-
Notifications
You must be signed in to change notification settings - Fork 25.2k
Fix the "slices" parameter for the Delete By Query API in the REST specification #51535
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
Conversation
…ecification This patch updates the `type` parameter in the Delete By Query API: according to [the documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html#docs-delete-by-query-slice), it can be set to "auto", but the type in the documentation allows only numerical values. This prevents people from setting the parameter to "auto" eg. in the Go client, which generates source from the specification, and sets the corresponding Go type as number. The patch uses the `|` notation, which we have discussed previously for encoding a "polymorphic" parameter like this. Related: elastic/go-elasticsearch#77
Pinging @elastic/es-core-infra (:Core/Infra/REST API) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense to me so long as the clients team is happy with it and jenkins doesn't mind.
…ecification (#51535) This patch updates the `type` parameter in the Delete By Query API: according to [the documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html#docs-delete-by-query-slice), it can be set to "auto", but the type in the documentation allows only numerical values. This prevents people from setting the parameter to "auto" eg. in the Go client, which generates source from the specification, and sets the corresponding Go type as number. The patch uses the `|` notation, which we have discussed previously for encoding a "polymorphic" parameter like this. Related: elastic/go-elasticsearch#77
* REST: Test: Fix the `accept_enterprise` parameter for Get License API (#51527) The Get License API specifies the `accept_enterprise` parameter as a `boolean`: https://github.com/elastic/elasticsearch/blob/0ca5cb8cb636a4be9c36b8e38e565af66abc423b/x-pack/plugin/src/test/resources/rest-api-spec/api/license.get.json#L22-L27 In the test, a `string` is passed however, which makes the test compilation fail in the Go client. (cherry picked from commit e2a2169) * Fix the SQL API documentation in REST specification (#51534) This patch fixes the SQL REST API documentation to conform to the current schema. (cherry picked from commit c8b6a84) * Fix the "slices" parameter for the Delete By Query API in the REST specification (#51535) This patch updates the `type` parameter in the Delete By Query API: according to [the documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html#docs-delete-by-query-slice), it can be set to "auto", but the type in the documentation allows only numerical values. This prevents people from setting the parameter to "auto" eg. in the Go client, which generates source from the specification, and sets the corresponding Go type as number. The patch uses the `|` notation, which we have discussed previously for encoding a "polymorphic" parameter like this. Related: elastic/go-elasticsearch#77 * Fix the Enrich API documentation in REST specification (#51528) This patch fixes the REST API documentation for the Enrich APIs to conform to the current schema. (cherry picked from commit 59f28f4)
should the type for |
Yes, absolutely, that was a mistake I did, it's already fixed via https://github.com/elastic/elasticsearch/pull/51792/files. |
This patch updates the
type
parameter in the Delete By Query API: according to the documentation, it can be set to "auto", but the type in the documentation allows only numerical values.This prevents people from setting the parameter to "auto" eg. in the Go client, which generates source from the specification, and sets the corresponding Go type as number.
The patch uses the
|
notation, which we have discussed previously for encoding a "polymorphic" parameter like this.Related: elastic/go-elasticsearch#77
/cc @elastic/es-clients