[OAS][DOCS] Add example for import saved objects API (elastic#192291)

tsullivan · Sep 9, 2024 · 9833f0f · 9833f0f
1 parent 910fa36
commit 9833f0f
Show file tree

Hide file tree

Showing 7 changed files with 56 additions and 2 deletions.
diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml
@@ -7269,6 +7269,14 @@ paths:
       summary: Import saved objects
       tags:
         - saved objects
+      x-codeSamples:
+        - label: Import with createNewCopies
+          lang: cURL
+          source: |
+            curl \
+              -X POST api/saved_objects/_import?createNewCopies=true
+              -H "kbn-xsrf: true"
+              --form file=@file.ndjson
   /api/status:
     get:
       operationId: '%2Fapi%2Fstatus#0'

diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml
@@ -10201,6 +10201,14 @@ paths:
       summary: Import saved objects
       tags:
         - saved objects
+      x-codeSamples:
+        - label: Import with createNewCopies
+          lang: cURL
+          source: |
+            curl \
+              -X POST api/saved_objects/_import?createNewCopies=true
+              -H "kbn-xsrf: true"
+              --form file=@file.ndjson
   /api/saved_objects/_resolve_import_errors:
     post:
       description: >

diff --git a/packages/core/saved-objects/docs/openapi/bundled.json b/packages/core/saved-objects/docs/openapi/bundled.json
@@ -745,7 +745,14 @@
               }
             }
           }
-        }
+        },
+        "x-codeSamples": [
+          {
+            "lang": "cURL",
+            "label": "Import with createNewCopies",
+            "source": "curl \\\n  -X POST api/saved_objects/_import?createNewCopies=true\n  -H \"kbn-xsrf: true\"\n  --form file=@file.ndjson\n"
+          }
+        ]
       }
     },
     "/api/saved_objects/_resolve_import_errors": {

diff --git a/packages/core/saved-objects/docs/openapi/bundled.yaml b/packages/core/saved-objects/docs/openapi/bundled.yaml
@@ -511,6 +511,14 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/400_response'
+      x-codeSamples:
+        - lang: cURL
+          label: Import with createNewCopies
+          source: |
+            curl \
+              -X POST api/saved_objects/_import?createNewCopies=true
+              -H "kbn-xsrf: true"
+              --form file=@file.ndjson
   /api/saved_objects/_resolve_import_errors:
     post:
       summary: Resolve import errors

diff --git a/packages/core/saved-objects/docs/openapi/bundled_serverless.json b/packages/core/saved-objects/docs/openapi/bundled_serverless.json
@@ -230,7 +230,14 @@
               }
             }
           }
-        }
+        },
+        "x-codeSamples": [
+          {
+            "lang": "cURL",
+            "label": "Import with createNewCopies",
+            "source": "curl \\\n  -X POST api/saved_objects/_import?createNewCopies=true\n  -H \"kbn-xsrf: true\"\n  --form file=@file.ndjson\n"
+          }
+        ]
       }
     }
   },

diff --git a/packages/core/saved-objects/docs/openapi/bundled_serverless.yaml b/packages/core/saved-objects/docs/openapi/bundled_serverless.yaml
@@ -176,6 +176,14 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/400_response'
+      x-codeSamples:
+        - lang: cURL
+          label: Import with createNewCopies
+          source: |
+            curl \
+              -X POST api/saved_objects/_import?createNewCopies=true
+              -H "kbn-xsrf: true"
+              --form file=@file.ndjson
 components:
   parameters:
     kbn_xsrf:

diff --git a/packages/core/saved-objects/docs/openapi/paths/api@saved_objects@_import.yaml b/packages/core/saved-objects/docs/openapi/paths/api@saved_objects@_import.yaml
@@ -84,3 +84,11 @@ post:
         application/json:
           schema:
             $ref: '../components/schemas/400_response.yaml'
+  x-codeSamples:
+  - lang: cURL
+    label: Import with createNewCopies
+    source: |
+      curl \
+        -X POST api/saved_objects/_import?createNewCopies=true
+        -H "kbn-xsrf: true"
+        --form file=@file.ndjson