elastic / elasticsearch-specification

Elasticsearch full specification
Apache License 2.0
121 stars 70 forks source link

[DOCS] Improve serverless operation summaries #2635

Open lcawl opened 3 months ago

lcawl commented 3 months ago

Now that https://github.com/elastic/elasticsearch-specification/issues/2314 is fixed, we can have operation summaries that diverge from operation descriptions. This meta-issue tracks the operation summary review and edits for the serverless APIs in each of these sections:

NOTE: The readme for how to add the summary is here and the style guide is here

You can get an indication of which summaries are too long and/or contain inappropriate terms by running make lint-docs or spectral lint output/openapi/elasticsearch-serverless-openapi.json --ruleset .spectral.yaml.

Todo

In progress

Done