[DOCS] Add admonition for apps using cat APIs#52727
Merged
jrodewig merged 1 commit intoelastic:masterfrom Feb 25, 2020
jrodewig:docs__cat-app-code
Merged
[DOCS] Add admonition for apps using cat APIs#52727jrodewig merged 1 commit intoelastic:masterfrom jrodewig:docs__cat-app-code
jrodewig merged 1 commit intoelastic:masterfrom
jrodewig:docs__cat-app-code
Conversation
cat APIs are intended for human consumption via the command line or Kibana console only. They are not intended for consumption by applications. This adds an explicit "important" admonition stating this to the cat API docs.
Collaborator
|
Pinging @elastic/es-core-features (:Core/Features/CAT APIs) |
Collaborator
|
Pinging @elastic/es-docs (>docs) |
cjcenizal
approved these changes
Feb 24, 2020
Contributor
cjcenizal
left a comment
There was a problem hiding this comment.
LGTM! Thanks for making this change.
Contributor
Author
|
Thanks @jaymode and @cjcenizal! |
jrodewig
added a commit
that referenced
this pull request
Feb 25, 2020
Adds an explicit "important" admonition discouraging apps from using cat APIs. cat APIs are intended for human consumption via the command line or Kibana console only. They are not intended for consumption by applications.
jrodewig
added a commit
that referenced
this pull request
Feb 25, 2020
Adds an explicit "important" admonition discouraging apps from using cat APIs. cat APIs are intended for human consumption via the command line or Kibana console only. They are not intended for consumption by applications.
Contributor
Author
Member
|
Thanks @jrodewig! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
Adds an explicit "important" admonition discouraging apps from using cat
APIs.
cat APIs are intended for human consumption via the command line or
Kibana console only. They are not intended for consumption by
applications.
Closes #51772.