diff --git a/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml b/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml index d084f0e5a..bfeeb24f6 100644 --- a/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-serverless-openapi-overlays.yaml @@ -27,4 +27,188 @@ actions: - target: "$.paths[*]['get','put','post','delete','options','head','patch','trace']" description: Add x-beta update: - x-beta: true \ No newline at end of file + x-beta: true + # Add an alphabetically sorted list of tags + - target: '$' + description: Add document-level tags sorted by display name + update: + tags: + - name: asynch_search + description: The async search API enables you to asynchronously run a search request, monitor its progress, and retrieve partial results as they become available. + x-displayName: Async search + - name: cat + x-displayName: Compact and aligned text (CAT) + description: > + The compact and aligned text (CAT) APIs aim are intended only for human consumption using the Kibana console or command line. + They are not intended for use by applications. + For application consumption, it's recommend to use a corresponding JSON API. + + 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. + - name: cluster + x-displayName: Cluster + - name: connector + x-displayName: Connector + description: > + The connector and sync jobs APIs provide a convenient way to create and manage Elastic connectors and sync jobs in an internal index. + + 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: + + * Native connectors are a managed service on Elastic Cloud + * Connector clients are self-managed on your infrastructure + + 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. + externalDocs: + url: https://www.elastic.co/guide/en/enterprise-search/current/connectors-tutorial-api.html + description: To get started with Connector APIs, check out the tutorial. + - name: bulk + description: The bulk API performs multiple indexing or delete operations in a single API call. This reduces overhead and can greatly increase indexing speed. + x-displayName: Document - Bulk + - name: create + x-displayName: Document - Create + - name: delete + x-displayName: Document - Delete + - name: delete_by_query + x-displayName: Document - Delete by query + - name: exists + x-displayName: Document - Exists + - name: get + x-displayName: Document - Get + - name: get_source + x-displayName: Document - Get source + - name: index + x-displayName: Document - Index + - name: mget + x-displayName: Document - Multi get + - name: mtermvectors + x-displayName: Document - Multi term vectors + - name: reindex + x-displayName: Document - Reindex + - name: exists_source + x-displayName: Document - Source exists + - name: termvectors + x-displayName: Document - Term vectors + - name: update + x-displayName: Document - Update + - name: update_by_query + x-displayName: Document - Update by query + - name: enrich + x-displayName: Enrich + - name: eql + x-displayName: EQL + description: > + Event Query Language (EQL) is a query language for event-based time series data, such as logs, metrics, and traces. + externalDocs: + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html + description: EQL search + - name: esql + x-displayName: ES|QL + description: > + 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. + externalDocs: + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/esql.html + description: ES|QL overview and tutorials + - name: graph + x-displayName: Graph explore + description: > + The graph explore API enables you to extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + externalDocs: + url: https://www.elastic.co/guide/en/kibana/current/xpack-graph.html + description: Getting started with Graph + - name: indices + x-displayName: Index + description: > + Index APIs enable you to manage individual indices, index settings, aliases, mappings, and index templates. + - name: inference + x-displayName: Inference + description: > + 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. + For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + 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. + - name: ingest + x-displayName: Ingest + description: Ingest APIs enable you to manage tasks and resources related to ingest pipelines and processors. + - name: license + x-displayName: Licensing + description: Licensing APIs enable you to manage your licenses. + - name: logstash + x-displayName: Logstash + description: > + Logstash APIs enable you to manage pipelines that are used by Logstash Central Management. + externalDocs: + url: https://www.elastic.co/guide/en/logstash/current/logstash-centralized-pipeline-management.html + description: Centralized pipeline management + - name: ml + x-displayName: Machine learning + - name: query_rules + x-displayName: Query rules + description: > + Query rules enable you to configure per-query rules that are applied at query time to queries that match the specific rule. + Query rules are organized into rulesets, collections of query rules that are matched against incoming queries. + Query rules are applied using the rule query. + + If a query matches one or more rules in the ruleset, the query is re-written to apply the rules before searching. + This allows pinning documents for only queries that match a specific term. + externalDocs: + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-rule-query.html + description: Rule query + - name: put_script + x-displayName: Script - Create or update + - name: delete_script + x-displayName: Script - Delete + - name: get_script + x-displayName: Script - Get + - name: scripts_painless_execute + x-displayName: Script - Run painless + - name: search + x-displayName: Search + - name: close_point_in_time + x-displayName: Search - Close point in time + - name: count + x-displayName: Search - Count + - name: explain + x-displayName: Search - Explain + - name: field_caps + x-displayName: Search - Field capabilities + - name: msearch + x-displayName: Search - Multi search + - name: msearch_template + x-displayName: Search - Multi search template + - name: open_point_in_time + x-displayName: Search - Open point in time + - name: rank_eval + x-displayName: Search - Ranking evaluation + - name: render_search_template + x-displayName: Search - Render search template + - name: scroll + x-displayName: Search - Scroll + - name: search_template + x-displayName: Search - Search template + - name: terms_enum + x-displayName: Search - Terms enum + - name: search_mvt + x-displayName: Search - Vector tile search + - name: search_application + x-displayName: Search application + - name: security + x-displayName: Security + - name: sql + x-displayName: SQL + description: > + Elasticsearch's SQL APIs enable you to run SQL queries on Elasticsearch indices and data streams. + externalDocs: + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-sql.html + description: An overview and tutorials for the Elasticsearch SQL features + - name: synonyms + x-displayName: Synonyms + description: > + The synonyms management API provides a convenient way to define and manage synonyms in an internal system index. + Related synonyms can be grouped in a "synonyms set". + Create as many synonym sets as you need. + - name: tasks + x-displayName: Task management + - name: transform + x-displayName: Transform + + + + \ No newline at end of file