[DOCS] Reformat update license API docs #48967
Merged
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
Makes a few changes to better align the update license API docs with the [API reference template][0]. Changes: * Replaces POST with PUT in several snippet examples. While both are valid, PUT is a bit more RESTful. * Removes leading slashes (/) from all snippets. * Relocates and retitles the 'Authorization' section to 'Prerequisites'. * Replaces explicit titles with the appropriate API reference template attributes. * Replaces unneeded `[float]` tags with explicit anchors. Closes #35341 [0]: https://github.com/elastic/docs/blob/master/shared/api-ref-ex.asciidoc
jrodewig
added
>docs
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/es-security (:Security/License) |
jrodewig
added a commit
that referenced
this pull request
Nov 14, 2019
Makes a few changes to better align the update license API docs with the [API reference template][0]. Changes: * Replaces POST with PUT in several snippet examples. While both are valid, PUT is a bit more RESTful. * Removes leading slashes (/) from all snippets. * Relocates and retitles the 'Authorization' section to 'Prerequisites'. * Replaces explicit titles with the appropriate API reference template attributes. * Replaces unneeded `[float]` tags with explicit anchors. Closes #35341 [0]: https://github.com/elastic/docs/blob/master/shared/api-ref-ex.asciidoc
jrodewig
added a commit
that referenced
this pull request
Nov 14, 2019
Makes a few changes to better align the update license API docs with the [API reference template][0]. Changes: * Replaces POST with PUT in several snippet examples. While both are valid, PUT is a bit more RESTful. * Removes leading slashes (/) from all snippets. * Relocates and retitles the 'Authorization' section to 'Prerequisites'. * Replaces explicit titles with the appropriate API reference template attributes. * Replaces unneeded `[float]` tags with explicit anchors. Closes #35341 [0]: https://github.com/elastic/docs/blob/master/shared/api-ref-ex.asciidoc
jrodewig
added a commit
that referenced
this pull request
Nov 14, 2019
Makes a few changes to better align the update license API docs with the [API reference template][0]. Changes: * Replaces POST with PUT in several snippet examples. While both are valid, PUT is a bit more RESTful. * Removes leading slashes (/) from all snippets. * Relocates and retitles the 'Authorization' section to 'Prerequisites'. * Replaces explicit titles with the appropriate API reference template attributes. * Replaces unneeded `[float]` tags with explicit anchors. Closes #35341 [0]: https://github.com/elastic/docs/blob/master/shared/api-ref-ex.asciidoc
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.
Consistently uses the
PUTHTTP method in all example snippets for the update license API docs. While bothPUTandPOSTare supported,PUTis a bit more RESTful. Closes #35341.Makes a few other changes to better align the API docs with the API reference template.
Changes
Replaces
POSTwithPUTin several snippet examples.Removes leading slashes (
/) from all snippets. Per the ES UI team, this is (slightly) more preferred as it reduces the likelihood of double slashes (//), which will produce an error.Relocates and retitles the 'Authorization' section to 'Prerequisites'.
Replaces explicit titles with the appropriate API reference template attributes.
Replaces unneeded
[float]tags with explicit anchors.