Lint operation summaries

elastic · Jun 4, 2024 · 5ed720f · 5ed720f
1 parent b126d71
commit 5ed720f
Show file tree

Hide file tree

Showing 9 changed files with 935 additions and 20 deletions.
diff --git a/packages/core/saved-objects/docs/openapi/bundled.json b/packages/core/saved-objects/docs/openapi/bundled.json
@@ -384,9 +384,9 @@
     },
     "/api/saved_objects/_export": {
       "post": {
-        "summary": "Retrieve sets of saved objects that you want to import into Kibana.",
+        "summary": "Export saved objects",
         "operationId": "exportSavedObjectsDefaultSpace",
-        "description": "\nYou must include `type` or `objects` in the request body.\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\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",
         "tags": [
           "saved objects"
         ],
@@ -610,9 +610,9 @@
     },
     "/api/saved_objects/_import": {
       "post": {
-        "summary": "Create sets of Kibana saved objects from a file created by the export API.",
+        "summary": "Import saved objects",
         "operationId": "importSavedObjectsDefaultSpace",
-        "description": "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.\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": "Creates 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",
         "tags": [
           "saved objects"
         ],
@@ -1123,9 +1123,9 @@
     },
     "/s/{spaceId}/api/saved_objects/_export": {
       "post": {
-        "summary": "Retrieve sets of saved objects that you want to import into Kibana.",
+        "summary": "Export saved objects",
         "operationId": "exportSavedObjects",
-        "description": "\nYou must include `type` or `objects` in the request body.\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": "Retrieves sets of saved objects that you want to import into Kibana.\nYou must include `type` or `objects` in the request body.\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",
         "tags": [
           "saved objects"
         ],
@@ -1184,9 +1184,9 @@
     },
     "/s/{spaceId}/api/saved_objects/_import": {
       "post": {
-        "summary": "Create sets of Kibana saved objects from a file created by the export API.",
+        "summary": "Import saved objects",
         "operationId": "importSavedObjects",
-        "description": "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.\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": "Creates 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",
         "tags": [
           "saved objects"
         ],

diff --git a/packages/core/saved-objects/docs/openapi/bundled.yaml b/packages/core/saved-objects/docs/openapi/bundled.yaml
@@ -252,10 +252,10 @@ paths:
                 $ref: '#/components/schemas/400_response'
   /api/saved_objects/_export:
     post:
-      summary: Retrieve sets of saved objects that you want to import into Kibana.
+      summary: Export saved objects
       operationId: exportSavedObjectsDefaultSpace
       description: |
-
+        Retrieve sets of saved objects that you want to import into Kibana.
         You must include `type` or `objects` in the request body.
 
         NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be exported.
@@ -394,9 +394,10 @@ paths:
                 $ref: '#/components/schemas/400_response'
   /api/saved_objects/_import:
     post:
-      summary: Create sets of Kibana saved objects from a file created by the export API.
+      summary: Import saved objects
       operationId: importSavedObjectsDefaultSpace
       description: |
+        Creates 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.
@@ -726,10 +727,10 @@ paths:
                 $ref: '#/components/schemas/400_response'
   /s/{spaceId}/api/saved_objects/_export:
     post:
-      summary: Retrieve sets of saved objects that you want to import into Kibana.
+      summary: Export saved objects
       operationId: exportSavedObjects
       description: |
-
+        Retrieves sets of saved objects that you want to import into Kibana.
         You must include `type` or `objects` in the request body.
 
         NOTE: The `savedObjects.maxImportExportSize` configuration setting limits the number of saved objects which may be exported.
@@ -768,9 +769,10 @@ paths:
                 $ref: '#/components/schemas/400_response'
   /s/{spaceId}/api/saved_objects/_import:
     post:
-      summary: Create sets of Kibana saved objects from a file created by the export API.
+      summary: Import saved objects
       operationId: importSavedObjects
       description: |
+        Creates 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.