Skip to content

Commit

Permalink
Fix: GET _mapping with index in query.
Browse files Browse the repository at this point in the history
Signed-off-by: dblock <[email protected]>
  • Loading branch information
dblock committed Jul 8, 2024
1 parent a359a5a commit 35f644d
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Fixed optional field in `/_nodes` ([#365](https://github.com/opensearch-project/opensearch-api-specification/pull/365))
- Fixed `/{index}/_open` can return a `task` ([#376](https://github.com/opensearch-project/opensearch-api-specification/pull/376))
- Fixed `_source` in `bulk` responses ([#375](https://github.com/opensearch-project/opensearch-api-specification/pull/375))
- Fixed `/_mapping` with index in query ([#385](https://github.com/opensearch-project/opensearch-api-specification/pull/385))

### Security

Expand Down
11 changes: 11 additions & 0 deletions spec/namespaces/indices.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,7 @@ paths:
externalDocs:
url: https://opensearch.org/docs/latest/field-types/index/#get-a-mapping
parameters:
- $ref: '#/components/parameters/indices.get_mapping::query.index'
- $ref: '#/components/parameters/indices.get_mapping::query.allow_no_indices'
- $ref: '#/components/parameters/indices.get_mapping::query.cluster_manager_timeout'
- $ref: '#/components/parameters/indices.get_mapping::query.expand_wildcards'
Expand Down Expand Up @@ -3780,6 +3781,16 @@ components:
schema:
$ref: '../schemas/_common.yaml#/components/schemas/Indices'
style: simple
indices.get_mapping::query.index:
in: query
name: index
description: |-
Comma-separated list of data streams, indices, and aliases used to limit
the request. Supports wildcards (`*`). To target all data streams and
indices, omit this parameter or use `*` or `_all`.
schema:
type: string
style: form
indices.get_mapping::query.allow_no_indices:
in: query
name: allow_no_indices
Expand Down
54 changes: 54 additions & 0 deletions tests/_core/mapping.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
$schema: ../../json_schemas/test_story.schema.yaml

description: Test mappings endpoints.
prologues:
- path: /{index}
method: PUT
parameters:
index: movies
request_body:
payload:
mappings:
properties:
director:
type: text
year:
type: integer
location:
type: ip
ignore_malformed: true
epilogues:
- path: /movies
method: DELETE
status: [200, 404]
chapters:
- synopsis: Get mappings for an index (index in query).
path: /_mapping
method: GET
parameters:
index: movies
response:
status: 200
payload:
movies:
mappings:
properties:
director:
type: text
year:
type: integer
- synopsis: Get mappings for an index (index in path).
path: /{index}/_mapping
method: GET
parameters:
index: movies
response:
status: 200
payload:
movies:
mappings:
properties:
director:
type: text
year:
type: integer

0 comments on commit 35f644d

Please sign in to comment.