Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.17] Add examples to licensing APIs (#3420) #3425

Merged
merged 1 commit into from
Jan 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 57 additions & 5 deletions docs/overlays/elasticsearch-openapi-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,63 @@ actions:
examples:
indicesLegacyPutTemplateRequestExample1:
$ref: "../../specification/indices/put_template/indicesPutTemplateRequestExample1.yaml"
## Examples for licensing
- target: "$.paths['/_license/basic_status']['get']"
description: "Add example for get basic status response"
update:
responses:
200:
content:
application/json:
examples:
getBasicStatusResponseExample1:
$ref: "../../specification/license/get_basic_status/GetBasicLicenseStatusResponseExample1.yaml"
- target: "$.paths['/_license/trial_status']['get']"
description: "Add example for get trial status response"
update:
responses:
200:
content:
application/json:
examples:
getLicenseResponseExample1:
$ref: "../../specification/license/get_trial_status/GetTrialLicenseStatusResponseExample1.yaml"
- target: "$.paths['/_license/start_basic']['post']"
description: "Add example for start basic response"
update:
responses:
200:
content:
application/json:
examples:
startBasicLicenseResponseExample1:
$ref: "../../specification/license/post_start_basic/StartBasicLicenseResponseExample1.yaml"
- target: "$.paths['/_license/start_trial']['post']"
description: "Add example for start trial response"
update:
responses:
200:
content:
application/json:
examples:
startTrialLicenseResponseExample1:
$ref: "../../specification/license/post_start_trial/StartTrialLicenseResponseExample1.yaml"
- target: "$.components['requestBodies']['license.post']"
description: "Add examples for update license request"
update:
content:
application/json:
examples:
updateLicenseRequestExample1:
$ref: "../../specification/license/post/PostLicenseRequestExample1.yaml"
- target: "$.components['responses']['license.post#200']"
description: "Add examples for update license response"
update:
content:
application/json:
examples:
clusterHealthResponseExample1:
$ref: "../../specification/license/post/PostLicenseResponseExample1.yaml"
## Examples for search applications
- target: "$.paths['/_application/search_application/{name}/_render_query']['post']"
description: "Add examples for render search application query operation"
Expand All @@ -402,10 +459,5 @@ actions:
examples:
renderSearchApplicationQueryRequestExample1:
$ref: "../../specification/search_application/render_query/SearchApplicationsRenderQueryRequestExample1.yaml"
responses:
200:
content:
application/json:
examples:
renderSearchApplicationQueryResponseExample1:
$ref: "../../specification/search_application/render_query/SearchApplicationsRenderQueryResponseExample1.yaml"
11 changes: 11 additions & 0 deletions docs/overlays/elasticsearch-shared-overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1351,3 +1351,14 @@ actions:
examples:
indicesRolloverResponseExample1:
$ref: "../../specification/indices/rollover/indicesRolloverResponseExample1.yaml"
## Examples for licensing
- target: "$.paths['/_license']['get']"
description: "Add example for get license response"
update:
responses:
200:
content:
application/json:
examples:
getLicenseResponseExample1:
$ref: "../../specification/license/get/GetLicenseResponseExample1.yaml"
5 changes: 3 additions & 2 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions specification/license/get/GetLicenseResponseExample1.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# summary: licensing/get-license.asciidoc:61
description: A successful response from `GET /_license`.
# type: response
# response_code: ''
value:
"{\n \"license\" : {\n \"status\" : \"active\",\n \"uid\" : \"cbff45e7-c553-41f7-ae4f-9205eabd80xx\"\
,\n \"type\" : \"trial\",\n \"issue_date\" : \"2018-10-20T22:05:12.332Z\"\
,\n \"issue_date_in_millis\" : 1540073112332,\n \"expiry_date\" : \"2018-11-19T22:05:12.332Z\"\
,\n \"expiry_date_in_millis\" : 1542665112332,\n \"max_nodes\" : 1000,\n \
\ \"max_resource_units\" : null,\n \"issued_to\" : \"test\",\n \"issuer\"\
\ : \"elasticsearch\",\n \"start_date_in_millis\" : -1\n }\n}"
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# summary: licensing/get-basic-status.asciidoc:42
description: A successful response from `GET /_license/basic_status`.
# type: response
# response_code: 200
value:
eligible_to_start_basic: true
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# summary: licensing/get-trial-status.asciidoc:47
description: A successful response from `GET /_license/trial_status`.
# type: response
# response_code: 200
value:
eligible_to_start_trial: true
11 changes: 11 additions & 0 deletions specification/license/post/PostLicenseRequestExample1.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# summary: licensing/update-license.asciidoc:63
# method_request: PUT _license
description: >
Run `PUT _license` to update to a basic license. NOTE: These values are invalid; you must substitute the appropriate contents from your license file.
# type: request
value:
"{\n \"licenses\": [\n {\n \"uid\":\"893361dc-9749-4997-93cb-802e3d7fa4xx\"\
,\n \"type\":\"basic\",\n \"issue_date_in_millis\":1411948800000,\n \
\ \"expiry_date_in_millis\":1914278399999,\n \"max_nodes\":1,\n \"\
issued_to\":\"issuedTo\",\n \"issuer\":\"issuer\",\n \"signature\":\"\
xx\"\n }\n ]\n}"
15 changes: 15 additions & 0 deletions specification/license/post/PostLicenseResponseExample1.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# summary: licensing/get-trial-status.asciidoc:47
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`.
# type: response
# response_code: 200
value:
acknowledged: false
license_status: valid
acknowledge:
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:"""'
watcher:
- Watcher will be disabled
logstash:
- Logstash will no longer poll for centrally-managed pipelines
security:
- The following X-Pack security functionality will be disabled ...
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# summary:
description: A successful response from `POST /_license/start_basic?acknowledge=true`. If you currently have a license with more features than a basic license and you start a basic license, you must pass the acknowledge parameter.
# type: response
# response_code: 200
value:
basic_was_started: true
acknowledged: true
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import { RequestBase } from '@_types/Base'
* @rest_spec_name license.post_start_trial
* @availability stack since=6.1.0 stability=stable
* @cluster_privileges manage
* @doc_id start-trial
*/
export interface Request extends RequestBase {
query_parameters: {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# summary:
description: A successful response from `POST /_license/start_trial?acknowledge=true`.
# type: response
# response_code: 200
value:
trial_was_started: true
acknowledged: true
Loading