Skip to content

Commit 5c8ffa4

Browse files
committed
Add example for update license
1 parent 8e770e3 commit 5c8ffa4

File tree

4 files changed

+37
-15
lines changed

4 files changed

+37
-15
lines changed

docs/overlays/elasticsearch-openapi-overlays.yaml

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -432,4 +432,20 @@ actions:
432432
application/json:
433433
examples:
434434
startTrialLicenseResponseExample1:
435-
$ref: "../../specification/license/post_start_trial/StartTrialLicenseResponseExample1.yaml"
435+
$ref: "../../specification/license/post_start_trial/StartTrialLicenseResponseExample1.yaml"
436+
- target: "$.components['requestBodies']['license.post']"
437+
description: "Add examples for update license request"
438+
update:
439+
content:
440+
application/json:
441+
examples:
442+
updateLicenseRequestExample1:
443+
$ref: "../../specification/license/post/PostLicenseRequestExample1.yaml"
444+
- target: "$.components['responses']['license.post#200']"
445+
description: "Add examples for update license response"
446+
update:
447+
content:
448+
application/json:
449+
examples:
450+
clusterHealthResponseExample1:
451+
$ref: "../../specification/license/post/PostLicenseResponseExample1.yaml"

specification/license/post/PostLicenseRequestExample1.yaml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
summary: licensing/update-license.asciidoc:63
2-
method_request: PUT _license
3-
description: ''
4-
type: request
1+
# summary: licensing/update-license.asciidoc:63
2+
# method_request: PUT _license
3+
description: >
4+
Run `PUT _license` to update to a basic license. NOTE: These values are invalid; you must substitute the appropriate contents from your license file.
5+
# type: request
56
value:
67
"{\n \"licenses\": [\n {\n \"uid\":\"893361dc-9749-4997-93cb-802e3d7fa4xx\"\
78
,\n \"type\":\"basic\",\n \"issue_date_in_millis\":1411948800000,\n \

specification/license/post/PostLicenseRequestExample2.yaml

Lines changed: 0 additions & 10 deletions
This file was deleted.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# summary: licensing/get-trial-status.asciidoc:47
2+
description: If you update to a basic license and you previously had a license with more features, you receive this type of response. You must re-submit the API request and set the `acknowledge` parameter to `true`.
3+
# type: response
4+
# response_code: ''
5+
value:
6+
acknowledged: false
7+
license_status: valid
8+
acknowledge:
9+
message: '"""This license update requires acknowledgement. To acknowledge the license, please read the following messages and update the license again, this time with the "acknowledge=true" parameter:"""'
10+
watcher:
11+
- Watcher will be disabled
12+
logstash:
13+
- Logstash will no longer poll for centrally-managed pipelines
14+
security:
15+
- The following X-Pack security functionality will be disabled ...

0 commit comments

Comments
 (0)