[DOCS] Fix ML sync API example (#133585)

elastic · Jun 8, 2022 · b7ae8a2 · b7ae8a2
1 parent b7c4d89
commit b7ae8a2
Show file tree

Hide file tree

Showing 4 changed files with 76 additions and 14 deletions.
diff --git a/docs/api/machine-learning/sync.asciidoc b/docs/api/machine-learning/sync.asciidoc
@@ -74,7 +74,7 @@ Retrieve the list of {ml} saved objects that require synchronization:
 
 [source,sh]
 --------------------------------------------------
-$ curl -X GET api/ml/saved_objects/sync?simulate=true
+GET api/ml/saved_objects/sync?simulate=true
 --------------------------------------------------
 // KIBANA
 
@@ -83,7 +83,7 @@ the following response:
 
 [source,sh]
 --------------------------------------------------
-{{"savedObjectsCreated":{"anomaly_detector":{"myjob1":{"success":true},"myjob2":{"success":true}}},"savedObjectsDeleted":{},"datafeedsAdded":{},"datafeedsRemoved":{}}
+{"savedObjectsCreated":{"anomaly_detector":{"myjob1":{"success":true},"myjob2":{"success":true}}},"savedObjectsDeleted":{},"datafeedsAdded":{},"datafeedsRemoved":{}}
 --------------------------------------------------
 
 To perform the synchronization, re-run the API and omit the `simulate` parameter.
diff --git a/x-pack/plugins/ml/common/openapi/bundled.json b/x-pack/plugins/ml/common/openapi/bundled.json
@@ -38,8 +38,11 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "items": {
-                    "$ref": "#/components/schemas/syncResponse"
+                  "$ref": "#/components/schemas/syncResponse"
+                },
+                "examples": {
+                  "syncExample": {
+                    "$ref": "#/components/examples/syncExample"
                   }
                 }
               }
@@ -62,8 +65,11 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "items": {
-                    "$ref": "#/components/schemas/syncResponse"
+                  "$ref": "#/components/schemas/syncResponse"
+                },
+                "examples": {
+                  "syncExample": {
+                    "$ref": "#/components/examples/syncExample"
                   }
                 }
               }
@@ -215,6 +221,26 @@
           }
         }
       }
+    },
+    "examples": {
+      "syncExample": {
+        "summary": "Two anomaly detection jobs required synchronization in this example.",
+        "value": {
+          "savedObjectsCreated": {
+            "anomaly_detector": {
+              "myjob1": {
+                "success": true
+              },
+              "myjob2": {
+                "success": true
+              }
+            }
+          },
+          "savedObjectsDeleted": {},
+          "datafeedsAdded": {},
+          "datafeedsRemoved": {}
+        }
+      }
     }
   },
   "security": [

diff --git a/x-pack/plugins/ml/common/openapi/bundled.yaml b/x-pack/plugins/ml/common/openapi/bundled.yaml
@@ -29,8 +29,10 @@ paths:
           content:
             application/json:
               schema:
-                items:
-                  $ref: '#/components/schemas/syncResponse'
+                $ref: '#/components/schemas/syncResponse'
+              examples:
+                syncExample:
+                  $ref: '#/components/examples/syncExample'
   /api/ml/saved_objects/sync:
     get:
       description: >
@@ -47,8 +49,10 @@ paths:
           content:
             application/json:
               schema:
-                items:
-                  $ref: '#/components/schemas/syncResponse'
+                $ref: '#/components/schemas/syncResponse'
+              examples:
+                syncExample:
+                  $ref: '#/components/examples/syncExample'
 components:
   parameters:
     spaceParam:
@@ -163,5 +167,18 @@ components:
                   success:
                     type: boolean
                     example: true
+  examples:
+    syncExample:
+      summary: Two anomaly detection jobs required synchronization in this example.
+      value:
+        savedObjectsCreated:
+          anomaly_detector:
+            myjob1:
+              success: true
+            myjob2:
+              success: true
+        savedObjectsDeleted: {}
+        datafeedsAdded: {}
+        datafeedsRemoved: {}
 security:
   - basicAuth: []
diff --git a/x-pack/plugins/ml/common/openapi/ml_apis.yaml b/x-pack/plugins/ml/common/openapi/ml_apis.yaml
@@ -27,8 +27,10 @@ paths:
           content:
             application/json:
               schema:
-                items:
-                  $ref: '#/components/schemas/syncResponse'
+                $ref: '#/components/schemas/syncResponse'
+              examples:
+                syncExample:
+                  $ref: '#/components/examples/syncExample'
   /api/ml/saved_objects/sync:
     get:
       description: >
@@ -43,8 +45,10 @@ paths:
           content:
             application/json:
               schema:
-                items:
-                  $ref: '#/components/schemas/syncResponse'
+                $ref: '#/components/schemas/syncResponse'
+              examples:
+                syncExample:
+                  $ref: '#/components/examples/syncExample'
 components:
  parameters:
   spaceParam:
@@ -142,5 +146,20 @@ components:
                   success:
                     type: boolean
                     example: true
+ examples:
+   syncExample:
+     summary: Two anomaly detection jobs required synchronization in this example.
+     value:
+       {
+         "savedObjectsCreated": {
+           "anomaly_detector": {
+             "myjob1": { "success":true },
+             "myjob2":{ "success":true }
+           }
+          },
+          "savedObjectsDeleted": {},
+          "datafeedsAdded":{},
+          "datafeedsRemoved":{}
+        }
 security:
   - basicAuth: []