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

[DOCS] Move licensing APIs to docs #31445

Merged
merged 3 commits into from
Jun 20, 2018
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
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[role="xpack"]
[testenv="basic"]
[[delete-license]]
=== Delete License API

Expand Down Expand Up @@ -41,3 +42,4 @@ When the license is successfully deleted, the API returns the following response
"acknowledged": true
}
------------------------------------------------------------
// NOTCONSOLE
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[role="xpack"]
[testenv="basic"]
[[get-basic-status]]
=== Get Basic Status API

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[role="xpack"]
[testenv="basic"]
[[get-license]]
=== Get License API

Expand Down Expand Up @@ -52,11 +53,9 @@ GET _xpack/license
"license" : {
"status" : "active",
"uid" : "cbff45e7-c553-41f7-ae4f-9205eabd80xx",
"type" : "trial",
"type" : "basic",
"issue_date" : "2018-02-22T23:12:05.550Z",
"issue_date_in_millis" : 1519341125550,
"expiry_date" : "2018-03-24T23:12:05.550Z",
"expiry_date_in_millis" : 1521933125550,
"max_nodes" : 1000,
"issued_to" : "test",
"issuer" : "elasticsearch",
Expand All @@ -65,11 +64,9 @@ GET _xpack/license
}
--------------------------------------------------
// TESTRESPONSE[s/"cbff45e7-c553-41f7-ae4f-9205eabd80xx"/$body.license.uid/]
// TESTRESPONSE[s/"trial"/$body.license.type/]
// TESTRESPONSE[s/"basic"/$body.license.type/]
// TESTRESPONSE[s/"2018-02-22T23:12:05.550Z"/$body.license.issue_date/]
// TESTRESPONSE[s/1519341125550/$body.license.issue_date_in_millis/]
// TESTRESPONSE[s/"2018-03-24T23:12:05.550Z"/$body.license.expiry_date/]
// TESTRESPONSE[s/1521933125550/$body.license.expiry_date_in_millis/]
// TESTRESPONSE[s/1000/$body.license.max_nodes/]
// TESTRESPONSE[s/"test"/$body.license.issued_to/]
// TESTRESPONSE[s/"elasticsearch"/$body.license.issuer/]
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[role="xpack"]
[testenv="basic"]
[[get-trial-status]]
=== Get Trial Status API

Expand Down
22 changes: 22 additions & 0 deletions docs/reference/licensing/index.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[role="xpack"]
[[licensing-apis]]
== Licensing APIs

You can use the following APIs to manage your licenses:

* <<delete-license>>
* <<get-license>>
* <<get-trial-status>>
* <<start-trial>>
* <<get-basic-status>>
* <<start-basic>>
* <<update-license>>


include::delete-license.asciidoc[]
include::get-license.asciidoc[]
include::get-trial-status.asciidoc[]
include::start-trial.asciidoc[]
include::get-basic-status.asciidoc[]
include::start-basic.asciidoc[]
include::update-license.asciidoc[]
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[role="xpack"]
[testenv="basic"]
[[start-basic]]
=== Start Basic API

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[role="xpack"]
[testenv="basic"]
[[start-trial]]
=== Start Trial API

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[role="xpack"]
[testenv="basic"]
[[update-license]]
=== Update License API

Expand Down Expand Up @@ -123,6 +124,7 @@ receive the following response:
}
}
------------------------------------------------------------
// NOTCONSOLE

To complete the update, you must re-submit the API request and set the
`acknowledge` parameter to `true`. For example:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/rest-api/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ directly to configure and access {xpack} features.

include::info.asciidoc[]
include::{xes-repo-dir}/rest-api/graph/explore.asciidoc[]
include::{xes-repo-dir}/rest-api/licensing.asciidoc[]
include::{es-repo-dir}/licensing/index.asciidoc[]
include::{xes-repo-dir}/rest-api/migration.asciidoc[]
include::{xes-repo-dir}/rest-api/ml-api.asciidoc[]
include::{xes-repo-dir}/rest-api/rollup-api.asciidoc[]
Expand Down
2 changes: 0 additions & 2 deletions x-pack/docs/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ buildRestTests.expectedUnconvertedCandidates = [
'en/watcher/trigger/schedule/weekly.asciidoc',
'en/watcher/trigger/schedule/yearly.asciidoc',
'en/watcher/troubleshooting.asciidoc',
'en/rest-api/license/delete-license.asciidoc',
'en/rest-api/license/update-license.asciidoc',
'en/rest-api/ml/delete-snapshot.asciidoc',
'en/rest-api/ml/forecast.asciidoc',
'en/rest-api/ml/get-bucket.asciidoc',
Expand Down
22 changes: 0 additions & 22 deletions x-pack/docs/en/rest-api/licensing.asciidoc

This file was deleted.