Skip to content

Commit 9b05f6a

Browse files
committed
[DOCS] Add admonition for app using cat APIs (#52727)
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.
1 parent b2cb38c commit 9b05f6a

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

docs/reference/cat.asciidoc

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,18 @@
44
["float",id="intro"]
55
=== Introduction
66

7-
JSON is great... for computers. Even if it's pretty-printed, trying
8-
to find relationships in the data is tedious. Human eyes, especially
9-
when looking at a terminal, need compact and aligned text. The cat API
10-
aims to meet this need.
7+
JSON is great... for computers. Even if it's pretty-printed, trying
8+
to find relationships in the data is tedious. Human eyes, especially
9+
when looking at a terminal, need compact and aligned text. The cat APIs
10+
aim to meet this need.
11+
12+
[IMPORTANT]
13+
====
14+
cat APIs are only intended for human consumption using the
15+
{kibana-ref}/console-kibana.html[Kibana console] or command line. They are _not_
16+
intended for use by applications. For application consumption, we recommend
17+
using a corresponding JSON API.
18+
====
1119

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

0 commit comments

Comments
 (0)