Skip to content
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

[DOCS][OAS] Add data view swap saved object references and preview APIs #187927

Merged
merged 13 commits into from
Jul 24, 2024
2 changes: 1 addition & 1 deletion docs/api/data-views.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[data-views-api]]
== Data views API

experimental[] Manage data views, formerly known as {kib} index patterns.
Manage data views, formerly known as {kib} index patterns.

WARNING: Do not write documents directly to the `.kibana` index. When you write directly
to the `.kibana` index, the data becomes corrupted and permanently breaks future {kib} versions.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/data-views/create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Create data view</titleabbrev>
++++

experimental[] Create data views.
Create data views.

[NOTE]
====
Expand Down
2 changes: 1 addition & 1 deletion docs/api/data-views/default-get.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Get default data view</titleabbrev>
++++

experimental[] Retrieve a default data view ID. Kibana UI uses the default data view unless user picks a different one.
Retrieve a default data view ID. Kibana UI uses the default data view unless user picks a different one.

[NOTE]
====
Expand Down
2 changes: 1 addition & 1 deletion docs/api/data-views/default-set.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Set default data view</titleabbrev>
++++

experimental[] Set a default data view ID. Kibana UI will use the default data view unless user picks a different one.
Set a default data view ID. Kibana UI will use the default data view unless user picks a different one.
The API doesn't validate if given `data_view_id` is a valid id.

[NOTE]
Expand Down
2 changes: 1 addition & 1 deletion docs/api/data-views/delete.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Delete data view</titleabbrev>
++++

experimental[] Delete data views.
Delete data views.

WARNING: Once you delete a data view, _it cannot be recovered_.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/data-views/get-all.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Get all data views</titleabbrev>
++++

experimental[] Retrieve a list of all data views.
Retrieve a list of all data views.

[NOTE]
====
Expand Down
2 changes: 1 addition & 1 deletion docs/api/data-views/get.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Get data view</titleabbrev>
++++

experimental[] Retrieve a single data view by ID.
Retrieve a single data view by ID.

[NOTE]
====
Expand Down
2 changes: 1 addition & 1 deletion docs/api/data-views/runtime-fields/create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Create runtime field</titleabbrev>
++++

experimental[] Create a runtime field
Create a runtime field

[[data-views-runtime-field-create-request]]
==== Request
Expand Down
2 changes: 1 addition & 1 deletion docs/api/data-views/runtime-fields/delete.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Delete runtime field</titleabbrev>
++++

experimental[] Delete a runtime field from a data view.
Delete a runtime field from a data view.

[[data-views-runtime-field-api-delete-request]]
==== Request
Expand Down
2 changes: 1 addition & 1 deletion docs/api/data-views/runtime-fields/get.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Get runtime field</titleabbrev>
++++

experimental[] Get a runtime field
Get a runtime field

[NOTE]
====
Expand Down
2 changes: 1 addition & 1 deletion docs/api/data-views/runtime-fields/update.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Update runtime field</titleabbrev>
++++

experimental[] Update an existing runtime field
Update an existing runtime field


[[data-views-runtime-field-update-request]]
Expand Down
2 changes: 1 addition & 1 deletion docs/api/data-views/runtime-fields/upsert.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Upsert runtime field</titleabbrev>
++++

experimental[] Create or update an existing runtime field
Create or update an existing runtime field


[[data-views-runtime-field-upsert-request]]
Expand Down
2 changes: 1 addition & 1 deletion docs/api/data-views/update-fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Update data view fields metadata</titleabbrev>
++++

experimental[] Update fields presentation metadata, such as `count`,
Update fields presentation metadata, such as `count`,
`customLabel`, `customDescription`, and `format`. You can update multiple fields in one request. Updates
are merged with persisted metadata. To remove existing metadata, specify `null` as the value.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/data-views/update.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Update data view</titleabbrev>
++++

experimental[] Update part of an data view. Only the specified fields are updated in the
Update part of an data view. Only the specified fields are updated in the
data view. Unspecified fields stay as they are persisted.

[NOTE]
Expand Down
8 changes: 4 additions & 4 deletions oas_docs/.spectral.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ rules:
description: Response code 200 should have at least one example.
message: "Each response body should have a realistic example. It must not contain any sensitive or confidential data."
severity: info
given: $.paths[*].[*].responses.[200].content.[application/json]
given: $.paths[*][*].responses.[200].content.[application/json]
then:
field: examples
function: defined
Expand All @@ -57,7 +57,7 @@ rules:
description: Operations should not have x-internal extension.
message: "Do not publish x-internal operations"
severity: error
given: $.paths[*].[get,put,post,delete,options,head,patch,trace]
given: $.paths[*][*]
then:
field: x-internal
function: undefined
Expand All @@ -67,13 +67,13 @@ rules:
message: "Each operation should have a summary"
severity: error
recommended: true
given: $.paths[*].[get,put,post,delete,options,head,patch,trace]
given: $.paths[*][*]
then:
field: summary
function: defined
operation-summary-length:
description: Operation summary should be between 5 and 45 characters
given: "$.paths[*].[get,put,post,delete,options,head,patch,trace]"
given: "$.paths[*][*]"
then:
field: summary
function: length
Expand Down
Loading