Add info and usage API examples

elastic · Jan 9, 2025 · dce1bbc · dce1bbc
1 parent db9fe44
commit dce1bbc
Show file tree

Hide file tree

Showing 6 changed files with 622 additions and 14 deletions.
diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/specification/xpack/info/XPackInfoRequest.ts b/specification/xpack/info/XPackInfoRequest.ts
@@ -30,16 +30,19 @@ import { RequestBase } from '@_types/Base'
  * @availability stack stability=stable
  * @availability serverless stability=stable visibility=private
  * @cluster_privileges monitor
+ * @doc_id info-api
  */
 export interface Request extends RequestBase {
   query_parameters: {
     /**
-     * A comma-separated list of the information categories to include in the response. For example, `build,license,features`.
+     * A comma-separated list of the information categories to include in the response.
+     * For example, `build,license,features`.
      */
     categories?: XPackCategory[]
     accept_enterprise?: boolean
     /**
-     * Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line.
+     * Defines whether additional human-readable information is included in the response.
+     * In particular, it adds descriptions and a tag line.
      * @server_default true
      */
     human?: boolean

diff --git a/specification/xpack/info/examples/response/XPackInfoResponseExample1.yaml b/specification/xpack/info/examples/response/XPackInfoResponseExample1.yaml
@@ -0,0 +1,129 @@
+# summary:
+description: A successful response from `GET /_xpack`.
+# type: response
+# response_code: 200
+value: |-
+  {
+    "build" : {
+        "hash" : "2798b1a3ce779b3611bb53a0082d4d741e4d3168",
+        "date" : "2015-04-07T13:34:42Z"
+    },
+    "license" : {
+        "uid" : "893361dc-9749-4997-93cb-xxx",
+        "type" : "trial",
+        "mode" : "trial",
+        "status" : "active",
+        "expiry_date_in_millis" : 1542665112332
+    },
+    "features" : {
+        "ccr" : {
+          "available" : true,
+          "enabled" : true
+        },
+      "aggregate_metric" : {
+            "available" : true,
+            "enabled" : true
+        },
+        "analytics" : {
+            "available" : true,
+            "enabled" : true
+        },
+        "archive" : {
+            "available" : true,
+            "enabled" : true
+        },
+        "enrich" : {
+            "available" : true,
+            "enabled" : true
+        },
+        "frozen_indices" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "graph" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "ilm" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "logstash" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "ml" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "esql" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "monitoring" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "rollup": {
+          "available": true,
+          "enabled": true
+        },
+        "searchable_snapshots" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "security" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "slm" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "spatial" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "eql" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "sql" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "transform" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "voting_only" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "watcher" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "data_streams" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "data_tiers" : {
+          "available" : true,
+          "enabled" : true
+        },
+        "enterprise_search": {
+          "available": true,
+          "enabled": true
+        },
+        "universal_profiling": {
+          "available": true,
+          "enabled": true
+        },
+        "logsdb": {
+          "available": true,
+          "enabled": false
+        }
+    },
+    "tagline" : "You know, for X"
+  }
diff --git a/specification/xpack/usage/XPackUsageRequest.ts b/specification/xpack/usage/XPackUsageRequest.ts
@@ -28,11 +28,14 @@ import { Duration } from '@_types/Time'
  * @availability stack stability=stable
  * @availability serverless stability=stable visibility=private
  * @cluster_privileges monitor
+ * @doc_id usage-api
  */
 export interface Request extends RequestBase {
   query_parameters: {
     /**
-     * Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
+     * The period to wait for a connection to the master node.
+     * If no response is received before the timeout expires, the request fails and returns an error.
+     * To indicate that the request should never timeout, set it to `-1`.
      * @server_default 30s
      */
     master_timeout?: Duration