Skip to content

Update resolve index missing type definition #2856

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 4 commits into from
Sep 4, 2024

Conversation

mohamedhamed-ahmed
Copy link
Contributor

@mohamedhamed-ahmed mohamedhamed-ahmed commented Sep 4, 2024

This PR adds the missing type definition for ignore_unavailable and allow_no_indices query param` which are accepted by ES but the definition is missing.

Copy link
Contributor

github-actions bot commented Sep 4, 2024

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

API Status Request Response
indices.resolve_index 🟢 6/6 6/6

You can validate this API yourself by using the make validate target.

Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

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

Thanks, this looks good! Can you please remove the _json_spec change for now?

Also, as a follow-up and only if you're interested, we could add allow_no_indices that is also missing.

Comment on lines 32 to 35
},
"ignore_unavailable": {
"type": "boolean",
"description": "Ignore unavailable indexes (default: false)"
Copy link
Member

Choose a reason for hiding this comment

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

The source of truth of the _json_spec folder is in Elasticsearch, see https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/main/resources/rest-api-spec/api/indices.resolve_index.json. Can you please open an Elasticsearch pull request? Otherwise this will change will be overwritten in our next weekly sync.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@pquentin Thanks for the review :)
I added allow_no_indices and also created a PR in ES but not sure if I missed something there as its first time to have a change done there, may you please have a look?

Copy link
Contributor

github-actions bot commented Sep 4, 2024

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

API Status Request Response
indices.resolve_index 🟢 6/6 6/6

You can validate this API yourself by using the make validate target.

Copy link
Contributor

github-actions bot commented Sep 4, 2024

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

API Status Request Response
indices.resolve_index 🟢 6/6 6/6

You can validate this API yourself by using the make validate target.

Copy link
Contributor

github-actions bot commented Sep 4, 2024

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

API Status Request Response
indices.resolve_index 🟢 6/6 6/6

You can validate this API yourself by using the make validate target.

@pquentin pquentin merged commit f24570e into main Sep 4, 2024
6 checks passed
@pquentin pquentin deleted the update-resolve-index-api-type-definition branch September 4, 2024 12:49
github-actions bot pushed a commit that referenced this pull request Sep 4, 2024
* Update resolve index missing type definition

* Add allow_no_indices

* Fix Markdown syntax in allow_no_indices

* Run make contrib

---------

Co-authored-by: Quentin Pradet <[email protected]>
(cherry picked from commit f24570e)
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