Skip to content

[8.x] Add examples to licensing APIs (#3420) #3424

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

Merged
merged 2 commits 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"
Loading
Loading