Skip to content

Commit f012de0

Browse files
authored
[DOCS] Move licensing APIs to docs (#31445)
1 parent 90d62e6 commit f012de0

11 files changed

+34
-31
lines changed

x-pack/docs/en/rest-api/license/delete-license.asciidoc renamed to docs/reference/licensing/delete-license.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[role="xpack"]
2+
[testenv="basic"]
23
[[delete-license]]
34
=== Delete License API
45

@@ -41,3 +42,4 @@ When the license is successfully deleted, the API returns the following response
4142
"acknowledged": true
4243
}
4344
------------------------------------------------------------
45+
// NOTCONSOLE

x-pack/docs/en/rest-api/license/get-basic-status.asciidoc renamed to docs/reference/licensing/get-basic-status.asciidoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[role="xpack"]
2+
[testenv="basic"]
23
[[get-basic-status]]
34
=== Get Basic Status API
45

x-pack/docs/en/rest-api/license/get-license.asciidoc renamed to docs/reference/licensing/get-license.asciidoc

+3-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[role="xpack"]
2+
[testenv="basic"]
23
[[get-license]]
34
=== Get License API
45

@@ -52,11 +53,9 @@ GET _xpack/license
5253
"license" : {
5354
"status" : "active",
5455
"uid" : "cbff45e7-c553-41f7-ae4f-9205eabd80xx",
55-
"type" : "trial",
56+
"type" : "basic",
5657
"issue_date" : "2018-02-22T23:12:05.550Z",
5758
"issue_date_in_millis" : 1519341125550,
58-
"expiry_date" : "2018-03-24T23:12:05.550Z",
59-
"expiry_date_in_millis" : 1521933125550,
6059
"max_nodes" : 1000,
6160
"issued_to" : "test",
6261
"issuer" : "elasticsearch",
@@ -65,11 +64,9 @@ GET _xpack/license
6564
}
6665
--------------------------------------------------
6766
// TESTRESPONSE[s/"cbff45e7-c553-41f7-ae4f-9205eabd80xx"/$body.license.uid/]
68-
// TESTRESPONSE[s/"trial"/$body.license.type/]
67+
// TESTRESPONSE[s/"basic"/$body.license.type/]
6968
// TESTRESPONSE[s/"2018-02-22T23:12:05.550Z"/$body.license.issue_date/]
7069
// TESTRESPONSE[s/1519341125550/$body.license.issue_date_in_millis/]
71-
// TESTRESPONSE[s/"2018-03-24T23:12:05.550Z"/$body.license.expiry_date/]
72-
// TESTRESPONSE[s/1521933125550/$body.license.expiry_date_in_millis/]
7370
// TESTRESPONSE[s/1000/$body.license.max_nodes/]
7471
// TESTRESPONSE[s/"test"/$body.license.issued_to/]
7572
// TESTRESPONSE[s/"elasticsearch"/$body.license.issuer/]

x-pack/docs/en/rest-api/license/get-trial-status.asciidoc renamed to docs/reference/licensing/get-trial-status.asciidoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[role="xpack"]
2+
[testenv="basic"]
23
[[get-trial-status]]
34
=== Get Trial Status API
45

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[role="xpack"]
2+
[[licensing-apis]]
3+
== Licensing APIs
4+
5+
You can use the following APIs to manage your licenses:
6+
7+
* <<delete-license>>
8+
* <<get-license>>
9+
* <<get-trial-status>>
10+
* <<start-trial>>
11+
* <<get-basic-status>>
12+
* <<start-basic>>
13+
* <<update-license>>
14+
15+
16+
include::delete-license.asciidoc[]
17+
include::get-license.asciidoc[]
18+
include::get-trial-status.asciidoc[]
19+
include::start-trial.asciidoc[]
20+
include::get-basic-status.asciidoc[]
21+
include::start-basic.asciidoc[]
22+
include::update-license.asciidoc[]

x-pack/docs/en/rest-api/license/start-basic.asciidoc renamed to docs/reference/licensing/start-basic.asciidoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[role="xpack"]
2+
[testenv="basic"]
23
[[start-basic]]
34
=== Start Basic API
45

x-pack/docs/en/rest-api/license/start-trial.asciidoc renamed to docs/reference/licensing/start-trial.asciidoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[role="xpack"]
2+
[testenv="basic"]
23
[[start-trial]]
34
=== Start Trial API
45

x-pack/docs/en/rest-api/license/update-license.asciidoc renamed to docs/reference/licensing/update-license.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[role="xpack"]
2+
[testenv="basic"]
23
[[update-license]]
34
=== Update License API
45

@@ -123,6 +124,7 @@ receive the following response:
123124
}
124125
}
125126
------------------------------------------------------------
127+
// NOTCONSOLE
126128

127129
To complete the update, you must re-submit the API request and set the
128130
`acknowledge` parameter to `true`. For example:

docs/reference/rest-api/index.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ directly to configure and access {xpack} features.
2020

2121
include::info.asciidoc[]
2222
include::{xes-repo-dir}/rest-api/graph/explore.asciidoc[]
23-
include::{xes-repo-dir}/rest-api/licensing.asciidoc[]
23+
include::{es-repo-dir}/licensing/index.asciidoc[]
2424
include::{xes-repo-dir}/rest-api/migration.asciidoc[]
2525
include::{xes-repo-dir}/rest-api/ml-api.asciidoc[]
2626
include::{xes-repo-dir}/rest-api/rollup-api.asciidoc[]

x-pack/docs/build.gradle

-2
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,6 @@ buildRestTests.expectedUnconvertedCandidates = [
4747
'en/watcher/trigger/schedule/weekly.asciidoc',
4848
'en/watcher/trigger/schedule/yearly.asciidoc',
4949
'en/watcher/troubleshooting.asciidoc',
50-
'en/rest-api/license/delete-license.asciidoc',
51-
'en/rest-api/license/update-license.asciidoc',
5250
'en/rest-api/ml/delete-snapshot.asciidoc',
5351
'en/rest-api/ml/forecast.asciidoc',
5452
'en/rest-api/ml/get-bucket.asciidoc',

x-pack/docs/en/rest-api/licensing.asciidoc

-22
This file was deleted.

0 commit comments

Comments
 (0)