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

[API][DOCS] Add x-state to saved object APIs #196783

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 2 additions & 12 deletions oas_docs/output/kibana.serverless.staging.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35790,12 +35790,6 @@ paths:

NOTE: The `savedObjects.maxImportExportSize` configuration setting
limits the number of saved objects which may be exported.


This functionality is in technical preview and may be changed or removed
in a future release. Elastic will work to fix any issues, but features
in technical preview are not subject to the support SLA of official GA
features.
operationId: exportSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Serverless_saved_objects_kbn_xsrf'
Expand Down Expand Up @@ -35854,6 +35848,7 @@ paths:
summary: Export saved objects
tags:
- saved objects
x-state: Technical preview
/api/saved_objects/_import:
post:
description: >
Expand All @@ -35864,12 +35859,6 @@ paths:
on the same major, or the next major. Exported saved objects are not
backwards compatible and cannot be imported into an older version of
Kibana.


This functionality is in technical preview and may be changed or removed
in a future release. Elastic will work to fix any issues, but features
in technical preview are not subject to the support SLA of official GA
features.
operationId: importSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Serverless_saved_objects_kbn_xsrf'
Expand Down Expand Up @@ -35988,6 +35977,7 @@ paths:
-X POST api/saved_objects/_import?createNewCopies=true
-H "kbn-xsrf: true"
--form [email protected]
x-state: Technical preview
/api/security_ai_assistant/anonymization_fields/_bulk_action:
post:
description: >-
Expand Down
14 changes: 2 additions & 12 deletions oas_docs/output/kibana.serverless.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35790,12 +35790,6 @@ paths:

NOTE: The `savedObjects.maxImportExportSize` configuration setting
limits the number of saved objects which may be exported.


This functionality is in technical preview and may be changed or removed
in a future release. Elastic will work to fix any issues, but features
in technical preview are not subject to the support SLA of official GA
features.
operationId: exportSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Serverless_saved_objects_kbn_xsrf'
Expand Down Expand Up @@ -35854,6 +35848,7 @@ paths:
summary: Export saved objects
tags:
- saved objects
x-state: Technical preview
/api/saved_objects/_import:
post:
description: >
Expand All @@ -35864,12 +35859,6 @@ paths:
on the same major, or the next major. Exported saved objects are not
backwards compatible and cannot be imported into an older version of
Kibana.


This functionality is in technical preview and may be changed or removed
in a future release. Elastic will work to fix any issues, but features
in technical preview are not subject to the support SLA of official GA
features.
operationId: importSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Serverless_saved_objects_kbn_xsrf'
Expand Down Expand Up @@ -35988,6 +35977,7 @@ paths:
-X POST api/saved_objects/_import?createNewCopies=true
-H "kbn-xsrf: true"
--form [email protected]
x-state: Technical preview
/api/security_ai_assistant/anonymization_fields/_bulk_action:
post:
description: >-
Expand Down
33 changes: 5 additions & 28 deletions oas_docs/output/kibana.staging.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10413,12 +10413,6 @@ paths:
but if you're dealing with a large number of saved objects and
experiencing performance issues, you may want to rotate the encryption
key.


This functionality is in technical preview and may be changed or removed
in a future release. Elastic will work to fix any issues, but features
in technical preview are not subject to the support SLA of official GA
features.
operationId: rotateEncryptionKey
parameters:
- description: >
Expand Down Expand Up @@ -10494,6 +10488,7 @@ paths:
summary: Rotate a key for encrypted saved objects
tags:
- saved objects
x-state: Technical preview
/api/endpoint_list:
post:
description: >-
Expand Down Expand Up @@ -39413,12 +39408,6 @@ paths:

NOTE: The `savedObjects.maxImportExportSize` configuration setting
limits the number of saved objects which may be exported.


This functionality is in technical preview and may be changed or removed
in a future release. Elastic will work to fix any issues, but features
in technical preview are not subject to the support SLA of official GA
features.
operationId: exportSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Saved_objects_kbn_xsrf'
Expand Down Expand Up @@ -39475,6 +39464,7 @@ paths:
summary: Export saved objects
tags:
- saved objects
x-state: Technical preview
/api/saved_objects/_find:
get:
deprecated: true
Expand Down Expand Up @@ -39617,12 +39607,6 @@ paths:
on the same major, or the next major. Exported saved objects are not
backwards compatible and cannot be imported into an older version of
Kibana.


This functionality is in technical preview and may be changed or removed
in a future release. Elastic will work to fix any issues, but features
in technical preview are not subject to the support SLA of official GA
features.
operationId: importSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Saved_objects_kbn_xsrf'
Expand Down Expand Up @@ -39739,23 +39723,15 @@ paths:
-X POST api/saved_objects/_import?createNewCopies=true
-H "kbn-xsrf: true"
--form [email protected]
x-state: Technical preview
/api/saved_objects/_resolve_import_errors:
post:
description: >
description: |
To resolve errors from the Import objects API, you can:


* Retry certain saved objects

* Overwrite specific saved objects

* Change references to different saved objects


This functionality is in technical preview and may be changed or removed
in a future release. Elastic will work to fix any issues, but features
in technical preview are not subject to the support SLA of official GA
features.
operationId: resolveImportErrors
parameters:
- $ref: '#/components/parameters/Saved_objects_kbn_xsrf'
Expand Down Expand Up @@ -39897,6 +39873,7 @@ paths:
summary: Resolve import errors
tags:
- saved objects
x-state: Technical preview
/api/saved_objects/{type}:
post:
deprecated: true
Expand Down
33 changes: 5 additions & 28 deletions oas_docs/output/kibana.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10413,12 +10413,6 @@ paths:
but if you're dealing with a large number of saved objects and
experiencing performance issues, you may want to rotate the encryption
key.


This functionality is in technical preview and may be changed or removed
in a future release. Elastic will work to fix any issues, but features
in technical preview are not subject to the support SLA of official GA
features.
operationId: rotateEncryptionKey
parameters:
- description: >
Expand Down Expand Up @@ -10494,6 +10488,7 @@ paths:
summary: Rotate a key for encrypted saved objects
tags:
- saved objects
x-state: Technical preview
/api/endpoint_list:
post:
description: >-
Expand Down Expand Up @@ -39413,12 +39408,6 @@ paths:

NOTE: The `savedObjects.maxImportExportSize` configuration setting
limits the number of saved objects which may be exported.


This functionality is in technical preview and may be changed or removed
in a future release. Elastic will work to fix any issues, but features
in technical preview are not subject to the support SLA of official GA
features.
operationId: exportSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Saved_objects_kbn_xsrf'
Expand Down Expand Up @@ -39475,6 +39464,7 @@ paths:
summary: Export saved objects
tags:
- saved objects
x-state: Technical preview
/api/saved_objects/_find:
get:
deprecated: true
Expand Down Expand Up @@ -39617,12 +39607,6 @@ paths:
on the same major, or the next major. Exported saved objects are not
backwards compatible and cannot be imported into an older version of
Kibana.


This functionality is in technical preview and may be changed or removed
in a future release. Elastic will work to fix any issues, but features
in technical preview are not subject to the support SLA of official GA
features.
operationId: importSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Saved_objects_kbn_xsrf'
Expand Down Expand Up @@ -39739,23 +39723,15 @@ paths:
-X POST api/saved_objects/_import?createNewCopies=true
-H "kbn-xsrf: true"
--form [email protected]
x-state: Technical preview
/api/saved_objects/_resolve_import_errors:
post:
description: >
description: |
To resolve errors from the Import objects API, you can:


* Retry certain saved objects

* Overwrite specific saved objects

* Change references to different saved objects


This functionality is in technical preview and may be changed or removed
in a future release. Elastic will work to fix any issues, but features
in technical preview are not subject to the support SLA of official GA
features.
operationId: resolveImportErrors
parameters:
- $ref: '#/components/parameters/Saved_objects_kbn_xsrf'
Expand Down Expand Up @@ -39897,6 +39873,7 @@ paths:
summary: Resolve import errors
tags:
- saved objects
x-state: Technical preview
/api/saved_objects/{type}:
post:
deprecated: true
Expand Down
12 changes: 8 additions & 4 deletions packages/core/saved-objects/docs/openapi/bundled.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@
"post": {
"summary": "Rotate a key for encrypted saved objects",
"operationId": "rotateEncryptionKey",
"description": "Superuser role required.\n\nIf a saved object cannot be decrypted using the primary encryption key, then Kibana will attempt to decrypt it using the specified decryption-only keys. In most of the cases this overhead is negligible, but if you're dealing with a large number of saved objects and experiencing performance issues, you may want to rotate the encryption key.\n\nThis functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "Superuser role required.\n\nIf a saved object cannot be decrypted using the primary encryption key, then Kibana will attempt to decrypt it using the specified decryption-only keys. In most of the cases this overhead is negligible, but if you're dealing with a large number of saved objects and experiencing performance issues, you may want to rotate the encryption key.\n",
"x-state": "Technical preview",
"tags": [
"saved objects"
],
Expand Down Expand Up @@ -380,7 +381,8 @@
"post": {
"summary": "Export saved objects",
"operationId": "exportSavedObjectsDefault",
"description": "Retrieve sets of saved objects that you want to import into Kibana.\nYou must include `type` or `objects` in the request body.\n\nExported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.\n\nNOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be exported.\n\nThis functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "Retrieve sets of saved objects that you want to import into Kibana.\nYou must include `type` or `objects` in the request body.\n\nExported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.\n\nNOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be exported.\n",
"x-state": "Technical preview",
"tags": [
"saved objects"
],
Expand Down Expand Up @@ -639,7 +641,8 @@
"post": {
"summary": "Import saved objects",
"operationId": "importSavedObjectsDefault",
"description": "Create sets of Kibana saved objects from a file created by the export API.\nSaved objects can be imported only into the same version, a newer minor on the same major, or the next major. Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.\n\nThis functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "Create sets of Kibana saved objects from a file created by the export API.\nSaved objects can be imported only into the same version, a newer minor on the same major, or the next major. Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.\n",
"x-state": "Technical preview",
"tags": [
"saved objects"
],
Expand Down Expand Up @@ -759,7 +762,8 @@
"post": {
"summary": "Resolve import errors",
"operationId": "resolveImportErrors",
"description": "To resolve errors from the Import objects API, you can:\n\n* Retry certain saved objects\n* Overwrite specific saved objects\n* Change references to different saved objects\n\nThis functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "To resolve errors from the Import objects API, you can:\n\n* Retry certain saved objects\n* Overwrite specific saved objects\n* Change references to different saved objects\n",
"x-state": "Technical preview",
"tags": [
"saved objects"
],
Expand Down
12 changes: 4 additions & 8 deletions packages/core/saved-objects/docs/openapi/bundled.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ paths:
Superuser role required.

If a saved object cannot be decrypted using the primary encryption key, then Kibana will attempt to decrypt it using the specified decryption-only keys. In most of the cases this overhead is negligible, but if you're dealing with a large number of saved objects and experiencing performance issues, you may want to rotate the encryption key.

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
x-state: Technical preview
tags:
- saved objects
parameters:
Expand Down Expand Up @@ -270,8 +269,7 @@ paths:
Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.

NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be exported.

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
x-state: Technical preview
tags:
- saved objects
parameters:
Expand Down Expand Up @@ -431,8 +429,7 @@ paths:
description: |
Create sets of Kibana saved objects from a file created by the export API.
Saved objects can be imported only into the same version, a newer minor on the same major, or the next major. Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
x-state: Technical preview
tags:
- saved objects
parameters:
Expand Down Expand Up @@ -529,8 +526,7 @@ paths:
* Retry certain saved objects
* Overwrite specific saved objects
* Change references to different saved objects

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
x-state: Technical preview
tags:
- saved objects
parameters:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@
"post": {
"summary": "Export saved objects",
"operationId": "exportSavedObjectsDefault",
"description": "Retrieve sets of saved objects that you want to import into Kibana.\nYou must include `type` or `objects` in the request body.\n\nExported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.\n\nNOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be exported.\n\nThis functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "Retrieve sets of saved objects that you want to import into Kibana.\nYou must include `type` or `objects` in the request body.\n\nExported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.\n\nNOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be exported.\n",
"x-state": "Technical preview",
"tags": [
"saved objects"
],
Expand Down Expand Up @@ -124,7 +125,8 @@
"post": {
"summary": "Import saved objects",
"operationId": "importSavedObjectsDefault",
"description": "Create sets of Kibana saved objects from a file created by the export API.\nSaved objects can be imported only into the same version, a newer minor on the same major, or the next major. Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.\n\nThis functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
"description": "Create sets of Kibana saved objects from a file created by the export API.\nSaved objects can be imported only into the same version, a newer minor on the same major, or the next major. Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.\n",
"x-state": "Technical preview",
"tags": [
"saved objects"
],
Expand Down
Loading