github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source 
(cherry picked from commit b7ae8a2efb)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
Kibana Machine 2022-06-14 12:42:09 -04:00 • committed by GitHub
parent fd5dda8215
commit a90510b3d8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 76 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/api/machine-learning/sync.asciidoc
View file

@ -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.

34
x-pack/plugins/ml/common/openapi/bundled.json
View file

@ -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": [

25
x-pack/plugins/ml/common/openapi/bundled.yaml
View file

@ -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: []

27
x-pack/plugins/ml/common/openapi/ml_apis.yaml
View file

@ -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: []