Skip to content

Commit 677bc9d

Browse files
authored
Merge branch 'main' into feat-selection
2 parents 4a29bb2 + 089a2de commit 677bc9d

File tree

3 files changed

+49
-0
lines changed

3 files changed

+49
-0
lines changed

changelogs/fragments/6855.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
doc:
2+
- Add example for saved object creation part for openapi doc. ([#6855](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/6855))

docs/_sidebar.md

+3
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
- [Client_management_design](multi-datasource/client_management_design.md)
1111
- [High_level_design](multi-datasource/high_level_design.md)
1212
- [User_stories](multi-datasource/user_stories.md)
13+
- [Openapi](openapi/README.md)
1314
- Plugins
1415
- [Data_persistence](plugins/data_persistence.md)
1516
- Saved_objects
@@ -159,6 +160,7 @@
159160
- [Opensearch dashboards.release notes 2.11.1](../release-notes/opensearch-dashboards.release-notes-2.11.1.md)
160161
- [Opensearch dashboards.release notes 2.12.0](../release-notes/opensearch-dashboards.release-notes-2.12.0.md)
161162
- [Opensearch dashboards.release notes 2.13.0](../release-notes/opensearch-dashboards.release-notes-2.13.0.md)
163+
- [Opensearch dashboards.release notes 2.14.0](../release-notes/opensearch-dashboards.release-notes-2.14.0.md)
162164
- [Opensearch dashboards.release notes 2.2.0](../release-notes/opensearch-dashboards.release-notes-2.2.0.md)
163165
- [Opensearch dashboards.release notes 2.2.1](../release-notes/opensearch-dashboards.release-notes-2.2.1.md)
164166
- [Opensearch dashboards.release notes 2.3.0](../release-notes/opensearch-dashboards.release-notes-2.3.0.md)
@@ -172,6 +174,7 @@
172174
- scripts
173175
- [README](../scripts/README.md)
174176
- [DOCS_README](DOCS_README.md)
177+
- [Theme](theme.md)
175178
- [CHANGELOG](../CHANGELOG.md)
176179
- [CODE_OF_CONDUCT](../CODE_OF_CONDUCT.md)
177180
- [COMMUNICATIONS](../COMMUNICATIONS.md)

docs/openapi/saved_objects/saved_objects.yml

+44
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,50 @@ paths:
8080
items:
8181
type: string
8282
description: Workspaces that this saved object exists in.
83+
examples:
84+
indexPattern:
85+
summary: Example of creating an index pattern saved object
86+
value:
87+
attributes:
88+
title: 'my-index-pattern'
89+
fields: '[{"count":"1","name":"@timestamp","searchable":"true"}]'
90+
references:
91+
- id: '51339560-1d7c-11ef-b757-55fac6c80d9a'
92+
name: 'dataSource'
93+
type: 'data-source'
94+
vegaVisualization:
95+
summary: Example of creating a Vega visualization saved object
96+
value:
97+
attributes:
98+
title: 'my-vega-visualization'
99+
visState: '{"title":"vegaVisualization","type":"vega","aggs":[]}}'
100+
uiStateJSON: '{}'
101+
description: ''
102+
version: 1
103+
kibanaSavedObjectMeta: {
104+
searchSourceJSON: '{"query":{"language":"kuery","query":""},"filter":[]}'
105+
}
106+
references:
107+
- id: '51339560-1d7c-11ef-b757-55fac6c80d9a'
108+
name: 'dataSource'
109+
type: 'data-source'
110+
dashboards:
111+
summary: Example of creating a dashboard saved object
112+
value:
113+
attributes:
114+
title: 'Revenue Dashboard'
115+
description: 'Revenue dashboard'
116+
panelsJSON: '[{"version":"2.9.0","gridData":{"x":0,"y":0,"w":24,"h":15,"i":"5db1d75d-f680-4869-a0e8-0f2b8b05b99c"},"panelIndex":"5db1d75d-f680-4869-a0e8-0f2b8b05b99c","embeddableConfig":{},"panelRefName":"panel_0"}]'
117+
optionsJSON: '{"hidePanelTitles":false,"useMargins":true}'
118+
version: 1
119+
timeRestore: true
120+
kibanaSavedObjectMeta: {
121+
searchSourceJSON: '{"query":{"language":"kuery","query":""},"filter":[]}'
122+
}
123+
references:
124+
- id: '37cc8650-b882-11e8-a6d9-e546fe2bba5f'
125+
name: 'panel_0'
126+
type: 'visualization'
83127
responses:
84128
'200':
85129
description: The creation request is successful

0 commit comments

Comments
 (0)