Skip to content

Commit 5c521a9

Browse files
jloleysensjloleysens
authored
[9.0] [Saved objects] Update import docs (#216658) (#220473)
# Backport This will backport the following commits from `main` to `9.0`: - [[Saved objects] Update import docs (#216658)](#216658) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Jean-Louis Leysens","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-04-02T12:44:38Z","message":"[Saved objects] Update import docs (#216658)\n\n## Summary\n\nClose https://github.com/elastic/kibana/issues/159453\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>","sha":"4d65a1027cfc763862e0556070ec88d156aa8b18","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Core","Feature:Saved Objects","release_note:skip","backport missing","v9.0.0","backport:version","v9.1.0","v8.19.0","v9.0.1"],"title":"[Saved objects] Update import docs","number":216658,"url":"https://github.com/elastic/kibana/pull/216658","mergeCommit":{"message":"[Saved objects] Update import docs (#216658)\n\n## Summary\n\nClose https://github.com/elastic/kibana/issues/159453\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>","sha":"4d65a1027cfc763862e0556070ec88d156aa8b18"}},"sourceBranch":"main","suggestedTargetBranches":["9.0"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/216658","number":216658,"mergeCommit":{"message":"[Saved objects] Update import docs (#216658)\n\n## Summary\n\nClose https://github.com/elastic/kibana/issues/159453\n\n---------\n\nCo-authored-by: kibanamachine <[email protected]>","sha":"4d65a1027cfc763862e0556070ec88d156aa8b18"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/216821","number":216821,"state":"MERGED","mergeCommit":{"sha":"c8fe87cb2b81767a4c69e76f1f2987deda436e26","message":"[8.x] [Saved objects] Update import docs (#216658) (#216821)\n\n# Backport\n\nThis will backport the following commits from `main` to `8.x`:\n- [[Saved objects] Update import docs\n(#216658)](https://github.com/elastic/kibana/pull/216658)\n\n\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sorenlouv/backport)\n\n\n\nCo-authored-by: Jean-Louis Leysens <[email protected]>"}}]}] BACKPORT-->
1 parent 989ad86 commit 5c521a9

File tree

8 files changed

+1529
-7619
lines changed

8 files changed

+1529
-7619
lines changed

‎oas_docs/output/kibana.serverless.yaml‎

Lines changed: 1522 additions & 7612 deletions
Large diffs are not rendered by default.

‎oas_docs/output/kibana.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42288,7 +42288,7 @@ paths:
4228842288
properties:
4228942289
file:
4229042290
description: |
42291-
A file exported using the export API. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.
42291+
A file exported using the export API. Changing the contents of the exported file in any way before importing it can cause errors, crashes or data loss. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.
4229242292
required: true
4229342293
responses:
4229442294
'200':

‎src/core/packages/saved-objects/docs/openapi/bundled.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -683,7 +683,7 @@
683683
"type": "object",
684684
"properties": {
685685
"file": {
686-
"description": "A file exported using the export API. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.\n"
686+
"description": "A file exported using the export API. Changing the contents of the exported file in any way before importing it can cause errors, crashes or data loss. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.\n"
687687
}
688688
}
689689
},

‎src/core/packages/saved-objects/docs/openapi/bundled.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,7 @@ paths:
463463
properties:
464464
file:
465465
description: |
466-
A file exported using the export API. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.
466+
A file exported using the export API. Changing the contents of the exported file in any way before importing it can cause errors, crashes or data loss. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.
467467
examples:
468468
importObjectsRequest:
469469
$ref: '#/components/examples/import_objects_request'

‎src/core/packages/saved-objects/docs/openapi/bundled_serverless.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@
168168
"type": "object",
169169
"properties": {
170170
"file": {
171-
"description": "A file exported using the export API. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.\n"
171+
"description": "A file exported using the export API. Changing the contents of the exported file in any way before importing it can cause errors, crashes or data loss. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.\n"
172172
}
173173
}
174174
},

‎src/core/packages/saved-objects/docs/openapi/bundled_serverless.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ paths:
128128
properties:
129129
file:
130130
description: |
131-
A file exported using the export API. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.
131+
A file exported using the export API. Changing the contents of the exported file in any way before importing it can cause errors, crashes or data loss. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.
132132
examples:
133133
importObjectsRequest:
134134
$ref: '#/components/examples/import_objects_request'

‎src/core/packages/saved-objects/docs/openapi/components/schemas/import_objects_request.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ type: object
22
properties:
33
file:
44
description: |
5-
A file exported using the export API. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.
5+
A file exported using the export API. Changing the contents of the exported file in any way before importing it can cause errors, crashes or data loss. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.

‎src/core/packages/saved-objects/docs/openapi/paths/api@saved_objects@_import.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ post:
3838
properties:
3939
file:
4040
description: |
41-
A file exported using the export API. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.
41+
A file exported using the export API. Changing the contents of the exported file in any way before importing it can cause errors, crashes or data loss. NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be included in this file. Similarly, the `savedObjects.maxImportPayloadBytes` setting limits the overall size of the file that can be imported.
4242
examples:
4343
importObjectsRequest:
4444
$ref: '../components/examples/import_objects_request.yaml'

0 commit comments

Comments
 (0)