Skip to content

[Backport 8.x] Add overlay for deep object in security APIs (#2914) #3022

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
Oct 16, 2024
Merged
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
22 changes: 14 additions & 8 deletions docs/overlays/elasticsearch-shared-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,6 @@ info:
title: Overlays for changes that apply to both Elasticsearch and Elasticsearch Serverless OpenAPI documents
version: 0.0.1
actions:
# Add x-model to hide children of schema objects that are defined elsewhere
- target: "$.components['schemas']['_types.query_dsl:QueryContainer']"
description: Add x-model and updated externalDocs for the QueryContainer object
update:
x-model: true
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
description: Query domain specific language (DSL) reference
# Add an alphabetically sorted list of tags
- target: '$'
description: Add document-level tags sorted by display name
Expand Down Expand Up @@ -244,6 +236,13 @@ actions:
- name: watcher
x-displayName: Watcher
# Add x-model and/or abbreviate schemas that should point to other references
- target: "$.components['schemas']['_types.query_dsl:QueryContainer']"
description: Add x-model and updated externalDocs for the QueryContainer object
update:
x-model: true
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
description: Query domain specific language (DSL) reference
- target: "$.components['schemas']['_types.analysis:CharFilter'].oneOf"
description: Remove existing oneOf definition for CharFilter
remove: true
Expand Down Expand Up @@ -280,6 +279,13 @@ actions:
externalDocs:
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenfilters.html
description: Token filter reference
- target: "$.components['schemas']['security._types:RoleTemplateScript']"
description: Add x-model where recommended by Bump.sh
update:
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
# Abbreviate and annotate items that are not shown in Bump.sh due to depth limits
- target: "$.components['schemas']['ml._types:Datafeed'].properties.query"
description: Remove query object from anomaly detection datafeed
Expand Down
Loading