Skip to content

Commit 4a0eaef

Browse files
lcawllcawl
authored
[OpenAPI] Add list of tags in overlay (#2905)
1 parent 61861f1 commit 4a0eaef

File tree

62 files changed

+583
-258
lines changed

Some content is hidden

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

62 files changed

+583
-258
lines changed

‎.spectral.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ rules:
1717
operation-operationId: warn
1818
operation-operationId-unique: warn
1919
operation-operationId-valid-in-url: warn
20-
operation-tag-defined: warn
20+
operation-tag-defined: error
2121
operation-tags: warn
2222
# Responses
2323
operation-success-response: warn

‎Makefile

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,14 @@ overlay-docs: ## Apply overlays to OpenAPI documents
6969
rm output/openapi/elasticsearch-serverless-openapi.tmp*.json
7070
rm output/openapi/elasticsearch-openapi.tmp*.json
7171

72-
lint-docs: ## Lint the OpenAPI documents
73-
@npx @stoplight/spectral-cli lint output/openapi/*.json --ruleset .spectral.yaml
72+
lint-docs: ## Lint the OpenAPI documents after overlays
73+
@npx @stoplight/spectral-cli lint output/openapi/elasticsearch-*.examples.json --ruleset .spectral.yaml
7474

75-
lint-docs-errs: ## Lint the OpenAPI documents and return only errors
76-
@npx @stoplight/spectral-cli lint output/openapi/*.json --ruleset .spectral.yaml -D
75+
lint-docs-errs: ## Lint the OpenAPI documents after overlays and return only errors
76+
@npx @stoplight/spectral-cli lint output/openapi/elasticsearch-*.examples.json --ruleset .spectral.yaml -D
7777

78-
lint-docs-serverless: ## Lint only the serverless OpenAPI document
79-
@npx @stoplight/spectral-cli lint output/openapi/elasticsearch-serverless-openapi.json --ruleset .spectral.yaml
78+
lint-docs-serverless: ## Lint only the serverless OpenAPI document after overlays
79+
@npx @stoplight/spectral-cli lint output/openapi/elasticsearch-serverless-openapi.examples.json --ruleset .spectral.yaml
8080

8181
help: ## Display help
8282
@awk 'BEGIN {FS = ":.*##"; printf "Usage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

‎docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 213 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,219 @@ actions:
1212
externalDocs:
1313
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/query-dsl.html
1414
description: Query domain specific language (DSL) reference
15+
# Add an alphabetically sorted list of tags
16+
- target: '$'
17+
description: Add document-level tags sorted by display name
18+
update:
19+
tags:
20+
# A
21+
- name: autoscaling
22+
x-displayName: Autoscaling
23+
# B
24+
- name: analytics
25+
x-displayName: Behavioral analytics
26+
# C
27+
- name: cat
28+
x-displayName: Compact and aligned text (CAT)
29+
description: >
30+
The compact and aligned text (CAT) APIs aim are intended only for human consumption using the Kibana console or command line.
31+
They are not intended for use by applications.
32+
For application consumption, it's recommend to use a corresponding JSON API.
33+
34+
All the cat commands accept a query string parameter `help` to see all the headers and info they provide, and the `/_cat` command alone lists all the available commands.
35+
- name: cluster
36+
x-displayName: Cluster
37+
- name: health_report
38+
x-displayName: Cluster - Health
39+
- name: connector
40+
x-displayName: Connector
41+
description: >
42+
The connector and sync jobs APIs provide a convenient way to create and manage Elastic connectors and sync jobs in an internal index.
43+
44+
Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure:
45+
46+
* Native connectors are a managed service on Elastic Cloud
47+
* Connector clients are self-managed on your infrastructure
48+
49+
This API provides an alternative to relying solely on Kibana UI for connector and sync job management. The API comes with a set of validations and assertions to ensure that the state representation in the internal index remains valid.
50+
externalDocs:
51+
url: https://www.elastic.co/guide/en/enterprise-search/current/connectors-tutorial-api.html
52+
description: To get started with Connector APIs, check out the tutorial.
53+
- name: ccr
54+
x-displayName: Cross-cluster replication
55+
# D
56+
- name: data stream
57+
x-displayName: Data stream
58+
externalDocs:
59+
description: Data stream overview
60+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html
61+
- name: document
62+
x-displayName: Document
63+
externalDocs:
64+
description: Reading and writing documents
65+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-replication.html
66+
- name: mget
67+
x-displayName: Document - Multi get
68+
- name: mtermvectors
69+
x-displayName: Document - Multi term vectors
70+
- name: delete_by_query_rethrottle
71+
x-displayName: Document - Rethrottle delete by query
72+
- name: update_by_query_rethrottle
73+
x-displayName: Document - Rethrottle update by query
74+
# E
75+
- name: enrich
76+
x-displayName: Enrich
77+
- name: eql
78+
x-displayName: EQL
79+
description: >
80+
Event Query Language (EQL) is a query language for event-based time series data, such as logs, metrics, and traces.
81+
externalDocs:
82+
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html
83+
description: EQL search
84+
- name: esql
85+
x-displayName: ES|QL
86+
description: >
87+
The Elasticsearch Query Language (ES|QL) provides a powerful way to filter, transform, and analyze data stored in Elasticsearch, and in the future in other runtimes.
88+
externalDocs:
89+
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html
90+
description: ES|QL overview and tutorials
91+
# F
92+
- name: features
93+
description: The feature APIs enable you to introspect and manage features provided by Elasticsearch and Elasticsearch plugins.
94+
x-displayName: Features
95+
- name: fleet
96+
x-displayName: Fleet
97+
# G
98+
- name: graph
99+
x-displayName: Graph explore
100+
description: >
101+
The graph explore API enables you to extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
102+
externalDocs:
103+
url: https://www.elastic.co/guide/en/kibana/current/xpack-graph.html
104+
description: Getting started with Graph
105+
# I
106+
- name: indices
107+
x-displayName: Index
108+
description: >
109+
Index APIs enable you to manage individual indices, index settings, aliases, mappings, and index templates.
110+
- name: dangling_indices
111+
x-displayName: Index - Import dangling index
112+
- name: ilm
113+
x-displayName: Index lifecycle management
114+
externalDocs:
115+
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html
116+
description: Manage the index lifecycle
117+
- name: inference
118+
x-displayName: Inference
119+
description: >
120+
Inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio or Hugging Face.
121+
For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.
122+
However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.
123+
- name: info
124+
x-displayName: Info
125+
- name: ingest
126+
x-displayName: Ingest
127+
description: Ingest APIs enable you to manage tasks and resources related to ingest pipelines and processors.
128+
# L
129+
- name: license
130+
x-displayName: Licensing
131+
description: Licensing APIs enable you to manage your licenses.
132+
- name: logstash
133+
x-displayName: Logstash
134+
description: >
135+
Logstash APIs enable you to manage pipelines that are used by Logstash Central Management.
136+
externalDocs:
137+
url: https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html
138+
description: Centralized pipeline management
139+
# M
140+
- name: ml
141+
x-displayName: Machine learning
142+
- name: migration
143+
x-displayName: Migration
144+
- name: monitoring
145+
x-displayName: Monitoring
146+
# N
147+
- name: shutdown
148+
x-displayName: Node lifecycle
149+
# Q
150+
- name: query_rules
151+
x-displayName: Query rules
152+
description: >
153+
Query rules enable you to configure per-query rules that are applied at query time to queries that match the specific rule.
154+
Query rules are organized into rulesets, collections of query rules that are matched against incoming queries.
155+
Query rules are applied using the rule query.
156+
157+
If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching.
158+
This allows pinning documents for only queries that match a specific term.
159+
externalDocs:
160+
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html
161+
description: Rule query
162+
# R
163+
- name: rollup
164+
x-displayName: Rollup
165+
# S
166+
- name: script
167+
x-displayName: Script
168+
- name: get_script_context
169+
x-displayName: Script - Get contexts
170+
- name: get_script_languages
171+
x-displayName: Script - Get languages
172+
- name: search
173+
x-displayName: Search
174+
- name: msearch
175+
x-displayName: Search - Multi search
176+
- name: scroll
177+
x-displayName: Search - Scroll
178+
- name: terms_enum
179+
x-displayName: Search - Terms enum
180+
- name: search_application
181+
x-displayName: Search application
182+
- name: searchable_snapshots
183+
x-displayName: Searchable snapshots
184+
- name: security
185+
x-displayName: Security
186+
- name: ssl
187+
x-displayName: Security - SSL
188+
- name: snapshot
189+
x-displayName: Snapshot and restore
190+
description: >
191+
Snapshot and restore APIs enable you to set up snapshot repositories, manage snapshot backups, and restore snapshots to a running cluster.
192+
externalDocs:
193+
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html
194+
description: Snapshot and restore
195+
- name: slm
196+
x-displayName: Snapshot lifecycle management
197+
description: >
198+
Snapshot lifecycle management (SLM) APIs enable you to set up policies to automatically take snapshots and control how long they are retained.
199+
externalDocs:
200+
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html
201+
description: Create a snapshot
202+
- name: sql
203+
x-displayName: SQL
204+
description: >
205+
Elasticsearch's SQL APIs enable you to run SQL queries on Elasticsearch indices and data streams.
206+
externalDocs:
207+
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-sql.html
208+
description: An overview and tutorials for the Elasticsearch SQL features
209+
- name: synonyms
210+
x-displayName: Synonyms
211+
description: >
212+
The synonyms management API provides a convenient way to define and manage synonyms in an internal system index.
213+
Related synonyms can be grouped in a "synonyms set".
214+
Create as many synonym sets as you need.
215+
# T
216+
- name: tasks
217+
x-displayName: Task management
218+
- name: text_structure
219+
x-displayName: Text structure
220+
- name: transform
221+
x-displayName: Transform
222+
# U
223+
- name: xpack
224+
x-displayName: Usage
225+
# W
226+
- name: watcher
227+
x-displayName: Watcher
15228
# Abbreviate and annotate items that are not shown in Bump.sh due to depth limits
16229
- target: "$.components['schemas']['ml._types:Datafeed'].properties.query"
17230
description: Remove query object from anomaly detection datafeed

0 commit comments

Comments
 (0)