Skip to content

[9.0] Update URLs for Docs V3 (#4255) #4259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/overlays/elasticsearch-openapi-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ actions:
type: http
description: |
Elasticsearch APIs support the use of bearer tokens in the `Authorization` HTTP header to authenticate with the API.
For examples, refer to [Token-based authentication services](https://www.elastic.co/guide/en/elasticsearch/reference/current/token-authentication-services.html)
For examples, refer to [Token-based authentication services](https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/token-based-authentication-services)
- target: '$'
description: Add document security
update:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ actions:
-H "Authorization: ApiKey ${API_KEY}"
```

To get API keys for the Elasticsearch endpoint (${ES_URL}) for a project, refer to [Connect to your Elasticsearch Serverless endpoint](https://www.elastic.co/guide/en/serverless/current/elasticsearch-connecting-to-es-serverless-endpoint.html).
For more information about where to find API keys for the Elasticsearch endpoint (${ES_URL}) for a project, go to [Get started with Elasticsearch Serverless](https://www.elastic.co/docs/solutions/search/serverless-elasticsearch-get-started).
in: header
name: Authorization
type: apiKey
Expand Down
48 changes: 24 additions & 24 deletions docs/overlays/elasticsearch-shared-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,21 +39,21 @@ actions:

This API requires the `manage_connector` privilege or, for read-only endpoints, the `monitor_connector` privilege.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/es-connectors-tutorial-api.html
description: Check out the connector API tutorial
url: https://www.elastic.co/docs/reference/search-connectors/api-tutorial
description: Check out the connector API tutorial.
- name: ccr
x-displayName: Cross-cluster replication
# D
- name: data stream
x-displayName: Data stream
externalDocs:
description: Learn more about data streams.
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html
url: https://www.elastic.co/docs/manage-data/data-store/data-streams
- name: document
x-displayName: Document
externalDocs:
description: Learn more about reading and writing documents.
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-replication.html
url: https://www.elastic.co/docs/deploy-manage/distributed-architecture/reading-and-writing-documents
# E
- name: enrich
x-displayName: Enrich
Expand All @@ -62,14 +62,14 @@ actions:
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
url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/eql
description: Learn more about 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
url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql
description: Learn more about ES|QL.
# F
- name: features
Expand All @@ -83,7 +83,7 @@ actions:
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
url: https://www.elastic.co/docs/explore-analyze/visualize/graph
description: Get started with Graph.
# I
- name: indices
Expand All @@ -93,7 +93,7 @@ actions:
- name: ilm
x-displayName: Index lifecycle management
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management.html
url: https://www.elastic.co/docs/manage-data/lifecycle/index-lifecycle-management
description: Learn more about managing the index lifecycle.
- name: inference
x-displayName: Inference
Expand All @@ -118,7 +118,7 @@ actions:
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
url: https://www.elastic.co/docs/reference/logstash/logstash-centralized-pipeline-management
description: Learn more about centralized pipeline management.
# M
- name: ml
Expand All @@ -127,19 +127,19 @@ actions:
x-displayName: Machine learning anomaly detection
# description:
externalDocs:
url: https://www.elastic.co/guide/en/machine-learning/current/ml-ad-finding-anomalies.html
url: https://www.elastic.co/docs/explore-analyze/machine-learning/anomaly-detection/ml-ad-finding-anomalies
description: Learn more about finding anomalies.
- name: ml data frame
x-displayName: Machine learning data frame analytics
# description:
externalDocs:
url: https://www.elastic.co/guide/en/machine-learning/current/ml-dfa-overview.html
url: https://www.elastic.co/docs/explore-analyze/machine-learning/data-frame-analytics/ml-dfa-overview
description: Learn more about data frame analytics.
- name: ml trained model
x-displayName: Machine learning trained model
# description:
externalDocs:
url: https://www.elastic.co/guide/en/machine-learning/current/ml-nlp-overview.html
url: https://www.elastic.co/docs/explore-analyze/machine-learning/nlp/ml-nlp-overview
description: Learn more about natural language processing.
- name: migration
x-displayName: Migration
Expand All @@ -159,7 +159,7 @@ actions:
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
url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rule-query
description: Learn more about the rule query.
# R
- name: rollup
Expand All @@ -171,7 +171,7 @@ actions:
Use the script support APIs to get a list of supported script contexts and languages.
Use the stored script APIs to manage stored scripts and search templates.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html
url: https://www.elastic.co/docs/explore-analyze/scripting
- name: search
x-displayName: Search
- name: search_application
Expand All @@ -185,21 +185,21 @@ actions:
description: >
Snapshot and restore APIs enable you to set up snapshot repositories, manage snapshot backups, and restore snapshots to a running cluster.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-restore.html
url: https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore
description: Learn more about snapshot and restore operations.
- name: slm
x-displayName: Snapshot lifecycle management
description: >
Snapshot lifecycle management (SLM) APIs enable you to set up policies to automatically take snapshots and control how long they are retained.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-take-snapshot.html
url: https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/create-snapshots
description: Learn more about creating a snapshot.
- 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
url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/sql
description: Check out the overview and tutorials for the Elasticsearch SQL features.
- name: synonyms
x-displayName: Synonyms
Expand All @@ -223,7 +223,7 @@ actions:
description: >
You can use Watcher to watch for changes or anomalies in your data and perform the necessary actions in response.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-alerting.html
url: https://www.elastic.co/docs/explore-analyze/alerts-cases/watcher
description: Learn more about Watcher.
# Add x-model and/or abbreviate schemas that should point to other references
- target: "$.components['schemas']['_types.query_dsl.QueryContainer']"
Expand Down Expand Up @@ -257,7 +257,7 @@ actions:
x-model: true
externalDocs:
description: Templating a role query
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/field-and-document-access-control.html#templating-role-query
url: https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/controlling-access-at-document-field-level#templating-role-query
- target: "$.components['schemas']['_types.query_dsl.DistanceFeatureQuery']"
description: Add x-model for distance feature query
update:
Expand Down Expand Up @@ -1006,7 +1006,7 @@ actions:
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
By default, this property has the following value: `{"match_all": {"boost": 1}}`.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl
description: Query DSL
- target: "$.components['schemas']['ml._types.CategorizationAnalyzerDefinition'].properties.tokenizer"
description: Remove tokenizer object from ML anomaly detection analysis config
Expand All @@ -1027,7 +1027,7 @@ actions:
Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2).
`ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify `"tokenizer": "ml_classic"` in your `categorization_analyzer`.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html
url: https://www.elastic.co/docs/reference/text-analysis/tokenizer-reference
description: Tokenizer reference
- target: "$.components['schemas']['ml._types.DataframeAnalyticsSource'].properties.query"
description: Remove query object from data frame analytics source
Expand All @@ -1044,7 +1044,7 @@ actions:
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
By default, this property has the following value: `{"match_all": {}}`.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl
description: Query DSL
- target: "$.components['schemas']['transform._types.Source'].properties.query"
description: Remove query object from transform source
Expand All @@ -1058,14 +1058,14 @@ actions:
description: >
A query clause that retrieves a subset of data from the source index.
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl
description: Query DSL
- target: "$.components['schemas']['_global.search._types.FieldCollapse']"
description: Add x-model and externalDocs
update:
x-model: true
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/collapse-search-results.html
url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/collapse-search-results
# - target: "$.components['schemas']['_global.msearch.MultisearchBody'].properties"
# description: Add x-model
# update:
Expand Down
Loading