Skip to content

Commit 38252ba

Browse files
lcawllcawl
committed
Merge single tag list
1 parent 5c66f35 commit 38252ba

File tree

3 files changed

+268
-466
lines changed

3 files changed

+268
-466
lines changed

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

Lines changed: 0 additions & 268 deletions
Original file line numberDiff line numberDiff line change
@@ -19,274 +19,6 @@ actions:
1919
x-feedbackLink:
2020
label: Feedback
2121
url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
22-
# Add an alphabetically sorted list of tags
23-
- target: '$'
24-
description: Add document-level tags sorted by display name
25-
update:
26-
tags:
27-
# A
28-
- name: async_search
29-
description: The async search API enables you to asynchronously run a search request, monitor its progress, and retrieve partial results as they become available.
30-
x-displayName: Async search
31-
- name: autoscaling
32-
x-displayName: Autoscaling
33-
# C
34-
- name: cat
35-
x-displayName: Compact and aligned text (CAT)
36-
description: >
37-
The compact and aligned text (CAT) APIs aim are intended only for human consumption using the Kibana console or command line.
38-
They are not intended for use by applications.
39-
For application consumption, it's recommend to use a corresponding JSON API.
40-
41-
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.
42-
- name: cluster
43-
x-displayName: Cluster
44-
- name: health_report
45-
x-displayName: Cluster - Health
46-
- name: nodes
47-
x-displayName: Cluster - Nodes
48-
- name: ping
49-
x-displayName: Cluster - Ping
50-
- name: connector
51-
x-displayName: Connector
52-
description: >
53-
The connector and sync jobs APIs provide a convenient way to create and manage Elastic connectors and sync jobs in an internal index.
54-
55-
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:
56-
57-
* Native connectors are a managed service on Elastic Cloud
58-
* Connector clients are self-managed on your infrastructure
59-
60-
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.
61-
externalDocs:
62-
url: https://www.elastic.co/guide/en/enterprise-search/current/connectors-tutorial-api.html
63-
description: To get started with Connector APIs, check out the tutorial.
64-
- name: ccr
65-
x-displayName: Cross-cluster replication
66-
# D
67-
- name: bulk
68-
description: The bulk API performs multiple indexing or delete operations in a single API call. This reduces overhead and can greatly increase indexing speed.
69-
x-displayName: Document - Bulk
70-
- name: create
71-
x-displayName: Document - Create
72-
- name: delete
73-
x-displayName: Document - Delete
74-
- name: delete_by_query
75-
x-displayName: Document - Delete by query
76-
- name: exists
77-
x-displayName: Document - Exists
78-
- name: get
79-
x-displayName: Document - Get
80-
- name: get_source
81-
x-displayName: Document - Get source
82-
- name: index
83-
x-displayName: Document - Index
84-
- name: mget
85-
x-displayName: Document - Multi get
86-
- name: mtermvectors
87-
x-displayName: Document - Multi term vectors
88-
- name: reindex
89-
x-displayName: Document - Reindex
90-
- name: delete_by_query_rethrottle
91-
x-displayName: Document - Rethrottle delete by query
92-
- name: reindex_rethrottle
93-
x-displayName: Document - Rethrottle reindex
94-
- name: update_by_query_rethrottle
95-
x-displayName: Document - Rethrottle update by query
96-
- name: exists_source
97-
x-displayName: Document - Source exists
98-
- name: termvectors
99-
x-displayName: Document - Term vectors
100-
- name: update
101-
x-displayName: Document - Update
102-
- name: update_by_query
103-
x-displayName: Document - Update by query
104-
# E
105-
- name: enrich
106-
x-displayName: Enrich
107-
- name: eql
108-
x-displayName: EQL
109-
description: >
110-
Event Query Language (EQL) is a query language for event-based time series data, such as logs, metrics, and traces.
111-
externalDocs:
112-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html
113-
description: EQL search
114-
- name: esql
115-
x-displayName: ES|QL
116-
description: >
117-
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.
118-
externalDocs:
119-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html
120-
description: ES|QL overview and tutorials
121-
# F
122-
- name: features
123-
description: The feature APIs enable you to introspect and manage features provided by Elasticsearch and Elasticsearch plugins.
124-
x-displayName: Features
125-
- name: fleet
126-
x-displayName: Fleet
127-
# G
128-
- name: graph
129-
x-displayName: Graph explore
130-
description: >
131-
The graph explore API enables you to extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
132-
externalDocs:
133-
url: https://www.elastic.co/guide/en/kibana/current/xpack-graph.html
134-
description: Getting started with Graph
135-
# I
136-
- name: indices
137-
x-displayName: Index
138-
description: >
139-
Index APIs enable you to manage individual indices, index settings, aliases, mappings, and index templates.
140-
- name: dangling_indices
141-
x-displayName: Index - Import dangling index
142-
- name: ilm
143-
x-displayName: Index lifecycle management
144-
externalDocs:
145-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html
146-
description: Manage the index lifecycle
147-
- name: inference
148-
x-displayName: Inference
149-
description: >
150-
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.
151-
For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models.
152-
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.
153-
- name: info
154-
x-displayName: Info
155-
- name: ingest
156-
x-displayName: Ingest
157-
description: Ingest APIs enable you to manage tasks and resources related to ingest pipelines and processors.
158-
# L
159-
- name: license
160-
x-displayName: Licensing
161-
description: Licensing APIs enable you to manage your licenses.
162-
- name: logstash
163-
x-displayName: Logstash
164-
description: >
165-
Logstash APIs enable you to manage pipelines that are used by Logstash Central Management.
166-
externalDocs:
167-
url: https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html
168-
description: Centralized pipeline management
169-
# M
170-
- name: migration
171-
x-displayName: Migration
172-
- name: ml
173-
x-displayName: Machine learning
174-
- name: monitoring
175-
x-displayName: Monitoring
176-
# N
177-
- name: shutdown
178-
x-displayName: Node lifecycle
179-
# Q
180-
- name: query_rules
181-
x-displayName: Query rules
182-
description: >
183-
Query rules enable you to configure per-query rules that are applied at query time to queries that match the specific rule.
184-
Query rules are organized into rulesets, collections of query rules that are matched against incoming queries.
185-
Query rules are applied using the rule query.
186-
187-
If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching.
188-
This allows pinning documents for only queries that match a specific term.
189-
externalDocs:
190-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html
191-
description: Rule query
192-
# R
193-
- name: rollup
194-
x-displayName: Rollup
195-
# S
196-
- name: put_script
197-
x-displayName: Script - Create or update
198-
- name: delete_script
199-
x-displayName: Script - Delete
200-
- name: get_script
201-
x-displayName: Script - Get
202-
- name: get_script_context
203-
x-displayName: Script - Get contexts
204-
- name: get_script_languages
205-
x-displayName: Script - Get languages
206-
- name: scripts_painless_execute
207-
x-displayName: Script - Run painless
208-
- name: search
209-
x-displayName: Search
210-
- name: clear_scroll
211-
x-displayName: Search - Clear scroll
212-
- name: close_point_in_time
213-
x-displayName: Search - Close point in time
214-
- name: count
215-
x-displayName: Search - Count
216-
- name: explain
217-
x-displayName: Search - Explain
218-
- name: field_caps
219-
x-displayName: Search - Field capabilities
220-
- name: knn_search
221-
x-displayName: Search - kNN
222-
- name: msearch
223-
x-displayName: Search - Multi search
224-
- name: msearch_template
225-
x-displayName: Search - Multi search template
226-
- name: open_point_in_time
227-
x-displayName: Search - Open point in time
228-
- name: rank_eval
229-
x-displayName: Search - Ranking evaluation
230-
- name: render_search_template
231-
x-displayName: Search - Render search template
232-
- name: scroll
233-
x-displayName: Search - Scroll
234-
- name: search_shards
235-
x-displayName: Search - Shards
236-
- name: search_template
237-
x-displayName: Search - Search template
238-
- name: terms_enum
239-
x-displayName: Search - Terms enum
240-
- name: search_mvt
241-
x-displayName: Search - Vector tile search
242-
- name: search_application
243-
x-displayName: Search application
244-
- name: searchable_snapshots
245-
x-displayName: Searchable snapshots
246-
- name: security
247-
x-displayName: Security
248-
- name: ssl
249-
x-displayName: Security - SSL
250-
- name: snapshot
251-
x-displayName: Snapshot and restore
252-
description: >
253-
Snapshot and restore APIs enable you to set up snapshot repositories, manage snapshot backups, and restore snapshots to a running cluster.
254-
externalDocs:
255-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html
256-
description: Snapshot and restore
257-
- name: slm
258-
x-displayName: Snapshot lifecycle management
259-
description: >
260-
Snapshot lifecycle management (SLM) APIs enable you to set up policies to automatically take snapshots and control how long they are retained.
261-
externalDocs:
262-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html
263-
description: Create a snapshot
264-
- name: sql
265-
x-displayName: SQL
266-
description: >
267-
Elasticsearch's SQL APIs enable you to run SQL queries on Elasticsearch indices and data streams.
268-
externalDocs:
269-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-sql.html
270-
description: An overview and tutorials for the Elasticsearch SQL features
271-
- name: synonyms
272-
x-displayName: Synonyms
273-
description: >
274-
The synonyms management API provides a convenient way to define and manage synonyms in an internal system index.
275-
Related synonyms can be grouped in a "synonyms set".
276-
Create as many synonym sets as you need.
277-
# T
278-
- name: tasks
279-
x-displayName: Task management
280-
- name: text_structure
281-
x-displayName: Text structure
282-
- name: transform
283-
x-displayName: Transform
284-
# U
285-
- name: xpack
286-
x-displayName: Usage
287-
# W
288-
- name: watcher
289-
x-displayName: Watcher
29022
# Examples that apply only to the Elasticsearch OpenAPI document
29123
- target: "$.paths['/_features']['get']"
29224
description: "Add examples for get features operation"

0 commit comments

Comments
 (0)