Skip to content

More edits to the API template #943

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Jul 2, 2019
Merged

More edits to the API template #943

merged 3 commits into from
Jul 2, 2019

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jun 20, 2019 •
edited
Loading

This PR updates the API reference template as follows:

  • adds an attribute for the "Properties" title
  • removes float attributes from the template (so the "On this page" navigation works)
  • uncomments the Response body since it's the only optional one we were commenting out that way
  • changes the template to use "Examples" instead of "Example" by default

@lcawl lcawl added the WIP label Jun 20, 2019
@lcawl lcawl force-pushed the more-api-updates branch from 0ff6e7b to eaca266 Compare June 28, 2019 15:38
@lcawl lcawl removed the WIP label Jun 28, 2019
@lcawl lcawl requested review from jrodewig and KOTungseth June 28, 2019 15:42
@lcawl lcawl marked this pull request as ready for review June 28, 2019 15:42
jrodewig
jrodewig reviewed Jun 28, 2019
View reviewed changes
shared/api-ref-ex.asciidoc
////
Response body is only required for detailed responses.
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice add!

jrodewig
jrodewig reviewed Jun 28, 2019
View reviewed changes
jrodewig
jrodewig approved these changes Jun 28, 2019
View reviewed changes
Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

LGTM. Some minor nits, but nothing blocking. Thanks @lcawl!

@lcawl lcawl merged commit 97bf455 into elastic:master Jul 2, 2019
@lcawl lcawl deleted the more-api-updates branch July 2, 2019 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jrodewig jrodewig jrodewig approved these changes

@KOTungseth KOTungseth Awaiting requested review from KOTungseth

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lcawl @jrodewig