Skip to content

Commit 6d8a8aa

Browse files
[DOCS] Augment descriptions in the license APIs (#6109) (#6126)
(cherry picked from commit 11f0a10) Co-authored-by: Lisa Cawley <lcawley@elastic.co>
1 parent 0cf3630 commit 6d8a8aa

File tree

4 files changed

+40
-3
lines changed

4 files changed

+40
-3
lines changed

specification/license/get/types.ts

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,52 @@ import { DateTime, EpochTime, UnitMillis } from '@_types/Time'
2323
import { LicenseStatus, LicenseType } from '@license/_types/License'
2424

2525
export class LicenseInformation {
26+
/**
27+
* The date and time the license expires in ISO 8601 format.
28+
*/
2629
expiry_date?: DateTime
30+
/**
31+
* The date and time the license expires in milliseconds since the Unix epoch.
32+
*/
2733
expiry_date_in_millis?: EpochTime<UnitMillis>
34+
/**
35+
* The date and time the license was issued in ISO 8601 format.
36+
*/
2837
issue_date: DateTime
38+
/**
39+
* The date and time the license was issued in milliseconds since the Unix epoch.
40+
*/
2941
issue_date_in_millis: EpochTime<UnitMillis>
42+
/**
43+
* The name of the customer or organization that received the license.
44+
*/
3045
issued_to: string
46+
/**
47+
* The name of the organization that issued the license.
48+
*/
3149
issuer: string
50+
/**
51+
* The maximum number of nodes the license allows.
52+
*/
3253
max_nodes: long | null
54+
/**
55+
* The maximum number of resource units the license allows (for enterprise licenses only).
56+
*/
3357
max_resource_units?: integer | null
58+
/**
59+
* The status of the license. For example,active, valid, invalid, or expired.
60+
*/
3461
status: LicenseStatus
62+
/**
63+
* The type of the license. For example, trial, basic, gold, platinum, or enterprise.
64+
*/
3565
type: LicenseType
66+
/**
67+
* The unique identifier of the license.
68+
*/
3669
uid: Uuid
70+
/**
71+
* The date and time the license was started in milliseconds since the Unix epoch.
72+
*/
3773
start_date_in_millis: EpochTime<UnitMillis>
3874
}

specification/license/post/PostLicenseRequest.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ export interface Request extends RequestBase {
4848
response_media_type: MediaType.Json
4949
query_parameters: {
5050
/**
51-
* Specifies whether you acknowledge the license changes.
51+
* To update a license, you must accept the acknowledge messages and set this parameter to `true`.
52+
* In particular, if you are upgrading or downgrading a license, you must acknowlege the feature changes.
5253
* @server_default false
5354
*/
5455
acknowledge?: boolean

specification/license/post_start_basic/StartBasicLicenseRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export interface Request extends RequestBase {
4747
response_media_type: MediaType.Json
4848
query_parameters: {
4949
/**
50-
* Whether the user has acknowledged acknowledge messages
50+
* To start a basic license, you must accept the acknowledge messages and set this parameter to `true`.
5151
* @server_default false
5252
*/
5353
acknowledge?: boolean

specification/license/post_start_trial/StartTrialLicenseRequest.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export interface Request extends RequestBase {
4545
response_media_type: MediaType.Json
4646
query_parameters: {
4747
/**
48-
* Whether the user has acknowledged acknowledge messages
48+
* To start a trial, you must accept the acknowledge messages and set this parameter to `true`.
4949
* @server_default false
5050
*/
5151
acknowledge?: boolean

0 commit comments

Comments
 (0)