[DOCS] Move licensing APIs to docs (#31445)

elastic · Jun 20, 2018 · f012de0 · f012de0
1 parent 90d62e6
commit f012de0
Show file tree

Hide file tree

Showing 11 changed files with 34 additions and 31 deletions.
diff --git a/.../rest-api/license/delete-license.asciidoc → ...ference/licensing/delete-license.asciidoc b/.../rest-api/license/delete-license.asciidoc → ...ference/licensing/delete-license.asciidoc
@@ -1,4 +1,5 @@
 [role="xpack"]
+[testenv="basic"]
 [[delete-license]]
 === Delete License API
 
@@ -41,3 +42,4 @@ When the license is successfully deleted, the API returns the following response
   "acknowledged": true
 }
 ------------------------------------------------------------
+// NOTCONSOLE
diff --git a/...est-api/license/get-basic-status.asciidoc → ...rence/licensing/get-basic-status.asciidoc b/...est-api/license/get-basic-status.asciidoc → ...rence/licensing/get-basic-status.asciidoc
@@ -1,4 +1,5 @@
 [role="xpack"]
+[testenv="basic"]
 [[get-basic-status]]
 === Get Basic Status API
 

diff --git a/.../en/rest-api/license/get-license.asciidoc → .../reference/licensing/get-license.asciidoc b/.../en/rest-api/license/get-license.asciidoc → .../reference/licensing/get-license.asciidoc
@@ -1,4 +1,5 @@
 [role="xpack"]
+[testenv="basic"]
 [[get-license]]
 === Get License API
 
@@ -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",
@@ -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/]
diff --git a/...est-api/license/get-trial-status.asciidoc → ...rence/licensing/get-trial-status.asciidoc b/...est-api/license/get-trial-status.asciidoc → ...rence/licensing/get-trial-status.asciidoc
@@ -1,4 +1,5 @@
 [role="xpack"]
+[testenv="basic"]
 [[get-trial-status]]
 === Get Trial Status API
 

diff --git a/docs/reference/licensing/index.asciidoc b/docs/reference/licensing/index.asciidoc
@@ -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[]
diff --git a/.../en/rest-api/license/start-basic.asciidoc → .../reference/licensing/start-basic.asciidoc b/.../en/rest-api/license/start-basic.asciidoc → .../reference/licensing/start-basic.asciidoc
@@ -1,4 +1,5 @@
 [role="xpack"]
+[testenv="basic"]
 [[start-basic]]
 === Start Basic API
 

diff --git a/.../en/rest-api/license/start-trial.asciidoc → .../reference/licensing/start-trial.asciidoc b/.../en/rest-api/license/start-trial.asciidoc → .../reference/licensing/start-trial.asciidoc
@@ -1,4 +1,5 @@
 [role="xpack"]
+[testenv="basic"]
 [[start-trial]]
 === Start Trial API
 

diff --git a/.../rest-api/license/update-license.asciidoc → ...ference/licensing/update-license.asciidoc b/.../rest-api/license/update-license.asciidoc → ...ference/licensing/update-license.asciidoc
@@ -1,4 +1,5 @@
 [role="xpack"]
+[testenv="basic"]
 [[update-license]]
 === Update License API
 
@@ -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:

diff --git a/docs/reference/rest-api/index.asciidoc b/docs/reference/rest-api/index.asciidoc
@@ -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[]

diff --git a/x-pack/docs/build.gradle b/x-pack/docs/build.gradle
@@ -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',

diff --git a/x-pack/docs/en/rest-api/licensing.asciidoc b/x-pack/docs/en/rest-api/licensing.asciidoc