Skip to content

Add descriptions for Search API #2171

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 2 commits into from
Jul 10, 2023
Merged

Conversation

abdonpijpelink
Copy link
Contributor

Adds descriptions for the Search API. Source for the descriptions: https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html (and pages linked from it)

Does not include aggs and suggesters.

@abdonpijpelink
Copy link
Contributor Author

I'm not sure what to do about the validation error (if anything). Running make validate api=search stack-version=8.8.0 locally just returns:

✖ 
    at run (/Users/abdon/projects/github/elasticsearch-specification/compiler/run-validations.js:175:12)
    exit code: 1
make: *** [validate] Error 1

@lcawl
Copy link
Contributor

lcawl commented Jul 7, 2023

I'm not sure what to do about the validation error (if anything).

I think the validation messages can be ignored in the context of adding descriptions. My interpretation of them is that they're indicating there are some request and response properties missing from the spec, but that's not what we're addressing with these PRs, unless we happen to notice an obvious omission.

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One suggestion, otherwise LGTM

@github-actions
Copy link
Contributor

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

API Status Request Response
search 🔴 1519/1538 1519/1520

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

@abdonpijpelink abdonpijpelink merged commit 585ff3b into main Jul 10, 2023
@abdonpijpelink abdonpijpelink deleted the search-api-descriptions branch July 10, 2023 09:48
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.

2 participants