Skip to content

Improve SearchApplication definition (and related) #3040

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 22, 2024

Conversation

flobernd
Copy link
Member

The SearchApplication was used as the body for search_application.put as well as search_application.get.

This caused problems, because the name field was mandatory, but is actually not required in case of PUT.

In this PR, I remove name from SearchApplication and rename this type to SearchApplicationParameters.

The current SearchApplication now derives from SearchApplicationParameters and adds back the name field. This type is used as the response for search_application.get and search_application.list (instead of SearchApplicationListItem which became redundant).

@flobernd flobernd requested review from pquentin, l-trotta and a team October 22, 2024 11:54
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
search_application.delete_behavioral_analytics 🟢 3/3 3/3
search_application.delete 🟢 7/7 7/7
search_application.get_behavioral_analytics 🔴 2/5 5/5
search_application.get 🔴 10/10 6/10
search_application.list 🔴 7/7 2/7
search_application.post_behavioral_analytics_event 🟠 Missing type Missing type
search_application.put_behavioral_analytics 🟢 3/3 3/3
search_application.put 🔴 3/10 10/10
search_application.render_query 🟠 Missing type Missing type
search_application.search 🟢 16/16 16/16

You can validate these APIs yourself by using the make validate target.

@flobernd flobernd force-pushed the improve-search-application-spec branch from 34c9616 to ed55594 Compare October 22, 2024 11:57
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
search_application.delete_behavioral_analytics 🟢 3/3 3/3
search_application.delete 🟢 7/7 7/7
search_application.get_behavioral_analytics 🔴 2/5 5/5
search_application.get 🔴 10/10 6/10
search_application.list 🔴 7/7 2/7
search_application.post_behavioral_analytics_event 🟠 Missing type Missing type
search_application.put_behavioral_analytics 🟢 3/3 3/3
search_application.put 🔴 3/10 10/10
search_application.render_query 🟠 Missing type Missing type
search_application.search 🟢 16/16 16/16

You can validate these APIs yourself by using the make validate target.

@flobernd flobernd merged commit 2d0a0fd into main Oct 22, 2024
6 checks passed
@flobernd flobernd deleted the improve-search-application-spec branch October 22, 2024 18:01
pquentin pushed a commit that referenced this pull request Jan 2, 2025
@pquentin
Copy link
Member

pquentin commented Jan 2, 2025

💚 All backports created successfully

Status Branch Result
8.x

Questions ?

Please refer to the Backport tool documentation

pquentin added a commit that referenced this pull request Jan 2, 2025
(cherry picked from commit 2d0a0fd)

Co-authored-by: Florian Bernd <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants