OpenSearch/docs/reference/indices
Gordon Brown 5c8b0662df
Deprecate REST access to System Indices (#63274) (Original #60945)
This PR adds deprecation warnings when accessing System Indices via the REST layer. At this time, these warnings are only enabled for Snapshot builds by default, to allow projects external to Elasticsearch additional time to adjust their access patterns.

Deprecation warnings will be triggered by all REST requests which access registered System Indices, except for purpose-specific APIs which access System Indices as an implementation detail a few specific APIs which will continue to allow access to system indices by default:

- `GET _cluster/health`
- `GET {index}/_recovery`
- `GET _cluster/allocation/explain`
- `GET _cluster/state`
- `POST _cluster/reroute`
- `GET {index}/_stats`
- `GET {index}/_segments`
- `GET {index}/_shard_stores`
- `GET _cat/[indices,aliases,health,recovery,shards,segments]`

Deprecation warnings for accessing system indices take the form:
```
this request accesses system indices: [.some_system_index], but in a future major version, direct access to system indices will be prevented by default
```
2020-10-06 13:41:40 -06:00
..
apis [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
add-alias.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
alias-exists.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
aliases.asciidoc [DOCS] Replace `twitter` dataset in docs (#60604) (#60609) 2020-08-03 13:31:19 -04:00
analyze.asciidoc Correct the type of the 'analyzer' parameter in the _analyze docs. (#56650) 2020-05-13 11:05:06 -07:00
clearcache.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
clone-index.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
close.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
component-templates.asciidoc [DOCS] Replace `twitter` dataset in docs (#60604) (#60609) 2020-08-03 13:31:19 -04:00
create-data-stream.asciidoc [DOCS] Simplify index template snippets for data streams (#59533) (#59553) 2020-07-14 17:28:43 -04:00
create-index.asciidoc [DOCS] Fix capitalization for several headings (#62324) (#62329) 2020-09-14 12:35:15 -04:00
dangling-index-delete.asciidoc Dangling indices documentation (#58751) 2020-07-09 14:02:23 +01:00
dangling-index-import.asciidoc [DOCS] Reformat snippets to use two-space indents (#59973) (#59994) 2020-07-21 15:49:58 -04:00
dangling-indices-list.asciidoc [DOCS] Fix list dangling indices documentation (#60099) 2020-08-04 10:32:00 +10:00
data-stream-stats.asciidoc [DOCS] Replace Wikipedia links with attribute (#61171) (#61209) 2020-08-17 11:27:04 -04:00
delete-alias.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
delete-component-template.asciidoc [DOCS] Refactored index-templates topic. (#59737) (#60165) 2020-07-23 19:48:19 -07:00
delete-data-stream.asciidoc [DOCS] Simplify index template snippets for data streams (#59533) (#59553) 2020-07-14 17:28:43 -04:00
delete-index-template-v1.asciidoc [DOCS] Split delete index template API docs (#62074) (#62169) 2020-09-09 10:13:16 -04:00
delete-index-template.asciidoc [DOCS] Split delete index template API docs (#62074) (#62169) 2020-09-09 10:13:16 -04:00
delete-index.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
flush.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
forcemerge.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
get-alias.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
get-component-template.asciidoc [DOCS] Refactored index-templates topic. (#59737) (#60165) 2020-07-23 19:48:19 -07:00
get-data-stream.asciidoc [DOCS] Fix hyphenation for "time series" (#61472) (#61481) 2020-08-24 11:18:07 -04:00
get-field-mapping.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
get-index-template-v1.asciidoc [DOCS] Refactored index-templates topic. (#59737) (#60165) 2020-07-23 19:48:19 -07:00
get-index-template.asciidoc [DOCS] Refactored index-templates topic. (#59737) (#60165) 2020-07-23 19:48:19 -07:00
get-index.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
get-mapping.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
get-settings.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
index-templates.asciidoc [7.x] Add "synthetics-*-*" templates for synthetics fleet data (#62193) (#62346) 2020-09-14 17:14:34 -06:00
indices-exists.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
open-close.asciidoc [DOCS] Fix capitalization for several headings (#62324) (#62329) 2020-09-14 12:35:15 -04:00
put-component-template.asciidoc [DOCS] Replace `twitter` dataset in docs (#60604) (#60609) 2020-08-03 13:31:19 -04:00
put-index-template-v1.asciidoc [DOCS] Replace `twitter` dataset in docs (#60604) (#60609) 2020-08-03 13:31:19 -04:00
put-index-template.asciidoc [7.x] Add "synthetics-*-*" templates for synthetics fleet data (#62193) (#62346) 2020-09-14 17:14:34 -06:00
put-mapping.asciidoc Remove a redundant section on field data types. (#61821) 2020-09-02 15:29:48 -07:00
recovery.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
refresh.asciidoc Deprecate REST access to System Indices (#63274) (Original #60945) 2020-10-06 13:41:40 -06:00
resolve.asciidoc [DOCS] Change wildcard to index pattern in DS docs (#61058) (#61060) 2020-08-12 15:14:03 -04:00
rollover-index.asciidoc Unmute rollover docs test (#62603) (#62605) 2020-09-18 11:11:13 +02:00
segments.asciidoc Deprecate REST access to System Indices (#63274) (Original #60945) 2020-10-06 13:41:40 -06:00
shard-stores.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
shrink-index.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
simulate-index.asciidoc [DOCS] Update my-index examples (#60132) (#60248) 2020-07-27 15:58:26 -04:00
simulate-multi-component-templates.asciidoc [DOCS] Update my-index examples (#60132) (#60248) 2020-07-27 15:58:26 -04:00
simulate-template.asciidoc [DOCS] Update my-index examples (#60132) (#60248) 2020-07-27 15:58:26 -04:00
split-index.asciidoc [DOCS] Replace `twitter` dataset in index API docs (#60473) (#60510) 2020-07-31 09:51:47 -04:00
stats.asciidoc Deprecate REST access to System Indices (#63274) (Original #60945) 2020-10-06 13:41:40 -06:00
synced-flush.asciidoc [DOCS] Replace `twitter` dataset in search/agg docs (#60667) (#60675) 2020-08-04 14:16:38 -04:00
template-exists.asciidoc [DOCS] Refactored index-templates topic. (#59737) (#60165) 2020-07-23 19:48:19 -07:00
types-exists.asciidoc [DOCS] Replace `twitter` dataset in search/agg docs (#60667) (#60675) 2020-08-04 14:16:38 -04:00
update-settings.asciidoc Deprecate REST access to System Indices (#63274) (Original #60945) 2020-10-06 13:41:40 -06:00