Skip to content

Commit e7547bb

Browse files
authored
Add overlay for deep object in security APIs (#2914)
1 parent 966c2f2 commit e7547bb

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,6 @@ info:
44
title: Overlays for changes that apply to both Elasticsearch and Elasticsearch Serverless OpenAPI documents
55
version: 0.0.1
66
actions:
7-
# Add x-model to hide children of schema objects that are defined elsewhere
8-
- target: "$.components['schemas']['_types.query_dsl:QueryContainer']"
9-
description: Add x-model and updated externalDocs for the QueryContainer object
10-
update:
11-
x-model: true
12-
externalDocs:
13-
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/query-dsl.html
14-
description: Query domain specific language (DSL) reference
157
# Add an alphabetically sorted list of tags
168
- target: '$'
179
description: Add document-level tags sorted by display name
@@ -244,6 +236,13 @@ actions:
244236
- name: watcher
245237
x-displayName: Watcher
246238
# Add x-model and/or abbreviate schemas that should point to other references
239+
- target: "$.components['schemas']['_types.query_dsl:QueryContainer']"
240+
description: Add x-model and updated externalDocs for the QueryContainer object
241+
update:
242+
x-model: true
243+
externalDocs:
244+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/query-dsl.html
245+
description: Query domain specific language (DSL) reference
247246
- target: "$.components['schemas']['_types.analysis:CharFilter'].oneOf"
248247
description: Remove existing oneOf definition for CharFilter
249248
remove: true
@@ -280,6 +279,13 @@ actions:
280279
externalDocs:
281280
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/analysis-tokenfilters.html
282281
description: Token filter reference
282+
- target: "$.components['schemas']['security._types:RoleTemplateScript']"
283+
description: Add x-model where recommended by Bump.sh
284+
update:
285+
x-model: true
286+
externalDocs:
287+
description: Templating a role query
288+
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/field-and-document-access-control.html#templating-role-query
283289
# Abbreviate and annotate items that are not shown in Bump.sh due to depth limits
284290
- target: "$.components['schemas']['ml._types:Datafeed'].properties.query"
285291
description: Remove query object from anomaly detection datafeed

0 commit comments

Comments
 (0)