Skip to content
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] Add admonition for apps using cat APIs #52727

Merged
merged 1 commit into from
Feb 25, 2020
Merged

[DOCS] Add admonition for apps using cat APIs #52727

merged 1 commit into from
Feb 25, 2020

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Feb 24, 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.

Closes #51772.

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.
@jrodewig jrodewig added >docs General docs changes :Data Management/CAT APIs Text APIs behind /_cat labels Feb 24, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (:Core/Features/CAT APIs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@jrodewig jrodewig changed the title [DOCS] Add admonition for app using cat APIs [DOCS] Add admonition for apps using cat APIs Feb 24, 2020
Copy link
Member

@jaymode jaymode left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@cjcenizal cjcenizal left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for making this change.

@jrodewig
Copy link
Contributor Author

Thanks @jaymode and @cjcenizal!

@jrodewig jrodewig merged commit ae1aafa into elastic:master Feb 25, 2020
@jrodewig jrodewig deleted the docs__cat-app-code branch February 25, 2020 12:19
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.
@jrodewig
Copy link
Contributor Author

Backport commits

master ae1aafa
7.x 9b05f6a
7.6 f09be12

@jasontedor
Copy link
Member

Thanks @jrodewig!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update cat API docs with guidance on intended use cases
6 participants