-
Notifications
You must be signed in to change notification settings - Fork 24.3k
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
[DOCS] Reformat rollup APIs to use new API format #44131
Conversation
Pinging @elastic/es-analytics-geo |
Pinging @elastic/es-docs |
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.
LGTM from a rollup perspective.
Out of curiosity, why remove the 404 response examples? Don't want to show exception messages in the API docs?
After I added the "Response codes" section, the example seemed redundant. We're trying to have brief examples in these reference pages if possible. If you feel strongly about adding it back, however, I can do so. |
No strong feelings, mostly just curious for future reference when writing docs. Thanks! 👍 |
Related to elastic/docs#937
With elastic/docs#938, we created a standard template
for Elastic API Reference documentation.
This PR edits some initial rollup APIs to use that template. It also makes use of some shared attributes that were implemented for rollup terms in elastic/docs#969