Skip to content

Commit 9fcc17b

Browse files
committed
[DOCS] Edits licensing summaries
1 parent 2aa04ec commit 9fcc17b

File tree

9 files changed

+43
-5
lines changed

9 files changed

+43
-5
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,9 @@ actions:
113113
- name: license
114114
x-displayName: Licensing
115115
description: Licensing APIs enable you to manage your licenses.
116+
externalDocs:
117+
url: https://www.elastic.co/subscriptions
118+
description: For more information about the different types of licenses, refer to Elastic subscriptions
116119
- name: logstash
117120
x-displayName: Logstash
118121
description: >

specification/_doc_ids/table.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,7 @@ k-precision,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/sea
261261
k-recall,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-rank-eval.html#k-recall
262262
kv-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/kv-processor.html
263263
knn-inner-hits,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/knn-search.html#nested-knn-search-inner-hits
264+
license-management,https://www.elastic.co/guide/en/kibana/{branch}/managing-licenses.html
264265
logstash-api-delete-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-delete-pipeline.html
265266
logstash-api-get-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-get-pipeline.html
266267
logstash-api-put-pipeline,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/logstash-api-put-pipeline.html

specification/license/delete/DeleteLicenseRequest.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23+
* Delete the license.
24+
* When the license expires, your subscription level reverts to Basic.
25+
*
26+
* If the operator privileges feature is enabled, only operator users can use this API.
2327
* @rest_spec_name license.delete
2428
* @availability stack stability=stable
29+
* @cluster_privileges manage
30+
* @ext_doc_id licence-management
2531
*/
2632
export interface Request extends RequestBase {}

specification/license/get/GetLicenseRequest.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,10 @@ import { RequestBase } from '@_types/Base'
2121

2222
/**
2323
* Get license information.
24-
* Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires.
25-
* For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).
24+
* Get information about your Elastic license including its type, its status, when it was issued, and when it expires.
25+
*
26+
* NOTE: If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response.
27+
* If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.
2628
* @rest_spec_name license.get
2729
* @availability stack stability=stable
2830
* @availability serverless stability=stable visibility=public

specification/license/get_basic_status/GetBasicLicenseStatusRequest.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23+
* Get the basic license status.
2324
* @rest_spec_name license.get_basic_status
2425
* @availability stack since=6.3.0 stability=stable
26+
* @cluster_privileges monitor
2527
*/
2628
export interface Request extends RequestBase {}

specification/license/get_trial_status/GetTrialLicenseStatusRequest.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23+
* Get the trial status.
2324
* @rest_spec_name license.get_trial_status
2425
* @availability stack since=6.1.0 stability=stable
26+
* @cluster_privileges monitor
2527
*/
2628
export interface Request extends RequestBase {}

specification/license/post/PostLicenseRequest.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,14 @@ import { License } from '@license/_types/License'
2121
import { RequestBase } from '@_types/Base'
2222

2323
/**
24+
* Update the license.
25+
* You can update your license at runtime without shutting down your nodes.
26+
* License updates take effect immediately.
27+
* If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.
28+
* You must then re-submit the API request with the acknowledge parameter set to true.
29+
*
30+
* NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.
31+
* If the operator privileges feature is enabled, only operator users can use this API.
2432
* @rest_spec_name license.post
2533
* @availability stack stability=stable
2634
* @cluster_privileges manage

specification/license/post_start_basic/StartBasicLicenseRequest.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,18 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23-
* The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true.
24-
* To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html).
23+
* Start a basic license.
24+
* Start an indefinite basic license, which gives access to all the basic features.
25+
*
26+
* NOTE: In order to start a basic license, you must not currently have a basic license.
27+
*
28+
* If the basic license does not support all of the features that are available with your current license, however, you are notified in the response.
29+
* You must then re-submit the API request with the `acknowledge` parameter set to `true`.
30+
*
31+
* To check the status of your basic license, use the get basic license API.
2532
* @rest_spec_name license.post_start_basic
2633
* @availability stack since=6.3.0 stability=stable
34+
* @cluster_privileges manage
2735
*/
2836
export interface Request extends RequestBase {
2937
query_parameters: {

specification/license/post_start_trial/StartTrialLicenseRequest.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@
2020
import { RequestBase } from '@_types/Base'
2121

2222
/**
23-
* The start trial API enables you to start a 30-day trial, which gives access to all subscription features.
23+
* Start a trial.
24+
* Start a 30-day trial, which gives access to all subscription features.
25+
*
26+
* NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version.
27+
* For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension.
28+
*
29+
* To check the status of your trial, use the get trial status API.
2430
* @rest_spec_name license.post_start_trial
2531
* @availability stack since=6.1.0 stability=stable
2632
* @cluster_privileges manage

0 commit comments

Comments
 (0)