Skip to content

Commit

Permalink
Add OpenAPI specification for bulk_get saved object APIs (#6860) (#6865)
Browse files Browse the repository at this point in the history
* Add OpenAPI specification for bulk_get saved object APIs



* Changeset file for PR #6860 created/updated

* Apply suggestions from code review




---------





(cherry picked from commit 6b2db4d)

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>
Signed-off-by: Yuanqi(Ella) Zhu <53279298+zhyuanqi@users.noreply.github.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
Co-authored-by: Lu Yu <nluyu@amazon.com>
  • Loading branch information
4 people authored May 30, 2024
1 parent 83eccef commit 720f7a8
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 1 deletion.
2 changes: 2 additions & 0 deletions changelogs/fragments/6860.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
doc:
- Add OpenAPI specification for bulk_get saved object APIs ([#6860](/~https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6860))
34 changes: 33 additions & 1 deletion docs/openapi/saved_objects/saved_objects.yml
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ paths:
example: 1
- in: query
name: search
description: The search query that filters the saved objects.
description: The simple_query_string query that filters the objects in the response.
schema:
type: string
example: "open*"
Expand Down Expand Up @@ -444,6 +444,38 @@ paths:
application/json:
schema:
type: object
/api/saved_objects/_bulk_get:
get:
tags:
- saved objects
summary: Bulk get saved objects
requestBody:
required: true
description: Array of criteria including id, type, fields used to retrieve matching saved objects
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
required: true
description: Unique id of the saved object.
type:
type: string
required: true
description: The type of saved object.
fields:
type: array
items:
type: string
description: The fields to return in the attributes key of the object response.
example:
- id: 67a9021c-c97e-4499-8150-9722ab44edd4
type: visualization
fields: ['title', 'fieldFormatMap']
components:
parameters:
type:
Expand Down

0 comments on commit 720f7a8

Please sign in to comment.