Skip to content

Commit

Permalink
[docs] Remove experimental message from saved objects import and expo…
Browse files Browse the repository at this point in the history
…rt apis (elastic#202173)

## Summary

resolves elastic#159454

Remove experimental message from saved objects import and export apis.


### Checklist

Check the PR satisfies following conditions. 

Reviewers should verify this PR satisfies this list as well.

- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials

### Identify risks

Does this PR introduce any risks? For example, consider risks like hard
to test bugs, performance regression, potential of data loss.

Describe the risk, its severity, and mitigation for each identified
risk. Invite stakeholders and evaluate how to proceed before merging.

---------

Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Elastic Machine <[email protected]>
  • Loading branch information
3 people authored and CAWilson94 committed Dec 12, 2024
1 parent 4b97289 commit 5d1f338
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 37 deletions.
4 changes: 0 additions & 4 deletions oas_docs/output/kibana.serverless.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32227,8 +32227,6 @@ 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.
operationId: exportSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Serverless_saved_objects_kbn_xsrf'
Expand Down Expand Up @@ -32287,8 +32285,6 @@ 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.
operationId: importSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Serverless_saved_objects_kbn_xsrf'
Expand Down
10 changes: 2 additions & 8 deletions oas_docs/output/kibana.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35070,7 +35070,7 @@ paths:
schema:
type: object
description: |
Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
Expand Down Expand Up @@ -35102,7 +35102,7 @@ paths:
schema:
type: object
description: |
Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
'400':
content:
application/json; Elastic-Api-Version=2023-10-31:
Expand All @@ -35121,8 +35121,6 @@ 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.
operationId: exportSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Saved_objects_kbn_xsrf'
Expand Down Expand Up @@ -35282,8 +35280,6 @@ 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.
operationId: importSavedObjectsDefault
parameters:
- $ref: '#/components/parameters/Saved_objects_kbn_xsrf'
Expand Down Expand Up @@ -35380,8 +35376,6 @@ 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.
operationId: resolveImportErrors
parameters:
- $ref: '#/components/parameters/Saved_objects_kbn_xsrf'
Expand Down
8 changes: 4 additions & 4 deletions packages/core/saved-objects/docs/openapi/bundled.json
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@
"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",
"tags": [
"saved objects"
],
Expand Down Expand Up @@ -639,7 +639,7 @@
"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",
"tags": [
"saved objects"
],
Expand Down Expand Up @@ -759,7 +759,7 @@
"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",
"tags": [
"saved objects"
],
Expand Down Expand Up @@ -1423,4 +1423,4 @@
}
}
}
}
}
10 changes: 2 additions & 8 deletions packages/core/saved-objects/docs/openapi/bundled.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ paths:
responses:
'200':
description: |
Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
content:
application/json:
schema:
Expand Down Expand Up @@ -248,7 +248,7 @@ paths:
responses:
'200':
description: |
Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
content:
application/json:
schema:
Expand All @@ -270,8 +270,6 @@ 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.
tags:
- saved objects
parameters:
Expand Down Expand Up @@ -431,8 +429,6 @@ 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.
tags:
- saved objects
parameters:
Expand Down Expand Up @@ -529,8 +525,6 @@ 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.
tags:
- saved objects
parameters:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"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",
"tags": [
"saved objects"
],
Expand Down Expand Up @@ -124,7 +124,7 @@
"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",
"tags": [
"saved objects"
],
Expand Down Expand Up @@ -358,4 +358,4 @@
}
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@ 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.
tags:
- saved objects
parameters:
Expand Down Expand Up @@ -96,8 +94,6 @@ 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.
tags:
- saved objects
parameters:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ post:
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.
tags:
- saved objects
parameters:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ post:
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.
tags:
- saved objects
parameters:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ post:
* 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.
tags:
- saved objects
parameters:
Expand Down

0 comments on commit 5d1f338

Please sign in to comment.