Commit Graph

14 Commits

Author SHA1 Message Date
Lee Hinman 777caf0725
[7.x] Add support for V2 index templates to /_cat/templates () ()
Backports the following commits to 7.x:
 - Add support for V2 index templates to /_cat/templates ()
2020-04-28 10:14:19 -06:00
Yannick Welsch fa212fe60b Stricter checks of setup and teardown in docs tests ()
Adds extra checks due to 7.x backport
2020-01-28 16:52:23 +01:00
James Rodewig a8e027551a
[DOCS] Document `bytes` and `time` params in cat API docs () () 2019-10-10 09:48:40 -04:00
James Rodewig b59ecde041
[DOCS] [2 of 5] Change // CONSOLE comments to [source,console] () () 2019-09-09 13:38:14 -04:00
James Rodewig ceb8b9bbee Change `{var}` convention to `<var>` () 2019-08-23 10:57:48 -04:00
James Rodewig 109358ca3f [DOCS] Reformat cat API titles () 2019-08-13 08:37:10 -04:00
James Rodewig bff4ef2d95 [DOCS] Reformats cat templates API () 2019-08-12 08:45:45 -04:00
James Rodewig a63f60b776 [DOCS] Remove heading offsets for REST APIs ()
Several files in the REST APIs nav section are included using
:leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.)
in those files and removes the :leveloffset: tags.

Other supporting changes:
* Alphabetizes top-level REST API nav items.
* Change 'indices APIs' heading to 'index APIs.'
* Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-19 14:36:06 -04:00
James Rodewig 5913723788 [DOCS] Change `// TESTRESPONSE[_cat]` to `// TESTRESPONSE[non_json]` () 2019-06-10 09:53:05 -04:00
Josh Soref edb48321ba [DOCS] Various spelling corrections () 2019-01-07 14:44:12 +01:00
Nik Everett 73549281e8
Docs: Use the default distribution to test docs ()
This switches the docs tests from the `oss-zip` distribution to the
`zip` distribution so they have xpack installed and configured with the
default basic license. The goal is to be able to merge the
`x-pack/docs` directory into the `docs` directory, marking the x-pack
docs with some kind of marker. This is the first step in that process.

This also enables `-Dtests.distribution` support for the `docs`
directory so you can run the tests against the `oss-zip` distribution
with something like
```
./gradlew -p docs check -Dtests.distribution=oss-zip
```

We can set up Jenkins to run both.

Relates to 
2018-06-18 12:06:42 -04:00
Nik Everett 45dd3780e2 CONSOLEify remaining _cat docs
Relates to 
2017-05-03 20:59:27 -04:00
Andreas Roussos 788c64848b [DOCS] Fixed various typos in the 'cat APIs' section () 2017-02-16 20:41:42 +01:00
Alexander Lin d31a8e6558 Provides a cat api endpoint for templates. ()
Adds a cat api endpoint: /_cat/templates and its more specific version, /_cat/templates/{name}.

It looks something like:

$ curl "localhost:9200/_cat/templates?v"
name                  template     order version
sushi_california_roll *avocado*    1     1
pizza_hawaiian        *pineapples* 1
pizza_pepperoni       *pepperoni*  1

The specified version (only allows * globs) looks like:

$ curl "localhost:9200/_cat/templates/pizza*"
name            template     order version
pizza_hawaiian  *pineapples* 1
pizza_pepperoni *pepperoni*  1

Partially specified columns:

$ curl "localhost:9200/_cat/templates/pizza*?v=true&h=name,template"
name            template
pizza_hawaiian  *pineapples*
pizza_pepperoni *pepperoni*

The help text:

$ curl "localhost:9200/_cat/templates/pizza*?help"
name     | n | template name
template | t | template pattern string
order    | o | template application order number
version  | v | version

Closes 
2016-09-20 10:40:23 +02:00