rest-api-spec: use url and description from Elasticsarch specification #133386
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
elasticsearchmachine
added
v9.2.0
needs:triage
pquentin
added
>docs
|
Pinging @elastic/core-docs (Team:Docs) |
lcawl
reviewed
Aug 22, 2025
rest-api-spec/src/main/resources/rest-api-spec/api/_internal.delete_desired_balance.json
Outdated
Show resolved
Hide resolved
They had a whitespace that the regex did not account for.
pquentin
commented
Aug 27, 2025
| "stability":"stable", | ||
| "stability":"experimental", |
There was a problem hiding this comment.
This change is intentional. All other internal APIs are experimental, which allows them to have a null URL. This is enforced in the JSON Schema.
lcawl
approved these changes
Aug 27, 2025
There was a problem hiding this comment.
LGTM. Hopefully in the long term those URLs can be generated (e.g. from https://github.com/elastic/elasticsearch-specification/blob/main/specification/_doc_ids/table.csv like we do in elasticsearch-specification) and/or contain only an id instead of a url so it's simpler to maintain.
|
Thank you @lcawl! Yes, this PR is part of the work to generate rest-api-spec from the Elasticsearch specification. All those URLs do come from |
pquentin
added
the
auto-backport
💔 Backport failed
You can use sqren/backport to manually backport by running |
This was referenced Aug 29, 2025
pquentin
added a commit
to pquentin/elasticsearch
that referenced
this pull request
Aug 29, 2025
elastic#133386) * rest-api-spec: use url and description from Elasticsarch specification * Remove doc URLs for internal APIs * Fix more URLs They had a whitespace that the regex did not account for. * Fix more URLs * Fix JSON Schema validation (cherry picked from commit 8697379) # Conflicts: # rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream_mappings.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_mappings.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_ai21.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_llama.json
pquentin
added a commit
to pquentin/elasticsearch
that referenced
this pull request
Aug 29, 2025
elastic#133386) * rest-api-spec: use url and description from Elasticsarch specification * Remove doc URLs for internal APIs * Fix more URLs They had a whitespace that the regex did not account for. * Fix more URLs * Fix JSON Schema validation (cherry picked from commit 8697379) # Conflicts: # rest-api-spec/src/main/resources/rest-api-spec/api/esql.get_query.json # rest-api-spec/src/main/resources/rest-api-spec/api/esql.list_queries.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_data_stream_options.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream_mappings.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream_options.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream_settings.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_mappings.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_options.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_settings.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.remove_block.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_ai21.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_amazonsagemaker.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_deepseek.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_llama.json
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
pquentin
added a commit
to pquentin/elasticsearch
that referenced
this pull request
Aug 29, 2025
elastic#133386) * rest-api-spec: use url and description from Elasticsarch specification * Remove doc URLs for internal APIs * Fix more URLs They had a whitespace that the regex did not account for. * Fix more URLs * Fix JSON Schema validation (cherry picked from commit 8697379) # Conflicts: # rest-api-spec/src/main/resources/rest-api-spec/api/esql.get_query.json # rest-api-spec/src/main/resources/rest-api-spec/api/esql.list_queries.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream_mappings.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_mappings.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.remove_block.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_ai21.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_llama.json
pquentin
added a commit
that referenced
this pull request
Aug 29, 2025
#133386) (#133783) * rest-api-spec: use url and description from Elasticsarch specification * Remove doc URLs for internal APIs * Fix more URLs They had a whitespace that the regex did not account for. * Fix more URLs * Fix JSON Schema validation (cherry picked from commit 8697379) # Conflicts: # rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream_mappings.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_mappings.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_ai21.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_llama.json
pquentin
added a commit
that referenced
this pull request
Aug 29, 2025
#133386) (#133784) * rest-api-spec: use url and description from Elasticsarch specification * Remove doc URLs for internal APIs * Fix more URLs They had a whitespace that the regex did not account for. * Fix more URLs * Fix JSON Schema validation (cherry picked from commit 8697379) # Conflicts: # rest-api-spec/src/main/resources/rest-api-spec/api/esql.get_query.json # rest-api-spec/src/main/resources/rest-api-spec/api/esql.list_queries.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_data_stream_options.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream_mappings.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream_options.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream_settings.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_mappings.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_options.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_settings.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.remove_block.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_ai21.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_amazonsagemaker.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_deepseek.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_llama.json
pquentin
added a commit
that referenced
this pull request
Aug 29, 2025
#133386) (#133796) * rest-api-spec: use url and description from Elasticsarch specification * Remove doc URLs for internal APIs * Fix more URLs They had a whitespace that the regex did not account for. * Fix more URLs * Fix JSON Schema validation (cherry picked from commit 8697379) # Conflicts: # rest-api-spec/src/main/resources/rest-api-spec/api/esql.get_query.json # rest-api-spec/src/main/resources/rest-api-spec/api/esql.list_queries.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream_mappings.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_mappings.json # rest-api-spec/src/main/resources/rest-api-spec/api/indices.remove_block.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_ai21.json # rest-api-spec/src/main/resources/rest-api-spec/api/inference.put_llama.json
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As a first step towards generating the rest-api-spec from the Elasticsearch specification, I'm replacing the documentation URL and description with data from the Elasticsearch specification, when available. The description is just the title instead of the full description, which would have been too long, since it's a full-blown Markdown text.