honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-26 06:46:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Make system & hidden index info more prominent. (#64839) (#64960)

Browse Source 
* [DOCS] Make system & hidden index info more prominent.

* Update docs/reference/api-conventions.asciidoc
This commit is contained in:
debadair 2020-11-11 15:16:45 -08:00 committed by GitHub
parent a7301065d7
commit e4b77bcd38
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/reference/api-conventions.asciidoc
View File

@ -42,14 +42,6 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
The defaults settings for the above parameters depend on the API being used.
Some indices (hereafter "system indices") are used by various system
modules and/or plugins to store state or configuration. These indices
are not intended to be accessed directly, and accessing them directly is
deprecated. In the next major version, access to these indices will no longer be
allowed to prevent accidental operations that may cause problems with
Elasticsearch features which depend on the consistency of data in these
indices.
Some multi-target APIs that can target indices also support the following query
string parameter:
@ -59,6 +51,28 @@ NOTE: Single index APIs, such as the <<docs>> and
<<indices-aliases,single-index `alias` APIs>>, do not support multi-target
syntax.
[[hidden-indices]]
==== Hidden indices
Indices that are configured to be hidden with the <<index-hidden,index.hidden>> setting are
excluded from mult-target queries by default.
To include hidden indices, you must specify the `expand_wildcards` parameter.
The backing indices for data streams are hidden indices,
and some features like {ml} store information in hidden indices.
Global index templates that match all indices are not applied to hidden indices.
[[system-indices]]
==== System indices
{es} modules and plugins can store configuration and state information in internal _system indices_.
You should not directly access or modify system indices
as they contain data essential to the operation of the system.
IMPORTANT: Direct access to system indices is deprecated and
will no longer be allowed in the next major version.
[[date-math-index-names]]
=== Date math support in index names

4
docs/reference/rest-api/common-parms.asciidoc
View File

@ -224,7 +224,7 @@ expand to. Multiple values are accepted when separated by a comma, as in
`open,hidden`. Valid values are:
`all`::
Expand to open and closed indices, including <<index-hidden,hidden indices>>.
Expand to open and closed indices, including <<hidden-indices,hidden indices>>.
`open`::
Expand only to open indices.
@ -233,7 +233,7 @@ Expand only to open indices.
Expand only to closed indices.
`hidden`::
Expansion of wildcards will include <<index-hidden,hidden indices>>.
Expansion of wildcards will include hidden indices.
Must be combined with `open`, `closed`, or both.
`none`::