Skip to content

Commit

Permalink
[DOCS] Add admonition for app using cat APIs (#52727)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jrodewig authored Feb 25, 2020
1 parent ca80ad6 commit ae1aafa
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions docs/reference/cat.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,18 @@
["float",id="intro"]
=== Introduction

JSON is great... for computers. Even if it's pretty-printed, trying
to find relationships in the data is tedious. Human eyes, especially
when looking at a terminal, need compact and aligned text. The cat API
aims to meet this need.
JSON is great... for computers. Even if it's pretty-printed, trying
to find relationships in the data is tedious. Human eyes, especially
when looking at a terminal, need compact and aligned text. The cat APIs
aim to meet this need.

[IMPORTANT]
====
cat APIs are only intended for human consumption using the
{kibana-ref}/console-kibana.html[Kibana console] or command line. They are _not_
intended for use by applications. For application consumption, we recommend
using a corresponding JSON API.
====

All the cat commands accept a query string parameter `help` to see all
the headers and info they provide, and the `/_cat` command alone lists all
Expand Down

0 comments on commit ae1aafa

Please sign in to comment.