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] Reformats cat repositories API #45382

Merged
merged 1 commit into from
Aug 12, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 30 additions & 5 deletions docs/reference/cat/repositories.asciidoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,35 @@
[[cat-repositories]]
=== cat repositories

The `repositories` command shows the snapshot repositories registered in the
cluster. For example:
Returns the <<snapshots-repositories,snapshot repositories>> for a cluster.


[[cat-repositories-api-request]]
==== {api-request-title}

`GET /_cat/repositories`


[[cat-repositories-query-params]]
==== {api-query-parms-title}

include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format]

include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h]

include::{docdir}/rest-api/common-parms.asciidoc[tag=help]

include::{docdir}/rest-api/common-parms.asciidoc[tag=local]

include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]

include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s]

include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]


[[cat-repositories-api-example]]
==== {api-examples-title}

[source,js]
--------------------------------------------------
Expand All @@ -11,7 +38,7 @@ GET /_cat/repositories?v
// CONSOLE
// TEST[s/^/PUT \/_snapshot\/repo1\n{"type": "fs", "settings": {"location": "repo\/1"}}\n/]

might looks like:
The API returns the following response:

[source,txt]
--------------------------------------------------
Expand All @@ -20,5 +47,3 @@ repo1 fs
repo2 s3
--------------------------------------------------
// TESTRESPONSE[s/\nrepo2 s3// non_json]

We can quickly see which repositories are registered and their type.