[SO] Discourage tampering with exported SOs in _import and _export docs (#222336)

## Summary

Per the title.
This commit is contained in:
Jean-Louis Leysens 2025-06-04 10:24:51 +02:00 committed by GitHub
parent 7f5aa3e269
commit 8646251178
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 18 additions and 11 deletions

View file

@ -47220,7 +47220,7 @@
},
"/api/saved_objects/_export": {
"post": {
"description": "Retrieve sets of saved objects that you want to import into Kibana. You 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.",
"description": "Retrieve sets of saved objects that you want to import into Kibana. You must include `type` or `objects` in the request body. The output of exporting saved objects must be treated as opaque. Tampering with exported data risks introducing unspecified errors and data loss.\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.",
"operationId": "post-saved-objects-export",
"parameters": [
{
@ -47437,7 +47437,7 @@
},
"/api/saved_objects/_import": {
"post": {
"description": "Create sets of Kibana saved objects from a file created by the export API. Saved objects can only be imported 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.",
"description": "Create sets of Kibana saved objects from a file created by the export API. Saved objects can only be imported into the same version, a newer minor on the same major, or the next major. Tampering with exported data risks introducing unspecified errors and data loss.\n\nExported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.",
"operationId": "post-saved-objects-import",
"parameters": [
{

View file

@ -47220,7 +47220,7 @@
},
"/api/saved_objects/_export": {
"post": {
"description": "Retrieve sets of saved objects that you want to import into Kibana. You 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.",
"description": "Retrieve sets of saved objects that you want to import into Kibana. You must include `type` or `objects` in the request body. The output of exporting saved objects must be treated as opaque. Tampering with exported data risks introducing unspecified errors and data loss.\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.",
"operationId": "post-saved-objects-export",
"parameters": [
{
@ -47437,7 +47437,7 @@
},
"/api/saved_objects/_import": {
"post": {
"description": "Create sets of Kibana saved objects from a file created by the export API. Saved objects can only be imported 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.",
"description": "Create sets of Kibana saved objects from a file created by the export API. Saved objects can only be imported into the same version, a newer minor on the same major, or the next major. Tampering with exported data risks introducing unspecified errors and data loss.\n\nExported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.",
"operationId": "post-saved-objects-import",
"parameters": [
{

View file

@ -43961,7 +43961,7 @@ paths:
/api/saved_objects/_export:
post:
description: |-
Retrieve sets of saved objects that you want to import into Kibana. You must include `type` or `objects` in the request body.
Retrieve sets of saved objects that you want to import into Kibana. You must include `type` or `objects` in the request body. The output of exporting saved objects must be treated as opaque. Tampering with exported data risks introducing unspecified errors and data loss.
Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.
@ -44108,7 +44108,10 @@ paths:
- saved objects
/api/saved_objects/_import:
post:
description: Create sets of Kibana saved objects from a file created by the export API. Saved objects can only be imported 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.
description: |-
Create sets of Kibana saved objects from a file created by the export API. Saved objects can only be imported into the same version, a newer minor on the same major, or the next major. Tampering with exported data risks introducing unspecified errors and data loss.
Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.
operationId: post-saved-objects-import
parameters:
- description: A required header to protect against CSRF attacks

View file

@ -46535,7 +46535,7 @@ paths:
/api/saved_objects/_export:
post:
description: |-
Retrieve sets of saved objects that you want to import into Kibana. You must include `type` or `objects` in the request body.
Retrieve sets of saved objects that you want to import into Kibana. You must include `type` or `objects` in the request body. The output of exporting saved objects must be treated as opaque. Tampering with exported data risks introducing unspecified errors and data loss.
Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.
@ -46784,7 +46784,10 @@ paths:
- saved objects
/api/saved_objects/_import:
post:
description: Create sets of Kibana saved objects from a file created by the export API. Saved objects can only be imported 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.
description: |-
Create sets of Kibana saved objects from a file created by the export API. Saved objects can only be imported into the same version, a newer minor on the same major, or the next major. Tampering with exported data risks introducing unspecified errors and data loss.
Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.
operationId: post-saved-objects-import
parameters:
- description: A required header to protect against CSRF attacks

View file

@ -150,7 +150,7 @@ export const registerExportRoute = (
summary: `Export saved objects`,
tags: ['oas-tag:saved objects'],
access: 'public',
description: `Retrieve sets of saved objects that you want to import into Kibana. You must include \`type\` or \`objects\` in the request body.
description: `Retrieve sets of saved objects that you want to import into Kibana. You must include \`type\` or \`objects\` in the request body. The output of exporting saved objects must be treated as opaque. Tampering with exported data risks introducing unspecified errors and data loss.
Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.

View file

@ -42,8 +42,9 @@ export const registerImportRoute = (
summary: `Import saved objects`,
tags: ['oas-tag:saved objects'],
access: 'public',
description:
'Create sets of Kibana saved objects from a file created by the export API. Saved objects can only be imported 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.',
description: `Create sets of Kibana saved objects from a file created by the export API. Saved objects can only be imported into the same version, a newer minor on the same major, or the next major. Tampering with exported data risks introducing unspecified errors and data loss.
Exported saved objects are not backwards compatible and cannot be imported into an older version of Kibana.`,
body: {
maxBytes: maxImportPayloadBytes,
output: 'stream',