Commit Graph

123 Commits

Author SHA1 Message Date
James Rodewig a687b1f180
[DOCS] Document `indices` cluster stats (#50527)
Documents the header and `indices` response parameters returned by the
`_cluster/stats` API.

Co-Authored-By: David Turner <david.turner@elastic.co>
2020-01-28 10:57:45 -05:00
debadair 0fed96eebc [DOCS] Align with ILM API docs (#48705)
* [DOCS] Reconciled with Snapshot/Restore reorg
2020-01-22 20:44:19 -08:00
Deb Adair 6f3581173b Revert "[DOCS] Align with ILM API docs (#48705)"
This reverts commit ec9437832d.
2020-01-21 22:32:40 -08:00
debadair ec9437832d
[DOCS] Align with ILM API docs (#48705)
* [DOCS] Reconciled with Snapshot/Restore reorg
2020-01-21 19:58:17 -08:00
Jay Modi 173c3bdac4
Introduce hidden indices (#50452)
This change introduces a new feature for indices so that they can be
hidden from wildcard expansion. The feature is referred to as hidden
indices. An index can be marked hidden through the use of an index
setting, `index.hidden`, at creation time. One primary use case for
this feature is to have a construct that fits indices that are created
by the stack that contain data used for display to the user and/or
intended for querying by the user. The desire to keep them hidden is
to avoid confusing users when searching all of the data they have
indexed and getting results returned from indices created by the
system.

Hidden indices have the following properties:
* API calls for all indices (empty indices array, _all, or *) will not
  return hidden indices by default.
* Wildcard expansion will not return hidden indices by default unless
  the wildcard pattern begins with a `.`. This behavior is similar to
  shell expansion of wildcards.
* REST API calls can enable the expansion of wildcards to hidden
  indices with the `expand_wildcards` parameter. To expand wildcards
  to hidden indices, use the value `hidden` in conjunction with `open`
  and/or `closed`.
* Creation of a hidden index will ignore global index templates. A
  global index template is one with a match-all pattern.
* Index templates can make an index hidden, with the exception of a
  global index template.
* Accessing a hidden index directly requires no additional parameters.

Relates #50251
2020-01-17 09:16:31 -07:00
Peter Dyson f77ff8ba09 [DOCS] Array of index patterns is also valid source indices with transform (#50777) 2020-01-13 15:44:35 -08:00
István Zoltán Szabó b3457154a3
[DOCS] Fine-tunes data frame analytics API docs formatting. (#50799) 2020-01-09 16:21:01 +01:00
István Zoltán Szabó b683f96e23
[DOCS] Moves analysis resources to PUT DFA API docs (#50704)
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2020-01-09 13:57:11 +01:00
Lisa Cawley 68e02a19d8
[DOCS] Move machine learning results definitions into APIs (#50257) 2019-12-18 09:50:31 -08:00
Lisa Cawley 6d608e6a0d
[DOCS] Move transform resource definitions into APIs (#50108) 2019-12-17 09:01:31 -08:00
Lisa Cawley 207094cd67
[DOCS] Moves model snapshot resource definitions into APIs (#50157)
Co-Authored-By: Ed Savage <32410745+edsavage@users.noreply.github.com>
2019-12-16 10:42:30 -08:00
István Zoltán Szabó 3857e3d94f
[DOCS] Moves data frame analytics job resource definitions into APIs (#50021) 2019-12-12 10:59:37 +01:00
Lisa Cawley ca482127fa
[DOCS] Move job count resource definitions into API (#50057)
Co-Authored-By: Przemysław Witek <przemyslaw.witek@elastic.co>
Co-Authored-By: David Roberts <dave.roberts@elastic.co>
Co-Authored-By: Ed Savage <32410745+edsavage@users.noreply.github.com>
2019-12-11 11:17:15 -08:00
Lisa Cawley 3d96e6b68e
[DOCS] Move datafeed resource definitions into APIs (#50005)
Co-Authored-By: István Zoltán Szabó <istvan.szabo@elastic.co>
2019-12-11 09:50:41 -08:00
Lisa Cawley 0f51bc2f72
[DOCS] Move anomaly detection job resource definitions into APIs (#49700)
Co-Authored-By: István Zoltán Szabó <istvan.szabo@elastic.co>
2019-12-06 15:32:07 -08:00
Julie Tibshirani 33a7f066e1
Remove include_type_name from the REST API spec and docs. (#48828)
In #48632 we removed support for `include_type_name` in the REST API. This PR
removes it from the API spec and documentation.
2019-11-12 09:42:46 -08:00
Martijn van Groningen 3d2a1bc59f
Include enrich into the info api as feature (#48109)
This commit also fixes a bug, the enrich enabled setting
was not included in the list of settings.
2019-10-16 19:30:27 +02:00
Lee Hinman f9511f477e
Add SLM support to xpack usage and info APIs (#48096)
* Add SLM support to xpack usage and info APIs

This adds the missing xpack usage and info information into the
`/_xpack` and `/_xpack/usage` APIs. The output now looks like:

```
GET /_xpack/usage
{
  ...
  "slm" : {
    "available" : true,
    "enabled" : true,
    "policy_count" : 1,
    "policy_stats" : {
      "retention_runs" : 0,
      ...
    }
  }
```

and

```
GET /_xpack
{
  ...
  "features" : {
    ...
    "slm" : {
      "available" : true,
      "enabled" : true
    },
    ...
  }
}
```

Relates to #43663

* Fix test expectation

* Fix docs test
2019-10-16 09:00:15 -06:00
debadair 3d5d96da07
Added request and response body sections. Closes #16035 (#48032) 2019-10-15 11:27:46 -07:00
Martijn van Groningen abdbd843ad
Merge remote-tracking branch 'es/master' into enrich 2019-10-10 14:41:34 +02:00
James Rodewig 15e2de6db8
[DOCS] Document `bytes` and `time` params in cat API docs (#47672) 2019-10-10 08:29:27 -04:00
Jim Ferenczi 8f9e77e6f1
Fix tag in the search request timeout option docs (#47776)
and add missing parentheses `search_timeout` param
2019-10-10 10:35:09 +02:00
Martijn van Groningen 957f0fad0f
Merge remote-tracking branch 'es/master' into enrich 2019-10-09 08:48:28 +02:00
debadair 07f4ca799b
Reformats term vectors APIs (#47484)
* Reformat termvectors APIs

* Reformats mtermvectors

* Apply suggestions from code review

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>

* Incorporated review feedback.
2019-10-04 20:09:11 -07:00
debadair d5be0404f5
Reformats mget API (#47477)
* Reformats mget API

* Update docs/reference/docs/get.asciidoc

Co-Authored-By: James Rodewig <james.rodewig@elastic.co>

* Incorporated feedback.
2019-10-04 17:55:53 -07:00
Tal Levy 4d3f6816a7 Merge remote-tracking branch 'elastic/master' into enrich 2019-10-04 13:30:57 -07:00
James Rodewig 730c35c4cd
[DOCS] Reformat index recovery API docs (#46493) 2019-10-03 16:13:21 -04:00
James Rodewig 26fef85887 [DOCS] Clarify `actions` parm def for tasks APIs 2019-10-01 11:49:08 -04:00
James Rodewig 9f5f9f19d0
[DOCS] Document cat tasks API (#47321) 2019-10-01 11:47:14 -04:00
Martijn van Groningen 197c1d59d4
Merge remote-tracking branch 'es/master' into enrich 2019-09-30 08:12:07 +02:00
James Rodewig 4568d30ef6
[DOCS] Document missing query parms for cat recovery API (#47181)
Documents the following query parameters for
the /_cat/recovery API:

* `active_only`
* `detailed`
* `index`
2019-09-27 12:19:47 -04:00
Martijn van Groningen f676d9730d
Merge remote-tracking branch 'es/master' into enrich 2019-09-27 13:51:17 +02:00
James Rodewig 223110491b
[DOCS] Reformat get pipeline API (#47131) 2019-09-26 08:26:01 -04:00
James Rodewig 48471b2e9a
[DOCS] Reformat clone index API docs (#46762) 2019-09-25 12:36:23 -04:00
Martijn van Groningen afc16ba518
Merge remote-tracking branch 'es/master' into enrich 2019-09-23 09:34:53 +02:00
Lisa Cawley 4da98c9e46
[DOCS] Update data frame transform URLs (#46940) 2019-09-20 13:26:57 -07:00
István Zoltán Szabó 4e11a19371
[DOCS] Reformats count API (#46377)
* [DOCS] Reformats count API.
Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
2019-09-17 09:53:03 +02:00
Lisa Cawley 79c1a6f7fb
[DOCS] Removes data-frames folder (#46760) 2019-09-16 10:23:46 -07:00
lcawl 6145f1765c [DOCS] Fixes formatting of analyzer parameter 2019-09-16 10:02:41 -07:00
Lisa Cawley b3dfd6e6d0
[DOCS] Updates dataframe transform terminology (#46642) 2019-09-16 08:28:19 -07:00
Hendrik Muhs de17140ca0
[Transform] Rename data frame plugin to transform: classes in xpack.core (#46644)
rename classes in xpack.core of transform plugin from "data frame transform" to "transform"
2019-09-15 19:59:21 +02:00
James Rodewig 5c78f606c2
[DOCS] Change // CONSOLE comments to [source,console] (#46440) 2019-09-09 10:45:37 -04:00
Martijn van Groningen f97cc7f355
Merge remote-tracking branch 'es/master' into enrich 2019-09-09 08:38:37 +02:00
James Rodewig 8d1ad42625
[DOCS] Correct definition for `allow_no_indices` parameter (#46450) 2019-09-06 14:10:36 -04:00
James Rodewig e43be90e6c
[DOCS] [5 of 5] Change // TESTRESPONSE comments to [source,console-results] (#46449) 2019-09-06 14:05:36 -04:00
James Rodewig 73838499b0
[DOCS] Resort common-parms (#46419) 2019-09-06 09:22:36 -04:00
James Rodewig 565ba9cb88
[DOCS] Reformat index stats API docs (#46322) 2019-09-05 15:03:33 -04:00
James Rodewig a5c60fb59a
[DOCS] Reformat index segments API docs (#46345) 2019-09-05 08:33:17 -04:00
James Rodewig dace374e26
[DOCS] Separate Enrich API Docs (#46286)
* Add enrich policy common parameter

* Add enrich APIs to REST APIs index

* Add put enrich policy API docs

* Add get enrich policy API docs

* Add delete enrich policy API docs

* Add execute enrich policy API docs
2019-09-04 14:11:52 -04:00
James Rodewig bf0b3ce885
[DOCS] Reformat "put index template" API docs (#46297) 2019-09-04 11:47:32 -04:00