Skip to content

Commit ec799fa

Browse files
committed
Add @doc_tag values
1 parent 0c878bb commit ec799fa

File tree

51 files changed

+73
-70
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+73
-70
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 21 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ actions:
2020
# A
2121
- name: autoscaling
2222
x-displayName: Autoscaling
23+
# B
24+
- name: analytics
25+
x-displayName: Behavioral analytics
2326
# C
2427
- name: cat
2528
x-displayName: Compact and aligned text (CAT)
@@ -33,8 +36,8 @@ actions:
3336
x-displayName: Cluster
3437
- name: health_report
3538
x-displayName: Cluster - Health
36-
- name: nodes
37-
x-displayName: Cluster - Nodes
39+
# - name: nodes
40+
# x-displayName: Cluster - Nodes
3841
- name: ping
3942
x-displayName: Cluster - Ping
4043
- name: connector
@@ -53,44 +56,25 @@ actions:
5356
description: To get started with Connector APIs, check out the tutorial.
5457
- name: ccr
5558
x-displayName: Cross-cluster replication
56-
# D
57-
- name: bulk
58-
description: The bulk API performs multiple indexing or delete operations in a single API call. This reduces overhead and can greatly increase indexing speed.
59-
x-displayName: Document - Bulk
60-
- name: create
61-
x-displayName: Document - Create
62-
- name: delete
63-
x-displayName: Document - Delete
64-
- name: delete_by_query
65-
x-displayName: Document - Delete by query
66-
- name: exists
67-
x-displayName: Document - Exists
68-
- name: get
69-
x-displayName: Document - Get
70-
- name: get_source
71-
x-displayName: Document - Get source
72-
- name: index
73-
x-displayName: Document - Index
59+
# D
60+
- name: data stream
61+
x-displayName: Data stream
62+
externalDocs:
63+
description: Data stream overview
64+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html
65+
- name: document
66+
x-displayName: Document
67+
externalDocs:
68+
description: Reading and writing documents
69+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-replication.html
7470
- name: mget
7571
x-displayName: Document - Multi get
7672
- name: mtermvectors
7773
x-displayName: Document - Multi term vectors
78-
- name: reindex
79-
x-displayName: Document - Reindex
8074
- name: delete_by_query_rethrottle
8175
x-displayName: Document - Rethrottle delete by query
82-
- name: reindex_rethrottle
83-
x-displayName: Document - Rethrottle reindex
8476
- name: update_by_query_rethrottle
8577
x-displayName: Document - Rethrottle update by query
86-
- name: exists_source
87-
x-displayName: Document - Source exists
88-
- name: termvectors
89-
x-displayName: Document - Term vectors
90-
- name: update
91-
x-displayName: Document - Update
92-
- name: update_by_query
93-
x-displayName: Document - Update by query
9478
# E
9579
- name: enrich
9680
x-displayName: Enrich
@@ -157,10 +141,10 @@ actions:
157141
url: https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html
158142
description: Centralized pipeline management
159143
# M
160-
- name: migration
161-
x-displayName: Migration
162144
- name: ml
163145
x-displayName: Machine learning
146+
- name: migration
147+
x-displayName: Migration
164148
- name: monitoring
165149
x-displayName: Monitoring
166150
# N
@@ -182,56 +166,25 @@ actions:
182166
# R
183167
- name: rollup
184168
x-displayName: Rollup
185-
# S
186-
- name: put_script
187-
x-displayName: Script - Create or update
169+
# S
170+
- name: script
171+
x-displayName: Script
188172
- name: delete_script
189173
x-displayName: Script - Delete
190-
- name: get_script
191-
x-displayName: Script - Get
192174
- name: get_script_context
193175
x-displayName: Script - Get contexts
194176
- name: get_script_languages
195177
x-displayName: Script - Get languages
196-
- name: scripts_painless_execute
197-
x-displayName: Script - Run painless
198178
- name: search
199179
x-displayName: Search
200-
- name: async_search
201-
description: The async search API enables you to asynchronously run a search request, monitor its progress, and retrieve partial results as they become available.
202-
x-displayName: Search - Async
203-
- name: clear_scroll
204-
x-displayName: Search - Clear scroll
205-
- name: close_point_in_time
206-
x-displayName: Search - Close point in time
207-
- name: count
208-
x-displayName: Search - Count
209-
- name: explain
210-
x-displayName: Search - Explain
211-
- name: field_caps
212-
x-displayName: Search - Field capabilities
213180
- name: knn_search
214181
x-displayName: Search - kNN
215182
- name: msearch
216183
x-displayName: Search - Multi search
217-
- name: msearch_template
218-
x-displayName: Search - Multi search template
219-
- name: open_point_in_time
220-
x-displayName: Search - Open point in time
221-
- name: rank_eval
222-
x-displayName: Search - Ranking evaluation
223-
- name: render_search_template
224-
x-displayName: Search - Render search template
225184
- name: scroll
226185
x-displayName: Search - Scroll
227-
- name: search_shards
228-
x-displayName: Search - Shards
229-
- name: search_template
230-
x-displayName: Search - Search template
231186
- name: terms_enum
232187
x-displayName: Search - Terms enum
233-
- name: search_mvt
234-
x-displayName: Search - Vector tile search
235188
- name: search_application
236189
x-displayName: Search application
237190
- name: searchable_snapshots

specification/_global/bulk/BulkRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ import { OperationContainer, UpdateAction } from './types'
3737
* @availability stack stability=stable
3838
* @availability serverless stability=stable visibility=public
3939
* @doc_id docs-bulk
40+
* @doc_tag document
4041
*
4142
*/
4243
export interface Request<TDocument, TPartialDocument> extends RequestBase {

specification/_global/clear_scroll/ClearScrollRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import { ScrollIds } from '@_types/common'
2626
* @availability stack stability=stable
2727
* @availability serverless stability=stable visibility=public
2828
* @doc_id clear-scroll-api
29+
* @doc_tag search
2930
*/
3031
export interface Request extends RequestBase {
3132
path_parts: {

specification/_global/close_point_in_time/ClosePointInTimeRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import { Id } from '@_types/common'
2626
* @availability stack since=7.10.0 stability=stable
2727
* @availability serverless stability=stable visibility=public
2828
* @doc_id point-in-time-api
29+
* @doc_tag search
2930
*/
3031
export interface Request extends RequestBase {
3132
body: {

specification/_global/count/CountRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { Operator } from '@_types/query_dsl/Operator'
2727
* @rest_spec_name count
2828
* @availability stack stability=stable
2929
* @availability serverless stability=stable visibility=public
30+
* @doc_tag search
3031
*/
3132
export interface Request extends RequestBase {
3233
path_parts: {

specification/_global/create/CreateRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ import { Duration } from '@_types/Time'
3636
* @rest_spec_name create
3737
* @availability stack since=5.0.0 stability=stable
3838
* @availability serverless stability=stable visibility=public
39-
*
39+
* @doc_tag document
4040
*/
4141
export interface Request<TDocument> extends RequestBase {
4242
path_parts: {

specification/_global/delete/DeleteRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ import { Duration } from '@_types/Time'
3737
* @rest_spec_name delete
3838
* @availability stack stability=stable
3939
* @availability serverless stability=stable visibility=public
40+
* @doc_tag document
4041
*/
4142
export interface Request extends RequestBase {
4243
path_parts: {

specification/_global/delete_by_query/DeleteByQueryRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ import { Duration } from '@_types/Time'
3939
* @rest_spec_name delete_by_query
4040
* @availability stack since=5.0.0 stability=stable
4141
* @availability serverless stability=stable visibility=public
42+
* @doc_tag document
4243
*/
4344
export interface Request extends RequestBase {
4445
path_parts: {

specification/_global/delete_script/DeleteScriptRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { Duration } from '@_types/Time'
2727
* @rest_spec_name delete_script
2828
* @availability stack stability=stable
2929
* @availability serverless stability=stable visibility=public
30+
* @doc_tag script
3031
*/
3132
export interface Request extends RequestBase {
3233
path_parts: {

specification/_global/exists/DocumentExistsRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ import {
3434
* @rest_spec_name exists
3535
* @availability stack stability=stable
3636
* @availability serverless stability=stable visibility=public
37+
* @doc_tag document
3738
*/
3839
export interface Request extends RequestBase {
3940
path_parts: {

specification/_global/exists_source/SourceExistsRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ import {
3434
* @rest_spec_name exists_source
3535
* @availability stack since=5.4.0 stability=stable
3636
* @availability serverless stability=stable visibility=public
37+
* @doc_tag document
3738
*/
3839
export interface Request extends RequestBase {
3940
path_parts: {

specification/_global/explain/ExplainRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ import { Operator } from '@_types/query_dsl/Operator'
2929
* @rest_spec_name explain
3030
* @availability stack stability=stable
3131
* @availability serverless stability=stable visibility=public
32+
* @doc_tag search
3233
*/
3334
export interface Request extends RequestBase {
3435
path_parts: {

specification/_global/field_caps/FieldCapabilitiesRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ import { QueryContainer } from '@_types/query_dsl/abstractions'
3030
* @availability stack since=5.4.0 stability=stable
3131
* @availability serverless stability=stable visibility=public
3232
* @index_privileges view_index_metadata,read,manage
33+
* @doc_tag search
3334
*/
3435
export interface Request extends RequestBase {
3536
path_parts: {

specification/_global/get/GetRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ import {
3434
* @rest_spec_name get
3535
* @availability stack stability=stable
3636
* @availability serverless stability=stable visibility=public
37+
* @doc_tag document
3738
*/
3839
export interface Request extends RequestBase {
3940
path_parts: {

specification/_global/get_script/GetScriptRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { Duration } from '@_types/Time'
2727
* @rest_spec_name get_script
2828
* @availability stack stability=stable
2929
* @availability serverless stability=stable visibility=public
30+
* @doc_tag script
3031
*/
3132
export interface Request extends RequestBase {
3233
path_parts: {

specification/_global/get_source/SourceRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ import {
3434
* @rest_spec_name get_source
3535
* @availability stack stability=stable
3636
* @availability serverless stability=stable visibility=public
37+
* @doc_tag document
3738
*/
3839
export interface Request extends RequestBase {
3940
path_parts: {

specification/_global/index/IndexRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ import { Duration } from '@_types/Time'
3939
* @rest_spec_name index
4040
* @availability stack stability=stable
4141
* @availability serverless stability=stable visibility=public
42+
* @doc_tag document
4243
*/
4344
export interface Request<TDocument> extends RequestBase {
4445
path_parts: {

specification/_global/knn_search/KnnSearchRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { Query } from './_types/Knn'
2727
* @rest_spec_name knn_search
2828
* @availability stack since=8.0.0 stability=experimental
2929
* @deprecated 8.4.0
30+
* @doc_tag search
3031
*/
3132
export interface Request extends RequestBase {
3233
path_parts: {

specification/_global/msearch_template/MultiSearchTemplateRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import { RequestItem } from './types'
2828
* @availability stack since=5.0.0 stability=stable
2929
* @availability serverless stability=stable visibility=public
3030
* @index_privileges read
31+
* @doc_tag search
3132
*/
3233
export interface Request extends RequestBase {
3334
path_parts: {

specification/_global/open_point_in_time/OpenPointInTimeRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ import { Duration } from '@_types/Time'
3434
* @availability serverless stability=stable visibility=public
3535
* @doc_id point-in-time-api
3636
* @index_privileges read
37+
* @doc_tag search
3738
*/
3839
export interface Request extends RequestBase {
3940
path_parts: {

specification/_global/put_script/PutScriptRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import { Duration } from '@_types/Time'
2828
* @rest_spec_name put_script
2929
* @availability stack stability=stable
3030
* @availability serverless stability=stable visibility=public
31+
* @doc_tag script
3132
*/
3233
export interface Request extends RequestBase {
3334
path_parts: {

specification/_global/rank_eval/RankEvalRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { RankEvalMetric, RankEvalRequestItem } from './types'
2727
* @availability stack since=6.2.0 stability=stable
2828
* @availability serverless stability=stable visibility=public
2929
* @index_privileges read
30+
* @doc_tag search
3031
*/
3132
export interface Request extends RequestBase {
3233
path_parts: {

specification/_global/reindex/ReindexRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ import { Destination, Source } from './types'
3030
* @rest_spec_name reindex
3131
* @availability stack since=2.3.0 stability=stable
3232
* @availability serverless stability=stable visibility=public
33+
* @doc_tag document
3334
*/
3435
export interface Request extends RequestBase {
3536
query_parameters: {

specification/_global/reindex_rethrottle/ReindexRethrottleRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import { float } from '@_types/Numeric'
2626
* @rest_spec_name reindex_rethrottle
2727
* @availability stack since=2.4.0 stability=stable
2828
* @availability serverless stability=stable visibility=private
29+
* @doc_tag document
2930
*/
3031
export interface Request extends RequestBase {
3132
path_parts: {

specification/_global/render_search_template/RenderSearchTemplateRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { Id } from '@_types/common'
2727
* @rest_spec_name render_search_template
2828
* @availability stack stability=stable
2929
* @availability serverless stability=stable visibility=public
30+
* @doc_tag search
3031
*/
3132
export interface Request extends RequestBase {
3233
path_parts: {

specification/_global/scripts_painless_execute/ExecutePainlessScriptRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import { PainlessContextSetup } from './types'
2727
* @rest_spec_name scripts_painless_execute
2828
* @availability stack since=6.3.0 stability=experimental
2929
* @availability serverless stability=experimental visibility=public
30+
* @doc_tag script
3031
*/
3132
export interface Request extends RequestBase {
3233
body: {

specification/_global/search_mvt/SearchMvtRequest.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ import { ZoomLevel } from './_types/ZoomLevel'
3636
* @rest_spec_name search_mvt
3737
* @availability stack since=7.15.0 stability=stable
3838
* @availability serverless stability=stable visibility=public
39+
* @doc_tag search
40+
*
3941
*/
4042
export interface Request extends RequestBase {
4143
path_parts: {

specification/_global/search_shards/SearchShardsRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import { ExpandWildcards, Indices, Routing } from '@_types/common'
2323
/**
2424
* @rest_spec_name search_shards
2525
* @availability stack stability=stable
26+
* @doc_tag search
2627
*/
2728
export interface Request extends RequestBase {
2829
path_parts: {

specification/_global/search_template/SearchTemplateRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ import { Duration } from '@_types/Time'
3434
* @rest_spec_name search_template
3535
* @availability stack since=2.0.0 stability=stable
3636
* @availability serverless stability=stable visibility=public
37+
* @doc_tag search
3738
*/
3839
export interface Request extends RequestBase {
3940
path_parts: {

specification/_global/termvectors/TermVectorsRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ import { Filter } from './types'
3636
* @rest_spec_name termvectors
3737
* @availability stack stability=stable
3838
* @availability serverless stability=stable visibility=public
39+
* @doc_tag document
3940
*/
4041
export interface Request<TDocument> extends RequestBase {
4142
path_parts: {

specification/_global/update/UpdateRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ import { Duration } from '@_types/Time'
4141
* @rest_spec_name update
4242
* @availability stack stability=stable
4343
* @availability serverless stability=stable visibility=public
44+
* @doc_tag document
4445
*/
4546
export interface Request<TDocument, TPartialDocument> extends RequestBase {
4647
path_parts: {

specification/_global/update_by_query/UpdateByQueryRequest.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ import { Duration } from '@_types/Time'
4141
* @rest_spec_name update_by_query
4242
* @availability stack since=2.4.0 stability=stable
4343
* @availability serverless stability=stable visibility=public
44+
* @doc_tag document
4445
*/
4546
export interface Request extends RequestBase {
4647
path_parts: {

0 commit comments

Comments
 (0)