diff --git a/docs/modules/analytics-rest-admin/analytics-admin.gradle b/docs/modules/analytics-rest-admin/analytics-admin.gradle index bab5986a..e7fdbed8 100644 --- a/docs/modules/analytics-rest-admin/analytics-admin.gradle +++ b/docs/modules/analytics-rest-admin/analytics-admin.gradle @@ -20,4 +20,5 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } \ No newline at end of file diff --git a/docs/modules/analytics-rest-admin/attachments/analytics-admin.yaml b/docs/modules/analytics-rest-admin/attachments/analytics-admin.yaml index 7ea6209c..581bd52a 100644 --- a/docs/modules/analytics-rest-admin/attachments/analytics-admin.yaml +++ b/docs/modules/analytics-rest-admin/attachments/analytics-admin.yaml @@ -762,6 +762,7 @@ components: securitySchemes: AnalyticsManageAnalyticsSelect: + x-displayName: Analytics Manage / Analytics Select type: http scheme: basic description: | @@ -775,6 +776,7 @@ components: * Analytics Admin ClusterReadPoolsRead: + x-displayName: Cluster Read / Pools Read type: http scheme: basic description: | @@ -786,6 +788,7 @@ components: * Analytics Admin AnalyticsManage: + x-displayName: Analytics Manage type: http scheme: basic description: | diff --git a/docs/modules/analytics-rest-admin/pages/index.adoc b/docs/modules/analytics-rest-admin/pages/index.adoc index 2e96fde5..37ec8161 100644 --- a/docs/modules/analytics-rest-admin/pages/index.adoc +++ b/docs/modules/analytics-rest-admin/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -33,7 +32,7 @@ These APIs enables you to manage and monitor the Analytics service. [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -68,7 +67,6 @@ The host name or IP address of a node running the Analytics Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -84,31 +82,26 @@ The Analytics Service REST port. Use `18095` for secure access. |=== - -// markup not found, no include::{specDir}overview/document-end.adoc[opts=optional] +include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}overview/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 1 - +:count-apis: 0 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -116,18 +109,14 @@ xref:tag-Default[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Default] = Default :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:cancel_request[] @@ -140,44 +129,38 @@ xref:restart_node[] xref:return_active_requests[] -//tag::cancel_request[] - -// markup not found, no include::{specDir}paths/cancel_request/operation-before.adoc[opts=optional] +//tag::cancel_request[] +include::{specDir}paths/cancel_request/operation-before.adoc[opts=optional] [#cancel_request] = Request Cancellation :leveloffset: +1 -// markup not found, no include::{specDir}paths/cancel_request/operation-begin.adoc[opts=optional] - +include::{specDir}paths/cancel_request/operation-begin.adoc[opts=optional] .... DELETE /analytics/admin/active_requests .... - -// markup not found, no include::{specDir}paths/cancel_request/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/cancel_request/operation-description-before.adoc[opts=optional] [#cancel_request-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/cancel_request/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/cancel_request/operation-description-begin.adoc[opts=optional] [markdown] -- Cancels an active request. -- - -// markup not found, no include::{specDir}paths/cancel_request/operation-description-end.adoc[opts=optional] +include::{specDir}paths/cancel_request/operation-description-end.adoc[opts=optional] [#cancel_request-consumes] @@ -188,26 +171,20 @@ Cancels an active request. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/cancel_request/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/cancel_request/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/cancel_request/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/cancel_request/operation-parameters-before.adoc[opts=optional] [#cancel_request-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/cancel_request/operation-parameters-begin.adoc[opts=optional] - - - - +include::{specDir}paths/cancel_request/operation-parameters-begin.adoc[opts=optional] [#cancel_request-form] .Form Parameters @@ -218,11 +195,8 @@ Cancels an active request. ¦ Name ¦ Description ¦ Schema a¦ *client_context_id* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- Identifier passed by the client that is used to identify an active request to be cancelled. -- @@ -235,27 +209,24 @@ a¦ String |=== - -// markup not found, no include::{specDir}paths/cancel_request/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/cancel_request/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/cancel_request/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/cancel_request/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/cancel_request/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/cancel_request/operation-responses-before.adoc[opts=optional] [#cancel_request-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/cancel_request/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/cancel_request/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -267,12 +238,14 @@ a| [markdown] The operation was successful. -- a| + | 400 a| [markdown] -- Bad request. Incorrect parameter or missing value. -- a| + | 401 a| [markdown] -- @@ -289,103 +262,83 @@ a| |=== - -// markup not found, no include::{specDir}paths/cancel_request/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/cancel_request/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/cancel_request/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/cancel_request/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/cancel_request/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/cancel_request/operation-security-before.adoc[opts=optional] [#cancel_request-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/cancel_request/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/cancel_request/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManageAnalyticsSelect[] +| xref:security-AnalyticsManageAnalyticsSelect[] |=== - -// markup not found, no include::{specDir}paths/cancel_request/operation-security-end.adoc[opts=optional] +include::{specDir}paths/cancel_request/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/cancel_request/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/cancel_request/operation-security-after.adoc[opts=optional] include::{snippetDir}cancel_request/http-request.adoc[opts=optional] +include::{snippetDir}cancel_request/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}cancel_request/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/cancel_request/operation-end.adoc[opts=optional] +include::{specDir}paths/cancel_request/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/cancel_request/operation-after.adoc[opts=optional] - +include::{specDir}paths/cancel_request/operation-after.adoc[opts=optional] //end::cancel_request[] - //tag::cluster_status[] - -// markup not found, no include::{specDir}paths/cluster_status/operation-before.adoc[opts=optional] - +include::{specDir}paths/cluster_status/operation-before.adoc[opts=optional] [#cluster_status] = Cluster Status :leveloffset: +1 -// markup not found, no include::{specDir}paths/cluster_status/operation-begin.adoc[opts=optional] - +include::{specDir}paths/cluster_status/operation-begin.adoc[opts=optional] .... GET /analytics/cluster .... - -// markup not found, no include::{specDir}paths/cluster_status/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/cluster_status/operation-description-before.adoc[opts=optional] [#cluster_status-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/cluster_status/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/cluster_status/operation-description-begin.adoc[opts=optional] [markdown] -- Shows various details about the current status of the Analytics Service, such as the service state, the state of each node partition, and the replicas of each partition. -- - -// markup not found, no include::{specDir}paths/cluster_status/operation-description-end.adoc[opts=optional] +include::{specDir}paths/cluster_status/operation-description-end.adoc[opts=optional] @@ -393,33 +346,29 @@ Shows various details about the current status of the Analytics Service, such as .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/cluster_status/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/cluster_status/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/cluster_status/operation-description-after.adoc[opts=optional] +include::{specDir}paths/cluster_status/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/cluster_status/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/cluster_status/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/cluster_status/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/cluster_status/operation-responses-before.adoc[opts=optional] [#cluster_status-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/cluster_status/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/cluster_status/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -448,103 +397,84 @@ a| |=== - -// markup not found, no include::{specDir}paths/cluster_status/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/cluster_status/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Status: -// markup not found, no include::{specDir}paths/cluster_status/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/cluster_status/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/cluster_status/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/cluster_status/operation-security-before.adoc[opts=optional] [#cluster_status-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/cluster_status/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/cluster_status/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-clusterReadPoolsRead[] +| xref:security-ClusterReadPoolsRead[] |=== - -// markup not found, no include::{specDir}paths/cluster_status/operation-security-end.adoc[opts=optional] +include::{specDir}paths/cluster_status/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/cluster_status/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/cluster_status/operation-security-after.adoc[opts=optional] include::{snippetDir}cluster_status/http-request.adoc[opts=optional] - include::{snippetDir}cluster_status/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/cluster_status/operation-end.adoc[opts=optional] +include::{specDir}paths/cluster_status/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/cluster_status/operation-after.adoc[opts=optional] - +include::{specDir}paths/cluster_status/operation-after.adoc[opts=optional] //end::cluster_status[] - //tag::completed_requests[] - -// markup not found, no include::{specDir}paths/completed_requests/operation-before.adoc[opts=optional] - +include::{specDir}paths/completed_requests/operation-before.adoc[opts=optional] [#completed_requests] = Completed Requests :leveloffset: +1 -// markup not found, no include::{specDir}paths/completed_requests/operation-begin.adoc[opts=optional] - +include::{specDir}paths/completed_requests/operation-begin.adoc[opts=optional] .... GET /analytics/admin/completed_requests .... - -// markup not found, no include::{specDir}paths/completed_requests/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/completed_requests/operation-description-before.adoc[opts=optional] [#completed_requests-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/completed_requests/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/completed_requests/operation-description-begin.adoc[opts=optional] [markdown] -- Gets a list of all completed analytic requests. -- - -// markup not found, no include::{specDir}paths/completed_requests/operation-description-end.adoc[opts=optional] +include::{specDir}paths/completed_requests/operation-description-end.adoc[opts=optional] @@ -552,33 +482,29 @@ Gets a list of all completed analytic requests. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/completed_requests/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/completed_requests/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/completed_requests/operation-description-after.adoc[opts=optional] +include::{specDir}paths/completed_requests/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/completed_requests/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/completed_requests/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/completed_requests/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/completed_requests/operation-responses-before.adoc[opts=optional] [#completed_requests-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/completed_requests/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/completed_requests/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -589,8 +515,7 @@ a| [markdown] -- Success. Returns a list of all completed analytic requests. -- -a| xref:Request[] - array +a| xref:Request[] array | 401 a| [markdown] @@ -608,103 +533,84 @@ a| |=== - -// markup not found, no include::{specDir}paths/completed_requests/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/completed_requests/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Request: -// markup not found, no include::{specDir}paths/completed_requests/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/completed_requests/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/completed_requests/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/completed_requests/operation-security-before.adoc[opts=optional] [#completed_requests-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/completed_requests/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/completed_requests/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManageAnalyticsSelect[] +| xref:security-AnalyticsManageAnalyticsSelect[] |=== - -// markup not found, no include::{specDir}paths/completed_requests/operation-security-end.adoc[opts=optional] +include::{specDir}paths/completed_requests/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/completed_requests/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/completed_requests/operation-security-after.adoc[opts=optional] include::{snippetDir}completed_requests/http-request.adoc[opts=optional] - include::{snippetDir}completed_requests/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/completed_requests/operation-end.adoc[opts=optional] +include::{specDir}paths/completed_requests/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/completed_requests/operation-after.adoc[opts=optional] - +include::{specDir}paths/completed_requests/operation-after.adoc[opts=optional] //end::completed_requests[] - //tag::ingestion_status[] - -// markup not found, no include::{specDir}paths/ingestion_status/operation-before.adoc[opts=optional] - +include::{specDir}paths/ingestion_status/operation-before.adoc[opts=optional] [#ingestion_status] = Ingestion Status :leveloffset: +1 -// markup not found, no include::{specDir}paths/ingestion_status/operation-begin.adoc[opts=optional] - +include::{specDir}paths/ingestion_status/operation-begin.adoc[opts=optional] .... GET /analytics/status/ingestion .... - -// markup not found, no include::{specDir}paths/ingestion_status/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/ingestion_status/operation-description-before.adoc[opts=optional] [#ingestion_status-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/ingestion_status/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/ingestion_status/operation-description-begin.adoc[opts=optional] [markdown] -- Shows the progress of ingestion by the Analytics service, for each Analytics collection. -- - -// markup not found, no include::{specDir}paths/ingestion_status/operation-description-end.adoc[opts=optional] +include::{specDir}paths/ingestion_status/operation-description-end.adoc[opts=optional] @@ -712,33 +618,29 @@ Shows the progress of ingestion by the Analytics service, for each Analytics col .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/ingestion_status/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/ingestion_status/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/ingestion_status/operation-description-after.adoc[opts=optional] +include::{specDir}paths/ingestion_status/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/ingestion_status/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/ingestion_status/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/ingestion_status/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/ingestion_status/operation-responses-before.adoc[opts=optional] [#ingestion_status-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/ingestion_status/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/ingestion_status/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -767,78 +669,63 @@ a| |=== - -// markup not found, no include::{specDir}paths/ingestion_status/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/ingestion_status/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Ingestion: -// markup not found, no include::{specDir}paths/ingestion_status/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/ingestion_status/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/ingestion_status/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/ingestion_status/operation-security-before.adoc[opts=optional] [#ingestion_status-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/ingestion_status/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/ingestion_status/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManageAnalyticsSelect[] +| xref:security-AnalyticsManageAnalyticsSelect[] |=== - -// markup not found, no include::{specDir}paths/ingestion_status/operation-security-end.adoc[opts=optional] +include::{specDir}paths/ingestion_status/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/ingestion_status/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/ingestion_status/operation-security-after.adoc[opts=optional] include::{snippetDir}ingestion_status/http-request.adoc[opts=optional] - include::{snippetDir}ingestion_status/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/ingestion_status/operation-end.adoc[opts=optional] +include::{specDir}paths/ingestion_status/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/ingestion_status/operation-after.adoc[opts=optional] - +include::{specDir}paths/ingestion_status/operation-after.adoc[opts=optional] //end::ingestion_status[] - //tag::monitor_node[] - -// markup not found, no include::{specDir}paths/monitor_node/operation-before.adoc[opts=optional] - +include::{specDir}paths/monitor_node/operation-before.adoc[opts=optional] [#monitor_node] = Pending Mutations :leveloffset: +1 -// markup not found, no include::{specDir}paths/monitor_node/operation-begin.adoc[opts=optional] - +include::{specDir}paths/monitor_node/operation-begin.adoc[opts=optional] .... GET /analytics/node/agg/stats/remaining @@ -847,16 +734,14 @@ GET /analytics/node/agg/stats/remaining CAUTION: This operation is deprecated, and will be removed in a future release. -// markup not found, no include::{specDir}paths/monitor_node/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/monitor_node/operation-description-before.adoc[opts=optional] [#monitor_node-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/monitor_node/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/monitor_node/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -866,8 +751,7 @@ NOTE: This endpoint may not return meaningful results in Couchbase Server 7.0 an -- - -// markup not found, no include::{specDir}paths/monitor_node/operation-description-end.adoc[opts=optional] +include::{specDir}paths/monitor_node/operation-description-end.adoc[opts=optional] @@ -875,33 +759,29 @@ NOTE: This endpoint may not return meaningful results in Couchbase Server 7.0 an .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/monitor_node/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/monitor_node/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/monitor_node/operation-description-after.adoc[opts=optional] +include::{specDir}paths/monitor_node/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/monitor_node/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/monitor_node/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/monitor_node/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/monitor_node/operation-responses-before.adoc[opts=optional] [#monitor_node-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/monitor_node/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/monitor_node/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -930,103 +810,84 @@ a| |=== - -// markup not found, no include::{specDir}paths/monitor_node/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/monitor_node/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Mutations: -// markup not found, no include::{specDir}paths/monitor_node/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/monitor_node/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/monitor_node/operation-security-before.adoc[opts=optional] +include::{specDir}paths/monitor_node/operation-security-before.adoc[opts=optional] [#monitor_node-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/monitor_node/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/monitor_node/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManageAnalyticsSelect[] +| xref:security-AnalyticsManageAnalyticsSelect[] |=== - -// markup not found, no include::{specDir}paths/monitor_node/operation-security-end.adoc[opts=optional] +include::{specDir}paths/monitor_node/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/monitor_node/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/monitor_node/operation-security-after.adoc[opts=optional] include::{snippetDir}monitor_node/http-request.adoc[opts=optional] - include::{snippetDir}monitor_node/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/monitor_node/operation-end.adoc[opts=optional] +include::{specDir}paths/monitor_node/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/monitor_node/operation-after.adoc[opts=optional] - +include::{specDir}paths/monitor_node/operation-after.adoc[opts=optional] //end::monitor_node[] - //tag::restart_cluster[] - -// markup not found, no include::{specDir}paths/restart_cluster/operation-before.adoc[opts=optional] - +include::{specDir}paths/restart_cluster/operation-before.adoc[opts=optional] [#restart_cluster] = Cluster Restart :leveloffset: +1 -// markup not found, no include::{specDir}paths/restart_cluster/operation-begin.adoc[opts=optional] - +include::{specDir}paths/restart_cluster/operation-begin.adoc[opts=optional] .... POST /analytics/cluster/restart .... - -// markup not found, no include::{specDir}paths/restart_cluster/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/restart_cluster/operation-description-before.adoc[opts=optional] [#restart_cluster-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/restart_cluster/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/restart_cluster/operation-description-begin.adoc[opts=optional] [markdown] -- Restarts all Analytics Service nodes in the cluster. -- - -// markup not found, no include::{specDir}paths/restart_cluster/operation-description-end.adoc[opts=optional] +include::{specDir}paths/restart_cluster/operation-description-end.adoc[opts=optional] @@ -1034,33 +895,29 @@ Restarts all Analytics Service nodes in the cluster. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/restart_cluster/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/restart_cluster/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/restart_cluster/operation-description-after.adoc[opts=optional] +include::{specDir}paths/restart_cluster/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/restart_cluster/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/restart_cluster/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/restart_cluster/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/restart_cluster/operation-responses-before.adoc[opts=optional] [#restart_cluster-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/restart_cluster/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/restart_cluster/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1089,103 +946,83 @@ a| |=== - -// markup not found, no include::{specDir}paths/restart_cluster/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/restart_cluster/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/restart_cluster/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/restart_cluster/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/restart_cluster/operation-security-before.adoc[opts=optional] +include::{specDir}paths/restart_cluster/operation-security-before.adoc[opts=optional] [#restart_cluster-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/restart_cluster/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/restart_cluster/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManage[] +| xref:security-AnalyticsManage[] |=== - -// markup not found, no include::{specDir}paths/restart_cluster/operation-security-end.adoc[opts=optional] +include::{specDir}paths/restart_cluster/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/restart_cluster/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/restart_cluster/operation-security-after.adoc[opts=optional] include::{snippetDir}restart_cluster/http-request.adoc[opts=optional] - include::{snippetDir}restart_cluster/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/restart_cluster/operation-end.adoc[opts=optional] +include::{specDir}paths/restart_cluster/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/restart_cluster/operation-after.adoc[opts=optional] - +include::{specDir}paths/restart_cluster/operation-after.adoc[opts=optional] //end::restart_cluster[] - //tag::restart_node[] - -// markup not found, no include::{specDir}paths/restart_node/operation-before.adoc[opts=optional] - +include::{specDir}paths/restart_node/operation-before.adoc[opts=optional] [#restart_node] = Node Restart :leveloffset: +1 -// markup not found, no include::{specDir}paths/restart_node/operation-begin.adoc[opts=optional] - +include::{specDir}paths/restart_node/operation-begin.adoc[opts=optional] .... POST /analytics/node/restart .... - -// markup not found, no include::{specDir}paths/restart_node/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/restart_node/operation-description-before.adoc[opts=optional] [#restart_node-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/restart_node/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/restart_node/operation-description-begin.adoc[opts=optional] [markdown] -- Restarts the specified Analytics Service node. -- - -// markup not found, no include::{specDir}paths/restart_node/operation-description-end.adoc[opts=optional] +include::{specDir}paths/restart_node/operation-description-end.adoc[opts=optional] @@ -1193,33 +1030,29 @@ Restarts the specified Analytics Service node. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/restart_node/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/restart_node/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/restart_node/operation-description-after.adoc[opts=optional] +include::{specDir}paths/restart_node/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/restart_node/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/restart_node/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/restart_node/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/restart_node/operation-responses-before.adoc[opts=optional] [#restart_node-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/restart_node/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/restart_node/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1248,103 +1081,83 @@ a| |=== - -// markup not found, no include::{specDir}paths/restart_node/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/restart_node/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/restart_node/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/restart_node/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/restart_node/operation-security-before.adoc[opts=optional] +include::{specDir}paths/restart_node/operation-security-before.adoc[opts=optional] [#restart_node-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/restart_node/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/restart_node/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManage[] +| xref:security-AnalyticsManage[] |=== - -// markup not found, no include::{specDir}paths/restart_node/operation-security-end.adoc[opts=optional] +include::{specDir}paths/restart_node/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/restart_node/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/restart_node/operation-security-after.adoc[opts=optional] include::{snippetDir}restart_node/http-request.adoc[opts=optional] - include::{snippetDir}restart_node/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/restart_node/operation-end.adoc[opts=optional] +include::{specDir}paths/restart_node/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/restart_node/operation-after.adoc[opts=optional] - +include::{specDir}paths/restart_node/operation-after.adoc[opts=optional] //end::restart_node[] - //tag::return_active_requests[] - -// markup not found, no include::{specDir}paths/return_active_requests/operation-before.adoc[opts=optional] - +include::{specDir}paths/return_active_requests/operation-before.adoc[opts=optional] [#return_active_requests] = Active Requests :leveloffset: +1 -// markup not found, no include::{specDir}paths/return_active_requests/operation-begin.adoc[opts=optional] - +include::{specDir}paths/return_active_requests/operation-begin.adoc[opts=optional] .... GET /analytics/admin/active_requests .... - -// markup not found, no include::{specDir}paths/return_active_requests/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/return_active_requests/operation-description-before.adoc[opts=optional] [#return_active_requests-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/return_active_requests/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/return_active_requests/operation-description-begin.adoc[opts=optional] [markdown] -- Gets a list of the analytic requests that are running. -- - -// markup not found, no include::{specDir}paths/return_active_requests/operation-description-end.adoc[opts=optional] +include::{specDir}paths/return_active_requests/operation-description-end.adoc[opts=optional] @@ -1352,33 +1165,29 @@ Gets a list of the analytic requests that are running. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/return_active_requests/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/return_active_requests/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/return_active_requests/operation-description-after.adoc[opts=optional] +include::{specDir}paths/return_active_requests/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/return_active_requests/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/return_active_requests/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/return_active_requests/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/return_active_requests/operation-responses-before.adoc[opts=optional] [#return_active_requests-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/return_active_requests/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/return_active_requests/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1389,8 +1198,7 @@ a| [markdown] -- Success. Returns an array id details on the running requests. -- -a| xref:Request[] - array +a| xref:Request[] array | 401 a| [markdown] @@ -1408,99 +1216,84 @@ a| |=== - -// markup not found, no include::{specDir}paths/return_active_requests/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/return_active_requests/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Request: -// markup not found, no include::{specDir}paths/return_active_requests/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/return_active_requests/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/return_active_requests/operation-security-before.adoc[opts=optional] +include::{specDir}paths/return_active_requests/operation-security-before.adoc[opts=optional] [#return_active_requests-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/return_active_requests/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/return_active_requests/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManageAnalyticsSelect[] +| xref:security-AnalyticsManageAnalyticsSelect[] |=== - -// markup not found, no include::{specDir}paths/return_active_requests/operation-security-end.adoc[opts=optional] +include::{specDir}paths/return_active_requests/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/return_active_requests/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/return_active_requests/operation-security-after.adoc[opts=optional] include::{snippetDir}return_active_requests/http-request.adoc[opts=optional] - include::{snippetDir}return_active_requests/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/return_active_requests/operation-end.adoc[opts=optional] +include::{specDir}paths/return_active_requests/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/return_active_requests/operation-after.adoc[opts=optional] - +include::{specDir}paths/return_active_requests/operation-after.adoc[opts=optional] //end::return_active_requests[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] +include::{specDir}paths/document-after.adoc[opts=optional] - -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] - +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 14 - +:count-models: 13 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:Ingestion[] xref:IngestionLink[] @@ -1519,19 +1312,27 @@ xref:StatusTopologyStateReplicas[] endif::[] +include::{specDir}definitions/Ingestion/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/Ingestion/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Ingestion[] [#Ingestion] +endif::show-Ingestion[] +ifndef::show-Ingestion[] +:leveloffset: +1 + +[discrete#Ingestion] +endif::show-Ingestion[] = Ingestion +ifdef::model-descriptions[] +//tag::desc-Ingestion[] +An object containing a single links property. +//end::desc-Ingestion[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Ingestion/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Ingestion/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1539,30 +1340,20 @@ endif::collapse-models[] //tag::Ingestion[] -ifdef::model-descriptions[] -//tag::desc-Ingestion[] -An object containing a single links property. -//end::desc-Ingestion[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*links* + -_optional_ -a¦ - -[markdown] +a¦ *links* + +optional +a¦ [markdown] -- An array of objects, each giving information about a single linked Analytics scope. -- [%hardbreaks] {blank} -a¦ xref:IngestionLink[] - array +a¦ xref:IngestionLink[] array |=== @@ -1570,28 +1361,31 @@ a¦ xref:IngestionLink[] -// markup not found, no include::{specDir}definitions/Ingestion/definition-end.adoc[opts=optional] +include::{specDir}definitions/Ingestion/definition-end.adoc[opts=optional] +:leveloffset: -1 +ifndef::show-Ingestion[] :leveloffset: -1 +endif::show-Ingestion[] -// markup not found, no include::{specDir}definitions/Ingestion/definition-after.adoc[opts=optional] +include::{specDir}definitions/Ingestion/definition-after.adoc[opts=optional] +include::{specDir}definitions/IngestionLink/definition-before.adoc[opts=optional] - - -// markup not found, no include::{specDir}definitions/IngestionLink/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-IngestionLink[] [#IngestionLink] +endif::show-IngestionLink[] +ifndef::show-IngestionLink[] +:leveloffset: +1 + +[discrete#IngestionLink] +endif::show-IngestionLink[] = Links :leveloffset: +1 -// markup not found, no include::{specDir}definitions/IngestionLink/definition-begin.adoc[opts=optional] +include::{specDir}definitions/IngestionLink/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1599,17 +1393,13 @@ endif::collapse-models[] //tag::IngestionLink[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*name* + -_optional_ -a¦ - -[markdown] +a¦ *name* + +optional +a¦ [markdown] -- The name of the link. -- @@ -1618,13 +1408,9 @@ The name of the link. *Example:* `+++"Local"+++` {blank} a¦ String - -a¦ -*scope* + -_optional_ -a¦ - -[markdown] +a¦ *scope* + +optional +a¦ [markdown] -- The name of the Analytics scope. -- @@ -1633,13 +1419,9 @@ The name of the Analytics scope. *Example:* `+++"travel-sample/inventory"+++` {blank} a¦ String - -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the Analytics scope. -- @@ -1649,13 +1431,9 @@ The status of the Analytics scope. *Example:* `+++"healthy"+++` {blank} a¦ String - -a¦ -*state* + -_optional_ -a¦ - -[markdown] +a¦ *state* + +optional +a¦ [markdown] -- An array of objects, each giving the ingestion state of one or more Analytics collections. @@ -1665,8 +1443,7 @@ Analytics collections which have the same ingestion state within this Analytics [%hardbreaks] {blank} -a¦ xref:IngestionLinkState[] - array +a¦ xref:IngestionLinkState[] array |=== @@ -1674,28 +1451,31 @@ a¦ xref:IngestionLinkState[] -// markup not found, no include::{specDir}definitions/IngestionLink/definition-end.adoc[opts=optional] - +include::{specDir}definitions/IngestionLink/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/IngestionLink/definition-after.adoc[opts=optional] - - - +ifndef::show-IngestionLink[] +:leveloffset: -1 +endif::show-IngestionLink[] -// markup not found, no include::{specDir}definitions/IngestionLinkState/definition-before.adoc[opts=optional] +include::{specDir}definitions/IngestionLink/definition-after.adoc[opts=optional] +include::{specDir}definitions/IngestionLinkState/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-IngestionLinkState[] [#IngestionLinkState] +endif::show-IngestionLinkState[] +ifndef::show-IngestionLinkState[] +:leveloffset: +1 + +[discrete#IngestionLinkState] +endif::show-IngestionLinkState[] = States :leveloffset: +1 -// markup not found, no include::{specDir}definitions/IngestionLinkState/definition-begin.adoc[opts=optional] +include::{specDir}definitions/IngestionLinkState/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1703,17 +1483,13 @@ endif::collapse-models[] //tag::IngestionLinkState[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*timestamp* + -_required_ -a¦ - -[markdown] +a¦ *timestamp* + +required +a¦ [markdown] -- The time since epoch that this sample was calculated, in milliseconds. -- @@ -1722,13 +1498,9 @@ The time since epoch that this sample was calculated, in milliseconds. *Example:* `1631273689161` {blank} a¦ Integer - -a¦ -*progress* + -_required_ -a¦ - -[markdown] +a¦ *progress* + +required +a¦ [markdown] -- The percentage (fraction from 0 to 1) of ingestion progress at the current time. -- @@ -1739,13 +1511,9 @@ The percentage (fraction from 0 to 1) of ingestion progress at the current time. *Example:* `0` {blank} a¦ Double (double) - -a¦ -*timeLag* + -_optional_ -a¦ - -[markdown] +a¦ *timeLag* + +optional +a¦ [markdown] -- The estimated time that the ingestion lags behind the Data service, in milliseconds. Only displayed for Analytics collections that are not fully ingested. @@ -1755,13 +1523,9 @@ The estimated time that the ingestion lags behind the Data service, in milliseco *Example:* `9744` {blank} a¦ Integer - -a¦ -*itemsProcessed* + -_optional_ -a¦ - -[markdown] +a¦ *itemsProcessed* + +optional +a¦ [markdown] -- The number of items ingested since last connect; that is, the total number of mutations and deletions processed. Only displayed for Analytics collections that are not fully ingested. @@ -1773,13 +1537,9 @@ Note that this value is reset on connect, so it may appear to get smaller. *Example:* `12301` {blank} a¦ Integer - -a¦ -*seqnoAdvances* + -_optional_ -a¦ - -[markdown] +a¦ *seqnoAdvances* + +optional +a¦ [markdown] -- The change in sequence number (seqno) since last connect. Only displayed for Analytics collections that are not fully ingested. @@ -1789,21 +1549,16 @@ The change in sequence number (seqno) since last connect. Only displayed for Ana *Example:* `61` {blank} a¦ Integer - -a¦ -*scopes* + -_required_ -a¦ - -[markdown] +a¦ *scopes* + +required +a¦ [markdown] -- An array of objects, each one giving information about a single Analytics scope. -- [%hardbreaks] {blank} -a¦ xref:IngestionLinkStateScope[] - array +a¦ xref:IngestionLinkStateScope[] array |=== @@ -1811,28 +1566,31 @@ a¦ xref:IngestionLinkStateScope[] -// markup not found, no include::{specDir}definitions/IngestionLinkState/definition-end.adoc[opts=optional] - +include::{specDir}definitions/IngestionLinkState/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/IngestionLinkState/definition-after.adoc[opts=optional] - - - +ifndef::show-IngestionLinkState[] +:leveloffset: -1 +endif::show-IngestionLinkState[] -// markup not found, no include::{specDir}definitions/IngestionLinkStateScope/definition-before.adoc[opts=optional] +include::{specDir}definitions/IngestionLinkState/definition-after.adoc[opts=optional] +include::{specDir}definitions/IngestionLinkStateScope/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-IngestionLinkStateScope[] [#IngestionLinkStateScope] +endif::show-IngestionLinkStateScope[] +ifndef::show-IngestionLinkStateScope[] +:leveloffset: +1 + +[discrete#IngestionLinkStateScope] +endif::show-IngestionLinkStateScope[] = State Scopes :leveloffset: +1 -// markup not found, no include::{specDir}definitions/IngestionLinkStateScope/definition-begin.adoc[opts=optional] +include::{specDir}definitions/IngestionLinkStateScope/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1840,17 +1598,13 @@ endif::collapse-models[] //tag::IngestionLinkStateScope[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*name* + -_required_ -a¦ - -[markdown] +a¦ *name* + +required +a¦ [markdown] -- The name of the Analytics scope. -- @@ -1859,21 +1613,16 @@ The name of the Analytics scope. *Example:* `+++"travel-sample/inventory"+++` {blank} a¦ String - -a¦ -*collections* + -_required_ -a¦ - -[markdown] +a¦ *collections* + +required +a¦ [markdown] -- An array of objects, each one giving information about a single Analytics collection. -- [%hardbreaks] {blank} -a¦ xref:IngestionLinkStateScopeColl[] - array +a¦ xref:IngestionLinkStateScopeColl[] array |=== @@ -1881,28 +1630,31 @@ a¦ xref:IngestionLinkStateScopeColl[] -// markup not found, no include::{specDir}definitions/IngestionLinkStateScope/definition-end.adoc[opts=optional] - +include::{specDir}definitions/IngestionLinkStateScope/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/IngestionLinkStateScope/definition-after.adoc[opts=optional] - - - +ifndef::show-IngestionLinkStateScope[] +:leveloffset: -1 +endif::show-IngestionLinkStateScope[] -// markup not found, no include::{specDir}definitions/IngestionLinkStateScopeColl/definition-before.adoc[opts=optional] +include::{specDir}definitions/IngestionLinkStateScope/definition-after.adoc[opts=optional] +include::{specDir}definitions/IngestionLinkStateScopeColl/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-IngestionLinkStateScopeColl[] [#IngestionLinkStateScopeColl] +endif::show-IngestionLinkStateScopeColl[] +ifndef::show-IngestionLinkStateScopeColl[] +:leveloffset: +1 + +[discrete#IngestionLinkStateScopeColl] +endif::show-IngestionLinkStateScopeColl[] = State Collections :leveloffset: +1 -// markup not found, no include::{specDir}definitions/IngestionLinkStateScopeColl/definition-begin.adoc[opts=optional] +include::{specDir}definitions/IngestionLinkStateScopeColl/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1910,17 +1662,13 @@ endif::collapse-models[] //tag::IngestionLinkStateScopeColl[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*name* + -_required_ -a¦ - -[markdown] +a¦ *name* + +required +a¦ [markdown] -- The name of the Analytics collection. -- @@ -1936,25 +1684,34 @@ a¦ String -// markup not found, no include::{specDir}definitions/IngestionLinkStateScopeColl/definition-end.adoc[opts=optional] - +include::{specDir}definitions/IngestionLinkStateScopeColl/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/IngestionLinkStateScopeColl/definition-after.adoc[opts=optional] - - - +ifndef::show-IngestionLinkStateScopeColl[] +:leveloffset: -1 +endif::show-IngestionLinkStateScopeColl[] -// markup not found, no include::{specDir}definitions/Mutations/definition-before.adoc[opts=optional] +include::{specDir}definitions/IngestionLinkStateScopeColl/definition-after.adoc[opts=optional] +include::{specDir}definitions/Mutations/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Mutations[] [#Mutations] +endif::show-Mutations[] +ifndef::show-Mutations[] +:leveloffset: +1 + +[discrete#Mutations] +endif::show-Mutations[] = Mutations +ifdef::model-descriptions[] +//tag::desc-Mutations[] +An object containing one or more nested scope objects, one for each available Analytics scope. +//end::desc-Mutations[] +endif::model-descriptions[] + :leveloffset: +1 include::{specDir}definitions/Mutations/definition-begin.adoc[opts=optional] @@ -1965,23 +1722,14 @@ include::{specDir}definitions/Mutations/definition-begin.adoc[opts=optional] //tag::Mutations[] -ifdef::model-descriptions[] -//tag::desc-Mutations[] -An object containing one or more nested scope objects, one for each available Analytics scope. -//end::desc-Mutations[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -** + -_additional + -property_ -a¦ - -[markdown] +a¦ ** + +additional + +property +a¦ [markdown] -- include::index.adoc[tag=desc-MutationsColl, opts=optional] -- @@ -1996,28 +1744,40 @@ a¦ xref:MutationsColl[] -// markup not found, no include::{specDir}definitions/Mutations/definition-end.adoc[opts=optional] +include::{specDir}definitions/Mutations/definition-end.adoc[opts=optional] +:leveloffset: -1 +ifndef::show-Mutations[] :leveloffset: -1 +endif::show-Mutations[] -// markup not found, no include::{specDir}definitions/Mutations/definition-after.adoc[opts=optional] +include::{specDir}definitions/Mutations/definition-after.adoc[opts=optional] +include::{specDir}definitions/MutationsColl/definition-before.adoc[opts=optional] +ifdef::show-MutationsColl[] +[#MutationsColl] +endif::show-MutationsColl[] +ifndef::show-MutationsColl[] +:leveloffset: +1 +[discrete#MutationsColl] +endif::show-MutationsColl[] += Collections -// markup not found, no include::{specDir}definitions/MutationsColl/definition-before.adoc[opts=optional] +ifdef::model-descriptions[] +//tag::desc-MutationsColl[] +An object containing one or more collection properties, one for each Analytics collection in the Analytics scope. +The name of the object is the name of the Analytics scope, in display form. For example, `` `travel-sample`.inventory ``. -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] -[#MutationsColl] -= Collections +//end::desc-MutationsColl[] +endif::model-descriptions[] :leveloffset: +1 -// markup not found, no include::{specDir}definitions/MutationsColl/definition-begin.adoc[opts=optional] +include::{specDir}definitions/MutationsColl/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2025,26 +1785,14 @@ endif::collapse-models[] //tag::MutationsColl[] -ifdef::model-descriptions[] -//tag::desc-MutationsColl[] -An object containing one or more collection properties, one for each Analytics collection in the Analytics scope. - -The name of the object is the name of the Analytics scope, in display form. For example, `` `travel-sample`.inventory ``. - -//end::desc-MutationsColl[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -** + -_additional + -property_ -a¦ - -[markdown] +a¦ ** + +additional + +property +a¦ [markdown] -- The number of mutations in the DCP queue that have not yet been ingested. The name of the property is the name of the Analytics collection. @@ -2060,28 +1808,37 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/MutationsColl/definition-end.adoc[opts=optional] - +include::{specDir}definitions/MutationsColl/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/MutationsColl/definition-after.adoc[opts=optional] - - - +ifndef::show-MutationsColl[] +:leveloffset: -1 +endif::show-MutationsColl[] -// markup not found, no include::{specDir}definitions/Request/definition-before.adoc[opts=optional] +include::{specDir}definitions/MutationsColl/definition-after.adoc[opts=optional] +include::{specDir}definitions/Request/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Request[] [#Request] +endif::show-Request[] +ifndef::show-Request[] +:leveloffset: +1 + +[discrete#Request] +endif::show-Request[] = Request +ifdef::model-descriptions[] +//tag::desc-Request[] +An object giving information about an Analytics service request. +//end::desc-Request[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Request/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Request/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2089,22 +1846,13 @@ endif::collapse-models[] //tag::Request[] -ifdef::model-descriptions[] -//tag::desc-Request[] -An object giving information about an Analytics service request. -//end::desc-Request[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*cancellable* + -_optional_ -a¦ - -[markdown] +a¦ *cancellable* + +optional +a¦ [markdown] -- Whether this request can be cancelled. -- @@ -2112,13 +1860,9 @@ Whether this request can be cancelled. [%hardbreaks] {blank} a¦ Boolean - -a¦ -*clientContextID* + -_optional_ -a¦ - -[markdown] +a¦ *clientContextID* + +optional +a¦ [markdown] -- A context ID for debugging purposes. -- @@ -2127,13 +1871,9 @@ A context ID for debugging purposes. *Example:* `+++"28379d60-7139-44d6-b57a-95935540b586"+++` {blank} a¦ String - -a¦ -*elapsedTime* + -_optional_ -a¦ - -[markdown] +a¦ *elapsedTime* + +optional +a¦ [markdown] -- How long the request has been running in seconds. -- @@ -2141,14 +1881,10 @@ How long the request has been running in seconds. [%hardbreaks] *Example:* `0.126` {blank} -a¦ Big Decimal - -a¦ -*jobCreateTime* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *jobCreateTime* + +optional +a¦ [markdown] -- The date and time when the request's job was created. -- @@ -2157,13 +1893,9 @@ The date and time when the request's job was created. *Example:* `+++"2024-05-28T19:47:02.512"+++` {blank} a¦ String - -a¦ -*jobId* + -_optional_ -a¦ - -[markdown] +a¦ *jobId* + +optional +a¦ [markdown] -- The request's job ID. This value can be null if request did not run (for example, due to an error). @@ -2173,13 +1905,9 @@ The request's job ID. This value can be null if request did not run (for example *Example:* `+++"JID:0.14"+++` {blank} a¦ String - -a¦ -*jobQueueTime* + -_optional_ -a¦ - -[markdown] +a¦ *jobQueueTime* + +optional +a¦ [markdown] -- How long the request's job has been in the queue waiting to run in seconds. -- @@ -2187,14 +1915,10 @@ How long the request's job has been in the queue waiting to run in seconds. [%hardbreaks] *Example:* `0` {blank} -a¦ Big Decimal - -a¦ -*jobRequiredCPUs* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *jobRequiredCPUs* + +optional +a¦ [markdown] -- The number of CPU cores required to run this request. -- @@ -2203,13 +1927,9 @@ The number of CPU cores required to run this request. *Example:* `1` {blank} a¦ Integer - -a¦ -*jobRequiredMemory* + -_optional_ -a¦ - -[markdown] +a¦ *jobRequiredMemory* + +optional +a¦ [markdown] -- The bytes of RAM being used to process this request. @@ -2219,13 +1939,9 @@ The bytes of RAM being used to process this request. *Example:* `34013184` {blank} a¦ Integer - -a¦ -*jobStartTime* + -_optional_ -a¦ - -[markdown] +a¦ *jobStartTime* + +optional +a¦ [markdown] -- The date and time the request's job began running. -- @@ -2234,13 +1950,9 @@ The date and time the request's job began running. *Example:* `+++"2024-05-28T19:47:02.514"+++` {blank} a¦ String - -a¦ -*jobStatus* + -_optional_ -a¦ - -[markdown] +a¦ *jobStatus* + +optional +a¦ [markdown] -- The state of the request's job. -- @@ -2250,13 +1962,9 @@ The state of the request's job. *Example:* `+++"RUNNING"+++` {blank} a¦ String - -a¦ -*plan* + -_optional_ -a¦ - -[markdown] +a¦ *plan* + +optional +a¦ [markdown] -- The query plan for this request. -- @@ -2264,13 +1972,9 @@ The query plan for this request. [%hardbreaks] {blank} a¦ String - -a¦ -*node* + -_optional_ -a¦ - -[markdown] +a¦ *node* + +optional +a¦ [markdown] -- The Analytics node that received the request. -- @@ -2279,13 +1983,9 @@ The Analytics node that received the request. *Example:* `+++"172.20.0.2:8095"+++` {blank} a¦ String - -a¦ -*remoteAddr* + -_optional_ -a¦ - -[markdown] +a¦ *remoteAddr* + +optional +a¦ [markdown] -- The network address and port of the client that made the request. -- @@ -2294,13 +1994,9 @@ The network address and port of the client that made the request. *Example:* `+++"172.20.0.123:53612"+++` {blank} a¦ String - -a¦ -*requestTime* + -_optional_ -a¦ - -[markdown] +a¦ *requestTime* + +optional +a¦ [markdown] -- The date and time the request was received. -- @@ -2309,13 +2005,9 @@ The date and time the request was received. *Example:* `+++"2024-05-28T19:44:07.730"+++` {blank} a¦ String - -a¦ -*scanConsistency* + -_optional_ -a¦ - -[markdown] +a¦ *scanConsistency* + +optional +a¦ [markdown] -- The Scan Consistency setting used for the request's query. -- @@ -2324,13 +2016,9 @@ The Scan Consistency setting used for the request's query. *Example:* `+++"not_bounded"+++` {blank} a¦ String - -a¦ -*state* + -_optional_ -a¦ - -[markdown] +a¦ *state* + +optional +a¦ [markdown] -- The state of the request. -- @@ -2340,13 +2028,9 @@ The state of the request. *Example:* `+++"running"+++` {blank} a¦ String - -a¦ -*statement* + -_optional_ -a¦ - -[markdown] +a¦ *statement* + +optional +a¦ [markdown] -- The SQL++ query statement being run by the request. -- @@ -2355,13 +2039,9 @@ The SQL++ query statement being run by the request. *Example:* `+++"select count(*) from hotel_endorsement_view;"+++` {blank} a¦ String - -a¦ -*userAgent* + -_optional_ -a¦ - -[markdown] +a¦ *userAgent* + +optional +a¦ [markdown] -- The user agent string of the browser that made the request. -- @@ -2370,13 +2050,9 @@ The user agent string of the browser that made the request. *Example:* `+++"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:126.0) Gecko/20100101 Firefox/126.0"+++` {blank} a¦ String - -a¦ -*users* + -_optional_ -a¦ - -[markdown] +a¦ *users* + +optional +a¦ [markdown] -- The user who made the request. -- @@ -2385,13 +2061,9 @@ The user who made the request. *Example:* `+++"Administrator"+++` {blank} a¦ String - -a¦ -*uuid* + -_optional_ -a¦ - -[markdown] +a¦ *uuid* + +optional +a¦ [markdown] -- The unique identifier for this request. -- @@ -2407,28 +2079,37 @@ a¦ String -// markup not found, no include::{specDir}definitions/Request/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Request/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Request/definition-after.adoc[opts=optional] - - - +ifndef::show-Request[] +:leveloffset: -1 +endif::show-Request[] -// markup not found, no include::{specDir}definitions/Status/definition-before.adoc[opts=optional] +include::{specDir}definitions/Request/definition-after.adoc[opts=optional] +include::{specDir}definitions/Status/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Status[] [#Status] +endif::show-Status[] +ifndef::show-Status[] +:leveloffset: +1 + +[discrete#Status] +endif::show-Status[] = Status +ifdef::model-descriptions[] +//tag::desc-Status[] +An object giving information about the status of the Analytics service. +//end::desc-Status[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Status/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Status/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2436,22 +2117,13 @@ endif::collapse-models[] //tag::Status[] -ifdef::model-descriptions[] -//tag::desc-Status[] -An object giving information about the status of the Analytics service. -//end::desc-Status[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*authorizedNodes* + -_optional_ -a¦ - -[markdown] +a¦ *authorizedNodes* + +optional +a¦ [markdown] -- An array of strings, each of which is the ID of an authorized Analytics node. -- @@ -2459,15 +2131,10 @@ An array of strings, each of which is the ID of an authorized Analytics node. [%hardbreaks] *Example:* `["86586a966202b5aa4aed31633f330aba","948fb3af810a9b7bc6c76e2a69ba35d9"]` {blank} -a¦ String - array - -a¦ -*ccNodeId* + -_optional_ -a¦ - -[markdown] +a¦ String array +a¦ *ccNodeId* + +optional +a¦ [markdown] -- The ID of the cluster controller node. -- @@ -2476,13 +2143,9 @@ The ID of the cluster controller node. *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} a¦ String - -a¦ -*nodeConfigUri* + -_optional_ -a¦ - -[markdown] +a¦ *nodeConfigUri* + +optional +a¦ [markdown] -- The path of the Analytics Node Configuration REST API. -- @@ -2491,13 +2154,9 @@ The path of the Analytics Node Configuration REST API. *Example:* `+++"/analytics/config/node"+++` {blank} a¦ String - -a¦ -*nodeDiagnosticsUri* + -_optional_ -a¦ - -[markdown] +a¦ *nodeDiagnosticsUri* + +optional +a¦ [markdown] -- The path of the Analytics Node Diagnostics REST API. For internal use only. @@ -2507,13 +2166,9 @@ The path of the Analytics Node Diagnostics REST API. For internal use only. *Example:* `+++"/analytics/node/diagnostics"+++` {blank} a¦ String - -a¦ -*nodeRestartUri* + -_optional_ -a¦ - -[markdown] +a¦ *nodeRestartUri* + +optional +a¦ [markdown] -- The path of the Analytics Node Restart REST API. -- @@ -2522,13 +2177,9 @@ The path of the Analytics Node Restart REST API. *Example:* `+++"/analytics/node/restart"+++` {blank} a¦ String - -a¦ -*nodeServiceUri* + -_optional_ -a¦ - -[markdown] +a¦ *nodeServiceUri* + +optional +a¦ [markdown] -- The path of the Analytics Query Service REST API. -- @@ -2537,13 +2188,9 @@ The path of the Analytics Query Service REST API. *Example:* `+++"/analytics/service"+++` {blank} a¦ String - -a¦ -*serviceConfigUri* + -_optional_ -a¦ - -[markdown] +a¦ *serviceConfigUri* + +optional +a¦ [markdown] -- The path of the Analytics Service Configuration REST API. -- @@ -2552,13 +2199,9 @@ The path of the Analytics Service Configuration REST API. *Example:* `+++"/analytics/config/service"+++` {blank} a¦ String - -a¦ -*serviceDiagnosticsUri* + -_optional_ -a¦ - -[markdown] +a¦ *serviceDiagnosticsUri* + +optional +a¦ [markdown] -- The full URI of the Analytics Service Diagnostics REST API. For internal use only. @@ -2568,13 +2211,9 @@ The full URI of the Analytics Service Diagnostics REST API. For internal use onl *Example:* `+++"http://localhost:8095/analytics/cluster/diagnostics"+++` {blank} a¦ String - -a¦ -*serviceRestartUri* + -_optional_ -a¦ - -[markdown] +a¦ *serviceRestartUri* + +optional +a¦ [markdown] -- The full URI of the Analytics Cluster Restart REST API. -- @@ -2583,13 +2222,9 @@ The full URI of the Analytics Cluster Restart REST API. *Example:* `+++"http://localhost:8095/analytics/cluster/restart"+++` {blank} a¦ String - -a¦ -*state* + -_optional_ -a¦ - -[markdown] +a¦ *state* + +optional +a¦ [markdown] -- The state of the Analytics Service. -- @@ -2599,43 +2234,29 @@ The state of the Analytics Service. *Example:* `+++"ACTIVE"+++` {blank} a¦ String - -a¦ -*nodes* + -_optional_ -a¦ - -[markdown] +a¦ *nodes* + +optional +a¦ [markdown] -- An array of objects, each giving information about one Analytics node. -- [%hardbreaks] {blank} -a¦ xref:StatusNodes[] - array - -a¦ -*partitions* + -_optional_ -a¦ - -[markdown] +a¦ xref:StatusNodes[] array +a¦ *partitions* + +optional +a¦ [markdown] -- An array of objects, each giving information about one Analytics partition. -- [%hardbreaks] {blank} -a¦ xref:StatusPartitions[] - array - -a¦ -*partitionsTopology* + -_optional_ -a¦ - -[markdown] +a¦ xref:StatusPartitions[] array +a¦ *partitionsTopology* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-StatusTopology, opts=optional] -- @@ -2650,28 +2271,31 @@ a¦ xref:StatusTopology[] -// markup not found, no include::{specDir}definitions/Status/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Status/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Status/definition-after.adoc[opts=optional] - - - +ifndef::show-Status[] +:leveloffset: -1 +endif::show-Status[] -// markup not found, no include::{specDir}definitions/StatusNodes/definition-before.adoc[opts=optional] +include::{specDir}definitions/Status/definition-after.adoc[opts=optional] +include::{specDir}definitions/StatusNodes/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-StatusNodes[] [#StatusNodes] +endif::show-StatusNodes[] +ifndef::show-StatusNodes[] +:leveloffset: +1 + +[discrete#StatusNodes] +endif::show-StatusNodes[] = Nodes :leveloffset: +1 -// markup not found, no include::{specDir}definitions/StatusNodes/definition-begin.adoc[opts=optional] +include::{specDir}definitions/StatusNodes/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2679,17 +2303,13 @@ endif::collapse-models[] //tag::StatusNodes[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*apiBase* + -_optional_ -a¦ - -[markdown] +a¦ *apiBase* + +optional +a¦ [markdown] -- The URI scheme, host, and port for HTTP access to Analytics REST APIs on this node. -- @@ -2698,13 +2318,9 @@ The URI scheme, host, and port for HTTP access to Analytics REST APIs on this no *Example:* `+++"http://192.168.8.101:8095"+++` {blank} a¦ String - -a¦ -*apiBaseHttps* + -_optional_ -a¦ - -[markdown] +a¦ *apiBaseHttps* + +optional +a¦ [markdown] -- The URI scheme, host, and port for secure HTTPS access to Analytics REST APIs on this node. -- @@ -2713,13 +2329,9 @@ The URI scheme, host, and port for secure HTTPS access to Analytics REST APIs on *Example:* `+++"https://192.168.8.101:18095"+++` {blank} a¦ String - -a¦ -*nodeId* + -_optional_ -a¦ - -[markdown] +a¦ *nodeId* + +optional +a¦ [markdown] -- The ID of the node. -- @@ -2728,13 +2340,9 @@ The ID of the node. *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} a¦ String - -a¦ -*nodeName* + -_optional_ -a¦ - -[markdown] +a¦ *nodeName* + +optional +a¦ [markdown] -- The name or IP address of the node, including the cluster administration port. -- @@ -2750,28 +2358,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/StatusNodes/definition-end.adoc[opts=optional] - +include::{specDir}definitions/StatusNodes/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/StatusNodes/definition-after.adoc[opts=optional] - - - +ifndef::show-StatusNodes[] +:leveloffset: -1 +endif::show-StatusNodes[] -// markup not found, no include::{specDir}definitions/StatusPartitions/definition-before.adoc[opts=optional] +include::{specDir}definitions/StatusNodes/definition-after.adoc[opts=optional] +include::{specDir}definitions/StatusPartitions/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-StatusPartitions[] [#StatusPartitions] +endif::show-StatusPartitions[] +ifndef::show-StatusPartitions[] +:leveloffset: +1 + +[discrete#StatusPartitions] +endif::show-StatusPartitions[] = Partitions :leveloffset: +1 -// markup not found, no include::{specDir}definitions/StatusPartitions/definition-begin.adoc[opts=optional] +include::{specDir}definitions/StatusPartitions/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2779,17 +2390,13 @@ endif::collapse-models[] //tag::StatusPartitions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*active* + -_optional_ -a¦ - -[markdown] +a¦ *active* + +optional +a¦ [markdown] -- Indicates whether this partition is active. -- @@ -2798,13 +2405,9 @@ Indicates whether this partition is active. *Example:* `true` {blank} a¦ Boolean - -a¦ -*activeNodeId* + -_optional_ -a¦ - -[markdown] +a¦ *activeNodeId* + +optional +a¦ [markdown] -- The ID of the node where this partition is currently active. -- @@ -2813,13 +2416,9 @@ The ID of the node where this partition is currently active. *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} a¦ String - -a¦ -*iodeviceNum* + -_optional_ -a¦ - -[markdown] +a¦ *iodeviceNum* + +optional +a¦ [markdown] -- The number of the IO Device where this partition is located. -- @@ -2828,13 +2427,9 @@ The number of the IO Device where this partition is located. *Example:* `0` {blank} a¦ Integer - -a¦ -*nodeId* + -_optional_ -a¦ - -[markdown] +a¦ *nodeId* + +optional +a¦ [markdown] -- The ID of the node where this partition originated. -- @@ -2843,13 +2438,9 @@ The ID of the node where this partition originated. *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} a¦ String - -a¦ -*partitionId* + -_optional_ -a¦ - -[markdown] +a¦ *partitionId* + +optional +a¦ [markdown] -- The ID of this partition. -- @@ -2858,13 +2449,9 @@ The ID of this partition. *Example:* `0` {blank} a¦ Integer - -a¦ -*path* + -_optional_ -a¦ - -[markdown] +a¦ *path* + +optional +a¦ [markdown] -- The path of the IO Device where this partition is located. -- @@ -2873,13 +2460,9 @@ The path of the IO Device where this partition is located. *Example:* `+++"/data/@analytics/v_iodevice_0"+++` {blank} a¦ String - -a¦ -*pendingActivation* + -_optional_ -a¦ - -[markdown] +a¦ *pendingActivation* + +optional +a¦ [markdown] -- Indicates whether this partition is waiting to become active. -- @@ -2895,28 +2478,37 @@ a¦ Boolean -// markup not found, no include::{specDir}definitions/StatusPartitions/definition-end.adoc[opts=optional] - +include::{specDir}definitions/StatusPartitions/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/StatusPartitions/definition-after.adoc[opts=optional] - - - +ifndef::show-StatusPartitions[] +:leveloffset: -1 +endif::show-StatusPartitions[] -// markup not found, no include::{specDir}definitions/StatusTopology/definition-before.adoc[opts=optional] +include::{specDir}definitions/StatusPartitions/definition-after.adoc[opts=optional] +include::{specDir}definitions/StatusTopology/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-StatusTopology[] [#StatusTopology] +endif::show-StatusTopology[] +ifndef::show-StatusTopology[] +:leveloffset: +1 + +[discrete#StatusTopology] +endif::show-StatusTopology[] = Partition Topology +ifdef::model-descriptions[] +//tag::desc-StatusTopology[] +An object giving information about the partition topology. +//end::desc-StatusTopology[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/StatusTopology/definition-begin.adoc[opts=optional] +include::{specDir}definitions/StatusTopology/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2924,22 +2516,13 @@ endif::collapse-models[] //tag::StatusTopology[] -ifdef::model-descriptions[] -//tag::desc-StatusTopology[] -An object giving information about the partition topology. -//end::desc-StatusTopology[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*balanced* + -_optional_ -a¦ - -[markdown] +a¦ *balanced* + +optional +a¦ [markdown] -- Indicates whether the Analytics nodes are balanced. -- @@ -2948,13 +2531,9 @@ Indicates whether the Analytics nodes are balanced. *Example:* `true` {blank} a¦ Boolean - -a¦ -*ccNodeId* + -_optional_ -a¦ - -[markdown] +a¦ *ccNodeId* + +optional +a¦ [markdown] -- The ID of the cluster controller node. -- @@ -2963,13 +2542,9 @@ The ID of the cluster controller node. *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} a¦ String - -a¦ -*metadataPartition* + -_optional_ -a¦ - -[markdown] +a¦ *metadataPartition* + +optional +a¦ [markdown] -- The ID of the metadata partition. -- @@ -2978,13 +2553,9 @@ The ID of the metadata partition. *Example:* `-1` {blank} a¦ Integer - -a¦ -*numReplicas* + -_optional_ -a¦ - -[markdown] +a¦ *numReplicas* + +optional +a¦ [markdown] -- The number of Analytics replicas. -- @@ -2993,13 +2564,9 @@ The number of Analytics replicas. *Example:* `1` {blank} a¦ Integer - -a¦ -*revision* + -_optional_ -a¦ - -[markdown] +a¦ *revision* + +optional +a¦ [markdown] -- The revision number of the partition topology. -- @@ -3008,13 +2575,9 @@ The revision number of the partition topology. *Example:* `1` {blank} a¦ Integer - -a¦ -*version* + -_optional_ -a¦ - -[markdown] +a¦ *version* + +optional +a¦ [markdown] -- The version number of the partition topology. -- @@ -3023,21 +2586,16 @@ The version number of the partition topology. *Example:* `1` {blank} a¦ Integer - -a¦ -*partitions* + -_optional_ -a¦ - -[markdown] +a¦ *partitions* + +optional +a¦ [markdown] -- An array of objects, each giving information about the state of one Analytics partition. -- [%hardbreaks] {blank} -a¦ xref:StatusTopologyState[] - array +a¦ xref:StatusTopologyState[] array |=== @@ -3045,28 +2603,31 @@ a¦ xref:StatusTopologyState[] -// markup not found, no include::{specDir}definitions/StatusTopology/definition-end.adoc[opts=optional] - +include::{specDir}definitions/StatusTopology/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/StatusTopology/definition-after.adoc[opts=optional] - - - +ifndef::show-StatusTopology[] +:leveloffset: -1 +endif::show-StatusTopology[] -// markup not found, no include::{specDir}definitions/StatusTopologyState/definition-before.adoc[opts=optional] +include::{specDir}definitions/StatusTopology/definition-after.adoc[opts=optional] +include::{specDir}definitions/StatusTopologyState/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-StatusTopologyState[] [#StatusTopologyState] +endif::show-StatusTopologyState[] +ifndef::show-StatusTopologyState[] +:leveloffset: +1 + +[discrete#StatusTopologyState] +endif::show-StatusTopologyState[] = Partition States :leveloffset: +1 -// markup not found, no include::{specDir}definitions/StatusTopologyState/definition-begin.adoc[opts=optional] +include::{specDir}definitions/StatusTopologyState/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -3074,17 +2635,13 @@ endif::collapse-models[] //tag::StatusTopologyState[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*id* + -_optional_ -a¦ - -[markdown] +a¦ *id* + +optional +a¦ [markdown] -- The partition ID. -- @@ -3093,13 +2650,9 @@ The partition ID. *Example:* `0` {blank} a¦ Integer - -a¦ -*master* + -_optional_ -a¦ - -[markdown] +a¦ *master* + +optional +a¦ [markdown] -- The ID of the node where the partition is currently active. -- @@ -3108,13 +2661,9 @@ The ID of the node where the partition is currently active. *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} a¦ String - -a¦ -*origin* + -_optional_ -a¦ - -[markdown] +a¦ *origin* + +optional +a¦ [markdown] -- The ID of the node where the partition originated. -- @@ -3123,21 +2672,16 @@ The ID of the node where the partition originated. *Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} a¦ String - -a¦ -*replicas* + -_optional_ -a¦ - -[markdown] +a¦ *replicas* + +optional +a¦ [markdown] -- An array of objects, each giving information about the state of one Analytics replica. -- [%hardbreaks] {blank} -a¦ xref:StatusTopologyStateReplicas[] - array +a¦ xref:StatusTopologyStateReplicas[] array |=== @@ -3145,28 +2689,31 @@ a¦ xref:StatusTopologyStateReplicas[] -// markup not found, no include::{specDir}definitions/StatusTopologyState/definition-end.adoc[opts=optional] - +include::{specDir}definitions/StatusTopologyState/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/StatusTopologyState/definition-after.adoc[opts=optional] - - - +ifndef::show-StatusTopologyState[] +:leveloffset: -1 +endif::show-StatusTopologyState[] -// markup not found, no include::{specDir}definitions/StatusTopologyStateReplicas/definition-before.adoc[opts=optional] +include::{specDir}definitions/StatusTopologyState/definition-after.adoc[opts=optional] +include::{specDir}definitions/StatusTopologyStateReplicas/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-StatusTopologyStateReplicas[] [#StatusTopologyStateReplicas] +endif::show-StatusTopologyStateReplicas[] +ifndef::show-StatusTopologyStateReplicas[] +:leveloffset: +1 + +[discrete#StatusTopologyStateReplicas] +endif::show-StatusTopologyStateReplicas[] = Replicas :leveloffset: +1 -// markup not found, no include::{specDir}definitions/StatusTopologyStateReplicas/definition-begin.adoc[opts=optional] +include::{specDir}definitions/StatusTopologyStateReplicas/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -3174,17 +2721,13 @@ endif::collapse-models[] //tag::StatusTopologyStateReplicas[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*location* + -_optional_ -a¦ - -[markdown] +a¦ *location* + +optional +a¦ [markdown] -- The name or IP address of the node where this replica is located, including the Analytics replication port. -- @@ -3193,13 +2736,9 @@ The name or IP address of the node where this replica is located, including the *Example:* `+++"192.168.8.102:9120"+++` {blank} a¦ String - -a¦ -*nodeId* + -_optional_ -a¦ - -[markdown] +a¦ *nodeId* + +optional +a¦ [markdown] -- The ID of the node where this replica is located. -- @@ -3208,13 +2747,9 @@ The ID of the node where this replica is located. *Example:* `+++"948fb3af810a9b7bc6c76e2a69ba35d9"+++` {blank} a¦ String - -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The synchronization status of the replica. -- @@ -3224,13 +2759,9 @@ The synchronization status of the replica. *Example:* `+++"IN_SYNC"+++` {blank} a¦ String - -a¦ -*syncProgress* + -_optional_ -a¦ - -[markdown] +a¦ *syncProgress* + +optional +a¦ [markdown] -- The percentage (fraction from 0 to 1) of synchronization progress for this replica at the current time. -- @@ -3248,26 +2779,26 @@ a¦ Double (double) -// markup not found, no include::{specDir}definitions/StatusTopologyStateReplicas/definition-end.adoc[opts=optional] - +include::{specDir}definitions/StatusTopologyStateReplicas/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/StatusTopologyStateReplicas/definition-after.adoc[opts=optional] - +ifndef::show-StatusTopologyStateReplicas[] +:leveloffset: -1 +endif::show-StatusTopologyStateReplicas[] +include::{specDir}definitions/StatusTopologyStateReplicas/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] - +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -3277,18 +2808,14 @@ a¦ Double (double) include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-before.adoc[opts=optional] - - -[[security-analyticsManageAnalyticsSelect]] -= Analytics Manage Analytics Select +[[security-AnalyticsManageAnalyticsSelect]] += Analytics Manage / Analytics Select :leveloffset: +1 -// markup not found, no include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -3304,29 +2831,22 @@ For the [Active Requests](#return_active_requests), [Request Cancellation](#canc -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-end.adoc[opts=optional] +include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-after.adoc[opts=optional] +include::{specDir}security/ClusterReadPoolsRead/security-scheme-before.adoc[opts=optional] - - - -// markup not found, no include::{specDir}security/ClusterReadPoolsRead/security-scheme-before.adoc[opts=optional] - - -[[security-clusterReadPoolsRead]] -= Cluster Read Pools Read +[[security-ClusterReadPoolsRead]] += Cluster Read / Pools Read :leveloffset: +1 -// markup not found, no include::{specDir}security/ClusterReadPoolsRead/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/ClusterReadPoolsRead/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -3340,29 +2860,22 @@ For the [Cluster Status](#cluster_status) operation, users must have one of the -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/ClusterReadPoolsRead/security-scheme-end.adoc[opts=optional] +include::{specDir}security/ClusterReadPoolsRead/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/ClusterReadPoolsRead/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/ClusterReadPoolsRead/security-scheme-after.adoc[opts=optional] - - - - -// markup not found, no include::{specDir}security/AnalyticsManage/security-scheme-before.adoc[opts=optional] - +include::{specDir}security/AnalyticsManage/security-scheme-before.adoc[opts=optional] -[[security-analyticsManage]] +[[security-AnalyticsManage]] = Analytics Manage :leveloffset: +1 -// markup not found, no include::{specDir}security/AnalyticsManage/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/AnalyticsManage/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -3374,16 +2887,13 @@ For the [Cluster Restart](#restart_cluster) and [Node Restart](#restart_node) op -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/AnalyticsManage/security-scheme-end.adoc[opts=optional] +include::{specDir}security/AnalyticsManage/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/AnalyticsManage/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/AnalyticsManage/security-scheme-after.adoc[opts=optional] @@ -3391,8 +2901,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - -// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] +include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/analytics-rest-config/analytics-config.gradle b/docs/modules/analytics-rest-config/analytics-config.gradle index f77f94b9..9e915a96 100644 --- a/docs/modules/analytics-rest-config/analytics-config.gradle +++ b/docs/modules/analytics-rest-config/analytics-config.gradle @@ -20,4 +20,5 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } \ No newline at end of file diff --git a/docs/modules/analytics-rest-config/attachments/analytics-config.yaml b/docs/modules/analytics-rest-config/attachments/analytics-config.yaml index b6e9f714..bcf78594 100644 --- a/docs/modules/analytics-rest-config/attachments/analytics-config.yaml +++ b/docs/modules/analytics-rest-config/attachments/analytics-config.yaml @@ -508,6 +508,7 @@ components: securitySchemes: AnalyticsManage: + x-displayName: Analytics Manage type: http scheme: basic description: |- diff --git a/docs/modules/analytics-rest-config/pages/index.adoc b/docs/modules/analytics-rest-config/pages/index.adoc index 33330e9a..8d79d951 100644 --- a/docs/modules/analytics-rest-config/pages/index.adoc +++ b/docs/modules/analytics-rest-config/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -33,7 +32,7 @@ This API enables you to configure Analytics nodes and clusters. [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -68,7 +67,6 @@ The host name or IP address of a node running the Analytics Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -84,31 +82,26 @@ The Analytics Service REST port. Use `18095` for secure access. |=== - -// markup not found, no include::{specDir}overview/document-end.adoc[opts=optional] +include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] +include::{specDir}overview/document-after.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] - +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 1 - +:count-apis: 0 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -116,18 +109,14 @@ xref:tag-Default[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Default] = Default :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:get_node[] @@ -136,44 +125,38 @@ xref:put_node[] xref:put_service[] -//tag::get_node[] +//tag::get_node[] -// markup not found, no include::{specDir}paths/get_node/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-before.adoc[opts=optional] [#get_node] = View Node-Specific Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_node/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-begin.adoc[opts=optional] .... GET /analytics/config/node .... - -// markup not found, no include::{specDir}paths/get_node/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-description-before.adoc[opts=optional] [#get_node-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_node/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-description-begin.adoc[opts=optional] [markdown] -- Views node-specific parameters, which apply to the node receiving the request. -- - -// markup not found, no include::{specDir}paths/get_node/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_node/operation-description-end.adoc[opts=optional] @@ -181,33 +164,29 @@ Views node-specific parameters, which apply to the node receiving the request. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_node/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_node/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_node/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_node/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_node/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_node/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_node/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_node/operation-responses-before.adoc[opts=optional] [#get_node-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_node/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -227,106 +206,86 @@ Unauthorized. The user name or password may be incorrect. Returns an object con -- a| Object - |=== - -// markup not found, no include::{specDir}paths/get_node/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_node/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Node: -// markup not found, no include::{specDir}paths/get_node/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_node/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_node/operation-security-before.adoc[opts=optional] [#get_node-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_node/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManage[] +| xref:security-AnalyticsManage[] |=== - -// markup not found, no include::{specDir}paths/get_node/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_node/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_node/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_node/operation-security-after.adoc[opts=optional] include::{snippetDir}get_node/http-request.adoc[opts=optional] - include::{snippetDir}get_node/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_node/operation-end.adoc[opts=optional] +include::{specDir}paths/get_node/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_node/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-after.adoc[opts=optional] //end::get_node[] - //tag::get_service[] - -// markup not found, no include::{specDir}paths/get_service/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-before.adoc[opts=optional] [#get_service] = View Service-Level Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_service/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-begin.adoc[opts=optional] .... GET /analytics/config/service .... - -// markup not found, no include::{specDir}paths/get_service/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-description-before.adoc[opts=optional] [#get_service-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_service/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-description-begin.adoc[opts=optional] [markdown] -- Views service-level parameters, which apply to all nodes running the Analytics service. -- - -// markup not found, no include::{specDir}paths/get_service/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_service/operation-description-end.adoc[opts=optional] @@ -334,33 +293,29 @@ Views service-level parameters, which apply to all nodes running the Analytics s .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_service/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_service/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_service/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_service/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_service/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_service/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_service/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_service/operation-responses-before.adoc[opts=optional] [#get_service-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_service/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -380,98 +335,79 @@ Unauthorized. The user name or password may be incorrect. Returns an object con -- a| Object - |=== - -// markup not found, no include::{specDir}paths/get_service/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_service/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Service: -// markup not found, no include::{specDir}paths/get_service/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_service/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_service/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-security-before.adoc[opts=optional] [#get_service-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_service/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManage[] +| xref:security-AnalyticsManage[] |=== - -// markup not found, no include::{specDir}paths/get_service/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_service/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional] include::{snippetDir}get_service/http-request.adoc[opts=optional] - include::{snippetDir}get_service/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_service/operation-end.adoc[opts=optional] +include::{specDir}paths/get_service/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_service/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-after.adoc[opts=optional] //end::get_service[] - //tag::put_node[] - -// markup not found, no include::{specDir}paths/put_node/operation-before.adoc[opts=optional] - +include::{specDir}paths/put_node/operation-before.adoc[opts=optional] [#put_node] = Modify Node-Specific Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_node/operation-begin.adoc[opts=optional] - +include::{specDir}paths/put_node/operation-begin.adoc[opts=optional] .... PUT /analytics/config/node .... - -// markup not found, no include::{specDir}paths/put_node/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/put_node/operation-description-before.adoc[opts=optional] [#put_node-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_node/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/put_node/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -485,8 +421,7 @@ or restart the Analytics cluster using the [Cluster Restart API][2]. [2]: /server/8.0/analytics-rest-admin.html#restart_cluster -- - -// markup not found, no include::{specDir}paths/put_node/operation-description-end.adoc[opts=optional] +include::{specDir}paths/put_node/operation-description-end.adoc[opts=optional] [#put_node-consumes] @@ -498,15 +433,13 @@ or restart the Analytics cluster using the [Cluster Restart API][2]. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/put_node/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/put_node/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_node/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/put_node/operation-parameters-before.adoc[opts=optional] [#put_node-parameters] = Parameters @@ -515,11 +448,6 @@ or restart the Analytics cluster using the [Cluster Restart API][2]. include::{specDir}paths/put_node/operation-parameters-begin.adoc[opts=optional] - - - - - [#put_node-body] .Body Parameter {blank} @@ -529,13 +457,10 @@ include::{specDir}paths/put_node/operation-parameters-begin.adoc[opts=optional] ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- -An object specifying one or more of the configurable node-level parameters on this node. + -- [%hardbreaks] @@ -546,26 +471,25 @@ a¦ xref:Node[] |=== -// markup not found, no include::{specDir}paths/put_node/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/put_node/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Node: -// markup not found, no include::{specDir}paths/put_node/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/put_node/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_node/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/put_node/operation-responses-before.adoc[opts=optional] [#put_node-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_node/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/put_node/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -577,6 +501,7 @@ a| [markdown] The operation was successful. -- a| + | 400 a| [markdown] -- @@ -591,98 +516,79 @@ Unauthorized. The user name or password may be incorrect. Returns an object con -- a| Object - |=== - -// markup not found, no include::{specDir}paths/put_node/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/put_node/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Errors: -// markup not found, no include::{specDir}paths/put_node/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/put_node/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_node/operation-security-before.adoc[opts=optional] +include::{specDir}paths/put_node/operation-security-before.adoc[opts=optional] [#put_node-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_node/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/put_node/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManage[] +| xref:security-AnalyticsManage[] |=== - -// markup not found, no include::{specDir}paths/put_node/operation-security-end.adoc[opts=optional] +include::{specDir}paths/put_node/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/put_node/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/put_node/operation-security-after.adoc[opts=optional] include::{snippetDir}put_node/http-request.adoc[opts=optional] +include::{snippetDir}put_node/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}put_node/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/put_node/operation-end.adoc[opts=optional] +include::{specDir}paths/put_node/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/put_node/operation-after.adoc[opts=optional] - +include::{specDir}paths/put_node/operation-after.adoc[opts=optional] //end::put_node[] - //tag::put_service[] - -// markup not found, no include::{specDir}paths/put_service/operation-before.adoc[opts=optional] - +include::{specDir}paths/put_service/operation-before.adoc[opts=optional] [#put_service] = Modify Service-Level Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_service/operation-begin.adoc[opts=optional] - +include::{specDir}paths/put_service/operation-begin.adoc[opts=optional] .... PUT /analytics/config/service .... - -// markup not found, no include::{specDir}paths/put_service/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/put_service/operation-description-before.adoc[opts=optional] [#put_service-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_service/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/put_service/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -694,8 +600,7 @@ you must restart the Analytics cluster using the [Cluster Restart API][1]. [1]: /server/8.0/analytics-rest-admin.html#restart_cluster -- - -// markup not found, no include::{specDir}paths/put_service/operation-description-end.adoc[opts=optional] +include::{specDir}paths/put_service/operation-description-end.adoc[opts=optional] [#put_service-consumes] @@ -707,15 +612,13 @@ you must restart the Analytics cluster using the [Cluster Restart API][1]. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/put_service/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/put_service/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_service/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/put_service/operation-parameters-before.adoc[opts=optional] [#put_service-parameters] = Parameters @@ -724,11 +627,6 @@ you must restart the Analytics cluster using the [Cluster Restart API][1]. include::{specDir}paths/put_service/operation-parameters-begin.adoc[opts=optional] - - - - - [#put_service-body] .Body Parameter {blank} @@ -738,13 +636,10 @@ include::{specDir}paths/put_service/operation-parameters-begin.adoc[opts=optiona ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- -An object specifying one or more of the configurable service-level parameters. + -- [%hardbreaks] @@ -755,26 +650,25 @@ a¦ xref:Service[] |=== -// markup not found, no include::{specDir}paths/put_service/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/put_service/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Service: -// markup not found, no include::{specDir}paths/put_service/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/put_service/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_service/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/put_service/operation-responses-before.adoc[opts=optional] [#put_service-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_service/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/put_service/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -786,6 +680,7 @@ a| [markdown] The operation was successful. -- a| + | 400 a| [markdown] -- @@ -800,102 +695,86 @@ Unauthorized. The user name or password may be incorrect. Returns an object con -- a| Object - |=== - -// markup not found, no include::{specDir}paths/put_service/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/put_service/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Errors: -// markup not found, no include::{specDir}paths/put_service/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/put_service/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_service/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/put_service/operation-security-before.adoc[opts=optional] [#put_service-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_service/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/put_service/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManage[] +| xref:security-AnalyticsManage[] |=== - -// markup not found, no include::{specDir}paths/put_service/operation-security-end.adoc[opts=optional] +include::{specDir}paths/put_service/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/put_service/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/put_service/operation-security-after.adoc[opts=optional] include::{snippetDir}put_service/http-request.adoc[opts=optional] +include::{snippetDir}put_service/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}put_service/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/put_service/operation-end.adoc[opts=optional] +include::{specDir}paths/put_service/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/put_service/operation-after.adoc[opts=optional] - +include::{specDir}paths/put_service/operation-after.adoc[opts=optional] //end::put_service[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 3 - +:count-models: 2 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:Errors[] xref:Node[] @@ -903,19 +782,21 @@ xref:Service[] endif::[] +include::{specDir}definitions/Errors/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/Errors/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Errors[] [#Errors] +endif::show-Errors[] +ifndef::show-Errors[] +:leveloffset: +1 + +[discrete#Errors] +endif::show-Errors[] = Errors :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Errors/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Errors/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -923,17 +804,13 @@ endif::collapse-models[] //tag::Errors[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*error* + -_required_ -a¦ - -[markdown] +a¦ *error* + +required +a¦ [markdown] -- An error message. -- @@ -948,28 +825,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/Errors/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Errors/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Errors/definition-after.adoc[opts=optional] - - - +ifndef::show-Errors[] +:leveloffset: -1 +endif::show-Errors[] -// markup not found, no include::{specDir}definitions/Node/definition-before.adoc[opts=optional] +include::{specDir}definitions/Errors/definition-after.adoc[opts=optional] +include::{specDir}definitions/Node/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Node[] [#Node] +endif::show-Node[] +ifndef::show-Node[] +:leveloffset: +1 + +[discrete#Node] +endif::show-Node[] = Node :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Node/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Node/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -977,17 +857,13 @@ endif::collapse-models[] //tag::Node[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*jvmArgs* + -_optional_ -a¦ - -[markdown] +a¦ *jvmArgs* + +optional +a¦ [markdown] -- JVM arguments to pass to the Analytics Driver. The default is undefined (null). @@ -1004,15 +880,12 @@ To pass arguments opaquely, you may use [Java command-line argument files][3]. -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*storageBuffercacheSize* + -_optional_ -a¦ - -[markdown] +a¦ *storageBuffercacheSize* + +optional +a¦ [markdown] -- The size of memory allocated to the disk buffer cache. The value should be a multiple of the buffer cache page size. @@ -1023,13 +896,9 @@ The default is 1/4 of the allocated Analytics Service memory. [%hardbreaks] {blank} a¦ Integer - -a¦ -*storageMemorycomponentGlobalbudget* + -_optional_ -a¦ - -[markdown] +a¦ *storageMemorycomponentGlobalbudget* + +optional +a¦ [markdown] -- The size of memory allocated to the memory components. The value should be a multiple of the memory component page size. @@ -1047,28 +916,31 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/Node/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Node/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Node/definition-after.adoc[opts=optional] - - - +ifndef::show-Node[] +:leveloffset: -1 +endif::show-Node[] -// markup not found, no include::{specDir}definitions/Service/definition-before.adoc[opts=optional] +include::{specDir}definitions/Node/definition-after.adoc[opts=optional] +include::{specDir}definitions/Service/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Service[] [#Service] +endif::show-Service[] +ifndef::show-Service[] +:leveloffset: +1 + +[discrete#Service] +endif::show-Service[] = Service :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Service/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Service/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1076,17 +948,13 @@ endif::collapse-models[] //tag::Service[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*activeMemoryGlobalBudget* + -_optional_ -a¦ - -[markdown] +a¦ *activeMemoryGlobalBudget* + +optional +a¦ [markdown] -- The memory budget (in bytes) for the active runtime. -- @@ -1095,13 +963,9 @@ The memory budget (in bytes) for the active runtime. *Default:* `67108864` {blank} a¦ Integer (int32) - -a¦ -*activeStopTimeout* + -_optional_ -a¦ - -[markdown] +a¦ *activeStopTimeout* + +optional +a¦ [markdown] -- The maximum time (in seconds) to wait for a graceful stop of an active runtime. -- @@ -1110,13 +974,9 @@ The maximum time (in seconds) to wait for a graceful stop of an active runtime. *Default:* `3600` {blank} a¦ Integer (int32) - -a¦ -*activeSuspendTimeout* + -_optional_ -a¦ - -[markdown] +a¦ *activeSuspendTimeout* + +optional +a¦ [markdown] -- The maximum time (in seconds) to wait for a graceful suspend of an active runtime. -- @@ -1125,13 +985,9 @@ The maximum time (in seconds) to wait for a graceful suspend of an active runtim *Default:* `3600` {blank} a¦ Integer (int32) - -a¦ -*analyticsBroadcastDcpStateMutationCount* + -_optional_ -a¦ - -[markdown] +a¦ *analyticsBroadcastDcpStateMutationCount* + +optional +a¦ [markdown] -- The number of processed mutations after which the DCP state is broadcast to storage -- @@ -1140,13 +996,9 @@ The number of processed mutations after which the DCP state is broadcast to stor *Default:* `10000` {blank} a¦ Integer (int32) - -a¦ -*analyticsHttpRequestQueueSize* + -_optional_ -a¦ - -[markdown] +a¦ *analyticsHttpRequestQueueSize* + +optional +a¦ [markdown] -- The maximum number of HTTP requests to queue pending ability to execute. -- @@ -1155,13 +1007,9 @@ The maximum number of HTTP requests to queue pending ability to execute. *Default:* `256` {blank} a¦ Integer (int32) - -a¦ -*analyticsHttpThreadCount* + -_optional_ -a¦ - -[markdown] +a¦ *analyticsHttpThreadCount* + +optional +a¦ [markdown] -- The number of threads to service HTTP requests. -- @@ -1170,27 +1018,20 @@ The number of threads to service HTTP requests. *Default:* `16` {blank} a¦ Integer (int32) - -a¦ -*bindAddress* + -_optional_ -a¦ - -[markdown] +a¦ *bindAddress* + +optional +a¦ [markdown] -- The bind address to use. -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*bindToHost* + -_optional_ -a¦ - -[markdown] +a¦ *bindToHost* + +optional +a¦ [markdown] -- Bind to configured hostname instead of wildcard address. -- @@ -1199,13 +1040,9 @@ Bind to configured hostname instead of wildcard address. *Default:* `false` {blank} a¦ Boolean - -a¦ -*clusterConnectRetries* + -_optional_ -a¦ - -[markdown] +a¦ *clusterConnectRetries* + +optional +a¦ [markdown] -- Number of attempts to contact CC before giving up. -- @@ -1214,13 +1051,9 @@ Number of attempts to contact CC before giving up. *Default:* `5` {blank} a¦ Integer (int32) - -a¦ -*collectDcpStateFromNodesTimeout* + -_optional_ -a¦ - -[markdown] +a¦ *collectDcpStateFromNodesTimeout* + +optional +a¦ [markdown] -- The maximum time to wait to collect DCP state from all nodes in seconds. -- @@ -1229,13 +1062,9 @@ The maximum time to wait to collect DCP state from all nodes in seconds. *Default:* `600` {blank} a¦ Integer (int32) - -a¦ -*compilerFramesize* + -_optional_ -a¦ - -[markdown] +a¦ *compilerFramesize* + +optional +a¦ [markdown] -- The page size (in bytes) for computation. -- @@ -1244,13 +1073,9 @@ The page size (in bytes) for computation. *Default:* `32768` {blank} a¦ Integer (int32) - -a¦ -*compilerGroupmemory* + -_optional_ -a¦ - -[markdown] +a¦ *compilerGroupmemory* + +optional +a¦ [markdown] -- The memory budget (in bytes) for a group by operator instance in a partition. -- @@ -1259,13 +1084,9 @@ The memory budget (in bytes) for a group by operator instance in a partition. *Default:* `33554432` {blank} a¦ Integer (int32) - -a¦ -*compilerJoinmemory* + -_optional_ -a¦ - -[markdown] +a¦ *compilerJoinmemory* + +optional +a¦ [markdown] -- The memory budget (in bytes) for a join operator instance in a partition. -- @@ -1274,13 +1095,9 @@ The memory budget (in bytes) for a join operator instance in a partition. *Default:* `33554432` {blank} a¦ Integer (int32) - -a¦ -*compilerParallelism* + -_optional_ -a¦ - -[markdown] +a¦ *compilerParallelism* + +optional +a¦ [markdown] -- The degree of parallelism for query execution. Zero means to use the storage parallelism as the query execution parallelism, while other integer values dictate the number of query execution parallel partitions. The system will fall back to use the number of all available CPU cores in the cluster as the degree of parallelism if the number set by a user is too large or too small. @@ -1290,13 +1107,9 @@ The degree of parallelism for query execution. Zero means to use the storage par *Default:* `0` {blank} a¦ Integer (int32) - -a¦ -*compilerSortParallel* + -_optional_ -a¦ - -[markdown] +a¦ *compilerSortParallel* + +optional +a¦ [markdown] -- Enables or disables full parallel sort. -- @@ -1305,13 +1118,9 @@ Enables or disables full parallel sort. *Default:* `false` {blank} a¦ Boolean - -a¦ -*compilerSortmemory* + -_optional_ -a¦ - -[markdown] +a¦ *compilerSortmemory* + +optional +a¦ [markdown] -- The memory budget (in bytes) for a sort operator instance in a partition. -- @@ -1320,13 +1129,9 @@ The memory budget (in bytes) for a sort operator instance in a partition. *Default:* `33554432` {blank} a¦ Integer (int32) - -a¦ -*compilerWindowmemory* + -_optional_ -a¦ - -[markdown] +a¦ *compilerWindowmemory* + +optional +a¦ [markdown] -- The memory budget (in bytes) for a window operator instance in a partition. -- @@ -1335,13 +1140,9 @@ The memory budget (in bytes) for a window operator instance in a partition. *Default:* `33554432` {blank} a¦ Integer (int32) - -a¦ -*coresMultiplier* + -_optional_ -a¦ - -[markdown] +a¦ *coresMultiplier* + +optional +a¦ [markdown] -- The factor to multiply by the number of cores to determine maximum query concurrent execution level. -- @@ -1350,13 +1151,9 @@ The factor to multiply by the number of cores to determine maximum query concurr *Default:* `3` {blank} a¦ Integer (int32) - -a¦ -*dcpBufferAckWatermark* + -_optional_ -a¦ - -[markdown] +a¦ *dcpBufferAckWatermark* + +optional +a¦ [markdown] -- The percentage of DCP connection buffer size at which to acknowledge bytes consumed to DCP producer. @@ -1368,13 +1165,9 @@ The percentage of DCP connection buffer size at which to acknowledge bytes consu *Maximum:* `100` {blank} a¦ Integer (int32) - -a¦ -*dcpChannelReconnectRemoteIdleSeconds* + -_optional_ -a¦ - -[markdown] +a¦ *dcpChannelReconnectRemoteIdleSeconds* + +optional +a¦ [markdown] -- Reconnect remote DCP channels that are idle for the specified number of seconds to ensure permissions have not been lost. A value of 0 disables reconnects on idle. @@ -1384,13 +1177,9 @@ Reconnect remote DCP channels that are idle for the specified number of seconds *Default:* `120` {blank} a¦ Integer (int32) - -a¦ -*dcpConnectionBufferSize* + -_optional_ -a¦ - -[markdown] +a¦ *dcpConnectionBufferSize* + +optional +a¦ [markdown] -- DCP connection buffer size (in bytes). @@ -1401,13 +1190,9 @@ Otherwise, the default is 1% of the JVM maximum heap size divided by the number [%hardbreaks] {blank} a¦ Integer (int32) - -a¦ -*deadlockWatchdogHaltDelaySeconds* + -_optional_ -a¦ - -[markdown] +a¦ *deadlockWatchdogHaltDelaySeconds* + +optional +a¦ [markdown] -- The delay (in seconds) to wait for graceful shutdown due to deadlocked threads, before halting. -- @@ -1416,13 +1201,9 @@ The delay (in seconds) to wait for graceful shutdown due to deadlocked threads, *Default:* `120` {blank} a¦ Integer (int32) - -a¦ -*deadlockWatchdogPollSeconds* + -_optional_ -a¦ - -[markdown] +a¦ *deadlockWatchdogPollSeconds* + +optional +a¦ [markdown] -- The frequency (in seconds) to scan for deadlocked threads. -- @@ -1431,13 +1212,9 @@ The frequency (in seconds) to scan for deadlocked threads. *Default:* `300` {blank} a¦ Integer (int32) - -a¦ -*jobHistorySize* + -_optional_ -a¦ - -[markdown] +a¦ *jobHistorySize* + +optional +a¦ [markdown] -- Limits the number of historical jobs remembered by the system to the specified value. -- @@ -1446,13 +1223,9 @@ Limits the number of historical jobs remembered by the system to the specified v *Default:* `10` {blank} a¦ Integer (int32) - -a¦ -*jobQueueCapacity* + -_optional_ -a¦ - -[markdown] +a¦ *jobQueueCapacity* + +optional +a¦ [markdown] -- The maximum number of jobs to queue before rejecting new jobs. -- @@ -1461,13 +1234,9 @@ The maximum number of jobs to queue before rejecting new jobs. *Default:* `4096` {blank} a¦ Integer (int32) - -a¦ -*jvmArgs* + -_optional_ -a¦ - -[markdown] +a¦ *jvmArgs* + +optional +a¦ [markdown] -- JVM arguments to pass to the Analytics Driver. The default is undefined (null). @@ -1481,15 +1250,12 @@ To pass arguments opaquely, you may use [Java command-line argument files][3]. -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*logLevel* + -_optional_ -a¦ - -[markdown] +a¦ *logLevel* + +optional +a¦ [markdown] -- The logging level. -- @@ -1498,13 +1264,9 @@ The logging level. *Default:* `+++"DEBUG"+++` {blank} a¦ String - -a¦ -*maxWebRequestSize* + -_optional_ -a¦ - -[markdown] +a¦ *maxWebRequestSize* + +optional +a¦ [markdown] -- The maximum accepted web request size in bytes. -- @@ -1513,13 +1275,9 @@ The maximum accepted web request size in bytes. *Default:* `52428800` {blank} a¦ Integer (int32) - -a¦ -*netBufferCount* + -_optional_ -a¦ - -[markdown] +a¦ *netBufferCount* + +optional +a¦ [markdown] -- Number of network buffers per input/output channel. -- @@ -1528,13 +1286,9 @@ Number of network buffers per input/output channel. *Default:* `1` {blank} a¦ Integer (int32) - -a¦ -*netThreadCount* + -_optional_ -a¦ - -[markdown] +a¦ *netThreadCount* + +optional +a¦ [markdown] -- Number of threads to use for Network I/O. -- @@ -1543,13 +1297,9 @@ Number of threads to use for Network I/O. *Default:* `1` {blank} a¦ Integer (int32) - -a¦ -*rebalancePullDatasetSizeFrequency* + -_optional_ -a¦ - -[markdown] +a¦ *rebalancePullDatasetSizeFrequency* + +optional +a¦ [markdown] -- The frequency at which the Analytics collection size is pulled from nodes during rebalance in seconds. -- @@ -1558,13 +1308,9 @@ The frequency at which the Analytics collection size is pulled from nodes during *Default:* `5` {blank} a¦ Integer (int32) - -a¦ -*remoteLinkConnectTimeoutSeconds* + -_optional_ -a¦ - -[markdown] +a¦ *remoteLinkConnectTimeoutSeconds* + +optional +a¦ [markdown] -- The maximum time (in seconds) to wait for a remote link connection to establish. A value of 0 disables timeout; a value of -1 sets timeout to the system default. @@ -1574,13 +1320,9 @@ The maximum time (in seconds) to wait for a remote link connection to establish. *Default:* `60` {blank} a¦ Integer (int32) - -a¦ -*remoteLinkSocketTimeoutSeconds* + -_optional_ -a¦ - -[markdown] +a¦ *remoteLinkSocketTimeoutSeconds* + +optional +a¦ [markdown] -- The maximum time (in seconds) to wait after establishing the connection for remote links; the maximum time of inactivity between two data packets. A value of 0 disables timeout; a value of -1 sets timeout to the system default. @@ -1590,13 +1332,9 @@ The maximum time (in seconds) to wait after establishing the connection for remo *Default:* `60` {blank} a¦ Integer (int32) - -a¦ -*requestsArchiveSize* + -_optional_ -a¦ - -[markdown] +a¦ *requestsArchiveSize* + +optional +a¦ [markdown] -- The maximum number of archived requests to maintain. -- @@ -1605,13 +1343,9 @@ The maximum number of archived requests to maintain. *Default:* `50` {blank} a¦ Integer (int32) - -a¦ -*resultSweepThreshold* + -_optional_ -a¦ - -[markdown] +a¦ *resultSweepThreshold* + +optional +a¦ [markdown] -- The duration within which an instance of the result cleanup should be invoked in milliseconds. -- @@ -1620,13 +1354,9 @@ The duration within which an instance of the result cleanup should be invoked in *Default:* `60000` {blank} a¦ Integer (int32) - -a¦ -*resultTtl* + -_optional_ -a¦ - -[markdown] +a¦ *resultTtl* + +optional +a¦ [markdown] -- Limits the amount of time results for asynchronous jobs should be retained by the system in milliseconds. -- @@ -1635,13 +1365,9 @@ Limits the amount of time results for asynchronous jobs should be retained by th *Default:* `86400000` {blank} a¦ Integer (int32) - -a¦ -*storageBuffercacheMaxopenfiles* + -_optional_ -a¦ - -[markdown] +a¦ *storageBuffercacheMaxopenfiles* + +optional +a¦ [markdown] -- The maximum number of open files in the buffer cache. -- @@ -1650,13 +1376,9 @@ The maximum number of open files in the buffer cache. *Default:* `2147483647` {blank} a¦ Integer (int32) - -a¦ -*storageBuffercachePagesize* + -_optional_ -a¦ - -[markdown] +a¦ *storageBuffercachePagesize* + +optional +a¦ [markdown] -- The page size in bytes for pages in the buffer cache. -- @@ -1665,13 +1387,9 @@ The page size in bytes for pages in the buffer cache. *Default:* `131072` {blank} a¦ Integer (int32) - -a¦ -*storageCompressionBlock* + -_optional_ -a¦ - -[markdown] +a¦ *storageCompressionBlock* + +optional +a¦ [markdown] -- The default compression scheme for the storage. -- @@ -1680,13 +1398,9 @@ The default compression scheme for the storage. *Default:* `+++"snappy"+++` {blank} a¦ String - -a¦ -*storageMemorycomponentNumcomponents* + -_optional_ -a¦ - -[markdown] +a¦ *storageMemorycomponentNumcomponents* + +optional +a¦ [markdown] -- The number of memory components to be used per LSM index. -- @@ -1695,13 +1409,9 @@ The number of memory components to be used per LSM index. *Default:* `2` {blank} a¦ Integer (int32) - -a¦ -*storageMemorycomponentPagesize* + -_optional_ -a¦ - -[markdown] +a¦ *storageMemorycomponentPagesize* + +optional +a¦ [markdown] -- The page size in bytes for pages allocated to memory components. -- @@ -1710,13 +1420,9 @@ The page size in bytes for pages allocated to memory components. *Default:* `131072` {blank} a¦ Integer (int32) - -a¦ -*storageWriteRateLimit* + -_optional_ -a¦ - -[markdown] +a¦ *storageWriteRateLimit* + +optional +a¦ [markdown] -- The maximum disk write rate for each storage partition in bytes per second. Disabled if the provided value is less than or equal to 0. @@ -1726,13 +1432,9 @@ The maximum disk write rate for each storage partition in bytes per second. Disa *Default:* `0` {blank} a¦ Long (int64) - -a¦ -*threaddumpFrequencySeconds* + -_optional_ -a¦ - -[markdown] +a¦ *threaddumpFrequencySeconds* + +optional +a¦ [markdown] -- The frequency (in seconds) at which to log diagnostic thread dumps. -- @@ -1741,13 +1443,9 @@ The frequency (in seconds) at which to log diagnostic thread dumps. *Default:* `300` {blank} a¦ Integer (int32) - -a¦ -*threaddumpLogLevel* + -_optional_ -a¦ - -[markdown] +a¦ *threaddumpLogLevel* + +optional +a¦ [markdown] -- The log level at which to emit diagnostic thread dumps. -- @@ -1756,13 +1454,9 @@ The log level at which to emit diagnostic thread dumps. *Default:* `+++"DEBUG"+++` {blank} a¦ String - -a¦ -*traceCategories* + -_optional_ -a¦ - -[markdown] +a¦ *traceCategories* + +optional +a¦ [markdown] -- Categories for tracing. The default is the empty array — no categories. @@ -1771,15 +1465,10 @@ Categories for tracing. The default is the empty array — no categories. [%hardbreaks] *Default:* `[]` {blank} -a¦ String - array - -a¦ -*txnDatasetCheckpointInterval* + -_optional_ -a¦ - -[markdown] +a¦ String array +a¦ *txnDatasetCheckpointInterval* + +optional +a¦ [markdown] -- The interval (in seconds) after which an Analytics collection is considered idle and persisted to disk. -- @@ -1795,26 +1484,26 @@ a¦ Integer (int32) -// markup not found, no include::{specDir}definitions/Service/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Service/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Service/definition-after.adoc[opts=optional] - +ifndef::show-Service[] +:leveloffset: -1 +endif::show-Service[] +include::{specDir}definitions/Service/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] - +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -1824,18 +1513,14 @@ a¦ Integer (int32) include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/AnalyticsManage/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/AnalyticsManage/security-scheme-before.adoc[opts=optional] - - -[[security-analyticsManage]] +[[security-AnalyticsManage]] = Analytics Manage :leveloffset: +1 -// markup not found, no include::{specDir}security/AnalyticsManage/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/AnalyticsManage/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -1847,16 +1532,13 @@ Users must have one of the following RBAC roles: -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/AnalyticsManage/security-scheme-end.adoc[opts=optional] +include::{specDir}security/AnalyticsManage/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/AnalyticsManage/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/AnalyticsManage/security-scheme-after.adoc[opts=optional] @@ -1864,8 +1546,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - -// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] +include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/analytics-rest-library/analytics-library.gradle b/docs/modules/analytics-rest-library/analytics-library.gradle index 7ad4c57f..1d481218 100644 --- a/docs/modules/analytics-rest-library/analytics-library.gradle +++ b/docs/modules/analytics-rest-library/analytics-library.gradle @@ -20,4 +20,5 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } diff --git a/docs/modules/analytics-rest-library/attachments/analytics-library.yaml b/docs/modules/analytics-rest-library/attachments/analytics-library.yaml index 48dceb1e..70c9d8c0 100644 --- a/docs/modules/analytics-rest-library/attachments/analytics-library.yaml +++ b/docs/modules/analytics-rest-library/attachments/analytics-library.yaml @@ -193,6 +193,7 @@ components: securitySchemes: FullAdmin: + x-displayName: Full Admin type: http scheme: basic description: > @@ -200,6 +201,7 @@ components: users must have the Full Admin RBAC role. AnalyticsAdmin: + x-displayName: Analytics Admin type: http scheme: basic description: | diff --git a/docs/modules/analytics-rest-library/pages/index.adoc b/docs/modules/analytics-rest-library/pages/index.adoc index 440a0d3f..6cca2c3c 100644 --- a/docs/modules/analytics-rest-library/pages/index.adoc +++ b/docs/modules/analytics-rest-library/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -33,7 +32,7 @@ This API enables you to manage the libraries that are used to create SQL\+\+ for [discrete#version] = Version information [%hardbreaks] -__Version__ : 0.1 +*Version:* 0.1 [discrete#host] = Host information @@ -68,7 +67,6 @@ The host name or IP address of a node running the Analytics Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -84,31 +82,26 @@ The Analytics Service REST port. Use `18095` for secure access. |=== - -// markup not found, no include::{specDir}overview/document-end.adoc[opts=optional] +include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] +include::{specDir}overview/document-after.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] - +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 1 - +:count-apis: 0 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -116,18 +109,14 @@ xref:tag-Default[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Default] = Default :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:delete_library[] @@ -135,44 +124,38 @@ xref:get_collection[] xref:post_library[] -//tag::delete_library[] - -// markup not found, no include::{specDir}paths/delete_library/operation-before.adoc[opts=optional] +//tag::delete_library[] +include::{specDir}paths/delete_library/operation-before.adoc[opts=optional] [#delete_library] = Delete a Library :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_library/operation-begin.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-begin.adoc[opts=optional] .... DELETE /analytics/library/{scope}/{library} .... - -// markup not found, no include::{specDir}paths/delete_library/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-description-before.adoc[opts=optional] [#delete_library-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_library/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-description-begin.adoc[opts=optional] [markdown] -- Deletes the specified library entirely. -- - -// markup not found, no include::{specDir}paths/delete_library/operation-description-end.adoc[opts=optional] +include::{specDir}paths/delete_library/operation-description-end.adoc[opts=optional] @@ -180,23 +163,20 @@ Deletes the specified library entirely. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/delete_library/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/delete_library/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_library/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/delete_library/operation-parameters-before.adoc[opts=optional] [#delete_library-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_library/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-parameters-begin.adoc[opts=optional] [#delete_library-path] .Path Parameters @@ -207,11 +187,8 @@ Deletes the specified library entirely. ¦ Name ¦ Description ¦ Schema a¦ *library* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a library. -- @@ -220,13 +197,9 @@ The name of a library. {blank} a¦ String - a¦ *scope* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Analytics scope containing the library. @@ -242,30 +215,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/delete_library/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/delete_library/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/delete_library/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/delete_library/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_library/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-responses-before.adoc[opts=optional] [#delete_library-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_library/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -284,6 +251,7 @@ a| [markdown] Not found. The library name in the path may be incorrect. -- a| + | 500 a| [markdown] -- @@ -291,106 +259,86 @@ Internal server error. Incorrect path or port number, incorrect credentials, bad -- a| xref:Errors[] - |=== - -// markup not found, no include::{specDir}paths/delete_library/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/delete_library/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Errors: -// markup not found, no include::{specDir}paths/delete_library/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_library/operation-security-before.adoc[opts=optional] +include::{specDir}paths/delete_library/operation-security-before.adoc[opts=optional] [#delete_library-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_library/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-fullAdmin[] +| xref:security-FullAdmin[] |=== - -// markup not found, no include::{specDir}paths/delete_library/operation-security-end.adoc[opts=optional] +include::{specDir}paths/delete_library/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/delete_library/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/delete_library/operation-security-after.adoc[opts=optional] include::{snippetDir}delete_library/http-request.adoc[opts=optional] +include::{snippetDir}delete_library/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}delete_library/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/delete_library/operation-end.adoc[opts=optional] +include::{specDir}paths/delete_library/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/delete_library/operation-after.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-after.adoc[opts=optional] //end::delete_library[] - //tag::get_collection[] - -// markup not found, no include::{specDir}paths/get_collection/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-before.adoc[opts=optional] [#get_collection] = Read All Libraries :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_collection/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-begin.adoc[opts=optional] .... GET /analytics/library .... - -// markup not found, no include::{specDir}paths/get_collection/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-description-before.adoc[opts=optional] [#get_collection-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_collection/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-description-begin.adoc[opts=optional] [markdown] -- Returns all libraries and functions. -- - -// markup not found, no include::{specDir}paths/get_collection/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-description-end.adoc[opts=optional] @@ -398,33 +346,29 @@ Returns all libraries and functions. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_collection/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_collection/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_collection/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_collection/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-responses-before.adoc[opts=optional] [#get_collection-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_collection/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -435,8 +379,7 @@ a| [markdown] -- Success. Returns an array of objects, each of which contains information about a single library. -- -a| xref:Libraries[] - array +a| xref:Libraries[] array | 404 a| [markdown] @@ -444,6 +387,7 @@ a| [markdown] Not found. The path may be missing its trailing slash. -- a| + | 500 a| [markdown] -- @@ -451,98 +395,80 @@ Internal server error. Incorrect path or port number, incorrect credentials, bad -- a| xref:Errors[] - |=== - -// markup not found, no include::{specDir}paths/get_collection/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Libraries: +:show-Errors: -// markup not found, no include::{specDir}paths/get_collection/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_collection/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-security-before.adoc[opts=optional] [#get_collection-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_collection/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsAdmin[] +| xref:security-AnalyticsAdmin[] |=== - -// markup not found, no include::{specDir}paths/get_collection/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_collection/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_collection/operation-security-after.adoc[opts=optional] include::{snippetDir}get_collection/http-request.adoc[opts=optional] - include::{snippetDir}get_collection/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_collection/operation-end.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_collection/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-after.adoc[opts=optional] //end::get_collection[] - //tag::post_library[] - -// markup not found, no include::{specDir}paths/post_library/operation-before.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-before.adoc[opts=optional] [#post_library] = Create or Update a Library :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_library/operation-begin.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-begin.adoc[opts=optional] .... POST /analytics/library/{scope}/{library} .... - -// markup not found, no include::{specDir}paths/post_library/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-description-before.adoc[opts=optional] [#post_library-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_library/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -550,7 +476,6 @@ Creates the specified library and its associated functions. If the specified lib -- - include::{specDir}paths/post_library/operation-description-end.adoc[opts=optional] @@ -562,23 +487,20 @@ include::{specDir}paths/post_library/operation-description-end.adoc[opts=optiona .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/post_library/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/post_library/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_library/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/post_library/operation-parameters-before.adoc[opts=optional] [#post_library-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_library/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-parameters-begin.adoc[opts=optional] [#post_library-path] .Path Parameters @@ -589,11 +511,8 @@ include::{specDir}paths/post_library/operation-description-end.adoc[opts=optiona ¦ Name ¦ Description ¦ Schema a¦ *library* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a library. -- @@ -602,13 +521,9 @@ The name of a library. {blank} a¦ String - a¦ *scope* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Analytics scope containing the library. @@ -622,9 +537,6 @@ The scope name may contain one or two identifiers, separated by a slash (/). You a¦ String |=== - - - [#post_library-form] .Form Parameters {blank} @@ -634,11 +546,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *data* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The library and all its dependencies, packaged by shiv. -- @@ -647,13 +556,9 @@ The library and all its dependencies, packaged by shiv. {blank} a¦ File (binary) - a¦ *type* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The language of the library. -- @@ -667,27 +572,24 @@ a¦ String |=== - -// markup not found, no include::{specDir}paths/post_library/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/post_library/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/post_library/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/post_library/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_library/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-responses-before.adoc[opts=optional] [#post_library-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_library/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -714,121 +616,108 @@ Internal server error. Incorrect path or port number, incorrect credentials, bad -- a| xref:Errors[] - |=== - -// markup not found, no include::{specDir}paths/post_library/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/post_library/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Errors: +:show-Errors: -// markup not found, no include::{specDir}paths/post_library/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_library/operation-security-before.adoc[opts=optional] +include::{specDir}paths/post_library/operation-security-before.adoc[opts=optional] [#post_library-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_library/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-fullAdmin[] +| xref:security-FullAdmin[] |=== - -// markup not found, no include::{specDir}paths/post_library/operation-security-end.adoc[opts=optional] +include::{specDir}paths/post_library/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_library/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/post_library/operation-security-after.adoc[opts=optional] include::{snippetDir}post_library/http-request.adoc[opts=optional] +include::{snippetDir}post_library/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}post_library/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/post_library/operation-end.adoc[opts=optional] +include::{specDir}paths/post_library/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_library/operation-after.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-after.adoc[opts=optional] //end::post_library[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] +include::{specDir}paths/document-after.adoc[opts=optional] - -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] - +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 2 - +:count-models: 1 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:Errors[] xref:Libraries[] endif::[] +include::{specDir}definitions/Errors/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/Errors/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Errors[] [#Errors] +endif::show-Errors[] +ifndef::show-Errors[] +:leveloffset: +1 + +[discrete#Errors] +endif::show-Errors[] = Errors :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Errors/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Errors/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -836,17 +725,13 @@ endif::collapse-models[] //tag::Errors[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*error* + -_required_ -a¦ - -[markdown] +a¦ *error* + +required +a¦ [markdown] -- An error message. -- @@ -861,28 +746,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/Errors/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Errors/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Errors/definition-after.adoc[opts=optional] - - - +ifndef::show-Errors[] +:leveloffset: -1 +endif::show-Errors[] -// markup not found, no include::{specDir}definitions/Libraries/definition-before.adoc[opts=optional] +include::{specDir}definitions/Errors/definition-after.adoc[opts=optional] +include::{specDir}definitions/Libraries/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Libraries[] [#Libraries] +endif::show-Libraries[] +ifndef::show-Libraries[] +:leveloffset: +1 + +[discrete#Libraries] +endif::show-Libraries[] = Libraries :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Libraries/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Libraries/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -890,17 +778,13 @@ endif::collapse-models[] //tag::Libraries[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*scope* + -_optional_ -a¦ - -[markdown] +a¦ *scope* + +optional +a¦ [markdown] -- The name of the Analytics scope containing the library. @@ -912,13 +796,9 @@ The scope name may contain one or two identifiers, separated by a slash (/). *Example:* `+++"travel-sample/inventory"+++` {blank} a¦ String - -a¦ -*hash_md5* + -_optional_ -a¦ - -[markdown] +a¦ *hash_md5* + +optional +a¦ [markdown] -- A MD5 hash of the library residing on the server. -- @@ -926,13 +806,9 @@ A MD5 hash of the library residing on the server. [%hardbreaks] {blank} a¦ String - -a¦ -*name* + -_optional_ -a¦ - -[markdown] +a¦ *name* + +optional +a¦ [markdown] -- The name of the library. -- @@ -948,26 +824,26 @@ a¦ String -// markup not found, no include::{specDir}definitions/Libraries/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Libraries/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Libraries/definition-after.adoc[opts=optional] - +ifndef::show-Libraries[] +:leveloffset: -1 +endif::show-Libraries[] +include::{specDir}definitions/Libraries/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] - +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -977,18 +853,14 @@ a¦ String include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/FullAdmin/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/FullAdmin/security-scheme-before.adoc[opts=optional] - - -[[security-fullAdmin]] +[[security-FullAdmin]] = Full Admin :leveloffset: +1 -// markup not found, no include::{specDir}security/FullAdmin/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/FullAdmin/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -997,29 +869,22 @@ To [Create or Update a Library](#post_library) or [Delete a Library](#delete_lib -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/FullAdmin/security-scheme-end.adoc[opts=optional] +include::{specDir}security/FullAdmin/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/FullAdmin/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/FullAdmin/security-scheme-after.adoc[opts=optional] +include::{specDir}security/AnalyticsAdmin/security-scheme-before.adoc[opts=optional] - - - -// markup not found, no include::{specDir}security/AnalyticsAdmin/security-scheme-before.adoc[opts=optional] - - -[[security-analyticsAdmin]] +[[security-AnalyticsAdmin]] = Analytics Admin :leveloffset: +1 -// markup not found, no include::{specDir}security/AnalyticsAdmin/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/AnalyticsAdmin/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -1032,16 +897,13 @@ To [Read All Libraries](#get_collection), users must have one of the following R -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/AnalyticsAdmin/security-scheme-end.adoc[opts=optional] +include::{specDir}security/AnalyticsAdmin/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/AnalyticsAdmin/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/AnalyticsAdmin/security-scheme-after.adoc[opts=optional] @@ -1049,8 +911,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - -// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] +include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/analytics-rest-links/analytics-links.gradle b/docs/modules/analytics-rest-links/analytics-links.gradle index 2fa35122..d89e88f4 100644 --- a/docs/modules/analytics-rest-links/analytics-links.gradle +++ b/docs/modules/analytics-rest-links/analytics-links.gradle @@ -20,4 +20,5 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } \ No newline at end of file diff --git a/docs/modules/analytics-rest-links/attachments/analytics-links.yaml b/docs/modules/analytics-rest-links/attachments/analytics-links.yaml index 2a438297..2730e572 100644 --- a/docs/modules/analytics-rest-links/attachments/analytics-links.yaml +++ b/docs/modules/analytics-rest-links/attachments/analytics-links.yaml @@ -995,6 +995,7 @@ components: properties: alternateAddresses: type: string + nullable: true description: > The alternate address defined on the node, if any. If not defined, this property returns `null`. @@ -1002,6 +1003,7 @@ components: example: null hostname: type: string + nullable: true description: > The hostname of the node. If not defined, this property returns `null`. @@ -1279,6 +1281,7 @@ components: securitySchemes: AnalyticsManage: + x-displayName: Analytics Manage type: http scheme: basic description: |- diff --git a/docs/modules/analytics-rest-links/pages/index.adoc b/docs/modules/analytics-rest-links/pages/index.adoc index 22535db8..88ae9aec 100644 --- a/docs/modules/analytics-rest-links/pages/index.adoc +++ b/docs/modules/analytics-rest-links/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -32,7 +31,7 @@ This API enables you to manage the links to remote Couchbase clusters and extern [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -67,7 +66,6 @@ The host name or IP address of a node running the Analytics Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -83,31 +81,26 @@ The Analytics Service REST port. Use `18095` for secure access. |=== - -// markup not found, no include::{specDir}overview/document-end.adoc[opts=optional] +include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}overview/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 3 - +:count-apis: 2 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -117,18 +110,14 @@ xref:tag-SingleLinks[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-LegacyMethods] = Legacy Methods :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:delete_alt[] @@ -136,19 +125,17 @@ xref:post_alt[] xref:put_alt[] -//tag::delete_alt[] - -// markup not found, no include::{specDir}paths/delete_alt/operation-before.adoc[opts=optional] +//tag::delete_alt[] +include::{specDir}paths/delete_alt/operation-before.adoc[opts=optional] [#delete_alt] = Delete Link (Alternative) :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_alt/operation-begin.adoc[opts=optional] - +include::{specDir}paths/delete_alt/operation-begin.adoc[opts=optional] .... DELETE /analytics/link @@ -157,16 +144,14 @@ DELETE /analytics/link CAUTION: This operation is deprecated, and will be removed in a future release. -// markup not found, no include::{specDir}paths/delete_alt/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/delete_alt/operation-description-before.adoc[opts=optional] [#delete_alt-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_alt/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/delete_alt/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -174,8 +159,7 @@ An alternative endpoint for [deleting a link](#delete_link), provided for backwa -- - -// markup not found, no include::{specDir}paths/delete_alt/operation-description-end.adoc[opts=optional] +include::{specDir}paths/delete_alt/operation-description-end.adoc[opts=optional] [#delete_alt-consumes] @@ -186,26 +170,20 @@ An alternative endpoint for [deleting a link](#delete_link), provided for backwa .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/delete_alt/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/delete_alt/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_alt/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/delete_alt/operation-parameters-before.adoc[opts=optional] [#delete_alt-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_alt/operation-parameters-begin.adoc[opts=optional] - - - - +include::{specDir}paths/delete_alt/operation-parameters-begin.adoc[opts=optional] [#delete_alt-form] .Form Parameters @@ -216,11 +194,8 @@ An alternative endpoint for [deleting a link](#delete_link), provided for backwa ¦ Name ¦ Description ¦ Schema a¦ *dataverse* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Analytics scope containing the link. With this parameter, the scope name may only contain a single identifier. -- @@ -229,13 +204,9 @@ The name of the Analytics scope containing the link. With this parameter, the s {blank} a¦ String - a¦ *name* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the link. -- @@ -248,27 +219,24 @@ a¦ String |=== - -// markup not found, no include::{specDir}paths/delete_alt/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/delete_alt/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/delete_alt/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/delete_alt/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_alt/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/delete_alt/operation-responses-before.adoc[opts=optional] [#delete_alt-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_alt/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/delete_alt/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -280,6 +248,7 @@ a| [markdown] The operation was successful. -- a| + | 400 a| [markdown] -- @@ -294,81 +263,66 @@ Internal Server Error. Incorrect path or port number, incorrect credentials, bad -- a| xref:Wrong[] - |=== - -// markup not found, no include::{specDir}paths/delete_alt/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/delete_alt/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Wrong: +:show-Wrong: -// markup not found, no include::{specDir}paths/delete_alt/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/delete_alt/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_alt/operation-security-before.adoc[opts=optional] +include::{specDir}paths/delete_alt/operation-security-before.adoc[opts=optional] [#delete_alt-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_alt/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/delete_alt/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManage[] +| xref:security-AnalyticsManage[] |=== - -// markup not found, no include::{specDir}paths/delete_alt/operation-security-end.adoc[opts=optional] +include::{specDir}paths/delete_alt/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/delete_alt/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_alt/operation-security-after.adoc[opts=optional] - - +include::{snippetDir}delete_alt/http-request.adoc[opts=optional] -// markup not found, no include::{snippetDir}delete_alt/http-request.adoc[opts=optional] +include::{snippetDir}delete_alt/http-response.adoc[opts=optional] - -// markup not found, no include::{snippetDir}delete_alt/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/delete_alt/operation-end.adoc[opts=optional] +include::{specDir}paths/delete_alt/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/delete_alt/operation-after.adoc[opts=optional] - +include::{specDir}paths/delete_alt/operation-after.adoc[opts=optional] //end::delete_alt[] - //tag::post_alt[] - -// markup not found, no include::{specDir}paths/post_alt/operation-before.adoc[opts=optional] - +include::{specDir}paths/post_alt/operation-before.adoc[opts=optional] [#post_alt] = Create Link (Alternative) :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_alt/operation-begin.adoc[opts=optional] - +include::{specDir}paths/post_alt/operation-begin.adoc[opts=optional] .... POST /analytics/link @@ -377,24 +331,21 @@ POST /analytics/link CAUTION: This operation is deprecated, and will be removed in a future release. -// markup not found, no include::{specDir}paths/post_alt/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/post_alt/operation-description-before.adoc[opts=optional] [#post_alt-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_alt/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/post_alt/operation-description-begin.adoc[opts=optional] [markdown] -- An alternative endpoint for [creating a link](#post_link), provided for backward compatibility. -- - -// markup not found, no include::{specDir}paths/post_alt/operation-description-end.adoc[opts=optional] +include::{specDir}paths/post_alt/operation-description-end.adoc[opts=optional] [#post_alt-consumes] @@ -405,26 +356,20 @@ An alternative endpoint for [creating a link](#post_link), provided for backward .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/post_alt/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/post_alt/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_alt/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/post_alt/operation-parameters-before.adoc[opts=optional] [#post_alt-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_alt/operation-parameters-begin.adoc[opts=optional] - - - - +include::{specDir}paths/post_alt/operation-parameters-begin.adoc[opts=optional] [#post_alt-form] .Form Parameters @@ -435,11 +380,8 @@ An alternative endpoint for [creating a link](#post_link), provided for backward ¦ Name ¦ Description ¦ Schema a¦ *dataverse* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Analytics scope containing the link. With this parameter, the scope name may only contain a single identifier. -- @@ -448,13 +390,9 @@ The name of the Analytics scope containing the link. With this parameter, the s {blank} a¦ String - a¦ *name* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the link. -- @@ -463,15 +401,10 @@ The name of the link. {blank} a¦ String - a¦ *type* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- - include::index.adoc[tag=desc-CommonType, opts=optional] -- @@ -481,13 +414,9 @@ include::index.adoc[tag=desc-CommonType, opts=optional] a¦ include::index.adoc[tag=type-CommonType, opts=optional] - a¦ *hostname* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For Couchbase links only. The remote hostname. -- @@ -496,13 +425,9 @@ For Couchbase links only. The remote hostname. {blank} a¦ String - a¦ *username* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The remote username. Required for links with no encryption or half encryption. Required for links with full encryption if using a password. You should URL-encode this parameter to escape any special characters. -- @@ -511,13 +436,9 @@ For Couchbase links only. The remote username. Required for links with no encryp {blank} a¦ String - a¦ *password* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The remote password. Required for links with no encryption or half encryption. Required for links with full encryption if using a username. You should URL-encode this parameter to escape any special characters. -- @@ -526,13 +447,9 @@ For Couchbase links only. The remote password. Required for links with no encryp {blank} a¦ String - a¦ *encryption* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For Couchbase links only. The type of encryption used by the link. For details, see [encryption](#encryption). -- @@ -542,13 +459,9 @@ For Couchbase links only. The type of encryption used by the link. For details, {blank} a¦ String - a¦ *certificate* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The content of the target cluster root certificate. Required for links with full encryption. You should URL-encode this parameter to escape any special characters. If required, this parameter may contain multiple certificates, separated by new lines. -- @@ -557,13 +470,9 @@ For Couchbase links only. The content of the target cluster root certificate. Re {blank} a¦ String - a¦ *clientCertificate* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links, this is the content of the client certificate. Required for links with full encryption if using a client key. For Azure Blob links, this is the client certificate for the registered application. Used for Azure Active Directory client certificate authentication. You should URL-encode this parameter to escape any special characters. -- @@ -572,13 +481,9 @@ For Couchbase links, this is the content of the client certificate. Required for {blank} a¦ String - a¦ *clientKey* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The content of the client key. Required for links with full encryption if using a client certificate. You should URL-encode this parameter to escape any special characters. -- @@ -587,13 +492,9 @@ For Couchbase links only. The content of the client key. Required for links with {blank} a¦ String - a¦ *accessKeyId* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For S3 links only. The Amazon S3 access key ID. -- @@ -602,13 +503,9 @@ For S3 links only. The Amazon S3 access key ID. {blank} a¦ String - a¦ *secretAccessKey* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For S3 links only. The Amazon S3 secret access key. You should URL-encode this parameter to escape any special characters. -- @@ -617,13 +514,9 @@ For S3 links only. The Amazon S3 secret access key. You should URL-encode this {blank} a¦ String - a¦ *sessionToken* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For S3 links only. The Amazon S3 session token. Use this parameter if you want the link to have temporary access. Passing this parameter indicates that the `accessKeyId` and `secretAccessKey` are temporary credentials. The Amazon S3 service validates the session token with each request to check whether the provided credentials have expired or are still valid. -- @@ -632,13 +525,9 @@ For S3 links only. The Amazon S3 session token. Use this parameter if you want t {blank} a¦ String - a¦ *region* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For S3 links only. The Amazon S3 region. -- @@ -647,13 +536,9 @@ For S3 links only. The Amazon S3 region. {blank} a¦ String - a¦ *serviceEndpoint* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For S3 links only. The Amazon S3 service endpoint. -- @@ -662,13 +547,9 @@ For S3 links only. The Amazon S3 service endpoint. {blank} a¦ String - a¦ *endpoint* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links and Google Cloud Storage links. The endpoint URI. Required for Azure Blob links; optional for Google Cloud Storage links. -- @@ -677,13 +558,9 @@ For Azure Blob links and Google Cloud Storage links. The endpoint URI. Required {blank} a¦ String - a¦ *accountName* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The account name. Used for shared key authentication. You should URL-encode this parameter to escape any special characters. -- @@ -692,13 +569,9 @@ For Azure Blob links only. The account name. Used for shared key authentication. {blank} a¦ String - a¦ *accountKey* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The account key. Used for shared key authentication. You should URL-encode this parameter to escape any special characters. -- @@ -707,13 +580,9 @@ For Azure Blob links only. The account key. Used for shared key authentication. {blank} a¦ String - a¦ *sharedAccessSignature* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. A token that can be used for authentication. Used for shared access signature authentication. You should URL-encode this parameter to escape any special characters. -- @@ -722,13 +591,9 @@ For Azure Blob links only. A token that can be used for authentication. Used for {blank} a¦ String - a¦ *managedIdentityId* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The managed identity ID. Used for managed identity authentication. Only available if the application is running on an Azure instance, e.g. an Azure virtual machine. You should URL-encode this parameter to escape any special characters. -- @@ -737,13 +602,9 @@ For Azure Blob links only. The managed identity ID. Used for managed identity au {blank} a¦ String - a¦ *clientId* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The client ID for the registered application. Used for Azure Active Directory client secret authentication, or Azure Active Directory client certificate authentication. You should URL-encode this parameter to escape any special characters. -- @@ -752,13 +613,9 @@ For Azure Blob links only. The client ID for the registered application. Used fo {blank} a¦ String - a¦ *tenantId* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The tenant ID where the registered application is created. Used for Azure Active Directory client secret authentication, or Azure Active Directory client certificate authentication. You should URL-encode this parameter to escape any special characters. -- @@ -767,13 +624,9 @@ For Azure Blob links only. The tenant ID where the registered application is cre {blank} a¦ String - a¦ *clientSecret* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The client secret for the registered application. Used for Azure Active Directory client secret authentication. You should URL-encode this parameter to escape any special characters. -- @@ -782,13 +635,9 @@ For Azure Blob links only. The client secret for the registered application. Use {blank} a¦ String - a¦ *clientCertificatePassword* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The client certificate password for the registered application. Used for Azure Active Directory client certificate authentication, if the client certificate is password-protected. You should URL-encode this parameter to escape any special characters. -- @@ -797,13 +646,9 @@ For Azure Blob links only. The client certificate password for the registered ap {blank} a¦ String - a¦ *jsonCredentials* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Google Cloud Storage links only. The JSON credentials of the link. This parameter is not allowed if `applicationDefaultCredentials` is provided. -- @@ -812,13 +657,9 @@ For Google Cloud Storage links only. The JSON credentials of the link. This par {blank} a¦ String - a¦ *applicationDefaultCredentials* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Google Cloud Storage links only. If present, indicates that the link should use the Google Application Default Credentials for authenticating. -- @@ -832,27 +673,24 @@ a¦ String |=== - -// markup not found, no include::{specDir}paths/post_alt/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/post_alt/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/post_alt/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/post_alt/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_alt/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/post_alt/operation-responses-before.adoc[opts=optional] [#post_alt-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_alt/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/post_alt/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -864,6 +702,7 @@ a| [markdown] The operation was successful. -- a| + | 400 a| [markdown] -- @@ -878,81 +717,66 @@ Internal Server Error. Incorrect path or port number, incorrect credentials, bad -- a| xref:Wrong[] - |=== - -// markup not found, no include::{specDir}paths/post_alt/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/post_alt/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Wrong: +:show-Wrong: -// markup not found, no include::{specDir}paths/post_alt/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/post_alt/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_alt/operation-security-before.adoc[opts=optional] +include::{specDir}paths/post_alt/operation-security-before.adoc[opts=optional] [#post_alt-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_alt/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/post_alt/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManage[] +| xref:security-AnalyticsManage[] |=== - -// markup not found, no include::{specDir}paths/post_alt/operation-security-end.adoc[opts=optional] +include::{specDir}paths/post_alt/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/post_alt/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_alt/operation-security-after.adoc[opts=optional] +include::{snippetDir}post_alt/http-request.adoc[opts=optional] +include::{snippetDir}post_alt/http-response.adoc[opts=optional] - -// markup not found, no include::{snippetDir}post_alt/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}post_alt/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/post_alt/operation-end.adoc[opts=optional] +include::{specDir}paths/post_alt/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_alt/operation-after.adoc[opts=optional] - +include::{specDir}paths/post_alt/operation-after.adoc[opts=optional] //end::post_alt[] - //tag::put_alt[] - -// markup not found, no include::{specDir}paths/put_alt/operation-before.adoc[opts=optional] - +include::{specDir}paths/put_alt/operation-before.adoc[opts=optional] [#put_alt] = Edit Link (Alternative) :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_alt/operation-begin.adoc[opts=optional] - +include::{specDir}paths/put_alt/operation-begin.adoc[opts=optional] .... PUT /analytics/link @@ -961,16 +785,14 @@ PUT /analytics/link CAUTION: This operation is deprecated, and will be removed in a future release. -// markup not found, no include::{specDir}paths/put_alt/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/put_alt/operation-description-before.adoc[opts=optional] [#put_alt-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_alt/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/put_alt/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -978,8 +800,7 @@ An alternative endpoint for [editing a link](#put_link), provided for backward c -- - -// markup not found, no include::{specDir}paths/put_alt/operation-description-end.adoc[opts=optional] +include::{specDir}paths/put_alt/operation-description-end.adoc[opts=optional] [#put_alt-consumes] @@ -990,26 +811,20 @@ An alternative endpoint for [editing a link](#put_link), provided for backward c .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/put_alt/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/put_alt/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_alt/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/put_alt/operation-parameters-before.adoc[opts=optional] [#put_alt-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_alt/operation-parameters-begin.adoc[opts=optional] - - - - +include::{specDir}paths/put_alt/operation-parameters-begin.adoc[opts=optional] [#put_alt-form] .Form Parameters @@ -1020,11 +835,8 @@ An alternative endpoint for [editing a link](#put_link), provided for backward c ¦ Name ¦ Description ¦ Schema a¦ *dataverse* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Analytics scope containing the link. With this parameter, the scope name may only contain a single identifier. -- @@ -1033,13 +845,9 @@ The name of the Analytics scope containing the link. With this parameter, the s {blank} a¦ String - a¦ *name* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the link. -- @@ -1048,15 +856,10 @@ The name of the link. {blank} a¦ String - a¦ *type* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- - include::index.adoc[tag=desc-CommonTypeEdit, opts=optional] -- @@ -1066,13 +869,9 @@ include::index.adoc[tag=desc-CommonTypeEdit, opts=optional] a¦ include::index.adoc[tag=type-CommonTypeEdit, opts=optional] - a¦ *hostname* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For Couchbase links only. The remote hostname. -- @@ -1081,13 +880,9 @@ For Couchbase links only. The remote hostname. {blank} a¦ String - a¦ *username* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The remote username. Required for links with no encryption or half encryption. Required for links with full encryption if using a password. You should URL-encode this parameter to escape any special characters. -- @@ -1096,13 +891,9 @@ For Couchbase links only. The remote username. Required for links with no encryp {blank} a¦ String - a¦ *password* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The remote password. Required for links with no encryption or half encryption. Required for links with full encryption if using a username. You should URL-encode this parameter to escape any special characters. -- @@ -1111,13 +902,9 @@ For Couchbase links only. The remote password. Required for links with no encryp {blank} a¦ String - a¦ *encryption* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For Couchbase links only. The type of encryption used by the link. For details, see [encryption](#encryption). -- @@ -1127,13 +914,9 @@ For Couchbase links only. The type of encryption used by the link. For details, {blank} a¦ String - a¦ *certificate* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The content of the target cluster root certificate. Required for links with full encryption. You should URL-encode this parameter to escape any special characters. If required, this parameter may contain multiple certificates, separated by new lines. -- @@ -1142,13 +925,9 @@ For Couchbase links only. The content of the target cluster root certificate. Re {blank} a¦ String - a¦ *clientCertificate* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links, this is the content of the client certificate. Required for links with full encryption if using a client key. For Azure Blob links, this is the client certificate for the registered application. Used for Azure Active Directory client certificate authentication. You should URL-encode this parameter to escape any special characters. -- @@ -1157,13 +936,9 @@ For Couchbase links, this is the content of the client certificate. Required for {blank} a¦ String - a¦ *clientKey* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The content of the client key. Required for links with full encryption if using a client certificate. You should URL-encode this parameter to escape any special characters. -- @@ -1172,13 +947,9 @@ For Couchbase links only. The content of the client key. Required for links with {blank} a¦ String - a¦ *accessKeyId* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For S3 links only. The Amazon S3 access key ID. -- @@ -1187,13 +958,9 @@ For S3 links only. The Amazon S3 access key ID. {blank} a¦ String - a¦ *secretAccessKey* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For S3 links only. The Amazon S3 secret access key. You should URL-encode this parameter to escape any special characters. -- @@ -1202,13 +969,9 @@ For S3 links only. The Amazon S3 secret access key. You should URL-encode this {blank} a¦ String - a¦ *sessionToken* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For S3 links only. The Amazon S3 session token. Use this parameter if you want the link to have temporary access. Passing this parameter indicates that the `accessKeyId` and `secretAccessKey` are temporary credentials. The Amazon S3 service validates the session token with each request to check whether the provided credentials have expired or are still valid. -- @@ -1217,13 +980,9 @@ For S3 links only. The Amazon S3 session token. Use this parameter if you want t {blank} a¦ String - a¦ *region* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For S3 links only. The Amazon S3 region. -- @@ -1232,13 +991,9 @@ For S3 links only. The Amazon S3 region. {blank} a¦ String - a¦ *serviceEndpoint* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For S3 links only. The Amazon S3 service endpoint. -- @@ -1247,13 +1002,9 @@ For S3 links only. The Amazon S3 service endpoint. {blank} a¦ String - a¦ *endpoint* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links and Google Cloud Storage links. The endpoint URI. Required for Azure Blob links; optional for Google Cloud Storage links. -- @@ -1262,13 +1013,9 @@ For Azure Blob links and Google Cloud Storage links. The endpoint URI. Required {blank} a¦ String - a¦ *accountName* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The account name. Used for shared key authentication. You should URL-encode this parameter to escape any special characters. -- @@ -1277,13 +1024,9 @@ For Azure Blob links only. The account name. Used for shared key authentication. {blank} a¦ String - a¦ *accountKey* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The account key. Used for shared key authentication. You should URL-encode this parameter to escape any special characters. -- @@ -1292,13 +1035,9 @@ For Azure Blob links only. The account key. Used for shared key authentication. {blank} a¦ String - a¦ *sharedAccessSignature* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. A token that can be used for authentication. Used for shared access signature authentication. You should URL-encode this parameter to escape any special characters. -- @@ -1307,13 +1046,9 @@ For Azure Blob links only. A token that can be used for authentication. Used for {blank} a¦ String - a¦ *managedIdentityId* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The managed identity ID. Used for managed identity authentication. Only available if the application is running on an Azure instance, e.g. an Azure virtual machine. You should URL-encode this parameter to escape any special characters. -- @@ -1322,13 +1057,9 @@ For Azure Blob links only. The managed identity ID. Used for managed identity au {blank} a¦ String - a¦ *clientId* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The client ID for the registered application. Used for Azure Active Directory client secret authentication, or Azure Active Directory client certificate authentication. You should URL-encode this parameter to escape any special characters. -- @@ -1337,13 +1068,9 @@ For Azure Blob links only. The client ID for the registered application. Used fo {blank} a¦ String - a¦ *tenantId* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The tenant ID where the registered application is created. Used for Azure Active Directory client secret authentication, or Azure Active Directory client certificate authentication. You should URL-encode this parameter to escape any special characters. -- @@ -1352,13 +1079,9 @@ For Azure Blob links only. The tenant ID where the registered application is cre {blank} a¦ String - a¦ *clientSecret* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The client secret for the registered application. Used for Azure Active Directory client secret authentication. You should URL-encode this parameter to escape any special characters. -- @@ -1367,13 +1090,9 @@ For Azure Blob links only. The client secret for the registered application. Use {blank} a¦ String - a¦ *clientCertificatePassword* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The client certificate password for the registered application. Used for Azure Active Directory client certificate authentication, if the client certificate is password-protected. You should URL-encode this parameter to escape any special characters. -- @@ -1382,13 +1101,9 @@ For Azure Blob links only. The client certificate password for the registered ap {blank} a¦ String - a¦ *jsonCredentials* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Google Cloud Storage links only. The JSON credentials of the link. This parameter is not allowed if `applicationDefaultCredentials` is provided. -- @@ -1397,13 +1112,9 @@ For Google Cloud Storage links only. The JSON credentials of the link. This par {blank} a¦ String - a¦ *applicationDefaultCredentials* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Google Cloud Storage links only. If present, indicates that the link should use the Google Application Default Credentials for authenticating. -- @@ -1417,27 +1128,24 @@ a¦ String |=== - -// markup not found, no include::{specDir}paths/put_alt/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/put_alt/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/put_alt/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/put_alt/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_alt/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/put_alt/operation-responses-before.adoc[opts=optional] [#put_alt-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_alt/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/put_alt/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1449,6 +1157,7 @@ a| [markdown] The operation was successful. -- a| + | 400 a| [markdown] -- @@ -1463,129 +1172,108 @@ Internal Server Error. Incorrect path or port number, incorrect credentials, bad -- a| xref:Wrong[] - |=== - -// markup not found, no include::{specDir}paths/put_alt/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/put_alt/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Wrong: +:show-Wrong: -// markup not found, no include::{specDir}paths/put_alt/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/put_alt/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_alt/operation-security-before.adoc[opts=optional] +include::{specDir}paths/put_alt/operation-security-before.adoc[opts=optional] [#put_alt-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_alt/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/put_alt/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManage[] +| xref:security-AnalyticsManage[] |=== - -// markup not found, no include::{specDir}paths/put_alt/operation-security-end.adoc[opts=optional] +include::{specDir}paths/put_alt/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/put_alt/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_alt/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}put_alt/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}put_alt/http-response.adoc[opts=optional] - +include::{snippetDir}put_alt/http-request.adoc[opts=optional] +include::{snippetDir}put_alt/http-response.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_alt/operation-end.adoc[opts=optional] +include::{specDir}paths/put_alt/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/put_alt/operation-after.adoc[opts=optional] - +include::{specDir}paths/put_alt/operation-after.adoc[opts=optional] //end::put_alt[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-MultipleLinks] = Multiple Links :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:get_all[] xref:get_scope[] -//tag::get_all[] - -// markup not found, no include::{specDir}paths/get_all/operation-before.adoc[opts=optional] +//tag::get_all[] +include::{specDir}paths/get_all/operation-before.adoc[opts=optional] [#get_all] = Query All Links :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_all/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_all/operation-begin.adoc[opts=optional] .... GET /analytics/link .... - -// markup not found, no include::{specDir}paths/get_all/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_all/operation-description-before.adoc[opts=optional] [#get_all-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_all/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_all/operation-description-begin.adoc[opts=optional] [markdown] -- Returns information about all links in all Analytics scopes. -- - -// markup not found, no include::{specDir}paths/get_all/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_all/operation-description-end.adoc[opts=optional] @@ -1593,24 +1281,20 @@ Returns information about all links in all Analytics scopes. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_all/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_all/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_all/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_all/operation-parameters-before.adoc[opts=optional] [#get_all-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_all/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/get_all/operation-parameters-begin.adoc[opts=optional] [#get_all-query] .Query Parameters @@ -1621,11 +1305,8 @@ Returns information about all links in all Analytics scopes. ¦ Name ¦ Description ¦ Schema a¦ *dataverse* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- The name of an Analytics scope. When this parameter is included, the request only returns information about links in the specified scope. @@ -1639,13 +1320,9 @@ This parameter is provided for backward compatibility. Note that it is deprecate {blank} a¦ String - a¦ *name* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- The name of a link. When this parameter is included, the request only returns information about the specified link. If specified, the `dataverse` parameter must be specified also. @@ -1657,13 +1334,9 @@ This parameter is provided for backward compatibility. Note that it is deprecate {blank} a¦ String - a¦ *type* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- The type of the link. If this parameter is omitted, all link types are retrieved, excluding the `Local` link. @@ -1678,29 +1351,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/get_all/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/get_all/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_all/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/get_all/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_all/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_all/operation-responses-before.adoc[opts=optional] [#get_all-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_all/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_all/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1711,8 +1379,7 @@ a| [markdown] -- Success. Returns an array of objects, each of which contains information about a link. -- -a| xref:ResponseAll[] - array +a| xref:ResponseAll[] array | 400 a| [markdown] @@ -1728,106 +1395,88 @@ Internal Server Error. Incorrect path or port number, incorrect credentials, bad -- a| xref:Wrong[] - |=== - -// markup not found, no include::{specDir}paths/get_all/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_all/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-ResponseAll: +:show-Wrong: +:show-Wrong: -// markup not found, no include::{specDir}paths/get_all/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_all/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_all/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_all/operation-security-before.adoc[opts=optional] [#get_all-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_all/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_all/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManage[] +| xref:security-AnalyticsManage[] |=== - -// markup not found, no include::{specDir}paths/get_all/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_all/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_all/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_all/operation-security-after.adoc[opts=optional] include::{snippetDir}get_all/http-request.adoc[opts=optional] - include::{snippetDir}get_all/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_all/operation-end.adoc[opts=optional] +include::{specDir}paths/get_all/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_all/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_all/operation-after.adoc[opts=optional] //end::get_all[] - //tag::get_scope[] - -// markup not found, no include::{specDir}paths/get_scope/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_scope/operation-before.adoc[opts=optional] [#get_scope] = Query Scope Links :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_scope/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_scope/operation-begin.adoc[opts=optional] .... GET /analytics/link/{scope} .... - -// markup not found, no include::{specDir}paths/get_scope/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_scope/operation-description-before.adoc[opts=optional] [#get_scope-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_scope/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_scope/operation-description-begin.adoc[opts=optional] [markdown] -- Returns information about all links in the specified Analytics scope. -- - -// markup not found, no include::{specDir}paths/get_scope/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_scope/operation-description-end.adoc[opts=optional] @@ -1835,23 +1484,20 @@ Returns information about all links in the specified Analytics scope. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_scope/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_scope/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_scope/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_scope/operation-parameters-before.adoc[opts=optional] [#get_scope-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_scope/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/get_scope/operation-parameters-begin.adoc[opts=optional] [#get_scope-path] .Path Parameters @@ -1862,11 +1508,8 @@ Returns information about all links in the specified Analytics scope. ¦ Name ¦ Description ¦ Schema a¦ *scope* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Analytics scope. @@ -1880,7 +1523,6 @@ With this parameter, the scope name may contain one or two identifiers, separate a¦ String |=== - [#get_scope-query] .Query Parameters {blank} @@ -1890,11 +1532,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *type* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- The type of the link. If this parameter is omitted, all link types are retrieved, excluding the `Local` link. @@ -1909,29 +1548,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/get_scope/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/get_scope/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_scope/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/get_scope/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_scope/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_scope/operation-responses-before.adoc[opts=optional] [#get_scope-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_scope/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_scope/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1942,8 +1576,7 @@ a| [markdown] -- Success. Returns an array of objects, each of which contains information about a link. -- -a| xref:ResponseAll[] - array +a| xref:ResponseAll[] array | 400 a| [markdown] @@ -1959,85 +1592,71 @@ Internal Server Error. Incorrect path or port number, incorrect credentials, bad -- a| xref:Wrong[] - |=== - -// markup not found, no include::{specDir}paths/get_scope/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_scope/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-ResponseAll: +:show-Wrong: +:show-Wrong: -// markup not found, no include::{specDir}paths/get_scope/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_scope/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_scope/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_scope/operation-security-before.adoc[opts=optional] [#get_scope-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_scope/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_scope/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManage[] +| xref:security-AnalyticsManage[] |=== - -// markup not found, no include::{specDir}paths/get_scope/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_scope/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_scope/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_scope/operation-security-after.adoc[opts=optional] include::{snippetDir}get_scope/http-request.adoc[opts=optional] - include::{snippetDir}get_scope/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_scope/operation-end.adoc[opts=optional] +include::{specDir}paths/get_scope/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_scope/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_scope/operation-after.adoc[opts=optional] //end::get_scope[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-SingleLinks] = Single Links :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:delete_link[] @@ -2046,36 +1665,31 @@ xref:post_link[] xref:put_link[] -//tag::delete_link[] - -// markup not found, no include::{specDir}paths/delete_link/operation-before.adoc[opts=optional] +//tag::delete_link[] +include::{specDir}paths/delete_link/operation-before.adoc[opts=optional] [#delete_link] = Delete Link :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_link/operation-begin.adoc[opts=optional] - +include::{specDir}paths/delete_link/operation-begin.adoc[opts=optional] .... DELETE /analytics/link/{scope}/{name} .... - -// markup not found, no include::{specDir}paths/delete_link/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/delete_link/operation-description-before.adoc[opts=optional] [#delete_link-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_link/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/delete_link/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -2083,8 +1697,7 @@ Deletes a link in the specified Analytics scope. The link cannot be deleted if a -- - -// markup not found, no include::{specDir}paths/delete_link/operation-description-end.adoc[opts=optional] +include::{specDir}paths/delete_link/operation-description-end.adoc[opts=optional] @@ -2092,23 +1705,20 @@ Deletes a link in the specified Analytics scope. The link cannot be deleted if a .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/delete_link/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/delete_link/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_link/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/delete_link/operation-parameters-before.adoc[opts=optional] [#delete_link-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_link/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/delete_link/operation-parameters-begin.adoc[opts=optional] [#delete_link-path] .Path Parameters @@ -2119,11 +1729,8 @@ Deletes a link in the specified Analytics scope. The link cannot be deleted if a ¦ Name ¦ Description ¦ Schema a¦ *scope* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Analytics scope. @@ -2135,13 +1742,9 @@ With this parameter, the scope name may contain one or two identifiers, separate {blank} a¦ String - a¦ *name* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the link. -- @@ -2154,30 +1757,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/delete_link/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/delete_link/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/delete_link/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/delete_link/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_link/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/delete_link/operation-responses-before.adoc[opts=optional] [#delete_link-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_link/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/delete_link/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2189,6 +1786,7 @@ a| [markdown] The operation was successful. -- a| + | 400 a| [markdown] -- @@ -2203,106 +1801,87 @@ Internal Server Error. Incorrect path or port number, incorrect credentials, bad -- a| xref:Wrong[] - |=== - -// markup not found, no include::{specDir}paths/delete_link/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/delete_link/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Wrong: +:show-Wrong: -// markup not found, no include::{specDir}paths/delete_link/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/delete_link/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_link/operation-security-before.adoc[opts=optional] +include::{specDir}paths/delete_link/operation-security-before.adoc[opts=optional] [#delete_link-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_link/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/delete_link/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManage[] +| xref:security-AnalyticsManage[] |=== - -// markup not found, no include::{specDir}paths/delete_link/operation-security-end.adoc[opts=optional] +include::{specDir}paths/delete_link/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/delete_link/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_link/operation-security-after.adoc[opts=optional] +include::{snippetDir}delete_link/http-request.adoc[opts=optional] +include::{snippetDir}delete_link/http-response.adoc[opts=optional] - -include::{snippetDir}delete_link/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}delete_link/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/delete_link/operation-end.adoc[opts=optional] +include::{specDir}paths/delete_link/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/delete_link/operation-after.adoc[opts=optional] - +include::{specDir}paths/delete_link/operation-after.adoc[opts=optional] //end::delete_link[] - //tag::get_link[] - -// markup not found, no include::{specDir}paths/get_link/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_link/operation-before.adoc[opts=optional] [#get_link] = Query Link :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_link/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_link/operation-begin.adoc[opts=optional] .... GET /analytics/link/{scope}/{name} .... - -// markup not found, no include::{specDir}paths/get_link/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_link/operation-description-before.adoc[opts=optional] [#get_link-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_link/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_link/operation-description-begin.adoc[opts=optional] [markdown] -- Returns information about a link in the specified Analytics scope. -- - -// markup not found, no include::{specDir}paths/get_link/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_link/operation-description-end.adoc[opts=optional] @@ -2310,23 +1889,20 @@ Returns information about a link in the specified Analytics scope. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_link/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_link/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_link/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_link/operation-parameters-before.adoc[opts=optional] [#get_link-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_link/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/get_link/operation-parameters-begin.adoc[opts=optional] [#get_link-path] .Path Parameters @@ -2337,11 +1913,8 @@ Returns information about a link in the specified Analytics scope. ¦ Name ¦ Description ¦ Schema a¦ *scope* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Analytics scope. @@ -2353,13 +1926,9 @@ With this parameter, the scope name may contain one or two identifiers, separate {blank} a¦ String - a¦ *name* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the link. -- @@ -2370,7 +1939,6 @@ The name of the link. a¦ String |=== - [#get_link-query] .Query Parameters {blank} @@ -2380,13 +1948,9 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *type* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- - include::index.adoc[tag=desc-CommonTypeEdit, opts=optional] -- @@ -2400,29 +1964,24 @@ include::index.adoc[tag=type-CommonTypeEdit, opts=optional] |=== - - - -// markup not found, no include::{specDir}paths/get_link/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/get_link/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_link/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/get_link/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_link/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_link/operation-responses-before.adoc[opts=optional] [#get_link-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_link/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_link/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2433,8 +1992,7 @@ a| [markdown] -- Success. Returns an array of objects, each of which contains information about a link. -- -a| xref:ResponseAll[] - array +a| xref:ResponseAll[] array | 400 a| [markdown] @@ -2450,106 +2008,88 @@ Internal Server Error. Incorrect path or port number, incorrect credentials, bad -- a| xref:Wrong[] - |=== - -// markup not found, no include::{specDir}paths/get_link/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_link/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-ResponseAll: +:show-Wrong: +:show-Wrong: -// markup not found, no include::{specDir}paths/get_link/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_link/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_link/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_link/operation-security-before.adoc[opts=optional] [#get_link-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_link/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_link/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManage[] +| xref:security-AnalyticsManage[] |=== - -// markup not found, no include::{specDir}paths/get_link/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_link/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_link/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_link/operation-security-after.adoc[opts=optional] include::{snippetDir}get_link/http-request.adoc[opts=optional] - include::{snippetDir}get_link/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_link/operation-end.adoc[opts=optional] +include::{specDir}paths/get_link/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_link/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_link/operation-after.adoc[opts=optional] //end::get_link[] - //tag::post_link[] - -// markup not found, no include::{specDir}paths/post_link/operation-before.adoc[opts=optional] - +include::{specDir}paths/post_link/operation-before.adoc[opts=optional] [#post_link] = Create Link :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_link/operation-begin.adoc[opts=optional] - +include::{specDir}paths/post_link/operation-begin.adoc[opts=optional] .... POST /analytics/link/{scope}/{name} .... - -// markup not found, no include::{specDir}paths/post_link/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/post_link/operation-description-before.adoc[opts=optional] [#post_link-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_link/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/post_link/operation-description-begin.adoc[opts=optional] [markdown] -- Creates a link in the specified Analytics scope. -- - -// markup not found, no include::{specDir}paths/post_link/operation-description-end.adoc[opts=optional] +include::{specDir}paths/post_link/operation-description-end.adoc[opts=optional] [#post_link-consumes] @@ -2560,23 +2100,20 @@ Creates a link in the specified Analytics scope. .Produces * application/json -:leveloffset: -1 +:leveloffset: -1 include::{specDir}paths/post_link/operation-description-after.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/post_link/operation-parameters-before.adoc[opts=optional] - +include::{specDir}paths/post_link/operation-parameters-before.adoc[opts=optional] [#post_link-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_link/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/post_link/operation-parameters-begin.adoc[opts=optional] [#post_link-path] .Path Parameters @@ -2587,11 +2124,8 @@ include::{specDir}paths/post_link/operation-description-after.adoc[opts=optional ¦ Name ¦ Description ¦ Schema a¦ *scope* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Analytics scope. @@ -2603,13 +2137,9 @@ With this parameter, the scope name may contain one or two identifiers, separate {blank} a¦ String - a¦ *name* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the link. -- @@ -2620,9 +2150,6 @@ The name of the link. a¦ String |=== - - - [#post_link-form] .Form Parameters {blank} @@ -2632,13 +2159,9 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *type* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- - include::index.adoc[tag=desc-CommonType, opts=optional] -- @@ -2648,13 +2171,9 @@ include::index.adoc[tag=desc-CommonType, opts=optional] a¦ include::index.adoc[tag=type-CommonType, opts=optional] - a¦ *hostname* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For Couchbase links only. The remote hostname. -- @@ -2663,13 +2182,9 @@ For Couchbase links only. The remote hostname. {blank} a¦ String - a¦ *username* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The remote username. Required for links with no encryption or half encryption. Required for links with full encryption if using a password. You should URL-encode this parameter to escape any special characters. -- @@ -2678,13 +2193,9 @@ For Couchbase links only. The remote username. Required for links with no encryp {blank} a¦ String - a¦ *password* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The remote password. Required for links with no encryption or half encryption. Required for links with full encryption if using a username. You should URL-encode this parameter to escape any special characters. -- @@ -2693,13 +2204,9 @@ For Couchbase links only. The remote password. Required for links with no encryp {blank} a¦ String - a¦ *encryption* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For Couchbase links only. The type of encryption used by the link. For details, see [encryption](#encryption). -- @@ -2709,13 +2216,9 @@ For Couchbase links only. The type of encryption used by the link. For details, {blank} a¦ String - a¦ *certificate* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The content of the target cluster root certificate. Required for links with full encryption. You should URL-encode this parameter to escape any special characters. If required, this parameter may contain multiple certificates, separated by new lines. -- @@ -2724,13 +2227,9 @@ For Couchbase links only. The content of the target cluster root certificate. Re {blank} a¦ String - a¦ *clientCertificate* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links, this is the content of the client certificate. Required for links with full encryption if using a client key. For Azure Blob links, this is the client certificate for the registered application. Used for Azure Active Directory client certificate authentication. You should URL-encode this parameter to escape any special characters. -- @@ -2739,13 +2238,9 @@ For Couchbase links, this is the content of the client certificate. Required for {blank} a¦ String - a¦ *clientKey* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The content of the client key. Required for links with full encryption if using a client certificate. You should URL-encode this parameter to escape any special characters. -- @@ -2754,13 +2249,9 @@ For Couchbase links only. The content of the client key. Required for links with {blank} a¦ String - a¦ *accessKeyId* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For S3 links only. The Amazon S3 access key ID. -- @@ -2769,13 +2260,9 @@ For S3 links only. The Amazon S3 access key ID. {blank} a¦ String - a¦ *secretAccessKey* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For S3 links only. The Amazon S3 secret access key. You should URL-encode this parameter to escape any special characters. -- @@ -2784,13 +2271,9 @@ For S3 links only. The Amazon S3 secret access key. You should URL-encode this {blank} a¦ String - a¦ *sessionToken* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For S3 links only. The Amazon S3 session token. Use this parameter if you want the link to have temporary access. Passing this parameter indicates that the `accessKeyId` and `secretAccessKey` are temporary credentials. The Amazon S3 service validates the session token with each request to check whether the provided credentials have expired or are still valid. -- @@ -2799,13 +2282,9 @@ For S3 links only. The Amazon S3 session token. Use this parameter if you want t {blank} a¦ String - a¦ *region* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For S3 links only. The Amazon S3 region. -- @@ -2814,13 +2293,9 @@ For S3 links only. The Amazon S3 region. {blank} a¦ String - a¦ *serviceEndpoint* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For S3 links only. The Amazon S3 service endpoint. -- @@ -2829,13 +2304,9 @@ For S3 links only. The Amazon S3 service endpoint. {blank} a¦ String - a¦ *endpoint* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links and Google Cloud Storage links. The endpoint URI. Required for Azure Blob links; optional for Google Cloud Storage links. -- @@ -2844,13 +2315,9 @@ For Azure Blob links and Google Cloud Storage links. The endpoint URI. Required {blank} a¦ String - a¦ *accountName* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The account name. Used for shared key authentication. You should URL-encode this parameter to escape any special characters. -- @@ -2859,13 +2326,9 @@ For Azure Blob links only. The account name. Used for shared key authentication. {blank} a¦ String - a¦ *accountKey* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The account key. Used for shared key authentication. You should URL-encode this parameter to escape any special characters. -- @@ -2874,13 +2337,9 @@ For Azure Blob links only. The account key. Used for shared key authentication. {blank} a¦ String - a¦ *sharedAccessSignature* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. A token that can be used for authentication. Used for shared access signature authentication. You should URL-encode this parameter to escape any special characters. -- @@ -2889,13 +2348,9 @@ For Azure Blob links only. A token that can be used for authentication. Used for {blank} a¦ String - a¦ *managedIdentityId* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The managed identity ID. Used for managed identity authentication. Only available if the application is running on an Azure instance, e.g. an Azure virtual machine. You should URL-encode this parameter to escape any special characters. -- @@ -2904,13 +2359,9 @@ For Azure Blob links only. The managed identity ID. Used for managed identity au {blank} a¦ String - a¦ *clientId* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The client ID for the registered application. Used for Azure Active Directory client secret authentication, or Azure Active Directory client certificate authentication. You should URL-encode this parameter to escape any special characters. -- @@ -2919,13 +2370,9 @@ For Azure Blob links only. The client ID for the registered application. Used fo {blank} a¦ String - a¦ *tenantId* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The tenant ID where the registered application is created. Used for Azure Active Directory client secret authentication, or Azure Active Directory client certificate authentication. You should URL-encode this parameter to escape any special characters. -- @@ -2934,13 +2381,9 @@ For Azure Blob links only. The tenant ID where the registered application is cre {blank} a¦ String - a¦ *clientSecret* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The client secret for the registered application. Used for Azure Active Directory client secret authentication. You should URL-encode this parameter to escape any special characters. -- @@ -2949,13 +2392,9 @@ For Azure Blob links only. The client secret for the registered application. Use {blank} a¦ String - a¦ *clientCertificatePassword* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The client certificate password for the registered application. Used for Azure Active Directory client certificate authentication, if the client certificate is password-protected. You should URL-encode this parameter to escape any special characters. -- @@ -2964,13 +2403,9 @@ For Azure Blob links only. The client certificate password for the registered ap {blank} a¦ String - a¦ *jsonCredentials* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Google Cloud Storage links only. The JSON credentials of the link. This parameter is not allowed if `applicationDefaultCredentials` is provided. -- @@ -2979,13 +2414,9 @@ For Google Cloud Storage links only. The JSON credentials of the link. This par {blank} a¦ String - a¦ *applicationDefaultCredentials* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Google Cloud Storage links only. If present, indicates that the link should use the Google Application Default Credentials for authenticating. -- @@ -2999,27 +2430,24 @@ a¦ String |=== - -// markup not found, no include::{specDir}paths/post_link/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/post_link/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/post_link/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/post_link/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_link/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/post_link/operation-responses-before.adoc[opts=optional] [#post_link-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_link/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/post_link/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3031,6 +2459,7 @@ a| [markdown] The operation was successful. -- a| + | 400 a| [markdown] -- @@ -3045,98 +2474,80 @@ Internal Server Error. Incorrect path or port number, incorrect credentials, bad -- a| xref:Wrong[] - |=== - -// markup not found, no include::{specDir}paths/post_link/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/post_link/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Wrong: +:show-Wrong: -// markup not found, no include::{specDir}paths/post_link/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/post_link/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_link/operation-security-before.adoc[opts=optional] +include::{specDir}paths/post_link/operation-security-before.adoc[opts=optional] [#post_link-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_link/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/post_link/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManage[] +| xref:security-AnalyticsManage[] |=== - -// markup not found, no include::{specDir}paths/post_link/operation-security-end.adoc[opts=optional] +include::{specDir}paths/post_link/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_link/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/post_link/operation-security-after.adoc[opts=optional] include::{snippetDir}post_link/http-request.adoc[opts=optional] +include::{snippetDir}post_link/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}post_link/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/post_link/operation-end.adoc[opts=optional] +include::{specDir}paths/post_link/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_link/operation-after.adoc[opts=optional] - +include::{specDir}paths/post_link/operation-after.adoc[opts=optional] //end::post_link[] - //tag::put_link[] - -// markup not found, no include::{specDir}paths/put_link/operation-before.adoc[opts=optional] - +include::{specDir}paths/put_link/operation-before.adoc[opts=optional] [#put_link] = Edit Link :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_link/operation-begin.adoc[opts=optional] - +include::{specDir}paths/put_link/operation-begin.adoc[opts=optional] .... PUT /analytics/link/{scope}/{name} .... - -// markup not found, no include::{specDir}paths/put_link/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/put_link/operation-description-before.adoc[opts=optional] [#put_link-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_link/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/put_link/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -3144,8 +2555,7 @@ Edits an existing link in the specified Analytics scope. The link name, type, an -- - -// markup not found, no include::{specDir}paths/put_link/operation-description-end.adoc[opts=optional] +include::{specDir}paths/put_link/operation-description-end.adoc[opts=optional] [#put_link-consumes] @@ -3156,23 +2566,20 @@ Edits an existing link in the specified Analytics scope. The link name, type, an .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/put_link/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/put_link/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_link/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/put_link/operation-parameters-before.adoc[opts=optional] [#put_link-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_link/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/put_link/operation-parameters-begin.adoc[opts=optional] [#put_link-path] .Path Parameters @@ -3183,11 +2590,8 @@ Edits an existing link in the specified Analytics scope. The link name, type, an ¦ Name ¦ Description ¦ Schema a¦ *scope* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Analytics scope. @@ -3199,13 +2603,9 @@ With this parameter, the scope name may contain one or two identifiers, separate {blank} a¦ String - a¦ *name* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the link. -- @@ -3216,9 +2616,6 @@ The name of the link. a¦ String |=== - - - [#put_link-form] .Form Parameters {blank} @@ -3228,13 +2625,9 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *type* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- - include::index.adoc[tag=desc-CommonTypeEdit, opts=optional] -- @@ -3244,13 +2637,9 @@ include::index.adoc[tag=desc-CommonTypeEdit, opts=optional] a¦ include::index.adoc[tag=type-CommonTypeEdit, opts=optional] - a¦ *hostname* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For Couchbase links only. The remote hostname. -- @@ -3259,13 +2648,9 @@ For Couchbase links only. The remote hostname. {blank} a¦ String - a¦ *username* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The remote username. Required for links with no encryption or half encryption. Required for links with full encryption if using a password. You should URL-encode this parameter to escape any special characters. -- @@ -3274,13 +2659,9 @@ For Couchbase links only. The remote username. Required for links with no encryp {blank} a¦ String - a¦ *password* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The remote password. Required for links with no encryption or half encryption. Required for links with full encryption if using a username. You should URL-encode this parameter to escape any special characters. -- @@ -3289,13 +2670,9 @@ For Couchbase links only. The remote password. Required for links with no encryp {blank} a¦ String - a¦ *encryption* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For Couchbase links only. The type of encryption used by the link. For details, see [encryption](#encryption). -- @@ -3305,13 +2682,9 @@ For Couchbase links only. The type of encryption used by the link. For details, {blank} a¦ String - a¦ *certificate* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The content of the target cluster root certificate. Required for links with full encryption. You should URL-encode this parameter to escape any special characters. If required, this parameter may contain multiple certificates, separated by new lines. -- @@ -3320,13 +2693,9 @@ For Couchbase links only. The content of the target cluster root certificate. Re {blank} a¦ String - a¦ *clientCertificate* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links, this is the content of the client certificate. Required for links with full encryption if using a client key. For Azure Blob links, this is the client certificate for the registered application. Used for Azure Active Directory client certificate authentication. You should URL-encode this parameter to escape any special characters. -- @@ -3335,13 +2704,9 @@ For Couchbase links, this is the content of the client certificate. Required for {blank} a¦ String - a¦ *clientKey* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Couchbase links only. The content of the client key. Required for links with full encryption if using a client certificate. You should URL-encode this parameter to escape any special characters. -- @@ -3350,13 +2715,9 @@ For Couchbase links only. The content of the client key. Required for links with {blank} a¦ String - a¦ *accessKeyId* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For S3 links only. The Amazon S3 access key ID. -- @@ -3365,13 +2726,9 @@ For S3 links only. The Amazon S3 access key ID. {blank} a¦ String - a¦ *secretAccessKey* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For S3 links only. The Amazon S3 secret access key. You should URL-encode this parameter to escape any special characters. -- @@ -3380,13 +2737,9 @@ For S3 links only. The Amazon S3 secret access key. You should URL-encode this {blank} a¦ String - a¦ *sessionToken* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For S3 links only. The Amazon S3 session token. Use this parameter if you want the link to have temporary access. Passing this parameter indicates that the `accessKeyId` and `secretAccessKey` are temporary credentials. The Amazon S3 service validates the session token with each request to check whether the provided credentials have expired or are still valid. -- @@ -3395,13 +2748,9 @@ For S3 links only. The Amazon S3 session token. Use this parameter if you want t {blank} a¦ String - a¦ *region* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- For S3 links only. The Amazon S3 region. -- @@ -3410,13 +2759,9 @@ For S3 links only. The Amazon S3 region. {blank} a¦ String - a¦ *serviceEndpoint* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For S3 links only. The Amazon S3 service endpoint. -- @@ -3425,13 +2770,9 @@ For S3 links only. The Amazon S3 service endpoint. {blank} a¦ String - a¦ *endpoint* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links and Google Cloud Storage links. The endpoint URI. Required for Azure Blob links; optional for Google Cloud Storage links. -- @@ -3440,13 +2781,9 @@ For Azure Blob links and Google Cloud Storage links. The endpoint URI. Required {blank} a¦ String - a¦ *accountName* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The account name. Used for shared key authentication. You should URL-encode this parameter to escape any special characters. -- @@ -3455,13 +2792,9 @@ For Azure Blob links only. The account name. Used for shared key authentication. {blank} a¦ String - a¦ *accountKey* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The account key. Used for shared key authentication. You should URL-encode this parameter to escape any special characters. -- @@ -3470,13 +2803,9 @@ For Azure Blob links only. The account key. Used for shared key authentication. {blank} a¦ String - a¦ *sharedAccessSignature* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. A token that can be used for authentication. Used for shared access signature authentication. You should URL-encode this parameter to escape any special characters. -- @@ -3485,13 +2814,9 @@ For Azure Blob links only. A token that can be used for authentication. Used for {blank} a¦ String - a¦ *managedIdentityId* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The managed identity ID. Used for managed identity authentication. Only available if the application is running on an Azure instance, e.g. an Azure virtual machine. You should URL-encode this parameter to escape any special characters. -- @@ -3500,13 +2825,9 @@ For Azure Blob links only. The managed identity ID. Used for managed identity au {blank} a¦ String - a¦ *clientId* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The client ID for the registered application. Used for Azure Active Directory client secret authentication, or Azure Active Directory client certificate authentication. You should URL-encode this parameter to escape any special characters. -- @@ -3515,13 +2836,9 @@ For Azure Blob links only. The client ID for the registered application. Used fo {blank} a¦ String - a¦ *tenantId* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The tenant ID where the registered application is created. Used for Azure Active Directory client secret authentication, or Azure Active Directory client certificate authentication. You should URL-encode this parameter to escape any special characters. -- @@ -3530,13 +2847,9 @@ For Azure Blob links only. The tenant ID where the registered application is cre {blank} a¦ String - a¦ *clientSecret* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The client secret for the registered application. Used for Azure Active Directory client secret authentication. You should URL-encode this parameter to escape any special characters. -- @@ -3545,13 +2858,9 @@ For Azure Blob links only. The client secret for the registered application. Use {blank} a¦ String - a¦ *clientCertificatePassword* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Azure Blob links only. The client certificate password for the registered application. Used for Azure Active Directory client certificate authentication, if the client certificate is password-protected. You should URL-encode this parameter to escape any special characters. -- @@ -3560,13 +2869,9 @@ For Azure Blob links only. The client certificate password for the registered ap {blank} a¦ String - a¦ *jsonCredentials* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Google Cloud Storage links only. The JSON credentials of the link. This parameter is not allowed if `applicationDefaultCredentials` is provided. -- @@ -3575,13 +2880,9 @@ For Google Cloud Storage links only. The JSON credentials of the link. This par {blank} a¦ String - a¦ *applicationDefaultCredentials* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For Google Cloud Storage links only. If present, indicates that the link should use the Google Application Default Credentials for authenticating. -- @@ -3595,27 +2896,24 @@ a¦ String |=== - -// markup not found, no include::{specDir}paths/put_link/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/put_link/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/put_link/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/put_link/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_link/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/put_link/operation-responses-before.adoc[opts=optional] [#put_link-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_link/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/put_link/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3627,6 +2925,7 @@ a| [markdown] The operation was successful. -- a| + | 400 a| [markdown] -- @@ -3641,102 +2940,87 @@ Internal Server Error. Incorrect path or port number, incorrect credentials, bad -- a| xref:Wrong[] - |=== - -// markup not found, no include::{specDir}paths/put_link/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/put_link/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Wrong: +:show-Wrong: -// markup not found, no include::{specDir}paths/put_link/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/put_link/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_link/operation-security-before.adoc[opts=optional] +include::{specDir}paths/put_link/operation-security-before.adoc[opts=optional] [#put_link-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_link/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/put_link/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManage[] +| xref:security-AnalyticsManage[] |=== - -// markup not found, no include::{specDir}paths/put_link/operation-security-end.adoc[opts=optional] +include::{specDir}paths/put_link/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/put_link/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/put_link/operation-security-after.adoc[opts=optional] include::{snippetDir}put_link/http-request.adoc[opts=optional] +include::{snippetDir}put_link/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}put_link/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/put_link/operation-end.adoc[opts=optional] +include::{specDir}paths/put_link/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/put_link/operation-after.adoc[opts=optional] - +include::{specDir}paths/put_link/operation-after.adoc[opts=optional] //end::put_link[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 14 - +:count-models: 13 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] ifdef::enum-definitions[] xref:CommonType[] @@ -3758,58 +3042,144 @@ xref:ResponseS3Specific[] xref:Wrong[] endif::[] + +include::{specDir}definitions/CommonType/definition-before.adoc[opts=optional] + ifdef::enum-definitions[] +ifdef::show-CommonType[] [#CommonType] +endif::show-CommonType[] +ifndef::show-CommonType[] +:leveloffset: +1 + +[discrete#CommonType] +endif::show-CommonType[] = Create Request Type +ifdef::model-descriptions[] +//tag::desc-CommonType[] +The type of the link. + +* `couchbase`: A link to a remote Couchbase cluster. +* `s3`: A link to the Amazon S3 service. +* `azureblob`: A link to Azure Blob Storage. +* `gcs`: A link to Google Cloud Storage. +//end::desc-CommonType[] +endif::model-descriptions[] + +:leveloffset: +1 + +include::{specDir}definitions/CommonType/definition-begin.adoc[opts=optional] + + .icon:menu[fw] Enumeration {blank} -//tag::desc-CommonType[] +[markdown] +-- The type of the link. * `couchbase`: A link to a remote Couchbase cluster. * `s3`: A link to the Amazon S3 service. * `azureblob`: A link to Azure Blob Storage. * `gcs`: A link to Google Cloud Storage. -//end::desc-CommonType[] +-- +[%hardbreaks] +*Values:* `"couchbase"`, `"s3"`, `"azureblob"`, `"gcs"` +{blank} .Schema //tag::type-CommonType[] -String +string //end::type-CommonType[] + +include::{specDir}definitions/CommonType/definition-end.adoc[opts=optional] + +:leveloffset: -1 + +ifndef::show-CommonType[] +:leveloffset: -1 +endif::show-CommonType[] + endif::enum-definitions[] + +include::{specDir}definitions/CommonType/definition-after.adoc[opts=optional] + +include::{specDir}definitions/CommonTypeEdit/definition-before.adoc[opts=optional] + ifdef::enum-definitions[] +ifdef::show-CommonTypeEdit[] [#CommonTypeEdit] +endif::show-CommonTypeEdit[] +ifndef::show-CommonTypeEdit[] +:leveloffset: +1 + +[discrete#CommonTypeEdit] +endif::show-CommonTypeEdit[] = Edit Request Type +ifdef::model-descriptions[] +//tag::desc-CommonTypeEdit[] +The type of the link. If this parameter is specified, the value must match the type that was set when the link was created. + +//end::desc-CommonTypeEdit[] +endif::model-descriptions[] + +:leveloffset: +1 + +include::{specDir}definitions/CommonTypeEdit/definition-begin.adoc[opts=optional] + + .icon:menu[fw] Enumeration {blank} -//tag::desc-CommonTypeEdit[] +[markdown] +-- The type of the link. If this parameter is specified, the value must match the type that was set when the link was created. -//end::desc-CommonTypeEdit[] +-- +[%hardbreaks] +*Values:* `"couchbase"`, `"s3"`, `"azureblob"`, `"gcs"` +{blank} .Schema //tag::type-CommonTypeEdit[] -String +string //end::type-CommonTypeEdit[] -endif::enum-definitions[] +include::{specDir}definitions/CommonTypeEdit/definition-end.adoc[opts=optional] + +:leveloffset: -1 + +ifndef::show-CommonTypeEdit[] +:leveloffset: -1 +endif::show-CommonTypeEdit[] + +endif::enum-definitions[] -// markup not found, no include::{specDir}definitions/ResponseAll/definition-before.adoc[opts=optional] +include::{specDir}definitions/CommonTypeEdit/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponseAll/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponseAll[] [#ResponseAll] +endif::show-ResponseAll[] +ifndef::show-ResponseAll[] +:leveloffset: +1 + +[discrete#ResponseAll] +endif::show-ResponseAll[] = Links +ifdef::model-descriptions[] +//tag::desc-ResponseAll[] +Properties common to all links. +//end::desc-ResponseAll[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponseAll/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ResponseAll/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -3817,22 +3187,13 @@ endif::collapse-models[] //tag::ResponseAll[] -ifdef::model-descriptions[] -//tag::desc-ResponseAll[] -Properties common to all links. -//end::desc-ResponseAll[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*scope* + -_required_ -a¦ - -[markdown] +a¦ *scope* + +required +a¦ [markdown] -- The name of the Analytics scope containing the link. @@ -3844,13 +3205,9 @@ The scope name may contain one or two identifiers, separated by a slash (/). *Example:* `+++"travel-sample/inventory"+++` {blank} a¦ String - -a¦ -*name* + -_required_ -a¦ - -[markdown] +a¦ *name* + +required +a¦ [markdown] -- The name of the link. -- @@ -3859,13 +3216,10 @@ The name of the link. *Example:* `+++"myLink"+++` {blank} a¦ String - a¦ [#type] *type* + -_required_ -a¦ - -[markdown] +required +a¦ [markdown] -- The type of the link. @@ -3885,57 +3239,45 @@ a¦ String //end::ResponseAll[] This schema has alternative properties, depending on the value of *type*: - [cols="25,55,20"] |=== | Value | | Schema - a| `azureblob` a| These properties are returned for Azure Blob links. a| xref:ResponseAzureBlob[] - a| `couchbase` a| These properties are returned for remote Couchbase links. a| xref:ResponseCouchbase[] - a| `gcs` a| These properties are returned for Google Cloud Storage links. a| xref:ResponseGCS[] - a| `s3` a| These properties are returned for S3 links. a| xref:ResponseS3[] -|=== - -// markup not found, no include::{specDir}definitions/ResponseAll/definition-end.adoc[opts=optional] +|=== +include::{specDir}definitions/ResponseAll/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponseAll/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponseAll[] +:leveloffset: -1 +endif::show-ResponseAll[] -// markup not found, no include::{specDir}definitions/ResponseAzureBlob/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponseAll/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponseAzureBlob/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponseAzureBlob[] [#ResponseAzureBlob] -= Azure Blob Response - +endif::show-ResponseAzureBlob[] +ifndef::show-ResponseAzureBlob[] :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponseAzureBlob/definition-begin.adoc[opts=optional] - - -.icon:bars[fw] Composite Schema -{blank} - -//tag::ResponseAzureBlob[] +[discrete#ResponseAzureBlob] +endif::show-ResponseAzureBlob[] += Azure Blob Response ifdef::model-descriptions[] //tag::desc-ResponseAzureBlob[] @@ -3943,14 +3285,20 @@ These properties are returned for Azure Blob links. //end::desc-ResponseAzureBlob[] endif::model-descriptions[] +:leveloffset: +1 + +include::{specDir}definitions/ResponseAzureBlob/definition-begin.adoc[opts=optional] + +.icon:bars[fw] Composite Schema +{blank} + +//tag::ResponseAzureBlob[] [cols="25,55,20",separator=¦] |=== ¦ All{nbsp}of{nbsp}... ¦ ¦ Schema a¦ -a¦ - -[markdown] +a¦ [markdown] -- include::index.adoc[tag=desc-ResponseAll, opts=optional] -- @@ -3959,10 +3307,8 @@ include::index.adoc[tag=desc-ResponseAll, opts=optional] {blank} a¦ xref:ResponseAll[] -a¦ _and_ -a¦ - -[markdown] +a¦ and +a¦ [markdown] -- include::index.adoc[tag=desc-ResponseAzureBlobSpecific, opts=optional] -- @@ -3970,34 +3316,41 @@ include::index.adoc[tag=desc-ResponseAzureBlobSpecific, opts=optional] [%hardbreaks] {blank} a¦ xref:ResponseAzureBlobSpecific[] - |=== //end::ResponseAzureBlob[] - -// markup not found, no include::{specDir}definitions/ResponseAzureBlob/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponseAzureBlob/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponseAzureBlob/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponseAzureBlob[] +:leveloffset: -1 +endif::show-ResponseAzureBlob[] -// markup not found, no include::{specDir}definitions/ResponseAzureBlobSpecific/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponseAzureBlob/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponseAzureBlobSpecific/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponseAzureBlobSpecific[] [#ResponseAzureBlobSpecific] +endif::show-ResponseAzureBlobSpecific[] +ifndef::show-ResponseAzureBlobSpecific[] +:leveloffset: +1 + +[discrete#ResponseAzureBlobSpecific] +endif::show-ResponseAzureBlobSpecific[] = Azure Blob Specific Response +ifdef::model-descriptions[] +//tag::desc-ResponseAzureBlobSpecific[] +Properties specific to Azure Blob links. +//end::desc-ResponseAzureBlobSpecific[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponseAzureBlobSpecific/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ResponseAzureBlobSpecific/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -4005,86 +3358,65 @@ endif::collapse-models[] //tag::ResponseAzureBlobSpecific[] -ifdef::model-descriptions[] -//tag::desc-ResponseAzureBlobSpecific[] -Properties specific to Azure Blob links. -//end::desc-ResponseAzureBlobSpecific[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*accountKey* + -_optional_ -a¦ - -[markdown] +a¦ *accountKey* + +optional +a¦ [markdown] -- The account key. Used for shared key authentication. This is redacted for the sake of security. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes *Example:* `+++""+++` {blank} a¦ String - -a¦ -*accountName* + -_optional_ -a¦ - -[markdown] +a¦ *accountName* + +optional +a¦ [markdown] -- The account name. Used for shared key authentication. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes *Example:* `+++"myAccountName"+++` {blank} a¦ String - -a¦ -*clientCertificate* + -_optional_ -a¦ - -[markdown] +a¦ *clientCertificate* + +optional +a¦ [markdown] -- The client certificate for the registered application. Used for Azure Active Directory client certificate authentication. This is redacted for the sake of security. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes *Example:* `+++""+++` {blank} a¦ String - -a¦ -*clientCertificatePassword* + -_optional_ -a¦ - -[markdown] +a¦ *clientCertificatePassword* + +optional +a¦ [markdown] -- The client certificate password for the registered application. Used for Azure Active Directory client certificate authentication, if the client certificate is password-protected. This is redacted for the sake of security. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes *Example:* `+++""+++` {blank} a¦ String - -a¦ -*clientId* + -_optional_ -a¦ - -[markdown] +a¦ *clientId* + +optional +a¦ [markdown] -- The client ID for the registered application. Used for Azure Active Directory client secret authentication, or Azure Active Directory client certificate authentication. If not set, this property returns `null`. @@ -4094,29 +3426,22 @@ The client ID for the registered application. Used for Azure Active Directory cl *Example:* `+++"myClientID"+++` {blank} a¦ String - -a¦ -*clientSecret* + -_optional_ -a¦ - -[markdown] +a¦ *clientSecret* + +optional +a¦ [markdown] -- The client secret for the registered application. Used for Azure Active Directory client secret authentication. This is redacted for the sake of security. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes *Example:* `+++""+++` {blank} a¦ String - -a¦ -*endpoint* + -_required_ -a¦ - -[markdown] +a¦ *endpoint* + +required +a¦ [markdown] -- The endpoint URI. -- @@ -4125,51 +3450,42 @@ The endpoint URI. *Example:* `+++"my.endpoint.uri"+++` {blank} a¦ String - -a¦ -*managedIdentityId* + -_optional_ -a¦ - -[markdown] +a¦ *managedIdentityId* + +optional +a¦ [markdown] -- The managed identity ID. Used for managed identity authentication. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes *Example:* `+++"myManagedIdentityID"+++` {blank} a¦ String - -a¦ -*sharedAccessSignature* + -_optional_ -a¦ - -[markdown] +a¦ *sharedAccessSignature* + +optional +a¦ [markdown] -- A token that can be used for authentication. Used for shared access signature authentication. This is redacted for the sake of security. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes *Example:* `+++""+++` {blank} a¦ String - -a¦ -*tenantId* + -_optional_ -a¦ - -[markdown] +a¦ *tenantId* + +optional +a¦ [markdown] -- The tenant ID where the registered application is created. Used for Azure Active Directory client secret authentication, or Azure Active Directory client certificate authentication. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes *Example:* `+++"myTenantID"+++` {blank} a¦ String @@ -4180,34 +3496,27 @@ a¦ String -// markup not found, no include::{specDir}definitions/ResponseAzureBlobSpecific/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponseAzureBlobSpecific/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponseAzureBlobSpecific/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponseAzureBlobSpecific[] +:leveloffset: -1 +endif::show-ResponseAzureBlobSpecific[] -// markup not found, no include::{specDir}definitions/ResponseCouchbase/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponseAzureBlobSpecific/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponseCouchbase/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponseCouchbase[] [#ResponseCouchbase] -= Couchbase Response - +endif::show-ResponseCouchbase[] +ifndef::show-ResponseCouchbase[] :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponseCouchbase/definition-begin.adoc[opts=optional] - - -.icon:bars[fw] Composite Schema -{blank} - -//tag::ResponseCouchbase[] +[discrete#ResponseCouchbase] +endif::show-ResponseCouchbase[] += Couchbase Response ifdef::model-descriptions[] //tag::desc-ResponseCouchbase[] @@ -4215,14 +3524,20 @@ These properties are returned for remote Couchbase links. //end::desc-ResponseCouchbase[] endif::model-descriptions[] +:leveloffset: +1 + +include::{specDir}definitions/ResponseCouchbase/definition-begin.adoc[opts=optional] + +.icon:bars[fw] Composite Schema +{blank} + +//tag::ResponseCouchbase[] [cols="25,55,20",separator=¦] |=== ¦ All{nbsp}of{nbsp}... ¦ ¦ Schema a¦ -a¦ - -[markdown] +a¦ [markdown] -- include::index.adoc[tag=desc-ResponseAll, opts=optional] -- @@ -4231,10 +3546,8 @@ include::index.adoc[tag=desc-ResponseAll, opts=optional] {blank} a¦ xref:ResponseAll[] -a¦ _and_ -a¦ - -[markdown] +a¦ and +a¦ [markdown] -- include::index.adoc[tag=desc-ResponseCouchbaseSpecific, opts=optional] -- @@ -4242,34 +3555,41 @@ include::index.adoc[tag=desc-ResponseCouchbaseSpecific, opts=optional] [%hardbreaks] {blank} a¦ xref:ResponseCouchbaseSpecific[] - |=== //end::ResponseCouchbase[] - -// markup not found, no include::{specDir}definitions/ResponseCouchbase/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponseCouchbase/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponseCouchbase/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponseCouchbase[] +:leveloffset: -1 +endif::show-ResponseCouchbase[] -// markup not found, no include::{specDir}definitions/ResponseCouchbaseSpecific/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponseCouchbase/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponseCouchbaseSpecific/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponseCouchbaseSpecific[] [#ResponseCouchbaseSpecific] +endif::show-ResponseCouchbaseSpecific[] +ifndef::show-ResponseCouchbaseSpecific[] +:leveloffset: +1 + +[discrete#ResponseCouchbaseSpecific] +endif::show-ResponseCouchbaseSpecific[] = Couchbase Specific Response +ifdef::model-descriptions[] +//tag::desc-ResponseCouchbaseSpecific[] +Properties specific to remote Couchbase links. +//end::desc-ResponseCouchbaseSpecific[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponseCouchbaseSpecific/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ResponseCouchbaseSpecific/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -4277,22 +3597,13 @@ endif::collapse-models[] //tag::ResponseCouchbaseSpecific[] -ifdef::model-descriptions[] -//tag::desc-ResponseCouchbaseSpecific[] -Properties specific to remote Couchbase links. -//end::desc-ResponseCouchbaseSpecific[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*activeHostname* + -_required_ -a¦ - -[markdown] +a¦ *activeHostname* + +required +a¦ [markdown] -- The remote hostname. -- @@ -4301,13 +3612,9 @@ The remote hostname. *Example:* `+++"remoteHostName:8091"+++` {blank} a¦ String - -a¦ -*bootstrapAlternateAddress* + -_required_ -a¦ - -[markdown] +a¦ *bootstrapAlternateAddress* + +required +a¦ [markdown] -- Specifies whether the provided (bootstrap) hostname is an alternative address. -- @@ -4316,13 +3623,9 @@ Specifies whether the provided (bootstrap) hostname is an alternative address. *Example:* `false` {blank} a¦ Boolean - -a¦ -*bootstrapHostname* + -_required_ -a¦ - -[markdown] +a¦ *bootstrapHostname* + +required +a¦ [markdown] -- The provided (bootstrap) hostname. -- @@ -4331,58 +3634,45 @@ The provided (bootstrap) hostname. *Example:* `+++"remoteHostName:8091"+++` {blank} a¦ String - -a¦ -*certificate* + -_required_ -a¦ - -[markdown] +a¦ *certificate* + +required +a¦ [markdown] -- The content of the target cluster root certificate. Only set for links with full encryption. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*clientCertificate* + -_required_ -a¦ - -[markdown] +a¦ *clientCertificate* + +required +a¦ [markdown] -- The content of the client certificate. Only set for links with full encryption using client certificate and client key. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*clientKey* + -_required_ -a¦ - -[markdown] +a¦ *clientKey* + +required +a¦ [markdown] -- The content of the client key. Only set for links with full encryption using client certificate and client key. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*clusterCompatibility* + -_required_ -a¦ - -[markdown] +a¦ *clusterCompatibility* + +required +a¦ [markdown] -- For internal use only. -- @@ -4391,13 +3681,10 @@ For internal use only. *Example:* `393221` {blank} a¦ Integer - a¦ [#encryption] *encryption* + -_required_ -a¦ - -[markdown] +required +a¦ [markdown] -- The type of encryption used by the link. @@ -4410,61 +3697,46 @@ The type of encryption used by the link. [%hardbreaks] *Values:* `"none"`, `"half"`, `"full"` {blank} -a¦ String - -a¦ -*nodes* + -_required_ -a¦ - -[markdown] +a¦ String +a¦ *nodes* + +required +a¦ [markdown] -- An array of objects, each of which contains information about a node in the target cluster. -- [%hardbreaks] {blank} -a¦ xref:ResponseCouchbaseSpecificNode[] - array - -a¦ -*password* + -_required_ -a¦ - -[markdown] +a¦ xref:ResponseCouchbaseSpecificNode[] array +a¦ *password* + +required +a¦ [markdown] -- The password used to connect to the link. This is redacted for the sake of security. Not set for links with full encryption using client certificate and client key. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes *Example:* `+++""+++` {blank} a¦ String - -a¦ -*username* + -_required_ -a¦ - -[markdown] +a¦ *username* + +required +a¦ [markdown] -- The remote username. Not set for links with full encryption using client certificate and client key. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes *Example:* `+++"remote.user"+++` {blank} a¦ String - -a¦ -*uuid* + -_required_ -a¦ - -[markdown] +a¦ *uuid* + +required +a¦ [markdown] -- A UUID uniquely identifying the link. -- @@ -4480,28 +3752,31 @@ a¦ UUID (UUID) -// markup not found, no include::{specDir}definitions/ResponseCouchbaseSpecific/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponseCouchbaseSpecific/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponseCouchbaseSpecific/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponseCouchbaseSpecific[] +:leveloffset: -1 +endif::show-ResponseCouchbaseSpecific[] -// markup not found, no include::{specDir}definitions/ResponseCouchbaseSpecificNode/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponseCouchbaseSpecific/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponseCouchbaseSpecificNode/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponseCouchbaseSpecificNode[] [#ResponseCouchbaseSpecificNode] +endif::show-ResponseCouchbaseSpecificNode[] +ifndef::show-ResponseCouchbaseSpecificNode[] +:leveloffset: +1 + +[discrete#ResponseCouchbaseSpecificNode] +endif::show-ResponseCouchbaseSpecificNode[] = Nodes :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponseCouchbaseSpecificNode/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ResponseCouchbaseSpecificNode/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -4509,47 +3784,37 @@ endif::collapse-models[] //tag::ResponseCouchbaseSpecificNode[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*alternateAddresses* + -_optional_ -a¦ - -[markdown] +a¦ *alternateAddresses* + +optional +a¦ [markdown] -- The alternate address defined on the node, if any. If not defined, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*hostname* + -_optional_ -a¦ - -[markdown] +a¦ *hostname* + +optional +a¦ [markdown] -- The hostname of the node. If not defined, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*services* + -_optional_ -a¦ - -[markdown] +a¦ *services* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-ResponseCouchbaseSpecificNodeServices, opts=optional] -- @@ -4564,28 +3829,37 @@ a¦ xref:ResponseCouchbaseSpecificNodeServices[] -// markup not found, no include::{specDir}definitions/ResponseCouchbaseSpecificNode/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponseCouchbaseSpecificNode/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponseCouchbaseSpecificNode/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponseCouchbaseSpecificNode[] +:leveloffset: -1 +endif::show-ResponseCouchbaseSpecificNode[] -// markup not found, no include::{specDir}definitions/ResponseCouchbaseSpecificNodeServices/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponseCouchbaseSpecificNode/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponseCouchbaseSpecificNodeServices/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponseCouchbaseSpecificNodeServices[] [#ResponseCouchbaseSpecificNodeServices] +endif::show-ResponseCouchbaseSpecificNodeServices[] +ifndef::show-ResponseCouchbaseSpecificNodeServices[] +:leveloffset: +1 + +[discrete#ResponseCouchbaseSpecificNodeServices] +endif::show-ResponseCouchbaseSpecificNodeServices[] = Services +ifdef::model-descriptions[] +//tag::desc-ResponseCouchbaseSpecificNodeServices[] +An object giving information about the services and ports configured on this node. +//end::desc-ResponseCouchbaseSpecificNodeServices[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponseCouchbaseSpecificNodeServices/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ResponseCouchbaseSpecificNodeServices/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -4593,22 +3867,13 @@ endif::collapse-models[] //tag::ResponseCouchbaseSpecificNodeServices[] -ifdef::model-descriptions[] -//tag::desc-ResponseCouchbaseSpecificNodeServices[] -An object giving information about the services and ports configured on this node. -//end::desc-ResponseCouchbaseSpecificNodeServices[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*cbas* + -_optional_ -a¦ - -[markdown] +a¦ *cbas* + +optional +a¦ [markdown] -- The port number for a connection to the Analytics service. -- @@ -4617,13 +3882,9 @@ The port number for a connection to the Analytics service. *Example:* `8095` {blank} a¦ Integer - -a¦ -*cbasSSL* + -_optional_ -a¦ - -[markdown] +a¦ *cbasSSL* + +optional +a¦ [markdown] -- The port number for an encrypted connection to the Analytics service. -- @@ -4632,13 +3893,9 @@ The port number for an encrypted connection to the Analytics service. *Example:* `18095` {blank} a¦ Integer - -a¦ -*kv* + -_optional_ -a¦ - -[markdown] +a¦ *kv* + +optional +a¦ [markdown] -- The port number for a connection to the Data service. -- @@ -4647,13 +3904,9 @@ The port number for a connection to the Data service. *Example:* `11210` {blank} a¦ Integer - -a¦ -*kvSSL* + -_optional_ -a¦ - -[markdown] +a¦ *kvSSL* + +optional +a¦ [markdown] -- The port number for an encrypted connection to the Data service. -- @@ -4662,13 +3915,9 @@ The port number for an encrypted connection to the Data service. *Example:* `11207` {blank} a¦ Integer - -a¦ -*mgmt* + -_optional_ -a¦ - -[markdown] +a¦ *mgmt* + +optional +a¦ [markdown] -- The port number for a connection to the Cluster Manager service. -- @@ -4677,13 +3926,9 @@ The port number for a connection to the Cluster Manager service. *Example:* `8091` {blank} a¦ Integer - -a¦ -*mgmtSSL* + -_optional_ -a¦ - -[markdown] +a¦ *mgmtSSL* + +optional +a¦ [markdown] -- The port number for an encrypted connection to the Cluster Manager service. -- @@ -4699,34 +3944,27 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/ResponseCouchbaseSpecificNodeServices/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponseCouchbaseSpecificNodeServices/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponseCouchbaseSpecificNodeServices/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponseCouchbaseSpecificNodeServices[] +:leveloffset: -1 +endif::show-ResponseCouchbaseSpecificNodeServices[] -// markup not found, no include::{specDir}definitions/ResponseGCS/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponseCouchbaseSpecificNodeServices/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponseGCS/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponseGCS[] [#ResponseGCS] -= GCS Response - +endif::show-ResponseGCS[] +ifndef::show-ResponseGCS[] :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponseGCS/definition-begin.adoc[opts=optional] - - -.icon:bars[fw] Composite Schema -{blank} - -//tag::ResponseGCS[] +[discrete#ResponseGCS] +endif::show-ResponseGCS[] += GCS Response ifdef::model-descriptions[] //tag::desc-ResponseGCS[] @@ -4734,14 +3972,20 @@ These properties are returned for Google Cloud Storage links. //end::desc-ResponseGCS[] endif::model-descriptions[] +:leveloffset: +1 + +include::{specDir}definitions/ResponseGCS/definition-begin.adoc[opts=optional] + +.icon:bars[fw] Composite Schema +{blank} + +//tag::ResponseGCS[] [cols="25,55,20",separator=¦] |=== ¦ All{nbsp}of{nbsp}... ¦ ¦ Schema a¦ -a¦ - -[markdown] +a¦ [markdown] -- include::index.adoc[tag=desc-ResponseAll, opts=optional] -- @@ -4750,10 +3994,8 @@ include::index.adoc[tag=desc-ResponseAll, opts=optional] {blank} a¦ xref:ResponseAll[] -a¦ _and_ -a¦ - -[markdown] +a¦ and +a¦ [markdown] -- include::index.adoc[tag=desc-ResponseGCSSpecific, opts=optional] -- @@ -4761,34 +4003,41 @@ include::index.adoc[tag=desc-ResponseGCSSpecific, opts=optional] [%hardbreaks] {blank} a¦ xref:ResponseGCSSpecific[] - |=== //end::ResponseGCS[] - -// markup not found, no include::{specDir}definitions/ResponseGCS/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponseGCS/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponseGCS/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponseGCS[] +:leveloffset: -1 +endif::show-ResponseGCS[] -// markup not found, no include::{specDir}definitions/ResponseGCSSpecific/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponseGCS/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponseGCSSpecific/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponseGCSSpecific[] [#ResponseGCSSpecific] +endif::show-ResponseGCSSpecific[] +ifndef::show-ResponseGCSSpecific[] +:leveloffset: +1 + +[discrete#ResponseGCSSpecific] +endif::show-ResponseGCSSpecific[] = GCS Specific Response +ifdef::model-descriptions[] +//tag::desc-ResponseGCSSpecific[] +Properties specific to Google Cloud Storage links. +//end::desc-ResponseGCSSpecific[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponseGCSSpecific/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ResponseGCSSpecific/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -4796,22 +4045,13 @@ endif::collapse-models[] //tag::ResponseGCSSpecific[] -ifdef::model-descriptions[] -//tag::desc-ResponseGCSSpecific[] -Properties specific to Google Cloud Storage links. -//end::desc-ResponseGCSSpecific[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*applicationDefaultCredentials* + -_required_ -a¦ - -[markdown] +a¦ *applicationDefaultCredentials* + +required +a¦ [markdown] -- If present, indicates that the link should use the Google Application Default Credentials for authenticating. If not set, this property returns `null`. @@ -4819,38 +4059,33 @@ If present, indicates that the link should use the Google Application Default Cr [%hardbreaks] *Values:* `"true"` +*Nullable:* yes *Example:* `+++"true"+++` {blank} a¦ String - -a¦ -*endpoint* + -_required_ -a¦ - -[markdown] +a¦ *endpoint* + +required +a¦ [markdown] -- The endpoint URI. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes *Example:* `+++"https://storage.googleapis.com"+++` {blank} a¦ String - -a¦ -*jsonCredentials* + -_required_ -a¦ - -[markdown] +a¦ *jsonCredentials* + +required +a¦ [markdown] -- The JSON credentials of the link. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes *Example:* `+++""+++` {blank} a¦ String @@ -4861,34 +4096,27 @@ a¦ String -// markup not found, no include::{specDir}definitions/ResponseGCSSpecific/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponseGCSSpecific/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponseGCSSpecific/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponseGCSSpecific[] +:leveloffset: -1 +endif::show-ResponseGCSSpecific[] -// markup not found, no include::{specDir}definitions/ResponseS3/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponseGCSSpecific/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponseS3/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponseS3[] [#ResponseS3] -= S3 Response - +endif::show-ResponseS3[] +ifndef::show-ResponseS3[] :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponseS3/definition-begin.adoc[opts=optional] - - -.icon:bars[fw] Composite Schema -{blank} - -//tag::ResponseS3[] +[discrete#ResponseS3] +endif::show-ResponseS3[] += S3 Response ifdef::model-descriptions[] //tag::desc-ResponseS3[] @@ -4896,14 +4124,20 @@ These properties are returned for S3 links. //end::desc-ResponseS3[] endif::model-descriptions[] +:leveloffset: +1 + +include::{specDir}definitions/ResponseS3/definition-begin.adoc[opts=optional] + +.icon:bars[fw] Composite Schema +{blank} + +//tag::ResponseS3[] [cols="25,55,20",separator=¦] |=== ¦ All{nbsp}of{nbsp}... ¦ ¦ Schema a¦ -a¦ - -[markdown] +a¦ [markdown] -- include::index.adoc[tag=desc-ResponseAll, opts=optional] -- @@ -4912,10 +4146,8 @@ include::index.adoc[tag=desc-ResponseAll, opts=optional] {blank} a¦ xref:ResponseAll[] -a¦ _and_ -a¦ - -[markdown] +a¦ and +a¦ [markdown] -- include::index.adoc[tag=desc-ResponseS3Specific, opts=optional] -- @@ -4923,34 +4155,41 @@ include::index.adoc[tag=desc-ResponseS3Specific, opts=optional] [%hardbreaks] {blank} a¦ xref:ResponseS3Specific[] - |=== //end::ResponseS3[] - -// markup not found, no include::{specDir}definitions/ResponseS3/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponseS3/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponseS3/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponseS3[] +:leveloffset: -1 +endif::show-ResponseS3[] -// markup not found, no include::{specDir}definitions/ResponseS3Specific/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponseS3/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponseS3Specific/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponseS3Specific[] [#ResponseS3Specific] +endif::show-ResponseS3Specific[] +ifndef::show-ResponseS3Specific[] +:leveloffset: +1 + +[discrete#ResponseS3Specific] +endif::show-ResponseS3Specific[] = S3 Specific Response +ifdef::model-descriptions[] +//tag::desc-ResponseS3Specific[] +Properties specific to S3 links. +//end::desc-ResponseS3Specific[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponseS3Specific/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ResponseS3Specific/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -4958,22 +4197,13 @@ endif::collapse-models[] //tag::ResponseS3Specific[] -ifdef::model-descriptions[] -//tag::desc-ResponseS3Specific[] -Properties specific to S3 links. -//end::desc-ResponseS3Specific[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*accessKeyId* + -_required_ -a¦ - -[markdown] +a¦ *accessKeyId* + +required +a¦ [markdown] -- The Amazon S3 access key ID. -- @@ -4982,13 +4212,9 @@ The Amazon S3 access key ID. *Example:* `+++"myAccessKey"+++` {blank} a¦ String - -a¦ -*region* + -_required_ -a¦ - -[markdown] +a¦ *region* + +required +a¦ [markdown] -- The Amazon S3 region. -- @@ -4997,13 +4223,9 @@ The Amazon S3 region. *Example:* `+++"us-east-1"+++` {blank} a¦ String - -a¦ -*secretAccessKey* + -_required_ -a¦ - -[markdown] +a¦ *secretAccessKey* + +required +a¦ [markdown] -- The Amazon S3 secret access key. This is redacted for the sake of security. @@ -5013,13 +4235,9 @@ The Amazon S3 secret access key. This is redacted for the sake of security. *Example:* `+++""+++` {blank} a¦ String - -a¦ -*sessionToken* + -_optional_ -a¦ - -[markdown] +a¦ *sessionToken* + +optional +a¦ [markdown] -- The Amazon S3 session token. Indicates that the link has temporary access, and that the `accessKeyId` and `secretAccessKey` are temporary credentials. This is redacted for the sake of security. @@ -5029,19 +4247,16 @@ The Amazon S3 session token. Indicates that the link has temporary access, and t *Example:* `+++""+++` {blank} a¦ String - -a¦ -*serviceEndpoint* + -_required_ -a¦ - -[markdown] +a¦ *serviceEndpoint* + +required +a¦ [markdown] -- Amazon S3 service endpoint. If not set, this property returns `null`. -- [%hardbreaks] +*Nullable:* yes *Example:* `+++"my.endpoint.uri"+++` {blank} a¦ String @@ -5052,28 +4267,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/ResponseS3Specific/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponseS3Specific/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponseS3Specific/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponseS3Specific[] +:leveloffset: -1 +endif::show-ResponseS3Specific[] -// markup not found, no include::{specDir}definitions/Wrong/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponseS3Specific/definition-after.adoc[opts=optional] +include::{specDir}definitions/Wrong/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Wrong[] [#Wrong] +endif::show-Wrong[] +ifndef::show-Wrong[] +:leveloffset: +1 + +[discrete#Wrong] +endif::show-Wrong[] = Errors :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Wrong/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Wrong/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5081,17 +4299,13 @@ endif::collapse-models[] //tag::Wrong[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*error* + -_required_ -a¦ - -[markdown] +a¦ *error* + +required +a¦ [markdown] -- An error message. -- @@ -5106,26 +4320,26 @@ a¦ String -// markup not found, no include::{specDir}definitions/Wrong/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Wrong/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Wrong/definition-after.adoc[opts=optional] - +ifndef::show-Wrong[] +:leveloffset: -1 +endif::show-Wrong[] +include::{specDir}definitions/Wrong/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] - +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -5135,18 +4349,14 @@ a¦ String include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/AnalyticsManage/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/AnalyticsManage/security-scheme-before.adoc[opts=optional] - - -[[security-analyticsManage]] +[[security-AnalyticsManage]] = Analytics Manage :leveloffset: +1 -// markup not found, no include::{specDir}security/AnalyticsManage/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/AnalyticsManage/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -5158,16 +4368,13 @@ Users must have one of the following RBAC roles: -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/AnalyticsManage/security-scheme-end.adoc[opts=optional] +include::{specDir}security/AnalyticsManage/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/AnalyticsManage/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/AnalyticsManage/security-scheme-after.adoc[opts=optional] @@ -5175,8 +4382,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - -// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] +include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/analytics-rest-service/analytics-service.gradle b/docs/modules/analytics-rest-service/analytics-service.gradle index 22535a95..68614b76 100644 --- a/docs/modules/analytics-rest-service/analytics-service.gradle +++ b/docs/modules/analytics-rest-service/analytics-service.gradle @@ -20,4 +20,5 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } \ No newline at end of file diff --git a/docs/modules/analytics-rest-service/attachments/analytics-service.yaml b/docs/modules/analytics-rest-service/attachments/analytics-service.yaml index 8147daec..f51ad610 100644 --- a/docs/modules/analytics-rest-service/attachments/analytics-service.yaml +++ b/docs/modules/analytics-rest-service/attachments/analytics-service.yaml @@ -474,6 +474,7 @@ components: securitySchemes: AnalyticsManageAnalyticsSelect: + x-displayName: Analytics Manage / Analytics Select type: http scheme: basic description: |- diff --git a/docs/modules/analytics-rest-service/pages/index.adoc b/docs/modules/analytics-rest-service/pages/index.adoc index 847360d4..f75688cf 100644 --- a/docs/modules/analytics-rest-service/pages/index.adoc +++ b/docs/modules/analytics-rest-service/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -33,7 +32,7 @@ This API enables you to run Analytics queries and set request-level parameters. [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -68,7 +67,6 @@ The host name or IP address of a node running the Analytics Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -84,31 +82,26 @@ The Analytics Service REST port. Use `18095` for secure access. |=== - -// markup not found, no include::{specDir}overview/document-end.adoc[opts=optional] +include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}overview/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 1 - +:count-apis: 0 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -116,18 +109,14 @@ xref:tag-Default[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Default] = Default :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:get_query[] @@ -136,44 +125,38 @@ xref:post_query[] xref:post_service[] -//tag::get_query[] - -// markup not found, no include::{specDir}paths/get_query/operation-before.adoc[opts=optional] +//tag::get_query[] +include::{specDir}paths/get_query/operation-before.adoc[opts=optional] [#get_query] = Read-Only Query Service (Alternative) :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_query/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_query/operation-begin.adoc[opts=optional] .... GET /query/service .... - -// markup not found, no include::{specDir}paths/get_query/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_query/operation-description-before.adoc[opts=optional] [#get_query-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_query/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_query/operation-description-begin.adoc[opts=optional] [markdown] -- An alternative endpoint for the [Read-Only Query Service](#get_service), provided for tools compatibility. -- - -// markup not found, no include::{specDir}paths/get_query/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_query/operation-description-end.adoc[opts=optional] @@ -181,24 +164,20 @@ An alternative endpoint for the [Read-Only Query Service](#get_service), provide .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_query/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_query/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_query/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_query/operation-parameters-before.adoc[opts=optional] [#get_query-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_query/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/get_query/operation-parameters-begin.adoc[opts=optional] [#get_query-query] .Query Parameters @@ -209,11 +188,8 @@ An alternative endpoint for the [Read-Only Query Service](#get_service), provide ¦ Name ¦ Description ¦ Schema a¦ *body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- Specify the parameters in the query URL in URL-encoded format. -- @@ -226,29 +202,25 @@ a¦ xref:Parameters[] |=== - - - -// markup not found, no include::{specDir}paths/get_query/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/get_query/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Parameters: -// markup not found, no include::{specDir}paths/get_query/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_query/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_query/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/get_query/operation-responses-before.adoc[opts=optional] [#get_query-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_query/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_query/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -275,98 +247,81 @@ Unauthorized. The user name or password may be incorrect. -- a| xref:Responses[] - |=== - -// markup not found, no include::{specDir}paths/get_query/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_query/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Responses: +:show-Responses: +:show-Responses: -// markup not found, no include::{specDir}paths/get_query/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_query/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_query/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_query/operation-security-before.adoc[opts=optional] [#get_query-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_query/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_query/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManageAnalyticsSelect[] +| xref:security-AnalyticsManageAnalyticsSelect[] |=== - -// markup not found, no include::{specDir}paths/get_query/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_query/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/get_query/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_query/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}get_query/http-request.adoc[opts=optional] +include::{snippetDir}get_query/http-request.adoc[opts=optional] +include::{snippetDir}get_query/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}get_query/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_query/operation-end.adoc[opts=optional] +include::{specDir}paths/get_query/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_query/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_query/operation-after.adoc[opts=optional] //end::get_query[] - //tag::get_service[] - -// markup not found, no include::{specDir}paths/get_service/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-before.adoc[opts=optional] [#get_service] = Read-Only Query Service :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_service/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-begin.adoc[opts=optional] .... GET /analytics/service .... - -// markup not found, no include::{specDir}paths/get_service/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-description-before.adoc[opts=optional] [#get_service-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_service/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -376,8 +331,7 @@ This is intended for situations where use of the `POST` method is restricted. -- - -// markup not found, no include::{specDir}paths/get_service/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_service/operation-description-end.adoc[opts=optional] @@ -385,24 +339,20 @@ This is intended for situations where use of the `POST` method is restricted. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_service/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_service/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_service/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_service/operation-parameters-before.adoc[opts=optional] [#get_service-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_service/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/get_service/operation-parameters-begin.adoc[opts=optional] [#get_service-query] .Query Parameters @@ -413,11 +363,8 @@ This is intended for situations where use of the `POST` method is restricted. ¦ Name ¦ Description ¦ Schema a¦ *body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- Specify the parameters in the query URL in URL-encoded format. -- @@ -430,29 +377,25 @@ a¦ xref:Parameters[] |=== - - - -// markup not found, no include::{specDir}paths/get_service/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/get_service/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Parameters: -// markup not found, no include::{specDir}paths/get_service/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_service/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_service/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-responses-before.adoc[opts=optional] [#get_service-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_service/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -479,106 +422,88 @@ Unauthorized. The user name or password may be incorrect. -- a| xref:Responses[] - |=== - -// markup not found, no include::{specDir}paths/get_service/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_service/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Responses: +:show-Responses: +:show-Responses: -// markup not found, no include::{specDir}paths/get_service/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_service/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_service/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-security-before.adoc[opts=optional] [#get_service-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_service/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManageAnalyticsSelect[] +| xref:security-AnalyticsManageAnalyticsSelect[] |=== - -// markup not found, no include::{specDir}paths/get_service/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_service/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional] include::{snippetDir}get_service/http-request.adoc[opts=optional] - include::{snippetDir}get_service/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_service/operation-end.adoc[opts=optional] +include::{specDir}paths/get_service/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_service/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-after.adoc[opts=optional] //end::get_service[] - //tag::post_query[] - -// markup not found, no include::{specDir}paths/post_query/operation-before.adoc[opts=optional] - +include::{specDir}paths/post_query/operation-before.adoc[opts=optional] [#post_query] = Query Service (Alternative) :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_query/operation-begin.adoc[opts=optional] - +include::{specDir}paths/post_query/operation-begin.adoc[opts=optional] .... POST /query/service .... - -// markup not found, no include::{specDir}paths/post_query/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/post_query/operation-description-before.adoc[opts=optional] [#post_query-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_query/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/post_query/operation-description-begin.adoc[opts=optional] [markdown] -- An alternative endpoint for the [Query Service](#post_service), provided for tools compatibility. -- - -// markup not found, no include::{specDir}paths/post_query/operation-description-end.adoc[opts=optional] +include::{specDir}paths/post_query/operation-description-end.adoc[opts=optional] [#post_query-consumes] @@ -590,15 +515,13 @@ An alternative endpoint for the [Query Service](#post_service), provided for too .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/post_query/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/post_query/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_query/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/post_query/operation-parameters-before.adoc[opts=optional] [#post_query-parameters] = Parameters @@ -607,11 +530,6 @@ An alternative endpoint for the [Query Service](#post_service), provided for too include::{specDir}paths/post_query/operation-parameters-begin.adoc[opts=optional] - - - - - [#post_query-body] .Body Parameter {blank} @@ -621,13 +539,10 @@ include::{specDir}paths/post_query/operation-parameters-begin.adoc[opts=optional ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -An object specifying one or more query parameters. + -- [%hardbreaks] @@ -638,26 +553,25 @@ a¦ xref:Parameters[] |=== -// markup not found, no include::{specDir}paths/post_query/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/post_query/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Parameters: -// markup not found, no include::{specDir}paths/post_query/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/post_query/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_query/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/post_query/operation-responses-before.adoc[opts=optional] [#post_query-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_query/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/post_query/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -684,79 +598,63 @@ Unauthorized. The user name or password may be incorrect. -- a| xref:Responses[] - |=== - -// markup not found, no include::{specDir}paths/post_query/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/post_query/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Responses: +:show-Responses: +:show-Responses: -// markup not found, no include::{specDir}paths/post_query/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/post_query/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_query/operation-security-before.adoc[opts=optional] +include::{specDir}paths/post_query/operation-security-before.adoc[opts=optional] +include::{specDir}paths/post_query/operation-security-after.adoc[opts=optional] +include::{snippetDir}post_query/http-request.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_query/operation-security-after.adoc[opts=optional] +include::{snippetDir}post_query/http-response.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}post_query/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}post_query/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/post_query/operation-end.adoc[opts=optional] +include::{specDir}paths/post_query/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_query/operation-after.adoc[opts=optional] - +include::{specDir}paths/post_query/operation-after.adoc[opts=optional] //end::post_query[] - //tag::post_service[] - -// markup not found, no include::{specDir}paths/post_service/operation-before.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-before.adoc[opts=optional] [#post_service] = Query Service :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_service/operation-begin.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-begin.adoc[opts=optional] .... POST /analytics/service .... - -// markup not found, no include::{specDir}paths/post_service/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-description-before.adoc[opts=optional] [#post_service-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_service/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -764,8 +662,7 @@ Enables you to execute a SQL\+\+ for Analytics statement. This method allows you -- - -// markup not found, no include::{specDir}paths/post_service/operation-description-end.adoc[opts=optional] +include::{specDir}paths/post_service/operation-description-end.adoc[opts=optional] [#post_service-consumes] @@ -777,15 +674,13 @@ Enables you to execute a SQL\+\+ for Analytics statement. This method allows you .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/post_service/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/post_service/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_service/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/post_service/operation-parameters-before.adoc[opts=optional] [#post_service-parameters] = Parameters @@ -794,11 +689,6 @@ Enables you to execute a SQL\+\+ for Analytics statement. This method allows you include::{specDir}paths/post_service/operation-parameters-begin.adoc[opts=optional] - - - - - [#post_service-body] .Body Parameter {blank} @@ -808,13 +698,10 @@ include::{specDir}paths/post_service/operation-parameters-begin.adoc[opts=option ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -An object specifying one or more query parameters. + -- [%hardbreaks] @@ -825,26 +712,25 @@ a¦ xref:Parameters[] |=== -// markup not found, no include::{specDir}paths/post_service/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/post_service/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Parameters: -// markup not found, no include::{specDir}paths/post_service/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_service/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/post_service/operation-responses-before.adoc[opts=optional] [#post_service-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_service/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -871,102 +757,88 @@ Unauthorized. The user name or password may be incorrect. -- a| xref:Responses[] - |=== - -// markup not found, no include::{specDir}paths/post_service/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/post_service/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Responses: +:show-Responses: +:show-Responses: -// markup not found, no include::{specDir}paths/post_service/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_service/operation-security-before.adoc[opts=optional] +include::{specDir}paths/post_service/operation-security-before.adoc[opts=optional] [#post_service-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_service/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-analyticsManageAnalyticsSelect[] +| xref:security-AnalyticsManageAnalyticsSelect[] |=== - -// markup not found, no include::{specDir}paths/post_service/operation-security-end.adoc[opts=optional] +include::{specDir}paths/post_service/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_service/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/post_service/operation-security-after.adoc[opts=optional] include::{snippetDir}post_service/http-request.adoc[opts=optional] - include::{snippetDir}post_service/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/post_service/operation-end.adoc[opts=optional] +include::{specDir}paths/post_service/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_service/operation-after.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-after.adoc[opts=optional] //end::post_service[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] +include::{specDir}paths/document-after.adoc[opts=optional] - -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] - +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 11 - +:count-models: 10 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:Parameters[] xref:ParametersCommon[] @@ -982,35 +854,32 @@ xref:ResponsesLocalYardsticks[] endif::[] +include::{specDir}definitions/Parameters/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/Parameters/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Parameters[] [#Parameters] +endif::show-Parameters[] +ifndef::show-Parameters[] +:leveloffset: +1 + +[discrete#Parameters] +endif::show-Parameters[] = Query Parameters :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Parameters/definition-begin.adoc[opts=optional] - +include::{specDir}definitions/Parameters/definition-begin.adoc[opts=optional] .icon:bars[fw] Composite Schema {blank} //tag::Parameters[] - - [cols="25,55,20",separator=¦] |=== ¦ All{nbsp}of{nbsp}... ¦ ¦ Schema a¦ -a¦ - -[markdown] +a¦ [markdown] -- include::index.adoc[tag=desc-ParametersCommon, opts=optional] -- @@ -1019,10 +888,8 @@ include::index.adoc[tag=desc-ParametersCommon, opts=optional] {blank} a¦ xref:ParametersCommon[] -a¦ _and_ -a¦ - -[markdown] +a¦ and +a¦ [markdown] -- include::index.adoc[tag=desc-ParametersLocal, opts=optional] -- @@ -1030,34 +897,41 @@ include::index.adoc[tag=desc-ParametersLocal, opts=optional] [%hardbreaks] {blank} a¦ xref:ParametersLocal[] - |=== //end::Parameters[] - -// markup not found, no include::{specDir}definitions/Parameters/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Parameters/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Parameters/definition-after.adoc[opts=optional] - - - +ifndef::show-Parameters[] +:leveloffset: -1 +endif::show-Parameters[] -// markup not found, no include::{specDir}definitions/ParametersCommon/definition-before.adoc[opts=optional] +include::{specDir}definitions/Parameters/definition-after.adoc[opts=optional] +include::{specDir}definitions/ParametersCommon/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ParametersCommon[] [#ParametersCommon] +endif::show-ParametersCommon[] +ifndef::show-ParametersCommon[] +:leveloffset: +1 + +[discrete#ParametersCommon] +endif::show-ParametersCommon[] = Common Parameters +ifdef::model-descriptions[] +//tag::desc-ParametersCommon[] +Parameters common with the Query Service. +//end::desc-ParametersCommon[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ParametersCommon/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ParametersCommon/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1065,22 +939,13 @@ endif::collapse-models[] //tag::ParametersCommon[] -ifdef::model-descriptions[] -//tag::desc-ParametersCommon[] -Parameters common with the Query Service. -//end::desc-ParametersCommon[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*statement* + -_required_ -a¦ - -[markdown] +a¦ *statement* + +required +a¦ [markdown] -- Specifies at least one valid SQL\+\+ for Analytics statement to run. -- @@ -1088,13 +953,9 @@ Specifies at least one valid SQL\+\+ for Analytics statement to run. [%hardbreaks] {blank} a¦ String - -a¦ -*client_context_id* + -_optional_ -a¦ - -[markdown] +a¦ *client_context_id* + +optional +a¦ [markdown] -- An identifier passed by the client that is returned verbatim in the query response. Useful for matching a particular query to a specific caller. @@ -1103,13 +964,9 @@ An identifier passed by the client that is returned verbatim in the query respon [%hardbreaks] {blank} a¦ String - -a¦ -*format* + -_optional_ -a¦ - -[markdown] +a¦ *format* + +optional +a¦ [markdown] -- Desired format for the query results. @@ -1122,13 +979,9 @@ Note that the only possible format is `JSON`. *Default:* `+++"JSON"+++` {blank} a¦ String - -a¦ -*pretty* + -_optional_ -a¦ - -[markdown] +a¦ *pretty* + +optional +a¦ [markdown] -- If `true`, the result is indented. -- @@ -1137,13 +990,9 @@ If `true`, the result is indented. *Default:* `false` {blank} a¦ Boolean - -a¦ -*query_context* + -_optional_ -a¦ - -[markdown] +a¦ *query_context* + +optional +a¦ [markdown] -- A scope for the statement. The value of this parameter must start with `default:`, followed by an Analytics scope name. The `default:` prefix is a dummy and is ignored when resolving an Analytics collection name or synonym name. @@ -1153,13 +1002,9 @@ A scope for the statement. The value of this parameter must start with `default: *Default:* `+++"default:Default"+++` {blank} a¦ String - -a¦ -*readonly* + -_optional_ -a¦ - -[markdown] +a¦ *readonly* + +optional +a¦ [markdown] -- If `true`, then DDL statements are not allowed. -- @@ -1168,13 +1013,9 @@ If `true`, then DDL statements are not allowed. *Default:* `false` {blank} a¦ Boolean - -a¦ -*scan_consistency* + -_optional_ -a¦ - -[markdown] +a¦ *scan_consistency* + +optional +a¦ [markdown] -- The consistency guarantee constraint for index scanning. If `not_bounded`, the query is executed immediately. If `request_plus`, the required datasets are updated with data available from the Data service at the time of the request before the query is executed. @@ -1185,13 +1026,9 @@ The consistency guarantee constraint for index scanning. If `not_bounded`, the q *Default:* `+++"not_bounded"+++` {blank} a¦ String - -a¦ -*scan_wait* + -_optional_ -a¦ - -[markdown] +a¦ *scan_wait* + +optional +a¦ [markdown] -- The maximum time to wait for datasets to be updated before the query is executed. The format includes an amount and a unit: `ns`, `us`, `ms`, `s`, `m`, or `h`. The default is `""` (no timeout). @@ -1201,13 +1038,9 @@ The maximum time to wait for datasets to be updated before the query is executed *Default:* `+++""+++` {blank} a¦ String - -a¦ -*timeout* + -_optional_ -a¦ - -[markdown] +a¦ *timeout* + +optional +a¦ [markdown] -- Maximum time to spend on the request before timing out. The format includes an amount and a unit: `ns`, `us`, `ms`, `s`, `m`, or `h`. The default is `""` (no timeout). @@ -1217,34 +1050,26 @@ Maximum time to spend on the request before timing out. The format includes an a *Default:* `+++""+++` {blank} a¦ String - -a¦ -*args* + -_optional_ -a¦ - -[markdown] +a¦ *args* + +optional +a¦ [markdown] -- An array of positional parameter values. -- [%hardbreaks] {blank} -a¦ Any Type - array - -a¦ -*<$identifier>* + -_additional + -property_ -a¦ - -[markdown] +a¦ Any Type array +a¦ *<$identifier>* + +additional + +property +a¦ [markdown] -- A named parameter value. -- [%hardbreaks] +*Nullable:* yes {blank} a¦ Any Type @@ -1254,28 +1079,37 @@ a¦ Any Type -// markup not found, no include::{specDir}definitions/ParametersCommon/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ParametersCommon/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ParametersCommon/definition-after.adoc[opts=optional] +ifndef::show-ParametersCommon[] +:leveloffset: -1 +endif::show-ParametersCommon[] +include::{specDir}definitions/ParametersCommon/definition-after.adoc[opts=optional] +include::{specDir}definitions/ParametersLocal/definition-before.adoc[opts=optional] - -// markup not found, no include::{specDir}definitions/ParametersLocal/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ParametersLocal[] [#ParametersLocal] +endif::show-ParametersLocal[] +ifndef::show-ParametersLocal[] +:leveloffset: +1 + +[discrete#ParametersLocal] +endif::show-ParametersLocal[] = Analytics Parameters +ifdef::model-descriptions[] +//tag::desc-ParametersLocal[] +Parameters specific to the Analytics Service. +//end::desc-ParametersLocal[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ParametersLocal/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ParametersLocal/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1283,22 +1117,13 @@ endif::collapse-models[] //tag::ParametersLocal[] -ifdef::model-descriptions[] -//tag::desc-ParametersLocal[] -Parameters specific to the Analytics Service. -//end::desc-ParametersLocal[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*plan-format* + -_optional_ -a¦ - -[markdown] +a¦ *plan-format* + +optional +a¦ [markdown] -- The plan format. -- @@ -1308,13 +1133,9 @@ The plan format. *Default:* `+++"JSON"+++` {blank} a¦ String - -a¦ -*logical-plan* + -_optional_ -a¦ - -[markdown] +a¦ *logical-plan* + +optional +a¦ [markdown] -- If `true`, the logical plan is included in the query response. -- @@ -1323,13 +1144,9 @@ If `true`, the logical plan is included in the query response. *Default:* `false` {blank} a¦ Boolean - -a¦ -*optimized-logical-plan* + -_optional_ -a¦ - -[markdown] +a¦ *optimized-logical-plan* + +optional +a¦ [markdown] -- If `true`, the optimized logical plan is included in the query response. -- @@ -1338,13 +1155,9 @@ If `true`, the optimized logical plan is included in the query response. *Default:* `true` {blank} a¦ Boolean - -a¦ -*expression-tree* + -_optional_ -a¦ - -[markdown] +a¦ *expression-tree* + +optional +a¦ [markdown] -- If `true`, the expression tree is included in the query response. -- @@ -1353,13 +1166,9 @@ If `true`, the expression tree is included in the query response. *Default:* `false` {blank} a¦ Boolean - -a¦ -*rewritten-expression-tree* + -_optional_ -a¦ - -[markdown] +a¦ *rewritten-expression-tree* + +optional +a¦ [markdown] -- If `true`, the rewritten expression tree is included in the query response. -- @@ -1368,13 +1177,9 @@ If `true`, the rewritten expression tree is included in the query response. *Default:* `false` {blank} a¦ Boolean - -a¦ -*job* + -_optional_ -a¦ - -[markdown] +a¦ *job* + +optional +a¦ [markdown] -- If `true`, the job details are included in the query response. -- @@ -1383,13 +1188,9 @@ If `true`, the job details are included in the query response. *Default:* `false` {blank} a¦ Boolean - -a¦ -*max-warnings* + -_optional_ -a¦ - -[markdown] +a¦ *max-warnings* + +optional +a¦ [markdown] -- An integer specifying the maximum number of warning messages to be included in the query response. -- @@ -1405,44 +1206,42 @@ a¦ Integer (int32) -// markup not found, no include::{specDir}definitions/ParametersLocal/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ParametersLocal/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ParametersLocal/definition-after.adoc[opts=optional] - - - +ifndef::show-ParametersLocal[] +:leveloffset: -1 +endif::show-ParametersLocal[] -// markup not found, no include::{specDir}definitions/Responses/definition-before.adoc[opts=optional] +include::{specDir}definitions/ParametersLocal/definition-after.adoc[opts=optional] +include::{specDir}definitions/Responses/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Responses[] [#Responses] +endif::show-Responses[] +ifndef::show-Responses[] +:leveloffset: +1 + +[discrete#Responses] +endif::show-Responses[] = Query Responses :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Responses/definition-begin.adoc[opts=optional] - +include::{specDir}definitions/Responses/definition-begin.adoc[opts=optional] .icon:bars[fw] Composite Schema {blank} //tag::Responses[] - - [cols="25,55,20",separator=¦] |=== ¦ All{nbsp}of{nbsp}... ¦ ¦ Schema a¦ -a¦ - -[markdown] +a¦ [markdown] -- include::index.adoc[tag=desc-ResponsesCommon, opts=optional] -- @@ -1451,10 +1250,8 @@ include::index.adoc[tag=desc-ResponsesCommon, opts=optional] {blank} a¦ xref:ResponsesCommon[] -a¦ _and_ -a¦ - -[markdown] +a¦ and +a¦ [markdown] -- include::index.adoc[tag=desc-ResponsesLocal, opts=optional] -- @@ -1462,34 +1259,41 @@ include::index.adoc[tag=desc-ResponsesLocal, opts=optional] [%hardbreaks] {blank} a¦ xref:ResponsesLocal[] - |=== //end::Responses[] - -// markup not found, no include::{specDir}definitions/Responses/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Responses/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Responses/definition-after.adoc[opts=optional] - - - +ifndef::show-Responses[] +:leveloffset: -1 +endif::show-Responses[] -// markup not found, no include::{specDir}definitions/ResponsesCommon/definition-before.adoc[opts=optional] +include::{specDir}definitions/Responses/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponsesCommon/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponsesCommon[] [#ResponsesCommon] +endif::show-ResponsesCommon[] +ifndef::show-ResponsesCommon[] +:leveloffset: +1 + +[discrete#ResponsesCommon] +endif::show-ResponsesCommon[] = Common Responses +ifdef::model-descriptions[] +//tag::desc-ResponsesCommon[] +Responses common with the Query Service. +//end::desc-ResponsesCommon[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponsesCommon/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ResponsesCommon/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1497,22 +1301,13 @@ endif::collapse-models[] //tag::ResponsesCommon[] -ifdef::model-descriptions[] -//tag::desc-ResponsesCommon[] -Responses common with the Query Service. -//end::desc-ResponsesCommon[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*requestID* + -_optional_ -a¦ - -[markdown] +a¦ *requestID* + +optional +a¦ [markdown] -- A unique identifier for the response. -- @@ -1520,13 +1315,9 @@ A unique identifier for the response. [%hardbreaks] {blank} a¦ UUID (UUID) - -a¦ -*clientContextID* + -_optional_ -a¦ - -[markdown] +a¦ *clientContextID* + +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [1]: query-params.html @@ -1541,13 +1332,9 @@ refer to `client_context_id` in [Query Parameters][1]. [%hardbreaks] {blank} a¦ String - -a¦ -*signature* + -_optional_ -a¦ - -[markdown] +a¦ *signature* + +optional +a¦ [markdown] -- The schema of the results. Present only when the query completes successfully. @@ -1556,13 +1343,9 @@ The schema of the results. Present only when the query completes successfully. [%hardbreaks] {blank} a¦ Object - -a¦ -*results* + -_optional_ -a¦ - -[markdown] +a¦ *results* + +optional +a¦ [markdown] -- An array of all the objects returned by the query. An object can be any JSON value. @@ -1570,15 +1353,10 @@ An array of all the objects returned by the query. An object can be any JSON val [%hardbreaks] {blank} -a¦ Any Type - array - -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ Any Type array +a¦ *status* + +optional +a¦ [markdown] -- The status of the request. -- @@ -1587,13 +1365,9 @@ The status of the request. *Values:* `"success"`, `"running"`, `"failed"`, `"timeout"`, `"fatal"` {blank} a¦ String - -a¦ -*errors* + -_optional_ -a¦ - -[markdown] +a¦ *errors* + +optional +a¦ [markdown] -- An array of error objects. Present only if 1 or more errors are returned during processing of the request. Each error is represented by an object in this list. @@ -1601,15 +1375,10 @@ An array of error objects. Present only if 1 or more errors are returned during [%hardbreaks] {blank} -a¦ xref:ResponsesCommonErrors[] - array - -a¦ -*warnings* + -_optional_ -a¦ - -[markdown] +a¦ xref:ResponsesCommonErrors[] array +a¦ *warnings* + +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [1]: query-params.html @@ -1628,15 +1397,10 @@ By default, no warnings are returned, even if warnings have occurred during proc [%hardbreaks] {blank} -a¦ xref:ResponsesCommonWarnings[] - array - -a¦ -*metrics* + -_optional_ -a¦ - -[markdown] +a¦ xref:ResponsesCommonWarnings[] array +a¦ *metrics* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-ResponsesCommonYardsticks, opts=optional] -- @@ -1651,28 +1415,31 @@ a¦ xref:ResponsesCommonYardsticks[] -// markup not found, no include::{specDir}definitions/ResponsesCommon/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponsesCommon/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponsesCommon/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponsesCommon[] +:leveloffset: -1 +endif::show-ResponsesCommon[] -// markup not found, no include::{specDir}definitions/ResponsesCommonErrors/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponsesCommon/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponsesCommonErrors/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponsesCommonErrors[] [#ResponsesCommonErrors] +endif::show-ResponsesCommonErrors[] +ifndef::show-ResponsesCommonErrors[] +:leveloffset: +1 + +[discrete#ResponsesCommonErrors] +endif::show-ResponsesCommonErrors[] = Errors :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponsesCommonErrors/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ResponsesCommonErrors/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1680,17 +1447,13 @@ endif::collapse-models[] //tag::ResponsesCommonErrors[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*code* + -_optional_ -a¦ - -[markdown] +a¦ *code* + +optional +a¦ [markdown] -- A number that identifies the error. -- @@ -1698,13 +1461,9 @@ A number that identifies the error. [%hardbreaks] {blank} a¦ Integer - -a¦ -*msg* + -_optional_ -a¦ - -[markdown] +a¦ *msg* + +optional +a¦ [markdown] -- A message describing the error in detail. Refer to [Error Codes](/server/8.0/analytics/error-codes.html). @@ -1720,28 +1479,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/ResponsesCommonErrors/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponsesCommonErrors/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponsesCommonErrors/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponsesCommonErrors[] +:leveloffset: -1 +endif::show-ResponsesCommonErrors[] -// markup not found, no include::{specDir}definitions/ResponsesCommonWarnings/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponsesCommonErrors/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponsesCommonWarnings/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponsesCommonWarnings[] [#ResponsesCommonWarnings] +endif::show-ResponsesCommonWarnings[] +ifndef::show-ResponsesCommonWarnings[] +:leveloffset: +1 + +[discrete#ResponsesCommonWarnings] +endif::show-ResponsesCommonWarnings[] = Warnings :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponsesCommonWarnings/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ResponsesCommonWarnings/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1749,17 +1511,13 @@ endif::collapse-models[] //tag::ResponsesCommonWarnings[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*code* + -_optional_ -a¦ - -[markdown] +a¦ *code* + +optional +a¦ [markdown] -- A number that identifies the warning. -- @@ -1767,13 +1525,9 @@ A number that identifies the warning. [%hardbreaks] {blank} a¦ Integer - -a¦ -*msg* + -_optional_ -a¦ - -[markdown] +a¦ *msg* + +optional +a¦ [markdown] -- A message describing the warning in detail. -- @@ -1788,28 +1542,37 @@ a¦ String -// markup not found, no include::{specDir}definitions/ResponsesCommonWarnings/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponsesCommonWarnings/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponsesCommonWarnings/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponsesCommonWarnings[] +:leveloffset: -1 +endif::show-ResponsesCommonWarnings[] -// markup not found, no include::{specDir}definitions/ResponsesCommonYardsticks/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponsesCommonWarnings/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponsesCommonYardsticks/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponsesCommonYardsticks[] [#ResponsesCommonYardsticks] +endif::show-ResponsesCommonYardsticks[] +ifndef::show-ResponsesCommonYardsticks[] +:leveloffset: +1 + +[discrete#ResponsesCommonYardsticks] +endif::show-ResponsesCommonYardsticks[] = Common Metrics +ifdef::model-descriptions[] +//tag::desc-ResponsesCommonYardsticks[] +An object containing metrics about the request. +//end::desc-ResponsesCommonYardsticks[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponsesCommonYardsticks/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ResponsesCommonYardsticks/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1817,22 +1580,13 @@ endif::collapse-models[] //tag::ResponsesCommonYardsticks[] -ifdef::model-descriptions[] -//tag::desc-ResponsesCommonYardsticks[] -An object containing metrics about the request. -//end::desc-ResponsesCommonYardsticks[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*elapsedTime* + -_optional_ -a¦ - -[markdown] +a¦ *elapsedTime* + +optional +a¦ [markdown] -- The total time taken for the request, that is the time from when the request was received until the results were returned. @@ -1841,13 +1595,9 @@ The total time taken for the request, that is the time from when the request was [%hardbreaks] {blank} a¦ String - -a¦ -*executionTime* + -_optional_ -a¦ - -[markdown] +a¦ *executionTime* + +optional +a¦ [markdown] -- The time taken for the execution of the request, that is the time from when query execution started until the results were returned. @@ -1856,13 +1606,9 @@ The time taken for the execution of the request, that is the time from when quer [%hardbreaks] {blank} a¦ String - -a¦ -*resultCount* + -_optional_ -a¦ - -[markdown] +a¦ *resultCount* + +optional +a¦ [markdown] -- The total number of objects in the results. -- @@ -1870,13 +1616,9 @@ The total number of objects in the results. [%hardbreaks] {blank} a¦ Integer (unsigned) - -a¦ -*resultSize* + -_optional_ -a¦ - -[markdown] +a¦ *resultSize* + +optional +a¦ [markdown] -- The total number of bytes in the results. -- @@ -1884,13 +1626,9 @@ The total number of bytes in the results. [%hardbreaks] {blank} a¦ Integer (unsigned) - -a¦ -*errorCount* + -_optional_ -a¦ - -[markdown] +a¦ *errorCount* + +optional +a¦ [markdown] -- The number of errors that occurred during the request. -- @@ -1898,13 +1636,9 @@ The number of errors that occurred during the request. [%hardbreaks] {blank} a¦ Integer (unsigned) - -a¦ -*warningCount* + -_optional_ -a¦ - -[markdown] +a¦ *warningCount* + +optional +a¦ [markdown] -- The number of warnings that occurred during the request. -- @@ -1919,28 +1653,37 @@ a¦ Integer (unsigned) -// markup not found, no include::{specDir}definitions/ResponsesCommonYardsticks/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponsesCommonYardsticks/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponsesCommonYardsticks/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponsesCommonYardsticks[] +:leveloffset: -1 +endif::show-ResponsesCommonYardsticks[] -// markup not found, no include::{specDir}definitions/ResponsesLocal/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponsesCommonYardsticks/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponsesLocal/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponsesLocal[] [#ResponsesLocal] +endif::show-ResponsesLocal[] +ifndef::show-ResponsesLocal[] +:leveloffset: +1 + +[discrete#ResponsesLocal] +endif::show-ResponsesLocal[] = Analytics Responses +ifdef::model-descriptions[] +//tag::desc-ResponsesLocal[] +Responses specific to the Analytics Service. +//end::desc-ResponsesLocal[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponsesLocal/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ResponsesLocal/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1948,22 +1691,13 @@ endif::collapse-models[] //tag::ResponsesLocal[] -ifdef::model-descriptions[] -//tag::desc-ResponsesLocal[] -Responses specific to the Analytics Service. -//end::desc-ResponsesLocal[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*plans* + -_optional_ -a¦ - -[markdown] +a¦ *plans* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-ResponsesLocalPlans, opts=optional] -- @@ -1971,13 +1705,9 @@ include::index.adoc[tag=desc-ResponsesLocalPlans, opts=optional] [%hardbreaks] {blank} a¦ xref:ResponsesLocalPlans[] - -a¦ -*metrics* + -_optional_ -a¦ - -[markdown] +a¦ *metrics* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-ResponsesLocalYardsticks, opts=optional] -- @@ -1992,28 +1722,37 @@ a¦ xref:ResponsesLocalYardsticks[] -// markup not found, no include::{specDir}definitions/ResponsesLocal/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponsesLocal/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponsesLocal/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponsesLocal[] +:leveloffset: -1 +endif::show-ResponsesLocal[] -// markup not found, no include::{specDir}definitions/ResponsesLocalPlans/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponsesLocal/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponsesLocalPlans/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponsesLocalPlans[] [#ResponsesLocalPlans] +endif::show-ResponsesLocalPlans[] +ifndef::show-ResponsesLocalPlans[] +:leveloffset: +1 + +[discrete#ResponsesLocalPlans] +endif::show-ResponsesLocalPlans[] = Plans +ifdef::model-descriptions[] +//tag::desc-ResponsesLocalPlans[] +An object containing the query plans, if requested. +//end::desc-ResponsesLocalPlans[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponsesLocalPlans/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ResponsesLocalPlans/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2021,22 +1760,13 @@ endif::collapse-models[] //tag::ResponsesLocalPlans[] -ifdef::model-descriptions[] -//tag::desc-ResponsesLocalPlans[] -An object containing the query plans, if requested. -//end::desc-ResponsesLocalPlans[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*logicalPlan* + -_optional_ -a¦ - -[markdown] +a¦ *logicalPlan* + +optional +a¦ [markdown] -- The logical plan. -- @@ -2044,13 +1774,9 @@ The logical plan. [%hardbreaks] {blank} a¦ Object - -a¦ -*optimizedLogicalPlan* + -_optional_ -a¦ - -[markdown] +a¦ *optimizedLogicalPlan* + +optional +a¦ [markdown] -- The optimized logical plan. -- @@ -2058,13 +1784,9 @@ The optimized logical plan. [%hardbreaks] {blank} a¦ Object - -a¦ -*rewrittenExpressionTree* + -_optional_ -a¦ - -[markdown] +a¦ *rewrittenExpressionTree* + +optional +a¦ [markdown] -- The rewritten expression tree. -- @@ -2072,13 +1794,9 @@ The rewritten expression tree. [%hardbreaks] {blank} a¦ String - -a¦ -*expressionTree* + -_optional_ -a¦ - -[markdown] +a¦ *expressionTree* + +optional +a¦ [markdown] -- The expression tree. -- @@ -2086,13 +1804,9 @@ The expression tree. [%hardbreaks] {blank} a¦ String - -a¦ -*job* + -_optional_ -a¦ - -[markdown] +a¦ *job* + +optional +a¦ [markdown] -- The job details. -- @@ -2109,26 +1823,35 @@ a¦ Object include::{specDir}definitions/ResponsesLocalPlans/definition-end.adoc[opts=optional] - :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponsesLocalPlans/definition-after.adoc[opts=optional] - - - +ifndef::show-ResponsesLocalPlans[] +:leveloffset: -1 +endif::show-ResponsesLocalPlans[] -// markup not found, no include::{specDir}definitions/ResponsesLocalYardsticks/definition-before.adoc[opts=optional] +include::{specDir}definitions/ResponsesLocalPlans/definition-after.adoc[opts=optional] +include::{specDir}definitions/ResponsesLocalYardsticks/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ResponsesLocalYardsticks[] [#ResponsesLocalYardsticks] +endif::show-ResponsesLocalYardsticks[] +ifndef::show-ResponsesLocalYardsticks[] +:leveloffset: +1 + +[discrete#ResponsesLocalYardsticks] +endif::show-ResponsesLocalYardsticks[] = Analytics Metrics +ifdef::model-descriptions[] +//tag::desc-ResponsesLocalYardsticks[] +An object containing metrics about the request. +//end::desc-ResponsesLocalYardsticks[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ResponsesLocalYardsticks/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ResponsesLocalYardsticks/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2136,22 +1859,13 @@ endif::collapse-models[] //tag::ResponsesLocalYardsticks[] -ifdef::model-descriptions[] -//tag::desc-ResponsesLocalYardsticks[] -An object containing metrics about the request. -//end::desc-ResponsesLocalYardsticks[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*processedObjects* + -_optional_ -a¦ - -[markdown] +a¦ *processedObjects* + +optional +a¦ [markdown] -- Number of processed tuples during query execution. -- @@ -2166,26 +1880,26 @@ a¦ Long (int64) -// markup not found, no include::{specDir}definitions/ResponsesLocalYardsticks/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ResponsesLocalYardsticks/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ResponsesLocalYardsticks/definition-after.adoc[opts=optional] - +ifndef::show-ResponsesLocalYardsticks[] +:leveloffset: -1 +endif::show-ResponsesLocalYardsticks[] +include::{specDir}definitions/ResponsesLocalYardsticks/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] - +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -2195,18 +1909,14 @@ a¦ Long (int64) include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-before.adoc[opts=optional] - - -[[security-analyticsManageAnalyticsSelect]] -= Analytics Manage Analytics Select +[[security-AnalyticsManageAnalyticsSelect]] += Analytics Manage / Analytics Select :leveloffset: +1 -// markup not found, no include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -2221,16 +1931,13 @@ Users must have one of the following RBAC roles: -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-end.adoc[opts=optional] +include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/AnalyticsManageAnalyticsSelect/security-scheme-after.adoc[opts=optional] @@ -2238,8 +1945,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - -// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] +include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/analytics-rest-settings/analytics-settings.gradle b/docs/modules/analytics-rest-settings/analytics-settings.gradle index 6ddb10dc..04894cdc 100644 --- a/docs/modules/analytics-rest-settings/analytics-settings.gradle +++ b/docs/modules/analytics-rest-settings/analytics-settings.gradle @@ -20,4 +20,5 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } \ No newline at end of file diff --git a/docs/modules/analytics-rest-settings/attachments/analytics-settings.yaml b/docs/modules/analytics-rest-settings/attachments/analytics-settings.yaml index cf0a9238..4431df69 100644 --- a/docs/modules/analytics-rest-settings/attachments/analytics-settings.yaml +++ b/docs/modules/analytics-rest-settings/attachments/analytics-settings.yaml @@ -112,6 +112,7 @@ components: securitySchemes: ClusterReadPoolsRead: + x-displayName: Cluster Read / Pools Read type: http scheme: basic description: |- diff --git a/docs/modules/analytics-rest-settings/pages/index.adoc b/docs/modules/analytics-rest-settings/pages/index.adoc index db405bc8..d332f4bd 100644 --- a/docs/modules/analytics-rest-settings/pages/index.adoc +++ b/docs/modules/analytics-rest-settings/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -33,7 +32,7 @@ This API enables you to view or set cluster-level Analytics settings. [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -68,7 +67,6 @@ The host name or IP address of a node running the Analytics Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -84,31 +82,26 @@ The Cluster administration REST port. Use `18091` for secure access. Note that |=== - -// markup not found, no include::{specDir}overview/document-end.adoc[opts=optional] +include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] - +include::{specDir}overview/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] - +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 1 - +:count-apis: 0 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -116,54 +109,45 @@ xref:tag-Default[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Default] = Default :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:get_settings[] xref:post_settings[] -//tag::get_settings[] - -// markup not found, no include::{specDir}paths/get_settings/operation-before.adoc[opts=optional] +//tag::get_settings[] +include::{specDir}paths/get_settings/operation-before.adoc[opts=optional] [#get_settings] = View Analytics Settings :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-begin.adoc[opts=optional] .... GET /settings/analytics .... - -// markup not found, no include::{specDir}paths/get_settings/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-description-before.adoc[opts=optional] [#get_settings-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -171,7 +155,6 @@ Retrieves cluster-level Analytics settings. Note that only one setting is availa -- - include::{specDir}paths/get_settings/operation-description-end.adoc[opts=optional] @@ -180,33 +163,29 @@ include::{specDir}paths/get_settings/operation-description-end.adoc[opts=optiona .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_settings/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_settings/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_settings/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_settings/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-responses-before.adoc[opts=optional] [#get_settings-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -226,98 +205,79 @@ Unauthorized. The user name or password may be incorrect. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/get_settings/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Settings: -// markup not found, no include::{specDir}paths/get_settings/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_settings/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-security-before.adoc[opts=optional] [#get_settings-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-clusterReadPoolsRead[] +| xref:security-ClusterReadPoolsRead[] |=== - -// markup not found, no include::{specDir}paths/get_settings/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional] include::{snippetDir}get_settings/http-request.adoc[opts=optional] - include::{snippetDir}get_settings/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_settings/operation-end.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_settings/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-after.adoc[opts=optional] //end::get_settings[] - //tag::post_settings[] - -// markup not found, no include::{specDir}paths/post_settings/operation-before.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-before.adoc[opts=optional] [#post_settings] = Modify Analytics Settings :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-begin.adoc[opts=optional] .... POST /settings/analytics .... - -// markup not found, no include::{specDir}paths/post_settings/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-description-before.adoc[opts=optional] [#post_settings-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -325,7 +285,6 @@ Sets cluster-level Analytics settings. Note that only one setting is available: -- - include::{specDir}paths/post_settings/operation-description-end.adoc[opts=optional] @@ -337,26 +296,20 @@ include::{specDir}paths/post_settings/operation-description-end.adoc[opts=option .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/post_settings/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/post_settings/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-parameters-before.adoc[opts=optional] [#post_settings-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-begin.adoc[opts=optional] - - - - +include::{specDir}paths/post_settings/operation-parameters-begin.adoc[opts=optional] [#post_settings-form] .Form Parameters @@ -367,11 +320,8 @@ include::{specDir}paths/post_settings/operation-description-end.adoc[opts=option ¦ Name ¦ Description ¦ Schema a¦ *numReplicas* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- Specifies the number of replicas for Analytics. -- @@ -379,6 +329,7 @@ Specifies the number of replicas for Analytics. [%hardbreaks] *Minimum:* `0` *Maximum:* `3` +*Example:* `56` {blank} a¦ Integer @@ -386,27 +337,24 @@ a¦ Integer |=== - -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_settings/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-responses-before.adoc[opts=optional] [#post_settings-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -433,120 +381,106 @@ Unauthorized. The user name or password may be incorrect. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/post_settings/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Settings: -// markup not found, no include::{specDir}paths/post_settings/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_settings/operation-security-before.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-security-before.adoc[opts=optional] [#post_settings-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-clusterReadPoolsRead[] +| xref:security-ClusterReadPoolsRead[] |=== - -// markup not found, no include::{specDir}paths/post_settings/operation-security-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optional] include::{snippetDir}post_settings/http-request.adoc[opts=optional] - include::{snippetDir}post_settings/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/post_settings/operation-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_settings/operation-after.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-after.adoc[opts=optional] //end::post_settings[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] - +include::{specDir}paths/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] - +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 1 - +:count-models: 0 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:Settings[] endif::[] +include::{specDir}definitions/Settings/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/Settings/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Settings[] [#Settings] +endif::show-Settings[] +ifndef::show-Settings[] +:leveloffset: +1 + +[discrete#Settings] +endif::show-Settings[] = Settings :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Settings/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Settings/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -554,17 +488,13 @@ endif::collapse-models[] //tag::Settings[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*numReplicas* + -_optional_ -a¦ - -[markdown] +a¦ *numReplicas* + +optional +a¦ [markdown] -- Specifies the number of replicas for Analytics. -- @@ -582,26 +512,26 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/Settings/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Settings/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Settings/definition-after.adoc[opts=optional] - +ifndef::show-Settings[] +:leveloffset: -1 +endif::show-Settings[] +include::{specDir}definitions/Settings/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] - +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -611,18 +541,14 @@ a¦ Integer include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/ClusterReadPoolsRead/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/ClusterReadPoolsRead/security-scheme-before.adoc[opts=optional] - - -[[security-clusterReadPoolsRead]] -= Cluster Read Pools Read +[[security-ClusterReadPoolsRead]] += Cluster Read / Pools Read :leveloffset: +1 -// markup not found, no include::{specDir}security/ClusterReadPoolsRead/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/ClusterReadPoolsRead/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -635,16 +561,13 @@ Users must have one of the following RBAC roles: -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/ClusterReadPoolsRead/security-scheme-end.adoc[opts=optional] +include::{specDir}security/ClusterReadPoolsRead/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/ClusterReadPoolsRead/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/ClusterReadPoolsRead/security-scheme-after.adoc[opts=optional] @@ -652,8 +575,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - -// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] +include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/eventing-rest-api/eventing.gradle b/docs/modules/eventing-rest-api/eventing.gradle index 1fd57e73..4c36ce10 100644 --- a/docs/modules/eventing-rest-api/eventing.gradle +++ b/docs/modules/eventing-rest-api/eventing.gradle @@ -43,6 +43,7 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" modelNameMappings = [ handler_schema: "Function Definition", function_scope_schema: "Function Scope", diff --git a/docs/modules/eventing-rest-api/pages/index.adoc b/docs/modules/eventing-rest-api/pages/index.adoc index 57b523fb..61d340e5 100644 --- a/docs/modules/eventing-rest-api/pages/index.adoc +++ b/docs/modules/eventing-rest-api/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -31,7 +30,7 @@ The Eventing REST API provides methods to work with and manipulate Couchbase Eve [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -66,7 +65,6 @@ The host name or IP address of a node running the Eventing Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -82,31 +80,26 @@ The Eventing Service REST port. Use `18096` for secure access. |=== - include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}overview/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 7 - +:count-apis: 6 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -120,18 +113,14 @@ xref:tag-Status[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Activation] = Activation :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:basic_deploy[] @@ -140,36 +129,31 @@ xref:basic_resume[] xref:basic_undeploy[] -//tag::basic_deploy[] - -// markup not found, no include::{specDir}paths/basic_deploy/operation-before.adoc[opts=optional] +//tag::basic_deploy[] +include::{specDir}paths/basic_deploy/operation-before.adoc[opts=optional] [#basic_deploy] = Deploy a Function :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_deploy/operation-begin.adoc[opts=optional] - +include::{specDir}paths/basic_deploy/operation-begin.adoc[opts=optional] .... POST /api/v1/functions/{function}/deploy .... - -// markup not found, no include::{specDir}paths/basic_deploy/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/basic_deploy/operation-description-before.adoc[opts=optional] [#basic_deploy-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_deploy/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/basic_deploy/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -177,29 +161,25 @@ Deploys an undeployed function. This is the preferred invocation. -- +include::{specDir}paths/basic_deploy/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_deploy/operation-description-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/basic_deploy/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_deploy/operation-description-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/basic_deploy/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/basic_deploy/operation-parameters-before.adoc[opts=optional] [#basic_deploy-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_deploy/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/basic_deploy/operation-parameters-begin.adoc[opts=optional] [#basic_deploy-path] .Path Parameters @@ -210,11 +190,8 @@ This is the preferred invocation. ¦ Name ¦ Description ¦ Schema a¦ *function* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -225,7 +202,6 @@ The name of a function. a¦ String |=== - [#basic_deploy-query] .Query Parameters {blank} @@ -235,11 +211,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -249,13 +222,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -269,29 +238,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/basic_deploy/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/basic_deploy/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/basic_deploy/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/basic_deploy/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_deploy/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/basic_deploy/operation-responses-before.adoc[opts=optional] [#basic_deploy-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_deploy/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/basic_deploy/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -306,97 +270,81 @@ a| |=== - -// markup not found, no include::{specDir}paths/basic_deploy/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/basic_deploy/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/basic_deploy/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/basic_deploy/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_deploy/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/basic_deploy/operation-security-before.adoc[opts=optional] [#basic_deploy-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_deploy/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/basic_deploy/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/basic_deploy/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/basic_deploy/operation-security-after.adoc[opts=optional] +include::{specDir}paths/basic_deploy/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/basic_deploy/operation-security-after.adoc[opts=optional] include::{snippetDir}basic_deploy/http-request.adoc[opts=optional] +include::{snippetDir}basic_deploy/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}basic_deploy/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/basic_deploy/operation-end.adoc[opts=optional] +include::{specDir}paths/basic_deploy/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/basic_deploy/operation-after.adoc[opts=optional] - +include::{specDir}paths/basic_deploy/operation-after.adoc[opts=optional] //end::basic_deploy[] - //tag::basic_pause[] - -// markup not found, no include::{specDir}paths/basic_pause/operation-before.adoc[opts=optional] - +include::{specDir}paths/basic_pause/operation-before.adoc[opts=optional] [#basic_pause] = Pause a Function :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_pause/operation-begin.adoc[opts=optional] - +include::{specDir}paths/basic_pause/operation-begin.adoc[opts=optional] .... POST /api/v1/functions/{function}/pause .... - -// markup not found, no include::{specDir}paths/basic_pause/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/basic_pause/operation-description-before.adoc[opts=optional] [#basic_pause-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_pause/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/basic_pause/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -404,29 +352,25 @@ Pauses a function and creates a DCP checkpoint such that on a subsequent resume This is the preferred invocation. -- +include::{specDir}paths/basic_pause/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_pause/operation-description-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/basic_pause/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_pause/operation-description-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/basic_pause/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/basic_pause/operation-parameters-before.adoc[opts=optional] [#basic_pause-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_pause/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/basic_pause/operation-parameters-begin.adoc[opts=optional] [#basic_pause-path] .Path Parameters @@ -437,11 +381,8 @@ This is the preferred invocation. ¦ Name ¦ Description ¦ Schema a¦ *function* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -452,7 +393,6 @@ The name of a function. a¦ String |=== - [#basic_pause-query] .Query Parameters {blank} @@ -462,11 +402,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -476,13 +413,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -496,29 +429,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/basic_pause/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/basic_pause/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/basic_pause/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/basic_pause/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_pause/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/basic_pause/operation-responses-before.adoc[opts=optional] [#basic_pause-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_pause/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/basic_pause/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -533,97 +461,81 @@ a| |=== - -// markup not found, no include::{specDir}paths/basic_pause/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/basic_pause/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/basic_pause/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/basic_pause/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_pause/operation-security-before.adoc[opts=optional] +include::{specDir}paths/basic_pause/operation-security-before.adoc[opts=optional] [#basic_pause-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_pause/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/basic_pause/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/basic_pause/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/basic_pause/operation-security-after.adoc[opts=optional] +include::{specDir}paths/basic_pause/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/basic_pause/operation-security-after.adoc[opts=optional] include::{snippetDir}basic_pause/http-request.adoc[opts=optional] +include::{snippetDir}basic_pause/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}basic_pause/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/basic_pause/operation-end.adoc[opts=optional] +include::{specDir}paths/basic_pause/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/basic_pause/operation-after.adoc[opts=optional] - +include::{specDir}paths/basic_pause/operation-after.adoc[opts=optional] //end::basic_pause[] - //tag::basic_resume[] - -// markup not found, no include::{specDir}paths/basic_resume/operation-before.adoc[opts=optional] - +include::{specDir}paths/basic_resume/operation-before.adoc[opts=optional] [#basic_resume] = Resume a Function :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_resume/operation-begin.adoc[opts=optional] - +include::{specDir}paths/basic_resume/operation-begin.adoc[opts=optional] .... POST /api/v1/functions/(function}/resume .... - -// markup not found, no include::{specDir}paths/basic_resume/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/basic_resume/operation-description-before.adoc[opts=optional] [#basic_resume-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_resume/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/basic_resume/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -631,29 +543,25 @@ Resumes a paused function from its paused DCP checkpoint. This is the preferred invocation. -- +include::{specDir}paths/basic_resume/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_resume/operation-description-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/basic_resume/operation-description-after.adoc[opts=optional] - +include::{specDir}paths/basic_resume/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_resume/operation-parameters-before.adoc[opts=optional] - +include::{specDir}paths/basic_resume/operation-parameters-before.adoc[opts=optional] [#basic_resume-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_resume/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/basic_resume/operation-parameters-begin.adoc[opts=optional] [#basic_resume-path] .Path Parameters @@ -664,11 +572,8 @@ This is the preferred invocation. ¦ Name ¦ Description ¦ Schema a¦ *function* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -679,7 +584,6 @@ The name of a function. a¦ String |=== - [#basic_resume-query] .Query Parameters {blank} @@ -689,11 +593,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -703,13 +604,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -723,29 +620,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/basic_resume/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/basic_resume/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/basic_resume/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/basic_resume/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_resume/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/basic_resume/operation-responses-before.adoc[opts=optional] [#basic_resume-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_resume/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/basic_resume/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -757,6 +649,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -766,97 +659,81 @@ a| |=== - -// markup not found, no include::{specDir}paths/basic_resume/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/basic_resume/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/basic_resume/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/basic_resume/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_resume/operation-security-before.adoc[opts=optional] +include::{specDir}paths/basic_resume/operation-security-before.adoc[opts=optional] [#basic_resume-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_resume/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/basic_resume/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/basic_resume/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/basic_resume/operation-security-after.adoc[opts=optional] +include::{specDir}paths/basic_resume/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/basic_resume/operation-security-after.adoc[opts=optional] include::{snippetDir}basic_resume/http-request.adoc[opts=optional] +include::{snippetDir}basic_resume/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}basic_resume/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/basic_resume/operation-end.adoc[opts=optional] +include::{specDir}paths/basic_resume/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/basic_resume/operation-after.adoc[opts=optional] - +include::{specDir}paths/basic_resume/operation-after.adoc[opts=optional] //end::basic_resume[] - //tag::basic_undeploy[] - -// markup not found, no include::{specDir}paths/basic_undeploy/operation-before.adoc[opts=optional] - +include::{specDir}paths/basic_undeploy/operation-before.adoc[opts=optional] [#basic_undeploy] = Undeploy a Function :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_undeploy/operation-begin.adoc[opts=optional] - +include::{specDir}paths/basic_undeploy/operation-begin.adoc[opts=optional] .... POST /api/v1/functions/{function}/undeploy .... - -// markup not found, no include::{specDir}paths/basic_undeploy/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/basic_undeploy/operation-description-before.adoc[opts=optional] [#basic_undeploy-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_undeploy/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/basic_undeploy/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -864,29 +741,25 @@ Undeploys a function. This is the preferred invocation. -- +include::{specDir}paths/basic_undeploy/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_undeploy/operation-description-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/basic_undeploy/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_undeploy/operation-description-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/basic_undeploy/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/basic_undeploy/operation-parameters-before.adoc[opts=optional] [#basic_undeploy-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_undeploy/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/basic_undeploy/operation-parameters-begin.adoc[opts=optional] [#basic_undeploy-path] .Path Parameters @@ -897,11 +770,8 @@ This is the preferred invocation. ¦ Name ¦ Description ¦ Schema a¦ *function* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -912,7 +782,6 @@ The name of a function. a¦ String |=== - [#basic_undeploy-query] .Query Parameters {blank} @@ -922,11 +791,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -936,13 +802,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -956,29 +818,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/basic_undeploy/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/basic_undeploy/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/basic_undeploy/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/basic_undeploy/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_undeploy/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/basic_undeploy/operation-responses-before.adoc[opts=optional] [#basic_undeploy-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_undeploy/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/basic_undeploy/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -993,84 +850,71 @@ a| |=== - -// markup not found, no include::{specDir}paths/basic_undeploy/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/basic_undeploy/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/basic_undeploy/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/basic_undeploy/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/basic_undeploy/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/basic_undeploy/operation-security-before.adoc[opts=optional] [#basic_undeploy-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/basic_undeploy/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/basic_undeploy/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/basic_undeploy/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/basic_undeploy/operation-security-after.adoc[opts=optional] +include::{specDir}paths/basic_undeploy/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/basic_undeploy/operation-security-after.adoc[opts=optional] include::{snippetDir}basic_undeploy/http-request.adoc[opts=optional] +include::{snippetDir}basic_undeploy/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}basic_undeploy/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/basic_undeploy/operation-end.adoc[opts=optional] +include::{specDir}paths/basic_undeploy/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/basic_undeploy/operation-after.adoc[opts=optional] - +include::{specDir}paths/basic_undeploy/operation-after.adoc[opts=optional] //end::basic_undeploy[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Advanced] = Advanced :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:adv_function_import[] @@ -1089,44 +933,38 @@ xref:adv_text_get[] xref:adv_text_update[] -//tag::adv_function_import[] - -// markup not found, no include::{specDir}paths/adv_function_import/operation-before.adoc[opts=optional] +//tag::adv_function_import[] +include::{specDir}paths/adv_function_import/operation-before.adoc[opts=optional] [#adv_function_import] = Create or Import a Function :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_import/operation-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_import/operation-begin.adoc[opts=optional] .... POST /api/v1/functions/{function} .... - -// markup not found, no include::{specDir}paths/adv_function_import/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_import/operation-description-before.adoc[opts=optional] [#adv_function_import-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_import/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_import/operation-description-begin.adoc[opts=optional] [markdown] -- Creates or imports a single function. -- - -// markup not found, no include::{specDir}paths/adv_function_import/operation-description-end.adoc[opts=optional] +include::{specDir}paths/adv_function_import/operation-description-end.adoc[opts=optional] [#adv_function_import-consumes] @@ -1134,23 +972,20 @@ Creates or imports a single function. * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/adv_function_import/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_function_import/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_import/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/adv_function_import/operation-parameters-before.adoc[opts=optional] [#adv_function_import-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_import/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_import/operation-parameters-begin.adoc[opts=optional] [#adv_function_import-path] .Path Parameters @@ -1161,11 +996,8 @@ Creates or imports a single function. ¦ Name ¦ Description ¦ Schema a¦ *function* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -1176,7 +1008,6 @@ The name of a function. a¦ String |=== - [#adv_function_import-query] .Query Parameters {blank} @@ -1186,11 +1017,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -1200,13 +1028,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -1218,9 +1042,6 @@ The scope to which the function belongs. a¦ String |=== - - - [#adv_function_import-body] .Body Parameter {blank} @@ -1230,13 +1051,10 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -A single function definition object, or an array containing a single function definition object. The function name in the definition object must match that given by the path parameter. + -- [%hardbreaks] @@ -1247,26 +1065,25 @@ a¦ xref:AddFunction[] |=== -// markup not found, no include::{specDir}paths/adv_function_import/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/adv_function_import/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-AddFunction: -// markup not found, no include::{specDir}paths/adv_function_import/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/adv_function_import/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_import/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/adv_function_import/operation-responses-before.adoc[opts=optional] [#adv_function_import-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_import/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_import/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1278,6 +1095,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -1287,97 +1105,81 @@ a| |=== - -// markup not found, no include::{specDir}paths/adv_function_import/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/adv_function_import/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_function_import/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/adv_function_import/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_import/operation-security-before.adoc[opts=optional] +include::{specDir}paths/adv_function_import/operation-security-before.adoc[opts=optional] [#adv_function_import-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_import/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_import/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/adv_function_import/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/adv_function_import/operation-security-after.adoc[opts=optional] +include::{specDir}paths/adv_function_import/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_function_import/operation-security-after.adoc[opts=optional] include::{snippetDir}adv_function_import/http-request.adoc[opts=optional] +include::{snippetDir}adv_function_import/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}adv_function_import/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/adv_function_import/operation-end.adoc[opts=optional] +include::{specDir}paths/adv_function_import/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_function_import/operation-after.adoc[opts=optional] - +include::{specDir}paths/adv_function_import/operation-after.adoc[opts=optional] //end::adv_function_import[] - //tag::adv_function_import_all[] - -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_import_all/operation-before.adoc[opts=optional] [#adv_function_import_all] = Create or Import Multiple Functions :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_import_all/operation-begin.adoc[opts=optional] .... POST /api/v1/functions .... - -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_import_all/operation-description-before.adoc[opts=optional] [#adv_function_import_all-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_import_all/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -1386,8 +1188,7 @@ Creates or imports multiple functions. If any function's `language_compatibility` field is missing, the value will be set to the highest version supported by the server, unlike [Import Multiple Functions](#adv_multiple_import). -- - -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-description-end.adoc[opts=optional] +include::{specDir}paths/adv_function_import_all/operation-description-end.adoc[opts=optional] [#adv_function_import_all-consumes] @@ -1395,27 +1196,20 @@ If any function's `language_compatibility` field is missing, the value will be s * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_function_import_all/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/adv_function_import_all/operation-parameters-before.adoc[opts=optional] [#adv_function_import_all-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-parameters-begin.adoc[opts=optional] - - - - - +include::{specDir}paths/adv_function_import_all/operation-parameters-begin.adoc[opts=optional] [#adv_function_import_all-body] .Body Parameter @@ -1426,13 +1220,10 @@ If any function's `language_compatibility` field is missing, the value will be s ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -A single function definition object, or an array containing one or more function definition objects. Function names must be unique. When multiple functions have the same name, an error is reported. + -- [%hardbreaks] @@ -1443,26 +1234,25 @@ a¦ xref:AddFunctions[] |=== -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/adv_function_import_all/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-AddFunctions: -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/adv_function_import_all/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/adv_function_import_all/operation-responses-before.adoc[opts=optional] [#adv_function_import_all-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_import_all/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1474,6 +1264,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -1483,95 +1274,76 @@ a| |=== - -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/adv_function_import_all/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/adv_function_import_all/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-security-before.adoc[opts=optional] +include::{specDir}paths/adv_function_import_all/operation-security-before.adoc[opts=optional] [#adv_function_import_all-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_import_all/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-unscoped[] +| xref:security-Unscoped[] |=== - -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-security-end.adoc[opts=optional] +include::{specDir}paths/adv_function_import_all/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/adv_function_import_all/operation-security-after.adoc[opts=optional] include::{snippetDir}adv_function_import_all/http-request.adoc[opts=optional] +include::{snippetDir}adv_function_import_all/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}adv_function_import_all/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-end.adoc[opts=optional] +include::{specDir}paths/adv_function_import_all/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_function_import_all/operation-after.adoc[opts=optional] - +include::{specDir}paths/adv_function_import_all/operation-after.adoc[opts=optional] //end::adv_function_import_all[] - //tag::adv_function_view[] - -// markup not found, no include::{specDir}paths/adv_function_view/operation-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_view/operation-before.adoc[opts=optional] [#adv_function_view] = View a Function :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_view/operation-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_view/operation-begin.adoc[opts=optional] .... GET /api/v1/functions/{function} .... - -// markup not found, no include::{specDir}paths/adv_function_view/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_view/operation-description-before.adoc[opts=optional] [#adv_function_view-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_view/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_view/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -1581,8 +1353,7 @@ If saved to a file the function definition can be imported into the cluster or a However any changes to the function definition made to the file outside the UI are discouraged. -- - -// markup not found, no include::{specDir}paths/adv_function_view/operation-description-end.adoc[opts=optional] +include::{specDir}paths/adv_function_view/operation-description-end.adoc[opts=optional] @@ -1590,23 +1361,20 @@ However any changes to the function definition made to the file outside the UI a .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/adv_function_view/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_function_view/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_view/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/adv_function_view/operation-parameters-before.adoc[opts=optional] [#adv_function_view-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_view/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_view/operation-parameters-begin.adoc[opts=optional] [#adv_function_view-path] .Path Parameters @@ -1617,11 +1385,8 @@ However any changes to the function definition made to the file outside the UI a ¦ Name ¦ Description ¦ Schema a¦ *function* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -1632,7 +1397,6 @@ The name of a function. a¦ String |=== - [#adv_function_view-query] .Query Parameters {blank} @@ -1642,11 +1406,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -1656,13 +1417,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -1676,29 +1433,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/adv_function_view/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/adv_function_view/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_function_view/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/adv_function_view/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_view/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_view/operation-responses-before.adoc[opts=optional] [#adv_function_view-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_view/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_view/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1720,97 +1472,82 @@ a| |=== - -// markup not found, no include::{specDir}paths/adv_function_view/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/adv_function_view/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-handler_schema: -// markup not found, no include::{specDir}paths/adv_function_view/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/adv_function_view/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_view/operation-security-before.adoc[opts=optional] +include::{specDir}paths/adv_function_view/operation-security-before.adoc[opts=optional] [#adv_function_view-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_view/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_view/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/adv_function_view/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/adv_function_view/operation-security-after.adoc[opts=optional] +include::{specDir}paths/adv_function_view/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_function_view/operation-security-after.adoc[opts=optional] include::{snippetDir}adv_function_view/http-request.adoc[opts=optional] +include::{snippetDir}adv_function_view/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}adv_function_view/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/adv_function_view/operation-end.adoc[opts=optional] +include::{specDir}paths/adv_function_view/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_function_view/operation-after.adoc[opts=optional] - +include::{specDir}paths/adv_function_view/operation-after.adoc[opts=optional] //end::adv_function_view[] - //tag::adv_function_view_all[] - -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_view_all/operation-before.adoc[opts=optional] [#adv_function_view_all] = View Multiple Functions :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_view_all/operation-begin.adoc[opts=optional] .... GET /api/v1/functions .... - -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_view_all/operation-description-before.adoc[opts=optional] [#adv_function_view_all-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_view_all/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -1822,8 +1559,7 @@ However any changes to the function definition made to the file outside the UI a If this API is run as a non-Administrator, the results are filtered via RBAC to include only the function scopes the user has access to. -- - -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-description-end.adoc[opts=optional] +include::{specDir}paths/adv_function_view_all/operation-description-end.adoc[opts=optional] @@ -1831,33 +1567,29 @@ If this API is run as a non-Administrator, the results are filtered via RBAC to .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/adv_function_view_all/operation-description-after.adoc[opts=optional] +include::{specDir}paths/adv_function_view_all/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/adv_function_view_all/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/adv_function_view_all/operation-responses-before.adoc[opts=optional] [#adv_function_view_all-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_view_all/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1868,8 +1600,7 @@ a| [markdown] -- Returns an array containing one or more function definition objects. -- -a| xref:handler_schema[] - array +a| xref:handler_schema[] array | 404 a| [markdown] @@ -1880,95 +1611,77 @@ a| |=== - -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/adv_function_view_all/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-handler_schema: -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/adv_function_view_all/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-security-before.adoc[opts=optional] +include::{specDir}paths/adv_function_view_all/operation-security-before.adoc[opts=optional] [#adv_function_view_all-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_view_all/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-unscoped[] +| xref:security-Unscoped[] |=== - -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-security-end.adoc[opts=optional] +include::{specDir}paths/adv_function_view_all/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/adv_function_view_all/operation-security-after.adoc[opts=optional] include::{snippetDir}adv_function_view_all/http-request.adoc[opts=optional] +include::{snippetDir}adv_function_view_all/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}adv_function_view_all/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-end.adoc[opts=optional] +include::{specDir}paths/adv_function_view_all/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_function_view_all/operation-after.adoc[opts=optional] - +include::{specDir}paths/adv_function_view_all/operation-after.adoc[opts=optional] //end::adv_function_view_all[] - //tag::adv_function_zap[] - -// markup not found, no include::{specDir}paths/adv_function_zap/operation-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap/operation-before.adoc[opts=optional] [#adv_function_zap] = Delete Function :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_zap/operation-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap/operation-begin.adoc[opts=optional] .... DELETE /api/v1/functions/{function} .... - -// markup not found, no include::{specDir}paths/adv_function_zap/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap/operation-description-before.adoc[opts=optional] [#adv_function_zap-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_zap/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -1977,29 +1690,25 @@ Deletes a specific function from the cluster. Use this API with caution, as it's irreversible. -- +include::{specDir}paths/adv_function_zap/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_zap/operation-description-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_function_zap/operation-description-after.adoc[opts=optional] +include::{specDir}paths/adv_function_zap/operation-description-after.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/adv_function_zap/operation-parameters-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap/operation-parameters-before.adoc[opts=optional] [#adv_function_zap-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_zap/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap/operation-parameters-begin.adoc[opts=optional] [#adv_function_zap-path] .Path Parameters @@ -2010,11 +1719,8 @@ Use this API with caution, as it's irreversible. ¦ Name ¦ Description ¦ Schema a¦ *function* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -2025,7 +1731,6 @@ The name of a function. a¦ String |=== - [#adv_function_zap-query] .Query Parameters {blank} @@ -2035,11 +1740,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -2049,13 +1751,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -2069,29 +1767,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/adv_function_zap/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/adv_function_zap/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_function_zap/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/adv_function_zap/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_zap/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap/operation-responses-before.adoc[opts=optional] [#adv_function_zap-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_zap/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2103,6 +1796,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -2112,97 +1806,81 @@ a| |=== - -// markup not found, no include::{specDir}paths/adv_function_zap/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/adv_function_zap/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_function_zap/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/adv_function_zap/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_zap/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap/operation-security-before.adoc[opts=optional] [#adv_function_zap-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_zap/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/adv_function_zap/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/adv_function_zap/operation-security-after.adoc[opts=optional] +include::{specDir}paths/adv_function_zap/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_function_zap/operation-security-after.adoc[opts=optional] include::{snippetDir}adv_function_zap/http-request.adoc[opts=optional] +include::{snippetDir}adv_function_zap/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}adv_function_zap/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/adv_function_zap/operation-end.adoc[opts=optional] +include::{specDir}paths/adv_function_zap/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_function_zap/operation-after.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap/operation-after.adoc[opts=optional] //end::adv_function_zap[] - //tag::adv_function_zap_all[] - -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap_all/operation-before.adoc[opts=optional] [#adv_function_zap_all] = Delete Multiple Functions :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap_all/operation-begin.adoc[opts=optional] .... DELETE /api/v1/functions .... - -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap_all/operation-description-before.adoc[opts=optional] [#adv_function_zap_all-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap_all/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -2212,39 +1890,34 @@ Use this API with caution, as it's irreversible. If this API is run as a non-Administrator the deleted set will be filtered via RBAC to include only the function scopes the user has access to. -- +include::{specDir}paths/adv_function_zap_all/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-description-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/adv_function_zap_all/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-description-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/adv_function_zap_all/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/adv_function_zap_all/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap_all/operation-responses-before.adoc[opts=optional] [#adv_function_zap_all-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap_all/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2256,6 +1929,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -2265,95 +1939,76 @@ a| |=== - -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/adv_function_zap_all/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/adv_function_zap_all/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap_all/operation-security-before.adoc[opts=optional] [#adv_function_zap_all-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap_all/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-unscoped[] +| xref:security-Unscoped[] |=== - -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-security-end.adoc[opts=optional] +include::{specDir}paths/adv_function_zap_all/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/adv_function_zap_all/operation-security-after.adoc[opts=optional] include::{snippetDir}adv_function_zap_all/http-request.adoc[opts=optional] +include::{snippetDir}adv_function_zap_all/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}adv_function_zap_all/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-end.adoc[opts=optional] +include::{specDir}paths/adv_function_zap_all/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-after.adoc[opts=optional] - +include::{specDir}paths/adv_function_zap_all/operation-after.adoc[opts=optional] //end::adv_function_zap_all[] - //tag::adv_multiple_export[] - -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-before.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_export/operation-before.adoc[opts=optional] [#adv_multiple_export] = Export Multiple Functions :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-begin.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_export/operation-begin.adoc[opts=optional] .... GET /api/v1/export .... - -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_export/operation-description-before.adoc[opts=optional] [#adv_multiple_export-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_export/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -2365,8 +2020,7 @@ However any changes to the function definition made to the file outside the UI a If this API is run as a non-Administrator the results are filtered via RBAC to include only the function scopes the user has access to. -- - -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-description-end.adoc[opts=optional] +include::{specDir}paths/adv_multiple_export/operation-description-end.adoc[opts=optional] @@ -2374,33 +2028,29 @@ If this API is run as a non-Administrator the results are filtered via RBAC to i .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/adv_multiple_export/operation-description-after.adoc[opts=optional] +include::{specDir}paths/adv_multiple_export/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/adv_multiple_export/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/adv_multiple_export/operation-responses-before.adoc[opts=optional] [#adv_multiple_export-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_export/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2411,8 +2061,7 @@ a| [markdown] -- Returns an array containing one or more function definition objects. -- -a| xref:handler_schema[] - array +a| xref:handler_schema[] array | 404 a| [markdown] @@ -2423,95 +2072,77 @@ a| |=== - -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/adv_multiple_export/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-handler_schema: -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_export/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-security-before.adoc[opts=optional] +include::{specDir}paths/adv_multiple_export/operation-security-before.adoc[opts=optional] [#adv_multiple_export-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_export/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-unscoped[] +| xref:security-Unscoped[] |=== - -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-security-end.adoc[opts=optional] +include::{specDir}paths/adv_multiple_export/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/adv_multiple_export/operation-security-after.adoc[opts=optional] include::{snippetDir}adv_multiple_export/http-request.adoc[opts=optional] +include::{snippetDir}adv_multiple_export/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}adv_multiple_export/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-end.adoc[opts=optional] +include::{specDir}paths/adv_multiple_export/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_multiple_export/operation-after.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_export/operation-after.adoc[opts=optional] //end::adv_multiple_export[] - //tag::adv_multiple_import[] - -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-before.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_import/operation-before.adoc[opts=optional] [#adv_multiple_import] = Import Multiple Functions :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-begin.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_import/operation-begin.adoc[opts=optional] .... POST /api/v1/import .... - -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_import/operation-description-before.adoc[opts=optional] [#adv_multiple_import-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_import/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -2520,8 +2151,7 @@ Imports multiple functions. If any function's `language_compatibility` field is missing, the value will be set to 6.0.0, unlike [Create or Import Multiple Functions](#adv_function_import_all). -- - -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-description-end.adoc[opts=optional] +include::{specDir}paths/adv_multiple_import/operation-description-end.adoc[opts=optional] [#adv_multiple_import-consumes] @@ -2529,27 +2159,20 @@ If any function's `language_compatibility` field is missing, the value will be s * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_multiple_import/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/adv_multiple_import/operation-parameters-before.adoc[opts=optional] [#adv_multiple_import-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-parameters-begin.adoc[opts=optional] - - - - - +include::{specDir}paths/adv_multiple_import/operation-parameters-begin.adoc[opts=optional] [#adv_multiple_import-body] .Body Parameter @@ -2560,13 +2183,10 @@ If any function's `language_compatibility` field is missing, the value will be s ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -A single function definition object, or an array containing one or more function definition objects. Function names must be unique. When multiple functions have the same name, an error is reported. + -- [%hardbreaks] @@ -2577,26 +2197,25 @@ a¦ xref:AddFunctions[] |=== -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/adv_multiple_import/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-AddFunctions: -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/adv_multiple_import/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_import/operation-responses-before.adoc[opts=optional] [#adv_multiple_import-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_import/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2608,6 +2227,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -2617,95 +2237,76 @@ a| |=== - -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/adv_multiple_import/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/adv_multiple_import/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_import/operation-security-before.adoc[opts=optional] [#adv_multiple_import-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_import/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-unscoped[] +| xref:security-Unscoped[] |=== - -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-security-end.adoc[opts=optional] +include::{specDir}paths/adv_multiple_import/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/adv_multiple_import/operation-security-after.adoc[opts=optional] include::{snippetDir}adv_multiple_import/http-request.adoc[opts=optional] +include::{snippetDir}adv_multiple_import/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}adv_multiple_import/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-end.adoc[opts=optional] +include::{specDir}paths/adv_multiple_import/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_multiple_import/operation-after.adoc[opts=optional] - +include::{specDir}paths/adv_multiple_import/operation-after.adoc[opts=optional] //end::adv_multiple_import[] - //tag::adv_settings_get[] - -// markup not found, no include::{specDir}paths/adv_settings_get/operation-before.adoc[opts=optional] - +include::{specDir}paths/adv_settings_get/operation-before.adoc[opts=optional] [#adv_settings_get] = View Function Settings :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_settings_get/operation-begin.adoc[opts=optional] - +include::{specDir}paths/adv_settings_get/operation-begin.adoc[opts=optional] .... GET /api/v1/functions/{function}/settings .... - -// markup not found, no include::{specDir}paths/adv_settings_get/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/adv_settings_get/operation-description-before.adoc[opts=optional] [#adv_settings_get-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_settings_get/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/adv_settings_get/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -2714,8 +2315,7 @@ The settings can be subsequently imported. However any changes to the function settings made to the file outside the UI are discouraged. -- - -// markup not found, no include::{specDir}paths/adv_settings_get/operation-description-end.adoc[opts=optional] +include::{specDir}paths/adv_settings_get/operation-description-end.adoc[opts=optional] @@ -2723,23 +2323,20 @@ However any changes to the function settings made to the file outside the UI are .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/adv_settings_get/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_settings_get/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_settings_get/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/adv_settings_get/operation-parameters-before.adoc[opts=optional] [#adv_settings_get-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_settings_get/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/adv_settings_get/operation-parameters-begin.adoc[opts=optional] [#adv_settings_get-path] .Path Parameters @@ -2750,11 +2347,8 @@ However any changes to the function settings made to the file outside the UI are ¦ Name ¦ Description ¦ Schema a¦ *function* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -2765,7 +2359,6 @@ The name of a function. a¦ String |=== - [#adv_settings_get-query] .Query Parameters {blank} @@ -2775,11 +2368,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -2789,13 +2379,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -2809,29 +2395,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/adv_settings_get/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/adv_settings_get/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_settings_get/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/adv_settings_get/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_settings_get/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/adv_settings_get/operation-responses-before.adoc[opts=optional] [#adv_settings_get-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_settings_get/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/adv_settings_get/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2853,97 +2434,82 @@ a| |=== - -// markup not found, no include::{specDir}paths/adv_settings_get/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/adv_settings_get/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-settings_schema: -// markup not found, no include::{specDir}paths/adv_settings_get/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/adv_settings_get/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_settings_get/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/adv_settings_get/operation-security-before.adoc[opts=optional] [#adv_settings_get-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_settings_get/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/adv_settings_get/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/adv_settings_get/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/adv_settings_get/operation-security-after.adoc[opts=optional] +include::{specDir}paths/adv_settings_get/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_settings_get/operation-security-after.adoc[opts=optional] include::{snippetDir}adv_settings_get/http-request.adoc[opts=optional] +include::{snippetDir}adv_settings_get/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}adv_settings_get/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/adv_settings_get/operation-end.adoc[opts=optional] +include::{specDir}paths/adv_settings_get/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_settings_get/operation-after.adoc[opts=optional] - +include::{specDir}paths/adv_settings_get/operation-after.adoc[opts=optional] //end::adv_settings_get[] - //tag::adv_settings_update[] - -// markup not found, no include::{specDir}paths/adv_settings_update/operation-before.adoc[opts=optional] - +include::{specDir}paths/adv_settings_update/operation-before.adoc[opts=optional] [#adv_settings_update] = Update Function Settings :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_settings_update/operation-begin.adoc[opts=optional] - +include::{specDir}paths/adv_settings_update/operation-begin.adoc[opts=optional] .... POST /api/v1/functions/{function}/settings .... - -// markup not found, no include::{specDir}paths/adv_settings_update/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/adv_settings_update/operation-description-before.adoc[opts=optional] [#adv_settings_update-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_settings_update/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/adv_settings_update/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -2958,8 +2524,7 @@ To get the current values of `deployment_status` and `processing_status`, see [V By adjusting `deployment_status` and `processing_status` this command can also deploy or resume a function; however, it cannot pause or undeploy a function. -- - -// markup not found, no include::{specDir}paths/adv_settings_update/operation-description-end.adoc[opts=optional] +include::{specDir}paths/adv_settings_update/operation-description-end.adoc[opts=optional] [#adv_settings_update-consumes] @@ -2967,23 +2532,20 @@ By adjusting `deployment_status` and `processing_status` this command can also d * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/adv_settings_update/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_settings_update/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_settings_update/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/adv_settings_update/operation-parameters-before.adoc[opts=optional] [#adv_settings_update-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_settings_update/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/adv_settings_update/operation-parameters-begin.adoc[opts=optional] [#adv_settings_update-path] .Path Parameters @@ -2994,11 +2556,8 @@ By adjusting `deployment_status` and `processing_status` this command can also d ¦ Name ¦ Description ¦ Schema a¦ *function* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -3009,7 +2568,6 @@ The name of a function. a¦ String |=== - [#adv_settings_update-query] .Query Parameters {blank} @@ -3019,11 +2577,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -3033,13 +2588,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -3051,9 +2602,6 @@ The scope to which the function belongs. a¦ String |=== - - - [#adv_settings_update-body] .Body Parameter {blank} @@ -3063,13 +2611,10 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -An object providing settings for the specified function. + -- [%hardbreaks] @@ -3080,26 +2625,25 @@ a¦ xref:Function Settings[] |=== -// markup not found, no include::{specDir}paths/adv_settings_update/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/adv_settings_update/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Function Settings: -// markup not found, no include::{specDir}paths/adv_settings_update/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/adv_settings_update/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_settings_update/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/adv_settings_update/operation-responses-before.adoc[opts=optional] [#adv_settings_update-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_settings_update/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/adv_settings_update/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3111,6 +2655,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -3120,97 +2665,81 @@ a| |=== - -// markup not found, no include::{specDir}paths/adv_settings_update/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/adv_settings_update/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_settings_update/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/adv_settings_update/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_settings_update/operation-security-before.adoc[opts=optional] +include::{specDir}paths/adv_settings_update/operation-security-before.adoc[opts=optional] [#adv_settings_update-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_settings_update/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/adv_settings_update/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/adv_settings_update/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/adv_settings_update/operation-security-after.adoc[opts=optional] +include::{specDir}paths/adv_settings_update/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_settings_update/operation-security-after.adoc[opts=optional] include::{snippetDir}adv_settings_update/http-request.adoc[opts=optional] +include::{snippetDir}adv_settings_update/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}adv_settings_update/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/adv_settings_update/operation-end.adoc[opts=optional] +include::{specDir}paths/adv_settings_update/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_settings_update/operation-after.adoc[opts=optional] - +include::{specDir}paths/adv_settings_update/operation-after.adoc[opts=optional] //end::adv_settings_update[] - //tag::adv_structure_get[] - -// markup not found, no include::{specDir}paths/adv_structure_get/operation-before.adoc[opts=optional] - +include::{specDir}paths/adv_structure_get/operation-before.adoc[opts=optional] [#adv_structure_get] = View Function Config :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_structure_get/operation-begin.adoc[opts=optional] - +include::{specDir}paths/adv_structure_get/operation-begin.adoc[opts=optional] .... GET /api/v1/functions/{function}/config .... - -// markup not found, no include::{specDir}paths/adv_structure_get/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/adv_structure_get/operation-description-before.adoc[opts=optional] [#adv_structure_get-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_structure_get/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/adv_structure_get/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -3219,8 +2748,7 @@ The definition can be subsequently imported. However any changes to the function definition made to the file outside the UI are discouraged. -- - -// markup not found, no include::{specDir}paths/adv_structure_get/operation-description-end.adoc[opts=optional] +include::{specDir}paths/adv_structure_get/operation-description-end.adoc[opts=optional] @@ -3228,23 +2756,20 @@ However any changes to the function definition made to the file outside the UI a .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/adv_structure_get/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_structure_get/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_structure_get/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/adv_structure_get/operation-parameters-before.adoc[opts=optional] [#adv_structure_get-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_structure_get/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/adv_structure_get/operation-parameters-begin.adoc[opts=optional] [#adv_structure_get-path] .Path Parameters @@ -3255,11 +2780,8 @@ However any changes to the function definition made to the file outside the UI a ¦ Name ¦ Description ¦ Schema a¦ *function* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -3270,7 +2792,6 @@ The name of a function. a¦ String |=== - [#adv_structure_get-query] .Query Parameters {blank} @@ -3280,11 +2801,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -3294,13 +2812,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -3314,29 +2828,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/adv_structure_get/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/adv_structure_get/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_structure_get/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/adv_structure_get/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_structure_get/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/adv_structure_get/operation-responses-before.adoc[opts=optional] [#adv_structure_get-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_structure_get/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/adv_structure_get/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3358,97 +2867,82 @@ a| |=== - -// markup not found, no include::{specDir}paths/adv_structure_get/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/adv_structure_get/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-depcfg_schema: -// markup not found, no include::{specDir}paths/adv_structure_get/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/adv_structure_get/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_structure_get/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/adv_structure_get/operation-security-before.adoc[opts=optional] [#adv_structure_get-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_structure_get/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/adv_structure_get/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/adv_structure_get/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/adv_structure_get/operation-security-after.adoc[opts=optional] +include::{specDir}paths/adv_structure_get/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_structure_get/operation-security-after.adoc[opts=optional] include::{snippetDir}adv_structure_get/http-request.adoc[opts=optional] +include::{snippetDir}adv_structure_get/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}adv_structure_get/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/adv_structure_get/operation-end.adoc[opts=optional] +include::{specDir}paths/adv_structure_get/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_structure_get/operation-after.adoc[opts=optional] - +include::{specDir}paths/adv_structure_get/operation-after.adoc[opts=optional] //end::adv_structure_get[] - //tag::adv_structure_update[] - -// markup not found, no include::{specDir}paths/adv_structure_update/operation-before.adoc[opts=optional] - +include::{specDir}paths/adv_structure_update/operation-before.adoc[opts=optional] [#adv_structure_update] = Update Function Config :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_structure_update/operation-begin.adoc[opts=optional] - +include::{specDir}paths/adv_structure_update/operation-begin.adoc[opts=optional] .... POST /api/v1/functions/{function}/config .... - -// markup not found, no include::{specDir}paths/adv_structure_update/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/adv_structure_update/operation-description-before.adoc[opts=optional] [#adv_structure_update-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_structure_update/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/adv_structure_update/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -3456,8 +2950,7 @@ Import the configuration and alter the source keyspace and the eventing storage You can only change these values if a function is in the undeployed state and the two keyspaces exist. -- - -// markup not found, no include::{specDir}paths/adv_structure_update/operation-description-end.adoc[opts=optional] +include::{specDir}paths/adv_structure_update/operation-description-end.adoc[opts=optional] [#adv_structure_update-consumes] @@ -3465,23 +2958,20 @@ You can only change these values if a function is in the undeployed state and th * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/adv_structure_update/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_structure_update/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_structure_update/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/adv_structure_update/operation-parameters-before.adoc[opts=optional] [#adv_structure_update-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_structure_update/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/adv_structure_update/operation-parameters-begin.adoc[opts=optional] [#adv_structure_update-path] .Path Parameters @@ -3492,11 +2982,8 @@ You can only change these values if a function is in the undeployed state and th ¦ Name ¦ Description ¦ Schema a¦ *function* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -3507,7 +2994,6 @@ The name of a function. a¦ String |=== - [#adv_structure_update-query] .Query Parameters {blank} @@ -3517,11 +3003,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -3531,13 +3014,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -3549,9 +3028,6 @@ The scope to which the function belongs. a¦ String |=== - - - [#adv_structure_update-body] .Body Parameter {blank} @@ -3561,13 +3037,10 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -An object providing the configuration for the specified function. + -- [%hardbreaks] @@ -3578,26 +3051,25 @@ a¦ xref:Deployment Config[] |=== -// markup not found, no include::{specDir}paths/adv_structure_update/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/adv_structure_update/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Deployment Config: -// markup not found, no include::{specDir}paths/adv_structure_update/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/adv_structure_update/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_structure_update/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/adv_structure_update/operation-responses-before.adoc[opts=optional] [#adv_structure_update-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_structure_update/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/adv_structure_update/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3609,6 +3081,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -3618,97 +3091,81 @@ a| |=== - -// markup not found, no include::{specDir}paths/adv_structure_update/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/adv_structure_update/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_structure_update/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/adv_structure_update/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_structure_update/operation-security-before.adoc[opts=optional] +include::{specDir}paths/adv_structure_update/operation-security-before.adoc[opts=optional] [#adv_structure_update-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_structure_update/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/adv_structure_update/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/adv_structure_update/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/adv_structure_update/operation-security-after.adoc[opts=optional] +include::{specDir}paths/adv_structure_update/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_structure_update/operation-security-after.adoc[opts=optional] include::{snippetDir}adv_structure_update/http-request.adoc[opts=optional] +include::{snippetDir}adv_structure_update/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}adv_structure_update/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/adv_structure_update/operation-end.adoc[opts=optional] +include::{specDir}paths/adv_structure_update/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_structure_update/operation-after.adoc[opts=optional] - +include::{specDir}paths/adv_structure_update/operation-after.adoc[opts=optional] //end::adv_structure_update[] - //tag::adv_text_get[] - -// markup not found, no include::{specDir}paths/adv_text_get/operation-before.adoc[opts=optional] - +include::{specDir}paths/adv_text_get/operation-before.adoc[opts=optional] [#adv_text_get] = View Function Code :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_text_get/operation-begin.adoc[opts=optional] - +include::{specDir}paths/adv_text_get/operation-begin.adoc[opts=optional] .... GET /api/v1/functions/{function}/appcode .... - -// markup not found, no include::{specDir}paths/adv_text_get/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/adv_text_get/operation-description-before.adoc[opts=optional] [#adv_text_get-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_text_get/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/adv_text_get/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -3718,8 +3175,7 @@ The JavaScript code can be subsequently imported. However any changes to the function definition made to the file outside the UI are discouraged. -- - -// markup not found, no include::{specDir}paths/adv_text_get/operation-description-end.adoc[opts=optional] +include::{specDir}paths/adv_text_get/operation-description-end.adoc[opts=optional] @@ -3727,23 +3183,20 @@ However any changes to the function definition made to the file outside the UI a .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/adv_text_get/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_text_get/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_text_get/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/adv_text_get/operation-parameters-before.adoc[opts=optional] [#adv_text_get-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_text_get/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/adv_text_get/operation-parameters-begin.adoc[opts=optional] [#adv_text_get-path] .Path Parameters @@ -3754,11 +3207,8 @@ However any changes to the function definition made to the file outside the UI a ¦ Name ¦ Description ¦ Schema a¦ *function* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -3769,7 +3219,6 @@ The name of a function. a¦ String |=== - [#adv_text_get-query] .Query Parameters {blank} @@ -3779,11 +3228,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -3793,13 +3239,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -3813,29 +3255,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/adv_text_get/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/adv_text_get/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_text_get/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/adv_text_get/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_text_get/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/adv_text_get/operation-responses-before.adoc[opts=optional] [#adv_text_get-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_text_get/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/adv_text_get/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3857,97 +3294,81 @@ a| |=== - -// markup not found, no include::{specDir}paths/adv_text_get/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/adv_text_get/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_text_get/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/adv_text_get/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_text_get/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/adv_text_get/operation-security-before.adoc[opts=optional] [#adv_text_get-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_text_get/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/adv_text_get/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/adv_text_get/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/adv_text_get/operation-security-after.adoc[opts=optional] +include::{specDir}paths/adv_text_get/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_text_get/operation-security-after.adoc[opts=optional] include::{snippetDir}adv_text_get/http-request.adoc[opts=optional] +include::{snippetDir}adv_text_get/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}adv_text_get/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/adv_text_get/operation-end.adoc[opts=optional] +include::{specDir}paths/adv_text_get/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_text_get/operation-after.adoc[opts=optional] - +include::{specDir}paths/adv_text_get/operation-after.adoc[opts=optional] //end::adv_text_get[] - //tag::adv_text_update[] - -// markup not found, no include::{specDir}paths/adv_text_update/operation-before.adoc[opts=optional] - +include::{specDir}paths/adv_text_update/operation-before.adoc[opts=optional] [#adv_text_update] = Update Function Code :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_text_update/operation-begin.adoc[opts=optional] - +include::{specDir}paths/adv_text_update/operation-begin.adoc[opts=optional] .... POST /api/v1/functions/{function}/appcode .... - -// markup not found, no include::{specDir}paths/adv_text_update/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/adv_text_update/operation-description-before.adoc[opts=optional] [#adv_text_update-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_text_update/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/adv_text_update/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -3956,8 +3377,7 @@ Unlike [Create or Import Function](#adv_function_import), the JavaScript is not It is highly recommended that you use the flag `--data-binary` or `--upload-file` when importing your JavaScript appcode fragments to avoid potential encoding issues due to string escaping. -- - -// markup not found, no include::{specDir}paths/adv_text_update/operation-description-end.adoc[opts=optional] +include::{specDir}paths/adv_text_update/operation-description-end.adoc[opts=optional] [#adv_text_update-consumes] @@ -3965,23 +3385,20 @@ It is highly recommended that you use the flag `--data-binary` or `--upload-file * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/adv_text_update/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_text_update/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_text_update/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/adv_text_update/operation-parameters-before.adoc[opts=optional] [#adv_text_update-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_text_update/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/adv_text_update/operation-parameters-begin.adoc[opts=optional] [#adv_text_update-path] .Path Parameters @@ -3992,11 +3409,8 @@ It is highly recommended that you use the flag `--data-binary` or `--upload-file ¦ Name ¦ Description ¦ Schema a¦ *function* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -4007,7 +3421,6 @@ The name of a function. a¦ String |=== - [#adv_text_update-query] .Query Parameters {blank} @@ -4017,11 +3430,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -4031,13 +3441,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -4049,9 +3455,6 @@ The scope to which the function belongs. a¦ String |=== - - - [#adv_text_update-body] .Body Parameter {blank} @@ -4061,13 +3464,10 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -A string providing the code for the specified function. + -- [%hardbreaks] @@ -4078,26 +3478,24 @@ a¦ String |=== -// markup not found, no include::{specDir}paths/adv_text_update/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/adv_text_update/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_text_update/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/adv_text_update/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_text_update/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/adv_text_update/operation-responses-before.adoc[opts=optional] [#adv_text_update-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_text_update/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/adv_text_update/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -4109,6 +3507,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -4118,120 +3517,102 @@ a| |=== - -// markup not found, no include::{specDir}paths/adv_text_update/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/adv_text_update/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/adv_text_update/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/adv_text_update/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/adv_text_update/operation-security-before.adoc[opts=optional] +include::{specDir}paths/adv_text_update/operation-security-before.adoc[opts=optional] [#adv_text_update-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/adv_text_update/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/adv_text_update/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/adv_text_update/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/adv_text_update/operation-security-after.adoc[opts=optional] +include::{specDir}paths/adv_text_update/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/adv_text_update/operation-security-after.adoc[opts=optional] include::{snippetDir}adv_text_update/http-request.adoc[opts=optional] +include::{snippetDir}adv_text_update/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}adv_text_update/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/adv_text_update/operation-end.adoc[opts=optional] +include::{specDir}paths/adv_text_update/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/adv_text_update/operation-after.adoc[opts=optional] - +include::{specDir}paths/adv_text_update/operation-after.adoc[opts=optional] //end::adv_text_update[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-List] = List :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:list_all[] xref:list_query[] -//tag::list_all[] - -// markup not found, no include::{specDir}paths/list_all/operation-before.adoc[opts=optional] +//tag::list_all[] +include::{specDir}paths/list_all/operation-before.adoc[opts=optional] [#list_all] = List All Functions :leveloffset: +1 -// markup not found, no include::{specDir}paths/list_all/operation-begin.adoc[opts=optional] - +include::{specDir}paths/list_all/operation-begin.adoc[opts=optional] .... GET /api/v1/list/functions .... - -// markup not found, no include::{specDir}paths/list_all/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/list_all/operation-description-before.adoc[opts=optional] [#list_all-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/list_all/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/list_all/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -4241,39 +3622,34 @@ The returned list can also be filtered — see [List Filtered Functions](#li If this API is run as a non-Administrator the results are filtered via RBAC to include only the function scopes the user has access to. -- +include::{specDir}paths/list_all/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/list_all/operation-description-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/list_all/operation-description-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/list_all/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/list_all/operation-description-after.adoc[opts=optional] +include::{specDir}paths/list_all/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/list_all/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/list_all/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/list_all/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/list_all/operation-responses-before.adoc[opts=optional] [#list_all-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/list_all/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/list_all/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -4285,6 +3661,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -4294,95 +3671,76 @@ a| |=== - -// markup not found, no include::{specDir}paths/list_all/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/list_all/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/list_all/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/list_all/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/list_all/operation-security-before.adoc[opts=optional] +include::{specDir}paths/list_all/operation-security-before.adoc[opts=optional] [#list_all-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/list_all/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/list_all/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-unscoped[] +| xref:security-Unscoped[] |=== - -// markup not found, no include::{specDir}paths/list_all/operation-security-end.adoc[opts=optional] +include::{specDir}paths/list_all/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/list_all/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/list_all/operation-security-after.adoc[opts=optional] include::{snippetDir}list_all/http-request.adoc[opts=optional] +include::{snippetDir}list_all/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}list_all/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/list_all/operation-end.adoc[opts=optional] +include::{specDir}paths/list_all/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/list_all/operation-after.adoc[opts=optional] - +include::{specDir}paths/list_all/operation-after.adoc[opts=optional] //end::list_all[] - //tag::list_query[] - -// markup not found, no include::{specDir}paths/list_query/operation-before.adoc[opts=optional] - +include::{specDir}paths/list_query/operation-before.adoc[opts=optional] [#list_query] = List Filtered Functions :leveloffset: +1 -// markup not found, no include::{specDir}paths/list_query/operation-begin.adoc[opts=optional] - +include::{specDir}paths/list_query/operation-begin.adoc[opts=optional] .... GET /api/v1/list/functions/query .... - -// markup not found, no include::{specDir}paths/list_query/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/list_query/operation-description-before.adoc[opts=optional] [#list_query-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/list_query/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/list_query/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -4396,30 +3754,25 @@ The returned list can be filtered by the following: If this API is run as a non-Administrator the results are filtered via RBAC to include only the function scopes the user has access to. -- +include::{specDir}paths/list_query/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/list_query/operation-description-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/list_query/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/list_query/operation-description-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/list_query/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/list_query/operation-parameters-before.adoc[opts=optional] [#list_query-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/list_query/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/list_query/operation-parameters-begin.adoc[opts=optional] [#list_query-query] .Query Parameters @@ -4430,11 +3783,8 @@ If this API is run as a non-Administrator the results are filtered via RBAC to i ¦ Name ¦ Description ¦ Schema a¦ *deployed* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- If `true`, returns the names of all deployed (or paused) functions. If `false`, returns the names of all undeployed functions. @@ -4444,13 +3794,9 @@ If `false`, returns the names of all undeployed functions. {blank} a¦ Boolean - a¦ *source_bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- The name of a bucket. Returns the names of Eventing functions in the cluster that have a source keyspace under the specified bucket. @@ -4460,13 +3806,9 @@ Returns the names of Eventing functions in the cluster that have a source keyspa {blank} a¦ String - a¦ *function_type* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- The function type. @@ -4483,29 +3825,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/list_query/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/list_query/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/list_query/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/list_query/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/list_query/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/list_query/operation-responses-before.adoc[opts=optional] [#list_query-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/list_query/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/list_query/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -4517,6 +3854,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -4526,147 +3864,121 @@ a| |=== - -// markup not found, no include::{specDir}paths/list_query/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/list_query/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/list_query/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/list_query/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/list_query/operation-security-before.adoc[opts=optional] +include::{specDir}paths/list_query/operation-security-before.adoc[opts=optional] [#list_query-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/list_query/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/list_query/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-unscoped[] +| xref:security-Unscoped[] |=== - -// markup not found, no include::{specDir}paths/list_query/operation-security-end.adoc[opts=optional] +include::{specDir}paths/list_query/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/list_query/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/list_query/operation-security-after.adoc[opts=optional] include::{snippetDir}list_query/http-request.adoc[opts=optional] +include::{snippetDir}list_query/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}list_query/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/list_query/operation-end.adoc[opts=optional] +include::{specDir}paths/list_query/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/list_query/operation-after.adoc[opts=optional] - +include::{specDir}paths/list_query/operation-after.adoc[opts=optional] //end::list_query[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Logging] = Logging :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:log_view[] -//tag::log_view[] - -// markup not found, no include::{specDir}paths/log_view/operation-before.adoc[opts=optional] +//tag::log_view[] +include::{specDir}paths/log_view/operation-before.adoc[opts=optional] [#log_view] = Get Log for a Function :leveloffset: +1 -// markup not found, no include::{specDir}paths/log_view/operation-begin.adoc[opts=optional] - +include::{specDir}paths/log_view/operation-begin.adoc[opts=optional] .... GET /getAppLog .... - -// markup not found, no include::{specDir}paths/log_view/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/log_view/operation-description-before.adoc[opts=optional] [#log_view-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/log_view/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/log_view/operation-description-begin.adoc[opts=optional] [markdown] -- Returns the most recent application log messages for the specified function. -- +include::{specDir}paths/log_view/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/log_view/operation-description-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/log_view/operation-description-after.adoc[opts=optional] +include::{specDir}paths/log_view/operation-description-after.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/log_view/operation-parameters-before.adoc[opts=optional] - +include::{specDir}paths/log_view/operation-parameters-before.adoc[opts=optional] [#log_view-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/log_view/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/log_view/operation-parameters-begin.adoc[opts=optional] [#log_view-query] .Query Parameters @@ -4677,11 +3989,8 @@ Returns the most recent application log messages for the specified function. ¦ Name ¦ Description ¦ Schema a¦ *name* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -4690,13 +3999,9 @@ The name of a function. {blank} a¦ String - a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -4706,13 +4011,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -4722,13 +4023,9 @@ The scope to which the function belongs. {blank} a¦ String - a¦ *aggregate* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- If `false`, the API accesses a single Eventing node. If `true`, the API accesses all Eventing nodes. @@ -4739,13 +4036,9 @@ If `true`, the API accesses all Eventing nodes. {blank} a¦ Boolean - a¦ *size* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- The approximate amount of logging information returned. When fetching from more than one Eventing node, the amount of logging information returned from each node is the `size` divided by the number of nodes. @@ -4760,29 +4053,24 @@ a¦ Integer |=== - - - -// markup not found, no include::{specDir}paths/log_view/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/log_view/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/log_view/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/log_view/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/log_view/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/log_view/operation-responses-before.adoc[opts=optional] [#log_view-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/log_view/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/log_view/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -4794,6 +4082,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -4803,120 +4092,102 @@ a| |=== - -// markup not found, no include::{specDir}paths/log_view/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/log_view/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/log_view/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/log_view/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/log_view/operation-security-before.adoc[opts=optional] +include::{specDir}paths/log_view/operation-security-before.adoc[opts=optional] [#log_view-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/log_view/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/log_view/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/log_view/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/log_view/operation-security-after.adoc[opts=optional] +include::{specDir}paths/log_view/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/log_view/operation-security-after.adoc[opts=optional] include::{snippetDir}log_view/http-request.adoc[opts=optional] +include::{snippetDir}log_view/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}log_view/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/log_view/operation-end.adoc[opts=optional] +include::{specDir}paths/log_view/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/log_view/operation-after.adoc[opts=optional] - +include::{specDir}paths/log_view/operation-after.adoc[opts=optional] //end::log_view[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-ServiceConfig] = Service Config :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:config_get[] xref:config_update[] -//tag::config_get[] - -// markup not found, no include::{specDir}paths/config_get/operation-before.adoc[opts=optional] +//tag::config_get[] +include::{specDir}paths/config_get/operation-before.adoc[opts=optional] [#config_get] = List Service Config :leveloffset: +1 -// markup not found, no include::{specDir}paths/config_get/operation-begin.adoc[opts=optional] - +include::{specDir}paths/config_get/operation-begin.adoc[opts=optional] .... GET /api/v1/config .... - -// markup not found, no include::{specDir}paths/config_get/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/config_get/operation-description-before.adoc[opts=optional] [#config_get-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/config_get/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/config_get/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -4932,8 +4203,7 @@ If a setting is not specified at the function scope level, the Eventing service You can also see the current values of the `enable_debugger` and `ram_quota` settings via the UI. -- - -// markup not found, no include::{specDir}paths/config_get/operation-description-end.adoc[opts=optional] +include::{specDir}paths/config_get/operation-description-end.adoc[opts=optional] @@ -4941,24 +4211,20 @@ You can also see the current values of the `enable_debugger` and `ram_quota` set .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/config_get/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/config_get/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/config_get/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/config_get/operation-parameters-before.adoc[opts=optional] [#config_get-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/config_get/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/config_get/operation-parameters-begin.adoc[opts=optional] [#config_get-query] .Query Parameters @@ -4969,11 +4235,8 @@ You can also see the current values of the `enable_debugger` and `ram_quota` set ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped configuration settings only. The bucket to which the configuration settings apply. @@ -4983,13 +4246,9 @@ The bucket to which the configuration settings apply. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped configuration settings only. The scope to which the configuration settings apply. @@ -5003,29 +4262,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/config_get/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/config_get/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/config_get/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/config_get/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/config_get/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/config_get/operation-responses-before.adoc[opts=optional] [#config_get-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/config_get/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/config_get/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -5047,97 +4301,82 @@ a| |=== - -// markup not found, no include::{specDir}paths/config_get/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/config_get/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-UnivConfig: -// markup not found, no include::{specDir}paths/config_get/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/config_get/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/config_get/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/config_get/operation-security-before.adoc[opts=optional] [#config_get-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/config_get/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/config_get/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/config_get/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/config_get/operation-security-after.adoc[opts=optional] +include::{specDir}paths/config_get/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/config_get/operation-security-after.adoc[opts=optional] include::{snippetDir}config_get/http-request.adoc[opts=optional] +include::{snippetDir}config_get/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}config_get/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/config_get/operation-end.adoc[opts=optional] +include::{specDir}paths/config_get/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/config_get/operation-after.adoc[opts=optional] - +include::{specDir}paths/config_get/operation-after.adoc[opts=optional] //end::config_get[] - //tag::config_update[] - -// markup not found, no include::{specDir}paths/config_update/operation-before.adoc[opts=optional] - +include::{specDir}paths/config_update/operation-before.adoc[opts=optional] [#config_update] = Modify Service Config :leveloffset: +1 -// markup not found, no include::{specDir}paths/config_update/operation-begin.adoc[opts=optional] - +include::{specDir}paths/config_update/operation-begin.adoc[opts=optional] .... POST /api/v1/config .... - -// markup not found, no include::{specDir}paths/config_update/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/config_update/operation-description-before.adoc[opts=optional] [#config_update-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/config_update/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/config_update/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -5156,8 +4395,7 @@ If a setting is not specified at the function scope level, the Eventing service You can also modify the `enable_debugger` and `ram_quota` settings via the UI. -- - -// markup not found, no include::{specDir}paths/config_update/operation-description-end.adoc[opts=optional] +include::{specDir}paths/config_update/operation-description-end.adoc[opts=optional] [#config_update-consumes] @@ -5165,24 +4403,20 @@ You can also modify the `enable_debugger` and `ram_quota` settings via the UI. * application/json -:leveloffset: -1 +:leveloffset: -1 include::{specDir}paths/config_update/operation-description-after.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/config_update/operation-parameters-before.adoc[opts=optional] - +include::{specDir}paths/config_update/operation-parameters-before.adoc[opts=optional] [#config_update-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/config_update/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/config_update/operation-parameters-begin.adoc[opts=optional] [#config_update-query] .Query Parameters @@ -5193,11 +4427,8 @@ include::{specDir}paths/config_update/operation-description-after.adoc[opts=opti ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped configuration settings only. The bucket to which the configuration settings apply. @@ -5207,13 +4438,9 @@ The bucket to which the configuration settings apply. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped configuration settings only. The scope to which the configuration settings apply. @@ -5225,9 +4452,6 @@ The scope to which the configuration settings apply. a¦ String |=== - - - [#config_update-body] .Body Parameter {blank} @@ -5237,13 +4461,10 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -An object providing the service configuration settings. + -- [%hardbreaks] @@ -5254,26 +4475,25 @@ a¦ xref:UnivConfig[] |=== -// markup not found, no include::{specDir}paths/config_update/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/config_update/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-UnivConfig: -// markup not found, no include::{specDir}paths/config_update/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/config_update/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/config_update/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/config_update/operation-responses-before.adoc[opts=optional] [#config_update-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/config_update/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/config_update/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -5285,6 +4505,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -5294,84 +4515,71 @@ a| |=== - -// markup not found, no include::{specDir}paths/config_update/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/config_update/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/config_update/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/config_update/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/config_update/operation-security-before.adoc[opts=optional] +include::{specDir}paths/config_update/operation-security-before.adoc[opts=optional] [#config_update-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/config_update/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/config_update/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/config_update/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/config_update/operation-security-after.adoc[opts=optional] +include::{specDir}paths/config_update/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/config_update/operation-security-after.adoc[opts=optional] include::{snippetDir}config_update/http-request.adoc[opts=optional] +include::{snippetDir}config_update/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}config_update/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/config_update/operation-end.adoc[opts=optional] +include::{specDir}paths/config_update/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/config_update/operation-after.adoc[opts=optional] - +include::{specDir}paths/config_update/operation-after.adoc[opts=optional] //end::config_update[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Statistics] = Statistics :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:stats_all[] @@ -5381,36 +4589,31 @@ xref:stats_latency[] xref:stats_reset[] -//tag::stats_all[] - -// markup not found, no include::{specDir}paths/stats_all/operation-before.adoc[opts=optional] +//tag::stats_all[] +include::{specDir}paths/stats_all/operation-before.adoc[opts=optional] [#stats_all] = Get All Statistics :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_all/operation-begin.adoc[opts=optional] - +include::{specDir}paths/stats_all/operation-begin.adoc[opts=optional] .... GET /api/v1/stats .... - -// markup not found, no include::{specDir}paths/stats_all/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/stats_all/operation-description-before.adoc[opts=optional] [#stats_all-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_all/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/stats_all/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -5420,30 +4623,25 @@ Retrieve all statistics for the node. If this API is run as a non-Administrator the results are filtered via RBAC to include only the function scopes the user has access to. -- +include::{specDir}paths/stats_all/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_all/operation-description-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/stats_all/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_all/operation-description-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/stats_all/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/stats_all/operation-parameters-before.adoc[opts=optional] [#stats_all-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_all/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/stats_all/operation-parameters-begin.adoc[opts=optional] [#stats_all-query] .Query Parameters @@ -5454,11 +4652,8 @@ If this API is run as a non-Administrator the results are filtered via RBAC to i ¦ Name ¦ Description ¦ Schema a¦ *type* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- Including this parameter returns the full statistics set, inclusive of events processing, events remaining, execution, failure, latency, worker PIDs and sequence processed. @@ -5474,29 +4669,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/stats_all/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/stats_all/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/stats_all/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/stats_all/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_all/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/stats_all/operation-responses-before.adoc[opts=optional] [#stats_all-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_all/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/stats_all/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -5508,6 +4698,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -5517,95 +4708,76 @@ a| |=== - -// markup not found, no include::{specDir}paths/stats_all/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/stats_all/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/stats_all/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/stats_all/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_all/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/stats_all/operation-security-before.adoc[opts=optional] [#stats_all-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_all/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/stats_all/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-unscoped[] +| xref:security-Unscoped[] |=== - -// markup not found, no include::{specDir}paths/stats_all/operation-security-end.adoc[opts=optional] +include::{specDir}paths/stats_all/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/stats_all/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/stats_all/operation-security-after.adoc[opts=optional] include::{snippetDir}stats_all/http-request.adoc[opts=optional] +include::{snippetDir}stats_all/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}stats_all/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/stats_all/operation-end.adoc[opts=optional] +include::{specDir}paths/stats_all/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/stats_all/operation-after.adoc[opts=optional] - +include::{specDir}paths/stats_all/operation-after.adoc[opts=optional] //end::stats_all[] - //tag::stats_execution[] - -// markup not found, no include::{specDir}paths/stats_execution/operation-before.adoc[opts=optional] - +include::{specDir}paths/stats_execution/operation-before.adoc[opts=optional] [#stats_execution] = Get Execution Statistics :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_execution/operation-begin.adoc[opts=optional] - +include::{specDir}paths/stats_execution/operation-begin.adoc[opts=optional] .... GET /getExecutionStats .... - -// markup not found, no include::{specDir}paths/stats_execution/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/stats_execution/operation-description-before.adoc[opts=optional] [#stats_execution-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_execution/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/stats_execution/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -5613,30 +4785,25 @@ Retrieve only execution statistics. This returns the subset of statistics for the node. -- +include::{specDir}paths/stats_execution/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_execution/operation-description-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/stats_execution/operation-description-after.adoc[opts=optional] - +include::{specDir}paths/stats_execution/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_execution/operation-parameters-before.adoc[opts=optional] - +include::{specDir}paths/stats_execution/operation-parameters-before.adoc[opts=optional] [#stats_execution-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_execution/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/stats_execution/operation-parameters-begin.adoc[opts=optional] [#stats_execution-query] .Query Parameters @@ -5647,11 +4814,8 @@ This returns the subset of statistics for the node. ¦ Name ¦ Description ¦ Schema a¦ *name* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -5660,13 +4824,9 @@ The name of a function. {blank} a¦ String - a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -5676,13 +4836,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -5696,29 +4852,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/stats_execution/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/stats_execution/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/stats_execution/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/stats_execution/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_execution/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/stats_execution/operation-responses-before.adoc[opts=optional] [#stats_execution-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_execution/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/stats_execution/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -5730,6 +4881,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -5739,97 +4891,81 @@ a| |=== - -// markup not found, no include::{specDir}paths/stats_execution/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/stats_execution/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/stats_execution/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/stats_execution/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_execution/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/stats_execution/operation-security-before.adoc[opts=optional] [#stats_execution-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_execution/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/stats_execution/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/stats_execution/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/stats_execution/operation-security-after.adoc[opts=optional] +include::{specDir}paths/stats_execution/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/stats_execution/operation-security-after.adoc[opts=optional] include::{snippetDir}stats_execution/http-request.adoc[opts=optional] +include::{snippetDir}stats_execution/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}stats_execution/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/stats_execution/operation-end.adoc[opts=optional] +include::{specDir}paths/stats_execution/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/stats_execution/operation-after.adoc[opts=optional] - +include::{specDir}paths/stats_execution/operation-after.adoc[opts=optional] //end::stats_execution[] - //tag::stats_failure[] - -// markup not found, no include::{specDir}paths/stats_failure/operation-before.adoc[opts=optional] - +include::{specDir}paths/stats_failure/operation-before.adoc[opts=optional] [#stats_failure] = Get Failure Statistics :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_failure/operation-begin.adoc[opts=optional] - +include::{specDir}paths/stats_failure/operation-begin.adoc[opts=optional] .... GET /getFailureStats .... - -// markup not found, no include::{specDir}paths/stats_failure/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/stats_failure/operation-description-before.adoc[opts=optional] [#stats_failure-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_failure/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/stats_failure/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -5837,30 +4973,25 @@ Retrieve only failure statistics. This returns the subset of statistics for the node. -- +include::{specDir}paths/stats_failure/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_failure/operation-description-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/stats_failure/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_failure/operation-description-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/stats_failure/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/stats_failure/operation-parameters-before.adoc[opts=optional] [#stats_failure-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_failure/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/stats_failure/operation-parameters-begin.adoc[opts=optional] [#stats_failure-query] .Query Parameters @@ -5871,11 +5002,8 @@ This returns the subset of statistics for the node. ¦ Name ¦ Description ¦ Schema a¦ *name* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -5884,13 +5012,9 @@ The name of a function. {blank} a¦ String - a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -5900,13 +5024,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -5920,29 +5040,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/stats_failure/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/stats_failure/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/stats_failure/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/stats_failure/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_failure/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/stats_failure/operation-responses-before.adoc[opts=optional] [#stats_failure-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_failure/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/stats_failure/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -5954,6 +5069,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -5963,97 +5079,81 @@ a| |=== - -// markup not found, no include::{specDir}paths/stats_failure/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/stats_failure/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/stats_failure/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/stats_failure/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_failure/operation-security-before.adoc[opts=optional] +include::{specDir}paths/stats_failure/operation-security-before.adoc[opts=optional] [#stats_failure-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_failure/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/stats_failure/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/stats_failure/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/stats_failure/operation-security-after.adoc[opts=optional] +include::{specDir}paths/stats_failure/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/stats_failure/operation-security-after.adoc[opts=optional] include::{snippetDir}stats_failure/http-request.adoc[opts=optional] +include::{snippetDir}stats_failure/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}stats_failure/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/stats_failure/operation-end.adoc[opts=optional] +include::{specDir}paths/stats_failure/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/stats_failure/operation-after.adoc[opts=optional] - +include::{specDir}paths/stats_failure/operation-after.adoc[opts=optional] //end::stats_failure[] - //tag::stats_latency[] - -// markup not found, no include::{specDir}paths/stats_latency/operation-before.adoc[opts=optional] - +include::{specDir}paths/stats_latency/operation-before.adoc[opts=optional] [#stats_latency] = Get Latency Statistics :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_latency/operation-begin.adoc[opts=optional] - +include::{specDir}paths/stats_latency/operation-begin.adoc[opts=optional] .... GET /getLatencyStats .... - -// markup not found, no include::{specDir}paths/stats_latency/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/stats_latency/operation-description-before.adoc[opts=optional] [#stats_latency-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_latency/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/stats_latency/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -6061,30 +5161,25 @@ Retrieve only latency statistics. This returns the subset of statistics for the node. -- +include::{specDir}paths/stats_latency/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_latency/operation-description-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/stats_latency/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_latency/operation-description-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/stats_latency/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/stats_latency/operation-parameters-before.adoc[opts=optional] [#stats_latency-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_latency/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/stats_latency/operation-parameters-begin.adoc[opts=optional] [#stats_latency-query] .Query Parameters @@ -6095,11 +5190,8 @@ This returns the subset of statistics for the node. ¦ Name ¦ Description ¦ Schema a¦ *name* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -6108,13 +5200,9 @@ The name of a function. {blank} a¦ String - a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -6124,13 +5212,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -6144,29 +5228,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/stats_latency/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/stats_latency/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/stats_latency/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/stats_latency/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_latency/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/stats_latency/operation-responses-before.adoc[opts=optional] [#stats_latency-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_latency/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/stats_latency/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -6178,6 +5257,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -6187,127 +5267,106 @@ a| |=== - -// markup not found, no include::{specDir}paths/stats_latency/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/stats_latency/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/stats_latency/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/stats_latency/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_latency/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/stats_latency/operation-security-before.adoc[opts=optional] [#stats_latency-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_latency/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/stats_latency/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/stats_latency/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/stats_latency/operation-security-after.adoc[opts=optional] +include::{specDir}paths/stats_latency/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/stats_latency/operation-security-after.adoc[opts=optional] include::{snippetDir}stats_latency/http-request.adoc[opts=optional] +include::{snippetDir}stats_latency/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}stats_latency/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/stats_latency/operation-end.adoc[opts=optional] +include::{specDir}paths/stats_latency/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/stats_latency/operation-after.adoc[opts=optional] - +include::{specDir}paths/stats_latency/operation-after.adoc[opts=optional] //end::stats_latency[] - //tag::stats_reset[] - -// markup not found, no include::{specDir}paths/stats_reset/operation-before.adoc[opts=optional] - +include::{specDir}paths/stats_reset/operation-before.adoc[opts=optional] [#stats_reset] = Reset Statistics :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_reset/operation-begin.adoc[opts=optional] - +include::{specDir}paths/stats_reset/operation-begin.adoc[opts=optional] .... GET /resetStatsCounters .... - -// markup not found, no include::{specDir}paths/stats_reset/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/stats_reset/operation-description-before.adoc[opts=optional] [#stats_reset-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_reset/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/stats_reset/operation-description-begin.adoc[opts=optional] [markdown] -- Resets statistics for the specified function. -- +include::{specDir}paths/stats_reset/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_reset/operation-description-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/stats_reset/operation-description-after.adoc[opts=optional] +include::{specDir}paths/stats_reset/operation-description-after.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/stats_reset/operation-parameters-before.adoc[opts=optional] - +include::{specDir}paths/stats_reset/operation-parameters-before.adoc[opts=optional] [#stats_reset-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_reset/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/stats_reset/operation-parameters-begin.adoc[opts=optional] [#stats_reset-query] .Query Parameters @@ -6318,11 +5377,8 @@ Resets statistics for the specified function. ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -6332,13 +5388,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -6348,13 +5400,9 @@ The scope to which the function belongs. {blank} a¦ String - a¦ *appName* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -6367,29 +5415,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/stats_reset/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/stats_reset/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/stats_reset/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/stats_reset/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_reset/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/stats_reset/operation-responses-before.adoc[opts=optional] [#stats_reset-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_reset/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/stats_reset/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -6401,6 +5444,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -6410,120 +5454,102 @@ a| |=== - -// markup not found, no include::{specDir}paths/stats_reset/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/stats_reset/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/stats_reset/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/stats_reset/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/stats_reset/operation-security-before.adoc[opts=optional] +include::{specDir}paths/stats_reset/operation-security-before.adoc[opts=optional] [#stats_reset-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/stats_reset/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/stats_reset/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/stats_reset/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/stats_reset/operation-security-after.adoc[opts=optional] +include::{specDir}paths/stats_reset/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/stats_reset/operation-security-after.adoc[opts=optional] include::{snippetDir}stats_reset/http-request.adoc[opts=optional] +include::{snippetDir}stats_reset/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}stats_reset/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/stats_reset/operation-end.adoc[opts=optional] +include::{specDir}paths/stats_reset/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/stats_reset/operation-after.adoc[opts=optional] - +include::{specDir}paths/stats_reset/operation-after.adoc[opts=optional] //end::stats_reset[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Status] = Status :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:status_all[] xref:status_function[] -//tag::status_all[] - -// markup not found, no include::{specDir}paths/status_all/operation-before.adoc[opts=optional] +//tag::status_all[] +include::{specDir}paths/status_all/operation-before.adoc[opts=optional] [#status_all] = View All Functions Status :leveloffset: +1 -// markup not found, no include::{specDir}paths/status_all/operation-begin.adoc[opts=optional] - +include::{specDir}paths/status_all/operation-begin.adoc[opts=optional] .... GET /api/v1/status .... - -// markup not found, no include::{specDir}paths/status_all/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/status_all/operation-description-before.adoc[opts=optional] [#status_all-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/status_all/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/status_all/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -6534,39 +5560,34 @@ There's no value of resuming; when resuming a paused eventing function, the `com If this API is run as a non-Administrator, the results are filtered via RBAC to include only the function scopes the user has access to. -- +include::{specDir}paths/status_all/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/status_all/operation-description-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/status_all/operation-description-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/status_all/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/status_all/operation-description-after.adoc[opts=optional] +include::{specDir}paths/status_all/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/status_all/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/status_all/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/status_all/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/status_all/operation-responses-before.adoc[opts=optional] [#status_all-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/status_all/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/status_all/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -6578,6 +5599,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -6587,95 +5609,76 @@ a| |=== - -// markup not found, no include::{specDir}paths/status_all/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/status_all/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/status_all/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/status_all/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/status_all/operation-security-before.adoc[opts=optional] +include::{specDir}paths/status_all/operation-security-before.adoc[opts=optional] [#status_all-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/status_all/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/status_all/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-unscoped[] +| xref:security-Unscoped[] |=== - -// markup not found, no include::{specDir}paths/status_all/operation-security-end.adoc[opts=optional] +include::{specDir}paths/status_all/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/status_all/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/status_all/operation-security-after.adoc[opts=optional] include::{snippetDir}status_all/http-request.adoc[opts=optional] +include::{snippetDir}status_all/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}status_all/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/status_all/operation-end.adoc[opts=optional] +include::{specDir}paths/status_all/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/status_all/operation-after.adoc[opts=optional] - +include::{specDir}paths/status_all/operation-after.adoc[opts=optional] //end::status_all[] - //tag::status_function[] - -// markup not found, no include::{specDir}paths/status_function/operation-before.adoc[opts=optional] - +include::{specDir}paths/status_function/operation-before.adoc[opts=optional] [#status_function] = View Function Status :leveloffset: +1 -// markup not found, no include::{specDir}paths/status_function/operation-begin.adoc[opts=optional] - +include::{specDir}paths/status_function/operation-begin.adoc[opts=optional] .... GET /api/v1/status/{function} .... - -// markup not found, no include::{specDir}paths/status_function/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/status_function/operation-description-before.adoc[opts=optional] [#status_function-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/status_function/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/status_function/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -6684,29 +5687,25 @@ It can have one of the following values: undeployed, deploying, deployed, undepl There's no value of resuming; when resuming a paused eventing function, the `composite_status` returns `deploying` until it reaches the deployed state. -- +include::{specDir}paths/status_function/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/status_function/operation-description-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/status_function/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/status_function/operation-description-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/status_function/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/status_function/operation-parameters-before.adoc[opts=optional] [#status_function-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/status_function/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/status_function/operation-parameters-begin.adoc[opts=optional] [#status_function-path] .Path Parameters @@ -6717,11 +5716,8 @@ There's no value of resuming; when resuming a paused eventing function, the `com ¦ Name ¦ Description ¦ Schema a¦ *function* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a function. -- @@ -6732,7 +5728,6 @@ The name of a function. a¦ String |=== - [#status_function-query] .Query Parameters {blank} @@ -6742,11 +5737,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The bucket to which the function belongs. @@ -6756,13 +5748,9 @@ The bucket to which the function belongs. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped functions only. The scope to which the function belongs. @@ -6776,29 +5764,24 @@ a¦ String |=== - - - -// markup not found, no include::{specDir}paths/status_function/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/status_function/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/status_function/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/status_function/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/status_function/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/status_function/operation-responses-before.adoc[opts=optional] [#status_function-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/status_function/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/status_function/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -6810,6 +5793,7 @@ a| [markdown] Success. -- a| + | 404 a| [markdown] -- @@ -6819,101 +5803,88 @@ a| |=== - -// markup not found, no include::{specDir}paths/status_function/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/status_function/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/status_function/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/status_function/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/status_function/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/status_function/operation-security-before.adoc[opts=optional] [#status_function-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/status_function/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/status_function/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scoped[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scoped[] -// markup not found, no include::{specDir}paths/status_function/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/status_function/operation-security-after.adoc[opts=optional] +include::{specDir}paths/status_function/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/status_function/operation-security-after.adoc[opts=optional] include::{snippetDir}status_function/http-request.adoc[opts=optional] +include::{snippetDir}status_function/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}status_function/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/status_function/operation-end.adoc[opts=optional] +include::{specDir}paths/status_function/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/status_function/operation-after.adoc[opts=optional] - +include::{specDir}paths/status_function/operation-after.adoc[opts=optional] //end::status_function[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 10 - +:count-models: 9 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:AddFunction[] xref:AddFunctions[] @@ -6928,35 +5899,32 @@ xref:UnivConfig[] endif::[] - include::{specDir}definitions/AddFunction/definition-before.adoc[opts=optional] - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-AddFunction[] [#AddFunction] +endif::show-AddFunction[] +ifndef::show-AddFunction[] +:leveloffset: +1 + +[discrete#AddFunction] +endif::show-AddFunction[] = Function Request :leveloffset: +1 -// markup not found, no include::{specDir}definitions/AddFunction/definition-begin.adoc[opts=optional] - +include::{specDir}definitions/AddFunction/definition-begin.adoc[opts=optional] .icon:bars[fw] Composite Schema {blank} //tag::AddFunction[] - - [cols="25,55,20",separator=¦] |=== ¦ One{nbsp}of{nbsp}... ¦ ¦ Schema a¦ -a¦ - -[markdown] +a¦ [markdown] -- include::index.adoc[tag=desc-handler_schema, opts=optional] -- @@ -6965,10 +5933,8 @@ include::index.adoc[tag=desc-handler_schema, opts=optional] {blank} a¦ xref:handler_schema[] -a¦ _or_ -a¦ - -[markdown] +a¦ or +a¦ [markdown] -- An array containing a single function definition object. -- @@ -6977,52 +5943,47 @@ An array containing a single function definition object. *Minimum items:* `1` *Maximum items:* `1` {blank} -a¦ xref:handler_schema[] - array - +a¦ xref:handler_schema[] array |=== //end::AddFunction[] - -// markup not found, no include::{specDir}definitions/AddFunction/definition-end.adoc[opts=optional] - +include::{specDir}definitions/AddFunction/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/AddFunction/definition-after.adoc[opts=optional] - - - +ifndef::show-AddFunction[] +:leveloffset: -1 +endif::show-AddFunction[] -// markup not found, no include::{specDir}definitions/AddFunctions/definition-before.adoc[opts=optional] +include::{specDir}definitions/AddFunction/definition-after.adoc[opts=optional] +include::{specDir}definitions/AddFunctions/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-AddFunctions[] [#AddFunctions] +endif::show-AddFunctions[] +ifndef::show-AddFunctions[] +:leveloffset: +1 + +[discrete#AddFunctions] +endif::show-AddFunctions[] = Functions Request :leveloffset: +1 -// markup not found, no include::{specDir}definitions/AddFunctions/definition-begin.adoc[opts=optional] - +include::{specDir}definitions/AddFunctions/definition-begin.adoc[opts=optional] .icon:bars[fw] Composite Schema {blank} //tag::AddFunctions[] - - [cols="25,55,20",separator=¦] |=== ¦ One{nbsp}of{nbsp}... ¦ ¦ Schema a¦ -a¦ - -[markdown] +a¦ [markdown] -- include::index.adoc[tag=desc-handler_schema, opts=optional] -- @@ -7031,10 +5992,8 @@ include::index.adoc[tag=desc-handler_schema, opts=optional] {blank} a¦ xref:handler_schema[] -a¦ _or_ -a¦ - -[markdown] +a¦ or +a¦ [markdown] -- An array containing one or more function definition objects. -- @@ -7042,36 +6001,42 @@ An array containing one or more function definition objects. [%hardbreaks] *Minimum items:* `1` {blank} -a¦ xref:handler_schema[] - array - +a¦ xref:handler_schema[] array |=== //end::AddFunctions[] - -// markup not found, no include::{specDir}definitions/AddFunctions/definition-end.adoc[opts=optional] - +include::{specDir}definitions/AddFunctions/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/AddFunctions/definition-after.adoc[opts=optional] - - - +ifndef::show-AddFunctions[] +:leveloffset: -1 +endif::show-AddFunctions[] -// markup not found, no include::{specDir}definitions/depcfg_schema/definition-before.adoc[opts=optional] +include::{specDir}definitions/AddFunctions/definition-after.adoc[opts=optional] +include::{specDir}definitions/depcfg_schema/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-depcfg_schema[] [#depcfg_schema] +endif::show-depcfg_schema[] +ifndef::show-depcfg_schema[] +:leveloffset: +1 + +[discrete#depcfg_schema] +endif::show-depcfg_schema[] = Deployment Config +ifdef::model-descriptions[] +//tag::desc-depcfg_schema[] +deployment configuration +//end::desc-depcfg_schema[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/depcfg_schema/definition-begin.adoc[opts=optional] +include::{specDir}definitions/depcfg_schema/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -7079,50 +6044,33 @@ endif::collapse-models[] //tag::depcfg_schema[] -ifdef::model-descriptions[] -//tag::desc-depcfg_schema[] -deployment configuration -//end::desc-depcfg_schema[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*buckets* + -_optional_ -a¦ - -[markdown] +a¦ *buckets* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} -a¦ xref:depcfg_schema_buckets_inner[] - array - -a¦ -*curl* + -_optional_ -a¦ - -[markdown] +a¦ xref:depcfg_schema_buckets_inner[] array +a¦ *curl* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} -a¦ xref:depcfg_schema_curl_inner[] - array - -a¦ -*metadata_bucket* + -_required_ -a¦ - -[markdown] +a¦ xref:depcfg_schema_curl_inner[] array +a¦ *metadata_bucket* + +required +a¦ [markdown] -- bucket to store eventing checkpoints and timers -- @@ -7131,13 +6079,9 @@ bucket to store eventing checkpoints and timers *Minimum length:* `1` {blank} a¦ String - -a¦ -*metadata_scope* + -_optional_ -a¦ - -[markdown] +a¦ *metadata_scope* + +optional +a¦ [markdown] -- scope to store eventing checkpoints and timers -- @@ -7145,13 +6089,9 @@ scope to store eventing checkpoints and timers [%hardbreaks] {blank} a¦ String - -a¦ -*metadata_collection* + -_optional_ -a¦ - -[markdown] +a¦ *metadata_collection* + +optional +a¦ [markdown] -- collection to store eventing checkpoints and timers -- @@ -7159,13 +6099,9 @@ collection to store eventing checkpoints and timers [%hardbreaks] {blank} a¦ String - -a¦ -*source_bucket* + -_required_ -a¦ - -[markdown] +a¦ *source_bucket* + +required +a¦ [markdown] -- bucket to listen to for document mutations -- @@ -7174,13 +6110,9 @@ bucket to listen to for document mutations *Minimum length:* `1` {blank} a¦ String - -a¦ -*source_scope* + -_optional_ -a¦ - -[markdown] +a¦ *source_scope* + +optional +a¦ [markdown] -- scope to listen to for document mutations -- @@ -7188,13 +6120,9 @@ scope to listen to for document mutations [%hardbreaks] {blank} a¦ String - -a¦ -*source_collection* + -_optional_ -a¦ - -[markdown] +a¦ *source_collection* + +optional +a¦ [markdown] -- collection to listen to for document mutations -- @@ -7202,20 +6130,16 @@ collection to listen to for document mutations [%hardbreaks] {blank} a¦ String - -a¦ -*constants* + -_optional_ -a¦ - -[markdown] +a¦ *constants* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} -a¦ xref:depcfg_schema_constants_inner[] - array +a¦ xref:depcfg_schema_constants_inner[] array |=== @@ -7223,28 +6147,31 @@ a¦ xref:depcfg_schema_constants_inner[] -// markup not found, no include::{specDir}definitions/depcfg_schema/definition-end.adoc[opts=optional] - +include::{specDir}definitions/depcfg_schema/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/depcfg_schema/definition-after.adoc[opts=optional] - - - +ifndef::show-depcfg_schema[] +:leveloffset: -1 +endif::show-depcfg_schema[] -// markup not found, no include::{specDir}definitions/depcfg_schema_constants_inner/definition-before.adoc[opts=optional] +include::{specDir}definitions/depcfg_schema/definition-after.adoc[opts=optional] +include::{specDir}definitions/depcfg_schema_constants_inner/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-depcfg_schema_constants_inner[] [#depcfg_schema_constants_inner] +endif::show-depcfg_schema_constants_inner[] +ifndef::show-depcfg_schema_constants_inner[] +:leveloffset: +1 + +[discrete#depcfg_schema_constants_inner] +endif::show-depcfg_schema_constants_inner[] = Deployment Constants :leveloffset: +1 -// markup not found, no include::{specDir}definitions/depcfg_schema_constants_inner/definition-begin.adoc[opts=optional] +include::{specDir}definitions/depcfg_schema_constants_inner/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -7252,17 +6179,13 @@ endif::collapse-models[] //tag::depcfg_schema_constants_inner[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*value* + -_required_ -a¦ - -[markdown] +a¦ *value* + +required +a¦ [markdown] -- alias name of the constant binding -- @@ -7273,13 +6196,9 @@ alias name of the constant binding *Maximum length:* `64` {blank} a¦ String - -a¦ -*literal* + -_required_ -a¦ - -[markdown] +a¦ *literal* + +required +a¦ [markdown] -- literal value bound to the alias name -- @@ -7295,28 +6214,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/depcfg_schema_constants_inner/definition-end.adoc[opts=optional] - +include::{specDir}definitions/depcfg_schema_constants_inner/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/depcfg_schema_constants_inner/definition-after.adoc[opts=optional] - - - +ifndef::show-depcfg_schema_constants_inner[] +:leveloffset: -1 +endif::show-depcfg_schema_constants_inner[] -// markup not found, no include::{specDir}definitions/depcfg_schema_buckets_inner/definition-before.adoc[opts=optional] +include::{specDir}definitions/depcfg_schema_constants_inner/definition-after.adoc[opts=optional] +include::{specDir}definitions/depcfg_schema_buckets_inner/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-depcfg_schema_buckets_inner[] [#depcfg_schema_buckets_inner] +endif::show-depcfg_schema_buckets_inner[] +ifndef::show-depcfg_schema_buckets_inner[] +:leveloffset: +1 + +[discrete#depcfg_schema_buckets_inner] +endif::show-depcfg_schema_buckets_inner[] = Deployment Keyspace :leveloffset: +1 -// markup not found, no include::{specDir}definitions/depcfg_schema_buckets_inner/definition-begin.adoc[opts=optional] +include::{specDir}definitions/depcfg_schema_buckets_inner/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -7324,17 +6246,13 @@ endif::collapse-models[] //tag::depcfg_schema_buckets_inner[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*alias* + -_required_ -a¦ - -[markdown] +a¦ *alias* + +required +a¦ [markdown] -- symbolic name used in code to refer to this binding -- @@ -7345,13 +6263,9 @@ symbolic name used in code to refer to this binding *Maximum length:* `64` {blank} a¦ String - -a¦ -*bucket_name* + -_required_ -a¦ - -[markdown] +a¦ *bucket_name* + +required +a¦ [markdown] -- name of the bucket this binding maps to -- @@ -7360,13 +6274,9 @@ name of the bucket this binding maps to *Minimum length:* `1` {blank} a¦ String - -a¦ -*scope_name* + -_optional_ -a¦ - -[markdown] +a¦ *scope_name* + +optional +a¦ [markdown] -- name of the scope this binding maps to -- @@ -7374,13 +6284,9 @@ name of the scope this binding maps to [%hardbreaks] {blank} a¦ String - -a¦ -*collection_name* + -_optional_ -a¦ - -[markdown] +a¦ *collection_name* + +optional +a¦ [markdown] -- name of the collection this binding maps to -- @@ -7388,13 +6294,9 @@ name of the collection this binding maps to [%hardbreaks] {blank} a¦ String - -a¦ -*access* + -_required_ -a¦ - -[markdown] +a¦ *access* + +required +a¦ [markdown] -- bucket access level (read or read+write) -- @@ -7410,28 +6312,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/depcfg_schema_buckets_inner/definition-end.adoc[opts=optional] - +include::{specDir}definitions/depcfg_schema_buckets_inner/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/depcfg_schema_buckets_inner/definition-after.adoc[opts=optional] - - - +ifndef::show-depcfg_schema_buckets_inner[] +:leveloffset: -1 +endif::show-depcfg_schema_buckets_inner[] -// markup not found, no include::{specDir}definitions/depcfg_schema_curl_inner/definition-before.adoc[opts=optional] +include::{specDir}definitions/depcfg_schema_buckets_inner/definition-after.adoc[opts=optional] +include::{specDir}definitions/depcfg_schema_curl_inner/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-depcfg_schema_curl_inner[] [#depcfg_schema_curl_inner] +endif::show-depcfg_schema_curl_inner[] +ifndef::show-depcfg_schema_curl_inner[] +:leveloffset: +1 + +[discrete#depcfg_schema_curl_inner] +endif::show-depcfg_schema_curl_inner[] = Deployment URL :leveloffset: +1 -// markup not found, no include::{specDir}definitions/depcfg_schema_curl_inner/definition-begin.adoc[opts=optional] +include::{specDir}definitions/depcfg_schema_curl_inner/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -7439,17 +6344,13 @@ endif::collapse-models[] //tag::depcfg_schema_curl_inner[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*hostname* + -_required_ -a¦ - -[markdown] +a¦ *hostname* + +required +a¦ [markdown] -- full URL (including any path) that this binding connects -- @@ -7459,13 +6360,9 @@ full URL (including any path) that this binding connects *Minimum length:* `1` {blank} a¦ URI (uri) - -a¦ -*value* + -_required_ -a¦ - -[markdown] +a¦ *value* + +required +a¦ [markdown] -- symbolic name used in code to refer to this binding -- @@ -7476,13 +6373,9 @@ symbolic name used in code to refer to this binding *Maximum length:* `64` {blank} a¦ String - -a¦ -*auth_type* + -_required_ -a¦ - -[markdown] +a¦ *auth_type* + +required +a¦ [markdown] -- http authentication method to use with this endpoint -- @@ -7491,13 +6384,9 @@ http authentication method to use with this endpoint *Values:* `"no-auth"`, `"basic"`, `"bearer"`, `"digest"` {blank} a¦ String - -a¦ -*username* + -_optional_ -a¦ - -[markdown] +a¦ *username* + +optional +a¦ [markdown] -- username for http auth methods that use it -- @@ -7505,13 +6394,9 @@ username for http auth methods that use it [%hardbreaks] {blank} a¦ String - -a¦ -*password* + -_optional_ -a¦ - -[markdown] +a¦ *password* + +optional +a¦ [markdown] -- password for http auth methods that use it -- @@ -7519,13 +6404,9 @@ password for http auth methods that use it [%hardbreaks] {blank} a¦ String - -a¦ -*bearer_key* + -_optional_ -a¦ - -[markdown] +a¦ *bearer_key* + +optional +a¦ [markdown] -- bearer key for bearer auth -- @@ -7533,13 +6414,9 @@ bearer key for bearer auth [%hardbreaks] {blank} a¦ String - -a¦ -*allow_cookies* + -_required_ -a¦ - -[markdown] +a¦ *allow_cookies* + +required +a¦ [markdown] -- allow cookies on the session -- @@ -7547,13 +6424,9 @@ allow cookies on the session [%hardbreaks] {blank} a¦ Boolean - -a¦ -*validate_ssl_certificate* + -_required_ -a¦ - -[markdown] +a¦ *validate_ssl_certificate* + +required +a¦ [markdown] -- validate remote server certificate using OS mechanisms -- @@ -7568,28 +6441,37 @@ a¦ Boolean -// markup not found, no include::{specDir}definitions/depcfg_schema_curl_inner/definition-end.adoc[opts=optional] - +include::{specDir}definitions/depcfg_schema_curl_inner/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/depcfg_schema_curl_inner/definition-after.adoc[opts=optional] - - - +ifndef::show-depcfg_schema_curl_inner[] +:leveloffset: -1 +endif::show-depcfg_schema_curl_inner[] -// markup not found, no include::{specDir}definitions/handler_schema/definition-before.adoc[opts=optional] +include::{specDir}definitions/depcfg_schema_curl_inner/definition-after.adoc[opts=optional] +include::{specDir}definitions/handler_schema/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-handler_schema[] [#handler_schema] +endif::show-handler_schema[] +ifndef::show-handler_schema[] +:leveloffset: +1 + +[discrete#handler_schema] +endif::show-handler_schema[] = Function Definition +ifdef::model-descriptions[] +//tag::desc-handler_schema[] +An object which defines a function. +//end::desc-handler_schema[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/handler_schema/definition-begin.adoc[opts=optional] +include::{specDir}definitions/handler_schema/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -7597,22 +6479,13 @@ endif::collapse-models[] //tag::handler_schema[] -ifdef::model-descriptions[] -//tag::desc-handler_schema[] -An object which defines a function. -//end::desc-handler_schema[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*appcode* + -_required_ -a¦ - -[markdown] +a¦ *appcode* + +required +a¦ [markdown] -- handler code -- @@ -7621,13 +6494,9 @@ handler code *Minimum length:* `1` {blank} a¦ String - -a¦ -*depcfg* + -_required_ -a¦ - -[markdown] +a¦ *depcfg* + +required +a¦ [markdown] -- include::index.adoc[tag=desc-depcfg_schema, opts=optional] -- @@ -7635,13 +6504,9 @@ include::index.adoc[tag=desc-depcfg_schema, opts=optional] [%hardbreaks] {blank} a¦ xref:depcfg_schema[] - -a¦ -*version* + -_required_ -a¦ - -[markdown] +a¦ *version* + +required +a¦ [markdown] -- authoring tool. use 'external' if authored or edited outside eventing ui -- @@ -7650,13 +6515,9 @@ authoring tool. use 'external' if authored or edited outside eventing ui *Pattern:* `+++/^evt-[5-7].[0-9]+.[0-9]+-[0-9]{4}-(ee|ce)$/+++` {blank} a¦ String - -a¦ -*enforce_schema* + -_optional_ -a¦ - -[markdown] +a¦ *enforce_schema* + +optional +a¦ [markdown] -- enforces stricter validation for all settings and configuration fields. -- @@ -7664,13 +6525,9 @@ enforces stricter validation for all settings and configuration fields. [%hardbreaks] {blank} a¦ Boolean - -a¦ -*handleruuid* + -_optional_ -a¦ - -[markdown] +a¦ *handleruuid* + +optional +a¦ [markdown] -- unique id of the the handler. generated by server -- @@ -7679,29 +6536,21 @@ unique id of the the handler. generated by server *Minimum:* `0` {blank} a¦ Integer - -a¦ -*function_instance_id* + -_optional_ -a¦ - -[markdown] +a¦ *function_instance_id* + +optional +a¦ [markdown] -- unique id of the deployment of the handler. generated by server -- [%hardbreaks] -*Minimum length:* `0` {blank} a¦ String - -a¦ -*appname* + -_required_ -a¦ - -[markdown] +a¦ *appname* + +required +a¦ [markdown] -- + -- [%hardbreaks] @@ -7710,13 +6559,9 @@ a¦ *Maximum length:* `100` {blank} a¦ String - -a¦ -*settings* + -_required_ -a¦ - -[markdown] +a¦ *settings* + +required +a¦ [markdown] -- include::index.adoc[tag=desc-settings_schema, opts=optional] -- @@ -7724,13 +6569,9 @@ include::index.adoc[tag=desc-settings_schema, opts=optional] [%hardbreaks] {blank} a¦ xref:settings_schema[] - -a¦ -*function_scope* + -_optional_ -a¦ - -[markdown] +a¦ *function_scope* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-function_scope_schema, opts=optional] -- @@ -7745,28 +6586,37 @@ a¦ xref:function_scope_schema[] -// markup not found, no include::{specDir}definitions/handler_schema/definition-end.adoc[opts=optional] - +include::{specDir}definitions/handler_schema/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/handler_schema/definition-after.adoc[opts=optional] - - - +ifndef::show-handler_schema[] +:leveloffset: -1 +endif::show-handler_schema[] -// markup not found, no include::{specDir}definitions/function_scope_schema/definition-before.adoc[opts=optional] +include::{specDir}definitions/handler_schema/definition-after.adoc[opts=optional] +include::{specDir}definitions/function_scope_schema/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-function_scope_schema[] [#function_scope_schema] +endif::show-function_scope_schema[] +ifndef::show-function_scope_schema[] +:leveloffset: +1 + +[discrete#function_scope_schema] +endif::show-function_scope_schema[] = Function Scope +ifdef::model-descriptions[] +//tag::desc-function_scope_schema[] +function scope +//end::desc-function_scope_schema[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/function_scope_schema/definition-begin.adoc[opts=optional] +include::{specDir}definitions/function_scope_schema/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -7774,22 +6624,13 @@ endif::collapse-models[] //tag::function_scope_schema[] -ifdef::model-descriptions[] -//tag::desc-function_scope_schema[] -function scope -//end::desc-function_scope_schema[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*bucket* + -_required_ -a¦ - -[markdown] +a¦ *bucket* + +required +a¦ [markdown] -- bucket to which function belongs -- @@ -7798,13 +6639,9 @@ bucket to which function belongs *Minimum length:* `1` {blank} a¦ String - -a¦ -*scope* + -_required_ -a¦ - -[markdown] +a¦ *scope* + +required +a¦ [markdown] -- scope to which function belongs -- @@ -7820,28 +6657,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/function_scope_schema/definition-end.adoc[opts=optional] - +include::{specDir}definitions/function_scope_schema/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/function_scope_schema/definition-after.adoc[opts=optional] - - - +ifndef::show-function_scope_schema[] +:leveloffset: -1 +endif::show-function_scope_schema[] -// markup not found, no include::{specDir}definitions/settings_schema/definition-before.adoc[opts=optional] +include::{specDir}definitions/function_scope_schema/definition-after.adoc[opts=optional] +include::{specDir}definitions/settings_schema/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-settings_schema[] [#settings_schema] +endif::show-settings_schema[] +ifndef::show-settings_schema[] +:leveloffset: +1 + +[discrete#settings_schema] +endif::show-settings_schema[] = Function Settings :leveloffset: +1 -// markup not found, no include::{specDir}definitions/settings_schema/definition-begin.adoc[opts=optional] +include::{specDir}definitions/settings_schema/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -7849,17 +6689,13 @@ endif::collapse-models[] //tag::settings_schema[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*cpp_worker_thread_count* + -_optional_ -a¦ - -[markdown] +a¦ *cpp_worker_thread_count* + +optional +a¦ [markdown] -- number of threads each worker utilizes -- @@ -7868,13 +6704,9 @@ number of threads each worker utilizes *Minimum:* `1` {blank} a¦ Integer - -a¦ -*dcp_stream_boundary* + -_optional_ -a¦ - -[markdown] +a¦ *dcp_stream_boundary* + +optional +a¦ [markdown] -- indicates where to start dcp stream from (beginning of time, present point) 'from_prior' is deprecated in 6.6.2 -- @@ -7883,13 +6715,9 @@ indicates where to start dcp stream from (beginning of time, present point) 'fro *Values:* `"everything"`, `"from_now"` {blank} a¦ String - -a¦ -*deployment_status* + -_optional_ -a¦ - -[markdown] +a¦ *deployment_status* + +optional +a¦ [markdown] -- indicates if the function is deployed. true=deployed, false=undeployed -- @@ -7897,13 +6725,9 @@ indicates if the function is deployed. true=deployed, false=undeployed [%hardbreaks] {blank} a¦ Boolean - -a¦ -*description* + -_optional_ -a¦ - -[markdown] +a¦ *description* + +optional +a¦ [markdown] -- free form text for user to describe the handler. no functional role -- @@ -7911,13 +6735,9 @@ free form text for user to describe the handler. no functional role [%hardbreaks] {blank} a¦ String - -a¦ -*execution_timeout* + -_optional_ -a¦ - -[markdown] +a¦ *execution_timeout* + +optional +a¦ [markdown] -- maximum time the handler can run before it is forcefully terminated (in seconds) -- @@ -7926,13 +6746,9 @@ maximum time the handler can run before it is forcefully terminated (in seconds) *Minimum:* `1` {blank} a¦ Integer - -a¦ -*cursor_checkpoint_timeout* + -_optional_ -a¦ - -[markdown] +a¦ *cursor_checkpoint_timeout* + +optional +a¦ [markdown] -- The maximum time the checkpoint writer can run before it's forcefully terminated (in seconds). -- @@ -7941,13 +6757,9 @@ The maximum time the checkpoint writer can run before it's forcefully terminated *Minimum:* `1` {blank} a¦ Integer - -a¦ -*on_deploy_timeout* + -_optional_ -a¦ - -[markdown] +a¦ *on_deploy_timeout* + +optional +a¦ [markdown] -- maximum time the OnDeploy handler can run before it is terminated (in seconds) -- @@ -7956,13 +6768,9 @@ maximum time the OnDeploy handler can run before it is terminated (in seconds) *Minimum:* `1` {blank} a¦ Integer - -a¦ -*language_compatibility* + -_optional_ -a¦ - -[markdown] +a¦ *language_compatibility* + +optional +a¦ [markdown] -- eventing language version this handler assumes in terms of syntax and behavior -- @@ -7971,13 +6779,9 @@ eventing language version this handler assumes in terms of syntax and behavior *Values:* `"6.6.2"`, `"6.0.0"`, `"6.5.0"`, `"7.2.0"` {blank} a¦ String - -a¦ -*lcb_inst_capacity* + -_optional_ -a¦ - -[markdown] +a¦ *lcb_inst_capacity* + +optional +a¦ [markdown] -- maximum number of libcouchbase connections that may be opened and pooled -- @@ -7986,13 +6790,9 @@ maximum number of libcouchbase connections that may be opened and pooled *Minimum:* `1` {blank} a¦ Integer - -a¦ -*lcb_retry_count* + -_optional_ -a¦ - -[markdown] +a¦ *lcb_retry_count* + +optional +a¦ [markdown] -- number of retries of retriable libcouchbase failures. 0 keeps trying till execution_timeout -- @@ -8001,13 +6801,9 @@ number of retries of retriable libcouchbase failures. 0 keeps trying till execut *Minimum:* `0` {blank} a¦ Integer - -a¦ -*lcb_timeout* + -_optional_ -a¦ - -[markdown] +a¦ *lcb_timeout* + +optional +a¦ [markdown] -- maximum time the lcb command is waited until completion before we terminate the request(in seconds) -- @@ -8016,13 +6812,9 @@ maximum time the lcb command is waited until completion before we terminate the *Minimum:* `1` {blank} a¦ Integer - -a¦ -*log_level* + -_optional_ -a¦ - -[markdown] +a¦ *log_level* + +optional +a¦ [markdown] -- level of detail in system logging -- @@ -8031,13 +6823,9 @@ level of detail in system logging *Values:* `"INFO"`, `"ERROR"`, `"WARNING"`, `"DEBUG"`, `"TRACE"` {blank} a¦ String - -a¦ -*n1ql_consistency* + -_optional_ -a¦ - -[markdown] +a¦ *n1ql_consistency* + +optional +a¦ [markdown] -- consistency level used by n1ql statements in the handler -- @@ -8046,13 +6834,9 @@ consistency level used by n1ql statements in the handler *Values:* `"none"`, `"request"` {blank} a¦ String - -a¦ -*num_timer_partitions* + -_optional_ -a¦ - -[markdown] +a¦ *num_timer_partitions* + +optional +a¦ [markdown] -- number of timer shards. defaults to number of vbuckets -- @@ -8061,13 +6845,9 @@ number of timer shards. defaults to number of vbuckets *Values:* `1`, `2`, `4`, `8`, `16`, `32`, `64`, `128`, `256`, `512`, `1024` {blank} a¦ Integer - -a¦ -*processing_status* + -_optional_ -a¦ - -[markdown] +a¦ *processing_status* + +optional +a¦ [markdown] -- indicates if the function is running (i.e., not paused). true=running, false=paused -- @@ -8075,13 +6855,9 @@ indicates if the function is running (i.e., not paused). true=running, false=pau [%hardbreaks] {blank} a¦ Boolean - -a¦ -*sock_batch_size* + -_optional_ -a¦ - -[markdown] +a¦ *sock_batch_size* + +optional +a¦ [markdown] -- batch size for messages from producer to consumer. normally, this must not be specified -- @@ -8090,13 +6866,9 @@ batch size for messages from producer to consumer. normally, this must not be sp *Minimum:* `1` {blank} a¦ Integer - -a¦ -*tick_duration* + -_optional_ -a¦ - -[markdown] +a¦ *tick_duration* + +optional +a¦ [markdown] -- duration to log stats from this handler, in milliseconds -- @@ -8104,13 +6876,9 @@ duration to log stats from this handler, in milliseconds [%hardbreaks] {blank} a¦ Integer - -a¦ -*timer_context_size* + -_optional_ -a¦ - -[markdown] +a¦ *timer_context_size* + +optional +a¦ [markdown] -- size limit of timer context object -- @@ -8120,13 +6888,9 @@ size limit of timer context object *Maximum:* `20971520` {blank} a¦ Integer - -a¦ -*user_prefix* + -_optional_ -a¦ - -[markdown] +a¦ *user_prefix* + +optional +a¦ [markdown] -- key prefix for all data stored in metadata by this handler -- @@ -8135,13 +6899,9 @@ key prefix for all data stored in metadata by this handler *Minimum length:* `1` {blank} a¦ String - -a¦ -*worker_count* + -_optional_ -a¦ - -[markdown] +a¦ *worker_count* + +optional +a¦ [markdown] -- number of worker processes handler utilizes on each eventing node -- @@ -8150,13 +6910,9 @@ number of worker processes handler utilizes on each eventing node *Minimum:* `1` {blank} a¦ Integer - -a¦ -*n1ql_prepare_all* + -_optional_ -a¦ - -[markdown] +a¦ *n1ql_prepare_all* + +optional +a¦ [markdown] -- automatically prepare all n1ql statements in the handler -- @@ -8164,43 +6920,29 @@ automatically prepare all n1ql statements in the handler [%hardbreaks] {blank} a¦ Boolean - -a¦ -*handler_headers* + -_optional_ -a¦ - -[markdown] +a¦ *handler_headers* + +optional +a¦ [markdown] -- code to automatically prepend to top of handler code -- [%hardbreaks] {blank} -a¦ String - array - -a¦ -*handler_footers* + -_optional_ -a¦ - -[markdown] +a¦ String array +a¦ *handler_footers* + +optional +a¦ [markdown] -- code to automatically append to bottom of handler code -- [%hardbreaks] {blank} -a¦ String - array - -a¦ -*enable_applog_rotation* + -_optional_ -a¦ - -[markdown] +a¦ String array +a¦ *enable_applog_rotation* + +optional +a¦ [markdown] -- enable rotating this handlers log() message files -- @@ -8208,13 +6950,9 @@ enable rotating this handlers log() message files [%hardbreaks] {blank} a¦ Boolean - -a¦ -*app_log_dir* + -_optional_ -a¦ - -[markdown] +a¦ *app_log_dir* + +optional +a¦ [markdown] -- directory to write content of log() message files -- @@ -8222,13 +6960,9 @@ directory to write content of log() message files [%hardbreaks] {blank} a¦ String - -a¦ -*app_log_max_size* + -_optional_ -a¦ - -[markdown] +a¦ *app_log_max_size* + +optional +a¦ [markdown] -- rotate logs when file grows to this size in bytes approximately -- @@ -8237,13 +6971,9 @@ rotate logs when file grows to this size in bytes approximately *Minimum:* `1024` {blank} a¦ Integer - -a¦ -*app_log_max_files* + -_optional_ -a¦ - -[markdown] +a¦ *app_log_max_files* + +optional +a¦ [markdown] -- number of log() message files to retain when rotating -- @@ -8252,13 +6982,9 @@ number of log() message files to retain when rotating *Minimum:* `1` {blank} a¦ Integer - -a¦ -*checkpoint_interval* + -_optional_ -a¦ - -[markdown] +a¦ *checkpoint_interval* + +optional +a¦ [markdown] -- number of seconds before writing a progress checkpoint -- @@ -8267,13 +6993,9 @@ number of seconds before writing a progress checkpoint *Minimum:* `1` {blank} a¦ Integer - -a¦ -*bucket_cache_size* + -_optional_ -a¦ - -[markdown] +a¦ *bucket_cache_size* + +optional +a¦ [markdown] -- maximum size in bytes the bucket cache can grow to -- @@ -8282,13 +7004,9 @@ maximum size in bytes the bucket cache can grow to *Minimum:* `20971520` {blank} a¦ Integer - -a¦ -*bucket_cache_age* + -_optional_ -a¦ - -[markdown] +a¦ *bucket_cache_age* + +optional +a¦ [markdown] -- time in milliseconds after which a cached bucket object is considered stale -- @@ -8297,13 +7015,9 @@ time in milliseconds after which a cached bucket object is considered stale *Minimum:* `1` {blank} a¦ Integer - -a¦ -*curl_max_allowed_resp_size* + -_optional_ -a¦ - -[markdown] +a¦ *curl_max_allowed_resp_size* + +optional +a¦ [markdown] -- maximum allowable curl call response in 'MegaBytes'. Setting the value to 0 lifts the upper limit off. This parameters affects v8 engine stability since it defines the maximum amount of heap space acquired by a curl call -- @@ -8311,13 +7025,9 @@ maximum allowable curl call response in 'MegaBytes'. Setting the value to 0 lift [%hardbreaks] {blank} a¦ Integer - -a¦ -*allow_transaction_mutations* + -_optional_ -a¦ - -[markdown] +a¦ *allow_transaction_mutations* + +optional +a¦ [markdown] -- allow staged transaction mutations -- @@ -8325,13 +7035,9 @@ allow staged transaction mutations [%hardbreaks] {blank} a¦ Boolean - -a¦ -*allow_sync_documents* + -_optional_ -a¦ - -[markdown] +a¦ *allow_sync_documents* + +optional +a¦ [markdown] -- Specifies whether the function allows Sync Gateway mutations. @@ -8347,13 +7053,9 @@ You must ensure that none of the documents which contain your own working data h [%hardbreaks] {blank} a¦ Boolean - -a¦ -*cursor_aware* + -_optional_ -a¦ - -[markdown] +a¦ *cursor_aware* + +optional +a¦ [markdown] -- Specifies whether the function suppresses potential duplicate mutations caused by App Services or Sync Gateway book-keeping. @@ -8365,13 +7067,9 @@ Enabling this setting may have a noticeable effect on the performance of the Eve [%hardbreaks] {blank} a¦ Boolean - -a¦ -*high_seq_check_interval* + -_optional_ -a¦ - -[markdown] +a¦ *high_seq_check_interval* + +optional +a¦ [markdown] -- number of milliseconds before checking for high seq number -- @@ -8379,13 +7077,9 @@ number of milliseconds before checking for high seq number [%hardbreaks] {blank} a¦ Integer - -a¦ -*max_unacked_bytes* + -_optional_ -a¦ - -[markdown] +a¦ *max_unacked_bytes* + +optional +a¦ [markdown] -- max MBs to wait to send more bytes to c++ side -- @@ -8393,13 +7087,9 @@ max MBs to wait to send more bytes to c++ side [%hardbreaks] {blank} a¦ Integer - -a¦ -*max_unacked_count* + -_optional_ -a¦ - -[markdown] +a¦ *max_unacked_count* + +optional +a¦ [markdown] -- max number of messages on c++ side -- @@ -8407,13 +7097,9 @@ max number of messages on c++ side [%hardbreaks] {blank} a¦ Integer - -a¦ -*message_flush_time* + -_optional_ -a¦ - -[markdown] +a¦ *message_flush_time* + +optional +a¦ [markdown] -- number of milliseconds before sending message to c++ side -- @@ -8421,13 +7107,9 @@ number of milliseconds before sending message to c++ side [%hardbreaks] {blank} a¦ Integer - -a¦ -*max_parallel_vb* + -_optional_ -a¦ - -[markdown] +a¦ *max_parallel_vb* + +optional +a¦ [markdown] -- number of parallel vb request per cpp thread -- @@ -8442,28 +7124,31 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/settings_schema/definition-end.adoc[opts=optional] - +include::{specDir}definitions/settings_schema/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/settings_schema/definition-after.adoc[opts=optional] - - - +ifndef::show-settings_schema[] +:leveloffset: -1 +endif::show-settings_schema[] -// markup not found, no include::{specDir}definitions/UnivConfig/definition-before.adoc[opts=optional] +include::{specDir}definitions/settings_schema/definition-after.adoc[opts=optional] +include::{specDir}definitions/UnivConfig/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-UnivConfig[] [#UnivConfig] +endif::show-UnivConfig[] +ifndef::show-UnivConfig[] +:leveloffset: +1 + +[discrete#UnivConfig] +endif::show-UnivConfig[] = Service Config :leveloffset: +1 -// markup not found, no include::{specDir}definitions/UnivConfig/definition-begin.adoc[opts=optional] +include::{specDir}definitions/UnivConfig/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -8471,17 +7156,13 @@ endif::collapse-models[] //tag::UnivConfig[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*ram_quota* + -_optional_ -a¦ - -[markdown] +a¦ *ram_quota* + +optional +a¦ [markdown] -- The memory allocation for the Eventing Service, per node. @@ -8493,13 +7174,9 @@ This setting is only available globally. *Example:* `512` {blank} a¦ Integer - -a¦ -*enable_curl* + -_optional_ -a¦ - -[markdown] +a¦ *enable_curl* + +optional +a¦ [markdown] -- Enables the Eventing curl function. For details, see [cURL](/server/8.0/eventing/eventing-curl-spec.html). @@ -8510,13 +7187,9 @@ This setting is available globally or at the function scope level. [%hardbreaks] {blank} a¦ Boolean - -a¦ -*enable_debugger* + -_optional_ -a¦ - -[markdown] +a¦ *enable_debugger* + +optional +a¦ [markdown] -- Enables the Eventing service debugger. For details, see [Debugging and Diagnosability](/server/8.0/eventing/eventing-debugging-and-diagnosability.html). @@ -8528,13 +7201,9 @@ This setting is available globally or at the function scope level. *Default:* `false` {blank} a¦ Boolean - -a¦ -*cursor_limit* + -_optional_ -a¦ - -[markdown] +a¦ *cursor_limit* + +optional +a¦ [markdown] -- The maximum number of cursor-aware Eventing functions that can coexist on a given source keyspace. (A cursor-aware Eventing function is one for which the `cursor_aware` setting is `true`.) @@ -8552,10 +7221,8 @@ This setting is only available globally. *Maximum:* `20` {blank} a¦ Integer - -a¦ -*num_nodes_running* + -_optional_ +a¦ *num_nodes_running* + +optional a¦ [.status]##Couchbase Server 8.0## [markdown] @@ -8580,26 +7247,26 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/UnivConfig/definition-end.adoc[opts=optional] - +include::{specDir}definitions/UnivConfig/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/UnivConfig/definition-after.adoc[opts=optional] - +ifndef::show-UnivConfig[] +:leveloffset: -1 +endif::show-UnivConfig[] +include::{specDir}definitions/UnivConfig/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] - +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -8609,18 +7276,14 @@ a¦ Integer include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/Global/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/Global/security-scheme-before.adoc[opts=optional] - - -[[security-global]] +[[security-Global]] = Global :leveloffset: +1 -// markup not found, no include::{specDir}security/Global/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Global/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -8632,29 +7295,22 @@ This is the default function scope for all functions after an upgrade from a pri -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/Global/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Global/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/Global/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/Global/security-scheme-after.adoc[opts=optional] - - +include::{specDir}security/Scoped/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/Scoped/security-scheme-before.adoc[opts=optional] - - -[[security-scoped]] +[[security-Scoped]] = Scoped :leveloffset: +1 -// markup not found, no include::{specDir}security/Scoped/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Scoped/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -8665,29 +7321,22 @@ You can quote the REST call on the command line to escape the `&` and `?` charac -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/Scoped/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Scoped/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/Scoped/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/Scoped/security-scheme-after.adoc[opts=optional] +include::{specDir}security/Unscoped/security-scheme-before.adoc[opts=optional] - - - -// markup not found, no include::{specDir}security/Unscoped/security-scheme-before.adoc[opts=optional] - - -[[security-unscoped]] +[[security-Unscoped]] = Unscoped :leveloffset: +1 -// markup not found, no include::{specDir}security/Unscoped/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Unscoped/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -8696,16 +7345,13 @@ The action is fully determined by the username and password credentials passed t -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/Unscoped/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Unscoped/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/Unscoped/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/Unscoped/security-scheme-after.adoc[opts=optional] @@ -8713,8 +7359,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - -// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] +include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/fts-rest-advanced/pages/index.adoc b/docs/modules/fts-rest-advanced/pages/index.adoc index fc2b307c..674111fd 100644 --- a/docs/modules/fts-rest-advanced/pages/index.adoc +++ b/docs/modules/fts-rest-advanced/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbase/cbft :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -32,7 +31,7 @@ These APIs enable you to manage and query Search index partitions and to specify [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -67,7 +66,6 @@ The host name or IP address of a node running the Search Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -83,31 +81,26 @@ The Search Service REST port. Use `18094` for secure access. |=== - -// markup not found, no include::{specDir}overview/document-end.adoc[opts=optional] +include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}overview/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 3 - +:count-apis: 2 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -117,62 +110,52 @@ xref:tag-Quota[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Definition] = Definition :leveloffset: +1 -ifeval::["Operations for Search index partition definition." != ""] Operations for Search index partition definition. endif::[] -ifeval::["Operations for Search index partition definition." == ""] -**{toc-title}** -endif::[] -endif::[] + [%hardbreaks] xref:getPartition[] xref:getPartitionName[] -//tag::getPartition[] - -// markup not found, no include::{specDir}paths/getPartition/operation-before.adoc[opts=optional] +//tag::getPartition[] +include::{specDir}paths/getPartition/operation-before.adoc[opts=optional] [#getPartition] = Get Index Partition Information :leveloffset: +1 -// markup not found, no include::{specDir}paths/getPartition/operation-begin.adoc[opts=optional] - +include::{specDir}paths/getPartition/operation-begin.adoc[opts=optional] .... GET /api/pindex .... - -// markup not found, no include::{specDir}paths/getPartition/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/getPartition/operation-description-before.adoc[opts=optional] [#getPartition-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/getPartition/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/getPartition/operation-description-begin.adoc[opts=optional] [markdown] -- Get information about a Search index partition. -- - -// markup not found, no include::{specDir}paths/getPartition/operation-description-end.adoc[opts=optional] +include::{specDir}paths/getPartition/operation-description-end.adoc[opts=optional] @@ -180,33 +163,29 @@ Get information about a Search index partition. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/getPartition/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/getPartition/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/getPartition/operation-description-after.adoc[opts=optional] +include::{specDir}paths/getPartition/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getPartition/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/getPartition/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getPartition/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/getPartition/operation-responses-before.adoc[opts=optional] [#getPartition-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/getPartition/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/getPartition/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -219,127 +198,104 @@ A JSON object containing the Search index partition information. -- a| xref:indexPartition[] - |=== - -// markup not found, no include::{specDir}paths/getPartition/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/getPartition/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-indexPartition: -// markup not found, no include::{specDir}paths/getPartition/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/getPartition/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getPartition/operation-security-before.adoc[opts=optional] +include::{specDir}paths/getPartition/operation-security-before.adoc[opts=optional] [#getPartition-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/getPartition/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/getPartition/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-read[] +| xref:security-Read[] |=== - -// markup not found, no include::{specDir}paths/getPartition/operation-security-end.adoc[opts=optional] +include::{specDir}paths/getPartition/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/getPartition/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getPartition/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}getPartition/http-request.adoc[opts=optional] - +include::{snippetDir}getPartition/http-request.adoc[opts=optional] include::{snippetDir}getPartition/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/getPartition/operation-end.adoc[opts=optional] +include::{specDir}paths/getPartition/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/getPartition/operation-after.adoc[opts=optional] - +include::{specDir}paths/getPartition/operation-after.adoc[opts=optional] //end::getPartition[] - //tag::getPartitionName[] - -// markup not found, no include::{specDir}paths/getPartitionName/operation-before.adoc[opts=optional] - +include::{specDir}paths/getPartitionName/operation-before.adoc[opts=optional] [#getPartitionName] = Get Index Partition by Name :leveloffset: +1 -// markup not found, no include::{specDir}paths/getPartitionName/operation-begin.adoc[opts=optional] - +include::{specDir}paths/getPartitionName/operation-begin.adoc[opts=optional] .... GET /api/pindex/{pindexName} .... - -// markup not found, no include::{specDir}paths/getPartitionName/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/getPartitionName/operation-description-before.adoc[opts=optional] [#getPartitionName-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/getPartitionName/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/getPartitionName/operation-description-begin.adoc[opts=optional] [markdown] -- Get information about a specific Search index partition by name. -- +include::{specDir}paths/getPartitionName/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getPartitionName/operation-description-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/getPartitionName/operation-description-after.adoc[opts=optional] - +include::{specDir}paths/getPartitionName/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getPartitionName/operation-parameters-before.adoc[opts=optional] - +include::{specDir}paths/getPartitionName/operation-parameters-before.adoc[opts=optional] [#getPartitionName-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/getPartitionName/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/getPartitionName/operation-parameters-begin.adoc[opts=optional] [#getPartitionName-path] .Path Parameters @@ -350,11 +306,8 @@ Get information about a specific Search index partition by name. ¦ Name ¦ Description ¦ Schema a¦ *pindexName* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index partition. -- @@ -367,30 +320,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/getPartitionName/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/getPartitionName/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/getPartitionName/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/getPartitionName/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getPartitionName/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/getPartitionName/operation-responses-before.adoc[opts=optional] [#getPartitionName-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/getPartitionName/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/getPartitionName/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -405,126 +352,104 @@ a| |=== - -// markup not found, no include::{specDir}paths/getPartitionName/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/getPartitionName/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/getPartitionName/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/getPartitionName/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getPartitionName/operation-security-before.adoc[opts=optional] +include::{specDir}paths/getPartitionName/operation-security-before.adoc[opts=optional] [#getPartitionName-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/getPartitionName/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/getPartitionName/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-read[] +| xref:security-Read[] |=== - -// markup not found, no include::{specDir}paths/getPartitionName/operation-security-end.adoc[opts=optional] +include::{specDir}paths/getPartitionName/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/getPartitionName/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getPartitionName/operation-security-after.adoc[opts=optional] - - +include::{snippetDir}getPartitionName/http-request.adoc[opts=optional] -// markup not found, no include::{snippetDir}getPartitionName/http-request.adoc[opts=optional] +include::{snippetDir}getPartitionName/http-response.adoc[opts=optional] - -// markup not found, no include::{snippetDir}getPartitionName/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/getPartitionName/operation-end.adoc[opts=optional] +include::{specDir}paths/getPartitionName/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/getPartitionName/operation-after.adoc[opts=optional] - +include::{specDir}paths/getPartitionName/operation-after.adoc[opts=optional] //end::getPartitionName[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Query] = Query :leveloffset: +1 -ifeval::["Operations for querying Search index partitions." != ""] Operations for querying Search index partitions. endif::[] -ifeval::["Operations for querying Search index partitions." == ""] -**{toc-title}** -endif::[] -endif::[] + [%hardbreaks] xref:getPartitionCount[] xref:queryPartition[] -//tag::getPartitionCount[] - -// markup not found, no include::{specDir}paths/getPartitionCount/operation-before.adoc[opts=optional] +//tag::getPartitionCount[] +include::{specDir}paths/getPartitionCount/operation-before.adoc[opts=optional] [#getPartitionCount] = Get Index Partition Document Count :leveloffset: +1 -// markup not found, no include::{specDir}paths/getPartitionCount/operation-begin.adoc[opts=optional] - +include::{specDir}paths/getPartitionCount/operation-begin.adoc[opts=optional] .... GET /api/pindex/{pindexName}/count .... - -// markup not found, no include::{specDir}paths/getPartitionCount/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/getPartitionCount/operation-description-before.adoc[opts=optional] [#getPartitionCount-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/getPartitionCount/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/getPartitionCount/operation-description-begin.adoc[opts=optional] [markdown] -- Get the document count of a specific Search index partition. -- - -// markup not found, no include::{specDir}paths/getPartitionCount/operation-description-end.adoc[opts=optional] +include::{specDir}paths/getPartitionCount/operation-description-end.adoc[opts=optional] @@ -532,23 +457,20 @@ Get the document count of a specific Search index partition. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/getPartitionCount/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/getPartitionCount/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getPartitionCount/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/getPartitionCount/operation-parameters-before.adoc[opts=optional] [#getPartitionCount-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/getPartitionCount/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/getPartitionCount/operation-parameters-begin.adoc[opts=optional] [#getPartitionCount-path] .Path Parameters @@ -559,11 +481,8 @@ Get the document count of a specific Search index partition. ¦ Name ¦ Description ¦ Schema a¦ *pindexName* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index partition. -- @@ -576,30 +495,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/getPartitionCount/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/getPartitionCount/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/getPartitionCount/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/getPartitionCount/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getPartitionCount/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/getPartitionCount/operation-responses-before.adoc[opts=optional] [#getPartitionCount-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/getPartitionCount/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/getPartitionCount/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -612,106 +525,86 @@ The Search Service returns a response that includes the status `ok`. -- a| xref:DocumentCount[] - |=== - -// markup not found, no include::{specDir}paths/getPartitionCount/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/getPartitionCount/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-DocumentCount: -// markup not found, no include::{specDir}paths/getPartitionCount/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/getPartitionCount/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getPartitionCount/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/getPartitionCount/operation-security-before.adoc[opts=optional] [#getPartitionCount-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/getPartitionCount/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/getPartitionCount/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-read[] +| xref:security-Read[] |=== - -// markup not found, no include::{specDir}paths/getPartitionCount/operation-security-end.adoc[opts=optional] +include::{specDir}paths/getPartitionCount/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/getPartitionCount/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getPartitionCount/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}getPartitionCount/http-request.adoc[opts=optional] - +include::{snippetDir}getPartitionCount/http-request.adoc[opts=optional] -// markup not found, no include::{snippetDir}getPartitionCount/http-response.adoc[opts=optional] +include::{snippetDir}getPartitionCount/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/getPartitionCount/operation-end.adoc[opts=optional] +include::{specDir}paths/getPartitionCount/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/getPartitionCount/operation-after.adoc[opts=optional] - +include::{specDir}paths/getPartitionCount/operation-after.adoc[opts=optional] //end::getPartitionCount[] - //tag::queryPartition[] - -// markup not found, no include::{specDir}paths/queryPartition/operation-before.adoc[opts=optional] - +include::{specDir}paths/queryPartition/operation-before.adoc[opts=optional] [#queryPartition] = Query Index Partition :leveloffset: +1 -// markup not found, no include::{specDir}paths/queryPartition/operation-begin.adoc[opts=optional] - +include::{specDir}paths/queryPartition/operation-begin.adoc[opts=optional] .... POST /api/pindex/{pindexName}/query .... - -// markup not found, no include::{specDir}paths/queryPartition/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/queryPartition/operation-description-before.adoc[opts=optional] [#queryPartition-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/queryPartition/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/queryPartition/operation-description-begin.adoc[opts=optional] [markdown] -- Execute a query against a specific Search index partition by name. -- - -// markup not found, no include::{specDir}paths/queryPartition/operation-description-end.adoc[opts=optional] +include::{specDir}paths/queryPartition/operation-description-end.adoc[opts=optional] [#queryPartition-consumes] @@ -722,23 +615,20 @@ Execute a query against a specific Search index partition by name. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/queryPartition/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/queryPartition/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/queryPartition/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/queryPartition/operation-parameters-before.adoc[opts=optional] [#queryPartition-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/queryPartition/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/queryPartition/operation-parameters-begin.adoc[opts=optional] [#queryPartition-path] .Path Parameters @@ -749,11 +639,8 @@ Execute a query against a specific Search index partition by name. ¦ Name ¦ Description ¦ Schema a¦ *pindexName* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index partition. -- @@ -764,10 +651,6 @@ The name of the Search index partition. a¦ String |=== - - - - [#queryPartition-body] .Body Parameter {blank} @@ -777,13 +660,10 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -A JSON object to define the settings for your Search query. For more information about how to create a Search query JSON object, see [Search Request JSON Properties](../search/search-request-params.html). + -- [%hardbreaks] @@ -794,26 +674,25 @@ a¦ xref:QueryRequest[] |=== -// markup not found, no include::{specDir}paths/queryPartition/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/queryPartition/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-QueryRequest: -// markup not found, no include::{specDir}paths/queryPartition/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/queryPartition/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/queryPartition/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/queryPartition/operation-responses-before.adoc[opts=optional] [#queryPartition-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/queryPartition/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/queryPartition/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -826,128 +705,106 @@ The response object has a status section that must be checked for every request. -- a| xref:QueryResponse[] - |=== - -// markup not found, no include::{specDir}paths/queryPartition/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/queryPartition/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-QueryResponse: -// markup not found, no include::{specDir}paths/queryPartition/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/queryPartition/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/queryPartition/operation-security-before.adoc[opts=optional] +include::{specDir}paths/queryPartition/operation-security-before.adoc[opts=optional] [#queryPartition-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/queryPartition/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/queryPartition/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-write[] +| xref:security-Write[] |=== - -// markup not found, no include::{specDir}paths/queryPartition/operation-security-end.adoc[opts=optional] +include::{specDir}paths/queryPartition/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/queryPartition/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/queryPartition/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}queryPartition/http-request.adoc[opts=optional] +include::{snippetDir}queryPartition/http-request.adoc[opts=optional] +include::{snippetDir}queryPartition/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}queryPartition/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/queryPartition/operation-end.adoc[opts=optional] +include::{specDir}paths/queryPartition/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/queryPartition/operation-after.adoc[opts=optional] - +include::{specDir}paths/queryPartition/operation-after.adoc[opts=optional] //end::queryPartition[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Quota] = Quota :leveloffset: +1 -ifeval::["Operations for managing Search memory quota." != ""] Operations for managing Search memory quota. endif::[] -ifeval::["Operations for managing Search memory quota." == ""] -**{toc-title}** -endif::[] -endif::[] + [%hardbreaks] xref:setFtsMemoryQuota[] -//tag::setFtsMemoryQuota[] +//tag::setFtsMemoryQuota[] -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-before.adoc[opts=optional] - +include::{specDir}paths/setFtsMemoryQuota/operation-before.adoc[opts=optional] [#setFtsMemoryQuota] = Set Search Memory Quota :leveloffset: +1 -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-begin.adoc[opts=optional] - +include::{specDir}paths/setFtsMemoryQuota/operation-begin.adoc[opts=optional] .... POST /pools/default .... - -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/setFtsMemoryQuota/operation-description-before.adoc[opts=optional] [#setFtsMemoryQuota-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/setFtsMemoryQuota/operation-description-begin.adoc[opts=optional] [markdown] -- Sets the memory quota for the Search Service. -- - -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-description-end.adoc[opts=optional] +include::{specDir}paths/setFtsMemoryQuota/operation-description-end.adoc[opts=optional] [#setFtsMemoryQuota-consumes] @@ -955,26 +812,20 @@ Sets the memory quota for the Search Service. * application/x-www-form-urlencoded -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/setFtsMemoryQuota/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/setFtsMemoryQuota/operation-parameters-before.adoc[opts=optional] [#setFtsMemoryQuota-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-parameters-begin.adoc[opts=optional] - - - - +include::{specDir}paths/setFtsMemoryQuota/operation-parameters-begin.adoc[opts=optional] [#setFtsMemoryQuota-form] .Form Parameters @@ -985,16 +836,14 @@ Sets the memory quota for the Search Service. ¦ Name ¦ Description ¦ Schema a¦ *ftsMemoryQuota* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- The memory quota for the Search service. -- [%hardbreaks] +*Example:* `56` {blank} a¦ Integer @@ -1002,27 +851,24 @@ a¦ Integer |=== - -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/setFtsMemoryQuota/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/setFtsMemoryQuota/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/setFtsMemoryQuota/operation-responses-before.adoc[opts=optional] [#setFtsMemoryQuota-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/setFtsMemoryQuota/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1037,99 +883,83 @@ a| |=== - -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/setFtsMemoryQuota/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/setFtsMemoryQuota/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-security-before.adoc[opts=optional] +include::{specDir}paths/setFtsMemoryQuota/operation-security-before.adoc[opts=optional] [#setFtsMemoryQuota-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/setFtsMemoryQuota/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-manage[] +| xref:security-Manage[] |=== - -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-security-end.adoc[opts=optional] +include::{specDir}paths/setFtsMemoryQuota/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/setFtsMemoryQuota/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}setFtsMemoryQuota/http-request.adoc[opts=optional] +include::{snippetDir}setFtsMemoryQuota/http-request.adoc[opts=optional] +include::{snippetDir}setFtsMemoryQuota/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}setFtsMemoryQuota/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-end.adoc[opts=optional] +include::{specDir}paths/setFtsMemoryQuota/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-after.adoc[opts=optional] - +include::{specDir}paths/setFtsMemoryQuota/operation-after.adoc[opts=optional] //end::setFtsMemoryQuota[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] +include::{specDir}paths/document-after.adoc[opts=optional] - -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] - +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 6 - +:count-models: 5 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:DocumentCount[] xref:indexPartition[] @@ -1140,19 +970,21 @@ xref:QueryResponse[] endif::[] +include::{specDir}definitions/DocumentCount/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/DocumentCount/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-DocumentCount[] [#DocumentCount] +endif::show-DocumentCount[] +ifndef::show-DocumentCount[] +:leveloffset: +1 + +[discrete#DocumentCount] +endif::show-DocumentCount[] = Document Count :leveloffset: +1 -// markup not found, no include::{specDir}definitions/DocumentCount/definition-begin.adoc[opts=optional] +include::{specDir}definitions/DocumentCount/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1160,17 +992,13 @@ endif::collapse-models[] //tag::DocumentCount[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the operation. -- @@ -1178,13 +1006,9 @@ The status of the operation. [%hardbreaks] {blank} a¦ String - -a¦ -*count* + -_optional_ -a¦ - -[markdown] +a¦ *count* + +optional +a¦ [markdown] -- The document count for the specified index. -- @@ -1199,28 +1023,31 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/DocumentCount/definition-end.adoc[opts=optional] - +include::{specDir}definitions/DocumentCount/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/DocumentCount/definition-after.adoc[opts=optional] - - - +ifndef::show-DocumentCount[] +:leveloffset: -1 +endif::show-DocumentCount[] -// markup not found, no include::{specDir}definitions/indexPartition/definition-before.adoc[opts=optional] +include::{specDir}definitions/DocumentCount/definition-after.adoc[opts=optional] +include::{specDir}definitions/indexPartition/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-indexPartition[] [#indexPartition] +endif::show-indexPartition[] +ifndef::show-indexPartition[] +:leveloffset: +1 + +[discrete#indexPartition] +endif::show-indexPartition[] = Index Partitions :leveloffset: +1 -// markup not found, no include::{specDir}definitions/indexPartition/definition-begin.adoc[opts=optional] +include::{specDir}definitions/indexPartition/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1228,17 +1055,13 @@ endif::collapse-models[] //tag::indexPartition[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*pindexes* + -_optional_ -a¦ - -[markdown] +a¦ *pindexes* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-indexPartitionPIndex, opts=optional] -- @@ -1246,13 +1069,9 @@ include::index.adoc[tag=desc-indexPartitionPIndex, opts=optional] [%hardbreaks] {blank} a¦ xref:indexPartitionPIndex[] - -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the request. -- @@ -1267,28 +1086,37 @@ a¦ String -// markup not found, no include::{specDir}definitions/indexPartition/definition-end.adoc[opts=optional] - +include::{specDir}definitions/indexPartition/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/indexPartition/definition-after.adoc[opts=optional] - - - +ifndef::show-indexPartition[] +:leveloffset: -1 +endif::show-indexPartition[] -// markup not found, no include::{specDir}definitions/indexPartitionPIndex/definition-before.adoc[opts=optional] +include::{specDir}definitions/indexPartition/definition-after.adoc[opts=optional] +include::{specDir}definitions/indexPartitionPIndex/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-indexPartitionPIndex[] [#indexPartitionPIndex] +endif::show-indexPartitionPIndex[] +ifndef::show-indexPartitionPIndex[] +:leveloffset: +1 + +[discrete#indexPartitionPIndex] +endif::show-indexPartitionPIndex[] = Index Partitions Wrapper +ifdef::model-descriptions[] +//tag::desc-indexPartitionPIndex[] +An object containing information about 1 or more Search index partitions. +//end::desc-indexPartitionPIndex[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/indexPartitionPIndex/definition-begin.adoc[opts=optional] +include::{specDir}definitions/indexPartitionPIndex/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1296,23 +1124,14 @@ endif::collapse-models[] //tag::indexPartitionPIndex[] -ifdef::model-descriptions[] -//tag::desc-indexPartitionPIndex[] -An object containing information about 1 or more Search index partitions. -//end::desc-indexPartitionPIndex[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ - -_additional + -property_ -a¦ - -[markdown] +additional + +property +a¦ [markdown] -- include::index.adoc[tag=desc-indexPartitionPIndexInner, opts=optional] -- @@ -1327,28 +1146,38 @@ a¦ xref:indexPartitionPIndexInner[] -// markup not found, no include::{specDir}definitions/indexPartitionPIndex/definition-end.adoc[opts=optional] - +include::{specDir}definitions/indexPartitionPIndex/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/indexPartitionPIndex/definition-after.adoc[opts=optional] - - - +ifndef::show-indexPartitionPIndex[] +:leveloffset: -1 +endif::show-indexPartitionPIndex[] -// markup not found, no include::{specDir}definitions/indexPartitionPIndexInner/definition-before.adoc[opts=optional] +include::{specDir}definitions/indexPartitionPIndex/definition-after.adoc[opts=optional] +include::{specDir}definitions/indexPartitionPIndexInner/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-indexPartitionPIndexInner[] [#indexPartitionPIndexInner] +endif::show-indexPartitionPIndexInner[] +ifndef::show-indexPartitionPIndexInner[] +:leveloffset: +1 + +[discrete#indexPartitionPIndexInner] +endif::show-indexPartitionPIndexInner[] = Index Partition +ifdef::model-descriptions[] +//tag::desc-indexPartitionPIndexInner[] +An object containing information about a single Search index partition. +The name of the property is the name of the Search index partition. +//end::desc-indexPartitionPIndexInner[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/indexPartitionPIndexInner/definition-begin.adoc[opts=optional] +include::{specDir}definitions/indexPartitionPIndexInner/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1356,23 +1185,13 @@ endif::collapse-models[] //tag::indexPartitionPIndexInner[] -ifdef::model-descriptions[] -//tag::desc-indexPartitionPIndexInner[] -An object containing information about a single Search index partition. -The name of the property is the name of the Search index partition. -//end::desc-indexPartitionPIndexInner[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*indexName* + -_optional_ -a¦ - -[markdown] +a¦ *indexName* + +optional +a¦ [markdown] -- The name of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -1381,13 +1200,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*indexParams* + -_optional_ -a¦ - -[markdown] +a¦ *indexParams* + +optional +a¦ [markdown] -- The Search index's type identifier, type mappings, and analyzers. For more information, see [Params Object](../search/search-index-params.html#params). @@ -1396,13 +1211,9 @@ For more information, see [Params Object](../search/search-index-params.html#par [%hardbreaks] {blank} a¦ Object - -a¦ -*indexType* + -_optional_ -a¦ - -[markdown] +a¦ *indexType* + +optional +a¦ [markdown] -- The type of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -1411,13 +1222,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*indexUUID* + -_optional_ -a¦ - -[markdown] +a¦ *indexUUID* + +optional +a¦ [markdown] -- The UUID of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -1426,13 +1233,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*name* + -_optional_ -a¦ - -[markdown] +a¦ *name* + +optional +a¦ [markdown] -- The name of the Search index partition. -- @@ -1440,13 +1243,9 @@ The name of the Search index partition. [%hardbreaks] {blank} a¦ String - -a¦ -*sourceName* + -_optional_ -a¦ - -[markdown] +a¦ *sourceName* + +optional +a¦ [markdown] -- The name of the bucket where the Search index is stored. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -1455,13 +1254,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*sourceParams* + -_optional_ -a¦ - -[markdown] +a¦ *sourceParams* + +optional +a¦ [markdown] -- Advanced settings for Search index behavior. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -1470,26 +1265,19 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ Object - -a¦ -*sourcePartitions* + -_optional_ -a¦ - -[markdown] +a¦ *sourcePartitions* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*sourceType* + -_optional_ -a¦ - -[markdown] +a¦ *sourceType* + +optional +a¦ [markdown] -- The type of the bucket where the Search index is stored. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -1498,13 +1286,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*sourceUUID* + -_optional_ -a¦ - -[markdown] +a¦ *sourceUUID* + +optional +a¦ [markdown] -- The UUID of the bucket where the Search index is stored. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -1513,13 +1297,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*uuid* + -_optional_ -a¦ - -[markdown] +a¦ *uuid* + +optional +a¦ [markdown] -- The UUID of the Search index partition. -- @@ -1534,28 +1314,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/indexPartitionPIndexInner/definition-end.adoc[opts=optional] - +include::{specDir}definitions/indexPartitionPIndexInner/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/indexPartitionPIndexInner/definition-after.adoc[opts=optional] - - - +ifndef::show-indexPartitionPIndexInner[] +:leveloffset: -1 +endif::show-indexPartitionPIndexInner[] -// markup not found, no include::{specDir}definitions/QueryRequest/definition-before.adoc[opts=optional] +include::{specDir}definitions/indexPartitionPIndexInner/definition-after.adoc[opts=optional] +include::{specDir}definitions/QueryRequest/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-QueryRequest[] [#QueryRequest] +endif::show-QueryRequest[] +ifndef::show-QueryRequest[] +:leveloffset: +1 + +[discrete#QueryRequest] +endif::show-QueryRequest[] = Query Request :leveloffset: +1 -// markup not found, no include::{specDir}definitions/QueryRequest/definition-begin.adoc[opts=optional] +include::{specDir}definitions/QueryRequest/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1563,17 +1346,13 @@ endif::collapse-models[] //tag::QueryRequest[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*query* + -_optional_ -a¦ - -[markdown] +a¦ *query* + +optional +a¦ [markdown] -- An object that contains the properties for one of the supported query types. For more information, see [Query Object](../search/search-request-params.html#query-object). @@ -1582,13 +1361,9 @@ For more information, see [Query Object](../search/search-request-params.html#qu [%hardbreaks] {blank} a¦ Object - -a¦ -*knn* + -_optional_ -a¦ - -[markdown] +a¦ *knn* + +optional +a¦ [markdown] -- An array that contains objects that describe a Vector Search query. For more information, see [Knn Objects](../search/search-request-params.html#knn-object). @@ -1596,15 +1371,10 @@ For more information, see [Knn Objects](../search/search-request-params.html#knn [%hardbreaks] {blank} -a¦ Object - array - -a¦ -*ctl* + -_optional_ -a¦ - -[markdown] +a¦ Object array +a¦ *ctl* + +optional +a¦ [markdown] -- An object that contains properties for query consistency. For more information, see [Ctl Object](../search/search-request-params.html#ctl). @@ -1613,13 +1383,9 @@ For more information, see [Ctl Object](../search/search-request-params.html#ctl) [%hardbreaks] {blank} a¦ Object - -a¦ -*size* + -_optional_ -a¦ - -[markdown] +a¦ *size* + +optional +a¦ [markdown] -- Set the total number of results to return for a single page of search results. -- @@ -1627,13 +1393,9 @@ Set the total number of results to return for a single page of search results. [%hardbreaks] {blank} a¦ Integer - -a¦ -*from* + -_optional_ -a¦ - -[markdown] +a¦ *from* + +optional +a¦ [markdown] -- Set an offset value to change where pagination starts for search results. -- @@ -1641,13 +1403,9 @@ Set an offset value to change where pagination starts for search results. [%hardbreaks] {blank} a¦ Integer - -a¦ -*highlight* + -_optional_ -a¦ - -[markdown] +a¦ *highlight* + +optional +a¦ [markdown] -- Contains properties to control search result highlighting. For more information, see [Highlight Objects](../search/search-request-params.html#highlight). @@ -1656,28 +1414,19 @@ For more information, see [Highlight Objects](../search/search-request-params.ht [%hardbreaks] {blank} a¦ Object - -a¦ -*fields* + -_optional_ -a¦ - -[markdown] +a¦ *fields* + +optional +a¦ [markdown] -- An array of strings to specify each indexed field you want to return in search results. -- [%hardbreaks] {blank} -a¦ String - array - -a¦ -*facets* + -_optional_ -a¦ - -[markdown] +a¦ String array +a¦ *facets* + +optional +a¦ [markdown] -- Contains nested objects to define each facet you want to return with search results. For more information, see [Facet Objects](../search/search-request-params.html#facet-name). @@ -1686,13 +1435,9 @@ For more information, see [Facet Objects](../search/search-request-params.html#f [%hardbreaks] {blank} a¦ Object - -a¦ -*explain* + -_optional_ -a¦ - -[markdown] +a¦ *explain* + +optional +a¦ [markdown] -- Whether to create an explanation for a search result's score in search results. -- @@ -1700,13 +1445,9 @@ Whether to create an explanation for a search result's score in search results. [%hardbreaks] {blank} a¦ Boolean - -a¦ -*sort* + -_optional_ -a¦ - -[markdown] +a¦ *sort* + +optional +a¦ [markdown] -- Contains an array of strings or JSON objects to set how to sort search results. For more information, see [Sort Object](../search/search-request-params.html#sort). @@ -1714,15 +1455,10 @@ For more information, see [Sort Object](../search/search-request-params.html#sor [%hardbreaks] {blank} -a¦ Any Type - array - -a¦ -*includeLocations* + -_optional_ -a¦ - -[markdown] +a¦ Any Type array +a¦ *includeLocations* + +optional +a¦ [markdown] -- Whether to return the position of each occurrence of a search term inside a document. -- @@ -1730,13 +1466,9 @@ Whether to return the position of each occurrence of a search term inside a docu [%hardbreaks] {blank} a¦ Boolean - -a¦ -*score* + -_optional_ -a¦ - -[markdown] +a¦ *score* + +optional +a¦ [markdown] -- Whether to include document relevancy scoring in search results. -- @@ -1744,51 +1476,36 @@ Whether to include document relevancy scoring in search results. [%hardbreaks] {blank} a¦ String - -a¦ -*search_after* + -_optional_ -a¦ - -[markdown] +a¦ *search_after* + +optional +a¦ [markdown] -- Use to control pagination in search results. -- [%hardbreaks] {blank} -a¦ String - array - -a¦ -*search_before* + -_optional_ -a¦ - -[markdown] +a¦ String array +a¦ *search_before* + +optional +a¦ [markdown] -- Use to control pagination in search results. -- [%hardbreaks] {blank} -a¦ String - array - -a¦ -*collections* + -_optional_ -a¦ - -[markdown] +a¦ String array +a¦ *collections* + +optional +a¦ [markdown] -- An array of strings that specify the collections where you want to run the query. -- [%hardbreaks] {blank} -a¦ String - array +a¦ String array |=== @@ -1796,28 +1513,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/QueryRequest/definition-end.adoc[opts=optional] - +include::{specDir}definitions/QueryRequest/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/QueryRequest/definition-after.adoc[opts=optional] - - - +ifndef::show-QueryRequest[] +:leveloffset: -1 +endif::show-QueryRequest[] -// markup not found, no include::{specDir}definitions/QueryResponse/definition-before.adoc[opts=optional] +include::{specDir}definitions/QueryRequest/definition-after.adoc[opts=optional] +include::{specDir}definitions/QueryResponse/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-QueryResponse[] [#QueryResponse] +endif::show-QueryResponse[] +ifndef::show-QueryResponse[] +:leveloffset: +1 + +[discrete#QueryResponse] +endif::show-QueryResponse[] = Query Response :leveloffset: +1 -// markup not found, no include::{specDir}definitions/QueryResponse/definition-begin.adoc[opts=optional] +include::{specDir}definitions/QueryResponse/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1825,17 +1545,13 @@ endif::collapse-models[] //tag::QueryResponse[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the operation. -- @@ -1843,21 +1559,16 @@ The status of the operation. [%hardbreaks] {blank} a¦ String - -a¦ -*results* + -_optional_ -a¦ - -[markdown] +a¦ *results* + +optional +a¦ [markdown] -- The results of the Search query. -- [%hardbreaks] {blank} -a¦ Object - array +a¦ Object array |=== @@ -1865,26 +1576,26 @@ a¦ Object -// markup not found, no include::{specDir}definitions/QueryResponse/definition-end.adoc[opts=optional] - +include::{specDir}definitions/QueryResponse/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/QueryResponse/definition-after.adoc[opts=optional] - +ifndef::show-QueryResponse[] +:leveloffset: -1 +endif::show-QueryResponse[] +include::{specDir}definitions/QueryResponse/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] - +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -1894,18 +1605,14 @@ a¦ Object include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/Manage/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/Manage/security-scheme-before.adoc[opts=optional] - - -[[security-manage]] +[[security-Manage]] = Manage :leveloffset: +1 -// markup not found, no include::{specDir}security/Manage/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Manage/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -1913,29 +1620,22 @@ You must have the **Search Admin** role, with FTS Manage permissions on the requ -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/Manage/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Manage/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/Manage/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/Manage/security-scheme-after.adoc[opts=optional] - - - - -// markup not found, no include::{specDir}security/Read/security-scheme-before.adoc[opts=optional] +include::{specDir}security/Read/security-scheme-before.adoc[opts=optional] - -[[security-read]] +[[security-Read]] = Read :leveloffset: +1 -// markup not found, no include::{specDir}security/Read/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Read/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -1943,29 +1643,22 @@ You must have the **Search Reader** or **Search Admin** role, with FTS Read perm -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/Read/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Read/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/Read/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/Read/security-scheme-after.adoc[opts=optional] - - - - -// markup not found, no include::{specDir}security/Write/security-scheme-before.adoc[opts=optional] +include::{specDir}security/Write/security-scheme-before.adoc[opts=optional] - -[[security-write]] +[[security-Write]] = Write :leveloffset: +1 -// markup not found, no include::{specDir}security/Write/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Write/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -1973,16 +1666,13 @@ You must have the **Search Admin** role, with FTS Write permissions on the requi -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/Write/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Write/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/Write/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/Write/security-scheme-after.adoc[opts=optional] @@ -1990,8 +1680,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - -// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] +include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/fts-rest-advanced/search-advanced.gradle b/docs/modules/fts-rest-advanced/search-advanced.gradle index 79be8e0a..f4d60303 100644 --- a/docs/modules/fts-rest-advanced/search-advanced.gradle +++ b/docs/modules/fts-rest-advanced/search-advanced.gradle @@ -31,6 +31,7 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/pages/index.adoc b/docs/modules/fts-rest-indexing/pages/index.adoc index 70dff068..f1c78f84 100644 --- a/docs/modules/fts-rest-indexing/pages/index.adoc +++ b/docs/modules/fts-rest-indexing/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbase/cbft :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -32,7 +31,7 @@ This API enables you to manage and monitor your Search indexes. [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -67,7 +66,6 @@ The host name or IP address of a node running the Search Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -83,31 +81,26 @@ The Search Service REST port. Use `18094` for secure access. |=== - -// markup not found, no include::{specDir}overview/document-end.adoc[opts=optional] +include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}overview/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 4 - +:count-apis: 3 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -118,18 +111,14 @@ xref:tag-Querying[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Definitions] = Definitions :leveloffset: +1 -ifeval::["Use the following APIs to retrieve Search index definitions, create new Search indexes, or delete an existing Search index." != ""] Use the following APIs to retrieve Search index definitions, create new Search indexes, or delete an existing Search index. endif::[] -ifeval::["Use the following APIs to retrieve Search index definitions, create new Search indexes, or delete an existing Search index." == ""] -**{toc-title}** -endif::[] -endif::[] + [%hardbreaks] xref:d-api-index-name[] @@ -142,43 +131,37 @@ xref:p-api-index-name[] xref:p-api-scoped-index-name[] -//tag::d-api-index-name[] - -// markup not found, no include::{specDir}paths/d-api-index-name/operation-before.adoc[opts=optional] +//tag::d-api-index-name[] +include::{specDir}paths/d-api-index-name/operation-before.adoc[opts=optional] [#d-api-index-name] = Delete Index Definition :leveloffset: +1 -// markup not found, no include::{specDir}paths/d-api-index-name/operation-begin.adoc[opts=optional] - +include::{specDir}paths/d-api-index-name/operation-begin.adoc[opts=optional] .... DELETE /api/index/{INDEX_NAME} .... - -// markup not found, no include::{specDir}paths/d-api-index-name/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/d-api-index-name/operation-description-before.adoc[opts=optional] [#d-api-index-name-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/d-api-index-name/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/d-api-index-name/operation-description-begin.adoc[opts=optional] [markdown] -- Deletes the Search index definition specified in the endpoint URL. -- - include::{specDir}paths/d-api-index-name/operation-description-end.adoc[opts=optional] @@ -187,23 +170,20 @@ include::{specDir}paths/d-api-index-name/operation-description-end.adoc[opts=opt .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/d-api-index-name/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/d-api-index-name/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/d-api-index-name/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/d-api-index-name/operation-parameters-before.adoc[opts=optional] [#d-api-index-name-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/d-api-index-name/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/d-api-index-name/operation-parameters-begin.adoc[opts=optional] [#d-api-index-name-path] .Path Parameters @@ -214,11 +194,8 @@ include::{specDir}paths/d-api-index-name/operation-description-end.adoc[opts=opt ¦ Name ¦ Description ¦ Schema a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. You must use the fully qualified name for the index, which includes the bucket and scope. @@ -237,30 +214,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/d-api-index-name/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/d-api-index-name/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/d-api-index-name/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/d-api-index-name/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/d-api-index-name/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/d-api-index-name/operation-responses-before.adoc[opts=optional] [#d-api-index-name-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/d-api-index-name/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/d-api-index-name/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -280,98 +251,79 @@ The Search Service returns a non-200 HTTP error code when a request fails. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/d-api-index-name/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/d-api-index-name/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-DeleteIndexResponse: -// markup not found, no include::{specDir}paths/d-api-index-name/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/d-api-index-name/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/d-api-index-name/operation-security-before.adoc[opts=optional] +include::{specDir}paths/d-api-index-name/operation-security-before.adoc[opts=optional] [#d-api-index-name-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/d-api-index-name/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/d-api-index-name/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-write[] +| xref:security-Write[] |=== - -// markup not found, no include::{specDir}paths/d-api-index-name/operation-security-end.adoc[opts=optional] +include::{specDir}paths/d-api-index-name/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/d-api-index-name/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/d-api-index-name/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}d-api-index-name/http-request.adoc[opts=optional] - +include::{snippetDir}d-api-index-name/http-request.adoc[opts=optional] include::{snippetDir}d-api-index-name/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/d-api-index-name/operation-end.adoc[opts=optional] +include::{specDir}paths/d-api-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/d-api-index-name/operation-after.adoc[opts=optional] - +include::{specDir}paths/d-api-index-name/operation-after.adoc[opts=optional] //end::d-api-index-name[] - //tag::d-api-scoped-index-name[] - -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-before.adoc[opts=optional] - +include::{specDir}paths/d-api-scoped-index-name/operation-before.adoc[opts=optional] [#d-api-scoped-index-name] = Delete Index Definition (Scoped) :leveloffset: +1 -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-begin.adoc[opts=optional] - +include::{specDir}paths/d-api-scoped-index-name/operation-begin.adoc[opts=optional] .... DELETE /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME} .... - -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/d-api-scoped-index-name/operation-description-before.adoc[opts=optional] [#d-api-scoped-index-name-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/d-api-scoped-index-name/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -379,8 +331,7 @@ Delete the Search index definition from the bucket and scope specified in the en This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` value. -- - -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-description-end.adoc[opts=optional] +include::{specDir}paths/d-api-scoped-index-name/operation-description-end.adoc[opts=optional] @@ -388,23 +339,20 @@ This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` va .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/d-api-scoped-index-name/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/d-api-scoped-index-name/operation-parameters-before.adoc[opts=optional] [#d-api-scoped-index-name-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/d-api-scoped-index-name/operation-parameters-begin.adoc[opts=optional] [#d-api-scoped-index-name-path] .Path Parameters @@ -415,11 +363,8 @@ This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` va ¦ Name ¦ Description ¦ Schema a¦ *BUCKET_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the bucket containing the Search index definition. -- @@ -428,13 +373,9 @@ The name of the bucket containing the Search index definition. {blank} a¦ String - a¦ *SCOPE_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the scope containing the Search index definition. -- @@ -443,13 +384,9 @@ The name of the scope containing the Search index definition. {blank} a¦ String - a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. -- @@ -463,30 +400,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/d-api-scoped-index-name/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/d-api-scoped-index-name/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/d-api-scoped-index-name/operation-responses-before.adoc[opts=optional] [#d-api-scoped-index-name-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/d-api-scoped-index-name/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -506,105 +437,85 @@ The Search Service returns a non-200 HTTP error code when a request fails. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/d-api-scoped-index-name/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-DeleteIndexResponse: -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/d-api-scoped-index-name/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-security-before.adoc[opts=optional] +include::{specDir}paths/d-api-scoped-index-name/operation-security-before.adoc[opts=optional] [#d-api-scoped-index-name-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/d-api-scoped-index-name/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-write[] +| xref:security-Write[] |=== - -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-security-end.adoc[opts=optional] +include::{specDir}paths/d-api-scoped-index-name/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/d-api-scoped-index-name/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}d-api-scoped-index-name/http-request.adoc[opts=optional] - +include::{snippetDir}d-api-scoped-index-name/http-request.adoc[opts=optional] include::{snippetDir}d-api-scoped-index-name/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-end.adoc[opts=optional] +include::{specDir}paths/d-api-scoped-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-after.adoc[opts=optional] - +include::{specDir}paths/d-api-scoped-index-name/operation-after.adoc[opts=optional] //end::d-api-scoped-index-name[] - //tag::g-api-index[] - -// markup not found, no include::{specDir}paths/g-api-index/operation-before.adoc[opts=optional] - +include::{specDir}paths/g-api-index/operation-before.adoc[opts=optional] [#g-api-index] = Get All Search Index Definitions :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-index/operation-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-index/operation-begin.adoc[opts=optional] .... GET /api/index .... - -// markup not found, no include::{specDir}paths/g-api-index/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/g-api-index/operation-description-before.adoc[opts=optional] [#g-api-index-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-index/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-index/operation-description-begin.adoc[opts=optional] [markdown] -- Returns all Search index definitions from the bucket where you have read permissions, as a JSON object. -- - include::{specDir}paths/g-api-index/operation-description-end.adoc[opts=optional] @@ -613,33 +524,29 @@ include::{specDir}paths/g-api-index/operation-description-end.adoc[opts=optional .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/g-api-index/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/g-api-index/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/g-api-index/operation-description-after.adoc[opts=optional] +include::{specDir}paths/g-api-index/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-index/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/g-api-index/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-index/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/g-api-index/operation-responses-before.adoc[opts=optional] [#g-api-index-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-index/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-index/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -652,105 +559,85 @@ A JSON object containing all Search index definitions. -- a| xref:GetIndexesResponse[] - |=== - -// markup not found, no include::{specDir}paths/g-api-index/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/g-api-index/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-GetIndexesResponse: -// markup not found, no include::{specDir}paths/g-api-index/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/g-api-index/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-index/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/g-api-index/operation-security-before.adoc[opts=optional] [#g-api-index-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-index/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-index/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-read[] +| xref:security-Read[] |=== - -// markup not found, no include::{specDir}paths/g-api-index/operation-security-end.adoc[opts=optional] +include::{specDir}paths/g-api-index/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/g-api-index/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-index/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}g-api-index/http-request.adoc[opts=optional] - +include::{snippetDir}g-api-index/http-request.adoc[opts=optional] include::{snippetDir}g-api-index/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/g-api-index/operation-end.adoc[opts=optional] +include::{specDir}paths/g-api-index/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/g-api-index/operation-after.adoc[opts=optional] - +include::{specDir}paths/g-api-index/operation-after.adoc[opts=optional] //end::g-api-index[] - //tag::g-api-index-name[] - -// markup not found, no include::{specDir}paths/g-api-index-name/operation-before.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name/operation-before.adoc[opts=optional] [#g-api-index-name] = Get Index Definition :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-index-name/operation-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name/operation-begin.adoc[opts=optional] .... GET /api/index/{INDEX_NAME} .... - -// markup not found, no include::{specDir}paths/g-api-index-name/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name/operation-description-before.adoc[opts=optional] [#g-api-index-name-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-index-name/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name/operation-description-begin.adoc[opts=optional] [markdown] -- Returns the definition of the Search index specified in the endpoint URL as a JSON object. -- - include::{specDir}paths/g-api-index-name/operation-description-end.adoc[opts=optional] @@ -759,23 +646,20 @@ include::{specDir}paths/g-api-index-name/operation-description-end.adoc[opts=opt .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/g-api-index-name/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/g-api-index-name/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-index-name/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/g-api-index-name/operation-parameters-before.adoc[opts=optional] [#g-api-index-name-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-index-name/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name/operation-parameters-begin.adoc[opts=optional] [#g-api-index-name-path] .Path Parameters @@ -786,11 +670,8 @@ include::{specDir}paths/g-api-index-name/operation-description-end.adoc[opts=opt ¦ Name ¦ Description ¦ Schema a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. You must use the fully qualified name for the index, which includes the bucket and scope. @@ -809,30 +690,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/g-api-index-name/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/g-api-index-name/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/g-api-index-name/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/g-api-index-name/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-index-name/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name/operation-responses-before.adoc[opts=optional] [#g-api-index-name-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-index-name/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -845,106 +720,86 @@ A JSON object containing the Search index definition. -- a| xref:GetIndexResponse[] - |=== - -// markup not found, no include::{specDir}paths/g-api-index-name/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/g-api-index-name/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-GetIndexResponse: -// markup not found, no include::{specDir}paths/g-api-index-name/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/g-api-index-name/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-index-name/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name/operation-security-before.adoc[opts=optional] [#g-api-index-name-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-index-name/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-read[] +| xref:security-Read[] |=== - -// markup not found, no include::{specDir}paths/g-api-index-name/operation-security-end.adoc[opts=optional] +include::{specDir}paths/g-api-index-name/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/g-api-index-name/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-index-name/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}g-api-index-name/http-request.adoc[opts=optional] - +include::{snippetDir}g-api-index-name/http-request.adoc[opts=optional] include::{snippetDir}g-api-index-name/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/g-api-index-name/operation-end.adoc[opts=optional] +include::{specDir}paths/g-api-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/g-api-index-name/operation-after.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name/operation-after.adoc[opts=optional] //end::g-api-index-name[] - //tag::g-api-scoped-index[] - -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-before.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index/operation-before.adoc[opts=optional] [#g-api-scoped-index] = Get All Search Index Definitions (Scoped) :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index/operation-begin.adoc[opts=optional] .... GET /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index .... - -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index/operation-description-before.adoc[opts=optional] [#g-api-scoped-index-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index/operation-description-begin.adoc[opts=optional] [markdown] -- Returns all Search index definitions inside the bucket and scope specified in the endpoint URL as a JSON object. -- - -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-description-end.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index/operation-description-end.adoc[opts=optional] @@ -952,23 +807,20 @@ Returns all Search index definitions inside the bucket and scope specified in th .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/g-api-scoped-index/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index/operation-parameters-before.adoc[opts=optional] [#g-api-scoped-index-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index/operation-parameters-begin.adoc[opts=optional] [#g-api-scoped-index-path] .Path Parameters @@ -979,11 +831,8 @@ Returns all Search index definitions inside the bucket and scope specified in th ¦ Name ¦ Description ¦ Schema a¦ *BUCKET_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the bucket containing the Search index definition. -- @@ -992,13 +841,9 @@ The name of the bucket containing the Search index definition. {blank} a¦ String - a¦ *SCOPE_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the scope containing the Search index definition. -- @@ -1011,30 +856,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index/operation-responses-before.adoc[opts=optional] [#g-api-scoped-index-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1047,98 +886,79 @@ A JSON object containing all Search index definitions. -- a| xref:GetIndexesResponse[] - |=== - -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-GetIndexesResponse: -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-security-before.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index/operation-security-before.adoc[opts=optional] [#g-api-scoped-index-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-read[] +| xref:security-Read[] |=== - -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-security-end.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/g-api-scoped-index/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-security-after.adoc[opts=optional] - - +include::{snippetDir}g-api-scoped-index/http-request.adoc[opts=optional] -// markup not found, no include::{snippetDir}g-api-scoped-index/http-request.adoc[opts=optional] +include::{snippetDir}g-api-scoped-index/http-response.adoc[opts=optional] - -// markup not found, no include::{snippetDir}g-api-scoped-index/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-end.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-after.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index/operation-after.adoc[opts=optional] //end::g-api-scoped-index[] - //tag::g-api-scoped-index-name[] - -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-before.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index-name/operation-before.adoc[opts=optional] [#g-api-scoped-index-name] = Get Index Definition (Scoped) :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index-name/operation-begin.adoc[opts=optional] .... GET /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME} .... - -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index-name/operation-description-before.adoc[opts=optional] [#g-api-scoped-index-name-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index-name/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -1146,8 +966,7 @@ Returns the Search index definition for the Search index specified in the endpoi This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` value. -- - -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-description-end.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index-name/operation-description-end.adoc[opts=optional] @@ -1155,23 +974,20 @@ This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` va .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/g-api-scoped-index-name/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index-name/operation-parameters-before.adoc[opts=optional] [#g-api-scoped-index-name-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index-name/operation-parameters-begin.adoc[opts=optional] [#g-api-scoped-index-name-path] .Path Parameters @@ -1182,11 +998,8 @@ This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` va ¦ Name ¦ Description ¦ Schema a¦ *BUCKET_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the bucket containing the Search index definition. -- @@ -1195,13 +1008,9 @@ The name of the bucket containing the Search index definition. {blank} a¦ String - a¦ *SCOPE_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the scope containing the Search index definition. -- @@ -1210,13 +1019,9 @@ The name of the scope containing the Search index definition. {blank} a¦ String - a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. -- @@ -1230,30 +1035,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index-name/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index-name/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index-name/operation-responses-before.adoc[opts=optional] [#g-api-scoped-index-name-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index-name/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1266,98 +1065,79 @@ A JSON object containing the Search index definition. -- a| xref:GetIndexResponse[] - |=== - -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index-name/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-GetIndexResponse: -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index-name/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-security-before.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index-name/operation-security-before.adoc[opts=optional] [#g-api-scoped-index-name-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index-name/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-read[] +| xref:security-Read[] |=== - -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-security-end.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index-name/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/g-api-scoped-index-name/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}g-api-scoped-index-name/http-request.adoc[opts=optional] - +include::{snippetDir}g-api-scoped-index-name/http-request.adoc[opts=optional] include::{snippetDir}g-api-scoped-index-name/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-end.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-after.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-index-name/operation-after.adoc[opts=optional] //end::g-api-scoped-index-name[] - //tag::p-api-index-name[] - -// markup not found, no include::{specDir}paths/p-api-index-name/operation-before.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name/operation-before.adoc[opts=optional] [#p-api-index-name] = Create or Update an Index Definition :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-index-name/operation-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name/operation-begin.adoc[opts=optional] .... PUT /api/index/{INDEX_NAME} .... - -// markup not found, no include::{specDir}paths/p-api-index-name/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name/operation-description-before.adoc[opts=optional] [#p-api-index-name-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-index-name/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -1365,7 +1145,6 @@ If the Search index in the endpoint URL does not exist, this endpoint uses a JSO If the Search index already exists, this endpoint updates the Search index definition. -- - include::{specDir}paths/p-api-index-name/operation-description-end.adoc[opts=optional] @@ -1377,23 +1156,20 @@ include::{specDir}paths/p-api-index-name/operation-description-end.adoc[opts=opt .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/p-api-index-name/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/p-api-index-name/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-index-name/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/p-api-index-name/operation-parameters-before.adoc[opts=optional] [#p-api-index-name-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-index-name/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name/operation-parameters-begin.adoc[opts=optional] [#p-api-index-name-path] .Path Parameters @@ -1404,11 +1180,8 @@ include::{specDir}paths/p-api-index-name/operation-description-end.adoc[opts=opt ¦ Name ¦ Description ¦ Schema a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. You must use the fully qualified name for the index, which includes the bucket and scope. @@ -1425,10 +1198,6 @@ To view the full, scoped name for an index for use with this endpoint: a¦ String |=== - - - - [#p-api-index-name-body] .Body Parameter {blank} @@ -1438,13 +1207,10 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -The full Search index definition. For a detailed list of all parameters for the request body, see [Search Index JSON Properties](../search/search-index-params.html). + -- [%hardbreaks] @@ -1455,26 +1221,25 @@ a¦ xref:IndexDefinition[] |=== -// markup not found, no include::{specDir}paths/p-api-index-name/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/p-api-index-name/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-IndexDefinition: -// markup not found, no include::{specDir}paths/p-api-index-name/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/p-api-index-name/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-index-name/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name/operation-responses-before.adoc[opts=optional] [#p-api-index-name-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-index-name/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1494,98 +1259,79 @@ The Search Service returns a non-200 HTTP error code when a request fails. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/p-api-index-name/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/p-api-index-name/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-PutIndexResponse: -// markup not found, no include::{specDir}paths/p-api-index-name/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/p-api-index-name/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-index-name/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name/operation-security-before.adoc[opts=optional] [#p-api-index-name-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-index-name/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-write[] +| xref:security-Write[] |=== - -// markup not found, no include::{specDir}paths/p-api-index-name/operation-security-end.adoc[opts=optional] +include::{specDir}paths/p-api-index-name/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/p-api-index-name/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-index-name/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}p-api-index-name/http-request.adoc[opts=optional] - +include::{snippetDir}p-api-index-name/http-request.adoc[opts=optional] include::{snippetDir}p-api-index-name/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/p-api-index-name/operation-end.adoc[opts=optional] +include::{specDir}paths/p-api-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/p-api-index-name/operation-after.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name/operation-after.adoc[opts=optional] //end::p-api-index-name[] - //tag::p-api-scoped-index-name[] - -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-before.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-index-name/operation-before.adoc[opts=optional] [#p-api-scoped-index-name] = Create or Update an Index Definition (Scoped) :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-index-name/operation-begin.adoc[opts=optional] .... PUT /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME} .... - -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-index-name/operation-description-before.adoc[opts=optional] [#p-api-scoped-index-name-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-index-name/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -1594,8 +1340,7 @@ If the Search index already exists, this endpoint updates the Search index defin This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` value. -- - -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-description-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-index-name/operation-description-end.adoc[opts=optional] [#p-api-scoped-index-name-consumes] @@ -1606,23 +1351,20 @@ This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` va .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/p-api-scoped-index-name/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-index-name/operation-parameters-before.adoc[opts=optional] [#p-api-scoped-index-name-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-index-name/operation-parameters-begin.adoc[opts=optional] [#p-api-scoped-index-name-path] .Path Parameters @@ -1633,11 +1375,8 @@ This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` va ¦ Name ¦ Description ¦ Schema a¦ *BUCKET_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the bucket containing the Search index definition. -- @@ -1646,13 +1385,9 @@ The name of the bucket containing the Search index definition. {blank} a¦ String - a¦ *SCOPE_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the scope containing the Search index definition. -- @@ -1661,13 +1396,9 @@ The name of the scope containing the Search index definition. {blank} a¦ String - a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. -- @@ -1679,10 +1410,6 @@ The name of the Search index definition. a¦ String |=== - - - - [#p-api-scoped-index-name-body] .Body Parameter {blank} @@ -1692,13 +1419,10 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -The full Search index definition. For a detailed list of all parameters for the request body, see [Search Index JSON Properties](../search/search-index-params.html). + -- [%hardbreaks] @@ -1709,26 +1433,25 @@ a¦ xref:IndexDefinition[] |=== -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-index-name/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-IndexDefinition: -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-index-name/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-index-name/operation-responses-before.adoc[opts=optional] [#p-api-scoped-index-name-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-index-name/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1748,85 +1471,69 @@ The Search Service returns a non-200 HTTP error code when a request fails. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-index-name/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-PutIndexResponse: -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-index-name/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-security-before.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-index-name/operation-security-before.adoc[opts=optional] [#p-api-scoped-index-name-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-index-name/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-write[] +| xref:security-Write[] |=== - -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-security-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-index-name/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/p-api-scoped-index-name/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}p-api-scoped-index-name/http-request.adoc[opts=optional] - +include::{snippetDir}p-api-scoped-index-name/http-request.adoc[opts=optional] include::{snippetDir}p-api-scoped-index-name/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-after.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-index-name/operation-after.adoc[opts=optional] //end::p-api-scoped-index-name[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Management] = Management :leveloffset: +1 -ifeval::["Use the following endpoints to manage index controls, such as document ingestion, partition assignment, and queries." != ""] Use the following endpoints to manage index controls, such as document ingestion, partition assignment, and queries. endif::[] -ifeval::["Use the following endpoints to manage index controls, such as document ingestion, partition assignment, and queries." == ""] -**{toc-title}** -endif::[] -endif::[] + [%hardbreaks] xref:p-api-idx-name-ingestcontrol[] @@ -1837,36 +1544,31 @@ xref:p-api-scoped-planfreezecontrol[] xref:p-api-scoped-querycontrol[] -//tag::p-api-idx-name-ingestcontrol[] - -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-before.adoc[opts=optional] +//tag::p-api-idx-name-ingestcontrol[] +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-before.adoc[opts=optional] [#p-api-idx-name-ingestcontrol] = Set Index Ingestion Control :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-begin.adoc[opts=optional] .... POST /api/index/{INDEX_NAME}/ingestControl/{OP} .... - -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-description-before.adoc[opts=optional] [#p-api-idx-name-ingestcontrol-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -1874,7 +1576,6 @@ For the Search index specified in the endpoint URL, pause or resume index update While paused, the Search index does not load any new document mutations. -- - include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-description-end.adoc[opts=optional] @@ -1883,23 +1584,20 @@ include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-description-end.a .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-parameters-before.adoc[opts=optional] [#p-api-idx-name-ingestcontrol-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-parameters-begin.adoc[opts=optional] [#p-api-idx-name-ingestcontrol-path] .Path Parameters @@ -1910,11 +1608,8 @@ include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-description-end.a ¦ Name ¦ Description ¦ Schema a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. You must use the fully qualified name for the index, which includes the bucket and scope. @@ -1929,13 +1624,9 @@ To view the full, scoped name for an index for use with this endpoint: {blank} a¦ String - a¦ *OP* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- To pause ingestion and maintenance, set `{OP}` to `pause`. To resume ingestion and maintenance on a paused index, set `{OP}` to `resume`. @@ -1950,30 +1641,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-responses-before.adoc[opts=optional] [#p-api-idx-name-ingestcontrol-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1986,98 +1671,79 @@ The Search Service returns a response that includes the status `ok`. -- a| xref:MgmtResponse[] - |=== - -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-MgmtResponse: -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-before.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-before.adoc[opts=optional] [#p-api-idx-name-ingestcontrol-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-manage[] +| xref:security-Manage[] |=== - -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-end.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}p-api-idx-name-ingestcontrol/http-request.adoc[opts=optional] - +include::{snippetDir}p-api-idx-name-ingestcontrol/http-request.adoc[opts=optional] include::{snippetDir}p-api-idx-name-ingestcontrol/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-end.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-after.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-after.adoc[opts=optional] //end::p-api-idx-name-ingestcontrol[] - //tag::p-api-idx-name-planfreezecontrol[] - -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-before.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-before.adoc[opts=optional] [#p-api-idx-name-planfreezecontrol] = Freeze Index Partition Assignment :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-begin.adoc[opts=optional] .... POST /api/index/{INDEX_NAME}/planFreezeControl/{OP} .... - -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-description-before.adoc[opts=optional] [#p-api-idx-name-planfreezecontrol-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -2085,7 +1751,6 @@ For the Search index specified in the endpoint URL, freeze or unfreeze the assig While frozen, the Search index stops assigning partitions during index rebalancing and index definition updates. -- - include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-description-end.adoc[opts=optional] @@ -2094,23 +1759,20 @@ include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-description-e .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-parameters-before.adoc[opts=optional] [#p-api-idx-name-planfreezecontrol-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-parameters-begin.adoc[opts=optional] [#p-api-idx-name-planfreezecontrol-path] .Path Parameters @@ -2121,11 +1783,8 @@ include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-description-e ¦ Name ¦ Description ¦ Schema a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. You must use the fully qualified name for the index, which includes the bucket and scope. @@ -2140,13 +1799,9 @@ To view the full, scoped name for an index for use with this endpoint: {blank} a¦ String - a¦ *OP* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- To freeze partition assignment, set `{OP}` to `freeze`. To unfreeze partition assignment on a frozen index, set `{OP}` to `unfreeze`. @@ -2161,30 +1816,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-responses-before.adoc[opts=optional] [#p-api-idx-name-planfreezecontrol-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2197,98 +1846,79 @@ The Search Service returns a response that includes the status `ok`. -- a| xref:MgmtResponse[] - |=== - -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-MgmtResponse: -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-before.adoc[opts=optional] [#p-api-idx-name-planfreezecontrol-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-manage[] +| xref:security-Manage[] |=== - -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-end.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}p-api-idx-name-planfreezecontrol/http-request.adoc[opts=optional] - +include::{snippetDir}p-api-idx-name-planfreezecontrol/http-request.adoc[opts=optional] include::{snippetDir}p-api-idx-name-planfreezecontrol/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-end.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-after.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-after.adoc[opts=optional] //end::p-api-idx-name-planfreezecontrol[] - //tag::p-api-idx-name-querycontrol[] - -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-before.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-querycontrol/operation-before.adoc[opts=optional] [#p-api-idx-name-querycontrol] = Stop Queries on an Index :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-querycontrol/operation-begin.adoc[opts=optional] .... POST /api/index/{INDEX_NAME}/queryControl/{OP} .... - -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-querycontrol/operation-description-before.adoc[opts=optional] [#p-api-idx-name-querycontrol-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-querycontrol/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -2296,7 +1926,6 @@ For the Search index specified in the endpoint URL, disallow or allow queries. While queries are disallowed, users see an error that the Search index's partitions could not be reached. -- - include::{specDir}paths/p-api-idx-name-querycontrol/operation-description-end.adoc[opts=optional] @@ -2305,23 +1934,20 @@ include::{specDir}paths/p-api-idx-name-querycontrol/operation-description-end.ad .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/p-api-idx-name-querycontrol/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-querycontrol/operation-parameters-before.adoc[opts=optional] [#p-api-idx-name-querycontrol-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-querycontrol/operation-parameters-begin.adoc[opts=optional] [#p-api-idx-name-querycontrol-path] .Path Parameters @@ -2332,11 +1958,8 @@ include::{specDir}paths/p-api-idx-name-querycontrol/operation-description-end.ad ¦ Name ¦ Description ¦ Schema a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. You must use the fully qualified name for the index, which includes the bucket and scope. @@ -2351,13 +1974,9 @@ To view the full, scoped name for an index for use with this endpoint: {blank} a¦ String - a¦ *OP* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- To allow queries against a Search index, set `{OP}` to `allow`. To block queries against a Search index, set `{OP}` to `disallow`. @@ -2372,30 +1991,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-querycontrol/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-querycontrol/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-querycontrol/operation-responses-before.adoc[opts=optional] [#p-api-idx-name-querycontrol-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-querycontrol/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2408,98 +2021,79 @@ The Search Service returns a response that includes the status `ok`. -- a| xref:MgmtResponse[] - |=== - -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-querycontrol/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-MgmtResponse: -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-querycontrol/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-before.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-before.adoc[opts=optional] [#p-api-idx-name-querycontrol-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-manage[] +| xref:security-Manage[] |=== - -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-end.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}p-api-idx-name-querycontrol/http-request.adoc[opts=optional] - +include::{snippetDir}p-api-idx-name-querycontrol/http-request.adoc[opts=optional] include::{snippetDir}p-api-idx-name-querycontrol/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-end.adoc[opts=optional] +include::{specDir}paths/p-api-idx-name-querycontrol/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-after.adoc[opts=optional] - +include::{specDir}paths/p-api-idx-name-querycontrol/operation-after.adoc[opts=optional] //end::p-api-idx-name-querycontrol[] - //tag::p-api-scoped-ingestcontrol[] - -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-before.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-before.adoc[opts=optional] [#p-api-scoped-ingestcontrol] = Set Index Ingestion Control (Scoped) :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-begin.adoc[opts=optional] .... POST /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME}/ingestControl/{OP} .... - -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-description-before.adoc[opts=optional] [#p-api-scoped-ingestcontrol-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -2508,8 +2102,7 @@ While paused, the Search index does not load any new document mutations. This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` value. -- - -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-description-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-description-end.adoc[opts=optional] @@ -2517,23 +2110,20 @@ This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` va .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-parameters-before.adoc[opts=optional] [#p-api-scoped-ingestcontrol-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-parameters-begin.adoc[opts=optional] [#p-api-scoped-ingestcontrol-path] .Path Parameters @@ -2544,11 +2134,8 @@ This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` va ¦ Name ¦ Description ¦ Schema a¦ *BUCKET_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the bucket containing the Search index definition. -- @@ -2557,13 +2144,9 @@ The name of the bucket containing the Search index definition. {blank} a¦ String - a¦ *SCOPE_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the scope containing the Search index definition. -- @@ -2572,13 +2155,9 @@ The name of the scope containing the Search index definition. {blank} a¦ String - a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. -- @@ -2588,13 +2167,9 @@ The name of the Search index definition. {blank} a¦ String - a¦ *OP* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- To pause ingestion and maintenance, set `{OP}` to `pause`. To resume ingestion and maintenance on a paused index, set `{OP}` to `resume`. @@ -2609,30 +2184,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-responses-before.adoc[opts=optional] [#p-api-scoped-ingestcontrol-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2645,98 +2214,79 @@ The Search Service returns a response that includes the status `ok`. -- a| xref:MgmtResponse[] - |=== - -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-MgmtResponse: -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-before.adoc[opts=optional] [#p-api-scoped-ingestcontrol-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-manage[] +| xref:security-Manage[] |=== - -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-after.adoc[opts=optional] +include::{snippetDir}p-api-scoped-ingestcontrol/http-request.adoc[opts=optional] +include::{snippetDir}p-api-scoped-ingestcontrol/http-response.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-end.adoc[opts=optional] -// markup not found, no include::{snippetDir}p-api-scoped-ingestcontrol/http-request.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/p-api-scoped-ingestcontrol/operation-after.adoc[opts=optional] -include::{snippetDir}p-api-scoped-ingestcontrol/http-response.adoc[opts=optional] +//end::p-api-scoped-ingestcontrol[] +//tag::p-api-scoped-planfreezecontrol[] - -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-end.adoc[opts=optional] - -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-after.adoc[opts=optional] - - -//end::p-api-scoped-ingestcontrol[] - - -//tag::p-api-scoped-planfreezecontrol[] - - -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-before.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-before.adoc[opts=optional] [#p-api-scoped-planfreezecontrol] = Freeze Index Partition Assignment (Scoped) :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-begin.adoc[opts=optional] .... POST /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME}/planFreezeControl/{OP} .... - -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-description-before.adoc[opts=optional] [#p-api-scoped-planfreezecontrol-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -2745,8 +2295,7 @@ While frozen, the Search index stops assigning partitions during index rebalanci This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` value. -- - -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-description-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-description-end.adoc[opts=optional] @@ -2754,23 +2303,20 @@ This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` va .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-parameters-before.adoc[opts=optional] [#p-api-scoped-planfreezecontrol-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-parameters-begin.adoc[opts=optional] [#p-api-scoped-planfreezecontrol-path] .Path Parameters @@ -2781,11 +2327,8 @@ This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` va ¦ Name ¦ Description ¦ Schema a¦ *BUCKET_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the bucket containing the Search index definition. -- @@ -2794,13 +2337,9 @@ The name of the bucket containing the Search index definition. {blank} a¦ String - a¦ *SCOPE_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the scope containing the Search index definition. -- @@ -2809,13 +2348,9 @@ The name of the scope containing the Search index definition. {blank} a¦ String - a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. -- @@ -2825,13 +2360,9 @@ The name of the Search index definition. {blank} a¦ String - a¦ *OP* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- To freeze partition assignment, set `{OP}` to `freeze`. To unfreeze partition assignment on a frozen index, set `{OP}` to `unfreeze`. @@ -2846,30 +2377,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-responses-before.adoc[opts=optional] [#p-api-scoped-planfreezecontrol-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2882,98 +2407,79 @@ The Search Service returns a response that includes the status `ok`. -- a| xref:MgmtResponse[] - |=== - -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-MgmtResponse: -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-before.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-before.adoc[opts=optional] [#p-api-scoped-planfreezecontrol-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-manage[] +| xref:security-Manage[] |=== - -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}p-api-scoped-planfreezecontrol/http-request.adoc[opts=optional] - +include::{snippetDir}p-api-scoped-planfreezecontrol/http-request.adoc[opts=optional] include::{snippetDir}p-api-scoped-planfreezecontrol/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-after.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-after.adoc[opts=optional] //end::p-api-scoped-planfreezecontrol[] - //tag::p-api-scoped-querycontrol[] - -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-before.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-querycontrol/operation-before.adoc[opts=optional] [#p-api-scoped-querycontrol] = Stop Queries on an Index (Scoped) :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-querycontrol/operation-begin.adoc[opts=optional] .... POST /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME}/queryControl/{OP} .... - -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-querycontrol/operation-description-before.adoc[opts=optional] [#p-api-scoped-querycontrol-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-querycontrol/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -2982,8 +2488,7 @@ While queries are disallowed, users see an error that the Search index's partiti This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` value. -- - -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-description-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-querycontrol/operation-description-end.adoc[opts=optional] @@ -2991,23 +2496,20 @@ This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` va .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/p-api-scoped-querycontrol/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-querycontrol/operation-parameters-before.adoc[opts=optional] [#p-api-scoped-querycontrol-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-querycontrol/operation-parameters-begin.adoc[opts=optional] [#p-api-scoped-querycontrol-path] .Path Parameters @@ -3018,11 +2520,8 @@ This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` va ¦ Name ¦ Description ¦ Schema a¦ *BUCKET_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the bucket containing the Search index definition. -- @@ -3031,13 +2530,9 @@ The name of the bucket containing the Search index definition. {blank} a¦ String - a¦ *SCOPE_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the scope containing the Search index definition. -- @@ -3046,13 +2541,9 @@ The name of the scope containing the Search index definition. {blank} a¦ String - a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. -- @@ -3062,13 +2553,9 @@ The name of the Search index definition. {blank} a¦ String - a¦ *OP* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- To allow queries against a Search index, set `{OP}` to `allow`. To block queries against a Search index, set `{OP}` to `disallow`. @@ -3083,30 +2570,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-querycontrol/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-querycontrol/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-querycontrol/operation-responses-before.adoc[opts=optional] [#p-api-scoped-querycontrol-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-querycontrol/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3119,85 +2600,69 @@ The Search Service returns a response that includes the status `ok`. -- a| xref:MgmtResponse[] - |=== - -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-querycontrol/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-MgmtResponse: -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-querycontrol/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-querycontrol/operation-security-before.adoc[opts=optional] [#p-api-scoped-querycontrol-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-querycontrol/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-manage[] +| xref:security-Manage[] |=== - -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-security-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-querycontrol/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/p-api-scoped-querycontrol/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}p-api-scoped-querycontrol/http-request.adoc[opts=optional] - +include::{snippetDir}p-api-scoped-querycontrol/http-request.adoc[opts=optional] include::{snippetDir}p-api-scoped-querycontrol/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-querycontrol/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-after.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-querycontrol/operation-after.adoc[opts=optional] //end::p-api-scoped-querycontrol[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Monitoring] = Monitoring :leveloffset: +1 -ifeval::["Use the following endpoints to get statistics about Search indexes for monitoring and debugging." != ""] Use the following endpoints to get statistics about Search indexes for monitoring and debugging. endif::[] -ifeval::["Use the following endpoints to get statistics about Search indexes for monitoring and debugging." == ""] -**{toc-title}** -endif::[] -endif::[] + [%hardbreaks] xref:g-api-scoped-status[] @@ -3206,36 +2671,31 @@ xref:g-api-stats-index-name[] xref:g-api-stats-index-name-analyzeDoc[] -//tag::g-api-scoped-status[] - -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-before.adoc[opts=optional] +//tag::g-api-scoped-status[] +include::{specDir}paths/g-api-scoped-status/operation-before.adoc[opts=optional] [#g-api-scoped-status] = Get Index Status (Scoped) :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-status/operation-begin.adoc[opts=optional] .... GET /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME}/status .... - -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-status/operation-description-before.adoc[opts=optional] [#g-api-scoped-status-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-status/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -3243,8 +2703,7 @@ Returns the status of the Search index specified in the endpoint URL, including -- - -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-description-end.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-status/operation-description-end.adoc[opts=optional] @@ -3252,23 +2711,20 @@ Returns the status of the Search index specified in the endpoint URL, including .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/g-api-scoped-status/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-status/operation-parameters-before.adoc[opts=optional] [#g-api-scoped-status-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-status/operation-parameters-begin.adoc[opts=optional] [#g-api-scoped-status-path] .Path Parameters @@ -3279,11 +2735,8 @@ Returns the status of the Search index specified in the endpoint URL, including ¦ Name ¦ Description ¦ Schema a¦ *BUCKET_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the bucket containing the Search index definition. -- @@ -3292,13 +2745,9 @@ The name of the bucket containing the Search index definition. {blank} a¦ String - a¦ *SCOPE_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the scope containing the Search index definition. -- @@ -3307,13 +2756,9 @@ The name of the scope containing the Search index definition. {blank} a¦ String - a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. -- @@ -3327,30 +2772,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-status/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-status/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-status/operation-responses-before.adoc[opts=optional] [#g-api-scoped-status-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-status/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3363,98 +2802,79 @@ The Search Service returns a response that includes the status `ok`. -- a| xref:StatusResponse[] - |=== - -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-status/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-StatusResponse: -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-status/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-security-before.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-status/operation-security-before.adoc[opts=optional] [#g-api-scoped-status-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-status/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-read[] +| xref:security-Read[] |=== - -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-security-end.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-status/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/g-api-scoped-status/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}g-api-scoped-status/http-request.adoc[opts=optional] - +include::{snippetDir}g-api-scoped-status/http-request.adoc[opts=optional] include::{snippetDir}g-api-scoped-status/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-end.adoc[opts=optional] +include::{specDir}paths/g-api-scoped-status/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-after.adoc[opts=optional] - +include::{specDir}paths/g-api-scoped-status/operation-after.adoc[opts=optional] //end::g-api-scoped-status[] - //tag::g-api-stats[] - -// markup not found, no include::{specDir}paths/g-api-stats/operation-before.adoc[opts=optional] - +include::{specDir}paths/g-api-stats/operation-before.adoc[opts=optional] [#g-api-stats] = Get Indexing and Data Metrics for All Indexes :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-stats/operation-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-stats/operation-begin.adoc[opts=optional] .... GET /api/stats .... - -// markup not found, no include::{specDir}paths/g-api-stats/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/g-api-stats/operation-description-before.adoc[opts=optional] [#g-api-stats-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-stats/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-stats/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -3464,8 +2884,7 @@ This endpoint returns statistics provided by the Search service. For additional statistics, see [Get Query, Mutation, and Partition Statistics for the Search Service](../fts-rest-stats/index.html#g-api-nsstats). -- - -// markup not found, no include::{specDir}paths/g-api-stats/operation-description-end.adoc[opts=optional] +include::{specDir}paths/g-api-stats/operation-description-end.adoc[opts=optional] @@ -3473,33 +2892,29 @@ For additional statistics, see [Get Query, Mutation, and Partition Statistics fo .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/g-api-stats/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/g-api-stats/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/g-api-stats/operation-description-after.adoc[opts=optional] +include::{specDir}paths/g-api-stats/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-stats/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/g-api-stats/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-stats/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/g-api-stats/operation-responses-before.adoc[opts=optional] [#g-api-stats-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-stats/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-stats/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3512,98 +2927,79 @@ A JSON object containing indexing and data metrics. -- a| xref:StatsNodeResponse[] - |=== - -// markup not found, no include::{specDir}paths/g-api-stats/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/g-api-stats/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-StatsNodeResponse: -// markup not found, no include::{specDir}paths/g-api-stats/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/g-api-stats/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-stats/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/g-api-stats/operation-security-before.adoc[opts=optional] [#g-api-stats-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-stats/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-stats/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-statistics[] +| xref:security-Statistics[] |=== - -// markup not found, no include::{specDir}paths/g-api-stats/operation-security-end.adoc[opts=optional] +include::{specDir}paths/g-api-stats/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/g-api-stats/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-stats/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}g-api-stats/http-request.adoc[opts=optional] - +include::{snippetDir}g-api-stats/http-request.adoc[opts=optional] include::{snippetDir}g-api-stats/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/g-api-stats/operation-end.adoc[opts=optional] +include::{specDir}paths/g-api-stats/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/g-api-stats/operation-after.adoc[opts=optional] - +include::{specDir}paths/g-api-stats/operation-after.adoc[opts=optional] //end::g-api-stats[] - //tag::g-api-stats-index-name[] - -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-before.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name/operation-before.adoc[opts=optional] [#g-api-stats-index-name] = Get Indexing and Data Metrics for an Index :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name/operation-begin.adoc[opts=optional] .... GET /api/stats/index/{INDEX_NAME} .... - -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name/operation-description-before.adoc[opts=optional] [#g-api-stats-index-name-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -3613,8 +3009,7 @@ This endpoint returns statistics provided by the Search service. For additional statistics, see [Get Query, Mutation, and Partition Statistics for an Index](../fts-rest-stats/index.html#g-api-nsstats-index-name). -- - -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-description-end.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name/operation-description-end.adoc[opts=optional] @@ -3622,23 +3017,20 @@ For additional statistics, see [Get Query, Mutation, and Partition Statistics fo .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/g-api-stats-index-name/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name/operation-parameters-before.adoc[opts=optional] [#g-api-stats-index-name-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name/operation-parameters-begin.adoc[opts=optional] [#g-api-stats-index-name-path] .Path Parameters @@ -3649,11 +3041,8 @@ For additional statistics, see [Get Query, Mutation, and Partition Statistics fo ¦ Name ¦ Description ¦ Schema a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. You must use the fully qualified name for the index, which includes the bucket and scope. @@ -3672,30 +3061,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name/operation-responses-before.adoc[opts=optional] [#g-api-stats-index-name-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3708,98 +3091,79 @@ A JSON object containing statistics for the specified Search index. -- a| xref:StatsIndexResponse[] - |=== - -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-StatsIndexResponse: -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name/operation-security-before.adoc[opts=optional] [#g-api-stats-index-name-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-statistics[] +| xref:security-Statistics[] |=== - -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-security-end.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/g-api-stats-index-name/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}g-api-stats-index-name/http-request.adoc[opts=optional] - +include::{snippetDir}g-api-stats-index-name/http-request.adoc[opts=optional] include::{snippetDir}g-api-stats-index-name/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-end.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-after.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name/operation-after.adoc[opts=optional] //end::g-api-stats-index-name[] - //tag::g-api-stats-index-name-analyzeDoc[] - -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-before.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-before.adoc[opts=optional] [#g-api-stats-index-name-analyzeDoc] = Analyze Document :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-begin.adoc[opts=optional] .... POST /api/index/{INDEX_NAME}/analyzeDoc .... - -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-description-before.adoc[opts=optional] [#g-api-stats-index-name-analyzeDoc-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -3807,8 +3171,7 @@ Use the Search index specified in the endpoint URL to analyze a document from th -- - -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-description-end.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-description-end.adoc[opts=optional] [#g-api-stats-index-name-analyzeDoc-consumes] @@ -3819,23 +3182,20 @@ Use the Search index specified in the endpoint URL to analyze a document from th .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-parameters-before.adoc[opts=optional] [#g-api-stats-index-name-analyzeDoc-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-parameters-begin.adoc[opts=optional] [#g-api-stats-index-name-analyzeDoc-path] .Path Parameters @@ -3846,11 +3206,8 @@ Use the Search index specified in the endpoint URL to analyze a document from th ¦ Name ¦ Description ¦ Schema a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. You must use the fully qualified name for the index, which includes the bucket and scope. @@ -3867,10 +3224,6 @@ To view the full, scoped name for an index for use with this endpoint: a¦ String |=== - - - - [#g-api-stats-index-name-analyzeDoc-body] .Body Parameter {blank} @@ -3880,13 +3233,10 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -Add any valid JSON document to the request body. + -- [%hardbreaks] @@ -3897,26 +3247,25 @@ a¦ xref:Object[] |=== -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Object: -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-responses-before.adoc[opts=optional] [#g-api-stats-index-name-analyzeDoc-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3929,85 +3278,69 @@ A JSON object containing the analysis of the provided document. -- a| xref:DocumentAnalysis[] - |=== - -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-DocumentAnalysis: -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-before.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-before.adoc[opts=optional] [#g-api-stats-index-name-analyzeDoc-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-read[] +| xref:security-Read[] |=== - -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-end.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-after.adoc[opts=optional] include::{snippetDir}g-api-stats-index-name-analyzeDoc/http-request.adoc[opts=optional] - include::{snippetDir}g-api-stats-index-name-analyzeDoc/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-end.adoc[opts=optional] +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-after.adoc[opts=optional] - +include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-after.adoc[opts=optional] //end::g-api-stats-index-name-analyzeDoc[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Querying] = Querying :leveloffset: +1 -ifeval::["Use the following endpoints to query the contents of a Search index." != ""] Use the following endpoints to query the contents of a Search index. endif::[] -ifeval::["Use the following endpoints to query the contents of a Search index." == ""] -**{toc-title}** -endif::[] -endif::[] + [%hardbreaks] xref:g-api-index-name-count[] @@ -4016,36 +3349,31 @@ xref:p-api-pindex-lookup[] xref:p-api-scoped-query[] -//tag::g-api-index-name-count[] - -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-before.adoc[opts=optional] +//tag::g-api-index-name-count[] +include::{specDir}paths/g-api-index-name-count/operation-before.adoc[opts=optional] [#g-api-index-name-count] = Get Document Count for an Index :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name-count/operation-begin.adoc[opts=optional] .... GET /api/index/{INDEX_NAME}/count .... - -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name-count/operation-description-before.adoc[opts=optional] [#g-api-index-name-count-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name-count/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -4053,8 +3381,7 @@ Returns the number of documents indexed in the specified Search index. -- - -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-description-end.adoc[opts=optional] +include::{specDir}paths/g-api-index-name-count/operation-description-end.adoc[opts=optional] @@ -4062,23 +3389,20 @@ Returns the number of documents indexed in the specified Search index. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/g-api-index-name-count/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/g-api-index-name-count/operation-parameters-before.adoc[opts=optional] [#g-api-index-name-count-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name-count/operation-parameters-begin.adoc[opts=optional] [#g-api-index-name-count-path] .Path Parameters @@ -4089,11 +3413,8 @@ Returns the number of documents indexed in the specified Search index. ¦ Name ¦ Description ¦ Schema a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. You must use the fully qualified name for the index, which includes the bucket and scope. @@ -4112,30 +3433,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/g-api-index-name-count/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/g-api-index-name-count/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name-count/operation-responses-before.adoc[opts=optional] [#g-api-index-name-count-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name-count/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -4148,98 +3463,79 @@ The Search Service returns a response that includes the status `ok`. -- a| xref:DocumentCount[] - |=== - -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/g-api-index-name-count/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-DocumentCount: -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/g-api-index-name-count/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name-count/operation-security-before.adoc[opts=optional] [#g-api-index-name-count-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name-count/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-statistics[] +| xref:security-Statistics[] |=== - -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-security-end.adoc[opts=optional] +include::{specDir}paths/g-api-index-name-count/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/g-api-index-name-count/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}g-api-index-name-count/http-request.adoc[opts=optional] - +include::{snippetDir}g-api-index-name-count/http-request.adoc[opts=optional] include::{snippetDir}g-api-index-name-count/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-end.adoc[opts=optional] +include::{specDir}paths/g-api-index-name-count/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-after.adoc[opts=optional] - +include::{specDir}paths/g-api-index-name-count/operation-after.adoc[opts=optional] //end::g-api-index-name-count[] - //tag::p-api-index-name-query[] - -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-before.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name-query/operation-before.adoc[opts=optional] [#p-api-index-name-query] = Query a Search Index :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name-query/operation-begin.adoc[opts=optional] .... POST /api/index/{INDEX_NAME}/query .... - -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name-query/operation-description-before.adoc[opts=optional] [#p-api-index-name-query-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name-query/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -4248,7 +3544,6 @@ The endpoint returns a JSON object as a response. -- - include::{specDir}paths/p-api-index-name-query/operation-description-end.adoc[opts=optional] @@ -4260,23 +3555,20 @@ include::{specDir}paths/p-api-index-name-query/operation-description-end.adoc[op .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/p-api-index-name-query/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/p-api-index-name-query/operation-parameters-before.adoc[opts=optional] [#p-api-index-name-query-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name-query/operation-parameters-begin.adoc[opts=optional] [#p-api-index-name-query-path] .Path Parameters @@ -4287,11 +3579,8 @@ include::{specDir}paths/p-api-index-name-query/operation-description-end.adoc[op ¦ Name ¦ Description ¦ Schema a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. You must use the fully qualified name for the index, which includes the bucket and scope. @@ -4308,10 +3597,6 @@ To view the full, scoped name for an index for use with this endpoint: a¦ String |=== - - - - [#p-api-index-name-query-body] .Body Parameter {blank} @@ -4321,13 +3606,10 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -A JSON object to define the settings for your Search query. For more information about how to create a Search query JSON object, see [Search Request JSON Properties](../search/search-request-params.html). + -- [%hardbreaks] @@ -4338,26 +3620,25 @@ a¦ xref:QueryRequest[] |=== -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/p-api-index-name-query/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-QueryRequest: -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name-query/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/p-api-index-name-query/operation-responses-before.adoc[opts=optional] [#p-api-index-name-query-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name-query/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -4370,98 +3651,79 @@ The response object has a status section that must be checked for every request. -- a| xref:QueryResponse[] - |=== - -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/p-api-index-name-query/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-QueryResponse: -include::{specDir}paths/p-api-index-name-query/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name-query/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-security-before.adoc[opts=optional] +include::{specDir}paths/p-api-index-name-query/operation-security-before.adoc[opts=optional] [#p-api-index-name-query-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name-query/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-manage[] +| xref:security-Manage[] |=== - -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-security-end.adoc[opts=optional] +include::{specDir}paths/p-api-index-name-query/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/p-api-index-name-query/operation-security-after.adoc[opts=optional] include::{snippetDir}p-api-index-name-query/http-request.adoc[opts=optional] +include::{snippetDir}p-api-index-name-query/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}p-api-index-name-query/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-end.adoc[opts=optional] +include::{specDir}paths/p-api-index-name-query/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-after.adoc[opts=optional] - +include::{specDir}paths/p-api-index-name-query/operation-after.adoc[opts=optional] //end::p-api-index-name-query[] - //tag::p-api-pindex-lookup[] - -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-before.adoc[opts=optional] - +include::{specDir}paths/p-api-pindex-lookup/operation-before.adoc[opts=optional] [#p-api-pindex-lookup] = Look Up the Index Partition for a Document (Scoped) :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-pindex-lookup/operation-begin.adoc[opts=optional] .... POST /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME}/pindexLookup .... - -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/p-api-pindex-lookup/operation-description-before.adoc[opts=optional] [#p-api-pindex-lookup-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-pindex-lookup/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -4470,8 +3732,7 @@ The endpoint returns a JSON object as a response. -- - -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-description-end.adoc[opts=optional] +include::{specDir}paths/p-api-pindex-lookup/operation-description-end.adoc[opts=optional] [#p-api-pindex-lookup-consumes] @@ -4482,23 +3743,20 @@ The endpoint returns a JSON object as a response. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/p-api-pindex-lookup/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/p-api-pindex-lookup/operation-parameters-before.adoc[opts=optional] [#p-api-pindex-lookup-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-pindex-lookup/operation-parameters-begin.adoc[opts=optional] [#p-api-pindex-lookup-path] .Path Parameters @@ -4509,11 +3767,8 @@ The endpoint returns a JSON object as a response. ¦ Name ¦ Description ¦ Schema a¦ *BUCKET_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the bucket containing the Search index definition. -- @@ -4522,13 +3777,9 @@ The name of the bucket containing the Search index definition. {blank} a¦ String - a¦ *SCOPE_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the scope containing the Search index definition. -- @@ -4537,13 +3788,9 @@ The name of the scope containing the Search index definition. {blank} a¦ String - a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. -- @@ -4555,10 +3802,6 @@ The name of the Search index definition. a¦ String |=== - - - - [#p-api-pindex-lookup-body] .Body Parameter {blank} @@ -4568,13 +3811,10 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -A valid JSON object that contains the docID property, with a value that matches the document ID for a document in the Search index. + -- [%hardbreaks] @@ -4585,26 +3825,25 @@ a¦ xref:LookupRequest[] |=== -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/p-api-pindex-lookup/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-LookupRequest: -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/p-api-pindex-lookup/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/p-api-pindex-lookup/operation-responses-before.adoc[opts=optional] [#p-api-pindex-lookup-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-pindex-lookup/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -4617,98 +3856,79 @@ The Search Service returns a response that includes the status `ok`. -- a| xref:LookupResponse[] - |=== - -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/p-api-pindex-lookup/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-LookupResponse: -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/p-api-pindex-lookup/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/p-api-pindex-lookup/operation-security-before.adoc[opts=optional] [#p-api-pindex-lookup-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-pindex-lookup/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-manage[] +| xref:security-Manage[] |=== - -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-security-end.adoc[opts=optional] +include::{specDir}paths/p-api-pindex-lookup/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/p-api-pindex-lookup/operation-security-after.adoc[opts=optional] include::{snippetDir}p-api-pindex-lookup/http-request.adoc[opts=optional] - include::{snippetDir}p-api-pindex-lookup/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-end.adoc[opts=optional] +include::{specDir}paths/p-api-pindex-lookup/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-after.adoc[opts=optional] - +include::{specDir}paths/p-api-pindex-lookup/operation-after.adoc[opts=optional] //end::p-api-pindex-lookup[] - //tag::p-api-scoped-query[] - -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-before.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-query/operation-before.adoc[opts=optional] [#p-api-scoped-query] = Query a Search Index (Scoped) :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-query/operation-begin.adoc[opts=optional] .... POST /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME}/query .... - -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-query/operation-description-before.adoc[opts=optional] [#p-api-scoped-query-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-query/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -4718,8 +3938,7 @@ This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` va -- - -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-description-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-query/operation-description-end.adoc[opts=optional] [#p-api-scoped-query-consumes] @@ -4730,23 +3949,20 @@ This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` va .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/p-api-scoped-query/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-query/operation-parameters-before.adoc[opts=optional] [#p-api-scoped-query-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-query/operation-parameters-begin.adoc[opts=optional] [#p-api-scoped-query-path] .Path Parameters @@ -4757,11 +3973,8 @@ This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` va ¦ Name ¦ Description ¦ Schema a¦ *BUCKET_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the bucket containing the Search index definition. -- @@ -4770,13 +3983,9 @@ The name of the bucket containing the Search index definition. {blank} a¦ String - a¦ *SCOPE_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the scope containing the Search index definition. -- @@ -4785,13 +3994,9 @@ The name of the scope containing the Search index definition. {blank} a¦ String - a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. -- @@ -4803,10 +4008,6 @@ The name of the Search index definition. a¦ String |=== - - - - [#p-api-scoped-query-body] .Body Parameter {blank} @@ -4816,13 +4017,10 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -A JSON object to define the settings for your Search query. For more information about how to create a Search query JSON object, see [Search Request JSON Properties](../search/search-request-params.html). + -- [%hardbreaks] @@ -4833,26 +4031,25 @@ a¦ xref:QueryRequest[] |=== -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-query/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-QueryRequest: -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-query/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-query/operation-responses-before.adoc[opts=optional] [#p-api-scoped-query-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-query/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -4874,99 +4071,84 @@ a| |=== - -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-query/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-QueryResponse: -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-query/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-query/operation-security-before.adoc[opts=optional] [#p-api-scoped-query-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-query/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-manage[] +| xref:security-Manage[] |=== - -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-security-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-query/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/p-api-scoped-query/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}p-api-scoped-query/http-request.adoc[opts=optional] - +include::{snippetDir}p-api-scoped-query/http-request.adoc[opts=optional] include::{snippetDir}p-api-scoped-query/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-end.adoc[opts=optional] +include::{specDir}paths/p-api-scoped-query/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-after.adoc[opts=optional] - +include::{specDir}paths/p-api-scoped-query/operation-after.adoc[opts=optional] //end::p-api-scoped-query[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] - +include::{specDir}paths/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] - +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 27 - +:count-models: 26 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:DeleteIndexResponse[] xref:DocumentAnalysis[] @@ -4998,19 +4180,21 @@ xref:StatusResponse[] endif::[] +include::{specDir}definitions/DeleteIndexResponse/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/DeleteIndexResponse/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-DeleteIndexResponse[] [#DeleteIndexResponse] +endif::show-DeleteIndexResponse[] +ifndef::show-DeleteIndexResponse[] +:leveloffset: +1 + +[discrete#DeleteIndexResponse] +endif::show-DeleteIndexResponse[] = Delete Response :leveloffset: +1 -// markup not found, no include::{specDir}definitions/DeleteIndexResponse/definition-begin.adoc[opts=optional] +include::{specDir}definitions/DeleteIndexResponse/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5018,17 +4202,13 @@ endif::collapse-models[] //tag::DeleteIndexResponse[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the operation. -- @@ -5036,13 +4216,9 @@ The status of the operation. [%hardbreaks] {blank} a¦ String - -a¦ -*uuid* + -_optional_ -a¦ - -[markdown] +a¦ *uuid* + +optional +a¦ [markdown] -- The UUID of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -5058,28 +4234,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/DeleteIndexResponse/definition-end.adoc[opts=optional] - +include::{specDir}definitions/DeleteIndexResponse/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/DeleteIndexResponse/definition-after.adoc[opts=optional] - - - +ifndef::show-DeleteIndexResponse[] +:leveloffset: -1 +endif::show-DeleteIndexResponse[] -// markup not found, no include::{specDir}definitions/DocumentAnalysis/definition-before.adoc[opts=optional] +include::{specDir}definitions/DeleteIndexResponse/definition-after.adoc[opts=optional] +include::{specDir}definitions/DocumentAnalysis/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-DocumentAnalysis[] [#DocumentAnalysis] +endif::show-DocumentAnalysis[] +ifndef::show-DocumentAnalysis[] +:leveloffset: +1 + +[discrete#DocumentAnalysis] +endif::show-DocumentAnalysis[] = Document Analysis :leveloffset: +1 -// markup not found, no include::{specDir}definitions/DocumentAnalysis/definition-begin.adoc[opts=optional] +include::{specDir}definitions/DocumentAnalysis/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5087,17 +4266,13 @@ endif::collapse-models[] //tag::DocumentAnalysis[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the operation. -- @@ -5105,21 +4280,16 @@ The status of the operation. [%hardbreaks] {blank} a¦ String - -a¦ -*analyzed* + -_optional_ -a¦ - -[markdown] +a¦ *analyzed* + +optional +a¦ [markdown] -- An array of objects containing the analysis of the document. -- [%hardbreaks] {blank} -a¦ xref:DocumentAnalysisItem[] - array +a¦ xref:DocumentAnalysisItem[] array |=== @@ -5127,28 +4297,37 @@ a¦ xref:DocumentAnalysisItem[] -// markup not found, no include::{specDir}definitions/DocumentAnalysis/definition-end.adoc[opts=optional] - +include::{specDir}definitions/DocumentAnalysis/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/DocumentAnalysis/definition-after.adoc[opts=optional] - - - +ifndef::show-DocumentAnalysis[] +:leveloffset: -1 +endif::show-DocumentAnalysis[] -// markup not found, no include::{specDir}definitions/DocumentAnalysisItem/definition-before.adoc[opts=optional] +include::{specDir}definitions/DocumentAnalysis/definition-after.adoc[opts=optional] +include::{specDir}definitions/DocumentAnalysisItem/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-DocumentAnalysisItem[] [#DocumentAnalysisItem] +endif::show-DocumentAnalysisItem[] +ifndef::show-DocumentAnalysisItem[] +:leveloffset: +1 + +[discrete#DocumentAnalysisItem] +endif::show-DocumentAnalysisItem[] = Analysis Item +ifdef::model-descriptions[] +//tag::desc-DocumentAnalysisItem[] +An object containing 1 or more search terms or tokens from the analyzed document. +//end::desc-DocumentAnalysisItem[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/DocumentAnalysisItem/definition-begin.adoc[opts=optional] +include::{specDir}definitions/DocumentAnalysisItem/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5156,23 +4335,14 @@ endif::collapse-models[] //tag::DocumentAnalysisItem[] -ifdef::model-descriptions[] -//tag::desc-DocumentAnalysisItem[] -An object containing 1 or more search terms or tokens from the analyzed document. -//end::desc-DocumentAnalysisItem[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ - -_additional + -property_ -a¦ - -[markdown] +additional + +property +a¦ [markdown] -- include::index.adoc[tag=desc-DocumentAnalysisItemToken, opts=optional] -- @@ -5187,28 +4357,38 @@ a¦ xref:DocumentAnalysisItemToken[] -// markup not found, no include::{specDir}definitions/DocumentAnalysisItem/definition-end.adoc[opts=optional] - +include::{specDir}definitions/DocumentAnalysisItem/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/DocumentAnalysisItem/definition-after.adoc[opts=optional] - - - +ifndef::show-DocumentAnalysisItem[] +:leveloffset: -1 +endif::show-DocumentAnalysisItem[] -// markup not found, no include::{specDir}definitions/DocumentAnalysisItemToken/definition-before.adoc[opts=optional] +include::{specDir}definitions/DocumentAnalysisItem/definition-after.adoc[opts=optional] +include::{specDir}definitions/DocumentAnalysisItemToken/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-DocumentAnalysisItemToken[] [#DocumentAnalysisItemToken] +endif::show-DocumentAnalysisItemToken[] +ifndef::show-DocumentAnalysisItemToken[] +:leveloffset: +1 + +[discrete#DocumentAnalysisItemToken] +endif::show-DocumentAnalysisItemToken[] = Analysis Token +ifdef::model-descriptions[] +//tag::desc-DocumentAnalysisItemToken[] +An object containing the analysis of a single search term or token from the analyzed document. +The name of the property is the search term or token. +//end::desc-DocumentAnalysisItemToken[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/DocumentAnalysisItemToken/definition-begin.adoc[opts=optional] +include::{specDir}definitions/DocumentAnalysisItemToken/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5216,44 +4396,30 @@ endif::collapse-models[] //tag::DocumentAnalysisItemToken[] -ifdef::model-descriptions[] -//tag::desc-DocumentAnalysisItemToken[] -An object containing the analysis of a single search term or token from the analyzed document. -The name of the property is the search term or token. -//end::desc-DocumentAnalysisItemToken[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*Term* + -_optional_ -a¦ - -[markdown] +a¦ *Term* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*Locations* + -_optional_ -a¦ - -[markdown] +a¦ *Locations* + +optional +a¦ [markdown] -- An array of objects describing the locations of the search term or token in the document. -- [%hardbreaks] {blank} -a¦ xref:DocumentAnalysisItemTokenLocation[] - array +a¦ xref:DocumentAnalysisItemTokenLocation[] array |=== @@ -5261,28 +4427,37 @@ a¦ xref:DocumentAnalysisItemTokenLocation[] -// markup not found, no include::{specDir}definitions/DocumentAnalysisItemToken/definition-end.adoc[opts=optional] - +include::{specDir}definitions/DocumentAnalysisItemToken/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/DocumentAnalysisItemToken/definition-after.adoc[opts=optional] - - - +ifndef::show-DocumentAnalysisItemToken[] +:leveloffset: -1 +endif::show-DocumentAnalysisItemToken[] -// markup not found, no include::{specDir}definitions/DocumentAnalysisItemTokenLocation/definition-before.adoc[opts=optional] +include::{specDir}definitions/DocumentAnalysisItemToken/definition-after.adoc[opts=optional] +include::{specDir}definitions/DocumentAnalysisItemTokenLocation/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-DocumentAnalysisItemTokenLocation[] [#DocumentAnalysisItemTokenLocation] +endif::show-DocumentAnalysisItemTokenLocation[] +ifndef::show-DocumentAnalysisItemTokenLocation[] +:leveloffset: +1 + +[discrete#DocumentAnalysisItemTokenLocation] +endif::show-DocumentAnalysisItemTokenLocation[] = Analysis Token Location +ifdef::model-descriptions[] +//tag::desc-DocumentAnalysisItemTokenLocation[] +An object describing the location of a single instance of the search term or token in the analyzed document. +//end::desc-DocumentAnalysisItemTokenLocation[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/DocumentAnalysisItemTokenLocation/definition-begin.adoc[opts=optional] +include::{specDir}definitions/DocumentAnalysisItemTokenLocation/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5290,22 +4465,13 @@ endif::collapse-models[] //tag::DocumentAnalysisItemTokenLocation[] -ifdef::model-descriptions[] -//tag::desc-DocumentAnalysisItemTokenLocation[] -An object describing the location of a single instance of the search term or token in the analyzed document. -//end::desc-DocumentAnalysisItemTokenLocation[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*Field* + -_optional_ -a¦ - -[markdown] +a¦ *Field* + +optional +a¦ [markdown] -- The field in the document where the token was found. -- @@ -5313,27 +4479,19 @@ The field in the document where the token was found. [%hardbreaks] {blank} a¦ String - -a¦ -*ArrayPositions* + -_optional_ -a¦ - -[markdown] +a¦ *ArrayPositions* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} -a¦ Any Type - array - -a¦ -*Start* + -_optional_ -a¦ - -[markdown] +a¦ Any Type array +a¦ *Start* + +optional +a¦ [markdown] -- The starting point of the token in the field. -- @@ -5341,13 +4499,9 @@ The starting point of the token in the field. [%hardbreaks] {blank} a¦ Integer - -a¦ -*End* + -_optional_ -a¦ - -[markdown] +a¦ *End* + +optional +a¦ [markdown] -- The ending point of the token in the field. -- @@ -5355,13 +4509,9 @@ The ending point of the token in the field. [%hardbreaks] {blank} a¦ Integer - -a¦ -*Position* + -_optional_ -a¦ - -[markdown] +a¦ *Position* + +optional +a¦ [markdown] -- The position of the token in the field. -- @@ -5376,28 +4526,31 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/DocumentAnalysisItemTokenLocation/definition-end.adoc[opts=optional] - +include::{specDir}definitions/DocumentAnalysisItemTokenLocation/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/DocumentAnalysisItemTokenLocation/definition-after.adoc[opts=optional] - - - +ifndef::show-DocumentAnalysisItemTokenLocation[] +:leveloffset: -1 +endif::show-DocumentAnalysisItemTokenLocation[] -// markup not found, no include::{specDir}definitions/DocumentCount/definition-before.adoc[opts=optional] +include::{specDir}definitions/DocumentAnalysisItemTokenLocation/definition-after.adoc[opts=optional] +include::{specDir}definitions/DocumentCount/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-DocumentCount[] [#DocumentCount] +endif::show-DocumentCount[] +ifndef::show-DocumentCount[] +:leveloffset: +1 + +[discrete#DocumentCount] +endif::show-DocumentCount[] = Document Count :leveloffset: +1 -// markup not found, no include::{specDir}definitions/DocumentCount/definition-begin.adoc[opts=optional] +include::{specDir}definitions/DocumentCount/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5405,17 +4558,13 @@ endif::collapse-models[] //tag::DocumentCount[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the operation. -- @@ -5423,13 +4572,9 @@ The status of the operation. [%hardbreaks] {blank} a¦ String - -a¦ -*count* + -_optional_ -a¦ - -[markdown] +a¦ *count* + +optional +a¦ [markdown] -- The document count for the specified index. -- @@ -5444,28 +4589,31 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/DocumentCount/definition-end.adoc[opts=optional] - +include::{specDir}definitions/DocumentCount/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/DocumentCount/definition-after.adoc[opts=optional] - - - +ifndef::show-DocumentCount[] +:leveloffset: -1 +endif::show-DocumentCount[] -// markup not found, no include::{specDir}definitions/GetIndexResponse/definition-before.adoc[opts=optional] +include::{specDir}definitions/DocumentCount/definition-after.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponse/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-GetIndexResponse[] [#GetIndexResponse] +endif::show-GetIndexResponse[] +ifndef::show-GetIndexResponse[] +:leveloffset: +1 + +[discrete#GetIndexResponse] +endif::show-GetIndexResponse[] = Index Response :leveloffset: +1 -// markup not found, no include::{specDir}definitions/GetIndexResponse/definition-begin.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponse/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5473,17 +4621,13 @@ endif::collapse-models[] //tag::GetIndexResponse[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*indexDef* + -_optional_ -a¦ - -[markdown] +a¦ *indexDef* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-IndexDefinition, opts=optional] -- @@ -5491,28 +4635,19 @@ include::index.adoc[tag=desc-IndexDefinition, opts=optional] [%hardbreaks] {blank} a¦ xref:IndexDefinition[] - -a¦ -*planPIndexes* + -_optional_ -a¦ - -[markdown] +a¦ *planPIndexes* + +optional +a¦ [markdown] -- An array of objects, each containing information about a single Search index partition. -- [%hardbreaks] {blank} -a¦ xref:GetIndexResponsePIndex[] - array - -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ xref:GetIndexResponsePIndex[] array +a¦ *status* + +optional +a¦ [markdown] -- The status of the operation. -- @@ -5520,21 +4655,16 @@ The status of the operation. [%hardbreaks] {blank} a¦ String - -a¦ -*warnings* + -_optional_ -a¦ - -[markdown] +a¦ *warnings* + +optional +a¦ [markdown] -- An array of warnings. -- [%hardbreaks] {blank} -a¦ String - array +a¦ String array |=== @@ -5542,28 +4672,37 @@ a¦ String -// markup not found, no include::{specDir}definitions/GetIndexResponse/definition-end.adoc[opts=optional] - +include::{specDir}definitions/GetIndexResponse/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/GetIndexResponse/definition-after.adoc[opts=optional] - - - +ifndef::show-GetIndexResponse[] +:leveloffset: -1 +endif::show-GetIndexResponse[] -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-before.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponse/definition-after.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndex/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-GetIndexResponsePIndex[] [#GetIndexResponsePIndex] +endif::show-GetIndexResponsePIndex[] +ifndef::show-GetIndexResponsePIndex[] +:leveloffset: +1 + +[discrete#GetIndexResponsePIndex] +endif::show-GetIndexResponsePIndex[] = Plan Partition +ifdef::model-descriptions[] +//tag::desc-GetIndexResponsePIndex[] +An object containing information about a single Search index partition. +//end::desc-GetIndexResponsePIndex[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-begin.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndex/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5571,22 +4710,13 @@ endif::collapse-models[] //tag::GetIndexResponsePIndex[] -ifdef::model-descriptions[] -//tag::desc-GetIndexResponsePIndex[] -An object containing information about a single Search index partition. -//end::desc-GetIndexResponsePIndex[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*indexName* + -_optional_ -a¦ - -[markdown] +a¦ *indexName* + +optional +a¦ [markdown] -- The name of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -5595,13 +4725,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*indexParams* + -_optional_ -a¦ - -[markdown] +a¦ *indexParams* + +optional +a¦ [markdown] -- The Search index's type identifier, type mappings, and analyzers. For more information, see [Params Object](../search/search-index-params.html#params). @@ -5610,13 +4736,9 @@ For more information, see [Params Object](../search/search-index-params.html#par [%hardbreaks] {blank} a¦ Object - -a¦ -*indexType* + -_optional_ -a¦ - -[markdown] +a¦ *indexType* + +optional +a¦ [markdown] -- The type of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -5625,13 +4747,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*indexUUID* + -_optional_ -a¦ - -[markdown] +a¦ *indexUUID* + +optional +a¦ [markdown] -- The UUID of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -5640,13 +4758,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*name* + -_optional_ -a¦ - -[markdown] +a¦ *name* + +optional +a¦ [markdown] -- The name of the Search index partition. -- @@ -5654,13 +4768,9 @@ The name of the Search index partition. [%hardbreaks] {blank} a¦ String - -a¦ -*nodes* + -_optional_ -a¦ - -[markdown] +a¦ *nodes* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapper, opts=optional] -- @@ -5668,13 +4778,9 @@ include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapper, opts=optional] [%hardbreaks] {blank} a¦ xref:GetIndexResponsePIndexNodesWrapper[] - -a¦ -*sourceName* + -_optional_ -a¦ - -[markdown] +a¦ *sourceName* + +optional +a¦ [markdown] -- The name of the bucket where the Search index is stored. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -5683,13 +4789,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*sourceParams* + -_optional_ -a¦ - -[markdown] +a¦ *sourceParams* + +optional +a¦ [markdown] -- Advanced settings for Search index behavior. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -5698,26 +4800,19 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ Object - -a¦ -*sourcePartitions* + -_optional_ -a¦ - -[markdown] +a¦ *sourcePartitions* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*sourceType* + -_optional_ -a¦ - -[markdown] +a¦ *sourceType* + +optional +a¦ [markdown] -- The type of the bucket where the Search index is stored. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -5726,13 +4821,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*sourceUUID* + -_optional_ -a¦ - -[markdown] +a¦ *sourceUUID* + +optional +a¦ [markdown] -- The UUID of the bucket where the Search index is stored. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -5741,13 +4832,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*uuid* + -_optional_ -a¦ - -[markdown] +a¦ *uuid* + +optional +a¦ [markdown] -- The UUID of the Search index partition. -- @@ -5762,28 +4849,37 @@ a¦ String -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-end.adoc[opts=optional] - +include::{specDir}definitions/GetIndexResponsePIndex/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-after.adoc[opts=optional] - - - +ifndef::show-GetIndexResponsePIndex[] +:leveloffset: -1 +endif::show-GetIndexResponsePIndex[] -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-before.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndex/definition-after.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-GetIndexResponsePIndexNodesWrapper[] [#GetIndexResponsePIndexNodesWrapper] +endif::show-GetIndexResponsePIndexNodesWrapper[] +ifndef::show-GetIndexResponsePIndexNodesWrapper[] +:leveloffset: +1 + +[discrete#GetIndexResponsePIndexNodesWrapper] +endif::show-GetIndexResponsePIndexNodesWrapper[] = Partition Nodes Wrapper +ifdef::model-descriptions[] +//tag::desc-GetIndexResponsePIndexNodesWrapper[] +An object containing information about 1 or more Search index partition nodes. +//end::desc-GetIndexResponsePIndexNodesWrapper[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-begin.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5791,23 +4887,14 @@ endif::collapse-models[] //tag::GetIndexResponsePIndexNodesWrapper[] -ifdef::model-descriptions[] -//tag::desc-GetIndexResponsePIndexNodesWrapper[] -An object containing information about 1 or more Search index partition nodes. -//end::desc-GetIndexResponsePIndexNodesWrapper[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ - -_additional + -property_ -a¦ - -[markdown] +additional + +property +a¦ [markdown] -- include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapperNode, opts=optional] -- @@ -5822,28 +4909,38 @@ a¦ xref:GetIndexResponsePIndexNodesWrapperNode[] -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-end.adoc[opts=optional] - +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-after.adoc[opts=optional] - - - +ifndef::show-GetIndexResponsePIndexNodesWrapper[] +:leveloffset: -1 +endif::show-GetIndexResponsePIndexNodesWrapper[] -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-before.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-after.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-GetIndexResponsePIndexNodesWrapperNode[] [#GetIndexResponsePIndexNodesWrapperNode] +endif::show-GetIndexResponsePIndexNodesWrapperNode[] +ifndef::show-GetIndexResponsePIndexNodesWrapperNode[] +:leveloffset: +1 + +[discrete#GetIndexResponsePIndexNodesWrapperNode] +endif::show-GetIndexResponsePIndexNodesWrapperNode[] = Partition Node +ifdef::model-descriptions[] +//tag::desc-GetIndexResponsePIndexNodesWrapperNode[] +An object containing information about a single Search index partition node. +The name of the property is the node UUID. +//end::desc-GetIndexResponsePIndexNodesWrapperNode[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-begin.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5851,50 +4948,35 @@ endif::collapse-models[] //tag::GetIndexResponsePIndexNodesWrapperNode[] -ifdef::model-descriptions[] -//tag::desc-GetIndexResponsePIndexNodesWrapperNode[] -An object containing information about a single Search index partition node. -The name of the property is the node UUID. -//end::desc-GetIndexResponsePIndexNodesWrapperNode[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*canRead* + -_optional_ -a¦ - -[markdown] +a¦ *canRead* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Boolean - -a¦ -*canWrite* + -_optional_ -a¦ - -[markdown] +a¦ *canWrite* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Boolean - -a¦ -*priority* + -_optional_ -a¦ - -[markdown] +a¦ *priority* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -5907,28 +4989,31 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-end.adoc[opts=optional] - +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-after.adoc[opts=optional] - - - +ifndef::show-GetIndexResponsePIndexNodesWrapperNode[] +:leveloffset: -1 +endif::show-GetIndexResponsePIndexNodesWrapperNode[] -// markup not found, no include::{specDir}definitions/GetIndexesResponse/definition-before.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-after.adoc[opts=optional] +include::{specDir}definitions/GetIndexesResponse/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-GetIndexesResponse[] [#GetIndexesResponse] +endif::show-GetIndexesResponse[] +ifndef::show-GetIndexesResponse[] +:leveloffset: +1 + +[discrete#GetIndexesResponse] +endif::show-GetIndexesResponse[] = Indexes Response :leveloffset: +1 -// markup not found, no include::{specDir}definitions/GetIndexesResponse/definition-begin.adoc[opts=optional] +include::{specDir}definitions/GetIndexesResponse/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5936,17 +5021,13 @@ endif::collapse-models[] //tag::GetIndexesResponse[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*indexDefs* + -_optional_ -a¦ - -[markdown] +a¦ *indexDefs* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-GetIndexesResponseIndexes, opts=optional] -- @@ -5954,13 +5035,9 @@ include::index.adoc[tag=desc-GetIndexesResponseIndexes, opts=optional] [%hardbreaks] {blank} a¦ xref:GetIndexesResponseIndexes[] - -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the operation. -- @@ -5975,28 +5052,37 @@ a¦ String -// markup not found, no include::{specDir}definitions/GetIndexesResponse/definition-end.adoc[opts=optional] - +include::{specDir}definitions/GetIndexesResponse/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/GetIndexesResponse/definition-after.adoc[opts=optional] - - - +ifndef::show-GetIndexesResponse[] +:leveloffset: -1 +endif::show-GetIndexesResponse[] -// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexes/definition-before.adoc[opts=optional] +include::{specDir}definitions/GetIndexesResponse/definition-after.adoc[opts=optional] +include::{specDir}definitions/GetIndexesResponseIndexes/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-GetIndexesResponseIndexes[] [#GetIndexesResponseIndexes] +endif::show-GetIndexesResponseIndexes[] +ifndef::show-GetIndexesResponseIndexes[] +:leveloffset: +1 + +[discrete#GetIndexesResponseIndexes] +endif::show-GetIndexesResponseIndexes[] = Index Definitions +ifdef::model-descriptions[] +//tag::desc-GetIndexesResponseIndexes[] +An object containing Search index definitions and related information. +//end::desc-GetIndexesResponseIndexes[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexes/definition-begin.adoc[opts=optional] +include::{specDir}definitions/GetIndexesResponseIndexes/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -6004,35 +5090,23 @@ endif::collapse-models[] //tag::GetIndexesResponseIndexes[] -ifdef::model-descriptions[] -//tag::desc-GetIndexesResponseIndexes[] -An object containing Search index definitions and related information. -//end::desc-GetIndexesResponseIndexes[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*implVersion* + -_optional_ -a¦ - -[markdown] +a¦ *implVersion* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*indexDefs* + -_optional_ -a¦ - -[markdown] +a¦ *indexDefs* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-GetIndexesResponseIndexesWrapper, opts=optional] -- @@ -6040,14 +5114,11 @@ include::index.adoc[tag=desc-GetIndexesResponseIndexesWrapper, opts=optional] [%hardbreaks] {blank} a¦ xref:GetIndexesResponseIndexesWrapper[] - -a¦ -*uuid* + -_optional_ -a¦ - -[markdown] +a¦ *uuid* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -6060,28 +5131,37 @@ a¦ String -// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexes/definition-end.adoc[opts=optional] - +include::{specDir}definitions/GetIndexesResponseIndexes/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexes/definition-after.adoc[opts=optional] - - - +ifndef::show-GetIndexesResponseIndexes[] +:leveloffset: -1 +endif::show-GetIndexesResponseIndexes[] -// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-before.adoc[opts=optional] +include::{specDir}definitions/GetIndexesResponseIndexes/definition-after.adoc[opts=optional] +include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-GetIndexesResponseIndexesWrapper[] [#GetIndexesResponseIndexesWrapper] +endif::show-GetIndexesResponseIndexesWrapper[] +ifndef::show-GetIndexesResponseIndexesWrapper[] +:leveloffset: +1 + +[discrete#GetIndexesResponseIndexesWrapper] +endif::show-GetIndexesResponseIndexesWrapper[] = Index Definitions Wrapper +ifdef::model-descriptions[] +//tag::desc-GetIndexesResponseIndexesWrapper[] +An object containing 1 or more Search index definitions. +//end::desc-GetIndexesResponseIndexesWrapper[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-begin.adoc[opts=optional] +include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -6089,23 +5169,14 @@ endif::collapse-models[] //tag::GetIndexesResponseIndexesWrapper[] -ifdef::model-descriptions[] -//tag::desc-GetIndexesResponseIndexesWrapper[] -An object containing 1 or more Search index definitions. -//end::desc-GetIndexesResponseIndexesWrapper[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ - -_additional + -property_ -a¦ - -[markdown] +additional + +property +a¦ [markdown] -- include::index.adoc[tag=desc-IndexDefinition, opts=optional] -- @@ -6120,28 +5191,38 @@ a¦ xref:IndexDefinition[] -// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-end.adoc[opts=optional] - +include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-after.adoc[opts=optional] - - - +ifndef::show-GetIndexesResponseIndexesWrapper[] +:leveloffset: -1 +endif::show-GetIndexesResponseIndexesWrapper[] -// markup not found, no include::{specDir}definitions/IndexDefinition/definition-before.adoc[opts=optional] +include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-after.adoc[opts=optional] +include::{specDir}definitions/IndexDefinition/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-IndexDefinition[] [#IndexDefinition] +endif::show-IndexDefinition[] +ifndef::show-IndexDefinition[] +:leveloffset: +1 + +[discrete#IndexDefinition] +endif::show-IndexDefinition[] = Index Definition +ifdef::model-descriptions[] +//tag::desc-IndexDefinition[] +The full Search index definition. +For a detailed list of all parameters, see [Search Index JSON Properties](../search/search-index-params.html). +//end::desc-IndexDefinition[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/IndexDefinition/definition-begin.adoc[opts=optional] +include::{specDir}definitions/IndexDefinition/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -6149,23 +5230,13 @@ endif::collapse-models[] //tag::IndexDefinition[] -ifdef::model-descriptions[] -//tag::desc-IndexDefinition[] -The full Search index definition. -For a detailed list of all parameters, see [Search Index JSON Properties](../search/search-index-params.html). -//end::desc-IndexDefinition[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*name* + -_required_ -a¦ - -[markdown] +a¦ *name* + +required +a¦ [markdown] -- The name of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -6174,13 +5245,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*type* + -_required_ -a¦ - -[markdown] +a¦ *type* + +required +a¦ [markdown] -- The type of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -6189,13 +5256,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*sourceName* + -_required_ -a¦ - -[markdown] +a¦ *sourceName* + +required +a¦ [markdown] -- The name of the bucket where the Search index is stored. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -6204,13 +5267,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*sourceUUID* + -_optional_ -a¦ - -[markdown] +a¦ *sourceUUID* + +optional +a¦ [markdown] -- The UUID of the bucket where the Search index is stored. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -6219,13 +5278,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*sourceParams* + -_optional_ -a¦ - -[markdown] +a¦ *sourceParams* + +optional +a¦ [markdown] -- Advanced settings for Search index behavior. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -6234,13 +5289,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ Object - -a¦ -*sourceType* + -_required_ -a¦ - -[markdown] +a¦ *sourceType* + +required +a¦ [markdown] -- The type of the bucket where the Search index is stored. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -6249,13 +5300,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*params* + -_required_ -a¦ - -[markdown] +a¦ *params* + +required +a¦ [markdown] -- The Search index's type identifier, type mappings, and analyzers. For more information, see [Params Object](../search/search-index-params.html#params). @@ -6264,13 +5311,9 @@ For more information, see [Params Object](../search/search-index-params.html#par [%hardbreaks] {blank} a¦ Object - -a¦ -*planParams* + -_required_ -a¦ - -[markdown] +a¦ *planParams* + +required +a¦ [markdown] -- include::index.adoc[tag=desc-IndexDefinitionPlanParams, opts=optional] -- @@ -6278,13 +5321,9 @@ include::index.adoc[tag=desc-IndexDefinitionPlanParams, opts=optional] [%hardbreaks] {blank} a¦ xref:IndexDefinitionPlanParams[] - -a¦ -*prevIndexUUID* + -_optional_ -a¦ - -[markdown] +a¦ *prevIndexUUID* + +optional +a¦ [markdown] -- The UUID of the previous index. Intended for clients that want to check that they are not overwriting the Search index definition updates of concurrent clients. @@ -6293,13 +5332,9 @@ Intended for clients that want to check that they are not overwriting the Search [%hardbreaks] {blank} a¦ String - -a¦ -*uuid* + -_optional_ -a¦ - -[markdown] +a¦ *uuid* + +optional +a¦ [markdown] -- The UUID of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -6315,28 +5350,38 @@ a¦ String -// markup not found, no include::{specDir}definitions/IndexDefinition/definition-end.adoc[opts=optional] - +include::{specDir}definitions/IndexDefinition/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/IndexDefinition/definition-after.adoc[opts=optional] - - - +ifndef::show-IndexDefinition[] +:leveloffset: -1 +endif::show-IndexDefinition[] -// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-before.adoc[opts=optional] +include::{specDir}definitions/IndexDefinition/definition-after.adoc[opts=optional] +include::{specDir}definitions/IndexDefinitionPlanParams/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-IndexDefinitionPlanParams[] [#IndexDefinitionPlanParams] +endif::show-IndexDefinitionPlanParams[] +ifndef::show-IndexDefinitionPlanParams[] +:leveloffset: +1 + +[discrete#IndexDefinitionPlanParams] +endif::show-IndexDefinitionPlanParams[] = Plan Parameters +ifdef::model-descriptions[] +//tag::desc-IndexDefinitionPlanParams[] +The Search index's partitioning and replication settings. +For more information, see [Plan Params Object](../search/search-index-params.html#planParams). +//end::desc-IndexDefinitionPlanParams[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-begin.adoc[opts=optional] +include::{specDir}definitions/IndexDefinitionPlanParams/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -6344,36 +5389,24 @@ endif::collapse-models[] //tag::IndexDefinitionPlanParams[] -ifdef::model-descriptions[] -//tag::desc-IndexDefinitionPlanParams[] -The Search index's partitioning and replication settings. -For more information, see [Plan Params Object](../search/search-index-params.html#planParams). -//end::desc-IndexDefinitionPlanParams[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*hierarchyRules* + -_optional_ -a¦ - -[markdown] +a¦ *hierarchyRules* + +optional +a¦ [markdown] -- + -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*maxPartitionsPerPIndex* + -_optional_ -a¦ - -[markdown] +a¦ *maxPartitionsPerPIndex* + +optional +a¦ [markdown] -- This setting is deprecated. Use `indexPartitions` instead. @@ -6382,13 +5415,9 @@ Use `indexPartitions` instead. [%hardbreaks] {blank} a¦ Integer - -a¦ -*indexPartitions* + -_optional_ -a¦ - -[markdown] +a¦ *indexPartitions* + +optional +a¦ [markdown] -- The number of partitions to split the Search index into, across the nodes you have available in your database with the Search Service enabled. -- @@ -6396,26 +5425,20 @@ The number of partitions to split the Search index into, across the nodes you ha [%hardbreaks] {blank} a¦ Integer - -a¦ -*nodePlanParams* + -_optional_ -a¦ - -[markdown] +a¦ *nodePlanParams* + +optional +a¦ [markdown] -- + -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*numReplicas* + -_optional_ -a¦ - -[markdown] +a¦ *numReplicas* + +optional +a¦ [markdown] -- The number of replicas the Search Service creates for the Search index to ensure high availability. -- @@ -6423,14 +5446,11 @@ The number of replicas the Search Service creates for the Search index to ensure [%hardbreaks] {blank} a¦ Integer - -a¦ -*planFrozen* + -_optional_ -a¦ - -[markdown] +a¦ *planFrozen* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -6443,28 +5463,31 @@ a¦ Boolean -// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-end.adoc[opts=optional] - +include::{specDir}definitions/IndexDefinitionPlanParams/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-after.adoc[opts=optional] - - - +ifndef::show-IndexDefinitionPlanParams[] +:leveloffset: -1 +endif::show-IndexDefinitionPlanParams[] -// markup not found, no include::{specDir}definitions/LookupRequest/definition-before.adoc[opts=optional] +include::{specDir}definitions/IndexDefinitionPlanParams/definition-after.adoc[opts=optional] +include::{specDir}definitions/LookupRequest/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-LookupRequest[] [#LookupRequest] +endif::show-LookupRequest[] +ifndef::show-LookupRequest[] +:leveloffset: +1 + +[discrete#LookupRequest] +endif::show-LookupRequest[] = Lookup Request :leveloffset: +1 -// markup not found, no include::{specDir}definitions/LookupRequest/definition-begin.adoc[opts=optional] +include::{specDir}definitions/LookupRequest/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -6472,17 +5495,13 @@ endif::collapse-models[] //tag::LookupRequest[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*docID* + -_optional_ -a¦ - -[markdown] +a¦ *docID* + +optional +a¦ [markdown] -- The document ID to look up in the Search index. -- @@ -6497,28 +5516,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/LookupRequest/definition-end.adoc[opts=optional] - +include::{specDir}definitions/LookupRequest/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/LookupRequest/definition-after.adoc[opts=optional] - - - +ifndef::show-LookupRequest[] +:leveloffset: -1 +endif::show-LookupRequest[] -// markup not found, no include::{specDir}definitions/LookupResponse/definition-before.adoc[opts=optional] +include::{specDir}definitions/LookupRequest/definition-after.adoc[opts=optional] +include::{specDir}definitions/LookupResponse/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-LookupResponse[] [#LookupResponse] +endif::show-LookupResponse[] +ifndef::show-LookupResponse[] +:leveloffset: +1 + +[discrete#LookupResponse] +endif::show-LookupResponse[] = Lookup Response :leveloffset: +1 -// markup not found, no include::{specDir}definitions/LookupResponse/definition-begin.adoc[opts=optional] +include::{specDir}definitions/LookupResponse/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -6526,17 +5548,13 @@ endif::collapse-models[] //tag::LookupResponse[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the operation. -- @@ -6544,13 +5562,9 @@ The status of the operation. [%hardbreaks] {blank} a¦ String - -a¦ -*pindexes* + -_optional_ -a¦ - -[markdown] +a¦ *pindexes* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-LookupResponsePartitions, opts=optional] -- @@ -6565,28 +5579,37 @@ a¦ xref:LookupResponsePartitions[] -// markup not found, no include::{specDir}definitions/LookupResponse/definition-end.adoc[opts=optional] - +include::{specDir}definitions/LookupResponse/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/LookupResponse/definition-after.adoc[opts=optional] - - - +ifndef::show-LookupResponse[] +:leveloffset: -1 +endif::show-LookupResponse[] -// markup not found, no include::{specDir}definitions/LookupResponsePartitions/definition-before.adoc[opts=optional] +include::{specDir}definitions/LookupResponse/definition-after.adoc[opts=optional] +include::{specDir}definitions/LookupResponsePartitions/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-LookupResponsePartitions[] [#LookupResponsePartitions] +endif::show-LookupResponsePartitions[] +ifndef::show-LookupResponsePartitions[] +:leveloffset: +1 + +[discrete#LookupResponsePartitions] +endif::show-LookupResponsePartitions[] = Lookup Partition Wrapper +ifdef::model-descriptions[] +//tag::desc-LookupResponsePartitions[] +An object containing information about 1 or more Search index partitions. +//end::desc-LookupResponsePartitions[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/LookupResponsePartitions/definition-begin.adoc[opts=optional] +include::{specDir}definitions/LookupResponsePartitions/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -6594,23 +5617,14 @@ endif::collapse-models[] //tag::LookupResponsePartitions[] -ifdef::model-descriptions[] -//tag::desc-LookupResponsePartitions[] -An object containing information about 1 or more Search index partitions. -//end::desc-LookupResponsePartitions[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ - -_additional + -property_ -a¦ - -[markdown] +additional + +property +a¦ [markdown] -- include::index.adoc[tag=desc-LookupResponsePartitionsID, opts=optional] -- @@ -6625,28 +5639,38 @@ a¦ xref:LookupResponsePartitionsID[] -// markup not found, no include::{specDir}definitions/LookupResponsePartitions/definition-end.adoc[opts=optional] - +include::{specDir}definitions/LookupResponsePartitions/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/LookupResponsePartitions/definition-after.adoc[opts=optional] - - - +ifndef::show-LookupResponsePartitions[] +:leveloffset: -1 +endif::show-LookupResponsePartitions[] -// markup not found, no include::{specDir}definitions/LookupResponsePartitionsID/definition-before.adoc[opts=optional] +include::{specDir}definitions/LookupResponsePartitions/definition-after.adoc[opts=optional] +include::{specDir}definitions/LookupResponsePartitionsID/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-LookupResponsePartitionsID[] [#LookupResponsePartitionsID] +endif::show-LookupResponsePartitionsID[] +ifndef::show-LookupResponsePartitionsID[] +:leveloffset: +1 + +[discrete#LookupResponsePartitionsID] +endif::show-LookupResponsePartitionsID[] = Lookup Partition +ifdef::model-descriptions[] +//tag::desc-LookupResponsePartitionsID[] +An object containing information about a single Search index partition. +The name of the property is the Search index partition name. +//end::desc-LookupResponsePartitionsID[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/LookupResponsePartitionsID/definition-begin.adoc[opts=optional] +include::{specDir}definitions/LookupResponsePartitionsID/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -6654,23 +5678,13 @@ endif::collapse-models[] //tag::LookupResponsePartitionsID[] -ifdef::model-descriptions[] -//tag::desc-LookupResponsePartitionsID[] -An object containing information about a single Search index partition. -The name of the property is the Search index partition name. -//end::desc-LookupResponsePartitionsID[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*id* + -_optional_ -a¦ - -[markdown] +a¦ *id* + +optional +a¦ [markdown] -- The Search index partition ID. -- @@ -6685,28 +5699,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/LookupResponsePartitionsID/definition-end.adoc[opts=optional] - +include::{specDir}definitions/LookupResponsePartitionsID/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/LookupResponsePartitionsID/definition-after.adoc[opts=optional] - - - +ifndef::show-LookupResponsePartitionsID[] +:leveloffset: -1 +endif::show-LookupResponsePartitionsID[] -// markup not found, no include::{specDir}definitions/MgmtResponse/definition-before.adoc[opts=optional] +include::{specDir}definitions/LookupResponsePartitionsID/definition-after.adoc[opts=optional] +include::{specDir}definitions/MgmtResponse/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-MgmtResponse[] [#MgmtResponse] +endif::show-MgmtResponse[] +ifndef::show-MgmtResponse[] +:leveloffset: +1 + +[discrete#MgmtResponse] +endif::show-MgmtResponse[] = Management Response :leveloffset: +1 -// markup not found, no include::{specDir}definitions/MgmtResponse/definition-begin.adoc[opts=optional] +include::{specDir}definitions/MgmtResponse/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -6714,17 +5731,13 @@ endif::collapse-models[] //tag::MgmtResponse[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the operation. -- @@ -6739,28 +5752,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/MgmtResponse/definition-end.adoc[opts=optional] - +include::{specDir}definitions/MgmtResponse/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/MgmtResponse/definition-after.adoc[opts=optional] - - - +ifndef::show-MgmtResponse[] +:leveloffset: -1 +endif::show-MgmtResponse[] -// markup not found, no include::{specDir}definitions/PutIndexResponse/definition-before.adoc[opts=optional] +include::{specDir}definitions/MgmtResponse/definition-after.adoc[opts=optional] +include::{specDir}definitions/PutIndexResponse/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-PutIndexResponse[] [#PutIndexResponse] +endif::show-PutIndexResponse[] +ifndef::show-PutIndexResponse[] +:leveloffset: +1 + +[discrete#PutIndexResponse] +endif::show-PutIndexResponse[] = Create or Update Response :leveloffset: +1 -// markup not found, no include::{specDir}definitions/PutIndexResponse/definition-begin.adoc[opts=optional] +include::{specDir}definitions/PutIndexResponse/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -6768,17 +5784,13 @@ endif::collapse-models[] //tag::PutIndexResponse[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the operation. -- @@ -6786,13 +5798,9 @@ The status of the operation. [%hardbreaks] {blank} a¦ String - -a¦ -*name* + -_optional_ -a¦ - -[markdown] +a¦ *name* + +optional +a¦ [markdown] -- The name of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -6801,13 +5809,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*uuid* + -_optional_ -a¦ - -[markdown] +a¦ *uuid* + +optional +a¦ [markdown] -- The UUID of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -6823,28 +5827,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/PutIndexResponse/definition-end.adoc[opts=optional] - +include::{specDir}definitions/PutIndexResponse/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/PutIndexResponse/definition-after.adoc[opts=optional] - - - +ifndef::show-PutIndexResponse[] +:leveloffset: -1 +endif::show-PutIndexResponse[] -// markup not found, no include::{specDir}definitions/QueryRequest/definition-before.adoc[opts=optional] +include::{specDir}definitions/PutIndexResponse/definition-after.adoc[opts=optional] +include::{specDir}definitions/QueryRequest/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-QueryRequest[] [#QueryRequest] +endif::show-QueryRequest[] +ifndef::show-QueryRequest[] +:leveloffset: +1 + +[discrete#QueryRequest] +endif::show-QueryRequest[] = Query Request :leveloffset: +1 -// markup not found, no include::{specDir}definitions/QueryRequest/definition-begin.adoc[opts=optional] +include::{specDir}definitions/QueryRequest/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -6852,17 +5859,13 @@ endif::collapse-models[] //tag::QueryRequest[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*query* + -_optional_ -a¦ - -[markdown] +a¦ *query* + +optional +a¦ [markdown] -- An object that contains the properties for one of the supported query types. For more information, see [Query Object](../search/search-request-params.html#query-object). @@ -6871,13 +5874,9 @@ For more information, see [Query Object](../search/search-request-params.html#qu [%hardbreaks] {blank} a¦ Object - -a¦ -*knn* + -_optional_ -a¦ - -[markdown] +a¦ *knn* + +optional +a¦ [markdown] -- An array that contains objects that describe a Vector Search query. For more information, see [Knn Objects](../search/search-request-params.html#knn-object). @@ -6885,15 +5884,10 @@ For more information, see [Knn Objects](../search/search-request-params.html#knn [%hardbreaks] {blank} -a¦ Object - array - -a¦ -*ctl* + -_optional_ -a¦ - -[markdown] +a¦ Object array +a¦ *ctl* + +optional +a¦ [markdown] -- An object that contains properties for query consistency. For more information, see [Ctl Object](../search/search-request-params.html#ctl). @@ -6902,13 +5896,9 @@ For more information, see [Ctl Object](../search/search-request-params.html#ctl) [%hardbreaks] {blank} a¦ Object - -a¦ -*size* + -_optional_ -a¦ - -[markdown] +a¦ *size* + +optional +a¦ [markdown] -- Set the total number of results to return for a single page of search results. -- @@ -6916,13 +5906,9 @@ Set the total number of results to return for a single page of search results. [%hardbreaks] {blank} a¦ Integer - -a¦ -*from* + -_optional_ -a¦ - -[markdown] +a¦ *from* + +optional +a¦ [markdown] -- Set an offset value to change where pagination starts for search results. -- @@ -6930,13 +5916,9 @@ Set an offset value to change where pagination starts for search results. [%hardbreaks] {blank} a¦ Integer - -a¦ -*highlight* + -_optional_ -a¦ - -[markdown] +a¦ *highlight* + +optional +a¦ [markdown] -- Contains properties to control search result highlighting. For more information, see [Highlight Objects](../search/search-request-params.html#highlight). @@ -6945,28 +5927,19 @@ For more information, see [Highlight Objects](../search/search-request-params.ht [%hardbreaks] {blank} a¦ Object - -a¦ -*fields* + -_optional_ -a¦ - -[markdown] +a¦ *fields* + +optional +a¦ [markdown] -- An array of strings to specify each indexed field you want to return in search results. -- [%hardbreaks] {blank} -a¦ String - array - -a¦ -*facets* + -_optional_ -a¦ - -[markdown] +a¦ String array +a¦ *facets* + +optional +a¦ [markdown] -- Contains nested objects to define each facet you want to return with search results. For more information, see [Facet Objects](../search/search-request-params.html#facet-name). @@ -6975,13 +5948,9 @@ For more information, see [Facet Objects](../search/search-request-params.html#f [%hardbreaks] {blank} a¦ Object - -a¦ -*explain* + -_optional_ -a¦ - -[markdown] +a¦ *explain* + +optional +a¦ [markdown] -- Whether to create an explanation for a search result's score in search results. -- @@ -6989,13 +5958,9 @@ Whether to create an explanation for a search result's score in search results. [%hardbreaks] {blank} a¦ Boolean - -a¦ -*sort* + -_optional_ -a¦ - -[markdown] +a¦ *sort* + +optional +a¦ [markdown] -- Contains an array of strings or JSON objects to set how to sort search results. For more information, see [Sort Object](../search/search-request-params.html#sort). @@ -7003,15 +5968,10 @@ For more information, see [Sort Object](../search/search-request-params.html#sor [%hardbreaks] {blank} -a¦ Any Type - array - -a¦ -*includeLocations* + -_optional_ -a¦ - -[markdown] +a¦ Any Type array +a¦ *includeLocations* + +optional +a¦ [markdown] -- Whether to return the position of each occurrence of a search term inside a document. -- @@ -7019,13 +5979,9 @@ Whether to return the position of each occurrence of a search term inside a docu [%hardbreaks] {blank} a¦ Boolean - -a¦ -*score* + -_optional_ -a¦ - -[markdown] +a¦ *score* + +optional +a¦ [markdown] -- Whether to include document relevancy scoring in search results. -- @@ -7033,51 +5989,36 @@ Whether to include document relevancy scoring in search results. [%hardbreaks] {blank} a¦ String - -a¦ -*search_after* + -_optional_ -a¦ - -[markdown] +a¦ *search_after* + +optional +a¦ [markdown] -- Use to control pagination in search results. -- [%hardbreaks] {blank} -a¦ String - array - -a¦ -*search_before* + -_optional_ -a¦ - -[markdown] +a¦ String array +a¦ *search_before* + +optional +a¦ [markdown] -- Use to control pagination in search results. -- [%hardbreaks] {blank} -a¦ String - array - -a¦ -*collections* + -_optional_ -a¦ - -[markdown] +a¦ String array +a¦ *collections* + +optional +a¦ [markdown] -- An array of strings that specify the collections where you want to run the query. -- [%hardbreaks] {blank} -a¦ String - array +a¦ String array |=== @@ -7085,28 +6026,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/QueryRequest/definition-end.adoc[opts=optional] - +include::{specDir}definitions/QueryRequest/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/QueryRequest/definition-after.adoc[opts=optional] - - - +ifndef::show-QueryRequest[] +:leveloffset: -1 +endif::show-QueryRequest[] -// markup not found, no include::{specDir}definitions/QueryResponse/definition-before.adoc[opts=optional] +include::{specDir}definitions/QueryRequest/definition-after.adoc[opts=optional] +include::{specDir}definitions/QueryResponse/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-QueryResponse[] [#QueryResponse] +endif::show-QueryResponse[] +ifndef::show-QueryResponse[] +:leveloffset: +1 + +[discrete#QueryResponse] +endif::show-QueryResponse[] = Query Response :leveloffset: +1 -// markup not found, no include::{specDir}definitions/QueryResponse/definition-begin.adoc[opts=optional] +include::{specDir}definitions/QueryResponse/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -7114,39 +6058,30 @@ endif::collapse-models[] //tag::QueryResponse[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the operation. -- -[%hardbreaks] -{blank} -a¦ String - -a¦ -*results* + -_optional_ -a¦ - -[markdown] +[%hardbreaks] +{blank} +a¦ String +a¦ *results* + +optional +a¦ [markdown] -- The results of the Search query. -- [%hardbreaks] {blank} -a¦ Object - array +a¦ Object array |=== @@ -7154,28 +6089,31 @@ a¦ Object -// markup not found, no include::{specDir}definitions/QueryResponse/definition-end.adoc[opts=optional] - +include::{specDir}definitions/QueryResponse/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/QueryResponse/definition-after.adoc[opts=optional] - - - +ifndef::show-QueryResponse[] +:leveloffset: -1 +endif::show-QueryResponse[] -// markup not found, no include::{specDir}definitions/StatsIndexResponse/definition-before.adoc[opts=optional] +include::{specDir}definitions/QueryResponse/definition-after.adoc[opts=optional] +include::{specDir}definitions/StatsIndexResponse/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-StatsIndexResponse[] [#StatsIndexResponse] +endif::show-StatsIndexResponse[] +ifndef::show-StatsIndexResponse[] +:leveloffset: +1 + +[discrete#StatsIndexResponse] +endif::show-StatsIndexResponse[] = Index Statistics :leveloffset: +1 -// markup not found, no include::{specDir}definitions/StatsIndexResponse/definition-begin.adoc[opts=optional] +include::{specDir}definitions/StatsIndexResponse/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -7183,31 +6121,25 @@ endif::collapse-models[] //tag::StatsIndexResponse[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*feeds* + -_optional_ -a¦ - -[markdown] +a¦ *feeds* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Object - -a¦ -*pindexes* + -_optional_ -a¦ - -[markdown] +a¦ *pindexes* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -7220,28 +6152,31 @@ a¦ Object -// markup not found, no include::{specDir}definitions/StatsIndexResponse/definition-end.adoc[opts=optional] - +include::{specDir}definitions/StatsIndexResponse/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/StatsIndexResponse/definition-after.adoc[opts=optional] - - - +ifndef::show-StatsIndexResponse[] +:leveloffset: -1 +endif::show-StatsIndexResponse[] -// markup not found, no include::{specDir}definitions/StatsNodeResponse/definition-before.adoc[opts=optional] +include::{specDir}definitions/StatsIndexResponse/definition-after.adoc[opts=optional] +include::{specDir}definitions/StatsNodeResponse/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-StatsNodeResponse[] [#StatsNodeResponse] +endif::show-StatsNodeResponse[] +ifndef::show-StatsNodeResponse[] +:leveloffset: +1 + +[discrete#StatsNodeResponse] +endif::show-StatsNodeResponse[] = Node Statistics :leveloffset: +1 -// markup not found, no include::{specDir}definitions/StatsNodeResponse/definition-begin.adoc[opts=optional] +include::{specDir}definitions/StatsNodeResponse/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -7249,30 +6184,23 @@ endif::collapse-models[] //tag::StatsNodeResponse[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*feeds* + -_optional_ -a¦ - -[markdown] +a¦ *feeds* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Object - -a¦ -*manager* + -_optional_ -a¦ - -[markdown] +a¦ *manager* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-StatsNodeResponseMgr, opts=optional] -- @@ -7280,14 +6208,11 @@ include::index.adoc[tag=desc-StatsNodeResponseMgr, opts=optional] [%hardbreaks] {blank} a¦ xref:StatsNodeResponseMgr[] - -a¦ -*pindexes* + -_optional_ -a¦ - -[markdown] +a¦ *pindexes* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -7300,28 +6225,31 @@ a¦ Object -// markup not found, no include::{specDir}definitions/StatsNodeResponse/definition-end.adoc[opts=optional] - +include::{specDir}definitions/StatsNodeResponse/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/StatsNodeResponse/definition-after.adoc[opts=optional] - - - +ifndef::show-StatsNodeResponse[] +:leveloffset: -1 +endif::show-StatsNodeResponse[] -// markup not found, no include::{specDir}definitions/StatsNodeResponseMgr/definition-before.adoc[opts=optional] +include::{specDir}definitions/StatsNodeResponse/definition-after.adoc[opts=optional] +include::{specDir}definitions/StatsNodeResponseMgr/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-StatsNodeResponseMgr[] [#StatsNodeResponseMgr] +endif::show-StatsNodeResponseMgr[] +ifndef::show-StatsNodeResponseMgr[] +:leveloffset: +1 + +[discrete#StatsNodeResponseMgr] +endif::show-StatsNodeResponseMgr[] = Manager Statistics :leveloffset: +1 -// markup not found, no include::{specDir}definitions/StatsNodeResponseMgr/definition-begin.adoc[opts=optional] +include::{specDir}definitions/StatsNodeResponseMgr/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -7329,330 +6257,255 @@ endif::collapse-models[] //tag::StatsNodeResponseMgr[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*TotCreateIndex* + -_optional_ -a¦ - -[markdown] +a¦ *TotCreateIndex* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotDeleteIndex* + -_optional_ -a¦ - -[markdown] +a¦ *TotDeleteIndex* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotUpdateIndex* + -_optional_ -a¦ - -[markdown] +a¦ *TotUpdateIndex* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBatchIntro* + -_optional_ -a¦ - -[markdown] +a¦ *TotBatchIntro* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBatchIntroFail* + -_optional_ -a¦ - -[markdown] +a¦ *TotBatchIntroFail* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBatchUpdate* + -_optional_ -a¦ - -[markdown] +a¦ *TotBatchUpdate* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBatchUpdateFail* + -_optional_ -a¦ - -[markdown] +a¦ *TotBatchUpdateFail* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBatchDelete* + -_optional_ -a¦ - -[markdown] +a¦ *TotBatchDelete* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBatchDeleteFail* + -_optional_ -a¦ - -[markdown] +a¦ *TotBatchDeleteFail* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBatchGet* + -_optional_ -a¦ - -[markdown] +a¦ *TotBatchGet* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBleveDestStart* + -_optional_ -a¦ - -[markdown] +a¦ *TotBleveDestStart* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBleveDestStop* + -_optional_ -a¦ - -[markdown] +a¦ *TotBleveDestStop* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBleveDestRemove* + -_optional_ -a¦ - -[markdown] +a¦ *TotBleveDestRemove* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBleveDestUpdate* + -_optional_ -a¦ - -[markdown] +a¦ *TotBleveDestUpdate* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBleveDestUpdateFail* + -_optional_ -a¦ - -[markdown] +a¦ *TotBleveDestUpdateFail* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBleveDestIntro* + -_optional_ -a¦ - -[markdown] +a¦ *TotBleveDestIntro* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBleveDestIntroFail* + -_optional_ -a¦ - -[markdown] +a¦ *TotBleveDestIntroFail* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBleveDestBatch* + -_optional_ -a¦ - -[markdown] +a¦ *TotBleveDestBatch* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBleveDestBatchFail* + -_optional_ -a¦ - -[markdown] +a¦ *TotBleveDestBatchFail* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBleveDestDelete* + -_optional_ -a¦ - -[markdown] +a¦ *TotBleveDestDelete* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBleveDestDeleteFail* + -_optional_ -a¦ - -[markdown] +a¦ *TotBleveDestDeleteFail* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBleveDestClose* + -_optional_ -a¦ - -[markdown] +a¦ *TotBleveDestClose* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotBleveDestCloseFail* + -_optional_ -a¦ - -[markdown] +a¦ *TotBleveDestCloseFail* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotQuery* + -_optional_ -a¦ - -[markdown] +a¦ *TotQuery* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*TotQueryFail* + -_optional_ -a¦ - -[markdown] +a¦ *TotQueryFail* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -7665,28 +6518,31 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/StatsNodeResponseMgr/definition-end.adoc[opts=optional] - +include::{specDir}definitions/StatsNodeResponseMgr/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/StatsNodeResponseMgr/definition-after.adoc[opts=optional] - - - +ifndef::show-StatsNodeResponseMgr[] +:leveloffset: -1 +endif::show-StatsNodeResponseMgr[] -// markup not found, no include::{specDir}definitions/StatusResponse/definition-before.adoc[opts=optional] +include::{specDir}definitions/StatsNodeResponseMgr/definition-after.adoc[opts=optional] +include::{specDir}definitions/StatusResponse/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-StatusResponse[] [#StatusResponse] +endif::show-StatusResponse[] +ifndef::show-StatusResponse[] +:leveloffset: +1 + +[discrete#StatusResponse] +endif::show-StatusResponse[] = Status Response :leveloffset: +1 -// markup not found, no include::{specDir}definitions/StatusResponse/definition-begin.adoc[opts=optional] +include::{specDir}definitions/StatusResponse/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -7694,17 +6550,13 @@ endif::collapse-models[] //tag::StatusResponse[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the operation. -- @@ -7712,13 +6564,9 @@ The status of the operation. [%hardbreaks] {blank} a¦ String - -a¦ -*indexStatus* + -_optional_ -a¦ - -[markdown] +a¦ *indexStatus* + +optional +a¦ [markdown] -- The status of the Search index. -- @@ -7733,26 +6581,26 @@ a¦ String -// markup not found, no include::{specDir}definitions/StatusResponse/definition-end.adoc[opts=optional] - +include::{specDir}definitions/StatusResponse/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/StatusResponse/definition-after.adoc[opts=optional] - +ifndef::show-StatusResponse[] +:leveloffset: -1 +endif::show-StatusResponse[] +include::{specDir}definitions/StatusResponse/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] - +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -7762,18 +6610,14 @@ a¦ String include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/Manage/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/Manage/security-scheme-before.adoc[opts=optional] - - -[[security-manage]] +[[security-Manage]] = Manage :leveloffset: +1 -// markup not found, no include::{specDir}security/Manage/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Manage/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -7781,29 +6625,22 @@ You must have the **Search Admin** role, with `cluster.bucket[$BUCKET_NAME].fts! -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/Manage/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Manage/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/Manage/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/Manage/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/Statistics/security-scheme-before.adoc[opts=optional] - - -// markup not found, no include::{specDir}security/Statistics/security-scheme-before.adoc[opts=optional] - - -[[security-statistics]] +[[security-Statistics]] = Statistics :leveloffset: +1 -// markup not found, no include::{specDir}security/Statistics/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Statistics/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -7811,29 +6648,22 @@ You must have the **Search Admin** role, with `cluster.bucket[$BUCKET_NAME].stat -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/Statistics/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Statistics/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/Statistics/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/Statistics/security-scheme-after.adoc[opts=optional] - - +include::{specDir}security/Read/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/Read/security-scheme-before.adoc[opts=optional] - - -[[security-read]] +[[security-Read]] = Read :leveloffset: +1 -// markup not found, no include::{specDir}security/Read/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Read/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -7841,29 +6671,22 @@ You must have the **Search Reader** or **Search Admin** role, with `cluster.buck -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/Read/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Read/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/Read/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/Read/security-scheme-after.adoc[opts=optional] - - - +include::{specDir}security/Write/security-scheme-before.adoc[opts=optional] -// markup not found, no include::{specDir}security/Write/security-scheme-before.adoc[opts=optional] - - -[[security-write]] +[[security-Write]] = Write :leveloffset: +1 -// markup not found, no include::{specDir}security/Write/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Write/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -7871,16 +6694,13 @@ You must have the **Search Admin** role, with `cluster.bucket[$BUCKET_NAME].fts! -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/Write/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Write/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/Write/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/Write/security-scheme-after.adoc[opts=optional] @@ -7888,8 +6708,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - -// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] +include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/fts-rest-indexing/search-index.gradle b/docs/modules/fts-rest-indexing/search-index.gradle index f97e5b75..cb6f6d6c 100644 --- a/docs/modules/fts-rest-indexing/search-index.gradle +++ b/docs/modules/fts-rest-indexing/search-index.gradle @@ -57,6 +57,7 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file diff --git a/docs/modules/fts-rest-manage/pages/index.adoc b/docs/modules/fts-rest-manage/pages/index.adoc index 3065a81b..baac631e 100644 --- a/docs/modules/fts-rest-manage/pages/index.adoc +++ b/docs/modules/fts-rest-manage/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbase/cbft :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -32,7 +31,7 @@ This API enables you to set Search manager options; in particular, to configure [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -67,7 +66,6 @@ The host name or IP address of a node running the Search Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -83,31 +81,26 @@ The Search Service REST port. Use `18094` for secure access. |=== - include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] +include::{specDir}overview/document-after.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] - +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 1 - +:count-apis: 0 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -115,53 +108,44 @@ xref:tag-Default[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Default] = Default :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:put_options[] -//tag::put_options[] - -// markup not found, no include::{specDir}paths/put_options/operation-before.adoc[opts=optional] +//tag::put_options[] +include::{specDir}paths/put_options/operation-before.adoc[opts=optional] [#put_options] = Modify Search Manager Options :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_options/operation-begin.adoc[opts=optional] - +include::{specDir}paths/put_options/operation-begin.adoc[opts=optional] .... PUT /api/managerOptions .... - -// markup not found, no include::{specDir}paths/put_options/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/put_options/operation-description-before.adoc[opts=optional] [#put_options-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_options/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/put_options/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -169,7 +153,6 @@ Sets Search manager options. Note that only one setting is available: `disableFileTransferRebalance`. -- - include::{specDir}paths/put_options/operation-description-end.adoc[opts=optional] @@ -181,27 +164,20 @@ include::{specDir}paths/put_options/operation-description-end.adoc[opts=optional .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/put_options/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/put_options/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_options/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/put_options/operation-parameters-before.adoc[opts=optional] [#put_options-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_options/operation-parameters-begin.adoc[opts=optional] - - - - - +include::{specDir}paths/put_options/operation-parameters-begin.adoc[opts=optional] [#put_options-body] .Body Parameter @@ -212,13 +188,10 @@ include::{specDir}paths/put_options/operation-description-end.adoc[opts=optional ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- -An object specifying Search manager options. + -- [%hardbreaks] @@ -229,26 +202,25 @@ a¦ xref:Options[] |=== -// markup not found, no include::{specDir}paths/put_options/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/put_options/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Options: -// markup not found, no include::{specDir}paths/put_options/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/put_options/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_options/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/put_options/operation-responses-before.adoc[opts=optional] [#put_options-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_options/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/put_options/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -282,121 +254,110 @@ Method not allowed. The method may be incorrectly specified. -- a| xref:Response[] - |=== - -// markup not found, no include::{specDir}paths/put_options/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/put_options/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Response: +:show-Response: +:show-Response: +:show-Response: -// markup not found, no include::{specDir}paths/put_options/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/put_options/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/put_options/operation-security-before.adoc[opts=optional] +include::{specDir}paths/put_options/operation-security-before.adoc[opts=optional] [#put_options-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/put_options/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/put_options/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/put_options/operation-security-end.adoc[opts=optional] +include::{specDir}paths/put_options/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/put_options/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/put_options/operation-security-after.adoc[opts=optional] include::{snippetDir}put_options/http-request.adoc[opts=optional] - include::{snippetDir}put_options/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/put_options/operation-end.adoc[opts=optional] +include::{specDir}paths/put_options/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/put_options/operation-after.adoc[opts=optional] - +include::{specDir}paths/put_options/operation-after.adoc[opts=optional] //end::put_options[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 2 - +:count-models: 1 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:Options[] xref:Response[] endif::[] +include::{specDir}definitions/Options/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/Options/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Options[] [#Options] +endif::show-Options[] +ifndef::show-Options[] +:leveloffset: +1 + +[discrete#Options] +endif::show-Options[] = Options :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Options/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Options/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -404,17 +365,13 @@ endif::collapse-models[] //tag::Options[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*disableFileTransferRebalance* + -_optional_ -a¦ - -[markdown] +a¦ *disableFileTransferRebalance* + +optional +a¦ [markdown] -- If the value is `false` (the default), new Search Service partitions are created during rebalance by means of partition file transfer. @@ -432,28 +389,31 @@ a¦ Boolean -// markup not found, no include::{specDir}definitions/Options/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Options/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Options/definition-after.adoc[opts=optional] - - - +ifndef::show-Options[] +:leveloffset: -1 +endif::show-Options[] -// markup not found, no include::{specDir}definitions/Response/definition-before.adoc[opts=optional] +include::{specDir}definitions/Options/definition-after.adoc[opts=optional] +include::{specDir}definitions/Response/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Response[] [#Response] +endif::show-Response[] +ifndef::show-Response[] +:leveloffset: +1 + +[discrete#Response] +endif::show-Response[] = Response :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Response/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Response/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -461,17 +421,13 @@ endif::collapse-models[] //tag::Response[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*status* + -_required_ -a¦ - -[markdown] +a¦ *status* + +required +a¦ [markdown] -- The status of the operation. @@ -480,13 +436,9 @@ The status of the operation. [%hardbreaks] {blank} a¦ String - -a¦ -*error* + -_optional_ -a¦ - -[markdown] +a¦ *error* + +optional +a¦ [markdown] -- The error message, if the operation was not successful. @@ -502,26 +454,26 @@ a¦ String -// markup not found, no include::{specDir}definitions/Response/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Response/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Response/definition-after.adoc[opts=optional] - +ifndef::show-Response[] +:leveloffset: -1 +endif::show-Response[] +include::{specDir}definitions/Response/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] - +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -531,31 +483,25 @@ a¦ String include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/Default/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/Default/security-scheme-before.adoc[opts=optional] - - -[[security-default]] +[[security-Default]] = Default :leveloffset: +1 -// markup not found, no include::{specDir}security/Default/security-scheme-begin.adoc[opts=optional] +include::{specDir}security/Default/security-scheme-begin.adoc[opts=optional] [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/Default/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Default/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/Default/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/Default/security-scheme-after.adoc[opts=optional] @@ -563,8 +509,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/fts-rest-manage/search-manage.gradle b/docs/modules/fts-rest-manage/search-manage.gradle index 0a488eaa..88a952f0 100644 --- a/docs/modules/fts-rest-manage/search-manage.gradle +++ b/docs/modules/fts-rest-manage/search-manage.gradle @@ -34,6 +34,7 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file diff --git a/docs/modules/fts-rest-nodes/pages/index.adoc b/docs/modules/fts-rest-nodes/pages/index.adoc index 8140797f..e005d8ea 100644 --- a/docs/modules/fts-rest-nodes/pages/index.adoc +++ b/docs/modules/fts-rest-nodes/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbase/cbft :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -32,7 +31,7 @@ This API enables you to manage and monitor your Search nodes. [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -67,7 +66,6 @@ The host name or IP address of a node running the Search Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -83,31 +81,26 @@ The Search Service REST port. Use `18094` for secure access. |=== - -// markup not found, no include::{specDir}overview/document-end.adoc[opts=optional] +include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}overview/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 4 - +:count-apis: 3 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -118,18 +111,14 @@ xref:tag-Monitoring[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Configuration] = Configuration :leveloffset: +1 -ifeval::["Operations for node configuration." != ""] Operations for node configuration. endif::[] -ifeval::["Operations for node configuration." == ""] -**{toc-title}** -endif::[] -endif::[] + [%hardbreaks] xref:getClusterConfig[] @@ -138,44 +127,38 @@ xref:managerMeta[] xref:refreshClusterConfig[] -//tag::getClusterConfig[] - -// markup not found, no include::{specDir}paths/getClusterConfig/operation-before.adoc[opts=optional] +//tag::getClusterConfig[] +include::{specDir}paths/getClusterConfig/operation-before.adoc[opts=optional] [#getClusterConfig] = Get Cluster Configuration :leveloffset: +1 -// markup not found, no include::{specDir}paths/getClusterConfig/operation-begin.adoc[opts=optional] - +include::{specDir}paths/getClusterConfig/operation-begin.adoc[opts=optional] .... GET /api/cfg .... - -// markup not found, no include::{specDir}paths/getClusterConfig/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/getClusterConfig/operation-description-before.adoc[opts=optional] [#getClusterConfig-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/getClusterConfig/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/getClusterConfig/operation-description-begin.adoc[opts=optional] [markdown] -- Returns the node's current view of the cluster's configuration as JSON. -- - -// markup not found, no include::{specDir}paths/getClusterConfig/operation-description-end.adoc[opts=optional] +include::{specDir}paths/getClusterConfig/operation-description-end.adoc[opts=optional] @@ -183,33 +166,29 @@ Returns the node's current view of the cluster's configuration as JSON. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/getClusterConfig/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/getClusterConfig/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/getClusterConfig/operation-description-after.adoc[opts=optional] +include::{specDir}paths/getClusterConfig/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getClusterConfig/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/getClusterConfig/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getClusterConfig/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/getClusterConfig/operation-responses-before.adoc[opts=optional] [#getClusterConfig-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/getClusterConfig/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/getClusterConfig/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -222,30 +201,27 @@ A JSON object containing the node's configuration. -- a| xref:clusterConfig[] - |=== - -// markup not found, no include::{specDir}paths/getClusterConfig/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/getClusterConfig/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-clusterConfig: -// markup not found, no include::{specDir}paths/getClusterConfig/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/getClusterConfig/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getClusterConfig/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/getClusterConfig/operation-security-before.adoc[opts=optional] [#getClusterConfig-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/getClusterConfig/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/getClusterConfig/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== @@ -256,103 +232,82 @@ a| xref:clusterConfig[] |=== - -// markup not found, no include::{specDir}paths/getClusterConfig/operation-security-end.adoc[opts=optional] +include::{specDir}paths/getClusterConfig/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/getClusterConfig/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getClusterConfig/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}getClusterConfig/http-request.adoc[opts=optional] - +include::{snippetDir}getClusterConfig/http-request.adoc[opts=optional] include::{snippetDir}getClusterConfig/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/getClusterConfig/operation-end.adoc[opts=optional] +include::{specDir}paths/getClusterConfig/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/getClusterConfig/operation-after.adoc[opts=optional] - +include::{specDir}paths/getClusterConfig/operation-after.adoc[opts=optional] //end::getClusterConfig[] - //tag::managerKick[] - -// markup not found, no include::{specDir}paths/managerKick/operation-before.adoc[opts=optional] - +include::{specDir}paths/managerKick/operation-before.adoc[opts=optional] [#managerKick] = Replan Resource Assignments :leveloffset: +1 -// markup not found, no include::{specDir}paths/managerKick/operation-begin.adoc[opts=optional] - +include::{specDir}paths/managerKick/operation-begin.adoc[opts=optional] .... POST /api/managerKick .... - -// markup not found, no include::{specDir}paths/managerKick/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/managerKick/operation-description-before.adoc[opts=optional] [#managerKick-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/managerKick/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/managerKick/operation-description-begin.adoc[opts=optional] [markdown] -- Forces the node to replan resource assignments, (by running the planner, if enabled) and update its runtime state to reflect the latest plan (by running the janitor, if enabled). -- +include::{specDir}paths/managerKick/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/managerKick/operation-description-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/managerKick/operation-description-after.adoc[opts=optional] - +include::{specDir}paths/managerKick/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/managerKick/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/managerKick/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/managerKick/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/managerKick/operation-parameters-after.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/managerKick/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/managerKick/operation-responses-before.adoc[opts=optional] [#managerKick-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/managerKick/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/managerKick/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -367,27 +322,24 @@ a| |=== - -// markup not found, no include::{specDir}paths/managerKick/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/managerKick/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/managerKick/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/managerKick/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/managerKick/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/managerKick/operation-security-before.adoc[opts=optional] [#managerKick-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/managerKick/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/managerKick/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== @@ -398,64 +350,48 @@ a| |=== - -// markup not found, no include::{specDir}paths/managerKick/operation-security-end.adoc[opts=optional] +include::{specDir}paths/managerKick/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/managerKick/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/managerKick/operation-security-after.adoc[opts=optional] - +include::{snippetDir}managerKick/http-request.adoc[opts=optional] +include::{snippetDir}managerKick/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}managerKick/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}managerKick/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/managerKick/operation-end.adoc[opts=optional] +include::{specDir}paths/managerKick/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/managerKick/operation-after.adoc[opts=optional] - +include::{specDir}paths/managerKick/operation-after.adoc[opts=optional] //end::managerKick[] - //tag::managerMeta[] - -// markup not found, no include::{specDir}paths/managerMeta/operation-before.adoc[opts=optional] - +include::{specDir}paths/managerMeta/operation-before.adoc[opts=optional] [#managerMeta] = Get Node Capabilities :leveloffset: +1 -// markup not found, no include::{specDir}paths/managerMeta/operation-begin.adoc[opts=optional] - +include::{specDir}paths/managerMeta/operation-begin.adoc[opts=optional] .... GET /api/managerMeta .... - -// markup not found, no include::{specDir}paths/managerMeta/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/managerMeta/operation-description-before.adoc[opts=optional] [#managerMeta-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/managerMeta/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/managerMeta/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -463,8 +399,7 @@ Returns information on the node's capabilities, including available indexing and This operation is intended to help management tools and web UIs to be more dynamically metadata driven. -- - -// markup not found, no include::{specDir}paths/managerMeta/operation-description-end.adoc[opts=optional] +include::{specDir}paths/managerMeta/operation-description-end.adoc[opts=optional] @@ -472,33 +407,29 @@ This operation is intended to help management tools and web UIs to be more dynam .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/managerMeta/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/managerMeta/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/managerMeta/operation-description-after.adoc[opts=optional] +include::{specDir}paths/managerMeta/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/managerMeta/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/managerMeta/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/managerMeta/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/managerMeta/operation-responses-before.adoc[opts=optional] [#managerMeta-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/managerMeta/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/managerMeta/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -511,30 +442,26 @@ A JSON object containing the node's capabilities. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/managerMeta/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/managerMeta/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/managerMeta/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/managerMeta/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/managerMeta/operation-security-before.adoc[opts=optional] +include::{specDir}paths/managerMeta/operation-security-before.adoc[opts=optional] [#managerMeta-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/managerMeta/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/managerMeta/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== @@ -545,103 +472,82 @@ a| Object |=== - -// markup not found, no include::{specDir}paths/managerMeta/operation-security-end.adoc[opts=optional] +include::{specDir}paths/managerMeta/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/managerMeta/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/managerMeta/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}managerMeta/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}managerMeta/http-response.adoc[opts=optional] - +include::{snippetDir}managerMeta/http-request.adoc[opts=optional] +include::{snippetDir}managerMeta/http-response.adoc[opts=optional] -// markup not found, no include::{specDir}paths/managerMeta/operation-end.adoc[opts=optional] +include::{specDir}paths/managerMeta/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/managerMeta/operation-after.adoc[opts=optional] - +include::{specDir}paths/managerMeta/operation-after.adoc[opts=optional] //end::managerMeta[] - //tag::refreshClusterConfig[] - -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-before.adoc[opts=optional] - +include::{specDir}paths/refreshClusterConfig/operation-before.adoc[opts=optional] [#refreshClusterConfig] = Refresh Node Configuration :leveloffset: +1 -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-begin.adoc[opts=optional] - +include::{specDir}paths/refreshClusterConfig/operation-begin.adoc[opts=optional] .... POST /api/cfgRefresh .... - -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/refreshClusterConfig/operation-description-before.adoc[opts=optional] [#refreshClusterConfig-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/refreshClusterConfig/operation-description-begin.adoc[opts=optional] [markdown] -- Requests the node to refresh its configuration from the configuration provider. -- +include::{specDir}paths/refreshClusterConfig/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-description-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/refreshClusterConfig/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-description-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/refreshClusterConfig/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/refreshClusterConfig/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/refreshClusterConfig/operation-responses-before.adoc[opts=optional] [#refreshClusterConfig-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/refreshClusterConfig/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -656,27 +562,24 @@ a| |=== - -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/refreshClusterConfig/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/refreshClusterConfig/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-security-before.adoc[opts=optional] +include::{specDir}paths/refreshClusterConfig/operation-security-before.adoc[opts=optional] [#refreshClusterConfig-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/refreshClusterConfig/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== @@ -687,51 +590,38 @@ a| |=== - -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-security-end.adoc[opts=optional] +include::{specDir}paths/refreshClusterConfig/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/refreshClusterConfig/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}refreshClusterConfig/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}refreshClusterConfig/http-response.adoc[opts=optional] - +include::{snippetDir}refreshClusterConfig/http-request.adoc[opts=optional] +include::{snippetDir}refreshClusterConfig/http-response.adoc[opts=optional] -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-end.adoc[opts=optional] +include::{specDir}paths/refreshClusterConfig/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-after.adoc[opts=optional] - +include::{specDir}paths/refreshClusterConfig/operation-after.adoc[opts=optional] //end::refreshClusterConfig[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Diagnostics] = Diagnostics :leveloffset: +1 -ifeval::["Operations for node diagnostics." != ""] Operations for node diagnostics. endif::[] -ifeval::["Operations for node diagnostics." == ""] -**{toc-title}** -endif::[] -endif::[] + [%hardbreaks] xref:captureCpuProfile[] @@ -742,75 +632,65 @@ xref:getRuntimeArgs[] xref:getRuntimeInfo[] -//tag::captureCpuProfile[] - -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-before.adoc[opts=optional] +//tag::captureCpuProfile[] +include::{specDir}paths/captureCpuProfile/operation-before.adoc[opts=optional] [#captureCpuProfile] = Capture CPU Profiling Information :leveloffset: +1 -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-begin.adoc[opts=optional] - +include::{specDir}paths/captureCpuProfile/operation-begin.adoc[opts=optional] .... POST /api/runtime/profile/cpu .... - -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/captureCpuProfile/operation-description-before.adoc[opts=optional] [#captureCpuProfile-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/captureCpuProfile/operation-description-begin.adoc[opts=optional] [markdown] -- Requests the node to capture local CPU usage profiling information. -- +include::{specDir}paths/captureCpuProfile/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-description-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-description-after.adoc[opts=optional] - +include::{specDir}paths/captureCpuProfile/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/captureCpuProfile/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/captureCpuProfile/operation-parameters-after.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/captureCpuProfile/operation-responses-before.adoc[opts=optional] [#captureCpuProfile-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/captureCpuProfile/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -825,27 +705,24 @@ a| |=== - -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/captureCpuProfile/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/captureCpuProfile/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/captureCpuProfile/operation-security-before.adoc[opts=optional] [#captureCpuProfile-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/captureCpuProfile/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== @@ -856,103 +733,82 @@ a| |=== - -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-security-end.adoc[opts=optional] +include::{specDir}paths/captureCpuProfile/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/captureCpuProfile/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-security-after.adoc[opts=optional] - +include::{snippetDir}captureCpuProfile/http-request.adoc[opts=optional] +include::{snippetDir}captureCpuProfile/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}captureCpuProfile/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}captureCpuProfile/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-end.adoc[opts=optional] +include::{specDir}paths/captureCpuProfile/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/captureCpuProfile/operation-after.adoc[opts=optional] - +include::{specDir}paths/captureCpuProfile/operation-after.adoc[opts=optional] //end::captureCpuProfile[] - //tag::captureMemoryProfile[] - -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-before.adoc[opts=optional] - +include::{specDir}paths/captureMemoryProfile/operation-before.adoc[opts=optional] [#captureMemoryProfile] = Capture Memory Profiling Information :leveloffset: +1 -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-begin.adoc[opts=optional] - +include::{specDir}paths/captureMemoryProfile/operation-begin.adoc[opts=optional] .... POST /api/runtime/profile/memory .... - -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/captureMemoryProfile/operation-description-before.adoc[opts=optional] [#captureMemoryProfile-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/captureMemoryProfile/operation-description-begin.adoc[opts=optional] [markdown] -- Requests the node to capture local memory usage profiling information. -- +include::{specDir}paths/captureMemoryProfile/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-description-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-description-after.adoc[opts=optional] - +include::{specDir}paths/captureMemoryProfile/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/captureMemoryProfile/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/captureMemoryProfile/operation-parameters-after.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/captureMemoryProfile/operation-responses-before.adoc[opts=optional] [#captureMemoryProfile-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/captureMemoryProfile/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -967,27 +823,24 @@ a| |=== - -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/captureMemoryProfile/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/captureMemoryProfile/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/captureMemoryProfile/operation-security-before.adoc[opts=optional] [#captureMemoryProfile-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/captureMemoryProfile/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== @@ -998,64 +851,48 @@ a| |=== - -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-security-end.adoc[opts=optional] +include::{specDir}paths/captureMemoryProfile/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/captureMemoryProfile/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-security-after.adoc[opts=optional] - +include::{snippetDir}captureMemoryProfile/http-request.adoc[opts=optional] +include::{snippetDir}captureMemoryProfile/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}captureMemoryProfile/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}captureMemoryProfile/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-end.adoc[opts=optional] +include::{specDir}paths/captureMemoryProfile/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-after.adoc[opts=optional] - +include::{specDir}paths/captureMemoryProfile/operation-after.adoc[opts=optional] //end::captureMemoryProfile[] - //tag::getDiagnostics[] - -// markup not found, no include::{specDir}paths/getDiagnostics/operation-before.adoc[opts=optional] - +include::{specDir}paths/getDiagnostics/operation-before.adoc[opts=optional] [#getDiagnostics] = Get Diagnostics :leveloffset: +1 -// markup not found, no include::{specDir}paths/getDiagnostics/operation-begin.adoc[opts=optional] - +include::{specDir}paths/getDiagnostics/operation-begin.adoc[opts=optional] .... GET /api/diag .... - -// markup not found, no include::{specDir}paths/getDiagnostics/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/getDiagnostics/operation-description-before.adoc[opts=optional] [#getDiagnostics-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/getDiagnostics/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/getDiagnostics/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -1075,8 +912,7 @@ The response JSON object can be quite large, 100s of KB or much more. The motivation for this operation is to simplify working with the Couchbase community, forums, technical support, and other engineers, by making data capture from each Search node a single step. -- - -// markup not found, no include::{specDir}paths/getDiagnostics/operation-description-end.adoc[opts=optional] +include::{specDir}paths/getDiagnostics/operation-description-end.adoc[opts=optional] @@ -1084,33 +920,29 @@ The motivation for this operation is to simplify working with the Couchbase comm .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/getDiagnostics/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/getDiagnostics/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/getDiagnostics/operation-description-after.adoc[opts=optional] +include::{specDir}paths/getDiagnostics/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getDiagnostics/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/getDiagnostics/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getDiagnostics/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/getDiagnostics/operation-responses-before.adoc[opts=optional] [#getDiagnostics-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/getDiagnostics/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/getDiagnostics/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1123,30 +955,26 @@ A JSON object containing the node's diagnostics. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/getDiagnostics/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/getDiagnostics/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/getDiagnostics/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/getDiagnostics/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getDiagnostics/operation-security-before.adoc[opts=optional] +include::{specDir}paths/getDiagnostics/operation-security-before.adoc[opts=optional] [#getDiagnostics-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/getDiagnostics/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/getDiagnostics/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== @@ -1157,72 +985,55 @@ a| Object |=== - -// markup not found, no include::{specDir}paths/getDiagnostics/operation-security-end.adoc[opts=optional] +include::{specDir}paths/getDiagnostics/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/getDiagnostics/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getDiagnostics/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}getDiagnostics/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}getDiagnostics/http-response.adoc[opts=optional] - +include::{snippetDir}getDiagnostics/http-request.adoc[opts=optional] +include::{snippetDir}getDiagnostics/http-response.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getDiagnostics/operation-end.adoc[opts=optional] +include::{specDir}paths/getDiagnostics/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/getDiagnostics/operation-after.adoc[opts=optional] - +include::{specDir}paths/getDiagnostics/operation-after.adoc[opts=optional] //end::getDiagnostics[] - //tag::getLogs[] - -// markup not found, no include::{specDir}paths/getLogs/operation-before.adoc[opts=optional] - +include::{specDir}paths/getLogs/operation-before.adoc[opts=optional] [#getLogs] = Get Node Logs :leveloffset: +1 -// markup not found, no include::{specDir}paths/getLogs/operation-begin.adoc[opts=optional] - +include::{specDir}paths/getLogs/operation-begin.adoc[opts=optional] .... GET /api/log .... - -// markup not found, no include::{specDir}paths/getLogs/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/getLogs/operation-description-before.adoc[opts=optional] [#getLogs-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/getLogs/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/getLogs/operation-description-begin.adoc[opts=optional] [markdown] -- Returns recent log messages and key events for the node as JSON. -- - -// markup not found, no include::{specDir}paths/getLogs/operation-description-end.adoc[opts=optional] +include::{specDir}paths/getLogs/operation-description-end.adoc[opts=optional] @@ -1230,33 +1041,29 @@ Returns recent log messages and key events for the node as JSON. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/getLogs/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/getLogs/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/getLogs/operation-description-after.adoc[opts=optional] +include::{specDir}paths/getLogs/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getLogs/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/getLogs/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getLogs/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/getLogs/operation-responses-before.adoc[opts=optional] [#getLogs-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/getLogs/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/getLogs/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1269,30 +1076,27 @@ A JSON object containing the node's logs. -- a| xref:logInfo[] - |=== - -// markup not found, no include::{specDir}paths/getLogs/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/getLogs/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-logInfo: -// markup not found, no include::{specDir}paths/getLogs/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/getLogs/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getLogs/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/getLogs/operation-security-before.adoc[opts=optional] [#getLogs-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/getLogs/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/getLogs/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== @@ -1303,72 +1107,55 @@ a| xref:logInfo[] |=== - -// markup not found, no include::{specDir}paths/getLogs/operation-security-end.adoc[opts=optional] +include::{specDir}paths/getLogs/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/getLogs/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getLogs/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}getLogs/http-request.adoc[opts=optional] - +include::{snippetDir}getLogs/http-request.adoc[opts=optional] include::{snippetDir}getLogs/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/getLogs/operation-end.adoc[opts=optional] +include::{specDir}paths/getLogs/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/getLogs/operation-after.adoc[opts=optional] - +include::{specDir}paths/getLogs/operation-after.adoc[opts=optional] //end::getLogs[] - //tag::getRuntimeArgs[] - -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-before.adoc[opts=optional] - +include::{specDir}paths/getRuntimeArgs/operation-before.adoc[opts=optional] [#getRuntimeArgs] = Get Node Runtime Arguments :leveloffset: +1 -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-begin.adoc[opts=optional] - +include::{specDir}paths/getRuntimeArgs/operation-begin.adoc[opts=optional] .... GET /api/runtime/args .... - -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/getRuntimeArgs/operation-description-before.adoc[opts=optional] [#getRuntimeArgs-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/getRuntimeArgs/operation-description-begin.adoc[opts=optional] [markdown] -- Returns information on the node's command-line, parameters, environment variables, and OS process values as JSON. -- - -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-description-end.adoc[opts=optional] +include::{specDir}paths/getRuntimeArgs/operation-description-end.adoc[opts=optional] @@ -1376,33 +1163,29 @@ Returns information on the node's command-line, parameters, environment variable .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/getRuntimeArgs/operation-description-after.adoc[opts=optional] +include::{specDir}paths/getRuntimeArgs/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/getRuntimeArgs/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/getRuntimeArgs/operation-responses-before.adoc[opts=optional] [#getRuntimeArgs-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/getRuntimeArgs/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1415,30 +1198,26 @@ A JSON object containing the node's runtime arguments. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/getRuntimeArgs/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/getRuntimeArgs/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-security-before.adoc[opts=optional] +include::{specDir}paths/getRuntimeArgs/operation-security-before.adoc[opts=optional] [#getRuntimeArgs-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/getRuntimeArgs/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== @@ -1449,72 +1228,55 @@ a| Object |=== - -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-security-end.adoc[opts=optional] +include::{specDir}paths/getRuntimeArgs/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/getRuntimeArgs/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-security-after.adoc[opts=optional] +include::{snippetDir}getRuntimeArgs/http-request.adoc[opts=optional] +include::{snippetDir}getRuntimeArgs/http-response.adoc[opts=optional] - -// markup not found, no include::{snippetDir}getRuntimeArgs/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}getRuntimeArgs/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-end.adoc[opts=optional] +include::{specDir}paths/getRuntimeArgs/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-after.adoc[opts=optional] - +include::{specDir}paths/getRuntimeArgs/operation-after.adoc[opts=optional] //end::getRuntimeArgs[] - //tag::getRuntimeInfo[] - -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-before.adoc[opts=optional] - +include::{specDir}paths/getRuntimeInfo/operation-before.adoc[opts=optional] [#getRuntimeInfo] = Get Node Runtime Information :leveloffset: +1 -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-begin.adoc[opts=optional] - +include::{specDir}paths/getRuntimeInfo/operation-begin.adoc[opts=optional] .... GET /api/runtime .... - -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/getRuntimeInfo/operation-description-before.adoc[opts=optional] [#getRuntimeInfo-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/getRuntimeInfo/operation-description-begin.adoc[opts=optional] [markdown] -- Returns information on the node's software, such as version strings and slow-changing runtime settings, as JSON. -- - -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-description-end.adoc[opts=optional] +include::{specDir}paths/getRuntimeInfo/operation-description-end.adoc[opts=optional] @@ -1522,33 +1284,29 @@ Returns information on the node's software, such as version strings and slow-cha .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/getRuntimeInfo/operation-description-after.adoc[opts=optional] +include::{specDir}paths/getRuntimeInfo/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/getRuntimeInfo/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/getRuntimeInfo/operation-responses-before.adoc[opts=optional] [#getRuntimeInfo-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/getRuntimeInfo/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1561,30 +1319,27 @@ A JSON object containing the node's runtime information. -- a| xref:runtimeInfo[] - |=== - -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/getRuntimeInfo/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-runtimeInfo: -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/getRuntimeInfo/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/getRuntimeInfo/operation-security-before.adoc[opts=optional] [#getRuntimeInfo-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/getRuntimeInfo/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== @@ -1595,125 +1350,102 @@ a| xref:runtimeInfo[] |=== - -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-security-end.adoc[opts=optional] +include::{specDir}paths/getRuntimeInfo/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/getRuntimeInfo/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}getRuntimeInfo/http-request.adoc[opts=optional] - +include::{snippetDir}getRuntimeInfo/http-request.adoc[opts=optional] include::{snippetDir}getRuntimeInfo/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-end.adoc[opts=optional] +include::{specDir}paths/getRuntimeInfo/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-after.adoc[opts=optional] - +include::{specDir}paths/getRuntimeInfo/operation-after.adoc[opts=optional] //end::getRuntimeInfo[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Management] = Management :leveloffset: +1 -ifeval::["Operations for node management." != ""] Operations for node management. endif::[] -ifeval::["Operations for node management." == ""] -**{toc-title}** -endif::[] -endif::[] + [%hardbreaks] xref:performGC[] -//tag::performGC[] - -// markup not found, no include::{specDir}paths/performGC/operation-before.adoc[opts=optional] +//tag::performGC[] +include::{specDir}paths/performGC/operation-before.adoc[opts=optional] [#performGC] = Perform Garbage Collection :leveloffset: +1 -// markup not found, no include::{specDir}paths/performGC/operation-begin.adoc[opts=optional] - +include::{specDir}paths/performGC/operation-begin.adoc[opts=optional] .... POST /api/runtime/gc .... - -// markup not found, no include::{specDir}paths/performGC/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/performGC/operation-description-before.adoc[opts=optional] [#performGC-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/performGC/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/performGC/operation-description-begin.adoc[opts=optional] [markdown] -- Requests the node to perform a garbage collection. -- +include::{specDir}paths/performGC/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/performGC/operation-description-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/performGC/operation-description-after.adoc[opts=optional] +include::{specDir}paths/performGC/operation-description-after.adoc[opts=optional] +include::{specDir}paths/performGC/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/performGC/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/performGC/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/performGC/operation-parameters-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/performGC/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/performGC/operation-responses-before.adoc[opts=optional] [#performGC-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/performGC/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/performGC/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1728,27 +1460,24 @@ a| |=== - -// markup not found, no include::{specDir}paths/performGC/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/performGC/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/performGC/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/performGC/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/performGC/operation-security-before.adoc[opts=optional] +include::{specDir}paths/performGC/operation-security-before.adoc[opts=optional] [#performGC-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/performGC/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/performGC/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== @@ -1759,95 +1488,76 @@ a| |=== - -// markup not found, no include::{specDir}paths/performGC/operation-security-end.adoc[opts=optional] +include::{specDir}paths/performGC/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/performGC/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/performGC/operation-security-after.adoc[opts=optional] +include::{snippetDir}performGC/http-request.adoc[opts=optional] +include::{snippetDir}performGC/http-response.adoc[opts=optional] - -// markup not found, no include::{snippetDir}performGC/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}performGC/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/performGC/operation-end.adoc[opts=optional] +include::{specDir}paths/performGC/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/performGC/operation-after.adoc[opts=optional] - +include::{specDir}paths/performGC/operation-after.adoc[opts=optional] //end::performGC[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Monitoring] = Monitoring :leveloffset: +1 -ifeval::["Operations for node monitoring." != ""] Operations for node monitoring. endif::[] -ifeval::["Operations for node monitoring." == ""] -**{toc-title}** -endif::[] -endif::[] + [%hardbreaks] xref:getMemoryStats[] xref:getRuntimeStats[] -//tag::getMemoryStats[] - -// markup not found, no include::{specDir}paths/getMemoryStats/operation-before.adoc[opts=optional] +//tag::getMemoryStats[] +include::{specDir}paths/getMemoryStats/operation-before.adoc[opts=optional] [#getMemoryStats] = Get Memory Statistics :leveloffset: +1 -// markup not found, no include::{specDir}paths/getMemoryStats/operation-begin.adoc[opts=optional] - +include::{specDir}paths/getMemoryStats/operation-begin.adoc[opts=optional] .... GET /api/runtime/statsMem .... - -// markup not found, no include::{specDir}paths/getMemoryStats/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/getMemoryStats/operation-description-before.adoc[opts=optional] [#getMemoryStats-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/getMemoryStats/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/getMemoryStats/operation-description-begin.adoc[opts=optional] [markdown] -- Returns information on the node's low-level garbage collection and memory-related runtime stats as JSON. -- - -// markup not found, no include::{specDir}paths/getMemoryStats/operation-description-end.adoc[opts=optional] +include::{specDir}paths/getMemoryStats/operation-description-end.adoc[opts=optional] @@ -1855,33 +1565,29 @@ Returns information on the node's low-level garbage collection and memory-relate .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/getMemoryStats/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/getMemoryStats/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/getMemoryStats/operation-description-after.adoc[opts=optional] +include::{specDir}paths/getMemoryStats/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getMemoryStats/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/getMemoryStats/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getMemoryStats/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/getMemoryStats/operation-responses-before.adoc[opts=optional] [#getMemoryStats-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/getMemoryStats/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/getMemoryStats/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1894,30 +1600,26 @@ A JSON object containing the node's memory statistics. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/getMemoryStats/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/getMemoryStats/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/getMemoryStats/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/getMemoryStats/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getMemoryStats/operation-security-before.adoc[opts=optional] +include::{specDir}paths/getMemoryStats/operation-security-before.adoc[opts=optional] [#getMemoryStats-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/getMemoryStats/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/getMemoryStats/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== @@ -1928,72 +1630,55 @@ a| Object |=== - -// markup not found, no include::{specDir}paths/getMemoryStats/operation-security-end.adoc[opts=optional] +include::{specDir}paths/getMemoryStats/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/getMemoryStats/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getMemoryStats/operation-security-after.adoc[opts=optional] +include::{snippetDir}getMemoryStats/http-request.adoc[opts=optional] +include::{snippetDir}getMemoryStats/http-response.adoc[opts=optional] - -// markup not found, no include::{snippetDir}getMemoryStats/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}getMemoryStats/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/getMemoryStats/operation-end.adoc[opts=optional] +include::{specDir}paths/getMemoryStats/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/getMemoryStats/operation-after.adoc[opts=optional] - +include::{specDir}paths/getMemoryStats/operation-after.adoc[opts=optional] //end::getMemoryStats[] - //tag::getRuntimeStats[] - -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-before.adoc[opts=optional] - +include::{specDir}paths/getRuntimeStats/operation-before.adoc[opts=optional] [#getRuntimeStats] = Get Runtime Statistics :leveloffset: +1 -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-begin.adoc[opts=optional] - +include::{specDir}paths/getRuntimeStats/operation-begin.adoc[opts=optional] .... GET /api/runtime/stats .... - -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/getRuntimeStats/operation-description-before.adoc[opts=optional] [#getRuntimeStats-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/getRuntimeStats/operation-description-begin.adoc[opts=optional] [markdown] -- Returns information on the node's low-level runtime stats as JSON. -- - -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-description-end.adoc[opts=optional] +include::{specDir}paths/getRuntimeStats/operation-description-end.adoc[opts=optional] @@ -2001,33 +1686,29 @@ Returns information on the node's low-level runtime stats as JSON. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/getRuntimeStats/operation-description-after.adoc[opts=optional] +include::{specDir}paths/getRuntimeStats/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/getRuntimeStats/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/getRuntimeStats/operation-responses-before.adoc[opts=optional] [#getRuntimeStats-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/getRuntimeStats/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2040,30 +1721,26 @@ A JSON object containing the node's low-level runtime statistics. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/getRuntimeStats/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/getRuntimeStats/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/getRuntimeStats/operation-security-before.adoc[opts=optional] [#getRuntimeStats-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/getRuntimeStats/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== @@ -2074,68 +1751,55 @@ a| Object |=== - -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-security-end.adoc[opts=optional] +include::{specDir}paths/getRuntimeStats/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/getRuntimeStats/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}getRuntimeStats/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}getRuntimeStats/http-response.adoc[opts=optional] +include::{snippetDir}getRuntimeStats/http-request.adoc[opts=optional] +include::{snippetDir}getRuntimeStats/http-response.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-end.adoc[opts=optional] +include::{specDir}paths/getRuntimeStats/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/getRuntimeStats/operation-after.adoc[opts=optional] - +include::{specDir}paths/getRuntimeStats/operation-after.adoc[opts=optional] //end::getRuntimeStats[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 19 - +:count-models: 18 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:clusterConfig[] xref:clusterConfigIndexes[] @@ -2159,19 +1823,21 @@ xref:runtimeInfoGo[] endif::[] +include::{specDir}definitions/clusterConfig/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/clusterConfig/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-clusterConfig[] [#clusterConfig] +endif::show-clusterConfig[] +ifndef::show-clusterConfig[] +:leveloffset: +1 + +[discrete#clusterConfig] +endif::show-clusterConfig[] = Cluster Configuration :leveloffset: +1 -// markup not found, no include::{specDir}definitions/clusterConfig/definition-begin.adoc[opts=optional] +include::{specDir}definitions/clusterConfig/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2179,17 +1845,13 @@ endif::collapse-models[] //tag::clusterConfig[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*indexDefs* + -_optional_ -a¦ - -[markdown] +a¦ *indexDefs* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-clusterConfigIndexes, opts=optional] -- @@ -2197,13 +1859,9 @@ include::index.adoc[tag=desc-clusterConfigIndexes, opts=optional] [%hardbreaks] {blank} a¦ xref:clusterConfigIndexes[] - -a¦ -*indexDefsCAS* + -_optional_ -a¦ - -[markdown] +a¦ *indexDefsCAS* + +optional +a¦ [markdown] -- Search index definition concurrency (compare and swap) value. -- @@ -2211,27 +1869,20 @@ Search index definition concurrency (compare and swap) value. [%hardbreaks] {blank} a¦ Integer - -a¦ -*indexDefsErr* + -_optional_ -a¦ - -[markdown] +a¦ *indexDefsErr* + +optional +a¦ [markdown] -- Search index definition error. -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*nodeDefsKnown* + -_optional_ -a¦ - -[markdown] +a¦ *nodeDefsKnown* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-clusterConfigNodesKnown, opts=optional] -- @@ -2239,13 +1890,9 @@ include::index.adoc[tag=desc-clusterConfigNodesKnown, opts=optional] [%hardbreaks] {blank} a¦ xref:clusterConfigNodesKnown[] - -a¦ -*nodeDefsKnownCAS* + -_optional_ -a¦ - -[markdown] +a¦ *nodeDefsKnownCAS* + +optional +a¦ [markdown] -- Known node definition concurrency (compare and swap) value. -- @@ -2253,27 +1900,20 @@ Known node definition concurrency (compare and swap) value. [%hardbreaks] {blank} a¦ Integer - -a¦ -*nodeDefsKnownErr* + -_optional_ -a¦ - -[markdown] +a¦ *nodeDefsKnownErr* + +optional +a¦ [markdown] -- Known node definition error. -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*nodeDefsWanted* + -_optional_ -a¦ - -[markdown] +a¦ *nodeDefsWanted* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-clusterConfigNodesWanted, opts=optional] -- @@ -2281,13 +1921,9 @@ include::index.adoc[tag=desc-clusterConfigNodesWanted, opts=optional] [%hardbreaks] {blank} a¦ xref:clusterConfigNodesWanted[] - -a¦ -*nodeDefsWantedCAS* + -_optional_ -a¦ - -[markdown] +a¦ *nodeDefsWantedCAS* + +optional +a¦ [markdown] -- Wanted node definition concurrency (compare and swap) value. -- @@ -2295,27 +1931,20 @@ Wanted node definition concurrency (compare and swap) value. [%hardbreaks] {blank} a¦ Integer - -a¦ -*nodeDefsWantedErr* + -_optional_ -a¦ - -[markdown] +a¦ *nodeDefsWantedErr* + +optional +a¦ [markdown] -- Wanted node definition error. -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*planPIndexes* + -_optional_ -a¦ - -[markdown] +a¦ *planPIndexes* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-clusterConfigPlan, opts=optional] -- @@ -2323,13 +1952,9 @@ include::index.adoc[tag=desc-clusterConfigPlan, opts=optional] [%hardbreaks] {blank} a¦ xref:clusterConfigPlan[] - -a¦ -*planPIndexesCAS* + -_optional_ -a¦ - -[markdown] +a¦ *planPIndexesCAS* + +optional +a¦ [markdown] -- Search index partition concurrency (compare and swap) value. -- @@ -2337,27 +1962,20 @@ Search index partition concurrency (compare and swap) value. [%hardbreaks] {blank} a¦ Integer - -a¦ -*planPIndexesErr* + -_optional_ -a¦ - -[markdown] +a¦ *planPIndexesErr* + +optional +a¦ [markdown] -- Search index partition error. -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the operation. -- @@ -2372,28 +1990,37 @@ a¦ String -// markup not found, no include::{specDir}definitions/clusterConfig/definition-end.adoc[opts=optional] - +include::{specDir}definitions/clusterConfig/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/clusterConfig/definition-after.adoc[opts=optional] - - - +ifndef::show-clusterConfig[] +:leveloffset: -1 +endif::show-clusterConfig[] -// markup not found, no include::{specDir}definitions/clusterConfigIndexes/definition-before.adoc[opts=optional] +include::{specDir}definitions/clusterConfig/definition-after.adoc[opts=optional] +include::{specDir}definitions/clusterConfigIndexes/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-clusterConfigIndexes[] [#clusterConfigIndexes] +endif::show-clusterConfigIndexes[] +ifndef::show-clusterConfigIndexes[] +:leveloffset: +1 + +[discrete#clusterConfigIndexes] +endif::show-clusterConfigIndexes[] = Index Definitions +ifdef::model-descriptions[] +//tag::desc-clusterConfigIndexes[] +An object containing Search index definitions and related information. +//end::desc-clusterConfigIndexes[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/clusterConfigIndexes/definition-begin.adoc[opts=optional] +include::{specDir}definitions/clusterConfigIndexes/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2401,35 +2028,23 @@ endif::collapse-models[] //tag::clusterConfigIndexes[] -ifdef::model-descriptions[] -//tag::desc-clusterConfigIndexes[] -An object containing Search index definitions and related information. -//end::desc-clusterConfigIndexes[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*implVersion* + -_optional_ -a¦ - -[markdown] +a¦ *implVersion* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*indexDefs* + -_optional_ -a¦ - -[markdown] +a¦ *indexDefs* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-GetIndexesResponseIndexesWrapper, opts=optional] -- @@ -2444,28 +2059,37 @@ a¦ xref:GetIndexesResponseIndexesWrapper[] -// markup not found, no include::{specDir}definitions/clusterConfigIndexes/definition-end.adoc[opts=optional] - +include::{specDir}definitions/clusterConfigIndexes/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/clusterConfigIndexes/definition-after.adoc[opts=optional] - - - +ifndef::show-clusterConfigIndexes[] +:leveloffset: -1 +endif::show-clusterConfigIndexes[] -// markup not found, no include::{specDir}definitions/clusterConfigNodesKnown/definition-before.adoc[opts=optional] +include::{specDir}definitions/clusterConfigIndexes/definition-after.adoc[opts=optional] +include::{specDir}definitions/clusterConfigNodesKnown/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-clusterConfigNodesKnown[] [#clusterConfigNodesKnown] +endif::show-clusterConfigNodesKnown[] +ifndef::show-clusterConfigNodesKnown[] +:leveloffset: +1 + +[discrete#clusterConfigNodesKnown] +endif::show-clusterConfigNodesKnown[] = Known Nodes +ifdef::model-descriptions[] +//tag::desc-clusterConfigNodesKnown[] +An object containing known node definitions and related information. +//end::desc-clusterConfigNodesKnown[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/clusterConfigNodesKnown/definition-begin.adoc[opts=optional] +include::{specDir}definitions/clusterConfigNodesKnown/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2473,35 +2097,23 @@ endif::collapse-models[] //tag::clusterConfigNodesKnown[] -ifdef::model-descriptions[] -//tag::desc-clusterConfigNodesKnown[] -An object containing known node definitions and related information. -//end::desc-clusterConfigNodesKnown[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*implVersion* + -_optional_ -a¦ - -[markdown] +a¦ *implVersion* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*nodeDefs* + -_optional_ -a¦ - -[markdown] +a¦ *nodeDefs* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-clusterConfigNodesWrapper, opts=optional] -- @@ -2509,14 +2121,11 @@ include::index.adoc[tag=desc-clusterConfigNodesWrapper, opts=optional] [%hardbreaks] {blank} a¦ xref:clusterConfigNodesWrapper[] - -a¦ -*uuid* + -_optional_ -a¦ - -[markdown] +a¦ *uuid* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -2529,34 +2138,27 @@ a¦ String -// markup not found, no include::{specDir}definitions/clusterConfigNodesKnown/definition-end.adoc[opts=optional] - +include::{specDir}definitions/clusterConfigNodesKnown/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/clusterConfigNodesKnown/definition-after.adoc[opts=optional] - - - +ifndef::show-clusterConfigNodesKnown[] +:leveloffset: -1 +endif::show-clusterConfigNodesKnown[] -// markup not found, no include::{specDir}definitions/clusterConfigNodesWanted/definition-before.adoc[opts=optional] +include::{specDir}definitions/clusterConfigNodesKnown/definition-after.adoc[opts=optional] +include::{specDir}definitions/clusterConfigNodesWanted/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-clusterConfigNodesWanted[] [#clusterConfigNodesWanted] -= Wanted Nodes - +endif::show-clusterConfigNodesWanted[] +ifndef::show-clusterConfigNodesWanted[] :leveloffset: +1 -// markup not found, no include::{specDir}definitions/clusterConfigNodesWanted/definition-begin.adoc[opts=optional] - - -.icon:brackets-curly[fw] Object -{blank} - -//tag::clusterConfigNodesWanted[] +[discrete#clusterConfigNodesWanted] +endif::show-clusterConfigNodesWanted[] += Wanted Nodes ifdef::model-descriptions[] //tag::desc-clusterConfigNodesWanted[] @@ -2564,29 +2166,33 @@ An object containing wanted node definitions and related information. //end::desc-clusterConfigNodesWanted[] endif::model-descriptions[] +:leveloffset: +1 + +include::{specDir}definitions/clusterConfigNodesWanted/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::clusterConfigNodesWanted[] + [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*implVersion* + -_optional_ -a¦ - -[markdown] +a¦ *implVersion* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*nodeDefs* + -_optional_ -a¦ - -[markdown] +a¦ *nodeDefs* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-clusterConfigNodesWrapper, opts=optional] -- @@ -2594,14 +2200,11 @@ include::index.adoc[tag=desc-clusterConfigNodesWrapper, opts=optional] [%hardbreaks] {blank} a¦ xref:clusterConfigNodesWrapper[] - -a¦ -*uuid* + -_optional_ -a¦ - -[markdown] +a¦ *uuid* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -2614,28 +2217,37 @@ a¦ String -// markup not found, no include::{specDir}definitions/clusterConfigNodesWanted/definition-end.adoc[opts=optional] - +include::{specDir}definitions/clusterConfigNodesWanted/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/clusterConfigNodesWanted/definition-after.adoc[opts=optional] - - - +ifndef::show-clusterConfigNodesWanted[] +:leveloffset: -1 +endif::show-clusterConfigNodesWanted[] -// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapper/definition-before.adoc[opts=optional] +include::{specDir}definitions/clusterConfigNodesWanted/definition-after.adoc[opts=optional] +include::{specDir}definitions/clusterConfigNodesWrapper/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-clusterConfigNodesWrapper[] [#clusterConfigNodesWrapper] +endif::show-clusterConfigNodesWrapper[] +ifndef::show-clusterConfigNodesWrapper[] +:leveloffset: +1 + +[discrete#clusterConfigNodesWrapper] +endif::show-clusterConfigNodesWrapper[] = Node Definitions Wrapper +ifdef::model-descriptions[] +//tag::desc-clusterConfigNodesWrapper[] +An object containing the definitions of 1 or more nodes. +//end::desc-clusterConfigNodesWrapper[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapper/definition-begin.adoc[opts=optional] +include::{specDir}definitions/clusterConfigNodesWrapper/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2643,23 +2255,14 @@ endif::collapse-models[] //tag::clusterConfigNodesWrapper[] -ifdef::model-descriptions[] -//tag::desc-clusterConfigNodesWrapper[] -An object containing the definitions of 1 or more nodes. -//end::desc-clusterConfigNodesWrapper[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ - -_additional + -property_ -a¦ - -[markdown] +additional + +property +a¦ [markdown] -- include::index.adoc[tag=desc-clusterConfigNodesWrapperNode, opts=optional] -- @@ -2674,28 +2277,38 @@ a¦ xref:clusterConfigNodesWrapperNode[] -// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapper/definition-end.adoc[opts=optional] - +include::{specDir}definitions/clusterConfigNodesWrapper/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapper/definition-after.adoc[opts=optional] - - - +ifndef::show-clusterConfigNodesWrapper[] +:leveloffset: -1 +endif::show-clusterConfigNodesWrapper[] -// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapperNode/definition-before.adoc[opts=optional] +include::{specDir}definitions/clusterConfigNodesWrapper/definition-after.adoc[opts=optional] +include::{specDir}definitions/clusterConfigNodesWrapperNode/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-clusterConfigNodesWrapperNode[] [#clusterConfigNodesWrapperNode] +endif::show-clusterConfigNodesWrapperNode[] +ifndef::show-clusterConfigNodesWrapperNode[] +:leveloffset: +1 + +[discrete#clusterConfigNodesWrapperNode] +endif::show-clusterConfigNodesWrapperNode[] = Node Definition +ifdef::model-descriptions[] +//tag::desc-clusterConfigNodesWrapperNode[] +An object containing the definition of a single node. +The name of the property is the UUID of the node. +//end::desc-clusterConfigNodesWrapperNode[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapperNode/definition-begin.adoc[opts=optional] +include::{specDir}definitions/clusterConfigNodesWrapperNode/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2703,102 +2316,76 @@ endif::collapse-models[] //tag::clusterConfigNodesWrapperNode[] -ifdef::model-descriptions[] -//tag::desc-clusterConfigNodesWrapperNode[] -An object containing the definition of a single node. -The name of the property is the UUID of the node. -//end::desc-clusterConfigNodesWrapperNode[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*container* + -_optional_ -a¦ - -[markdown] +a¦ *container* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*extras* + -_optional_ -a¦ - -[markdown] +a¦ *extras* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*hostPort* + -_optional_ -a¦ - -[markdown] +a¦ *hostPort* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*implVersion* + -_optional_ -a¦ - -[markdown] +a¦ *implVersion* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*tags* + -_optional_ -a¦ - -[markdown] +a¦ *tags* + +optional +a¦ [markdown] -- + -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*uuid* + -_optional_ -a¦ - -[markdown] +a¦ *uuid* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*weight* + -_optional_ -a¦ - -[markdown] +a¦ *weight* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -2811,28 +2398,37 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapperNode/definition-end.adoc[opts=optional] - +include::{specDir}definitions/clusterConfigNodesWrapperNode/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapperNode/definition-after.adoc[opts=optional] - - - +ifndef::show-clusterConfigNodesWrapperNode[] +:leveloffset: -1 +endif::show-clusterConfigNodesWrapperNode[] -// markup not found, no include::{specDir}definitions/clusterConfigPlan/definition-before.adoc[opts=optional] +include::{specDir}definitions/clusterConfigNodesWrapperNode/definition-after.adoc[opts=optional] +include::{specDir}definitions/clusterConfigPlan/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-clusterConfigPlan[] [#clusterConfigPlan] +endif::show-clusterConfigPlan[] +ifndef::show-clusterConfigPlan[] +:leveloffset: +1 + +[discrete#clusterConfigPlan] +endif::show-clusterConfigPlan[] = Plan Partitions +ifdef::model-descriptions[] +//tag::desc-clusterConfigPlan[] +An object containing Search index partitions and related information. +//end::desc-clusterConfigPlan[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/clusterConfigPlan/definition-begin.adoc[opts=optional] +include::{specDir}definitions/clusterConfigPlan/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2840,35 +2436,23 @@ endif::collapse-models[] //tag::clusterConfigPlan[] -ifdef::model-descriptions[] -//tag::desc-clusterConfigPlan[] -An object containing Search index partitions and related information. -//end::desc-clusterConfigPlan[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*implVersion* + -_optional_ -a¦ - -[markdown] +a¦ *implVersion* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*planPIndexes* + -_optional_ -a¦ - -[markdown] +a¦ *planPIndexes* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-clusterConfigPlanWrapper, opts=optional] -- @@ -2876,26 +2460,19 @@ include::index.adoc[tag=desc-clusterConfigPlanWrapper, opts=optional] [%hardbreaks] {blank} a¦ xref:clusterConfigPlanWrapper[] - -a¦ -*uuid* + -_optional_ -a¦ - -[markdown] +a¦ *uuid* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*warnings* + -_optional_ -a¦ - -[markdown] +a¦ *warnings* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-GetIndexResponsePlanWrng, opts=optional] -- @@ -2910,28 +2487,37 @@ a¦ xref:GetIndexResponsePlanWrng[] -// markup not found, no include::{specDir}definitions/clusterConfigPlan/definition-end.adoc[opts=optional] - +include::{specDir}definitions/clusterConfigPlan/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/clusterConfigPlan/definition-after.adoc[opts=optional] - - - +ifndef::show-clusterConfigPlan[] +:leveloffset: -1 +endif::show-clusterConfigPlan[] -// markup not found, no include::{specDir}definitions/clusterConfigPlanWrapper/definition-before.adoc[opts=optional] +include::{specDir}definitions/clusterConfigPlan/definition-after.adoc[opts=optional] +include::{specDir}definitions/clusterConfigPlanWrapper/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-clusterConfigPlanWrapper[] [#clusterConfigPlanWrapper] +endif::show-clusterConfigPlanWrapper[] +ifndef::show-clusterConfigPlanWrapper[] +:leveloffset: +1 + +[discrete#clusterConfigPlanWrapper] +endif::show-clusterConfigPlanWrapper[] = Plan Partitions Wrapper +ifdef::model-descriptions[] +//tag::desc-clusterConfigPlanWrapper[] +An object containing information about 1 or more Search index partitions. +//end::desc-clusterConfigPlanWrapper[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/clusterConfigPlanWrapper/definition-begin.adoc[opts=optional] +include::{specDir}definitions/clusterConfigPlanWrapper/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2939,23 +2525,14 @@ endif::collapse-models[] //tag::clusterConfigPlanWrapper[] -ifdef::model-descriptions[] -//tag::desc-clusterConfigPlanWrapper[] -An object containing information about 1 or more Search index partitions. -//end::desc-clusterConfigPlanWrapper[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ - -_additional + -property_ -a¦ - -[markdown] +additional + +property +a¦ [markdown] -- include::index.adoc[tag=desc-GetIndexResponsePIndex, opts=optional] -- @@ -2970,28 +2547,37 @@ a¦ xref:GetIndexResponsePIndex[] -// markup not found, no include::{specDir}definitions/clusterConfigPlanWrapper/definition-end.adoc[opts=optional] - +include::{specDir}definitions/clusterConfigPlanWrapper/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/clusterConfigPlanWrapper/definition-after.adoc[opts=optional] - - - +ifndef::show-clusterConfigPlanWrapper[] +:leveloffset: -1 +endif::show-clusterConfigPlanWrapper[] -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-before.adoc[opts=optional] +include::{specDir}definitions/clusterConfigPlanWrapper/definition-after.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndex/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-GetIndexResponsePIndex[] [#GetIndexResponsePIndex] +endif::show-GetIndexResponsePIndex[] +ifndef::show-GetIndexResponsePIndex[] +:leveloffset: +1 + +[discrete#GetIndexResponsePIndex] +endif::show-GetIndexResponsePIndex[] = Plan Partition +ifdef::model-descriptions[] +//tag::desc-GetIndexResponsePIndex[] +An object containing information about a single Search index partition. +//end::desc-GetIndexResponsePIndex[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-begin.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndex/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2999,22 +2585,13 @@ endif::collapse-models[] //tag::GetIndexResponsePIndex[] -ifdef::model-descriptions[] -//tag::desc-GetIndexResponsePIndex[] -An object containing information about a single Search index partition. -//end::desc-GetIndexResponsePIndex[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*indexName* + -_optional_ -a¦ - -[markdown] +a¦ *indexName* + +optional +a¦ [markdown] -- The name of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -3023,13 +2600,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*indexParams* + -_optional_ -a¦ - -[markdown] +a¦ *indexParams* + +optional +a¦ [markdown] -- The Search index's type identifier, type mappings, and analyzers. For more information, see [Params Object](../search/search-index-params.html#params). @@ -3038,13 +2611,9 @@ For more information, see [Params Object](../search/search-index-params.html#par [%hardbreaks] {blank} a¦ Object - -a¦ -*indexType* + -_optional_ -a¦ - -[markdown] +a¦ *indexType* + +optional +a¦ [markdown] -- The type of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -3053,13 +2622,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*indexUUID* + -_optional_ -a¦ - -[markdown] +a¦ *indexUUID* + +optional +a¦ [markdown] -- The UUID of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -3068,13 +2633,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*name* + -_optional_ -a¦ - -[markdown] +a¦ *name* + +optional +a¦ [markdown] -- The name of the Search index partition. -- @@ -3082,13 +2643,9 @@ The name of the Search index partition. [%hardbreaks] {blank} a¦ String - -a¦ -*nodes* + -_optional_ -a¦ - -[markdown] +a¦ *nodes* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapper, opts=optional] -- @@ -3096,13 +2653,9 @@ include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapper, opts=optional] [%hardbreaks] {blank} a¦ xref:GetIndexResponsePIndexNodesWrapper[] - -a¦ -*sourceName* + -_optional_ -a¦ - -[markdown] +a¦ *sourceName* + +optional +a¦ [markdown] -- The name of the bucket where the Search index is stored. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -3111,13 +2664,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*sourceParams* + -_optional_ -a¦ - -[markdown] +a¦ *sourceParams* + +optional +a¦ [markdown] -- Advanced settings for Search index behavior. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -3126,26 +2675,19 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ Object - -a¦ -*sourcePartitions* + -_optional_ -a¦ - -[markdown] +a¦ *sourcePartitions* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*sourceType* + -_optional_ -a¦ - -[markdown] +a¦ *sourceType* + +optional +a¦ [markdown] -- The type of the bucket where the Search index is stored. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -3154,13 +2696,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*sourceUUID* + -_optional_ -a¦ - -[markdown] +a¦ *sourceUUID* + +optional +a¦ [markdown] -- The UUID of the bucket where the Search index is stored. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -3169,13 +2707,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*uuid* + -_optional_ -a¦ - -[markdown] +a¦ *uuid* + +optional +a¦ [markdown] -- The UUID of the Search index partition. -- @@ -3190,28 +2724,37 @@ a¦ String -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-end.adoc[opts=optional] - +include::{specDir}definitions/GetIndexResponsePIndex/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-after.adoc[opts=optional] - - - +ifndef::show-GetIndexResponsePIndex[] +:leveloffset: -1 +endif::show-GetIndexResponsePIndex[] -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-before.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndex/definition-after.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-GetIndexResponsePIndexNodesWrapper[] [#GetIndexResponsePIndexNodesWrapper] +endif::show-GetIndexResponsePIndexNodesWrapper[] +ifndef::show-GetIndexResponsePIndexNodesWrapper[] +:leveloffset: +1 + +[discrete#GetIndexResponsePIndexNodesWrapper] +endif::show-GetIndexResponsePIndexNodesWrapper[] = Partition Nodes Wrapper +ifdef::model-descriptions[] +//tag::desc-GetIndexResponsePIndexNodesWrapper[] +An object containing information about 1 or more Search index partition nodes. +//end::desc-GetIndexResponsePIndexNodesWrapper[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-begin.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -3219,23 +2762,14 @@ endif::collapse-models[] //tag::GetIndexResponsePIndexNodesWrapper[] -ifdef::model-descriptions[] -//tag::desc-GetIndexResponsePIndexNodesWrapper[] -An object containing information about 1 or more Search index partition nodes. -//end::desc-GetIndexResponsePIndexNodesWrapper[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ - -_additional + -property_ -a¦ - -[markdown] +additional + +property +a¦ [markdown] -- include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapperNode, opts=optional] -- @@ -3250,28 +2784,38 @@ a¦ xref:GetIndexResponsePIndexNodesWrapperNode[] -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-end.adoc[opts=optional] - +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-after.adoc[opts=optional] - - - +ifndef::show-GetIndexResponsePIndexNodesWrapper[] +:leveloffset: -1 +endif::show-GetIndexResponsePIndexNodesWrapper[] -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-before.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-after.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-GetIndexResponsePIndexNodesWrapperNode[] [#GetIndexResponsePIndexNodesWrapperNode] +endif::show-GetIndexResponsePIndexNodesWrapperNode[] +ifndef::show-GetIndexResponsePIndexNodesWrapperNode[] +:leveloffset: +1 + +[discrete#GetIndexResponsePIndexNodesWrapperNode] +endif::show-GetIndexResponsePIndexNodesWrapperNode[] = Partition Node +ifdef::model-descriptions[] +//tag::desc-GetIndexResponsePIndexNodesWrapperNode[] +An object containing information about a single Search index partition node. +The name of the property is the node UUID. +//end::desc-GetIndexResponsePIndexNodesWrapperNode[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-begin.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -3279,50 +2823,35 @@ endif::collapse-models[] //tag::GetIndexResponsePIndexNodesWrapperNode[] -ifdef::model-descriptions[] -//tag::desc-GetIndexResponsePIndexNodesWrapperNode[] -An object containing information about a single Search index partition node. -The name of the property is the node UUID. -//end::desc-GetIndexResponsePIndexNodesWrapperNode[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*canRead* + -_optional_ -a¦ - -[markdown] +a¦ *canRead* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Boolean - -a¦ -*canWrite* + -_optional_ -a¦ - -[markdown] +a¦ *canWrite* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Boolean - -a¦ -*priority* + -_optional_ -a¦ - -[markdown] +a¦ *priority* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -3335,28 +2864,37 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-end.adoc[opts=optional] - +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-after.adoc[opts=optional] - - - +ifndef::show-GetIndexResponsePIndexNodesWrapperNode[] +:leveloffset: -1 +endif::show-GetIndexResponsePIndexNodesWrapperNode[] -// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrng/definition-before.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-after.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePlanWrng/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-GetIndexResponsePlanWrng[] [#GetIndexResponsePlanWrng] +endif::show-GetIndexResponsePlanWrng[] +ifndef::show-GetIndexResponsePlanWrng[] +:leveloffset: +1 + +[discrete#GetIndexResponsePlanWrng] +endif::show-GetIndexResponsePlanWrng[] = Plan Warnings Wrapper +ifdef::model-descriptions[] +//tag::desc-GetIndexResponsePlanWrng[] +An object containing 0, 1, or more nested objects, each containing warnings that apply to a Search index. +//end::desc-GetIndexResponsePlanWrng[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrng/definition-begin.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePlanWrng/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -3364,23 +2902,14 @@ endif::collapse-models[] //tag::GetIndexResponsePlanWrng[] -ifdef::model-descriptions[] -//tag::desc-GetIndexResponsePlanWrng[] -An object containing 0, 1, or more nested objects, each containing warnings that apply to a Search index. -//end::desc-GetIndexResponsePlanWrng[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ - -_additional + -property_ -a¦ - -[markdown] +additional + +property +a¦ [markdown] -- include::index.adoc[tag=desc-GetIndexResponsePlanWrngIndex, opts=optional] -- @@ -3395,35 +2924,43 @@ a¦ xref:GetIndexResponsePlanWrngIndex[] -// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrng/definition-end.adoc[opts=optional] - +include::{specDir}definitions/GetIndexResponsePlanWrng/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrng/definition-after.adoc[opts=optional] - - - +ifndef::show-GetIndexResponsePlanWrng[] +:leveloffset: -1 +endif::show-GetIndexResponsePlanWrng[] -// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrngIndex/definition-before.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePlanWrng/definition-after.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePlanWrngIndex/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-GetIndexResponsePlanWrngIndex[] [#GetIndexResponsePlanWrngIndex] +endif::show-GetIndexResponsePlanWrngIndex[] +ifndef::show-GetIndexResponsePlanWrngIndex[] +:leveloffset: +1 + +[discrete#GetIndexResponsePlanWrngIndex] +endif::show-GetIndexResponsePlanWrngIndex[] = Plan Warnings +ifdef::model-descriptions[] +//tag::desc-GetIndexResponsePlanWrngIndex[] +An array of warnings. +The name of the property is the name of the Search index. +//end::desc-GetIndexResponsePlanWrngIndex[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrngIndex/definition-begin.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePlanWrngIndex/definition-begin.adoc[opts=optional] .icon:brackets[fw] Array {blank} - - [markdown] -- An array of warnings. @@ -3432,39 +2969,31 @@ The name of the property is the name of the Search index. [%hardbreaks] {blank} -.Schema -String - array +.Schema +String array -// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrngIndex/definition-end.adoc[opts=optional] - +include::{specDir}definitions/GetIndexResponsePlanWrngIndex/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrngIndex/definition-after.adoc[opts=optional] - - - +ifndef::show-GetIndexResponsePlanWrngIndex[] +:leveloffset: -1 +endif::show-GetIndexResponsePlanWrngIndex[] -// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-before.adoc[opts=optional] +include::{specDir}definitions/GetIndexResponsePlanWrngIndex/definition-after.adoc[opts=optional] +include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-GetIndexesResponseIndexesWrapper[] [#GetIndexesResponseIndexesWrapper] -= Index Definitions Wrapper - +endif::show-GetIndexesResponseIndexesWrapper[] +ifndef::show-GetIndexesResponseIndexesWrapper[] :leveloffset: +1 -// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-begin.adoc[opts=optional] - - -.icon:brackets-curly[fw] Object -{blank} - -//tag::GetIndexesResponseIndexesWrapper[] +[discrete#GetIndexesResponseIndexesWrapper] +endif::show-GetIndexesResponseIndexesWrapper[] += Index Definitions Wrapper ifdef::model-descriptions[] //tag::desc-GetIndexesResponseIndexesWrapper[] @@ -3472,17 +3001,24 @@ An object containing 1 or more Search index definitions. //end::desc-GetIndexesResponseIndexesWrapper[] endif::model-descriptions[] +:leveloffset: +1 + +include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::GetIndexesResponseIndexesWrapper[] + [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ - -_additional + -property_ -a¦ - -[markdown] +additional + +property +a¦ [markdown] -- include::index.adoc[tag=desc-IndexDefinition, opts=optional] -- @@ -3497,28 +3033,38 @@ a¦ xref:IndexDefinition[] -// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-end.adoc[opts=optional] - +include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-after.adoc[opts=optional] - - - +ifndef::show-GetIndexesResponseIndexesWrapper[] +:leveloffset: -1 +endif::show-GetIndexesResponseIndexesWrapper[] -// markup not found, no include::{specDir}definitions/IndexDefinition/definition-before.adoc[opts=optional] +include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-after.adoc[opts=optional] +include::{specDir}definitions/IndexDefinition/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-IndexDefinition[] [#IndexDefinition] +endif::show-IndexDefinition[] +ifndef::show-IndexDefinition[] +:leveloffset: +1 + +[discrete#IndexDefinition] +endif::show-IndexDefinition[] = Index Definition +ifdef::model-descriptions[] +//tag::desc-IndexDefinition[] +The full Search index definition. +For a detailed list of all parameters, see [Search Index JSON Properties](../search/search-index-params.html). +//end::desc-IndexDefinition[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/IndexDefinition/definition-begin.adoc[opts=optional] +include::{specDir}definitions/IndexDefinition/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -3526,23 +3072,13 @@ endif::collapse-models[] //tag::IndexDefinition[] -ifdef::model-descriptions[] -//tag::desc-IndexDefinition[] -The full Search index definition. -For a detailed list of all parameters, see [Search Index JSON Properties](../search/search-index-params.html). -//end::desc-IndexDefinition[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*name* + -_required_ -a¦ - -[markdown] +a¦ *name* + +required +a¦ [markdown] -- The name of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -3551,13 +3087,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*type* + -_required_ -a¦ - -[markdown] +a¦ *type* + +required +a¦ [markdown] -- The type of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -3566,13 +3098,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*sourceName* + -_required_ -a¦ - -[markdown] +a¦ *sourceName* + +required +a¦ [markdown] -- The name of the bucket where the Search index is stored. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -3581,13 +3109,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*sourceUUID* + -_optional_ -a¦ - -[markdown] +a¦ *sourceUUID* + +optional +a¦ [markdown] -- The UUID of the bucket where the Search index is stored. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -3596,13 +3120,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*sourceParams* + -_optional_ -a¦ - -[markdown] +a¦ *sourceParams* + +optional +a¦ [markdown] -- Advanced settings for Search index behavior. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -3611,13 +3131,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ Object - -a¦ -*sourceType* + -_required_ -a¦ - -[markdown] +a¦ *sourceType* + +required +a¦ [markdown] -- The type of the bucket where the Search index is stored. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -3626,13 +3142,9 @@ For more information, see [Initial Settings](../search/search-index-params.html# [%hardbreaks] {blank} a¦ String - -a¦ -*params* + -_required_ -a¦ - -[markdown] +a¦ *params* + +required +a¦ [markdown] -- The Search index's type identifier, type mappings, and analyzers. For more information, see [Params Object](../search/search-index-params.html#params). @@ -3641,13 +3153,9 @@ For more information, see [Params Object](../search/search-index-params.html#par [%hardbreaks] {blank} a¦ Object - -a¦ -*planParams* + -_required_ -a¦ - -[markdown] +a¦ *planParams* + +required +a¦ [markdown] -- include::index.adoc[tag=desc-IndexDefinitionPlanParams, opts=optional] -- @@ -3655,13 +3163,9 @@ include::index.adoc[tag=desc-IndexDefinitionPlanParams, opts=optional] [%hardbreaks] {blank} a¦ xref:IndexDefinitionPlanParams[] - -a¦ -*prevIndexUUID* + -_optional_ -a¦ - -[markdown] +a¦ *prevIndexUUID* + +optional +a¦ [markdown] -- The UUID of the previous index. Intended for clients that want to check that they are not overwriting the Search index definition updates of concurrent clients. @@ -3670,13 +3174,9 @@ Intended for clients that want to check that they are not overwriting the Search [%hardbreaks] {blank} a¦ String - -a¦ -*uuid* + -_optional_ -a¦ - -[markdown] +a¦ *uuid* + +optional +a¦ [markdown] -- The UUID of the Search index. For more information, see [Initial Settings](../search/search-index-params.html#initial). @@ -3692,28 +3192,38 @@ a¦ String -// markup not found, no include::{specDir}definitions/IndexDefinition/definition-end.adoc[opts=optional] - +include::{specDir}definitions/IndexDefinition/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/IndexDefinition/definition-after.adoc[opts=optional] - - - +ifndef::show-IndexDefinition[] +:leveloffset: -1 +endif::show-IndexDefinition[] -// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-before.adoc[opts=optional] +include::{specDir}definitions/IndexDefinition/definition-after.adoc[opts=optional] +include::{specDir}definitions/IndexDefinitionPlanParams/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-IndexDefinitionPlanParams[] [#IndexDefinitionPlanParams] +endif::show-IndexDefinitionPlanParams[] +ifndef::show-IndexDefinitionPlanParams[] +:leveloffset: +1 + +[discrete#IndexDefinitionPlanParams] +endif::show-IndexDefinitionPlanParams[] = Plan Parameters +ifdef::model-descriptions[] +//tag::desc-IndexDefinitionPlanParams[] +The Search index's partitioning and replication settings. +For more information, see [Plan Params Object](../search/search-index-params.html#planParams). +//end::desc-IndexDefinitionPlanParams[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-begin.adoc[opts=optional] +include::{specDir}definitions/IndexDefinitionPlanParams/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -3721,36 +3231,24 @@ endif::collapse-models[] //tag::IndexDefinitionPlanParams[] -ifdef::model-descriptions[] -//tag::desc-IndexDefinitionPlanParams[] -The Search index's partitioning and replication settings. -For more information, see [Plan Params Object](../search/search-index-params.html#planParams). -//end::desc-IndexDefinitionPlanParams[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*hierarchyRules* + -_optional_ -a¦ - -[markdown] +a¦ *hierarchyRules* + +optional +a¦ [markdown] -- + -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*maxPartitionsPerPIndex* + -_optional_ -a¦ - -[markdown] +a¦ *maxPartitionsPerPIndex* + +optional +a¦ [markdown] -- This setting is deprecated. Use `indexPartitions` instead. @@ -3759,13 +3257,9 @@ Use `indexPartitions` instead. [%hardbreaks] {blank} a¦ Integer - -a¦ -*indexPartitions* + -_optional_ -a¦ - -[markdown] +a¦ *indexPartitions* + +optional +a¦ [markdown] -- The number of partitions to split the Search index into, across the nodes you have available in your database with the Search Service enabled. -- @@ -3773,26 +3267,20 @@ The number of partitions to split the Search index into, across the nodes you ha [%hardbreaks] {blank} a¦ Integer - -a¦ -*nodePlanParams* + -_optional_ -a¦ - -[markdown] +a¦ *nodePlanParams* + +optional +a¦ [markdown] -- + -- [%hardbreaks] +*Nullable:* yes {blank} a¦ String - -a¦ -*numReplicas* + -_optional_ -a¦ - -[markdown] +a¦ *numReplicas* + +optional +a¦ [markdown] -- The number of replicas the Search Service creates for the Search index to ensure high availability. -- @@ -3800,14 +3288,11 @@ The number of replicas the Search Service creates for the Search index to ensure [%hardbreaks] {blank} a¦ Integer - -a¦ -*planFrozen* + -_optional_ -a¦ - -[markdown] +a¦ *planFrozen* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -3820,28 +3305,31 @@ a¦ Boolean -// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-end.adoc[opts=optional] - +include::{specDir}definitions/IndexDefinitionPlanParams/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-after.adoc[opts=optional] - - - +ifndef::show-IndexDefinitionPlanParams[] +:leveloffset: -1 +endif::show-IndexDefinitionPlanParams[] -// markup not found, no include::{specDir}definitions/logInfo/definition-before.adoc[opts=optional] +include::{specDir}definitions/IndexDefinitionPlanParams/definition-after.adoc[opts=optional] +include::{specDir}definitions/logInfo/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-logInfo[] [#logInfo] +endif::show-logInfo[] +ifndef::show-logInfo[] +:leveloffset: +1 + +[discrete#logInfo] +endif::show-logInfo[] = Log Messages :leveloffset: +1 -// markup not found, no include::{specDir}definitions/logInfo/definition-begin.adoc[opts=optional] +include::{specDir}definitions/logInfo/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -3849,38 +3337,30 @@ endif::collapse-models[] //tag::logInfo[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*events* + -_optional_ -a¦ - -[markdown] +a¦ *events* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} -a¦ Object - array - -a¦ -*messages* + -_optional_ -a¦ - -[markdown] +a¦ Object array +a¦ *messages* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} -a¦ Object - array +a¦ Object array |=== @@ -3888,28 +3368,31 @@ a¦ Object -// markup not found, no include::{specDir}definitions/logInfo/definition-end.adoc[opts=optional] - +include::{specDir}definitions/logInfo/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/logInfo/definition-after.adoc[opts=optional] - - - +ifndef::show-logInfo[] +:leveloffset: -1 +endif::show-logInfo[] -// markup not found, no include::{specDir}definitions/runtimeInfo/definition-before.adoc[opts=optional] +include::{specDir}definitions/logInfo/definition-after.adoc[opts=optional] +include::{specDir}definitions/runtimeInfo/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-runtimeInfo[] [#runtimeInfo] +endif::show-runtimeInfo[] +ifndef::show-runtimeInfo[] +:leveloffset: +1 + +[discrete#runtimeInfo] +endif::show-runtimeInfo[] = Runtime Information :leveloffset: +1 -// markup not found, no include::{specDir}definitions/runtimeInfo/definition-begin.adoc[opts=optional] +include::{specDir}definitions/runtimeInfo/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -3917,17 +3400,13 @@ endif::collapse-models[] //tag::runtimeInfo[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*arch* + -_optional_ -a¦ - -[markdown] +a¦ *arch* + +optional +a¦ [markdown] -- The architecture of the node. -- @@ -3935,13 +3414,9 @@ The architecture of the node. [%hardbreaks] {blank} a¦ String - -a¦ -*go* + -_optional_ -a¦ - -[markdown] +a¦ *go* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-runtimeInfoGo, opts=optional] -- @@ -3949,13 +3424,9 @@ include::index.adoc[tag=desc-runtimeInfoGo, opts=optional] [%hardbreaks] {blank} a¦ xref:runtimeInfoGo[] - -a¦ -*numCPU* + -_optional_ -a¦ - -[markdown] +a¦ *numCPU* + +optional +a¦ [markdown] -- The number of CPUs on the node. -- @@ -3963,13 +3434,9 @@ The number of CPUs on the node. [%hardbreaks] {blank} a¦ Integer - -a¦ -*os* + -_optional_ -a¦ - -[markdown] +a¦ *os* + +optional +a¦ [markdown] -- The operating system of the node. -- @@ -3977,27 +3444,21 @@ The operating system of the node. [%hardbreaks] {blank} a¦ String - -a¦ -*versionData* + -_optional_ -a¦ - -[markdown] +a¦ *versionData* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*versionMain* + -_optional_ -a¦ - -[markdown] +a¦ *versionMain* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -4010,28 +3471,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/runtimeInfo/definition-end.adoc[opts=optional] - +include::{specDir}definitions/runtimeInfo/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/runtimeInfo/definition-after.adoc[opts=optional] - - - +ifndef::show-runtimeInfo[] +:leveloffset: -1 +endif::show-runtimeInfo[] -// markup not found, no include::{specDir}definitions/runtimeInfoGo/definition-before.adoc[opts=optional] +include::{specDir}definitions/runtimeInfo/definition-after.adoc[opts=optional] +include::{specDir}definitions/runtimeInfoGo/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-runtimeInfoGo[] [#runtimeInfoGo] +endif::show-runtimeInfoGo[] +ifndef::show-runtimeInfoGo[] +:leveloffset: +1 + +[discrete#runtimeInfoGo] +endif::show-runtimeInfoGo[] = Go Runtime Information :leveloffset: +1 -// markup not found, no include::{specDir}definitions/runtimeInfoGo/definition-begin.adoc[opts=optional] +include::{specDir}definitions/runtimeInfoGo/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -4039,57 +3503,45 @@ endif::collapse-models[] //tag::runtimeInfoGo[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*GOMAXPROCS* + -_optional_ -a¦ - -[markdown] +a¦ *GOMAXPROCS* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ Integer - -a¦ -*GOROOT* + -_optional_ -a¦ - -[markdown] +a¦ *GOROOT* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*compiler* + -_optional_ -a¦ - -[markdown] +a¦ *compiler* + +optional +a¦ [markdown] -- + -- [%hardbreaks] {blank} a¦ String - -a¦ -*version* + -_optional_ -a¦ - -[markdown] +a¦ *version* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -4102,26 +3554,26 @@ a¦ String -// markup not found, no include::{specDir}definitions/runtimeInfoGo/definition-end.adoc[opts=optional] - +include::{specDir}definitions/runtimeInfoGo/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/runtimeInfoGo/definition-after.adoc[opts=optional] - +ifndef::show-runtimeInfoGo[] +:leveloffset: -1 +endif::show-runtimeInfoGo[] +include::{specDir}definitions/runtimeInfoGo/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] - +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -4131,18 +3583,14 @@ a¦ String include::{specDir}security/document-begin.adoc[opts=optional] - - -// markup not found, no include::{specDir}security/manageCluster/security-scheme-before.adoc[opts=optional] - +include::{specDir}security/manageCluster/security-scheme-before.adoc[opts=optional] [[security-manageCluster]] -= Manage Cluster += manageCluster :leveloffset: +1 -// markup not found, no include::{specDir}security/manageCluster/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/manageCluster/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -4150,29 +3598,22 @@ You must have the **Full Admin** or **Cluster Admin** role, with permissions to -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/manageCluster/security-scheme-end.adoc[opts=optional] +include::{specDir}security/manageCluster/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/manageCluster/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/manageCluster/security-scheme-after.adoc[opts=optional] - - - - -// markup not found, no include::{specDir}security/readClusterSettings/security-scheme-before.adoc[opts=optional] - +include::{specDir}security/readClusterSettings/security-scheme-before.adoc[opts=optional] [[security-readClusterSettings]] -= Read Cluster Settings += readClusterSettings :leveloffset: +1 -// markup not found, no include::{specDir}security/readClusterSettings/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/readClusterSettings/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -4180,29 +3621,22 @@ You must have the **Full Admin** or **Cluster Admin** role, with permission to r -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/readClusterSettings/security-scheme-end.adoc[opts=optional] +include::{specDir}security/readClusterSettings/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/readClusterSettings/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/readClusterSettings/security-scheme-after.adoc[opts=optional] - - - - -// markup not found, no include::{specDir}security/readClusterLogs/security-scheme-before.adoc[opts=optional] - +include::{specDir}security/readClusterLogs/security-scheme-before.adoc[opts=optional] [[security-readClusterLogs]] -= Read Cluster Logs += readClusterLogs :leveloffset: +1 -// markup not found, no include::{specDir}security/readClusterLogs/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/readClusterLogs/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -4210,29 +3644,22 @@ You must have the **Full Admin** or **Cluster Admin** role, with permission to r -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/readClusterLogs/security-scheme-end.adoc[opts=optional] +include::{specDir}security/readClusterLogs/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/readClusterLogs/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/readClusterLogs/security-scheme-after.adoc[opts=optional] - - - - -// markup not found, no include::{specDir}security/writeClusterSettings/security-scheme-before.adoc[opts=optional] - +include::{specDir}security/writeClusterSettings/security-scheme-before.adoc[opts=optional] [[security-writeClusterSettings]] -= Write Cluster Settings += writeClusterSettings :leveloffset: +1 -// markup not found, no include::{specDir}security/writeClusterSettings/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/writeClusterSettings/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -4240,16 +3667,13 @@ You must have the **Full Admin** or **Cluster Admin** role, with permission to w -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/writeClusterSettings/security-scheme-end.adoc[opts=optional] +include::{specDir}security/writeClusterSettings/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/writeClusterSettings/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/writeClusterSettings/security-scheme-after.adoc[opts=optional] @@ -4257,8 +3681,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - -// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] +include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/fts-rest-nodes/search-nodes.gradle b/docs/modules/fts-rest-nodes/search-nodes.gradle index 4922edf3..0bafb805 100644 --- a/docs/modules/fts-rest-nodes/search-nodes.gradle +++ b/docs/modules/fts-rest-nodes/search-nodes.gradle @@ -33,6 +33,7 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file diff --git a/docs/modules/fts-rest-query/pages/index.adoc b/docs/modules/fts-rest-query/pages/index.adoc index c1e476c2..709d6630 100644 --- a/docs/modules/fts-rest-query/pages/index.adoc +++ b/docs/modules/fts-rest-query/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbase/cbft :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -32,7 +31,7 @@ This API enables you to get information about active Search queries. [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -67,7 +66,6 @@ The host name or IP address of a node running the Search Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -83,31 +81,26 @@ The Search Service REST port. Use `18094` for secure access. |=== - include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] +include::{specDir}overview/document-after.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] - +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 1 - +:count-apis: 0 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -115,18 +108,14 @@ xref:tag-Default[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Default] = Default :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:api-query[] @@ -134,44 +123,38 @@ xref:api-query-cancel[] xref:api-query-index[] -//tag::api-query[] - -// markup not found, no include::{specDir}paths/api-query/operation-before.adoc[opts=optional] +//tag::api-query[] +include::{specDir}paths/api-query/operation-before.adoc[opts=optional] [#api-query] = View Active Node Queries :leveloffset: +1 -// markup not found, no include::{specDir}paths/api-query/operation-begin.adoc[opts=optional] - +include::{specDir}paths/api-query/operation-begin.adoc[opts=optional] .... GET /api/query .... - -// markup not found, no include::{specDir}paths/api-query/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/api-query/operation-description-before.adoc[opts=optional] [#api-query-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/api-query/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/api-query/operation-description-begin.adoc[opts=optional] [markdown] -- Gets the details of all the active queries in any Search node in a cluster. -- - -// markup not found, no include::{specDir}paths/api-query/operation-description-end.adoc[opts=optional] +include::{specDir}paths/api-query/operation-description-end.adoc[opts=optional] @@ -179,24 +162,20 @@ Gets the details of all the active queries in any Search node in a cluster. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/api-query/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/api-query/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/api-query/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/api-query/operation-parameters-before.adoc[opts=optional] [#api-query-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/api-query/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/api-query/operation-parameters-begin.adoc[opts=optional] [#api-query-query] .Query Parameters @@ -207,11 +186,8 @@ Gets the details of all the active queries in any Search node in a cluster. ¦ Name ¦ Description ¦ Schema a¦ *longerThan* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- Filters the queries running beyond the given span of time. @@ -227,29 +203,24 @@ a¦ String (duration) |=== - - - -// markup not found, no include::{specDir}paths/api-query/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/api-query/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/api-query/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/api-query/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/api-query/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/api-query/operation-responses-before.adoc[opts=optional] [#api-query-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/api-query/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/api-query/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -262,98 +233,79 @@ A list of all active Search queries across all nodes in the cluster. -- a| xref:ActiveResponse[] - |=== - -// markup not found, no include::{specDir}paths/api-query/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/api-query/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-ActiveResponse: -// markup not found, no include::{specDir}paths/api-query/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/api-query/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/api-query/operation-security-before.adoc[opts=optional] +include::{specDir}paths/api-query/operation-security-before.adoc[opts=optional] [#api-query-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/api-query/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/api-query/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/api-query/operation-security-end.adoc[opts=optional] +include::{specDir}paths/api-query/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/api-query/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/api-query/operation-security-after.adoc[opts=optional] include::{snippetDir}api-query/http-request.adoc[opts=optional] - include::{snippetDir}api-query/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/api-query/operation-end.adoc[opts=optional] +include::{specDir}paths/api-query/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/api-query/operation-after.adoc[opts=optional] - +include::{specDir}paths/api-query/operation-after.adoc[opts=optional] //end::api-query[] - //tag::api-query-cancel[] - -// markup not found, no include::{specDir}paths/api-query-cancel/operation-before.adoc[opts=optional] - +include::{specDir}paths/api-query-cancel/operation-before.adoc[opts=optional] [#api-query-cancel] = Cancel Active Queries :leveloffset: +1 -// markup not found, no include::{specDir}paths/api-query-cancel/operation-begin.adoc[opts=optional] - +include::{specDir}paths/api-query-cancel/operation-begin.adoc[opts=optional] .... POST /api/query/{queryID}/cancel .... - -// markup not found, no include::{specDir}paths/api-query-cancel/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/api-query-cancel/operation-description-before.adoc[opts=optional] [#api-query-cancel-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/api-query-cancel/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/api-query-cancel/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -361,8 +313,7 @@ Allows the user to cancel an active query that's running longer than expected. Use the View Active Index Queries API or the View Active Node Queries API to get the parameters `queryID` and `uuid`, which are used to identify and cancel the query. -- - -// markup not found, no include::{specDir}paths/api-query-cancel/operation-description-end.adoc[opts=optional] +include::{specDir}paths/api-query-cancel/operation-description-end.adoc[opts=optional] [#api-query-cancel-consumes] @@ -373,23 +324,20 @@ Use the View Active Index Queries API or the View Active Node Queries API to get .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/api-query-cancel/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/api-query-cancel/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/api-query-cancel/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/api-query-cancel/operation-parameters-before.adoc[opts=optional] [#api-query-cancel-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/api-query-cancel/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/api-query-cancel/operation-parameters-begin.adoc[opts=optional] [#api-query-cancel-path] .Path Parameters @@ -400,11 +348,8 @@ Use the View Active Index Queries API or the View Active Node Queries API to get ¦ Name ¦ Description ¦ Schema a¦ *queryID* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The ID of the active query. This ID is used to identify the query that you want to cancel. @@ -416,10 +361,6 @@ This ID is used to identify the query that you want to cancel. a¦ Integer |=== - - - - [#api-query-cancel-body] .Body Parameter {blank} @@ -429,13 +370,10 @@ a¦ Integer ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- -The body contains the UUID of the node where the query is running. This is optional and allows cancellation of queries on specific nodes. + -- [%hardbreaks] @@ -446,26 +384,25 @@ a¦ xref:CancelRequest[] |=== -// markup not found, no include::{specDir}paths/api-query-cancel/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/api-query-cancel/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-CancelRequest: -// markup not found, no include::{specDir}paths/api-query-cancel/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/api-query-cancel/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/api-query-cancel/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/api-query-cancel/operation-responses-before.adoc[opts=optional] [#api-query-cancel-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/api-query-cancel/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/api-query-cancel/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -478,106 +415,86 @@ The query was successfully canceled. -- a| xref:CancelResponse[] - |=== - -// markup not found, no include::{specDir}paths/api-query-cancel/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/api-query-cancel/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-CancelResponse: -// markup not found, no include::{specDir}paths/api-query-cancel/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/api-query-cancel/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/api-query-cancel/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/api-query-cancel/operation-security-before.adoc[opts=optional] [#api-query-cancel-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/api-query-cancel/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/api-query-cancel/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/api-query-cancel/operation-security-end.adoc[opts=optional] +include::{specDir}paths/api-query-cancel/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/api-query-cancel/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/api-query-cancel/operation-security-after.adoc[opts=optional] include::{snippetDir}api-query-cancel/http-request.adoc[opts=optional] - include::{snippetDir}api-query-cancel/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/api-query-cancel/operation-end.adoc[opts=optional] +include::{specDir}paths/api-query-cancel/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/api-query-cancel/operation-after.adoc[opts=optional] - +include::{specDir}paths/api-query-cancel/operation-after.adoc[opts=optional] //end::api-query-cancel[] - //tag::api-query-index[] - -// markup not found, no include::{specDir}paths/api-query-index/operation-before.adoc[opts=optional] - +include::{specDir}paths/api-query-index/operation-before.adoc[opts=optional] [#api-query-index] = View Active Index Queries :leveloffset: +1 -// markup not found, no include::{specDir}paths/api-query-index/operation-begin.adoc[opts=optional] - +include::{specDir}paths/api-query-index/operation-begin.adoc[opts=optional] .... GET /api/query/index/{indexName} .... - -// markup not found, no include::{specDir}paths/api-query-index/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/api-query-index/operation-description-before.adoc[opts=optional] [#api-query-index-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/api-query-index/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/api-query-index/operation-description-begin.adoc[opts=optional] [markdown] -- Gets the details of all the active queries for any given Search index in the system. -- - -// markup not found, no include::{specDir}paths/api-query-index/operation-description-end.adoc[opts=optional] +include::{specDir}paths/api-query-index/operation-description-end.adoc[opts=optional] @@ -585,23 +502,20 @@ Gets the details of all the active queries for any given Search index in the sys .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/api-query-index/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/api-query-index/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/api-query-index/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/api-query-index/operation-parameters-before.adoc[opts=optional] [#api-query-index-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/api-query-index/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/api-query-index/operation-parameters-begin.adoc[opts=optional] [#api-query-index-path] .Path Parameters @@ -612,11 +526,8 @@ Gets the details of all the active queries for any given Search index in the sys ¦ Name ¦ Description ¦ Schema a¦ *indexName* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index. -- @@ -627,7 +538,6 @@ The name of the Search index. a¦ String |=== - [#api-query-index-query] .Query Parameters {blank} @@ -637,11 +547,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *longerThan* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- Filters the queries running beyond the given span of time. @@ -657,29 +564,24 @@ a¦ String (duration) |=== - - - -// markup not found, no include::{specDir}paths/api-query-index/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/api-query-index/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/api-query-index/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/api-query-index/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/api-query-index/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/api-query-index/operation-responses-before.adoc[opts=optional] [#api-query-index-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/api-query-index/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/api-query-index/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -692,102 +594,86 @@ A list of active queries for the specified Search index. -- a| xref:ActiveResponse[] - |=== - -// markup not found, no include::{specDir}paths/api-query-index/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/api-query-index/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-ActiveResponse: -// markup not found, no include::{specDir}paths/api-query-index/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/api-query-index/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/api-query-index/operation-security-before.adoc[opts=optional] +include::{specDir}paths/api-query-index/operation-security-before.adoc[opts=optional] [#api-query-index-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/api-query-index/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/api-query-index/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/api-query-index/operation-security-end.adoc[opts=optional] +include::{specDir}paths/api-query-index/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/api-query-index/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/api-query-index/operation-security-after.adoc[opts=optional] include::{snippetDir}api-query-index/http-request.adoc[opts=optional] - include::{snippetDir}api-query-index/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/api-query-index/operation-end.adoc[opts=optional] +include::{specDir}paths/api-query-index/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/api-query-index/operation-after.adoc[opts=optional] - +include::{specDir}paths/api-query-index/operation-after.adoc[opts=optional] //end::api-query-index[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] +include::{specDir}paths/document-after.adoc[opts=optional] - -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] - +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 8 - +:count-models: 7 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:ActiveResponse[] xref:ActiveResponseFilter[] @@ -800,19 +686,21 @@ xref:CancelResponse[] endif::[] +include::{specDir}definitions/ActiveResponse/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/ActiveResponse/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ActiveResponse[] [#ActiveResponse] +endif::show-ActiveResponse[] +ifndef::show-ActiveResponse[] +:leveloffset: +1 + +[discrete#ActiveResponse] +endif::show-ActiveResponse[] = Active Response :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ActiveResponse/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ActiveResponse/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -820,17 +708,13 @@ endif::collapse-models[] //tag::ActiveResponse[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the request. -- @@ -838,13 +722,9 @@ The status of the request. [%hardbreaks] {blank} a¦ String - -a¦ -*stats* + -_optional_ -a¦ - -[markdown] +a¦ *stats* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-ActiveResponseStats, opts=optional] -- @@ -852,13 +732,9 @@ include::index.adoc[tag=desc-ActiveResponseStats, opts=optional] [%hardbreaks] {blank} a¦ xref:ActiveResponseStats[] - -a¦ -*totalActiveQueryCount* + -_optional_ -a¦ - -[markdown] +a¦ *totalActiveQueryCount* + +optional +a¦ [markdown] -- The total number of active queries. -- @@ -866,13 +742,9 @@ The total number of active queries. [%hardbreaks] {blank} a¦ Integer - -a¦ -*filteredActiveQueries* + -_optional_ -a¦ - -[markdown] +a¦ *filteredActiveQueries* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-ActiveResponseFilter, opts=optional] -- @@ -887,28 +759,37 @@ a¦ xref:ActiveResponseFilter[] -// markup not found, no include::{specDir}definitions/ActiveResponse/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ActiveResponse/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ActiveResponse/definition-after.adoc[opts=optional] - - - +ifndef::show-ActiveResponse[] +:leveloffset: -1 +endif::show-ActiveResponse[] -// markup not found, no include::{specDir}definitions/ActiveResponseFilter/definition-before.adoc[opts=optional] +include::{specDir}definitions/ActiveResponse/definition-after.adoc[opts=optional] +include::{specDir}definitions/ActiveResponseFilter/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ActiveResponseFilter[] [#ActiveResponseFilter] +endif::show-ActiveResponseFilter[] +ifndef::show-ActiveResponseFilter[] +:leveloffset: +1 + +[discrete#ActiveResponseFilter] +endif::show-ActiveResponseFilter[] = Filtered Active Queries +ifdef::model-descriptions[] +//tag::desc-ActiveResponseFilter[] +An object containing details of the filtered active queries. +//end::desc-ActiveResponseFilter[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ActiveResponseFilter/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ActiveResponseFilter/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -916,22 +797,13 @@ endif::collapse-models[] //tag::ActiveResponseFilter[] -ifdef::model-descriptions[] -//tag::desc-ActiveResponseFilter[] -An object containing details of the filtered active queries. -//end::desc-ActiveResponseFilter[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*indexName* + -_optional_ -a¦ - -[markdown] +a¦ *indexName* + +optional +a¦ [markdown] -- The name of the Search index. Only included if viewing active queries for a specific index. @@ -940,13 +812,9 @@ Only included if viewing active queries for a specific index. [%hardbreaks] {blank} a¦ String - -a¦ -*longerThan* + -_optional_ -a¦ - -[markdown] +a¦ *longerThan* + +optional +a¦ [markdown] -- The duration used to filter the active queries. Only included if the `longerThan` query parameter is used. @@ -955,13 +823,9 @@ Only included if the `longerThan` query parameter is used. [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*queryCount* + -_optional_ -a¦ - -[markdown] +a¦ *queryCount* + +optional +a¦ [markdown] -- The number of filtered active queries. -- @@ -969,13 +833,9 @@ The number of filtered active queries. [%hardbreaks] {blank} a¦ Integer - -a¦ -*queryMap* + -_optional_ -a¦ - -[markdown] +a¦ *queryMap* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-ActiveResponseFilterMap, opts=optional] -- @@ -990,28 +850,37 @@ a¦ xref:ActiveResponseFilterMap[] -// markup not found, no include::{specDir}definitions/ActiveResponseFilter/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ActiveResponseFilter/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ActiveResponseFilter/definition-after.adoc[opts=optional] - - - +ifndef::show-ActiveResponseFilter[] +:leveloffset: -1 +endif::show-ActiveResponseFilter[] -// markup not found, no include::{specDir}definitions/ActiveResponseFilterMap/definition-before.adoc[opts=optional] +include::{specDir}definitions/ActiveResponseFilter/definition-after.adoc[opts=optional] +include::{specDir}definitions/ActiveResponseFilterMap/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ActiveResponseFilterMap[] [#ActiveResponseFilterMap] +endif::show-ActiveResponseFilterMap[] +ifndef::show-ActiveResponseFilterMap[] +:leveloffset: +1 + +[discrete#ActiveResponseFilterMap] +endif::show-ActiveResponseFilterMap[] = Query Map +ifdef::model-descriptions[] +//tag::desc-ActiveResponseFilterMap[] +Contains 1 or more nested objects, each containing the details of a single active query. +//end::desc-ActiveResponseFilterMap[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ActiveResponseFilterMap/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ActiveResponseFilterMap/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1019,23 +888,14 @@ endif::collapse-models[] //tag::ActiveResponseFilterMap[] -ifdef::model-descriptions[] -//tag::desc-ActiveResponseFilterMap[] -Contains 1 or more nested objects, each containing the details of a single active query. -//end::desc-ActiveResponseFilterMap[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ - -_additional + -property_ -a¦ - -[markdown] +additional + +property +a¦ [markdown] -- include::index.adoc[tag=desc-ActiveResponseFilterMapItem, opts=optional] -- @@ -1050,28 +910,38 @@ a¦ xref:ActiveResponseFilterMapItem[] -// markup not found, no include::{specDir}definitions/ActiveResponseFilterMap/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ActiveResponseFilterMap/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ActiveResponseFilterMap/definition-after.adoc[opts=optional] - - - +ifndef::show-ActiveResponseFilterMap[] +:leveloffset: -1 +endif::show-ActiveResponseFilterMap[] -// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItem/definition-before.adoc[opts=optional] +include::{specDir}definitions/ActiveResponseFilterMap/definition-after.adoc[opts=optional] +include::{specDir}definitions/ActiveResponseFilterMapItem/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ActiveResponseFilterMapItem[] [#ActiveResponseFilterMapItem] +endif::show-ActiveResponseFilterMapItem[] +ifndef::show-ActiveResponseFilterMapItem[] +:leveloffset: +1 + +[discrete#ActiveResponseFilterMapItem] +endif::show-ActiveResponseFilterMapItem[] = Query Map Item +ifdef::model-descriptions[] +//tag::desc-ActiveResponseFilterMapItem[] +The details of a single active query. +The name of the property is the UUID of the node on which the query is running, and the ID of the query on that node, separated by a hyphen. +//end::desc-ActiveResponseFilterMapItem[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItem/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ActiveResponseFilterMapItem/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1079,23 +949,13 @@ endif::collapse-models[] //tag::ActiveResponseFilterMapItem[] -ifdef::model-descriptions[] -//tag::desc-ActiveResponseFilterMapItem[] -The details of a single active query. -The name of the property is the UUID of the node on which the query is running, and the ID of the query on that node, separated by a hyphen. -//end::desc-ActiveResponseFilterMapItem[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*QueryContext* + -_optional_ -a¦ - -[markdown] +a¦ *QueryContext* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-ActiveResponseFilterMapItemContext, opts=optional] -- @@ -1103,13 +963,9 @@ include::index.adoc[tag=desc-ActiveResponseFilterMapItemContext, opts=optional] [%hardbreaks] {blank} a¦ xref:ActiveResponseFilterMapItemContext[] - -a¦ -*executionTime* + -_optional_ -a¦ - -[markdown] +a¦ *executionTime* + +optional +a¦ [markdown] -- The time taken to execute the query. -- @@ -1124,28 +980,37 @@ a¦ String (duration) -// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItem/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ActiveResponseFilterMapItem/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItem/definition-after.adoc[opts=optional] - - - +ifndef::show-ActiveResponseFilterMapItem[] +:leveloffset: -1 +endif::show-ActiveResponseFilterMapItem[] -// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItemContext/definition-before.adoc[opts=optional] +include::{specDir}definitions/ActiveResponseFilterMapItem/definition-after.adoc[opts=optional] +include::{specDir}definitions/ActiveResponseFilterMapItemContext/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ActiveResponseFilterMapItemContext[] [#ActiveResponseFilterMapItemContext] +endif::show-ActiveResponseFilterMapItemContext[] +ifndef::show-ActiveResponseFilterMapItemContext[] +:leveloffset: +1 + +[discrete#ActiveResponseFilterMapItemContext] +endif::show-ActiveResponseFilterMapItemContext[] = Query Context +ifdef::model-descriptions[] +//tag::desc-ActiveResponseFilterMapItemContext[] +The query context. +//end::desc-ActiveResponseFilterMapItemContext[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItemContext/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ActiveResponseFilterMapItemContext/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1153,22 +1018,13 @@ endif::collapse-models[] //tag::ActiveResponseFilterMapItemContext[] -ifdef::model-descriptions[] -//tag::desc-ActiveResponseFilterMapItemContext[] -The query context. -//end::desc-ActiveResponseFilterMapItemContext[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*query* + -_optional_ -a¦ - -[markdown] +a¦ *query* + +optional +a¦ [markdown] -- An object containing the Search query. For more information, see [Search Request JSON Properties](../search/search-request-params.html). @@ -1177,55 +1033,42 @@ For more information, see [Search Request JSON Properties](../search/search-requ [%hardbreaks] {blank} a¦ Object - -a¦ -*size* + -_optional_ -a¦ - -[markdown] +a¦ *size* + +optional +a¦ [markdown] -- + -- [%hardbreaks] *Example:* `10` {blank} a¦ Integer - -a¦ -*from* + -_optional_ -a¦ - -[markdown] +a¦ *from* + +optional +a¦ [markdown] -- + -- [%hardbreaks] *Example:* `0` {blank} a¦ Integer - -a¦ -*timeout* + -_optional_ -a¦ - -[markdown] +a¦ *timeout* + +optional +a¦ [markdown] -- + -- [%hardbreaks] *Example:* `120000` {blank} a¦ Integer - -a¦ -*index* + -_optional_ -a¦ - -[markdown] +a¦ *index* + +optional +a¦ [markdown] -- The name of a Search index. -- @@ -1240,28 +1083,37 @@ a¦ String -// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItemContext/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ActiveResponseFilterMapItemContext/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItemContext/definition-after.adoc[opts=optional] - - - +ifndef::show-ActiveResponseFilterMapItemContext[] +:leveloffset: -1 +endif::show-ActiveResponseFilterMapItemContext[] -// markup not found, no include::{specDir}definitions/ActiveResponseStats/definition-before.adoc[opts=optional] +include::{specDir}definitions/ActiveResponseFilterMapItemContext/definition-after.adoc[opts=optional] +include::{specDir}definitions/ActiveResponseStats/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-ActiveResponseStats[] [#ActiveResponseStats] +endif::show-ActiveResponseStats[] +ifndef::show-ActiveResponseStats[] +:leveloffset: +1 + +[discrete#ActiveResponseStats] +endif::show-ActiveResponseStats[] = Stats +ifdef::model-descriptions[] +//tag::desc-ActiveResponseStats[] +An object containing request statistics. +//end::desc-ActiveResponseStats[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/ActiveResponseStats/definition-begin.adoc[opts=optional] +include::{specDir}definitions/ActiveResponseStats/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1269,37 +1121,26 @@ endif::collapse-models[] //tag::ActiveResponseStats[] -ifdef::model-descriptions[] -//tag::desc-ActiveResponseStats[] -An object containing request statistics. -//end::desc-ActiveResponseStats[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*total* + -_optional_ -a¦ - -[markdown] +a¦ *total* + +optional +a¦ [markdown] -- + -- [%hardbreaks] *Example:* `3` {blank} a¦ Integer - -a¦ -*successful* + -_optional_ -a¦ - -[markdown] +a¦ *successful* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -1313,28 +1154,31 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/ActiveResponseStats/definition-end.adoc[opts=optional] - +include::{specDir}definitions/ActiveResponseStats/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/ActiveResponseStats/definition-after.adoc[opts=optional] - - - +ifndef::show-ActiveResponseStats[] +:leveloffset: -1 +endif::show-ActiveResponseStats[] -// markup not found, no include::{specDir}definitions/CancelRequest/definition-before.adoc[opts=optional] +include::{specDir}definitions/ActiveResponseStats/definition-after.adoc[opts=optional] +include::{specDir}definitions/CancelRequest/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-CancelRequest[] [#CancelRequest] +endif::show-CancelRequest[] +ifndef::show-CancelRequest[] +:leveloffset: +1 + +[discrete#CancelRequest] +endif::show-CancelRequest[] = Cancellation Request :leveloffset: +1 -// markup not found, no include::{specDir}definitions/CancelRequest/definition-begin.adoc[opts=optional] +include::{specDir}definitions/CancelRequest/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1342,17 +1186,13 @@ endif::collapse-models[] //tag::CancelRequest[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*uuid* + -_optional_ -a¦ - -[markdown] +a¦ *uuid* + +optional +a¦ [markdown] -- Represents the active query's coordinator node's UUID, where the query will be canceled. This parameter allows the user to cancel a query anywhere in the system by specifying its coordinator node's UUID. @@ -1368,28 +1208,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/CancelRequest/definition-end.adoc[opts=optional] - +include::{specDir}definitions/CancelRequest/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/CancelRequest/definition-after.adoc[opts=optional] - - - +ifndef::show-CancelRequest[] +:leveloffset: -1 +endif::show-CancelRequest[] -// markup not found, no include::{specDir}definitions/CancelResponse/definition-before.adoc[opts=optional] +include::{specDir}definitions/CancelRequest/definition-after.adoc[opts=optional] +include::{specDir}definitions/CancelResponse/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-CancelResponse[] [#CancelResponse] +endif::show-CancelResponse[] +ifndef::show-CancelResponse[] +:leveloffset: +1 + +[discrete#CancelResponse] +endif::show-CancelResponse[] = Cancellation Response :leveloffset: +1 -// markup not found, no include::{specDir}definitions/CancelResponse/definition-begin.adoc[opts=optional] +include::{specDir}definitions/CancelResponse/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1397,17 +1240,13 @@ endif::collapse-models[] //tag::CancelResponse[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ *status* + +optional +a¦ [markdown] -- The status of the request. -- @@ -1415,13 +1254,9 @@ The status of the request. [%hardbreaks] {blank} a¦ String - -a¦ -*msg* + -_optional_ -a¦ - -[markdown] +a¦ *msg* + +optional +a¦ [markdown] -- The response message, giving details of the node UUID and query ID. -- @@ -1436,26 +1271,26 @@ a¦ String -// markup not found, no include::{specDir}definitions/CancelResponse/definition-end.adoc[opts=optional] - +include::{specDir}definitions/CancelResponse/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/CancelResponse/definition-after.adoc[opts=optional] - +ifndef::show-CancelResponse[] +:leveloffset: -1 +endif::show-CancelResponse[] +include::{specDir}definitions/CancelResponse/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] - +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -1465,31 +1300,25 @@ a¦ String include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/Default/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/Default/security-scheme-before.adoc[opts=optional] - - -[[security-default]] +[[security-Default]] = Default :leveloffset: +1 -// markup not found, no include::{specDir}security/Default/security-scheme-begin.adoc[opts=optional] +include::{specDir}security/Default/security-scheme-begin.adoc[opts=optional] [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/Default/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Default/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/Default/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/Default/security-scheme-after.adoc[opts=optional] @@ -1497,8 +1326,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - -// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] +include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/fts-rest-query/search-query.gradle b/docs/modules/fts-rest-query/search-query.gradle index 2f66d881..4c82eb43 100644 --- a/docs/modules/fts-rest-query/search-query.gradle +++ b/docs/modules/fts-rest-query/search-query.gradle @@ -38,6 +38,7 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file diff --git a/docs/modules/fts-rest-stats/pages/index.adoc b/docs/modules/fts-rest-stats/pages/index.adoc index c619dd88..1f673cd8 100644 --- a/docs/modules/fts-rest-stats/pages/index.adoc +++ b/docs/modules/fts-rest-stats/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbase/cbft :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -32,7 +31,7 @@ This API enables you to get statistics for the Search Service and your Search in [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -67,7 +66,6 @@ The host name or IP address of a node running the Search Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -83,31 +81,26 @@ The Search Service REST port. Use `18094` for secure access. |=== - -// markup not found, no include::{specDir}overview/document-end.adoc[opts=optional] +include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}overview/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 1 - +:count-apis: 0 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -115,54 +108,45 @@ xref:tag-Default[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Default] = Default :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:g-api-nsstats[] xref:g-api-nsstats-index-name[] -//tag::g-api-nsstats[] - -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-before.adoc[opts=optional] +//tag::g-api-nsstats[] +include::{specDir}paths/g-api-nsstats/operation-before.adoc[opts=optional] [#g-api-nsstats] = Get Query, Mutation, and Partition Statistics for the Search Service :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats/operation-begin.adoc[opts=optional] .... GET /api/nsstats .... - -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats/operation-description-before.adoc[opts=optional] [#g-api-nsstats-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -172,8 +156,7 @@ This endpoint returns statistics provided by the Cluster Manager. For additional statistics, including detailed partition information, see [Get Indexing and Data Metrics for All Indexes](../fts-rest-indexing/index.html#g-api-stats). -- - -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-description-end.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats/operation-description-end.adoc[opts=optional] @@ -181,33 +164,29 @@ For additional statistics, including detailed partition information, see [Get In .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats/operation-description-after.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats/operation-responses-before.adoc[opts=optional] [#g-api-nsstats-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -226,12 +205,14 @@ a| [markdown] Object not found. The URI may be malformed. -- a| + | 401 a| [markdown] -- Unauthorized. Failure to authenticate. -- a| + | 403 a| [markdown] -- @@ -241,95 +222,77 @@ a| |=== - -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-allStats: -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats/operation-security-before.adoc[opts=optional] [#g-api-nsstats-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-admin[] +| xref:security-Admin[] |=== - -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-security-end.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/g-api-nsstats/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}g-api-nsstats/http-request.adoc[opts=optional] - +include::{snippetDir}g-api-nsstats/http-request.adoc[opts=optional] include::{snippetDir}g-api-nsstats/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-end.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/g-api-nsstats/operation-after.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats/operation-after.adoc[opts=optional] //end::g-api-nsstats[] - //tag::g-api-nsstats-index-name[] - -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-before.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats-index-name/operation-before.adoc[opts=optional] [#g-api-nsstats-index-name] = Get Query, Mutation, and Partition Statistics for an Index :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats-index-name/operation-begin.adoc[opts=optional] .... GET /api/nsstats/index/{INDEX_NAME} .... - -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats-index-name/operation-description-before.adoc[opts=optional] [#g-api-nsstats-index-name-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats-index-name/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -339,8 +302,7 @@ This endpoint returns statistics provided by the Cluster Manager. For additional statistics, including detailed partition information, see [Get Indexing and Data Metrics for an Index](../fts-rest-indexing/index.html#g-api-stats-index-name). -- - -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-description-end.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats-index-name/operation-description-end.adoc[opts=optional] @@ -348,23 +310,20 @@ For additional statistics, including detailed partition information, see [Get In .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/g-api-nsstats-index-name/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats-index-name/operation-parameters-before.adoc[opts=optional] [#g-api-nsstats-index-name-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats-index-name/operation-parameters-begin.adoc[opts=optional] [#g-api-nsstats-index-name-path] .Path Parameters @@ -375,11 +334,8 @@ For additional statistics, including detailed partition information, see [Get In ¦ Name ¦ Description ¦ Schema a¦ *INDEX_NAME* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of the Search index definition. You must use the fully qualified name for the index, which includes the bucket and scope. @@ -398,30 +354,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats-index-name/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats-index-name/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats-index-name/operation-responses-before.adoc[opts=optional] [#g-api-nsstats-index-name-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats-index-name/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -434,102 +384,86 @@ The Search Service returns statistics from the `nsstats` endpoint for the specif -- a| xref:indexStats[] - |=== - -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats-index-name/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-indexStats: -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats-index-name/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats-index-name/operation-security-before.adoc[opts=optional] [#g-api-nsstats-index-name-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats-index-name/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-statistics[] +| xref:security-Statistics[] |=== - -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-security-end.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats-index-name/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/g-api-nsstats-index-name/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}g-api-nsstats-index-name/http-request.adoc[opts=optional] - +include::{snippetDir}g-api-nsstats-index-name/http-request.adoc[opts=optional] include::{snippetDir}g-api-nsstats-index-name/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-end.adoc[opts=optional] +include::{specDir}paths/g-api-nsstats-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-after.adoc[opts=optional] - +include::{specDir}paths/g-api-nsstats-index-name/operation-after.adoc[opts=optional] //end::g-api-nsstats-index-name[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] - +include::{specDir}paths/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] - +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 3 - +:count-models: 2 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:allStats[] xref:clusterStats[] @@ -537,35 +471,32 @@ xref:indexStats[] endif::[] +include::{specDir}definitions/allStats/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/allStats/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-allStats[] [#allStats] +endif::show-allStats[] +ifndef::show-allStats[] +:leveloffset: +1 + +[discrete#allStats] +endif::show-allStats[] = Service Statistics :leveloffset: +1 -// markup not found, no include::{specDir}definitions/allStats/definition-begin.adoc[opts=optional] - +include::{specDir}definitions/allStats/definition-begin.adoc[opts=optional] .icon:bars[fw] Composite Schema {blank} //tag::allStats[] - - [cols="25,55,20",separator=¦] |=== ¦ All{nbsp}of{nbsp}... ¦ ¦ Schema a¦ -a¦ - -[markdown] +a¦ [markdown] -- include::index.adoc[tag=desc-clusterStats, opts=optional] -- @@ -574,10 +505,8 @@ include::index.adoc[tag=desc-clusterStats, opts=optional] {blank} a¦ xref:clusterStats[] -a¦ _and_ -a¦ - -[markdown] +a¦ and +a¦ [markdown] -- include::index.adoc[tag=desc-indexStats, opts=optional] -- @@ -585,34 +514,41 @@ include::index.adoc[tag=desc-indexStats, opts=optional] [%hardbreaks] {blank} a¦ xref:indexStats[] - |=== //end::allStats[] - -// markup not found, no include::{specDir}definitions/allStats/definition-end.adoc[opts=optional] - +include::{specDir}definitions/allStats/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/allStats/definition-after.adoc[opts=optional] - - - +ifndef::show-allStats[] +:leveloffset: -1 +endif::show-allStats[] -// markup not found, no include::{specDir}definitions/clusterStats/definition-before.adoc[opts=optional] +include::{specDir}definitions/allStats/definition-after.adoc[opts=optional] +include::{specDir}definitions/clusterStats/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-clusterStats[] [#clusterStats] +endif::show-clusterStats[] +ifndef::show-clusterStats[] +:leveloffset: +1 + +[discrete#clusterStats] +endif::show-clusterStats[] = Cluster Statistics +ifdef::model-descriptions[] +//tag::desc-clusterStats[] +Statistics for the entire cluster. +//end::desc-clusterStats[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/clusterStats/definition-begin.adoc[opts=optional] +include::{specDir}definitions/clusterStats/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -620,36 +556,23 @@ endif::collapse-models[] //tag::clusterStats[] -ifdef::model-descriptions[] -//tag::desc-clusterStats[] -Statistics for the entire cluster. -//end::desc-clusterStats[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*avg_queries_latency* + -_optional_ -a¦ - -[markdown] +a¦ *avg_queries_latency* + +optional +a¦ [markdown] -- The average latency of all Search queries run on the cluster, in milliseconds. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*batch_bytes_added* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *batch_bytes_added* + +optional +a¦ [markdown] -- The total number of bytes in batches that have not yet been added to the Search index. @@ -659,13 +582,9 @@ Batches are a data structure in the Search Service, used for processing data com [%hardbreaks] {blank} a¦ Integer - -a¦ -*batch_bytes_removed* + -_optional_ -a¦ - -[markdown] +a¦ *batch_bytes_removed* + +optional +a¦ [markdown] -- The total number of bytes in batches that have been added to the Search index. @@ -677,13 +596,9 @@ Batches are a data structure in the Search Service, used for processing data com [%hardbreaks] {blank} a¦ Integer - -a¦ -*curr_batches_blocked_by_herder* + -_optional_ -a¦ - -[markdown] +a¦ *curr_batches_blocked_by_herder* + +optional +a¦ [markdown] -- The difference between the number of batches that have been indexed (`batch_bytes_removed`) and batches that have not yet been indexed (`batch_bytes_added`). @@ -695,13 +610,9 @@ This statistic appears on the Server Web Console dashboard as **DCP Batches Bloc [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_batches_introduced* + -_optional_ -a¦ - -[markdown] +a¦ *num_batches_introduced* + +optional +a¦ [markdown] -- The total number of batches introduced as part of indexing operations. @@ -711,13 +622,9 @@ Batches are a data structure in the Search Service, used for processing data com [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_bytes_ram_quota* + -_optional_ -a¦ - -[markdown] +a¦ *num_bytes_ram_quota* + +optional +a¦ [markdown] -- The total number of bytes set as the maximum usable memory for the Search Service on the cluster. @@ -727,13 +634,9 @@ This statistic appears on the Server Web Console dashboard as **RAM Quota for Se [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_bytes_used_disk* + -_optional_ -a¦ - -[markdown] +a¦ *num_bytes_used_disk* + +optional +a¦ [markdown] -- The total number of bytes used on disk by Search indexes in the cluster. -- @@ -741,13 +644,9 @@ The total number of bytes used on disk by Search indexes in the cluster. [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_bytes_used_ram* + -_optional_ -a¦ - -[markdown] +a¦ *num_bytes_used_ram* + +optional +a¦ [markdown] -- The number of bytes used in memory by the Search Service. @@ -757,13 +656,9 @@ This statistic appears on the Server Web Console dashboard as **RAM Used by Sear [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_bytes_used_ram_c* + -_optional_ -a¦ - -[markdown] +a¦ *num_bytes_used_ram_c* + +optional +a¦ [markdown] -- The number of bytes used in memory by the Search Service's C language processes. @@ -773,13 +668,9 @@ This amount is included as part of the total number of bytes used in memory, giv [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_files_on_disk* + -_optional_ -a¦ - -[markdown] +a¦ *num_files_on_disk* + +optional +a¦ [markdown] -- The total number of files on disk for all Search indexes. -- @@ -787,13 +678,9 @@ The total number of files on disk for all Search indexes. [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_gocbcore_dcp_agents* + -_optional_ -a¦ - -[markdown] +a¦ *num_gocbcore_dcp_agents* + +optional +a¦ [markdown] -- The total number of Go SDK DCP agents used by the Search Service to establish DCP communication with the Data Service. @@ -803,13 +690,9 @@ The number of Go SDK DCP agents should be less than or equal to the number of Se [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_gocbcore_stats_agents* + -_optional_ -a¦ - -[markdown] +a¦ *num_gocbcore_stats_agents* + +optional +a¦ [markdown] -- The total number of Go SDK agent pairs, used to retrieve statistics from the Data Service, that are present on a node. @@ -819,27 +702,19 @@ Typically, the Search Service uses one agent pair for each bucket on a node. [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_indexes* + -_optional_ -a¦ - -[markdown] +a¦ *num_indexes* + +optional +a¦ [markdown] -- The number of Search indexes in the cluster. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*num_knn_search_requests* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *num_knn_search_requests* + +optional +a¦ [markdown] -- The total number of [Vector Search](https://docs.couchbase.com/server/8.0/vector-search/vector-search.html) requests made across all Search indexes in the cluster. -- @@ -847,27 +722,19 @@ The total number of [Vector Search](https://docs.couchbase.com/server/8.0/vector [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_vector_indexes* + -_optional_ -a¦ - -[markdown] +a¦ *num_vector_indexes* + +optional +a¦ [markdown] -- The number of Search indexes in the cluster that have vector/vector_base64 fields. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*pct_cpu_gc* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *pct_cpu_gc* + +optional +a¦ [markdown] -- The percentage of CPU time spent by a Search index in garbage collection. Garbage collection involves cleanup actions like removing unnecessary index entries. @@ -875,14 +742,10 @@ Garbage collection involves cleanup actions like removing unnecessary index entr [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*pct_used_ram* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *pct_used_ram* + +optional +a¦ [markdown] -- The percentage of the available RAM quota used by the Search Service. @@ -891,14 +754,10 @@ This statistic appears on the Server Web Console dashboard as **Pct RAM Used by [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*tot_batches_flushed_on_maxops* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *tot_batches_flushed_on_maxops* + +optional +a¦ [markdown] -- The total number of batches executed due to the batch size being greater than the maximum number of operations per batch. @@ -909,13 +768,9 @@ A batch is executed when it's flushed to disk. [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_batches_flushed_on_timer* + -_optional_ -a¦ - -[markdown] +a¦ *tot_batches_flushed_on_timer* + +optional +a¦ [markdown] -- The total number of batches executed at regular intervals. -- @@ -923,13 +778,9 @@ The total number of batches executed at regular intervals. [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_batches_merged* + -_optional_ -a¦ - -[markdown] +a¦ *tot_batches_merged* + +optional +a¦ [markdown] -- The number of batches that have been merged together before being sent to the disk write queue. @@ -940,13 +791,9 @@ A batch is executed when it's flushed to disk. [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_batches_new* + -_optional_ -a¦ - -[markdown] +a¦ *tot_batches_new* + +optional +a¦ [markdown] -- The number of new batches that have been freshly introduced into the system. @@ -956,13 +803,9 @@ Batches are a data structure in the Search Service, used for processing data com [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_bleve_dest_closed* + -_optional_ -a¦ - -[markdown] +a¦ *tot_bleve_dest_closed* + +optional +a¦ [markdown] -- The total number of times a Search index partition closed to new Search requests. -- @@ -970,13 +813,9 @@ The total number of times a Search index partition closed to new Search requests [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_bleve_dest_opened* + -_optional_ -a¦ - -[markdown] +a¦ *tot_bleve_dest_opened* + +optional +a¦ [markdown] -- The total number of times Search index partitions were created or reopened for new Search requests, or for ingesting data coming in from DCP. @@ -986,13 +825,9 @@ Opening a Search index partition creates a file lock for concurrent access reque [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_grpc_listeners_closed* + -_optional_ -a¦ - -[markdown] +a¦ *tot_grpc_listeners_closed* + +optional +a¦ [markdown] -- The total number of gRPC listeners closed. @@ -1004,13 +839,9 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_grpc_listeners_opened* + -_optional_ -a¦ - -[markdown] +a¦ *tot_grpc_listeners_opened* + +optional +a¦ [markdown] -- The total number of gRPC listeners opened. @@ -1022,13 +853,9 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_grpc_queryreject_on_memquota* + -_optional_ -a¦ - -[markdown] +a¦ *tot_grpc_queryreject_on_memquota* + +optional +a¦ [markdown] -- The total number of gRPC queries rejected because of the available memory quota for the Search Service being less than the estimated memory required for merging search results from all partitions. @@ -1040,13 +867,9 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_grpcs_listeners_closed* + -_optional_ -a¦ - -[markdown] +a¦ *tot_grpcs_listeners_closed* + +optional +a¦ [markdown] -- The total number of gRPC SSL listeners closed. @@ -1058,15 +881,11 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_grpcs_listeners_opened* + -_optional_ -a¦ - -[markdown] --- -The total number of gRPC SSL listeners opened. +a¦ *tot_grpcs_listeners_opened* + +optional +a¦ [markdown] +-- +The total number of gRPC SSL listeners opened. gRPC SSL listeners handle incoming SSL connection requests to the Search Service. @@ -1076,13 +895,9 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_http_limitlisteners_closed* + -_optional_ -a¦ - -[markdown] +a¦ *tot_http_limitlisteners_closed* + +optional +a¦ [markdown] -- The total number of HTTP limit listeners closed. @@ -1092,13 +907,9 @@ HTTP limit listeners manage limits on incoming HTTP requests to the Search Servi [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_http_limitlisteners_opened* + -_optional_ -a¦ - -[markdown] +a¦ *tot_http_limitlisteners_opened* + +optional +a¦ [markdown] -- The total number of HTTP limit listeners opened. @@ -1108,13 +919,9 @@ HTTP limit listeners manage limits on incoming HTTP requests to the Search Servi [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_https_limitlisteners_closed* + -_optional_ -a¦ - -[markdown] +a¦ *tot_https_limitlisteners_closed* + +optional +a¦ [markdown] -- The total number of HTTPS limit listeners closed. @@ -1124,13 +931,9 @@ HTTPS limit listeners manage limits on incoming HTTPS requests to the Search Ser [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_https_limitlisteners_opened* + -_optional_ -a¦ - -[markdown] +a¦ *tot_https_limitlisteners_opened* + +optional +a¦ [markdown] -- The total number of HTTPS limit listeners opened. @@ -1140,13 +943,9 @@ HTTPS limit listeners manage limits on incoming HTTPS requests to the Search Ser [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_queryreject_on_memquota* + -_optional_ -a¦ - -[markdown] +a¦ *tot_queryreject_on_memquota* + +optional +a¦ [markdown] -- The total number of Search queries rejected because of the available memory quota for the Search Service being less than the estimated memory required for merging search results from all partitions. @@ -1156,13 +955,9 @@ For more information about how to set the Search Service's quota, see [ftsMemory [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_remote_grpc* + -_optional_ -a¦ - -[markdown] +a¦ *tot_remote_grpc* + +optional +a¦ [markdown] -- The total number of remote gRPC requests made to the Search Service. @@ -1172,13 +967,9 @@ A request is remote if it comes from a different node in the cluster. [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_remote_grpc_ssl* + -_optional_ -a¦ - -[markdown] +a¦ *tot_remote_grpc_ssl* + +optional +a¦ [markdown] -- The total number of gRPC scatter-gather requests made to the Search Service over SSL. @@ -1188,13 +979,9 @@ A request is remote if it comes from a different node in the cluster. [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_remote_grpc_tls* + -_optional_ -a¦ - -[markdown] +a¦ *tot_remote_grpc_tls* + +optional +a¦ [markdown] -- This metric is deprecated. -- @@ -1202,13 +989,9 @@ This metric is deprecated. [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_remote_http* + -_optional_ -a¦ - -[markdown] +a¦ *tot_remote_http* + +optional +a¦ [markdown] -- The total number of remote HTTP requests made to the Search Service. @@ -1221,13 +1004,9 @@ Use gRPC requests, instead. [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_remote_http2* + -_optional_ -a¦ - -[markdown] +a¦ *tot_remote_http2* + +optional +a¦ [markdown] -- The total number of remote HTTPS requests made to the Search Service. @@ -1240,13 +1019,9 @@ Use gRPC requests, instead. [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_remote_http_ssl* + -_optional_ -a¦ - -[markdown] +a¦ *tot_remote_http_ssl* + +optional +a¦ [markdown] -- The total number of remote HTTP SSL requests made to the Search Service. @@ -1259,13 +1034,9 @@ Use gRPC requests, instead. [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_rollback_full* + -_optional_ -a¦ - -[markdown] +a¦ *tot_rollback_full* + +optional +a¦ [markdown] -- The total number of full rollbacks that occurred on a Search index partition. @@ -1278,13 +1049,9 @@ If the Search Service's index snapshots are too far ahead of the Data Service's [%hardbreaks] {blank} a¦ Integer - -a¦ -*tot_rollback_partial* + -_optional_ -a¦ - -[markdown] +a¦ *tot_rollback_partial* + +optional +a¦ [markdown] -- The total number of partial rollbacks that occurred on a Search index partition. @@ -1297,13 +1064,9 @@ If the Search Service's index snapshots are too far ahead of the Data Service's [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_bytes_query_results* + -_optional_ -a¦ - -[markdown] +a¦ *total_bytes_query_results* + +optional +a¦ [markdown] -- The size of all results returned for Search queries. This includes the size of all JSON sent. @@ -1312,13 +1075,9 @@ This includes the size of all JSON sent. [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_create_index_bad_request_error* + -_optional_ -a¦ - -[markdown] +a¦ *total_create_index_bad_request_error* + +optional +a¦ [markdown] -- The total number of bad request errors returned for requests to create new Search indexes on the cluster. -- @@ -1326,13 +1085,9 @@ The total number of bad request errors returned for requests to create new Searc [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_create_index_internal_server_error* + -_optional_ -a¦ - -[markdown] +a¦ *total_create_index_internal_server_error* + +optional +a¦ [markdown] -- The total number of internal server errors returned for requests to create new Search indexes on the cluster. -- @@ -1340,13 +1095,9 @@ The total number of internal server errors returned for requests to create new S [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_create_index_request* + -_optional_ -a¦ - -[markdown] +a¦ *total_create_index_request* + +optional +a¦ [markdown] -- The total number of requests received by the Search Service for creating new Search indexes. -- @@ -1354,13 +1105,9 @@ The total number of requests received by the Search Service for creating new Sea [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_create_index_request_ok* + -_optional_ -a¦ - -[markdown] +a¦ *total_create_index_request_ok* + +optional +a¦ [markdown] -- The total number of requests received by the Search Service for creating new Search indexes that were successful. -- @@ -1368,13 +1115,9 @@ The total number of requests received by the Search Service for creating new Sea [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_delete_index_bad_request_error* + -_optional_ -a¦ - -[markdown] +a¦ *total_delete_index_bad_request_error* + +optional +a¦ [markdown] -- The total number of bad request errors returned for requests to delete Search indexes on the cluster. -- @@ -1382,13 +1125,9 @@ The total number of bad request errors returned for requests to delete Search in [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_delete_index_internal_server_error* + -_optional_ -a¦ - -[markdown] +a¦ *total_delete_index_internal_server_error* + +optional +a¦ [markdown] -- The total number of internal server errors returned for requests to delete Search indexes on the cluster. -- @@ -1396,13 +1135,9 @@ The total number of internal server errors returned for requests to delete Searc [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_delete_index_request* + -_optional_ -a¦ - -[markdown] +a¦ *total_delete_index_request* + +optional +a¦ [markdown] -- The total number of requests received by the Search Service to delete Search indexes. -- @@ -1410,13 +1145,9 @@ The total number of requests received by the Search Service to delete Search ind [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_delete_index_request_ok* + -_optional_ -a¦ - -[markdown] +a¦ *total_delete_index_request_ok* + +optional +a¦ [markdown] -- The total number of requests received by the Search Service to delete Search indexes that were successful. -- @@ -1424,13 +1155,9 @@ The total number of requests received by the Search Service to delete Search ind [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_gc* + -_optional_ -a¦ - -[markdown] +a¦ *total_gc* + +optional +a¦ [markdown] -- The total number of garbage collection events triggered by the Search Service. @@ -1440,13 +1167,9 @@ Garbage collection events include removing unnecessary index entries. [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_internal_queries* + -_optional_ -a¦ - -[markdown] +a¦ *total_internal_queries* + +optional +a¦ [markdown] -- The number of internal queries from the coordinating node for a Search query to other nodes running the Search Service. @@ -1458,13 +1181,9 @@ The coordinating node applies filters to the results from all Search index parti [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_queries* + -_optional_ -a¦ - -[markdown] +a¦ *total_queries* + +optional +a¦ [markdown] -- The total number of Search queries per second across all Search indexes in the cluster. -- @@ -1472,13 +1191,9 @@ The total number of Search queries per second across all Search indexes in the c [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_queries_bad_request_error* + -_optional_ -a¦ - -[markdown] +a¦ *total_queries_bad_request_error* + +optional +a¦ [markdown] -- The total number of bad request errors returned for Search queries on the cluster. -- @@ -1486,13 +1201,9 @@ The total number of bad request errors returned for Search queries on the cluste [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_queries_consistency_error* + -_optional_ -a¦ - -[markdown] +a¦ *total_queries_consistency_error* + +optional +a¦ [markdown] -- The total number of Search queries that encountered consistency errors on the cluster. @@ -1502,13 +1213,9 @@ For more information about consistency in Search queries, see [Search Request JS [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_queries_error* + -_optional_ -a¦ - -[markdown] +a¦ *total_queries_error* + +optional +a¦ [markdown] -- The total number of Search queries that encountered an error on the cluster. -- @@ -1516,13 +1223,9 @@ The total number of Search queries that encountered an error on the cluster. [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_queries_max_result_window_exceeded_error* + -_optional_ -a¦ - -[markdown] +a¦ *total_queries_max_result_window_exceeded_error* + +optional +a¦ [markdown] -- The total number of Search queries that exceeded the [bleveMaxResultWindow](https://docs.couchbase.com/server/8.0/fts/fts-advanced-settings-bleveMaxResultWindow.html) setting. -- @@ -1530,13 +1233,9 @@ The total number of Search queries that exceeded the [bleveMaxResultWindow](http [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_queries_partial_results_error* + -_optional_ -a¦ - -[markdown] +a¦ *total_queries_partial_results_error* + +optional +a¦ [markdown] -- The total number of Search queries that could only return partial results. @@ -1546,13 +1245,9 @@ A Search query can return partial results if it times out before all partitions [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_queries_rejected_by_herder* + -_optional_ -a¦ - -[markdown] +a¦ *total_queries_rejected_by_herder* + +optional +a¦ [markdown] -- The total number of queries rejected by the Search Service when the memory used approaches or exceeds the quota set for a query. @@ -1564,13 +1259,9 @@ This statistic appears on the Server Web Console dashboard as **Rejected Queries [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_queries_search_in_context_error* + -_optional_ -a¦ - -[markdown] +a¦ *total_queries_search_in_context_error* + +optional +a¦ [markdown] -- The total number of Search queries that returned an error when running through the `SearchInContext` API. @@ -1580,13 +1271,9 @@ These errors are typically internal server errors. [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_queries_slow* + -_optional_ -a¦ - -[markdown] +a¦ *total_queries_slow* + +optional +a¦ [markdown] -- The total number of Search queries that were added to the slow query log. -- @@ -1594,13 +1281,9 @@ The total number of Search queries that were added to the slow query log. [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_queries_timeout* + -_optional_ -a¦ - -[markdown] +a¦ *total_queries_timeout* + +optional +a¦ [markdown] -- The total number of Search queries that timed out. @@ -1610,13 +1293,9 @@ You can set the timeout for a query with the [ctl object](https://docs.couchbase [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_queries_validation_error* + -_optional_ -a¦ - -[markdown] +a¦ *total_queries_validation_error* + +optional +a¦ [markdown] -- The total number of queries that encountered a validation error, when the query request included a `validate` property in the `ctl` object. @@ -1626,13 +1305,9 @@ For more information, see the [validate property](https://docs.couchbase.com/ser [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_request_time* + -_optional_ -a¦ - -[markdown] +a¦ *total_request_time* + +optional +a¦ [markdown] -- The total time, in nanoseconds, spent processing Search queries across the cluster. -- @@ -1647,28 +1322,37 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/clusterStats/definition-end.adoc[opts=optional] - +include::{specDir}definitions/clusterStats/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/clusterStats/definition-after.adoc[opts=optional] - - - +ifndef::show-clusterStats[] +:leveloffset: -1 +endif::show-clusterStats[] -// markup not found, no include::{specDir}definitions/indexStats/definition-before.adoc[opts=optional] +include::{specDir}definitions/clusterStats/definition-after.adoc[opts=optional] +include::{specDir}definitions/indexStats/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-indexStats[] [#indexStats] +endif::show-indexStats[] +ifndef::show-indexStats[] +:leveloffset: +1 + +[discrete#indexStats] +endif::show-indexStats[] = Index Statistics +ifdef::model-descriptions[] +//tag::desc-indexStats[] +Statistics for a single Search index. +//end::desc-indexStats[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/indexStats/definition-begin.adoc[opts=optional] +include::{specDir}definitions/indexStats/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1676,22 +1360,13 @@ endif::collapse-models[] //tag::indexStats[] -ifdef::model-descriptions[] -//tag::desc-indexStats[] -Statistics for a single Search index. -//end::desc-indexStats[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*BUCKET:INDEX:avg_grpc_internal_queries_latency* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:avg_grpc_internal_queries_latency* + +optional +a¦ [markdown] -- The average time taken for a Search query's scatter-gather requests between the coordinator and other nodes running the Search Service. @@ -1702,13 +1377,9 @@ The coordinator is the Search node that receives the Search request and scatters [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:avg_grpc_queries_latency* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:avg_grpc_queries_latency* + +optional +a¦ [markdown] -- The average time taken for each Search query that uses gRPC, in milliseconds for the given Search index. @@ -1718,13 +1389,9 @@ The Search Service uses gRPC to manage scatter-gather operations across nodes wh [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:avg_internal_queries_latency* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:avg_internal_queries_latency* + +optional +a¦ [markdown] -- The average latency, in milliseconds, for inter-node queries for the given Search index. -- @@ -1732,13 +1399,9 @@ The average latency, in milliseconds, for inter-node queries for the given Searc [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:avg_queries_latency* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:avg_queries_latency* + +optional +a¦ [markdown] -- The average latency, in milliseconds, for all Search queries on the given Search index. @@ -1748,13 +1411,9 @@ This statistic appears on the Server Web Console dashboard as **Search Query Lat [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:doc_count* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:doc_count* + +optional +a¦ [markdown] -- The total number of documents in the given Search index. @@ -1764,167 +1423,119 @@ This statistic appears on the Server Web Console dashboard as **Search Docs**. [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:global_query_timer_count* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:global_query_timer_count* + +optional +a¦ [markdown] -- The number of Search query timer events received at the global query endpoint. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*BUCKET:INDEX:global_query_timer_mean_ns* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *BUCKET:INDEX:global_query_timer_mean_ns* + +optional +a¦ [markdown] -- The mean runtime for Search queries received at the global query endpoint in nanoseconds. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*BUCKET:INDEX:global_query_timer_median_ns* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *BUCKET:INDEX:global_query_timer_median_ns* + +optional +a¦ [markdown] -- The median runtime for Search queries received at the global query endpoint in nanoseconds. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*BUCKET:INDEX:global_query_timer_p80_ns* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *BUCKET:INDEX:global_query_timer_p80_ns* + +optional +a¦ [markdown] -- The 80th percentile runtime for Search queries received at the global query endpoint in nanoseconds. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*BUCKET:INDEX:global_query_timer_p99_ns* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *BUCKET:INDEX:global_query_timer_p99_ns* + +optional +a¦ [markdown] -- The 99th percentile runtime for Search queries received at the global query endpoint in nanoseconds. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*BUCKET:INDEX:grpc_query_timer_count* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *BUCKET:INDEX:grpc_query_timer_count* + +optional +a¦ [markdown] -- The number of Search query timer events received at the gRPC endpoint. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*BUCKET:INDEX:grpc_query_timer_mean_ns* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *BUCKET:INDEX:grpc_query_timer_mean_ns* + +optional +a¦ [markdown] -- The mean runtime for Search queries received at the gRPC endpoint in nanoseconds. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*BUCKET:INDEX:grpc_query_timer_median_ns* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *BUCKET:INDEX:grpc_query_timer_median_ns* + +optional +a¦ [markdown] -- The median runtime for Search queries received at the gRPC endpoint in nanoseconds. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*BUCKET:INDEX:grpc_query_timer_p80_ns* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *BUCKET:INDEX:grpc_query_timer_p80_ns* + +optional +a¦ [markdown] -- The 80th percentile runtime for Search queries received at the gRPC endpoint in nanoseconds. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*BUCKET:INDEX:grpc_query_timer_p99_ns* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *BUCKET:INDEX:grpc_query_timer_p99_ns* + +optional +a¦ [markdown] -- The 99th percentile runtime for Search queries received at the gRPC endpoint in nanoseconds. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*BUCKET:INDEX:last_access_time* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *BUCKET:INDEX:last_access_time* + +optional +a¦ [markdown] -- The last date and time that a query ran against the given Search index. -- [%hardbreaks] {blank} -a¦ Date (date-time) - -a¦ -*BUCKET:INDEX:num_bytes_read_at_query_time* + -_optional_ -a¦ - -[markdown] +a¦ Date (date-time) +a¦ *BUCKET:INDEX:num_bytes_read_at_query_time* + +optional +a¦ [markdown] -- The total number of bytes read by all queries against the given Search index. -- @@ -1932,13 +1543,9 @@ The total number of bytes read by all queries against the given Search index. [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:num_bytes_used_disk* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:num_bytes_used_disk* + +optional +a¦ [markdown] -- The total number of bytes used on disk by the given Search index. @@ -1948,13 +1555,9 @@ This statistic appears on the Server Web Console dashboard as **Search Disk Size [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:num_bytes_used_disk_by_root* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:num_bytes_used_disk_by_root* + +optional +a¦ [markdown] -- The total number of bytes used on disk by the root segment of the given Search index. @@ -1968,13 +1571,9 @@ The `num_bytes_used_disk_by_root` value will be less than the `num_bytes_used_di [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:num_bytes_used_disk_by_root_reclaimable* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:num_bytes_used_disk_by_root_reclaimable* + +optional +a¦ [markdown] -- The total number of bytes used on disk by the latest root index segment snapshot, which can potentially be reclaimed by a file merge operation. @@ -1986,13 +1585,9 @@ Stale segments are deleted when they're not used by any new queries. [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:num_bytes_written_at_index_time* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:num_bytes_written_at_index_time* + +optional +a¦ [markdown] -- The total cumulative number of bytes written to disk as part of introducing segments, or files. -- @@ -2000,13 +1595,9 @@ The total cumulative number of bytes written to disk as part of introducing segm [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:num_file_merge_ops* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:num_file_merge_ops* + +optional +a¦ [markdown] -- The number of merge operations completed by the merger routine, over persisted files. @@ -2020,13 +1611,9 @@ The persister and merger interact to continuously flush and merge new in-memory [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:num_files_on_disk* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:num_files_on_disk* + +optional +a¦ [markdown] -- The total number of files on disk for the given Search index. @@ -2036,13 +1623,9 @@ This statistic appears on the Server Web Console dashboard as **Search Disk File [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:num_mem_merge_ops* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:num_mem_merge_ops* + +optional +a¦ [markdown] -- The number of merge operations completed by the merger routine, over in-memory segments. @@ -2056,13 +1639,9 @@ The persister and merger interact to continuously flush and merge new in-memory [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:num_mutations_to_index* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:num_mutations_to_index* + +optional +a¦ [markdown] -- The DCP sequence numbers of changes that have not yet been indexed for the given Search index. @@ -2072,13 +1651,9 @@ This statistic appears on the Server Web Console dashboard as **Search Mutations [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:num_persister_nap_merger_break* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:num_persister_nap_merger_break* + +optional +a¦ [markdown] -- The number of times the persister was interrupted by the merger during a nap period. @@ -2092,13 +1667,9 @@ The persister and merger interact to continuously flush and merge new in-memory [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:num_persister_nap_pause_completed* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:num_persister_nap_pause_completed* + +optional +a¦ [markdown] -- The number of times the persister completed its configured nap period before flushing content to disk, without being interrupted by the merger. @@ -2112,13 +1683,9 @@ The persister and merger interact to continuously flush and merge new in-memory [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:num_pindexes_actual* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:num_pindexes_actual* + +optional +a¦ [markdown] -- The total number of partitions currently in the given Search index. @@ -2128,13 +1695,9 @@ This statistic appears on the Server Web Console dashboard as **Search Partition [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:num_pindexes_target* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:num_pindexes_target* + +optional +a¦ [markdown] -- The total number of planned or expected partitions for the given Search index. @@ -2144,13 +1707,9 @@ This statistic appears on the Server Web Console dashboard as **Search Partition [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:num_recs_to_persist* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:num_recs_to_persist* + +optional +a¦ [markdown] -- The total number of entries, including terms, records, and dictionary rows, that have not yet been persisted to disk. @@ -2160,13 +1719,9 @@ This statistic appears on the Server Web Console dashboard as **Search Records t [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:num_root_filesegments* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:num_root_filesegments* + +optional +a¦ [markdown] -- The total number of file segments in the root segment. @@ -2178,13 +1733,9 @@ This statistic appears on the Server Web Console dashboard as **Search Disk Segm [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:num_root_memorysegments* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:num_root_memorysegments* + +optional +a¦ [markdown] -- The total number of memory segments in the root segment. @@ -2196,83 +1747,59 @@ This statistic appears on the Server Web Console dashboard as **Search Memory Se [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:scoped_query_timer_count* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:scoped_query_timer_count* + +optional +a¦ [markdown] -- The number of Search query timer events received at the scoped query endpoint. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*BUCKET:INDEX:scoped_query_timer_mean_ns* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *BUCKET:INDEX:scoped_query_timer_mean_ns* + +optional +a¦ [markdown] -- The mean runtime for Search queries received at the scoped query endpoint in nanoseconds. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*BUCKET:INDEX:scoped_query_timer_median_ns* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *BUCKET:INDEX:scoped_query_timer_median_ns* + +optional +a¦ [markdown] -- The median runtime for Search queries received at the scoped query endpoint in nanoseconds. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*BUCKET:INDEX:scoped_query_timer_p80_ns* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *BUCKET:INDEX:scoped_query_timer_p80_ns* + +optional +a¦ [markdown] -- The 80th percentile runtime for Search queries received at the scoped query endpoint in nanoseconds. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*BUCKET:INDEX:scoped_query_timer_p99_ns* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *BUCKET:INDEX:scoped_query_timer_p99_ns* + +optional +a¦ [markdown] -- The 99th percentile runtime for Search queries received at the scoped query endpoint in nanoseconds. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*BUCKET:INDEX:timer_batch_store_count* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *BUCKET:INDEX:timer_batch_store_count* + +optional +a¦ [markdown] -- The total number of times batches were executed against the given Search index. @@ -2283,13 +1810,9 @@ A batch is executed when it's flushed to disk. [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:timer_data_delete_count* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:timer_data_delete_count* + +optional +a¦ [markdown] -- The total number of delete operations received from DCP for the given Search index. -- @@ -2297,13 +1820,9 @@ The total number of delete operations received from DCP for the given Search ind [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:timer_data_update_count* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:timer_data_update_count* + +optional +a¦ [markdown] -- The total number of create or update operations received from DCP for the given Search index. -- @@ -2311,13 +1830,9 @@ The total number of create or update operations received from DCP for the given [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:timer_opaque_get_count* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:timer_opaque_get_count* + +optional +a¦ [markdown] -- The total number of times the DCP consumer had to retrieve stored metadata to aid in reconnection for the given Search index. @@ -2327,13 +1842,9 @@ If the DCP connection closes, the Search Service can use this stored metadata to [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:timer_opaque_set_count* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:timer_opaque_set_count* + +optional +a¦ [markdown] -- The total number of times the DCP consumer updated stored metadata, based on changes to Snapshot markers or the failover log, for the given Search index. -- @@ -2341,13 +1852,9 @@ The total number of times the DCP consumer updated stored metadata, based on cha [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:timer_rollback_count* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:timer_rollback_count* + +optional +a¦ [markdown] -- The total number of DCP Rollback messages received for the given Search index. -- @@ -2355,13 +1862,9 @@ The total number of DCP Rollback messages received for the given Search index. [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:timer_snapshot_start_count* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:timer_snapshot_start_count* + +optional +a¦ [markdown] -- The total number of DCP Snapshot markers received for the given Search index. @@ -2371,13 +1874,9 @@ Snapshots contain a representation of document mutations on either a write queue [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:tot_seq_received* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:tot_seq_received* + +optional +a¦ [markdown] -- This metric is no longer used and will soon be deprecated. -- @@ -2385,13 +1884,9 @@ This metric is no longer used and will soon be deprecated. [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_bytes_indexed* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_bytes_indexed* + +optional +a¦ [markdown] -- The rate, in bytes per second, of content indexed in the given Search index. @@ -2401,13 +1896,9 @@ This statistic appears on the Server Web Console dashboard as **Search Index Rat [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_bytes_query_results* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_bytes_query_results* + +optional +a¦ [markdown] -- The size of results returned for Search queries on the given Search index. This includes the size of all JSON sent. @@ -2418,13 +1909,9 @@ This statistic appears on the Server Web Console dashboard as **Search Result Ra [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_compaction_written_bytes* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_compaction_written_bytes* + +optional +a¦ [markdown] -- The total number of bytes written to disk as a result of compaction operations on the given Search index. @@ -2434,13 +1921,9 @@ This statistic appears on the Server Web Console dashboard as **Search Compactio [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_grpc_internal_queries* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_grpc_internal_queries* + +optional +a¦ [markdown] -- The total number of internal gRPC requests from the coordinating node for a Search query to other nodes running the Search Service, for the given Search index. @@ -2452,13 +1935,9 @@ The coordinating node applies filters to the results from all Search index parti [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_grpc_queries* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_grpc_queries* + +optional +a¦ [markdown] -- The total number of queries, using gRPC for streaming, for the given Search index. -- @@ -2466,13 +1945,9 @@ The total number of queries, using gRPC for streaming, for the given Search inde [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_grpc_queries_error* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_grpc_queries_error* + +optional +a¦ [markdown] -- The total number of queries that resulted in an error that used gRPC for streaming on the given Search index. -- @@ -2480,13 +1955,9 @@ The total number of queries that resulted in an error that used gRPC for streami [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_grpc_queries_slow* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_grpc_queries_slow* + +optional +a¦ [markdown] -- The total number of queries added to the slow query log that used gRPC for streaming on the given Search index. -- @@ -2494,13 +1965,9 @@ The total number of queries added to the slow query log that used gRPC for strea [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_grpc_queries_timeout* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_grpc_queries_timeout* + +optional +a¦ [markdown] -- The total number of queries that timed out that used gRPC for streaming on the given Search index. -- @@ -2508,13 +1975,9 @@ The total number of queries that timed out that used gRPC for streaming on the g [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_grpc_request_time* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_grpc_request_time* + +optional +a¦ [markdown] -- The total time, in nanoseconds, for internal scatter-gather requests. @@ -2526,13 +1989,9 @@ The coordinating node applies filters to the results from all Search index parti [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_internal_queries* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_internal_queries* + +optional +a¦ [markdown] -- The number of internal queries from the coordinating node for a Search query to other nodes running the Search Service, for the given Search index. @@ -2544,13 +2003,9 @@ The coordinating node applies filters to the results from all Search index parti [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_knn_searches* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_knn_searches* + +optional +a¦ [markdown] -- The total number of [Vector Search](https://docs.couchbase.com/server/8.0/vector-search/vector-search.html) requests made to the given Search index. -- @@ -2558,13 +2013,9 @@ The total number of [Vector Search](https://docs.couchbase.com/server/8.0/vector [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_queries* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_queries* + +optional +a¦ [markdown] -- The total number of Search queries per second on the given Search index. -- @@ -2572,13 +2023,9 @@ The total number of Search queries per second on the given Search index. [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_queries_error* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_queries_error* + +optional +a¦ [markdown] -- The total number of Search queries on the given Search index that resulted in an error. @@ -2588,13 +2035,9 @@ This statistic appears on the Server Web Console dashboard as **Search Query Err [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_queries_slow* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_queries_slow* + +optional +a¦ [markdown] -- The total number of Search queries on the given Search index in the slow query log. @@ -2606,13 +2049,9 @@ This statistic appears on the Server Web Console dashboard as **Search Slow Quer [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_queries_timeout* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_queries_timeout* + +optional +a¦ [markdown] -- The total number of Search queries on the given Search index that timed out. @@ -2622,13 +2061,9 @@ This statistic appears on the Server Web Console dashboard as **Search Query Tim [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_request_time* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_request_time* + +optional +a¦ [markdown] -- The total time, in nanoseconds, spent processing Search query requests for the given Search index. -- @@ -2636,13 +2071,9 @@ The total time, in nanoseconds, spent processing Search query requests for the g [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_term_searchers* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_term_searchers* + +optional +a¦ [markdown] -- The total number of term searchers for the given Search index. @@ -2657,13 +2088,9 @@ This statistic appears on the Server Web Console dashboard as **Term Searchers S [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_term_searchers_finished* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_term_searchers_finished* + +optional +a¦ [markdown] -- The total number of term searchers on the given Search index that have finished serving a Search query. -- @@ -2671,13 +2098,9 @@ The total number of term searchers on the given Search index that have finished [%hardbreaks] {blank} a¦ Integer - -a¦ -*BUCKET:INDEX:total_vectors* + -_optional_ -a¦ - -[markdown] +a¦ *BUCKET:INDEX:total_vectors* + +optional +a¦ [markdown] -- The total number of vectors inside the given Search index, across all indexed fields. @@ -2694,26 +2117,26 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/indexStats/definition-end.adoc[opts=optional] - +include::{specDir}definitions/indexStats/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/indexStats/definition-after.adoc[opts=optional] - +ifndef::show-indexStats[] +:leveloffset: -1 +endif::show-indexStats[] +include::{specDir}definitions/indexStats/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] - +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -2723,18 +2146,14 @@ a¦ Integer include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/Admin/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/Admin/security-scheme-before.adoc[opts=optional] - - -[[security-admin]] +[[security-Admin]] = Admin :leveloffset: +1 -// markup not found, no include::{specDir}security/Admin/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Admin/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -2742,29 +2161,22 @@ You must have the **Full Admin**, **Cluster Admin**, or **Bucket Admin** role, w -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/Admin/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Admin/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/Admin/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/Admin/security-scheme-after.adoc[opts=optional] - - - +include::{specDir}security/Statistics/security-scheme-before.adoc[opts=optional] -// markup not found, no include::{specDir}security/Statistics/security-scheme-before.adoc[opts=optional] - - -[[security-statistics]] +[[security-Statistics]] = Statistics :leveloffset: +1 -// markup not found, no include::{specDir}security/Statistics/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Statistics/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -2772,16 +2184,13 @@ You must have the **Search Admin** role, with Stats Read permissions on the requ -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/Statistics/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Statistics/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/Statistics/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/Statistics/security-scheme-after.adoc[opts=optional] @@ -2789,8 +2198,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - -// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] +include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/fts-rest-stats/search-stats.gradle b/docs/modules/fts-rest-stats/search-stats.gradle index b524dc4c..563f7d0d 100644 --- a/docs/modules/fts-rest-stats/search-stats.gradle +++ b/docs/modules/fts-rest-stats/search-stats.gradle @@ -33,6 +33,7 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file diff --git a/docs/modules/index-rest-settings/index-settings.gradle b/docs/modules/index-rest-settings/index-settings.gradle index fd5fec4b..4e2bd8d3 100644 --- a/docs/modules/index-rest-settings/index-settings.gradle +++ b/docs/modules/index-rest-settings/index-settings.gradle @@ -20,4 +20,5 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } \ No newline at end of file diff --git a/docs/modules/index-rest-settings/pages/index.adoc b/docs/modules/index-rest-settings/pages/index.adoc index c204472f..1d182be6 100644 --- a/docs/modules/index-rest-settings/pages/index.adoc +++ b/docs/modules/index-rest-settings/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -36,7 +35,7 @@ Unless otherwise noted, you should only change the Index Service settings when a [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -71,7 +70,6 @@ The host name or IP address of a node running the Index Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -87,31 +85,26 @@ The Index Service REST port. Use `19102` for secure access. |=== - include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] +include::{specDir}overview/document-after.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] - +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 1 - +:count-apis: 0 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -119,62 +112,52 @@ xref:tag-Default[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Default] = Default :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:get_settings[] xref:post_settings[] -//tag::get_settings[] - -// markup not found, no include::{specDir}paths/get_settings/operation-before.adoc[opts=optional] +//tag::get_settings[] +include::{specDir}paths/get_settings/operation-before.adoc[opts=optional] [#get_settings] = Retrieve Index Settings :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-begin.adoc[opts=optional] .... GET /settings .... - -// markup not found, no include::{specDir}paths/get_settings/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-description-before.adoc[opts=optional] [#get_settings-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-description-begin.adoc[opts=optional] [markdown] -- Returns Index Service settings. -- - -// markup not found, no include::{specDir}paths/get_settings/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-description-end.adoc[opts=optional] @@ -182,33 +165,29 @@ Returns Index Service settings. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_settings/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_settings/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_settings/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_settings/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-responses-before.adoc[opts=optional] [#get_settings-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -227,6 +206,7 @@ a| [markdown] Not found. The URL may be specified incorrectly. -- a| + | 401 a| [markdown] -- @@ -236,103 +216,84 @@ a| |=== - -// markup not found, no include::{specDir}paths/get_settings/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Settings: -// markup not found, no include::{specDir}paths/get_settings/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_settings/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-security-before.adoc[opts=optional] [#get_settings-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_settings/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional] include::{snippetDir}get_settings/http-request.adoc[opts=optional] - include::{snippetDir}get_settings/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_settings/operation-end.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_settings/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-after.adoc[opts=optional] //end::get_settings[] - //tag::post_settings[] - -// markup not found, no include::{specDir}paths/post_settings/operation-before.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-before.adoc[opts=optional] [#post_settings] = Update Index Settings :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-begin.adoc[opts=optional] .... POST /settings .... - -// markup not found, no include::{specDir}paths/post_settings/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-description-before.adoc[opts=optional] [#post_settings-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-description-begin.adoc[opts=optional] [markdown] -- Updates Index Service settings. -- - -// markup not found, no include::{specDir}paths/post_settings/operation-description-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-description-end.adoc[opts=optional] [#post_settings-consumes] @@ -340,27 +301,20 @@ Updates Index Service settings. * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/post_settings/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/post_settings/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-parameters-before.adoc[opts=optional] [#post_settings-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-begin.adoc[opts=optional] - - - - - +include::{specDir}paths/post_settings/operation-parameters-begin.adoc[opts=optional] [#post_settings-body] .Body Parameter @@ -371,13 +325,10 @@ Updates Index Service settings. ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -An object specifying Index Service settings. You only need to specify the settings you want to change; settings which are not specified are left unchanged. + -- [%hardbreaks] @@ -388,26 +339,25 @@ a¦ xref:Settings[] |=== -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Settings: -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_settings/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-responses-before.adoc[opts=optional] [#post_settings-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -419,12 +369,14 @@ a| [markdown] Success. Returns `OK` and no object. -- a| + | 401 a| [markdown] -- Unauthorized. Failure to authenticate. -- a| + | 404 a| [markdown] -- @@ -434,117 +386,103 @@ a| |=== - -// markup not found, no include::{specDir}paths/post_settings/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/post_settings/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_settings/operation-security-before.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-security-before.adoc[opts=optional] [#post_settings-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/post_settings/operation-security-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optional] include::{snippetDir}post_settings/http-request.adoc[opts=optional] +include::{snippetDir}post_settings/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}post_settings/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/post_settings/operation-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_settings/operation-after.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-after.adoc[opts=optional] //end::post_settings[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 1 - +:count-models: 0 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:Settings[] endif::[] +include::{specDir}definitions/Settings/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/Settings/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Settings[] [#Settings] +endif::show-Settings[] +ifndef::show-Settings[] +:leveloffset: +1 + +[discrete#Settings] +endif::show-Settings[] = Settings :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Settings/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Settings/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -552,17 +490,13 @@ endif::collapse-models[] //tag::Settings[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*indexer.​plasma.​LSSSegmentFileSize* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​plasma.​LSSSegmentFileSize* + +optional +a¦ [markdown] -- For standard indexes using Plasma, the maximum size for Log Structured Store segment files, in bytes. Index compaction and space reclamation are triggered when the segment file size reaches this value. @@ -580,13 +514,9 @@ For more information, see [Standard Index Storage](/server/8.0/indexes/storage-m *Example:* `67108864` {blank} a¦ Integer (int32) - -a¦ -*indexer.​rebalance.​transferBatchSize* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​rebalance.​transferBatchSize* + +optional +a¦ [markdown] -- Sets the batch size Couchbase Server uses when rebuilding index files during rebalance. This setting has no effect on file-based rebalance. @@ -603,13 +533,9 @@ For an overview of rebalance as it affects the Index Service, including an overv *Example:* `7` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​allow_large_keys* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​allow_large_keys* + +optional +a¦ [markdown] -- Whether the size of index keys is unlimited. @@ -623,13 +549,9 @@ In Couchbase Server 6.5 and later, the Index Service does not need to restart wh *Default:* `true` {blank} a¦ Boolean - -a¦ -*indexer.​settings.​bufferPoolBlockSize* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​bufferPoolBlockSize* + +optional +a¦ [markdown] -- Buffer pool block size. -- @@ -638,13 +560,9 @@ Buffer pool block size. *Default:* `16384` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​build.​batch_size* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​build.​batch_size* + +optional +a¦ [markdown] -- Build batch size. -- @@ -653,13 +571,9 @@ Build batch size. *Default:* `5` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​compaction.​abort_exceed_interval* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​compaction.​abort_exceed_interval* + +optional +a¦ [markdown] -- Whether to abort index compaction if it's still running after the end of the index compaction interval. -- @@ -668,13 +582,9 @@ Whether to abort index compaction if it's still running after the end of the ind *Default:* `false` {blank} a¦ Boolean - -a¦ -*indexer.​settings.​compaction.​check_period* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​compaction.​check_period* + +optional +a¦ [markdown] -- An interval, specifying how frequently the Index Service checks whether the compaction threshold has been reached (seconds). -- @@ -683,13 +593,9 @@ An interval, specifying how frequently the Index Service checks whether the comp *Default:* `30` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​compaction.​compaction_mode* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​compaction.​compaction_mode* + +optional +a¦ [markdown] -- The compaction mode for indexes. -- @@ -699,13 +605,9 @@ The compaction mode for indexes. *Default:* `+++"circular"+++` {blank} a¦ String - -a¦ -*indexer.​settings.​compaction.​days_of_week* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​compaction.​days_of_week* + +optional +a¦ [markdown] -- The days of the week on which circular compaction is to run, if specified. Individual values must be day-names, each specified with an initial capital, and otherwise lower-case. @@ -717,13 +619,9 @@ Multiple values must be separated by a single comma, with no spaces. *Example:* `+++"Saturday,Sunday"+++` {blank} a¦ String - -a¦ -*indexer.​settings.​compaction.​interval* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​compaction.​interval* + +optional +a¦ [markdown] -- A string in the form `fromHour:fromMinute,toHour:toMinute`, specifying the interval during which index compaction can run. @@ -744,13 +642,9 @@ The default value means any time. *Example:* `+++"01:00,05:59"+++` {blank} a¦ String - -a¦ -*indexer.​settings.​compaction.​min_frag* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​compaction.​min_frag* + +optional +a¦ [markdown] -- The minimum fragmentation threshold to trigger compaction (percentage). -- @@ -760,13 +654,9 @@ The minimum fragmentation threshold to trigger compaction (percentage). *Minimum:* `5` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​compaction.​min_size* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​compaction.​min_size* + +optional +a¦ [markdown] -- Compaction minimum file size. -- @@ -775,13 +665,9 @@ Compaction minimum file size. *Default:* `524288000` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​compaction.​plasma.​manual* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​compaction.​plasma.​manual* + +optional +a¦ [markdown] -- For standard indexes using Plasma, whether compaction should be triggered manually. -- @@ -790,13 +676,9 @@ For standard indexes using Plasma, whether compaction should be triggered manual *Default:* `false` {blank} a¦ Boolean - -a¦ -*indexer.​settings.​compaction.​plasma.​optional.​decrement* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​compaction.​plasma.​optional.​decrement* + +optional +a¦ [markdown] -- For standard indexes using Plasma, the optional decrement. -- @@ -805,13 +687,9 @@ For standard indexes using Plasma, the optional decrement. *Default:* `5` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​compaction.​plasma.​optional.​min_frag* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​compaction.​plasma.​optional.​min_frag* + +optional +a¦ [markdown] -- For standard indexes using Plasma, the minimum fragmentation threshold to trigger compaction (percentage). -- @@ -820,13 +698,9 @@ For standard indexes using Plasma, the minimum fragmentation threshold to trigge *Default:* `20` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​compaction.​plasma.​optional.​quota* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​compaction.​plasma.​optional.​quota* + +optional +a¦ [markdown] -- For standard indexes using Plasma, the optional quota. -- @@ -835,13 +709,9 @@ For standard indexes using Plasma, the optional quota. *Default:* `25` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​corrupt_index_num_backups* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​corrupt_index_num_backups* + +optional +a¦ [markdown] -- Corrupt index number of backups. -- @@ -850,13 +720,9 @@ Corrupt index number of backups. *Default:* `1` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​cpuProfDir* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​cpuProfDir* + +optional +a¦ [markdown] -- The name of the directory where local CPU usage profiling information is captured. -- @@ -864,13 +730,9 @@ The name of the directory where local CPU usage profiling information is capture [%hardbreaks] {blank} a¦ String - -a¦ -*indexer.​settings.​cpuProfile* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​cpuProfile* + +optional +a¦ [markdown] -- Whether the Index Service should capture local CPU usage profiling information. -- @@ -879,13 +741,9 @@ Whether the Index Service should capture local CPU usage profiling information. *Default:* `false` {blank} a¦ Boolean - -a¦ -*indexer.​settings.​defer_build* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​defer_build* + +optional +a¦ [markdown] -- The default setting for the `defer_build` option for index creation. @@ -899,13 +757,9 @@ You can override this setting by specifying the `defer_build` option when you cr *Default:* `false` {blank} a¦ Boolean - -a¦ -*indexer.​settings.​eTagPeriod* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​eTagPeriod* + +optional +a¦ [markdown] -- The ETag (entity tag) period. -- @@ -914,13 +768,9 @@ The ETag (entity tag) period. *Default:* `240` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​enable_corrupt_index_backup* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​enable_corrupt_index_backup* + +optional +a¦ [markdown] -- Whether corrupt index backup is enabled. -- @@ -929,13 +779,9 @@ Whether corrupt index backup is enabled. *Default:* `false` {blank} a¦ Boolean - -a¦ -*indexer.​settings.​enable_page_bloom_filter* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​enable_page_bloom_filter* + +optional +a¦ [markdown] -- Whether Bloom filters are enabled for memory management. @@ -946,13 +792,9 @@ For more information, see [Per Page Bloom Filters](/server/8.0/indexes/storage-m *Default:* `true` {blank} a¦ Boolean - -a¦ -*indexer.​settings.​enable_shard_affinity* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​enable_shard_affinity* + +optional +a¦ [markdown] -- Selects the index rebalance method. See [Index Rebalance Methods](/server/8.0/learn/clusters-and-availability/rebalance.html#index-rebalance-methods). @@ -969,13 +811,9 @@ However, when you alter an index, you cannot use the `WITH` clause to specify wh *Default:* `false` {blank} a¦ Boolean - -a¦ -*indexer.​settings.​fast_flush_mode* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​fast_flush_mode* + +optional +a¦ [markdown] -- Whether fast flush mode is enabled. -- @@ -984,13 +822,9 @@ Whether fast flush mode is enabled. *Default:* `true` {blank} a¦ Boolean - -a¦ -*indexer.​settings.​gc_percent* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​gc_percent* + +optional +a¦ [markdown] -- Garbage collection percentage. -- @@ -999,13 +833,9 @@ Garbage collection percentage. *Default:* `100` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​inmemory_snapshot.​fdb.​interval* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​inmemory_snapshot.​fdb.​interval* + +optional +a¦ [markdown] -- For standard indexes using Forestdb, the in-memory snapshot interval (ms). This determines the earliest possibility of a scan seeing a given KV mutation. @@ -1016,13 +846,9 @@ This determines the earliest possibility of a scan seeing a given KV mutation. *Minimum:* `1` (exclusive) {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​inmemory_snapshot.​interval* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​inmemory_snapshot.​interval* + +optional +a¦ [markdown] -- The in-memory snapshot interval (ms). This determines the earliest possibility of a scan seeing a given KV mutation. @@ -1033,13 +859,9 @@ This determines the earliest possibility of a scan seeing a given KV mutation. *Minimum:* `1` (exclusive) {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​inmemory_snapshot.​moi.​interval* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​inmemory_snapshot.​moi.​interval* + +optional +a¦ [markdown] -- For memory-optimized indexes, the in-memory snapshot interval (ms). This determines the earliest possibility of a scan seeing a given KV mutation. @@ -1050,13 +872,9 @@ This determines the earliest possibility of a scan seeing a given KV mutation. *Minimum:* `1` (exclusive) {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​largeSnapshotThreshold* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​largeSnapshotThreshold* + +optional +a¦ [markdown] -- The large snapshot threshold. -- @@ -1065,13 +883,9 @@ The large snapshot threshold. *Default:* `200` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​log_level* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​log_level* + +optional +a¦ [markdown] -- Indexer logging level. -- @@ -1081,13 +895,9 @@ Indexer logging level. *Default:* `+++"info"+++` {blank} a¦ String - -a¦ -*indexer.​settings.​maxNumPartitions* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​maxNumPartitions* + +optional +a¦ [markdown] -- Maximum number of partitions. -- @@ -1096,13 +906,9 @@ Maximum number of partitions. *Default:* `64` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​maxVbQueueLength* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​maxVbQueueLength* + +optional +a¦ [markdown] -- Maximum vBucket queue length. -- @@ -1111,13 +917,9 @@ Maximum vBucket queue length. *Default:* `0` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​max_array_seckey_size* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​max_array_seckey_size* + +optional +a¦ [markdown] -- If `indexer.settings.allow_large_keys` is false, this setting specifies the maximum size for array index keys. @@ -1128,13 +930,9 @@ In Couchbase Server 6.5 and later, the Index Service does not need to restart wh *Default:* `10240` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​max_cpu_percent* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​max_cpu_percent* + +optional +a¦ [markdown] -- The CPU capacity that the Index Service should use (percentage). If set to `0`, the indexer will use all CPUs. @@ -1144,13 +942,9 @@ If set to `0`, the indexer will use all CPUs. *Default:* `0` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​max_seckey_size* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​max_seckey_size* + +optional +a¦ [markdown] -- If `indexer.settings.allow_large_keys` is false, this setting specifies the maximum size for index keys. @@ -1161,13 +955,9 @@ In Couchbase Server 6.5 and later, the Index Service does not need to restart wh *Default:* `4608` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​max_writer_lock_prob* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​max_writer_lock_prob* + +optional +a¦ [markdown] -- Maximum writer lock prob. -- @@ -1176,13 +966,9 @@ Maximum writer lock prob. *Default:* `20` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​memProfDir* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​memProfDir* + +optional +a¦ [markdown] -- The name of the directory where local memory usage profiling information is captured. -- @@ -1190,13 +976,9 @@ The name of the directory where local memory usage profiling information is capt [%hardbreaks] {blank} a¦ String - -a¦ -*indexer.​settings.​memProfile* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​memProfile* + +optional +a¦ [markdown] -- Whether the Index Service should capture local memory usage profiling information. -- @@ -1205,13 +987,9 @@ Whether the Index Service should capture local memory usage profiling informatio *Default:* `false` {blank} a¦ Boolean - -a¦ -*indexer.​settings.​memory_quota* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​memory_quota* + +optional +a¦ [markdown] -- How much RAM is allocated to the Index Service for the current node. -- @@ -1220,13 +998,9 @@ How much RAM is allocated to the Index Service for the current node. *Default:* `536870912` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​minVbQueueLength* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​minVbQueueLength* + +optional +a¦ [markdown] -- Minimum vBucket queue length. -- @@ -1235,13 +1009,9 @@ Minimum vBucket queue length. *Default:* `30` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​moi.​debug* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​moi.​debug* + +optional +a¦ [markdown] -- Debug memory-optimized index storage. -- @@ -1250,13 +1020,9 @@ Debug memory-optimized index storage. *Default:* `false` {blank} a¦ Boolean - -a¦ -*indexer.​settings.​moi.​persistence_threads* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​moi.​persistence_threads* + +optional +a¦ [markdown] -- For memory-optimized index storage, the number of persistence threads. -- @@ -1265,13 +1031,9 @@ For memory-optimized index storage, the number of persistence threads. *Default:* `4` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​moi.​recovery.​max_rollbacks* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​moi.​recovery.​max_rollbacks* + +optional +a¦ [markdown] -- For memory-optimized index storage, the maximum number of committed rollback points. -- @@ -1280,13 +1042,9 @@ For memory-optimized index storage, the maximum number of committed rollback poi *Default:* `2` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​moi.​recovery_threads* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​moi.​recovery_threads* + +optional +a¦ [markdown] -- For memory-optimized index storage, the number of recovery threads. -- @@ -1295,13 +1053,9 @@ For memory-optimized index storage, the number of recovery threads. *Default:* `8` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​num_replica* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​num_replica* + +optional +a¦ [markdown] -- The default number of index replicas to be created by the Index Service whenever `CREATE INDEX` is invoked. -- @@ -1311,13 +1065,9 @@ The default number of index replicas to be created by the Index Service whenever *Example:* `2` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​percentage_memory_quota* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​percentage_memory_quota* + +optional +a¦ [markdown] -- Percentage memory quota. -- @@ -1326,13 +1076,9 @@ Percentage memory quota. *Default:* `0` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​persisted_snapshot.​fdb.​interval* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​persisted_snapshot.​fdb.​interval* + +optional +a¦ [markdown] -- For standard indexes using Forestdb, the persisted snapshot interval (ms). This must be a multiple of the in-memory snapshot interval. @@ -1343,13 +1089,9 @@ This must be a multiple of the in-memory snapshot interval. *Minimum:* `100` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​persisted_snapshot.interval* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​persisted_snapshot.interval* + +optional +a¦ [markdown] -- The persisted snapshot interval (ms). This must be a multiple of the in-memory snapshot interval. @@ -1360,13 +1102,9 @@ This must be a multiple of the in-memory snapshot interval. *Minimum:* `100` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​persisted_snapshot.​moi.​interval* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​persisted_snapshot.​moi.​interval* + +optional +a¦ [markdown] -- For memory-optimized indexes, the persisted snapshot interval (ms). This must be a multiple of the in-memory snapshot interval. @@ -1377,13 +1115,9 @@ This must be a multiple of the in-memory snapshot interval. *Minimum:* `100` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​persisted_snapshot_init_build.​fdb.​interval* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​persisted_snapshot_init_build.​fdb.​interval* + +optional +a¦ [markdown] -- For standard indexes using Forestdb, the persisted snapshot interval for the initial build (ms). -- @@ -1392,13 +1126,9 @@ For standard indexes using Forestdb, the persisted snapshot interval for the ini *Default:* `5000` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​persisted_snapshot_init_build.​interval* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​persisted_snapshot_init_build.​interval* + +optional +a¦ [markdown] -- The persisted snapshot interval for the initial build (ms). -- @@ -1407,13 +1137,9 @@ The persisted snapshot interval for the initial build (ms). *Default:* `5000` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​persisted_snapshot_init_build.​moi.​interval* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​persisted_snapshot_init_build.​moi.​interval* + +optional +a¦ [markdown] -- For memory-optimized indexes, the persisted snapshot interval for the initial build (ms). -- @@ -1422,13 +1148,9 @@ For memory-optimized indexes, the persisted snapshot interval for the initial bu *Default:* `600000` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​plasma.​recovery.​max_rollbacks* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​plasma.​recovery.​max_rollbacks* + +optional +a¦ [markdown] -- For standard indexes using Plasma, the maximum number of committed rollback points. -- @@ -1437,13 +1159,9 @@ For standard indexes using Plasma, the maximum number of committed rollback poin *Default:* `2` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​rebalance.​blob_storage_bucket* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​rebalance.​blob_storage_bucket* + +optional +a¦ [markdown] -- Rebalance blob storage bucket. -- @@ -1452,13 +1170,9 @@ Rebalance blob storage bucket. *Default:* `+++""+++` {blank} a¦ String - -a¦ -*indexer.​settings.​rebalance.​blob_storage_prefix* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​rebalance.​blob_storage_prefix* + +optional +a¦ [markdown] -- Rebalance blob storage prefix. -- @@ -1467,13 +1181,9 @@ Rebalance blob storage prefix. *Default:* `+++""+++` {blank} a¦ String - -a¦ -*indexer.​settings.​rebalance.​blob_storage_region* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​rebalance.​blob_storage_region* + +optional +a¦ [markdown] -- Rebalance blob storage region. -- @@ -1482,13 +1192,9 @@ Rebalance blob storage region. *Default:* `+++""+++` {blank} a¦ String - -a¦ -*indexer.​settings.​rebalance.​blob_storage_scheme* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​rebalance.​blob_storage_scheme* + +optional +a¦ [markdown] -- Rebalance blob storage scheme. -- @@ -1497,13 +1203,9 @@ Rebalance blob storage scheme. *Default:* `+++""+++` {blank} a¦ String - -a¦ -*indexer.​settings.​rebalance.​redistribute_indexes* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​rebalance.​redistribute_indexes* + +optional +a¦ [markdown] -- Whether to redistribute indexes on rebalance. @@ -1518,13 +1220,9 @@ For more information, see [Rebalance](/server/8.0/learn/clusters-and-availabilit *Default:* `false` {blank} a¦ Boolean - -a¦ -*indexer.​settings.​recovery.​max_rollbacks* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​recovery.​max_rollbacks* + +optional +a¦ [markdown] -- The maximum number of committed rollback points. -- @@ -1533,13 +1231,9 @@ The maximum number of committed rollback points. *Default:* `2` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​scan_getseqnos_retries* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​scan_getseqnos_retries* + +optional +a¦ [markdown] -- Scan get sequence numbers retries. -- @@ -1548,13 +1242,9 @@ Scan get sequence numbers retries. *Default:* `30` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​scan_timeout* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​scan_timeout* + +optional +a¦ [markdown] -- The default timeout for the indexer, in milliseconds. This is distinct from the Query Service timeout. @@ -1567,13 +1257,9 @@ An index scan may time out if the Index Service timeout is lower than the Query *Default:* `120000` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​send_buffer_size* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​send_buffer_size* + +optional +a¦ [markdown] -- Send buffer size. -- @@ -1582,13 +1268,9 @@ Send buffer size. *Default:* `1024` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​serverless.​indexLimit* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​serverless.​indexLimit* + +optional +a¦ [markdown] -- Serverless index limit. -- @@ -1597,13 +1279,9 @@ Serverless index limit. *Default:* `201` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​sliceBufSize* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​sliceBufSize* + +optional +a¦ [markdown] -- Slice buffer size. -- @@ -1612,13 +1290,9 @@ Slice buffer size. *Default:* `1600` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​smallSnapshotThreshold* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​smallSnapshotThreshold* + +optional +a¦ [markdown] -- Small snapshot threshold. -- @@ -1627,13 +1301,9 @@ Small snapshot threshold. *Default:* `30` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​snapshotListeners* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​snapshotListeners* + +optional +a¦ [markdown] -- Snapshot listeners. -- @@ -1642,13 +1312,9 @@ Snapshot listeners. *Default:* `4` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​snapshotRequestWorkers* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​snapshotRequestWorkers* + +optional +a¦ [markdown] -- Snapshot request workers. -- @@ -1657,13 +1323,9 @@ Snapshot request workers. *Default:* `4` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​statsLogDumpInterval* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​statsLogDumpInterval* + +optional +a¦ [markdown] -- Statistics log dump interval. -- @@ -1672,13 +1334,9 @@ Statistics log dump interval. *Default:* `60` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​storage_mode* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​storage_mode* + +optional +a¦ [markdown] -- The storage mode to be used for the Index Service on this node. @@ -1704,13 +1362,9 @@ If you're using Couchbase Server Community Edition, the default (and only) value *Values:* `"plasma"`, `"memory_optimized"`, `"forestdb"` {blank} a¦ String - -a¦ -*indexer.​settings.​storage_mode.​disable_upgrade* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​storage_mode.​disable_upgrade* + +optional +a¦ [markdown] -- Whether upgrade of the index storage mode is disabled. -- @@ -1719,13 +1373,9 @@ Whether upgrade of the index storage mode is disabled. *Default:* `false` {blank} a¦ Boolean - -a¦ -*indexer.​settings.​thresholds.​mem_high* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​thresholds.​mem_high* + +optional +a¦ [markdown] -- High memory threshold. -- @@ -1734,13 +1384,9 @@ High memory threshold. *Default:* `70` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​thresholds.​mem_low* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​thresholds.​mem_low* + +optional +a¦ [markdown] -- Low memory threshold. -- @@ -1749,13 +1395,9 @@ Low memory threshold. *Default:* `50` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​thresholds.​units_high* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​thresholds.​units_high* + +optional +a¦ [markdown] -- High units threshold. -- @@ -1764,13 +1406,9 @@ High units threshold. *Default:* `60` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​thresholds.​units_low* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​thresholds.​units_low* + +optional +a¦ [markdown] -- Low units threshold. -- @@ -1779,13 +1417,9 @@ Low units threshold. *Default:* `40` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​units_quota* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​units_quota* + +optional +a¦ [markdown] -- Units quota. -- @@ -1794,13 +1428,9 @@ Units quota. *Default:* `10000` {blank} a¦ Integer (int32) - -a¦ -*indexer.​settings.​wal_size* + -_optional_ -a¦ - -[markdown] +a¦ *indexer.​settings.​wal_size* + +optional +a¦ [markdown] -- Write-ahead log size. -- @@ -1809,13 +1439,9 @@ Write-ahead log size. *Default:* `4096` {blank} a¦ Integer (int32) - -a¦ -*projector.​settings.​log_level* + -_optional_ -a¦ - -[markdown] +a¦ *projector.​settings.​log_level* + +optional +a¦ [markdown] -- Projector logging level. -- @@ -1824,13 +1450,9 @@ Projector logging level. *Default:* `+++"info"+++` {blank} a¦ String - -a¦ -*queryport.​client.​settings.​backfillLimit* + -_optional_ -a¦ - -[markdown] +a¦ *queryport.​client.​settings.​backfillLimit* + +optional +a¦ [markdown] -- The maximum size of the backfill file (MB). @@ -1844,13 +1466,9 @@ The maximum size is limited only by the available disk space. *Default:* `5120` {blank} a¦ Integer (int32) - -a¦ -*queryport.​client.​settings.​closeActiveConnections* + -_optional_ -a¦ - -[markdown] +a¦ *queryport.​client.​settings.​closeActiveConnections* + +optional +a¦ [markdown] -- Whether to close active connections. -- @@ -1859,13 +1477,9 @@ Whether to close active connections. *Default:* `true` {blank} a¦ Boolean - -a¦ -*queryport.​client.​settings.​minPoolSizeWM* + -_optional_ -a¦ - -[markdown] +a¦ *queryport.​client.​settings.​minPoolSizeWM* + +optional +a¦ [markdown] -- Minimum pool size. -- @@ -1874,13 +1488,9 @@ Minimum pool size. *Default:* `1000` {blank} a¦ Integer (int32) - -a¦ -*queryport.​client.​settings.​poolOverflow* + -_optional_ -a¦ - -[markdown] +a¦ *queryport.​client.​settings.​poolOverflow* + +optional +a¦ [markdown] -- Maximum number of connections in a pool. -- @@ -1889,13 +1499,9 @@ Maximum number of connections in a pool. *Default:* `30` {blank} a¦ Integer (int32) - -a¦ -*queryport.​client.​settings.​poolSize* + -_optional_ -a¦ - -[markdown] +a¦ *queryport.​client.​settings.​poolSize* + +optional +a¦ [markdown] -- Number of simultaneous active connections in a pool. -- @@ -1904,13 +1510,9 @@ Number of simultaneous active connections in a pool. *Default:* `5000` {blank} a¦ Integer (int32) - -a¦ -*queryport.​client.​settings.​relConnBatchSize* + -_optional_ -a¦ - -[markdown] +a¦ *queryport.​client.​settings.​relConnBatchSize* + +optional +a¦ [markdown] -- Connection batch size. -- @@ -1926,26 +1528,26 @@ a¦ Integer (int32) -// markup not found, no include::{specDir}definitions/Settings/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Settings/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Settings/definition-after.adoc[opts=optional] - +ifndef::show-Settings[] +:leveloffset: -1 +endif::show-Settings[] +include::{specDir}definitions/Settings/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] - +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -1955,18 +1557,14 @@ a¦ Integer (int32) include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/Default/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/Default/security-scheme-before.adoc[opts=optional] - - -[[security-default]] +[[security-Default]] = Default :leveloffset: +1 -// markup not found, no include::{specDir}security/Default/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Default/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -1974,16 +1572,13 @@ Users must have the Full Admin or Cluster Admin role, with Cluster Read and Buck -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/Default/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Default/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/Default/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/Default/security-scheme-after.adoc[opts=optional] @@ -1991,8 +1586,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - -// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] +include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/index-rest-stats/attachments/indexes.yaml b/docs/modules/index-rest-stats/attachments/indexes.yaml index db9de519..888dde10 100644 --- a/docs/modules/index-rest-stats/attachments/indexes.yaml +++ b/docs/modules/index-rest-stats/attachments/indexes.yaml @@ -399,12 +399,14 @@ components: securitySchemes: NodeStatistics: + x-displayName: Node Statistics type: http scheme: basic description: | To get [Node statistics](#NodeIdxNodeIndexer), users must have the Query System Catalog RBAC role. IndexStatistics: + x-displayName: Index Statistics type: http scheme: basic description: | diff --git a/docs/modules/index-rest-stats/indexes.gradle b/docs/modules/index-rest-stats/indexes.gradle index bff74967..8ec75a03 100644 --- a/docs/modules/index-rest-stats/indexes.gradle +++ b/docs/modules/index-rest-stats/indexes.gradle @@ -20,4 +20,5 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } \ No newline at end of file diff --git a/docs/modules/index-rest-stats/pages/index.adoc b/docs/modules/index-rest-stats/pages/index.adoc index a2037b78..675ce490 100644 --- a/docs/modules/index-rest-stats/pages/index.adoc +++ b/docs/modules/index-rest-stats/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -32,7 +31,7 @@ This API enables you to get Index service statistics. [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -67,7 +66,6 @@ The host name or IP address of a node running the Index Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -83,31 +81,26 @@ The Index Service REST port. Use `19102` for secure access. |=== - -// markup not found, no include::{specDir}overview/document-end.adoc[opts=optional] +include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}overview/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 1 - +:count-apis: 0 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -115,18 +108,14 @@ xref:tag-Default[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Default] = Default :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:get_index_stats[] @@ -134,44 +123,38 @@ xref:get_keyspace_stats[] xref:get_node_stats[] -//tag::get_index_stats[] - -// markup not found, no include::{specDir}paths/get_index_stats/operation-before.adoc[opts=optional] +//tag::get_index_stats[] +include::{specDir}paths/get_index_stats/operation-before.adoc[opts=optional] [#get_index_stats] = Get Statistics for an Index :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_index_stats/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_index_stats/operation-begin.adoc[opts=optional] .... GET /api/v1/stats/{keyspace}/{index} .... - -// markup not found, no include::{specDir}paths/get_index_stats/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_index_stats/operation-description-before.adoc[opts=optional] [#get_index_stats-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_index_stats/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_index_stats/operation-description-begin.adoc[opts=optional] [markdown] -- Returns statistics for an index. -- - -// markup not found, no include::{specDir}paths/get_index_stats/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_index_stats/operation-description-end.adoc[opts=optional] @@ -179,23 +162,20 @@ Returns statistics for an index. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_index_stats/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_index_stats/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_index_stats/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_index_stats/operation-parameters-before.adoc[opts=optional] [#get_index_stats-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_index_stats/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/get_index_stats/operation-parameters-begin.adoc[opts=optional] [#get_index_stats-path] .Path Parameters @@ -206,11 +186,8 @@ Returns statistics for an index. ¦ Name ¦ Description ¦ Schema a¦ *keyspace* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a keyspace. This must contain a bucket name, which may be followed by an optional scope name and an optional collection name, separated by dots. @@ -226,13 +203,9 @@ For example, `` `bucket.1`.scope.collection ``. {blank} a¦ String - a¦ *index* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of an index. -- @@ -243,7 +216,6 @@ The name of an index. a¦ String |=== - [#get_index_stats-query] .Query Parameters {blank} @@ -253,11 +225,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *pretty* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- Whether the output should be formatted with indentations and newlines. -- @@ -267,13 +236,9 @@ Whether the output should be formatted with indentations and newlines. {blank} a¦ Boolean - a¦ *partition* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- Whether statistics for index partitions should be included. -- @@ -283,13 +248,9 @@ Whether statistics for index partitions should be included. {blank} a¦ Boolean - a¦ *redact* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- Whether keyspace and index names should be redacted in the output. @@ -300,13 +261,9 @@ Whether keyspace and index names should be redacted in the output. {blank} a¦ Boolean - a¦ *skipEmpty* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- Whether empty, null, or zero statistics should be omitted from the output. -- @@ -320,29 +277,24 @@ a¦ Boolean |=== - - - include::{specDir}paths/get_index_stats/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_index_stats/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_index_stats/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_index_stats/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/get_index_stats/operation-responses-before.adoc[opts=optional] [#get_index_stats-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_index_stats/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_index_stats/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -364,103 +316,84 @@ a| |=== - -// markup not found, no include::{specDir}paths/get_index_stats/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_index_stats/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-PartIdx: -// markup not found, no include::{specDir}paths/get_index_stats/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_index_stats/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_index_stats/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_index_stats/operation-security-before.adoc[opts=optional] [#get_index_stats-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_index_stats/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_index_stats/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-indexStatistics[] +| xref:security-IndexStatistics[] |=== - -// markup not found, no include::{specDir}paths/get_index_stats/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_index_stats/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_index_stats/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_index_stats/operation-security-after.adoc[opts=optional] include::{snippetDir}get_index_stats/http-request.adoc[opts=optional] - include::{snippetDir}get_index_stats/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_index_stats/operation-end.adoc[opts=optional] +include::{specDir}paths/get_index_stats/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_index_stats/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_index_stats/operation-after.adoc[opts=optional] //end::get_index_stats[] - //tag::get_keyspace_stats[] - -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_keyspace_stats/operation-before.adoc[opts=optional] [#get_keyspace_stats] = Get Statistics for Indexes in a Keyspace :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_keyspace_stats/operation-begin.adoc[opts=optional] .... GET /api/v1/stats/{keyspace} .... - -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_keyspace_stats/operation-description-before.adoc[opts=optional] [#get_keyspace_stats-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_keyspace_stats/operation-description-begin.adoc[opts=optional] [markdown] -- Returns statistics for all indexes within a bucket, scope, or collection. -- - -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_keyspace_stats/operation-description-end.adoc[opts=optional] @@ -468,23 +401,20 @@ Returns statistics for all indexes within a bucket, scope, or collection. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_keyspace_stats/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_keyspace_stats/operation-parameters-before.adoc[opts=optional] [#get_keyspace_stats-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/get_keyspace_stats/operation-parameters-begin.adoc[opts=optional] [#get_keyspace_stats-path] .Path Parameters @@ -495,11 +425,8 @@ Returns statistics for all indexes within a bucket, scope, or collection. ¦ Name ¦ Description ¦ Schema a¦ *keyspace* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a keyspace. This must contain a bucket name, which may be followed by an optional scope name and an optional collection name, separated by dots. @@ -517,7 +444,6 @@ For example, `` `bucket.1`.scope.collection ``. a¦ String |=== - [#get_keyspace_stats-query] .Query Parameters {blank} @@ -527,11 +453,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *pretty* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- Whether the output should be formatted with indentations and newlines. -- @@ -541,13 +464,9 @@ Whether the output should be formatted with indentations and newlines. {blank} a¦ Boolean - a¦ *redact* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- Whether keyspace and index names should be redacted in the output. @@ -558,13 +477,9 @@ Whether keyspace and index names should be redacted in the output. {blank} a¦ Boolean - a¦ *skipEmpty* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- Whether empty, null, or zero statistics should be omitted from the output. -- @@ -578,29 +493,24 @@ a¦ Boolean |=== - - - include::{specDir}paths/get_keyspace_stats/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_keyspace_stats/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/get_keyspace_stats/operation-responses-before.adoc[opts=optional] [#get_keyspace_stats-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_keyspace_stats/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -622,103 +532,84 @@ a| |=== - -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_keyspace_stats/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-PartIdxIndexes: -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_keyspace_stats/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_keyspace_stats/operation-security-before.adoc[opts=optional] [#get_keyspace_stats-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_keyspace_stats/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-indexStatistics[] +| xref:security-IndexStatistics[] |=== - -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_keyspace_stats/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_keyspace_stats/operation-security-after.adoc[opts=optional] include::{snippetDir}get_keyspace_stats/http-request.adoc[opts=optional] - include::{snippetDir}get_keyspace_stats/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-end.adoc[opts=optional] +include::{specDir}paths/get_keyspace_stats/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_keyspace_stats/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_keyspace_stats/operation-after.adoc[opts=optional] //end::get_keyspace_stats[] - //tag::get_node_stats[] - -// markup not found, no include::{specDir}paths/get_node_stats/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_node_stats/operation-before.adoc[opts=optional] [#get_node_stats] = Get Statistics for an Index Node :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_node_stats/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_node_stats/operation-begin.adoc[opts=optional] .... GET /api/v1/stats .... - -// markup not found, no include::{specDir}paths/get_node_stats/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_node_stats/operation-description-before.adoc[opts=optional] [#get_node_stats-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_node_stats/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_node_stats/operation-description-begin.adoc[opts=optional] [markdown] -- Returns statistics for an index node, and for all indexes on that node. -- - -// markup not found, no include::{specDir}paths/get_node_stats/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_node_stats/operation-description-end.adoc[opts=optional] @@ -726,24 +617,20 @@ Returns statistics for an index node, and for all indexes on that node. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_node_stats/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_node_stats/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_node_stats/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_node_stats/operation-parameters-before.adoc[opts=optional] [#get_node_stats-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_node_stats/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/get_node_stats/operation-parameters-begin.adoc[opts=optional] [#get_node_stats-query] .Query Parameters @@ -754,11 +641,8 @@ Returns statistics for an index node, and for all indexes on that node. ¦ Name ¦ Description ¦ Schema a¦ *pretty* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- Whether the output should be formatted with indentations and newlines. -- @@ -768,13 +652,9 @@ Whether the output should be formatted with indentations and newlines. {blank} a¦ Boolean - a¦ *redact* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- Whether keyspace and index names should be redacted in the output. @@ -785,13 +665,9 @@ Whether keyspace and index names should be redacted in the output. {blank} a¦ Boolean - a¦ *skipEmpty* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- Whether empty, null, or zero statistics should be omitted from the output. -- @@ -805,29 +681,24 @@ a¦ Boolean |=== - - - -// markup not found, no include::{specDir}paths/get_node_stats/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/get_node_stats/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_node_stats/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/get_node_stats/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_node_stats/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_node_stats/operation-responses-before.adoc[opts=optional] [#get_node_stats-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_node_stats/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_node_stats/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -840,104 +711,91 @@ Success. Returns an object containing a nested `indexer` object, and usually one -- a| xref:NodeIdx[] - |=== - -// markup not found, no include::{specDir}paths/get_node_stats/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_node_stats/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-NodeIdx: -// markup not found, no include::{specDir}paths/get_node_stats/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_node_stats/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_node_stats/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_node_stats/operation-security-before.adoc[opts=optional] [#get_node_stats-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_node_stats/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_node_stats/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-indexStatistics[] -| http (basic) -| xref:security-nodeStatistics[] - -|=== +| xref:security-IndexStatistics[] -// markup not found, no include::{specDir}paths/get_node_stats/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-NodeStatistics[] +|=== -// markup not found, no include::{specDir}paths/get_node_stats/operation-security-after.adoc[opts=optional] +include::{specDir}paths/get_node_stats/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_node_stats/operation-security-after.adoc[opts=optional] include::{snippetDir}get_node_stats/http-request.adoc[opts=optional] - include::{snippetDir}get_node_stats/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_node_stats/operation-end.adoc[opts=optional] +include::{specDir}paths/get_node_stats/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_node_stats/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_node_stats/operation-after.adoc[opts=optional] //end::get_node_stats[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] +include::{specDir}paths/document-after.adoc[opts=optional] - -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] - +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 7 - +:count-models: 6 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:NodeIdx[] xref:NodeIdxNode[] @@ -949,35 +807,32 @@ xref:PartIdxPartitionsIndex[] endif::[] +include::{specDir}definitions/NodeIdx/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/NodeIdx/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-NodeIdx[] [#NodeIdx] +endif::show-NodeIdx[] +ifndef::show-NodeIdx[] +:leveloffset: +1 + +[discrete#NodeIdx] +endif::show-NodeIdx[] = Node and Indexes :leveloffset: +1 -// markup not found, no include::{specDir}definitions/NodeIdx/definition-begin.adoc[opts=optional] - +include::{specDir}definitions/NodeIdx/definition-begin.adoc[opts=optional] .icon:bars[fw] Composite Schema {blank} //tag::NodeIdx[] - - [cols="25,55,20",separator=¦] |=== ¦ All{nbsp}of{nbsp}... ¦ ¦ Schema a¦ -a¦ - -[markdown] +a¦ [markdown] -- include::index.adoc[tag=desc-NodeIdxNode, opts=optional] -- @@ -986,10 +841,8 @@ include::index.adoc[tag=desc-NodeIdxNode, opts=optional] {blank} a¦ xref:NodeIdxNode[] -a¦ _and_ -a¦ - -[markdown] +a¦ and +a¦ [markdown] -- include::index.adoc[tag=desc-PartIdxIndexes, opts=optional] -- @@ -997,34 +850,41 @@ include::index.adoc[tag=desc-PartIdxIndexes, opts=optional] [%hardbreaks] {blank} a¦ xref:PartIdxIndexes[] - |=== //end::NodeIdx[] - -// markup not found, no include::{specDir}definitions/NodeIdx/definition-end.adoc[opts=optional] - +include::{specDir}definitions/NodeIdx/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/NodeIdx/definition-after.adoc[opts=optional] - - - +ifndef::show-NodeIdx[] +:leveloffset: -1 +endif::show-NodeIdx[] -// markup not found, no include::{specDir}definitions/NodeIdxNode/definition-before.adoc[opts=optional] +include::{specDir}definitions/NodeIdx/definition-after.adoc[opts=optional] +include::{specDir}definitions/NodeIdxNode/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-NodeIdxNode[] [#NodeIdxNode] +endif::show-NodeIdxNode[] +ifndef::show-NodeIdxNode[] +:leveloffset: +1 + +[discrete#NodeIdxNode] +endif::show-NodeIdxNode[] = Nodes +ifdef::model-descriptions[] +//tag::desc-NodeIdxNode[] +Node statistics. +//end::desc-NodeIdxNode[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/NodeIdxNode/definition-begin.adoc[opts=optional] +include::{specDir}definitions/NodeIdxNode/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1032,22 +892,13 @@ endif::collapse-models[] //tag::NodeIdxNode[] -ifdef::model-descriptions[] -//tag::desc-NodeIdxNode[] -Node statistics. -//end::desc-NodeIdxNode[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*indexer* + -_required_ -a¦ - -[markdown] +a¦ *indexer* + +required +a¦ [markdown] -- include::index.adoc[tag=desc-NodeIdxNodeIndexer, opts=optional] -- @@ -1062,28 +913,37 @@ a¦ xref:NodeIdxNodeIndexer[] -// markup not found, no include::{specDir}definitions/NodeIdxNode/definition-end.adoc[opts=optional] - +include::{specDir}definitions/NodeIdxNode/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/NodeIdxNode/definition-after.adoc[opts=optional] - - - +ifndef::show-NodeIdxNode[] +:leveloffset: -1 +endif::show-NodeIdxNode[] -// markup not found, no include::{specDir}definitions/NodeIdxNodeIndexer/definition-before.adoc[opts=optional] +include::{specDir}definitions/NodeIdxNode/definition-after.adoc[opts=optional] +include::{specDir}definitions/NodeIdxNodeIndexer/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-NodeIdxNodeIndexer[] [#NodeIdxNodeIndexer] +endif::show-NodeIdxNodeIndexer[] +ifndef::show-NodeIdxNodeIndexer[] +:leveloffset: +1 + +[discrete#NodeIdxNodeIndexer] +endif::show-NodeIdxNodeIndexer[] = Node +ifdef::model-descriptions[] +//tag::desc-NodeIdxNodeIndexer[] +A nested object containing statistics for the current index node. +//end::desc-NodeIdxNodeIndexer[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/NodeIdxNodeIndexer/definition-begin.adoc[opts=optional] +include::{specDir}definitions/NodeIdxNodeIndexer/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1091,22 +951,13 @@ endif::collapse-models[] //tag::NodeIdxNodeIndexer[] -ifdef::model-descriptions[] -//tag::desc-NodeIdxNodeIndexer[] -A nested object containing statistics for the current index node. -//end::desc-NodeIdxNodeIndexer[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*indexer_state* + -_optional_ -a¦ - -[markdown] +a¦ *indexer_state* + +optional +a¦ [markdown] -- Current state of the Index service on this node. -- @@ -1116,13 +967,9 @@ Current state of the Index service on this node. *Example:* `+++"Active"+++` {blank} a¦ String - -a¦ -*memory_quota* + -_optional_ -a¦ - -[markdown] +a¦ *memory_quota* + +optional +a¦ [markdown] -- Memory quota assigned to the Index service on this node by user configuration (bytes). -- @@ -1133,10 +980,8 @@ Memory quota assigned to the Index service on this node by user configuration (b *Example:* `536870912` {blank} a¦ Long (int64) - -a¦ -*memory_total_storage* + -_optional_ +a¦ *memory_total_storage* + +optional a¦ [.edition]##{enterprise}## [markdown] @@ -1150,13 +995,9 @@ This also accounts for memory fragmentation. *Example:* `71794688` {blank} a¦ Integer - -a¦ -*memory_used* + -_optional_ -a¦ - -[markdown] +a¦ *memory_used* + +optional +a¦ [markdown] -- Amount of memory used by the Index service on this node (bytes). -- @@ -1165,13 +1006,9 @@ Amount of memory used by the Index service on this node (bytes). *Example:* `360192000` {blank} a¦ Integer - -a¦ -*total_indexer_gc_pause_ns* + -_optional_ -a¦ - -[markdown] +a¦ *total_indexer_gc_pause_ns* + +optional +a¦ [markdown] -- The total time the indexer has spent in GC pause since last startup (ns). -- @@ -1187,44 +1024,42 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/NodeIdxNodeIndexer/definition-end.adoc[opts=optional] - +include::{specDir}definitions/NodeIdxNodeIndexer/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/NodeIdxNodeIndexer/definition-after.adoc[opts=optional] - - - +ifndef::show-NodeIdxNodeIndexer[] +:leveloffset: -1 +endif::show-NodeIdxNodeIndexer[] -// markup not found, no include::{specDir}definitions/PartIdx/definition-before.adoc[opts=optional] +include::{specDir}definitions/NodeIdxNodeIndexer/definition-after.adoc[opts=optional] +include::{specDir}definitions/PartIdx/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-PartIdx[] [#PartIdx] +endif::show-PartIdx[] +ifndef::show-PartIdx[] +:leveloffset: +1 + +[discrete#PartIdx] +endif::show-PartIdx[] = Index and Partitions :leveloffset: +1 -// markup not found, no include::{specDir}definitions/PartIdx/definition-begin.adoc[opts=optional] - +include::{specDir}definitions/PartIdx/definition-begin.adoc[opts=optional] .icon:bars[fw] Composite Schema {blank} //tag::PartIdx[] - - [cols="25,55,20",separator=¦] |=== ¦ All{nbsp}of{nbsp}... ¦ ¦ Schema a¦ -a¦ - -[markdown] +a¦ [markdown] -- include::index.adoc[tag=desc-PartIdxIndexes, opts=optional] -- @@ -1233,10 +1068,8 @@ include::index.adoc[tag=desc-PartIdxIndexes, opts=optional] {blank} a¦ xref:PartIdxIndexes[] -a¦ _and_ -a¦ - -[markdown] +a¦ and +a¦ [markdown] -- include::index.adoc[tag=desc-PartIdxPartitions, opts=optional] -- @@ -1244,34 +1077,41 @@ include::index.adoc[tag=desc-PartIdxPartitions, opts=optional] [%hardbreaks] {blank} a¦ xref:PartIdxPartitions[] - |=== //end::PartIdx[] - -// markup not found, no include::{specDir}definitions/PartIdx/definition-end.adoc[opts=optional] - +include::{specDir}definitions/PartIdx/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/PartIdx/definition-after.adoc[opts=optional] - - - +ifndef::show-PartIdx[] +:leveloffset: -1 +endif::show-PartIdx[] -// markup not found, no include::{specDir}definitions/PartIdxIndexes/definition-before.adoc[opts=optional] +include::{specDir}definitions/PartIdx/definition-after.adoc[opts=optional] +include::{specDir}definitions/PartIdxIndexes/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-PartIdxIndexes[] [#PartIdxIndexes] +endif::show-PartIdxIndexes[] +ifndef::show-PartIdxIndexes[] +:leveloffset: +1 + +[discrete#PartIdxIndexes] +endif::show-PartIdxIndexes[] = Indexes +ifdef::model-descriptions[] +//tag::desc-PartIdxIndexes[] +Index statistics. +//end::desc-PartIdxIndexes[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/PartIdxIndexes/definition-begin.adoc[opts=optional] +include::{specDir}definitions/PartIdxIndexes/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1279,23 +1119,14 @@ endif::collapse-models[] //tag::PartIdxIndexes[] -ifdef::model-descriptions[] -//tag::desc-PartIdxIndexes[] -Index statistics. -//end::desc-PartIdxIndexes[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ - -_additional + -property_ -a¦ - -[markdown] +additional + +property +a¦ [markdown] -- include::index.adoc[tag=desc-PartIdxPartitionsIndex, opts=optional] -- @@ -1312,26 +1143,35 @@ a¦ xref:PartIdxPartitionsIndex[] include::{specDir}definitions/PartIdxIndexes/definition-end.adoc[opts=optional] - :leveloffset: -1 -// markup not found, no include::{specDir}definitions/PartIdxIndexes/definition-after.adoc[opts=optional] - - - +ifndef::show-PartIdxIndexes[] +:leveloffset: -1 +endif::show-PartIdxIndexes[] -// markup not found, no include::{specDir}definitions/PartIdxPartitions/definition-before.adoc[opts=optional] +include::{specDir}definitions/PartIdxIndexes/definition-after.adoc[opts=optional] +include::{specDir}definitions/PartIdxPartitions/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-PartIdxPartitions[] [#PartIdxPartitions] +endif::show-PartIdxPartitions[] +ifndef::show-PartIdxPartitions[] +:leveloffset: +1 + +[discrete#PartIdxPartitions] +endif::show-PartIdxPartitions[] = Partitions +ifdef::model-descriptions[] +//tag::desc-PartIdxPartitions[] +Index partition statistics. +//end::desc-PartIdxPartitions[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/PartIdxPartitions/definition-begin.adoc[opts=optional] +include::{specDir}definitions/PartIdxPartitions/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1339,23 +1179,14 @@ endif::collapse-models[] //tag::PartIdxPartitions[] -ifdef::model-descriptions[] -//tag::desc-PartIdxPartitions[] -Index partition statistics. -//end::desc-PartIdxPartitions[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ - -_additional + -property_ -a¦ - -[markdown] +additional + +property +a¦ [markdown] -- include::index.adoc[tag=desc-PartIdxPartitionsIndex, opts=optional] -- @@ -1372,26 +1203,35 @@ a¦ xref:PartIdxPartitionsIndex[] include::{specDir}definitions/PartIdxPartitions/definition-end.adoc[opts=optional] - :leveloffset: -1 -// markup not found, no include::{specDir}definitions/PartIdxPartitions/definition-after.adoc[opts=optional] - - - +ifndef::show-PartIdxPartitions[] +:leveloffset: -1 +endif::show-PartIdxPartitions[] -// markup not found, no include::{specDir}definitions/PartIdxPartitionsIndex/definition-before.adoc[opts=optional] +include::{specDir}definitions/PartIdxPartitions/definition-after.adoc[opts=optional] +include::{specDir}definitions/PartIdxPartitionsIndex/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-PartIdxPartitionsIndex[] [#PartIdxPartitionsIndex] +endif::show-PartIdxPartitionsIndex[] +ifndef::show-PartIdxPartitionsIndex[] +:leveloffset: +1 + +[discrete#PartIdxPartitionsIndex] +endif::show-PartIdxPartitionsIndex[] = Index +ifdef::model-descriptions[] +//tag::desc-PartIdxPartitionsIndex[] +A nested object containing statistics for an index or index partition. +//end::desc-PartIdxPartitionsIndex[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/PartIdxPartitionsIndex/definition-begin.adoc[opts=optional] +include::{specDir}definitions/PartIdxPartitionsIndex/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1399,22 +1239,13 @@ endif::collapse-models[] //tag::PartIdxPartitionsIndex[] -ifdef::model-descriptions[] -//tag::desc-PartIdxPartitionsIndex[] -A nested object containing statistics for an index or index partition. -//end::desc-PartIdxPartitionsIndex[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*avg_array_length* + -_optional_ -a¦ - -[markdown] +a¦ *avg_array_length* + +optional +a¦ [markdown] -- (Array indexes only.) The average number of items indexed per document. @@ -1424,13 +1255,9 @@ The average number of items indexed per document. [%hardbreaks] {blank} a¦ Integer - -a¦ -*avg_drain_rate* + -_optional_ -a¦ - -[markdown] +a¦ *avg_drain_rate* + +optional +a¦ [markdown] -- Average number of items flushed from memory to disk storage per second. -- @@ -1438,13 +1265,9 @@ Average number of items flushed from memory to disk storage per second. [%hardbreaks] {blank} a¦ Integer - -a¦ -*avg_item_size* + -_optional_ -a¦ - -[markdown] +a¦ *avg_item_size* + +optional +a¦ [markdown] -- Average size of the keys. -- @@ -1452,13 +1275,9 @@ Average size of the keys. [%hardbreaks] {blank} a¦ Integer - -a¦ -*avg_scan_latency* + -_optional_ -a¦ - -[markdown] +a¦ *avg_scan_latency* + +optional +a¦ [markdown] -- Average time to serve a scan request (nanoseconds). -- @@ -1466,10 +1285,8 @@ Average time to serve a scan request (nanoseconds). [%hardbreaks] {blank} a¦ Integer - -a¦ -*cache_hit_percent* + -_optional_ +a¦ *cache_hit_percent* + +optional a¦ [.edition]##{enterprise}## [markdown] @@ -1480,13 +1297,9 @@ Percentage of memory accesses that were served from the managed cache. [%hardbreaks] {blank} a¦ Integer - -a¦ -*cache_hits* + -_optional_ -a¦ - -[markdown] +a¦ *cache_hits* + +optional +a¦ [markdown] -- Accesses to this index data from RAM. -- @@ -1494,13 +1307,9 @@ Accesses to this index data from RAM. [%hardbreaks] {blank} a¦ Integer - -a¦ -*cache_misses* + -_optional_ -a¦ - -[markdown] +a¦ *cache_misses* + +optional +a¦ [markdown] -- Accesses to this index data from disk. -- @@ -1508,13 +1317,9 @@ Accesses to this index data from disk. [%hardbreaks] {blank} a¦ Integer - -a¦ -*data_size* + -_optional_ -a¦ - -[markdown] +a¦ *data_size* + +optional +a¦ [markdown] -- The size of indexable data that is maintained for the index or partition (bytes). -- @@ -1523,13 +1328,9 @@ The size of indexable data that is maintained for the index or partition (bytes) *Example:* `95728` {blank} a¦ Integer - -a¦ -*disk_size* + -_optional_ -a¦ - -[markdown] +a¦ *disk_size* + +optional +a¦ [markdown] -- Total disk file size consumed by the index or partition. -- @@ -1538,13 +1339,9 @@ Total disk file size consumed by the index or partition. *Example:* `889054` {blank} a¦ Integer - -a¦ -*docid_count* + -_optional_ -a¦ - -[markdown] +a¦ *docid_count* + +optional +a¦ [markdown] -- (Array indexes only.) The number of documents currently indexed. @@ -1554,13 +1351,9 @@ The number of documents currently indexed. [%hardbreaks] {blank} a¦ Integer - -a¦ -*frag_percent* + -_optional_ -a¦ - -[markdown] +a¦ *frag_percent* + +optional +a¦ [markdown] -- Percentage fragmentation of the index. @@ -1571,13 +1364,9 @@ TIP: At small index sizes of less than a hundred kB, the static overhead of the [%hardbreaks] {blank} a¦ Integer - -a¦ -*initial_build_progress* + -_optional_ -a¦ - -[markdown] +a¦ *initial_build_progress* + +optional +a¦ [markdown] -- Percentage initial build progress for the index. When initial build is completed, the value is `100`. @@ -1590,13 +1379,9 @@ For an index partition, the value is listed as `0`. *Example:* `100` {blank} a¦ Integer - -a¦ -*items_count* + -_optional_ -a¦ - -[markdown] +a¦ *items_count* + +optional +a¦ [markdown] -- The number of items currently indexed. -- @@ -1605,13 +1390,9 @@ The number of items currently indexed. *Example:* `2155` {blank} a¦ Integer - -a¦ -*last_known_scan_time* + -_optional_ -a¦ - -[markdown] +a¦ *last_known_scan_time* + +optional +a¦ [markdown] -- Time of the last scan request received for this index (Unix timestamp in nanoseconds). This may be useful for determining whether this index is currently unused. @@ -1623,13 +1404,9 @@ NOTE: This statistic is persisted to disk every 15 minutes, so it is preserved w [%hardbreaks] {blank} a¦ Long (int64) - -a¦ -*num_docs_indexed* + -_optional_ -a¦ - -[markdown] +a¦ *num_docs_indexed* + +optional +a¦ [markdown] -- Number of documents indexed by the indexer since last startup. -- @@ -1637,13 +1414,9 @@ Number of documents indexed by the indexer since last startup. [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_docs_pending* + -_optional_ -a¦ - -[markdown] +a¦ *num_docs_pending* + +optional +a¦ [markdown] -- Number of documents pending to be indexed. -- @@ -1651,13 +1424,9 @@ Number of documents pending to be indexed. [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_docs_queued* + -_optional_ -a¦ - -[markdown] +a¦ *num_docs_queued* + +optional +a¦ [markdown] -- Number of documents queued to be indexed. -- @@ -1665,13 +1434,9 @@ Number of documents queued to be indexed. [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_items_flushed* + -_optional_ -a¦ - -[markdown] +a¦ *num_items_flushed* + +optional +a¦ [markdown] -- Number of items flushed from memory to disk storage. -- @@ -1679,13 +1444,9 @@ Number of items flushed from memory to disk storage. [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_pending_requests* + -_optional_ -a¦ - -[markdown] +a¦ *num_pending_requests* + +optional +a¦ [markdown] -- Number of requests received but not yet served by the indexer. -- @@ -1693,13 +1454,9 @@ Number of requests received but not yet served by the indexer. [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_requests* + -_optional_ -a¦ - -[markdown] +a¦ *num_requests* + +optional +a¦ [markdown] -- Number of requests served by the indexer since last startup. -- @@ -1707,13 +1464,9 @@ Number of requests served by the indexer since last startup. [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_rows_returned* + -_optional_ -a¦ - -[markdown] +a¦ *num_rows_returned* + +optional +a¦ [markdown] -- Total number of rows returned so far by the indexer. -- @@ -1721,13 +1474,9 @@ Total number of rows returned so far by the indexer. [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_scan_errors* + -_optional_ -a¦ - -[markdown] +a¦ *num_scan_errors* + +optional +a¦ [markdown] -- Number of requests that failed due to errors other than timeout. -- @@ -1735,13 +1484,9 @@ Number of requests that failed due to errors other than timeout. [%hardbreaks] {blank} a¦ Integer - -a¦ -*num_scan_timeouts* + -_optional_ -a¦ - -[markdown] +a¦ *num_scan_timeouts* + +optional +a¦ [markdown] -- Number of requests that timed out, either waiting for snapshots or during scan in progress. -- @@ -1749,10 +1494,8 @@ Number of requests that timed out, either waiting for snapshots or during scan i [%hardbreaks] {blank} a¦ Integer - -a¦ -*recs_in_mem* + -_optional_ +a¦ *recs_in_mem* + +optional a¦ [.edition]##{enterprise}## [markdown] @@ -1767,10 +1510,8 @@ For memory-optimized index storage, this is the same as `items_count`. *Example:* `2155` {blank} a¦ Integer - -a¦ -*recs_on_disk* + -_optional_ +a¦ *recs_on_disk* + +optional a¦ [.edition]##{enterprise}## [markdown] @@ -1782,10 +1523,8 @@ For memory-optimized index storage, this is `0`. [%hardbreaks] {blank} a¦ Integer - -a¦ -*resident_percent* + -_optional_ +a¦ *resident_percent* + +optional a¦ [.edition]##{enterprise}## [markdown] @@ -1797,13 +1536,9 @@ Percentage of the data held in memory. *Example:* `100` {blank} a¦ Integer - -a¦ -*scan_bytes_read* + -_optional_ -a¦ - -[markdown] +a¦ *scan_bytes_read* + +optional +a¦ [markdown] -- Number of bytes read by a scan since last startup. -- @@ -1811,13 +1546,9 @@ Number of bytes read by a scan since last startup. [%hardbreaks] {blank} a¦ Integer - -a¦ -*total_scan_duration* + -_optional_ -a¦ - -[markdown] +a¦ *total_scan_duration* + +optional +a¦ [markdown] -- Total time spent by the indexer in scanning rows since last startup (nanoseconds). -- @@ -1832,26 +1563,26 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/PartIdxPartitionsIndex/definition-end.adoc[opts=optional] - +include::{specDir}definitions/PartIdxPartitionsIndex/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/PartIdxPartitionsIndex/definition-after.adoc[opts=optional] - +ifndef::show-PartIdxPartitionsIndex[] +:leveloffset: -1 +endif::show-PartIdxPartitionsIndex[] +include::{specDir}definitions/PartIdxPartitionsIndex/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] - +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -1861,18 +1592,14 @@ a¦ Integer include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/NodeStatistics/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/NodeStatistics/security-scheme-before.adoc[opts=optional] - - -[[security-nodeStatistics]] +[[security-NodeStatistics]] = Node Statistics :leveloffset: +1 -// markup not found, no include::{specDir}security/NodeStatistics/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/NodeStatistics/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -1881,29 +1608,22 @@ To get [Node statistics](#NodeIdxNodeIndexer), users must have the Query System -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/NodeStatistics/security-scheme-end.adoc[opts=optional] +include::{specDir}security/NodeStatistics/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/NodeStatistics/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/NodeStatistics/security-scheme-after.adoc[opts=optional] - - - - -// markup not found, no include::{specDir}security/IndexStatistics/security-scheme-before.adoc[opts=optional] +include::{specDir}security/IndexStatistics/security-scheme-before.adoc[opts=optional] - -[[security-indexStatistics]] +[[security-IndexStatistics]] = Index Statistics :leveloffset: +1 -// markup not found, no include::{specDir}security/IndexStatistics/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/IndexStatistics/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -1914,16 +1634,13 @@ To get [Index statistics](#PartIdxPartitionsIndex) for an individual index, user -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/IndexStatistics/security-scheme-end.adoc[opts=optional] +include::{specDir}security/IndexStatistics/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/IndexStatistics/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/IndexStatistics/security-scheme-after.adoc[opts=optional] @@ -1931,8 +1648,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - -// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] +include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/n1ql-rest-admin/admin.gradle b/docs/modules/n1ql-rest-admin/admin.gradle index 37ed5af4..222976f8 100644 --- a/docs/modules/n1ql-rest-admin/admin.gradle +++ b/docs/modules/n1ql-rest-admin/admin.gradle @@ -34,6 +34,7 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file diff --git a/docs/modules/n1ql-rest-admin/pages/index.adoc b/docs/modules/n1ql-rest-admin/pages/index.adoc index d7be2c4d..2e6a79dc 100644 --- a/docs/modules/n1ql-rest-admin/pages/index.adoc +++ b/docs/modules/n1ql-rest-admin/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbase/query :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -32,7 +31,7 @@ This API enables you to retrieve statistics about the clusters and nodes running [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -67,7 +66,6 @@ The host name or IP address of a node running the Query Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -83,31 +81,26 @@ The Query Service REST port. Use `18093` for secure access. |=== - -// markup not found, no include::{specDir}overview/document-end.adoc[opts=optional] +include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}overview/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 7 - +:count-apis: 6 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -121,18 +114,14 @@ xref:tag-Statistics[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-ActiveRequests] = Active Requests :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:delete_active_request[] @@ -141,44 +130,38 @@ xref:get_active_request[] xref:get_active_requests[] -//tag::delete_active_request[] - -// markup not found, no include::{specDir}paths/delete_active_request/operation-before.adoc[opts=optional] +//tag::delete_active_request[] +include::{specDir}paths/delete_active_request/operation-before.adoc[opts=optional] [#delete_active_request] = Delete an Active Request :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_active_request/operation-begin.adoc[opts=optional] - +include::{specDir}paths/delete_active_request/operation-begin.adoc[opts=optional] .... DELETE /admin/active_requests/{request} .... - -// markup not found, no include::{specDir}paths/delete_active_request/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/delete_active_request/operation-description-before.adoc[opts=optional] [#delete_active_request-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_active_request/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/delete_active_request/operation-description-begin.adoc[opts=optional] [markdown] -- Terminates the specified active query request. -- - -// markup not found, no include::{specDir}paths/delete_active_request/operation-description-end.adoc[opts=optional] +include::{specDir}paths/delete_active_request/operation-description-end.adoc[opts=optional] @@ -186,23 +169,20 @@ Terminates the specified active query request. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/delete_active_request/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/delete_active_request/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_active_request/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/delete_active_request/operation-parameters-before.adoc[opts=optional] [#delete_active_request-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_active_request/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/delete_active_request/operation-parameters-begin.adoc[opts=optional] [#delete_active_request-path] .Path Parameters @@ -213,11 +193,8 @@ Terminates the specified active query request. ¦ Name ¦ Description ¦ Schema a¦ *request* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a request. This is the `requestID` that was assigned automatically when the statement was created. @@ -231,30 +208,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/delete_active_request/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/delete_active_request/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/delete_active_request/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/delete_active_request/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_active_request/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/delete_active_request/operation-responses-before.adoc[opts=optional] [#delete_active_request-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_active_request/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/delete_active_request/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -266,6 +237,7 @@ a| [markdown] The active request was successfully terminated. -- a| + | 500 a| [markdown] -- @@ -273,98 +245,78 @@ Returns an error message if the active request could not be found. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/delete_active_request/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/delete_active_request/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/delete_active_request/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/delete_active_request/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_active_request/operation-security-before.adoc[opts=optional] +include::{specDir}paths/delete_active_request/operation-security-before.adoc[opts=optional] [#delete_active_request-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_active_request/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/delete_active_request/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/delete_active_request/operation-security-end.adoc[opts=optional] +include::{specDir}paths/delete_active_request/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/delete_active_request/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/delete_active_request/operation-security-after.adoc[opts=optional] include::{snippetDir}delete_active_request/http-request.adoc[opts=optional] +include::{snippetDir}delete_active_request/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}delete_active_request/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/delete_active_request/operation-end.adoc[opts=optional] +include::{specDir}paths/delete_active_request/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/delete_active_request/operation-after.adoc[opts=optional] - +include::{specDir}paths/delete_active_request/operation-after.adoc[opts=optional] //end::delete_active_request[] - //tag::get_active_indexes[] - -// markup not found, no include::{specDir}paths/get_active_indexes/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_active_indexes/operation-before.adoc[opts=optional] [#get_active_indexes] = Retrieve Active Index Requests :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_active_indexes/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_active_indexes/operation-begin.adoc[opts=optional] .... GET /admin/indexes/active_requests .... - -// markup not found, no include::{specDir}paths/get_active_indexes/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_active_indexes/operation-description-before.adoc[opts=optional] [#get_active_indexes-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_active_indexes/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_active_indexes/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -374,8 +326,7 @@ Returns all active index requests. * Use [Delete an Active Request](#delete_active_request) to terminate an active index request. -- - -// markup not found, no include::{specDir}paths/get_active_indexes/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_active_indexes/operation-description-end.adoc[opts=optional] @@ -383,33 +334,29 @@ Returns all active index requests. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_active_indexes/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_active_indexes/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_active_indexes/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_active_indexes/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_active_indexes/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_active_indexes/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_active_indexes/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_active_indexes/operation-responses-before.adoc[opts=optional] [#get_active_indexes-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_active_indexes/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_active_indexes/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -420,109 +367,87 @@ a| [markdown] -- An array of strings, each of which is the requestID of an active index request. -- -a| String - array - +a| String array |=== - -// markup not found, no include::{specDir}paths/get_active_indexes/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_active_indexes/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_active_indexes/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_active_indexes/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_active_indexes/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_active_indexes/operation-security-before.adoc[opts=optional] [#get_active_indexes-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_active_indexes/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_active_indexes/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_active_indexes/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_active_indexes/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/get_active_indexes/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_active_indexes/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}get_active_indexes/http-request.adoc[opts=optional] +include::{snippetDir}get_active_indexes/http-request.adoc[opts=optional] +include::{snippetDir}get_active_indexes/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}get_active_indexes/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_active_indexes/operation-end.adoc[opts=optional] +include::{specDir}paths/get_active_indexes/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_active_indexes/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_active_indexes/operation-after.adoc[opts=optional] //end::get_active_indexes[] - //tag::get_active_request[] - -// markup not found, no include::{specDir}paths/get_active_request/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_active_request/operation-before.adoc[opts=optional] [#get_active_request] = Retrieve an Active Request :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_active_request/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_active_request/operation-begin.adoc[opts=optional] .... GET /admin/active_requests/{request} .... - -// markup not found, no include::{specDir}paths/get_active_request/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_active_request/operation-description-before.adoc[opts=optional] [#get_active_request-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_active_request/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_active_request/operation-description-begin.adoc[opts=optional] [markdown] -- Returns the specified active query request. -- - -// markup not found, no include::{specDir}paths/get_active_request/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_active_request/operation-description-end.adoc[opts=optional] @@ -530,23 +455,20 @@ Returns the specified active query request. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_active_request/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_active_request/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_active_request/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_active_request/operation-parameters-before.adoc[opts=optional] [#get_active_request-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_active_request/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/get_active_request/operation-parameters-begin.adoc[opts=optional] [#get_active_request-path] .Path Parameters @@ -557,11 +479,8 @@ Returns the specified active query request. ¦ Name ¦ Description ¦ Schema a¦ *request* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a request. This is the `requestID` that was assigned automatically when the statement was created. @@ -575,30 +494,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/get_active_request/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/get_active_request/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_active_request/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_active_request/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_active_request/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/get_active_request/operation-responses-before.adoc[opts=optional] [#get_active_request-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_active_request/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_active_request/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -611,106 +524,86 @@ An object containing information about the specified active request. -- a| xref:Requests[] - |=== - -// markup not found, no include::{specDir}paths/get_active_request/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_active_request/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Requests: -// markup not found, no include::{specDir}paths/get_active_request/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_active_request/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_active_request/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_active_request/operation-security-before.adoc[opts=optional] [#get_active_request-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_active_request/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_active_request/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_active_request/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_active_request/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_active_request/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_active_request/operation-security-after.adoc[opts=optional] include::{snippetDir}get_active_request/http-request.adoc[opts=optional] +include::{snippetDir}get_active_request/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}get_active_request/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_active_request/operation-end.adoc[opts=optional] +include::{specDir}paths/get_active_request/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_active_request/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_active_request/operation-after.adoc[opts=optional] //end::get_active_request[] - //tag::get_active_requests[] - -// markup not found, no include::{specDir}paths/get_active_requests/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_active_requests/operation-before.adoc[opts=optional] [#get_active_requests] = Retrieve All Active Requests :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_active_requests/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_active_requests/operation-begin.adoc[opts=optional] .... GET /admin/active_requests .... - -// markup not found, no include::{specDir}paths/get_active_requests/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_active_requests/operation-description-before.adoc[opts=optional] [#get_active_requests-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_active_requests/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_active_requests/operation-description-begin.adoc[opts=optional] [markdown] -- Returns all active query requests. -- - -// markup not found, no include::{specDir}paths/get_active_requests/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_active_requests/operation-description-end.adoc[opts=optional] @@ -718,33 +611,29 @@ Returns all active query requests. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_active_requests/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_active_requests/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_active_requests/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_active_requests/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_active_requests/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_active_requests/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_active_requests/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_active_requests/operation-responses-before.adoc[opts=optional] [#get_active_requests-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_active_requests/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_active_requests/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -755,88 +644,71 @@ a| [markdown] -- An array of objects, each of which contains information about one active request. -- -a| xref:Requests[] - array - +a| xref:Requests[] array |=== - -// markup not found, no include::{specDir}paths/get_active_requests/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_active_requests/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Requests: -// markup not found, no include::{specDir}paths/get_active_requests/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_active_requests/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_active_requests/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_active_requests/operation-security-before.adoc[opts=optional] [#get_active_requests-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_active_requests/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_active_requests/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_active_requests/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_active_requests/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_active_requests/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_active_requests/operation-security-after.adoc[opts=optional] include::{snippetDir}get_active_requests/http-request.adoc[opts=optional] +include::{snippetDir}get_active_requests/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}get_active_requests/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_active_requests/operation-end.adoc[opts=optional] +include::{specDir}paths/get_active_requests/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_active_requests/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_active_requests/operation-after.adoc[opts=optional] //end::get_active_requests[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-CompletedRequests] = Completed Requests :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:delete_completed_request[] @@ -845,44 +717,38 @@ xref:get_completed_request[] xref:get_completed_requests[] -//tag::delete_completed_request[] - -// markup not found, no include::{specDir}paths/delete_completed_request/operation-before.adoc[opts=optional] +//tag::delete_completed_request[] +include::{specDir}paths/delete_completed_request/operation-before.adoc[opts=optional] [#delete_completed_request] = Delete a Completed Request :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_completed_request/operation-begin.adoc[opts=optional] - +include::{specDir}paths/delete_completed_request/operation-begin.adoc[opts=optional] .... DELETE /admin/completed_requests/{request} .... - -// markup not found, no include::{specDir}paths/delete_completed_request/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/delete_completed_request/operation-description-before.adoc[opts=optional] [#delete_completed_request-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_completed_request/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/delete_completed_request/operation-description-begin.adoc[opts=optional] [markdown] -- Purges the specified completed request. -- - -// markup not found, no include::{specDir}paths/delete_completed_request/operation-description-end.adoc[opts=optional] +include::{specDir}paths/delete_completed_request/operation-description-end.adoc[opts=optional] @@ -890,23 +756,20 @@ Purges the specified completed request. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/delete_completed_request/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/delete_completed_request/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_completed_request/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/delete_completed_request/operation-parameters-before.adoc[opts=optional] [#delete_completed_request-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_completed_request/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/delete_completed_request/operation-parameters-begin.adoc[opts=optional] [#delete_completed_request-path] .Path Parameters @@ -917,11 +780,8 @@ Purges the specified completed request. ¦ Name ¦ Description ¦ Schema a¦ *request* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a request. This is the `requestID` that was assigned automatically when the statement was created. @@ -935,30 +795,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/delete_completed_request/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/delete_completed_request/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/delete_completed_request/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/delete_completed_request/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_completed_request/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/delete_completed_request/operation-responses-before.adoc[opts=optional] [#delete_completed_request-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_completed_request/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/delete_completed_request/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -970,6 +824,7 @@ a| [markdown] The completed request was successfully purged. -- a| + | 500 a| [markdown] -- @@ -977,98 +832,78 @@ Returns an error message if the completed request could not be found. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/delete_completed_request/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/delete_completed_request/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/delete_completed_request/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/delete_completed_request/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_completed_request/operation-security-before.adoc[opts=optional] +include::{specDir}paths/delete_completed_request/operation-security-before.adoc[opts=optional] [#delete_completed_request-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_completed_request/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/delete_completed_request/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/delete_completed_request/operation-security-end.adoc[opts=optional] +include::{specDir}paths/delete_completed_request/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/delete_completed_request/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/delete_completed_request/operation-security-after.adoc[opts=optional] include::{snippetDir}delete_completed_request/http-request.adoc[opts=optional] +include::{snippetDir}delete_completed_request/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}delete_completed_request/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/delete_completed_request/operation-end.adoc[opts=optional] +include::{specDir}paths/delete_completed_request/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/delete_completed_request/operation-after.adoc[opts=optional] - +include::{specDir}paths/delete_completed_request/operation-after.adoc[opts=optional] //end::delete_completed_request[] - //tag::get_completed_indexes[] - -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_completed_indexes/operation-before.adoc[opts=optional] [#get_completed_indexes] = Retrieve Completed Index Requests :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_completed_indexes/operation-begin.adoc[opts=optional] .... GET /admin/indexes/completed_requests .... - -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_completed_indexes/operation-description-before.adoc[opts=optional] [#get_completed_indexes-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_completed_indexes/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -1078,8 +913,7 @@ Returns all completed index requests. * Use [Delete a Completed Request](#delete_completed_request) to purge a completed index request. -- - -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_completed_indexes/operation-description-end.adoc[opts=optional] @@ -1087,33 +921,29 @@ Returns all completed index requests. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_completed_indexes/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_completed_indexes/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_completed_indexes/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_completed_indexes/operation-responses-before.adoc[opts=optional] [#get_completed_indexes-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_completed_indexes/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1124,109 +954,87 @@ a| [markdown] -- An array of strings, each of which is the requestID of a completed index request. -- -a| String - array - +a| String array |=== - -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_completed_indexes/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_completed_indexes/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_completed_indexes/operation-security-before.adoc[opts=optional] [#get_completed_indexes-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_completed_indexes/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_completed_indexes/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/get_completed_indexes/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}get_completed_indexes/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}get_completed_indexes/http-response.adoc[opts=optional] +include::{snippetDir}get_completed_indexes/http-request.adoc[opts=optional] +include::{snippetDir}get_completed_indexes/http-response.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-end.adoc[opts=optional] +include::{specDir}paths/get_completed_indexes/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_completed_indexes/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_completed_indexes/operation-after.adoc[opts=optional] //end::get_completed_indexes[] - //tag::get_completed_request[] - -// markup not found, no include::{specDir}paths/get_completed_request/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_completed_request/operation-before.adoc[opts=optional] [#get_completed_request] = Retrieve a Completed Request :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_completed_request/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_completed_request/operation-begin.adoc[opts=optional] .... GET /admin/completed_requests/{request} .... - -// markup not found, no include::{specDir}paths/get_completed_request/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_completed_request/operation-description-before.adoc[opts=optional] [#get_completed_request-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_completed_request/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_completed_request/operation-description-begin.adoc[opts=optional] [markdown] -- Returns the specified completed request. -- - -// markup not found, no include::{specDir}paths/get_completed_request/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_completed_request/operation-description-end.adoc[opts=optional] @@ -1234,23 +1042,20 @@ Returns the specified completed request. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_completed_request/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_completed_request/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_completed_request/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_completed_request/operation-parameters-before.adoc[opts=optional] [#get_completed_request-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_completed_request/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/get_completed_request/operation-parameters-begin.adoc[opts=optional] [#get_completed_request-path] .Path Parameters @@ -1261,11 +1066,8 @@ Returns the specified completed request. ¦ Name ¦ Description ¦ Schema a¦ *request* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a request. This is the `requestID` that was assigned automatically when the statement was created. @@ -1279,30 +1081,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/get_completed_request/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/get_completed_request/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_completed_request/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_completed_request/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_completed_request/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/get_completed_request/operation-responses-before.adoc[opts=optional] [#get_completed_request-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_completed_request/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_completed_request/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1315,106 +1111,86 @@ An object containing information about the specified completed request. -- a| xref:Requests[] - |=== - -// markup not found, no include::{specDir}paths/get_completed_request/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_completed_request/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Requests: -// markup not found, no include::{specDir}paths/get_completed_request/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_completed_request/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_completed_request/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_completed_request/operation-security-before.adoc[opts=optional] [#get_completed_request-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_completed_request/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_completed_request/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_completed_request/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_completed_request/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_completed_request/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_completed_request/operation-security-after.adoc[opts=optional] include::{snippetDir}get_completed_request/http-request.adoc[opts=optional] +include::{snippetDir}get_completed_request/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}get_completed_request/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_completed_request/operation-end.adoc[opts=optional] +include::{specDir}paths/get_completed_request/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_completed_request/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_completed_request/operation-after.adoc[opts=optional] //end::get_completed_request[] - //tag::get_completed_requests[] - -// markup not found, no include::{specDir}paths/get_completed_requests/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_completed_requests/operation-before.adoc[opts=optional] [#get_completed_requests] = Retrieve All Completed Requests :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_completed_requests/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_completed_requests/operation-begin.adoc[opts=optional] .... GET /admin/completed_requests .... - -// markup not found, no include::{specDir}paths/get_completed_requests/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_completed_requests/operation-description-before.adoc[opts=optional] [#get_completed_requests-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_completed_requests/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_completed_requests/operation-description-begin.adoc[opts=optional] [markdown] -- Returns all completed requests. -- - -// markup not found, no include::{specDir}paths/get_completed_requests/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_completed_requests/operation-description-end.adoc[opts=optional] @@ -1422,33 +1198,29 @@ Returns all completed requests. .Produces * application/json + :leveloffset: -1 +include::{specDir}paths/get_completed_requests/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_completed_requests/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_completed_requests/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_completed_requests/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_completed_requests/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_completed_requests/operation-parameters-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_completed_requests/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/get_completed_requests/operation-responses-before.adoc[opts=optional] [#get_completed_requests-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_completed_requests/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_completed_requests/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1459,88 +1231,71 @@ a| [markdown] -- An array of objects, each of which contains information about one completed request. -- -a| xref:Requests[] - array - +a| xref:Requests[] array |=== - -// markup not found, no include::{specDir}paths/get_completed_requests/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_completed_requests/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Requests: -// markup not found, no include::{specDir}paths/get_completed_requests/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_completed_requests/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_completed_requests/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_completed_requests/operation-security-before.adoc[opts=optional] [#get_completed_requests-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_completed_requests/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_completed_requests/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_completed_requests/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_completed_requests/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_completed_requests/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_completed_requests/operation-security-after.adoc[opts=optional] include::{snippetDir}get_completed_requests/http-request.adoc[opts=optional] +include::{snippetDir}get_completed_requests/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}get_completed_requests/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_completed_requests/operation-end.adoc[opts=optional] +include::{specDir}paths/get_completed_requests/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_completed_requests/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_completed_requests/operation-after.adoc[opts=optional] //end::get_completed_requests[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Configuration] = Configuration :leveloffset: +1 -ifeval::["Operations for cluster and node configuration." != ""] Operations for cluster and node configuration. endif::[] -ifeval::["Operations for cluster and node configuration." == ""] -**{toc-title}** -endif::[] -endif::[] + [%hardbreaks] xref:get_cluster[] @@ -1550,44 +1305,38 @@ xref:get_node[] xref:get_nodes[] -//tag::get_cluster[] - -// markup not found, no include::{specDir}paths/get_cluster/operation-before.adoc[opts=optional] +//tag::get_cluster[] +include::{specDir}paths/get_cluster/operation-before.adoc[opts=optional] [#get_cluster] = Read a Cluster :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_cluster/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_cluster/operation-begin.adoc[opts=optional] .... GET /admin/clusters/{cluster} .... - -// markup not found, no include::{specDir}paths/get_cluster/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_cluster/operation-description-before.adoc[opts=optional] [#get_cluster-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_cluster/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_cluster/operation-description-begin.adoc[opts=optional] [markdown] -- Returns information about the specified cluster. -- - -// markup not found, no include::{specDir}paths/get_cluster/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_cluster/operation-description-end.adoc[opts=optional] @@ -1595,23 +1344,20 @@ Returns information about the specified cluster. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_cluster/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_cluster/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_cluster/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_cluster/operation-parameters-before.adoc[opts=optional] [#get_cluster-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_cluster/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/get_cluster/operation-parameters-begin.adoc[opts=optional] [#get_cluster-path] .Path Parameters @@ -1622,11 +1368,8 @@ Returns information about the specified cluster. ¦ Name ¦ Description ¦ Schema a¦ *cluster* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a cluster. -- @@ -1639,30 +1382,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/get_cluster/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/get_cluster/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_cluster/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_cluster/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_cluster/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/get_cluster/operation-responses-before.adoc[opts=optional] [#get_cluster-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_cluster/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_cluster/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1675,106 +1412,86 @@ An object giving information about the specified cluster. -- a| xref:Clusters[] - |=== - -// markup not found, no include::{specDir}paths/get_cluster/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_cluster/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Clusters: -// markup not found, no include::{specDir}paths/get_cluster/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_cluster/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_cluster/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_cluster/operation-security-before.adoc[opts=optional] [#get_cluster-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_cluster/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_cluster/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_cluster/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_cluster/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/get_cluster/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_cluster/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}get_cluster/http-request.adoc[opts=optional] +include::{snippetDir}get_cluster/http-request.adoc[opts=optional] +include::{snippetDir}get_cluster/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}get_cluster/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_cluster/operation-end.adoc[opts=optional] +include::{specDir}paths/get_cluster/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_cluster/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_cluster/operation-after.adoc[opts=optional] //end::get_cluster[] - //tag::get_clusters[] - -// markup not found, no include::{specDir}paths/get_clusters/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_clusters/operation-before.adoc[opts=optional] [#get_clusters] = Read All Clusters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_clusters/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_clusters/operation-begin.adoc[opts=optional] .... GET /admin/clusters .... - -// markup not found, no include::{specDir}paths/get_clusters/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_clusters/operation-description-before.adoc[opts=optional] [#get_clusters-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_clusters/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_clusters/operation-description-begin.adoc[opts=optional] [markdown] -- Returns information about all clusters. -- - -// markup not found, no include::{specDir}paths/get_clusters/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_clusters/operation-description-end.adoc[opts=optional] @@ -1782,33 +1499,29 @@ Returns information about all clusters. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_clusters/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_clusters/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_clusters/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_clusters/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_clusters/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_clusters/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_clusters/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_clusters/operation-responses-before.adoc[opts=optional] [#get_clusters-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_clusters/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_clusters/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1819,109 +1532,88 @@ a| [markdown] -- An array of objects, each of which gives information about one cluster. -- -a| xref:Clusters[] - array - +a| xref:Clusters[] array |=== - -// markup not found, no include::{specDir}paths/get_clusters/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_clusters/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Clusters: -// markup not found, no include::{specDir}paths/get_clusters/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_clusters/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_clusters/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_clusters/operation-security-before.adoc[opts=optional] [#get_clusters-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_clusters/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_clusters/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_clusters/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_clusters/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/get_clusters/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_clusters/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}get_clusters/http-request.adoc[opts=optional] +include::{snippetDir}get_clusters/http-request.adoc[opts=optional] +include::{snippetDir}get_clusters/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}get_clusters/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_clusters/operation-end.adoc[opts=optional] +include::{specDir}paths/get_clusters/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_clusters/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_clusters/operation-after.adoc[opts=optional] //end::get_clusters[] - //tag::get_config[] - -// markup not found, no include::{specDir}paths/get_config/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_config/operation-before.adoc[opts=optional] [#get_config] = Read Configuration :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_config/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_config/operation-begin.adoc[opts=optional] .... GET /admin/config .... - -// markup not found, no include::{specDir}paths/get_config/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_config/operation-description-before.adoc[opts=optional] [#get_config-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_config/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_config/operation-description-begin.adoc[opts=optional] [markdown] -- Returns the configuration of the query service on the cluster. -- - -// markup not found, no include::{specDir}paths/get_config/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_config/operation-description-end.adoc[opts=optional] @@ -1929,33 +1621,29 @@ Returns the configuration of the query service on the cluster. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_config/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_config/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_config/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_config/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_config/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_config/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_config/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_config/operation-responses-before.adoc[opts=optional] [#get_config-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_config/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_config/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1968,106 +1656,86 @@ An object giving information about the specified node. -- a| xref:Nodes[] - |=== - -// markup not found, no include::{specDir}paths/get_config/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_config/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Nodes: -// markup not found, no include::{specDir}paths/get_config/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_config/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_config/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_config/operation-security-before.adoc[opts=optional] [#get_config-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_config/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_config/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_config/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_config/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/get_config/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_config/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}get_config/http-request.adoc[opts=optional] - +include::{snippetDir}get_config/http-request.adoc[opts=optional] -// markup not found, no include::{snippetDir}get_config/http-response.adoc[opts=optional] +include::{snippetDir}get_config/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_config/operation-end.adoc[opts=optional] +include::{specDir}paths/get_config/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_config/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_config/operation-after.adoc[opts=optional] //end::get_config[] - //tag::get_node[] - -// markup not found, no include::{specDir}paths/get_node/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-before.adoc[opts=optional] [#get_node] = Read a Node :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_node/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-begin.adoc[opts=optional] .... GET /admin/clusters/{cluster}/nodes/{node} .... - -// markup not found, no include::{specDir}paths/get_node/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-description-before.adoc[opts=optional] [#get_node-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_node/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-description-begin.adoc[opts=optional] [markdown] -- Returns information about the specified node in the specified cluster. -- - -// markup not found, no include::{specDir}paths/get_node/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_node/operation-description-end.adoc[opts=optional] @@ -2075,23 +1743,20 @@ Returns information about the specified node in the specified cluster. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_node/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_node/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_node/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_node/operation-parameters-before.adoc[opts=optional] [#get_node-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_node/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-parameters-begin.adoc[opts=optional] [#get_node-path] .Path Parameters @@ -2102,11 +1767,8 @@ Returns information about the specified node in the specified cluster. ¦ Name ¦ Description ¦ Schema a¦ *cluster* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a cluster. -- @@ -2115,13 +1777,9 @@ The name of a cluster. {blank} a¦ String - a¦ *node* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a node. -- @@ -2134,30 +1792,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/get_node/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/get_node/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_node/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_node/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_node/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-responses-before.adoc[opts=optional] [#get_node-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_node/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2170,106 +1822,86 @@ An object giving information about the specified node. -- a| xref:Nodes[] - |=== - -// markup not found, no include::{specDir}paths/get_node/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_node/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Nodes: -// markup not found, no include::{specDir}paths/get_node/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_node/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_node/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-security-before.adoc[opts=optional] [#get_node-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_node/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_node/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_node/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/get_node/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_node/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}get_node/http-request.adoc[opts=optional] +include::{snippetDir}get_node/http-request.adoc[opts=optional] +include::{snippetDir}get_node/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}get_node/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_node/operation-end.adoc[opts=optional] +include::{specDir}paths/get_node/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_node/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_node/operation-after.adoc[opts=optional] //end::get_node[] - //tag::get_nodes[] - -// markup not found, no include::{specDir}paths/get_nodes/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_nodes/operation-before.adoc[opts=optional] [#get_nodes] = Read All Nodes :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_nodes/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_nodes/operation-begin.adoc[opts=optional] .... GET /admin/clusters/{cluster}/nodes .... - -// markup not found, no include::{specDir}paths/get_nodes/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_nodes/operation-description-before.adoc[opts=optional] [#get_nodes-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_nodes/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_nodes/operation-description-begin.adoc[opts=optional] [markdown] -- Returns information about all nodes in the specified cluster. -- - -// markup not found, no include::{specDir}paths/get_nodes/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_nodes/operation-description-end.adoc[opts=optional] @@ -2277,23 +1909,20 @@ Returns information about all nodes in the specified cluster. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_nodes/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_nodes/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_nodes/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_nodes/operation-parameters-before.adoc[opts=optional] [#get_nodes-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_nodes/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/get_nodes/operation-parameters-begin.adoc[opts=optional] [#get_nodes-path] .Path Parameters @@ -2304,11 +1933,8 @@ Returns information about all nodes in the specified cluster. ¦ Name ¦ Description ¦ Schema a¦ *cluster* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a cluster. -- @@ -2321,30 +1947,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/get_nodes/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/get_nodes/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_nodes/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_nodes/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_nodes/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/get_nodes/operation-responses-before.adoc[opts=optional] [#get_nodes-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_nodes/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_nodes/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2355,88 +1975,71 @@ a| [markdown] -- An array of objects, each of which gives information about one node. -- -a| xref:Nodes[] - array - +a| xref:Nodes[] array |=== - -// markup not found, no include::{specDir}paths/get_nodes/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_nodes/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Nodes: -// markup not found, no include::{specDir}paths/get_nodes/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_nodes/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_nodes/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_nodes/operation-security-before.adoc[opts=optional] [#get_nodes-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_nodes/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_nodes/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_nodes/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_nodes/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/get_nodes/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_nodes/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}get_nodes/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}get_nodes/http-response.adoc[opts=optional] - +include::{snippetDir}get_nodes/http-request.adoc[opts=optional] +include::{snippetDir}get_nodes/http-response.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_nodes/operation-end.adoc[opts=optional] +include::{specDir}paths/get_nodes/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_nodes/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_nodes/operation-after.adoc[opts=optional] //end::get_nodes[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Default] = Default :leveloffset: +1 -ifeval::["Other operations." != ""] Other operations. endif::[] -ifeval::["Other operations." == ""] -**{toc-title}** -endif::[] -endif::[] + [%hardbreaks] xref:get_gc[] @@ -2444,36 +2047,31 @@ xref:get_ping[] xref:post_gc[] -//tag::get_gc[] - -// markup not found, no include::{specDir}paths/get_gc/operation-before.adoc[opts=optional] +//tag::get_gc[] +include::{specDir}paths/get_gc/operation-before.adoc[opts=optional] [#get_gc] = Run Garbage Collector :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_gc/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_gc/operation-begin.adoc[opts=optional] .... GET /admin/gc .... - -// markup not found, no include::{specDir}paths/get_gc/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_gc/operation-description-before.adoc[opts=optional] [#get_gc-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_gc/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_gc/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -2482,8 +2080,7 @@ Runs the garbage collector. A message is written to `query.log` whenever the garbage collector endpoint is invoked. -- - -// markup not found, no include::{specDir}paths/get_gc/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_gc/operation-description-end.adoc[opts=optional] @@ -2491,33 +2088,29 @@ A message is written to `query.log` whenever the garbage collector endpoint is i .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_gc/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_gc/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_gc/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_gc/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_gc/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_gc/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_gc/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_gc/operation-responses-before.adoc[opts=optional] [#get_gc-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_gc/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_gc/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2537,106 +2130,86 @@ Error 10000: authentication failure. The invoking user is not a valid full-admin -- a| Object - |=== - -// markup not found, no include::{specDir}paths/get_gc/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_gc/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Garbage: -// markup not found, no include::{specDir}paths/get_gc/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_gc/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_gc/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_gc/operation-security-before.adoc[opts=optional] [#get_gc-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_gc/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_gc/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_gc/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_gc/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/get_gc/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_gc/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}get_gc/http-request.adoc[opts=optional] - +include::{snippetDir}get_gc/http-request.adoc[opts=optional] include::{snippetDir}get_gc/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_gc/operation-end.adoc[opts=optional] +include::{specDir}paths/get_gc/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_gc/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_gc/operation-after.adoc[opts=optional] //end::get_gc[] - //tag::get_ping[] - -// markup not found, no include::{specDir}paths/get_ping/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_ping/operation-before.adoc[opts=optional] [#get_ping] = Ping :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_ping/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_ping/operation-begin.adoc[opts=optional] .... GET /admin/ping .... - -// markup not found, no include::{specDir}paths/get_ping/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_ping/operation-description-before.adoc[opts=optional] [#get_ping-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_ping/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_ping/operation-description-begin.adoc[opts=optional] [markdown] -- Returns a minimal response, indicating that the service is running and reachable. -- - -// markup not found, no include::{specDir}paths/get_ping/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_ping/operation-description-end.adoc[opts=optional] @@ -2644,33 +2217,29 @@ Returns a minimal response, indicating that the service is running and reachable .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_ping/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_ping/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_ping/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_ping/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_ping/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_ping/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_ping/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_ping/operation-responses-before.adoc[opts=optional] [#get_ping-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_ping/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_ping/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2683,79 +2252,60 @@ An empty object. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/get_ping/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_ping/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_ping/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_ping/operation-responses-after.adoc[opts=optional] include::{specDir}paths/get_ping/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_ping/operation-security-after.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_ping/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}get_ping/http-request.adoc[opts=optional] - +include::{snippetDir}get_ping/http-request.adoc[opts=optional] include::{snippetDir}get_ping/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_ping/operation-end.adoc[opts=optional] +include::{specDir}paths/get_ping/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_ping/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_ping/operation-after.adoc[opts=optional] //end::get_ping[] - //tag::post_gc[] - -// markup not found, no include::{specDir}paths/post_gc/operation-before.adoc[opts=optional] - +include::{specDir}paths/post_gc/operation-before.adoc[opts=optional] [#post_gc] = Run Garbage Collector and Release Memory :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_gc/operation-begin.adoc[opts=optional] - +include::{specDir}paths/post_gc/operation-begin.adoc[opts=optional] .... POST /admin/gc .... - -// markup not found, no include::{specDir}paths/post_gc/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/post_gc/operation-description-before.adoc[opts=optional] [#post_gc-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_gc/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/post_gc/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -2764,8 +2314,7 @@ Run the garbage collector and attempts to return freed memory to the OS. A message is written to `query.log` whenever the garbage collector endpoint is invoked. -- - -// markup not found, no include::{specDir}paths/post_gc/operation-description-end.adoc[opts=optional] +include::{specDir}paths/post_gc/operation-description-end.adoc[opts=optional] @@ -2773,33 +2322,29 @@ A message is written to `query.log` whenever the garbage collector endpoint is i .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/post_gc/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/post_gc/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/post_gc/operation-description-after.adoc[opts=optional] +include::{specDir}paths/post_gc/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_gc/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/post_gc/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_gc/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/post_gc/operation-responses-before.adoc[opts=optional] [#post_gc-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_gc/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/post_gc/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -2819,85 +2364,69 @@ Error 10000: authentication failure. The invoking user is not a valid full-admin -- a| Object - |=== - -// markup not found, no include::{specDir}paths/post_gc/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/post_gc/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Garbage: -// markup not found, no include::{specDir}paths/post_gc/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/post_gc/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_gc/operation-security-before.adoc[opts=optional] +include::{specDir}paths/post_gc/operation-security-before.adoc[opts=optional] [#post_gc-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_gc/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/post_gc/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/post_gc/operation-security-end.adoc[opts=optional] +include::{specDir}paths/post_gc/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/post_gc/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_gc/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}post_gc/http-request.adoc[opts=optional] - +include::{snippetDir}post_gc/http-request.adoc[opts=optional] include::{snippetDir}post_gc/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/post_gc/operation-end.adoc[opts=optional] +include::{specDir}paths/post_gc/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_gc/operation-after.adoc[opts=optional] - +include::{specDir}paths/post_gc/operation-after.adoc[opts=optional] //end::post_gc[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-PreparedStatements] = Prepared Statements :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:delete_prepared[] @@ -2906,44 +2435,38 @@ xref:get_prepared_indexes[] xref:get_prepareds[] -//tag::delete_prepared[] - -// markup not found, no include::{specDir}paths/delete_prepared/operation-before.adoc[opts=optional] +//tag::delete_prepared[] +include::{specDir}paths/delete_prepared/operation-before.adoc[opts=optional] [#delete_prepared] = Delete a Prepared Statement :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_prepared/operation-begin.adoc[opts=optional] - +include::{specDir}paths/delete_prepared/operation-begin.adoc[opts=optional] .... DELETE /admin/prepareds/{name} .... - -// markup not found, no include::{specDir}paths/delete_prepared/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/delete_prepared/operation-description-before.adoc[opts=optional] [#delete_prepared-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_prepared/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/delete_prepared/operation-description-begin.adoc[opts=optional] [markdown] -- Deletes the specified prepared statement. -- - -// markup not found, no include::{specDir}paths/delete_prepared/operation-description-end.adoc[opts=optional] +include::{specDir}paths/delete_prepared/operation-description-end.adoc[opts=optional] @@ -2951,23 +2474,20 @@ Deletes the specified prepared statement. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/delete_prepared/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/delete_prepared/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_prepared/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/delete_prepared/operation-parameters-before.adoc[opts=optional] [#delete_prepared-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_prepared/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/delete_prepared/operation-parameters-begin.adoc[opts=optional] [#delete_prepared-path] .Path Parameters @@ -2978,11 +2498,8 @@ Deletes the specified prepared statement. ¦ Name ¦ Description ¦ Schema a¦ *name* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a prepared statement. This may be a UUID that was assigned automatically, or a name that was user-specified when the statement was created. @@ -2996,30 +2513,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/delete_prepared/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/delete_prepared/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/delete_prepared/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/delete_prepared/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_prepared/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/delete_prepared/operation-responses-before.adoc[opts=optional] [#delete_prepared-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_prepared/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/delete_prepared/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3031,6 +2542,7 @@ a| [markdown] The prepared statement was successfully deleted. -- a| + | 500 a| [markdown] -- @@ -3038,106 +2550,85 @@ Returns an error message if the prepared statement could not be found. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/delete_prepared/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/delete_prepared/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/delete_prepared/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/delete_prepared/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_prepared/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/delete_prepared/operation-security-before.adoc[opts=optional] [#delete_prepared-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_prepared/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/delete_prepared/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/delete_prepared/operation-security-end.adoc[opts=optional] +include::{specDir}paths/delete_prepared/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/delete_prepared/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/delete_prepared/operation-security-after.adoc[opts=optional] include::{snippetDir}delete_prepared/http-request.adoc[opts=optional] +include::{snippetDir}delete_prepared/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}delete_prepared/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/delete_prepared/operation-end.adoc[opts=optional] +include::{specDir}paths/delete_prepared/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/delete_prepared/operation-after.adoc[opts=optional] - +include::{specDir}paths/delete_prepared/operation-after.adoc[opts=optional] //end::delete_prepared[] - //tag::get_prepared[] - -// markup not found, no include::{specDir}paths/get_prepared/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_prepared/operation-before.adoc[opts=optional] [#get_prepared] = Retrieve a Prepared Statement :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_prepared/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_prepared/operation-begin.adoc[opts=optional] .... GET /admin/prepareds/{name} .... - -// markup not found, no include::{specDir}paths/get_prepared/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_prepared/operation-description-before.adoc[opts=optional] [#get_prepared-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_prepared/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_prepared/operation-description-begin.adoc[opts=optional] [markdown] -- Returns the specified prepared statement. -- - -// markup not found, no include::{specDir}paths/get_prepared/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_prepared/operation-description-end.adoc[opts=optional] @@ -3145,23 +2636,20 @@ Returns the specified prepared statement. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_prepared/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_prepared/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_prepared/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_prepared/operation-parameters-before.adoc[opts=optional] [#get_prepared-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_prepared/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/get_prepared/operation-parameters-begin.adoc[opts=optional] [#get_prepared-path] .Path Parameters @@ -3172,11 +2660,8 @@ Returns the specified prepared statement. ¦ Name ¦ Description ¦ Schema a¦ *name* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a prepared statement. This may be a UUID that was assigned automatically, or a name that was user-specified when the statement was created. @@ -3190,30 +2675,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/get_prepared/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/get_prepared/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_prepared/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_prepared/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_prepared/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/get_prepared/operation-responses-before.adoc[opts=optional] [#get_prepared-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_prepared/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_prepared/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3226,98 +2705,79 @@ An object containing information about the specified prepared statement. -- a| xref:Statements[] - |=== - -// markup not found, no include::{specDir}paths/get_prepared/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_prepared/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Statements: -// markup not found, no include::{specDir}paths/get_prepared/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_prepared/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_prepared/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_prepared/operation-security-before.adoc[opts=optional] [#get_prepared-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_prepared/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_prepared/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_prepared/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_prepared/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_prepared/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_prepared/operation-security-after.adoc[opts=optional] include::{snippetDir}get_prepared/http-request.adoc[opts=optional] +include::{snippetDir}get_prepared/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}get_prepared/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_prepared/operation-end.adoc[opts=optional] +include::{specDir}paths/get_prepared/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_prepared/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_prepared/operation-after.adoc[opts=optional] //end::get_prepared[] - //tag::get_prepared_indexes[] - -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_prepared_indexes/operation-before.adoc[opts=optional] [#get_prepared_indexes] = Retrieve Prepared Index Statements :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_prepared_indexes/operation-begin.adoc[opts=optional] .... GET /admin/indexes/prepareds .... - -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_prepared_indexes/operation-description-before.adoc[opts=optional] [#get_prepared_indexes-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_prepared_indexes/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -3327,8 +2787,7 @@ Returns all prepared index statements. * Use [Delete a Prepared Statement](#delete_prepared) to delete a prepared index statement. -- - -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_prepared_indexes/operation-description-end.adoc[opts=optional] @@ -3336,33 +2795,29 @@ Returns all prepared index statements. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_prepared_indexes/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_prepared_indexes/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_prepared_indexes/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_prepared_indexes/operation-responses-before.adoc[opts=optional] [#get_prepared_indexes-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_prepared_indexes/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3373,109 +2828,87 @@ a| [markdown] -- An array of strings, each of which is the name of a prepared index statement. -- -a| String - array - +a| String array |=== - -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_prepared_indexes/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_prepared_indexes/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_prepared_indexes/operation-security-before.adoc[opts=optional] [#get_prepared_indexes-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_prepared_indexes/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_prepared_indexes/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/get_prepared_indexes/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}get_prepared_indexes/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}get_prepared_indexes/http-response.adoc[opts=optional] - +include::{snippetDir}get_prepared_indexes/http-request.adoc[opts=optional] +include::{snippetDir}get_prepared_indexes/http-response.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-end.adoc[opts=optional] +include::{specDir}paths/get_prepared_indexes/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_prepared_indexes/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_prepared_indexes/operation-after.adoc[opts=optional] //end::get_prepared_indexes[] - //tag::get_prepareds[] - -// markup not found, no include::{specDir}paths/get_prepareds/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_prepareds/operation-before.adoc[opts=optional] [#get_prepareds] = Retrieve All Prepared Statements :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_prepareds/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_prepareds/operation-begin.adoc[opts=optional] .... GET /admin/prepareds .... - -// markup not found, no include::{specDir}paths/get_prepareds/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_prepareds/operation-description-before.adoc[opts=optional] [#get_prepareds-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_prepareds/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_prepareds/operation-description-begin.adoc[opts=optional] [markdown] -- Returns all prepared statements. -- - -// markup not found, no include::{specDir}paths/get_prepareds/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_prepareds/operation-description-end.adoc[opts=optional] @@ -3483,33 +2916,29 @@ Returns all prepared statements. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_prepareds/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_prepareds/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_prepareds/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_prepareds/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_prepareds/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_prepareds/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_prepareds/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_prepareds/operation-responses-before.adoc[opts=optional] [#get_prepareds-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_prepareds/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_prepareds/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3520,132 +2949,109 @@ a| [markdown] -- An array of objects, each of which contains information about one prepared statement. -- -a| xref:Statements[] - array - +a| xref:Statements[] array |=== - -// markup not found, no include::{specDir}paths/get_prepareds/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_prepareds/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Statements: -// markup not found, no include::{specDir}paths/get_prepareds/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_prepareds/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_prepareds/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_prepareds/operation-security-before.adoc[opts=optional] [#get_prepareds-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_prepareds/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_prepareds/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_prepareds/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_prepareds/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_prepareds/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_prepareds/operation-security-after.adoc[opts=optional] include::{snippetDir}get_prepareds/http-request.adoc[opts=optional] +include::{snippetDir}get_prepareds/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}get_prepareds/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_prepareds/operation-end.adoc[opts=optional] +include::{specDir}paths/get_prepareds/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_prepareds/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_prepareds/operation-after.adoc[opts=optional] //end::get_prepareds[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Settings] = Settings :leveloffset: +1 -ifeval::["Operations for query settings." != ""] Operations for query settings. endif::[] -ifeval::["Operations for query settings." == ""] -**{toc-title}** -endif::[] -endif::[] + [%hardbreaks] xref:get_settings[] xref:post_settings[] -//tag::get_settings[] - -// markup not found, no include::{specDir}paths/get_settings/operation-before.adoc[opts=optional] +//tag::get_settings[] +include::{specDir}paths/get_settings/operation-before.adoc[opts=optional] [#get_settings] = Retrieve Node-Level Query Settings :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-begin.adoc[opts=optional] .... GET /admin/settings .... - -// markup not found, no include::{specDir}paths/get_settings/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-description-before.adoc[opts=optional] [#get_settings-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-description-begin.adoc[opts=optional] [markdown] -- Returns node-level query settings. -- - -// markup not found, no include::{specDir}paths/get_settings/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-description-end.adoc[opts=optional] @@ -3653,33 +3059,29 @@ Returns node-level query settings. .Produces * application/json -:leveloffset: -1 +:leveloffset: -1 include::{specDir}paths/get_settings/operation-description-after.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/get_settings/operation-parameters-before.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_settings/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_settings/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-responses-before.adoc[opts=optional] [#get_settings-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3692,106 +3094,86 @@ An object giving node-level query settings. -- a| xref:Settings[] - |=== - -// markup not found, no include::{specDir}paths/get_settings/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Settings: -// markup not found, no include::{specDir}paths/get_settings/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_settings/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-security-before.adoc[opts=optional] [#get_settings-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_settings/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional] - +include::{snippetDir}get_settings/http-request.adoc[opts=optional] +include::{snippetDir}get_settings/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}get_settings/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}get_settings/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_settings/operation-end.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_settings/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-after.adoc[opts=optional] //end::get_settings[] - //tag::post_settings[] - -// markup not found, no include::{specDir}paths/post_settings/operation-before.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-before.adoc[opts=optional] [#post_settings] = Update Node-Level Query Settings :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-begin.adoc[opts=optional] .... POST /admin/settings .... - -// markup not found, no include::{specDir}paths/post_settings/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-description-before.adoc[opts=optional] [#post_settings-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-description-begin.adoc[opts=optional] [markdown] -- Updates node-level query settings. -- - -// markup not found, no include::{specDir}paths/post_settings/operation-description-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-description-end.adoc[opts=optional] [#post_settings-consumes] @@ -3803,27 +3185,20 @@ Updates node-level query settings. .Produces * application/json -:leveloffset: -1 +:leveloffset: -1 include::{specDir}paths/post_settings/operation-description-after.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-before.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-parameters-before.adoc[opts=optional] [#post_settings-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-begin.adoc[opts=optional] - - - - - +include::{specDir}paths/post_settings/operation-parameters-begin.adoc[opts=optional] [#post_settings-body] .Body Parameter @@ -3834,13 +3209,10 @@ include::{specDir}paths/post_settings/operation-description-after.adoc[opts=opti ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- -An object specifying node-level query settings. + -- [%hardbreaks] @@ -3851,26 +3223,25 @@ a¦ xref:Settings[] |=== -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Settings: -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_settings/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-responses-before.adoc[opts=optional] [#post_settings-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -3883,85 +3254,69 @@ An object giving node-level query settings, including the latest changes. -- a| xref:Settings[] - |=== - -// markup not found, no include::{specDir}paths/post_settings/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Settings: -// markup not found, no include::{specDir}paths/post_settings/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_settings/operation-security-before.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-security-before.adoc[opts=optional] [#post_settings-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/post_settings/operation-security-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}post_settings/http-request.adoc[opts=optional] - +include::{snippetDir}post_settings/http-request.adoc[opts=optional] -// markup not found, no include::{snippetDir}post_settings/http-response.adoc[opts=optional] +include::{snippetDir}post_settings/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/post_settings/operation-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_settings/operation-after.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-after.adoc[opts=optional] //end::post_settings[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] - -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Statistics] = Statistics :leveloffset: +1 -ifeval::["Operations for query statistics." != ""] Operations for query statistics. endif::[] -ifeval::["Operations for query statistics." == ""] -**{toc-title}** -endif::[] -endif::[] + [%hardbreaks] xref:get_debug_vars[] @@ -3970,44 +3325,38 @@ xref:get_stats[] xref:get_vitals[] -//tag::get_debug_vars[] - -// markup not found, no include::{specDir}paths/get_debug_vars/operation-before.adoc[opts=optional] +//tag::get_debug_vars[] +include::{specDir}paths/get_debug_vars/operation-before.adoc[opts=optional] [#get_debug_vars] = Get Debug Variables :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_debug_vars/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_debug_vars/operation-begin.adoc[opts=optional] .... GET /debug/vars .... - -// markup not found, no include::{specDir}paths/get_debug_vars/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_debug_vars/operation-description-before.adoc[opts=optional] [#get_debug_vars-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_debug_vars/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_debug_vars/operation-description-begin.adoc[opts=optional] [markdown] -- Currently unused. -- - -// markup not found, no include::{specDir}paths/get_debug_vars/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_debug_vars/operation-description-end.adoc[opts=optional] @@ -4015,33 +3364,29 @@ Currently unused. .Produces * text/html -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_debug_vars/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_debug_vars/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_debug_vars/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_debug_vars/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_debug_vars/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_debug_vars/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_debug_vars/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_debug_vars/operation-responses-before.adoc[opts=optional] [#get_debug_vars-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_debug_vars/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_debug_vars/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -4054,87 +3399,67 @@ Redirects to the [Retrieve All Statistics](#get_stats) endpoint. -- a| String (text/html) - |=== - -// markup not found, no include::{specDir}paths/get_debug_vars/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_debug_vars/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_debug_vars/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_debug_vars/operation-responses-after.adoc[opts=optional] include::{specDir}paths/get_debug_vars/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_debug_vars/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_debug_vars/http-request.adoc[opts=optional] +include::{snippetDir}get_debug_vars/http-response.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_debug_vars/operation-security-after.adoc[opts=optional] - +include::{specDir}paths/get_debug_vars/operation-end.adoc[opts=optional] +:leveloffset: -1 -// markup not found, no include::{snippetDir}get_debug_vars/http-request.adoc[opts=optional] +include::{specDir}paths/get_debug_vars/operation-after.adoc[opts=optional] +//end::get_debug_vars[] -include::{snippetDir}get_debug_vars/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_debug_vars/operation-end.adoc[opts=optional] - -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_debug_vars/operation-after.adoc[opts=optional] - - -//end::get_debug_vars[] - - -//tag::get_stat[] - - -// markup not found, no include::{specDir}paths/get_stat/operation-before.adoc[opts=optional] +//tag::get_stat[] +include::{specDir}paths/get_stat/operation-before.adoc[opts=optional] [#get_stat] = Retrieve a Statistic :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_stat/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_stat/operation-begin.adoc[opts=optional] .... GET /admin/stats/{stat} .... - -// markup not found, no include::{specDir}paths/get_stat/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_stat/operation-description-before.adoc[opts=optional] [#get_stat-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_stat/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_stat/operation-description-begin.adoc[opts=optional] [markdown] -- Returns the specified statistic. -- - -// markup not found, no include::{specDir}paths/get_stat/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_stat/operation-description-end.adoc[opts=optional] @@ -4142,23 +3467,20 @@ Returns the specified statistic. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_stat/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_stat/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_stat/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_stat/operation-parameters-before.adoc[opts=optional] [#get_stat-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_stat/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/get_stat/operation-parameters-begin.adoc[opts=optional] [#get_stat-path] .Path Parameters @@ -4169,11 +3491,8 @@ Returns the specified statistic. ¦ Name ¦ Description ¦ Schema a¦ *stat* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a statistic. Only top-level statistic names can be used. @@ -4189,30 +3508,24 @@ a¦ String |=== - - - - -// markup not found, no include::{specDir}paths/get_stat/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/get_stat/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_stat/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/get_stat/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_stat/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_stat/operation-responses-before.adoc[opts=optional] [#get_stat-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_stat/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_stat/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -4225,106 +3538,86 @@ An object containing all metrics for the specified statistic. Each statistic has -- a| xref:Metrics[] - |=== - -// markup not found, no include::{specDir}paths/get_stat/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_stat/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Metrics: -// markup not found, no include::{specDir}paths/get_stat/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_stat/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_stat/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_stat/operation-security-before.adoc[opts=optional] [#get_stat-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_stat/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_stat/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_stat/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_stat/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/get_stat/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_stat/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_stat/http-request.adoc[opts=optional] +include::{snippetDir}get_stat/http-response.adoc[opts=optional] - -// markup not found, no include::{snippetDir}get_stat/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}get_stat/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_stat/operation-end.adoc[opts=optional] +include::{specDir}paths/get_stat/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_stat/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_stat/operation-after.adoc[opts=optional] //end::get_stat[] - //tag::get_stats[] - -// markup not found, no include::{specDir}paths/get_stats/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_stats/operation-before.adoc[opts=optional] [#get_stats] = Retrieve All Statistics :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_stats/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_stats/operation-begin.adoc[opts=optional] .... GET /admin/stats .... - -// markup not found, no include::{specDir}paths/get_stats/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_stats/operation-description-before.adoc[opts=optional] [#get_stats-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_stats/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_stats/operation-description-begin.adoc[opts=optional] [markdown] -- Returns all statistics. -- - -// markup not found, no include::{specDir}paths/get_stats/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_stats/operation-description-end.adoc[opts=optional] @@ -4332,33 +3625,29 @@ Returns all statistics. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_stats/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_stats/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_stats/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_stats/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_stats/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_stats/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_stats/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_stats/operation-responses-before.adoc[opts=optional] [#get_stats-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_stats/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_stats/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -4371,98 +3660,79 @@ An object containing all statistics. Each statistic consists of a top-level stat -- a| xref:Statistics[] - |=== - -// markup not found, no include::{specDir}paths/get_stats/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_stats/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Statistics: -// markup not found, no include::{specDir}paths/get_stats/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/get_stats/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_stats/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/get_stats/operation-security-before.adoc[opts=optional] [#get_stats-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_stats/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_stats/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_stats/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_stats/operation-security-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/get_stats/operation-security-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_stats/operation-security-after.adoc[opts=optional] - - - -// markup not found, no include::{snippetDir}get_stats/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}get_stats/http-response.adoc[opts=optional] +include::{snippetDir}get_stats/http-request.adoc[opts=optional] +include::{snippetDir}get_stats/http-response.adoc[opts=optional] - -// markup not found, no include::{specDir}paths/get_stats/operation-end.adoc[opts=optional] +include::{specDir}paths/get_stats/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_stats/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_stats/operation-after.adoc[opts=optional] //end::get_stats[] - //tag::get_vitals[] - -// markup not found, no include::{specDir}paths/get_vitals/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_vitals/operation-before.adoc[opts=optional] [#get_vitals] = Retrieve Vitals :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_vitals/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_vitals/operation-begin.adoc[opts=optional] .... GET /admin/vitals .... - -// markup not found, no include::{specDir}paths/get_vitals/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_vitals/operation-description-before.adoc[opts=optional] [#get_vitals-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_vitals/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_vitals/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -4470,8 +3740,7 @@ Returns data about the running state and health of the query engine. This information can be very useful to assess the current workload and performance characteristics of a query engine, and hence load-balance the requests being sent to various query engines. -- - -// markup not found, no include::{specDir}paths/get_vitals/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_vitals/operation-description-end.adoc[opts=optional] @@ -4479,33 +3748,29 @@ This information can be very useful to assess the current workload and performan .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_vitals/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_vitals/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_vitals/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_vitals/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_vitals/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_vitals/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_vitals/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_vitals/operation-responses-before.adoc[opts=optional] [#get_vitals-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_vitals/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_vitals/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -4518,102 +3783,86 @@ An object containing all vital statistics. -- a| xref:Vitals[] - |=== - -// markup not found, no include::{specDir}paths/get_vitals/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_vitals/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Vitals: -// markup not found, no include::{specDir}paths/get_vitals/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_vitals/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_vitals/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_vitals/operation-security-before.adoc[opts=optional] [#get_vitals-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_vitals/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_vitals/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_vitals/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_vitals/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_vitals/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_vitals/operation-security-after.adoc[opts=optional] include::{snippetDir}get_vitals/http-request.adoc[opts=optional] +include::{snippetDir}get_vitals/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}get_vitals/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_vitals/operation-end.adoc[opts=optional] +include::{specDir}paths/get_vitals/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_vitals/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_vitals/operation-after.adoc[opts=optional] //end::get_vitals[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] +include::{specDir}paths/document-after.adoc[opts=optional] - -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] - +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 12 - +:count-models: 11 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:Clusters[] xref:Garbage[] @@ -4630,19 +3879,21 @@ xref:Vitals[] endif::[] +include::{specDir}definitions/Clusters/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/Clusters/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Clusters[] [#Clusters] +endif::show-Clusters[] +ifndef::show-Clusters[] +:leveloffset: +1 + +[discrete#Clusters] +endif::show-Clusters[] = Cluster Information :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Clusters/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Clusters/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -4650,17 +3901,13 @@ endif::collapse-models[] //tag::Clusters[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*name* + -_optional_ -a¦ - -[markdown] +a¦ *name* + +optional +a¦ [markdown] -- The name of the cluster. -- @@ -4668,13 +3915,9 @@ The name of the cluster. [%hardbreaks] {blank} a¦ String - -a¦ -*datastore* + -_optional_ -a¦ - -[markdown] +a¦ *datastore* + +optional +a¦ [markdown] -- The URL of the datastore. -- @@ -4682,13 +3925,9 @@ The URL of the datastore. [%hardbreaks] {blank} a¦ String - -a¦ -*configstore* + -_optional_ -a¦ - -[markdown] +a¦ *configstore* + +optional +a¦ [markdown] -- The URL of the configstore. -- @@ -4696,13 +3935,9 @@ The URL of the configstore. [%hardbreaks] {blank} a¦ String - -a¦ -*accountstore* + -_optional_ -a¦ - -[markdown] +a¦ *accountstore* + +optional +a¦ [markdown] -- The URL of the accountstore. -- @@ -4710,14 +3945,11 @@ The URL of the accountstore. [%hardbreaks] {blank} a¦ String - -a¦ -*version* + -_optional_ -a¦ - -[markdown] +a¦ *version* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -4730,28 +3962,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/Clusters/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Clusters/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Clusters/definition-after.adoc[opts=optional] - - - +ifndef::show-Clusters[] +:leveloffset: -1 +endif::show-Clusters[] -// markup not found, no include::{specDir}definitions/Garbage/definition-before.adoc[opts=optional] +include::{specDir}definitions/Clusters/definition-after.adoc[opts=optional] +include::{specDir}definitions/Garbage/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Garbage[] [#Garbage] +endif::show-Garbage[] +ifndef::show-Garbage[] +:leveloffset: +1 + +[discrete#Garbage] +endif::show-Garbage[] = Garbage Collection :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Garbage/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Garbage/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -4759,17 +3994,13 @@ endif::collapse-models[] //tag::Garbage[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*freed* + -_required_ -a¦ - -[markdown] +a¦ *freed* + +required +a¦ [markdown] -- The amount of memory freed. -- @@ -4777,13 +4008,9 @@ The amount of memory freed. [%hardbreaks] {blank} a¦ Integer - -a¦ -*released* + -_optional_ -a¦ - -[markdown] +a¦ *released* + +optional +a¦ [markdown] -- Only returned by the POST method. The amount of memory released to the OS. @@ -4792,13 +4019,9 @@ The amount of memory released to the OS. [%hardbreaks] {blank} a¦ Integer - -a¦ -*status* + -_required_ -a¦ - -[markdown] +a¦ *status* + +required +a¦ [markdown] -- The status of the garbage collector. -- @@ -4813,34 +4036,27 @@ a¦ String -// markup not found, no include::{specDir}definitions/Garbage/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Garbage/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Garbage/definition-after.adoc[opts=optional] - - - +ifndef::show-Garbage[] +:leveloffset: -1 +endif::show-Garbage[] -// markup not found, no include::{specDir}definitions/Logging_Parameters/definition-before.adoc[opts=optional] +include::{specDir}definitions/Garbage/definition-after.adoc[opts=optional] +include::{specDir}definitions/Logging_Parameters/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Logging_Parameters[] [#Logging_Parameters] -= Logging Parameters - +endif::show-Logging_Parameters[] +ifndef::show-Logging_Parameters[] :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Logging_Parameters/definition-begin.adoc[opts=optional] - - -.icon:brackets-curly[fw] Object -{blank} - -//tag::Logging_Parameters[] +[discrete#Logging_Parameters] +endif::show-Logging_Parameters[] += Logging Parameters ifdef::model-descriptions[] //tag::desc-Logging_Parameters[] @@ -4853,32 +4069,36 @@ Refer to [Configure Completed Requests][sys-completed-config] for more informati //end::desc-Logging_Parameters[] endif::model-descriptions[] +:leveloffset: +1 + +include::{specDir}definitions/Logging_Parameters/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::Logging_Parameters[] + [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*aborted* + -_optional_ -a¦ - -[markdown] +a¦ *aborted* + +optional +a¦ [markdown] -- If true, all requests that generate a panic are logged. -- [%hardbreaks] *Default:* `null` +*Nullable:* yes *Example:* `true` {blank} a¦ Boolean - -a¦ -*client* + -_optional_ -a¦ - -[markdown] +a¦ *client* + +optional +a¦ [markdown] -- The IP address of the client. If specified, all completed requests from this IP address are logged. @@ -4889,13 +4109,9 @@ If specified, all completed requests from this IP address are logged. *Example:* `+++"172.1.2.3"+++` {blank} a¦ String - -a¦ -*context* + -_optional_ -a¦ - -[markdown] +a¦ *context* + +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [client_context_id]: #client_context_id @@ -4914,13 +4130,9 @@ Refer to the [request-level][client_context_id] `client_context_id` parameter fo [%hardbreaks] {blank} a¦ String - -a¦ -*error* + -_optional_ -a¦ - -[markdown] +a¦ *error* + +optional +a¦ [markdown] -- An error number. If specified, all completed queries returning this error number are logged. @@ -4928,16 +4140,13 @@ If specified, all completed queries returning this error number are logged. [%hardbreaks] *Default:* `null` +*Nullable:* yes *Example:* `12003` {blank} a¦ Integer (int32) - -a¦ -*tag* + -_optional_ -a¦ - -[markdown] +a¦ *tag* + +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config @@ -4955,13 +4164,9 @@ Refer to [Configure Completed Requests][sys-completed-config] for more informati *Example:* `+++"both_user_and_error"+++` {blank} a¦ String - -a¦ -*threshold* + -_optional_ -a¦ - -[markdown] +a¦ *threshold* + +optional +a¦ [markdown] -- A duration in milliseconds. If specified, all completed queries lasting longer than this threshold are logged. @@ -4974,13 +4179,9 @@ This is another way of specifying the `completed-threshold` setting. *Example:* `7000` {blank} a¦ Integer (int32) - -a¦ -*user* + -_optional_ -a¦ - -[markdown] +a¦ *user* + +optional +a¦ [markdown] -- A user name, as given in the request credentials. If specified, all completed queries with this user name are logged. @@ -4991,13 +4192,9 @@ If specified, all completed queries with this user name are logged. *Example:* `+++"marco"+++` {blank} a¦ String - -a¦ -*statement* + -_optional_ -a¦ - -[markdown] +a¦ *statement* + +optional +a¦ [markdown] -- A LIKE search pattern to match against the query text. If specified, all completed queries where the pattern is found are logged. @@ -5008,13 +4205,9 @@ If specified, all completed queries where the pattern is found are logged. *Example:* `+++"%FIND USER%"+++` {blank} a¦ String - -a¦ -*plan* + -_optional_ -a¦ - -[markdown] +a¦ *plan* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-Logging_Parameters_Plan, opts=optional] -- @@ -5022,13 +4215,9 @@ include::index.adoc[tag=desc-Logging_Parameters_Plan, opts=optional] [%hardbreaks] {blank} a¦ xref:Logging_Parameters_Plan[] - -a¦ -*errors* + -_optional_ -a¦ - -[markdown] +a¦ *errors* + +optional +a¦ [markdown] -- The number of errors. If specified, all completed queries that return at least this many errors are logged. @@ -5046,34 +4235,27 @@ a¦ Integer (int32) -// markup not found, no include::{specDir}definitions/Logging_Parameters/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Logging_Parameters/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Logging_Parameters/definition-after.adoc[opts=optional] - - - +ifndef::show-Logging_Parameters[] +:leveloffset: -1 +endif::show-Logging_Parameters[] -// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan/definition-before.adoc[opts=optional] +include::{specDir}definitions/Logging_Parameters/definition-after.adoc[opts=optional] +include::{specDir}definitions/Logging_Parameters_Plan/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Logging_Parameters_Plan[] [#Logging_Parameters_Plan] -= Plan Qualifier - +endif::show-Logging_Parameters_Plan[] +ifndef::show-Logging_Parameters_Plan[] :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan/definition-begin.adoc[opts=optional] - - -.icon:bars[fw] Composite Schema -{blank} - -//tag::Logging_Parameters_Plan[] +[discrete#Logging_Parameters_Plan] +endif::show-Logging_Parameters_Plan[] += Plan Qualifier ifdef::model-descriptions[] //tag::desc-Logging_Parameters_Plan[] @@ -5083,14 +4265,20 @@ All completed queries where the specified field:value pairs are found in the pla //end::desc-Logging_Parameters_Plan[] endif::model-descriptions[] +:leveloffset: +1 + +include::{specDir}definitions/Logging_Parameters_Plan/definition-begin.adoc[opts=optional] + +.icon:bars[fw] Composite Schema +{blank} + +//tag::Logging_Parameters_Plan[] [cols="25,55,20",separator=¦] |=== ¦ One{nbsp}of{nbsp}... ¦ ¦ Schema a¦ -a¦ - -[markdown] +a¦ [markdown] -- include::index.adoc[tag=desc-Logging_Parameters_Plan_Pairs, opts=optional] -- @@ -5099,46 +4287,50 @@ include::index.adoc[tag=desc-Logging_Parameters_Plan_Pairs, opts=optional] {blank} a¦ xref:Logging_Parameters_Plan_Pairs[] -a¦ _or_ -a¦ - -[markdown] +a¦ or +a¦ [markdown] -- An array of objects, each containing one or more field:value pairs. -- [%hardbreaks] {blank} -a¦ xref:Logging_Parameters_Plan_Pairs[] - array - +a¦ xref:Logging_Parameters_Plan_Pairs[] array |=== //end::Logging_Parameters_Plan[] - -// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Logging_Parameters_Plan/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan/definition-after.adoc[opts=optional] - - - +ifndef::show-Logging_Parameters_Plan[] +:leveloffset: -1 +endif::show-Logging_Parameters_Plan[] -// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan_Pairs/definition-before.adoc[opts=optional] +include::{specDir}definitions/Logging_Parameters_Plan/definition-after.adoc[opts=optional] +include::{specDir}definitions/Logging_Parameters_Plan_Pairs/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Logging_Parameters_Plan_Pairs[] [#Logging_Parameters_Plan_Pairs] +endif::show-Logging_Parameters_Plan_Pairs[] +ifndef::show-Logging_Parameters_Plan_Pairs[] +:leveloffset: +1 + +[discrete#Logging_Parameters_Plan_Pairs] +endif::show-Logging_Parameters_Plan_Pairs[] = Field:Value Pairs +ifdef::model-descriptions[] +//tag::desc-Logging_Parameters_Plan_Pairs[] +An object containing one or more field:value pairs. +//end::desc-Logging_Parameters_Plan_Pairs[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan_Pairs/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Logging_Parameters_Plan_Pairs/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5146,23 +4338,14 @@ endif::collapse-models[] //tag::Logging_Parameters_Plan_Pairs[] -ifdef::model-descriptions[] -//tag::desc-Logging_Parameters_Plan_Pairs[] -An object containing one or more field:value pairs. -//end::desc-Logging_Parameters_Plan_Pairs[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -** + -_additional + -property_ -a¦ - -[markdown] +a¦ ** + +additional + +property +a¦ [markdown] -- A field:value pair describing a field in the query plan, and the value that the field must have for the request to be logged. The name of the property is the name of the field in the query plan. @@ -5176,6 +4359,7 @@ For example, `[{"index": "ix1"}, {"index": "ix2"}]` specifies that if the query -- [%hardbreaks] +*Nullable:* yes {blank} a¦ Any Type @@ -5185,28 +4369,31 @@ a¦ Any Type -// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan_Pairs/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Logging_Parameters_Plan_Pairs/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan_Pairs/definition-after.adoc[opts=optional] - - - +ifndef::show-Logging_Parameters_Plan_Pairs[] +:leveloffset: -1 +endif::show-Logging_Parameters_Plan_Pairs[] -// markup not found, no include::{specDir}definitions/Metrics/definition-before.adoc[opts=optional] +include::{specDir}definitions/Logging_Parameters_Plan_Pairs/definition-after.adoc[opts=optional] +include::{specDir}definitions/Metrics/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Metrics[] [#Metrics] +endif::show-Metrics[] +ifndef::show-Metrics[] +:leveloffset: +1 + +[discrete#Metrics] +endif::show-Metrics[] = Metrics :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Metrics/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Metrics/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5214,17 +4401,13 @@ endif::collapse-models[] //tag::Metrics[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*count* + -_optional_ -a¦ - -[markdown] +a¦ *count* + +optional +a¦ [markdown] -- A single value that represents the current state. -- @@ -5232,69 +4415,49 @@ A single value that represents the current state. [%hardbreaks] {blank} a¦ Integer - -a¦ -*15m.rate* + -_optional_ -a¦ - -[markdown] +a¦ *15m.rate* + +optional +a¦ [markdown] -- 15-minute exponentially weighted moving average. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*1m.rate* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *1m.rate* + +optional +a¦ [markdown] -- 1-minute exponentially weighted moving average. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*5m.rate* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *5m.rate* + +optional +a¦ [markdown] -- 5-minute exponentially weighted moving average. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*mean.rate* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *mean.rate* + +optional +a¦ [markdown] -- Mean rate since the query service started. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*max* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *max* + +optional +a¦ [markdown] -- The maximum value. -- @@ -5302,41 +4465,29 @@ The maximum value. [%hardbreaks] {blank} a¦ Integer - -a¦ -*mean* + -_optional_ -a¦ - -[markdown] +a¦ *mean* + +optional +a¦ [markdown] -- The mean value. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*median* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *median* + +optional +a¦ [markdown] -- The median value. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*min* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *min* + +optional +a¦ [markdown] -- The minimum value. -- @@ -5344,76 +4495,56 @@ The minimum value. [%hardbreaks] {blank} a¦ Integer - -a¦ -*stddev* + -_optional_ -a¦ - -[markdown] +a¦ *stddev* + +optional +a¦ [markdown] -- The standard deviation. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*75%* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *75%* + +optional +a¦ [markdown] -- The 75th percentile. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*95%* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *95%* + +optional +a¦ [markdown] -- The 95th percentile. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*99%* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *99%* + +optional +a¦ [markdown] -- The 99th percentile. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*99.9%* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *99.9%* + +optional +a¦ [markdown] -- The 99.9th percentile. -- [%hardbreaks] {blank} -a¦ Big Decimal +a¦ BigDecimal |=== @@ -5421,28 +4552,31 @@ a¦ Big Decimal -// markup not found, no include::{specDir}definitions/Metrics/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Metrics/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Metrics/definition-after.adoc[opts=optional] - - - +ifndef::show-Metrics[] +:leveloffset: -1 +endif::show-Metrics[] -// markup not found, no include::{specDir}definitions/Nodes/definition-before.adoc[opts=optional] +include::{specDir}definitions/Metrics/definition-after.adoc[opts=optional] +include::{specDir}definitions/Nodes/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Nodes[] [#Nodes] +endif::show-Nodes[] +ifndef::show-Nodes[] +:leveloffset: +1 + +[discrete#Nodes] +endif::show-Nodes[] = Node Information :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Nodes/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Nodes/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5450,17 +4584,13 @@ endif::collapse-models[] //tag::Nodes[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*cluster* + -_optional_ -a¦ - -[markdown] +a¦ *cluster* + +optional +a¦ [markdown] -- The name of the cluster. -- @@ -5468,13 +4598,9 @@ The name of the cluster. [%hardbreaks] {blank} a¦ String - -a¦ -*name* + -_optional_ -a¦ - -[markdown] +a¦ *name* + +optional +a¦ [markdown] -- The URL of the node, including port number. -- @@ -5482,13 +4608,9 @@ The URL of the node, including port number. [%hardbreaks] {blank} a¦ String - -a¦ -*queryEndpoint* + -_optional_ -a¦ - -[markdown] +a¦ *queryEndpoint* + +optional +a¦ [markdown] -- The HTTP URL of the query endpoint. -- @@ -5496,13 +4618,9 @@ The HTTP URL of the query endpoint. [%hardbreaks] {blank} a¦ String - -a¦ -*adminEndpoint* + -_optional_ -a¦ - -[markdown] +a¦ *adminEndpoint* + +optional +a¦ [markdown] -- The HTTP URL of the admin endpoint. -- @@ -5510,13 +4628,9 @@ The HTTP URL of the admin endpoint. [%hardbreaks] {blank} a¦ String - -a¦ -*querySecure* + -_optional_ -a¦ - -[markdown] +a¦ *querySecure* + +optional +a¦ [markdown] -- The HTTPS URL of the query endpoint. -- @@ -5524,13 +4638,9 @@ The HTTPS URL of the query endpoint. [%hardbreaks] {blank} a¦ String - -a¦ -*adminSecure* + -_optional_ -a¦ - -[markdown] +a¦ *adminSecure* + +optional +a¦ [markdown] -- The HTTPS URL of the admin endpoint. -- @@ -5538,14 +4648,11 @@ The HTTPS URL of the admin endpoint. [%hardbreaks] {blank} a¦ String - -a¦ -*options* + -_optional_ -a¦ - -[markdown] +a¦ *options* + +optional +a¦ [markdown] -- + -- [%hardbreaks] @@ -5558,28 +4665,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/Nodes/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Nodes/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Nodes/definition-after.adoc[opts=optional] - - - +ifndef::show-Nodes[] +:leveloffset: -1 +endif::show-Nodes[] -// markup not found, no include::{specDir}definitions/Requests/definition-before.adoc[opts=optional] +include::{specDir}definitions/Nodes/definition-after.adoc[opts=optional] +include::{specDir}definitions/Requests/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Requests[] [#Requests] +endif::show-Requests[] +ifndef::show-Requests[] +:leveloffset: +1 + +[discrete#Requests] +endif::show-Requests[] = Requests :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Requests/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Requests/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -5587,17 +4697,13 @@ endif::collapse-models[] //tag::Requests[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*clientContextID* + -_optional_ -a¦ - -[markdown] +a¦ *clientContextID* + +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [client_context_id]: query-settings.html#client_context_id @@ -5615,13 +4721,9 @@ Refer to the [request-level][client_context_id] `client_context_id` parameter fo [%hardbreaks] {blank} a¦ String - -a¦ -*cpuTime* + -_optional_ -a¦ - -[markdown] +a¦ *cpuTime* + +optional +a¦ [markdown] -- The total sum of [execTime][exec_time] across all operators. @@ -5632,13 +4734,9 @@ The total sum of [execTime][exec_time] across all operators. *Example:* `+++"90.734075ms"+++` {blank} a¦ String (duration) - -a¦ -*elapsedTime* + -_optional_ -a¦ - -[markdown] +a¦ *elapsedTime* + +optional +a¦ [markdown] -- The time taken from when the request was acknowledged by the service to when the request was completed. It includes the time taken by the service to schedule the request. @@ -5647,13 +4745,9 @@ It includes the time taken by the service to schedule the request. [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*errorCount* + -_optional_ -a¦ - -[markdown] +a¦ *errorCount* + +optional +a¦ [markdown] -- Total number of errors encountered while executing the query. -- @@ -5661,13 +4755,9 @@ Total number of errors encountered while executing the query. [%hardbreaks] {blank} a¦ Integer - -a¦ -*ioTime* + -_optional_ -a¦ - -[markdown] +a¦ *ioTime* + +optional +a¦ [markdown] -- The total sum of [servTime][serv_time] across all operators. @@ -5678,13 +4768,9 @@ The total sum of [servTime][serv_time] across all operators. *Example:* `+++"752.858519ms"+++` {blank} a¦ String (duration) - -a¦ -*memoryQuota* + -_optional_ -a¦ - -[markdown] +a¦ *memoryQuota* + +optional +a¦ [markdown] -- The memory quota for the request, in MB. This property is only returned if a memory quota is set for the query. @@ -5693,13 +4779,9 @@ This property is only returned if a memory quota is set for the query. [%hardbreaks] {blank} a¦ Integer - -a¦ -*node* + -_optional_ -a¦ - -[markdown] +a¦ *node* + +optional +a¦ [markdown] -- IP address and port number of the node where the query is executed. -- @@ -5707,13 +4789,9 @@ IP address and port number of the node where the query is executed. [%hardbreaks] {blank} a¦ String - -a¦ -*phaseCounts* + -_optional_ -a¦ - -[markdown] +a¦ *phaseCounts* + +optional +a¦ [markdown] -- Count of documents processed at selective phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc. @@ -5725,13 +4803,9 @@ Polling the active requests again may return different values. *Example:* `{"fetch":16,"indexScan":187}` {blank} a¦ Object - -a¦ -*phaseOperators* + -_optional_ -a¦ - -[markdown] +a¦ *phaseOperators* + +optional +a¦ [markdown] -- Indicates the numbers of each kind of query operator involved in different phases of the query processing. @@ -5744,13 +4818,9 @@ A union select would have twice as many operator counts, one per each branch of *Example:* `{"authorize":1,"fetch":1,"indexScan":2}` {blank} a¦ Object - -a¦ -*phaseTimes* + -_optional_ -a¦ - -[markdown] +a¦ *phaseTimes* + +optional +a¦ [markdown] -- Cumulative execution times for various phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc. @@ -5762,13 +4832,9 @@ Polling the active requests again may return different values. *Example:* `{"authorize":"823.631µs","fetch":"656.873µs","indexScan":"29.146543ms","instantiate":"236.221µs","parse":"826.382µs","plan":"11.831101ms","run":"16.892181ms"}` {blank} a¦ Object - -a¦ -*remoteAddr* + -_optional_ -a¦ - -[markdown] +a¦ *remoteAddr* + +optional +a¦ [markdown] -- IP address and port number of the client application, from where the query is received. -- @@ -5776,13 +4842,9 @@ IP address and port number of the client application, from where the query is re [%hardbreaks] {blank} a¦ String - -a¦ -*requestId* + -_optional_ -a¦ - -[markdown] +a¦ *requestId* + +optional +a¦ [markdown] -- Unique request ID internally generated for the query. -- @@ -5790,13 +4852,9 @@ Unique request ID internally generated for the query. [%hardbreaks] {blank} a¦ UUID (uuid) - -a¦ -*requestTime* + -_optional_ -a¦ - -[markdown] +a¦ *requestTime* + +optional +a¦ [markdown] -- Timestamp when the query is received. -- @@ -5804,13 +4862,9 @@ Timestamp when the query is received. [%hardbreaks] {blank} a¦ Date (date-time) - -a¦ -*resultCount* + -_optional_ -a¦ - -[markdown] +a¦ *resultCount* + +optional +a¦ [markdown] -- Total number of documents returned in the query result. -- @@ -5818,13 +4872,9 @@ Total number of documents returned in the query result. [%hardbreaks] {blank} a¦ Integer - -a¦ -*resultSize* + -_optional_ -a¦ - -[markdown] +a¦ *resultSize* + +optional +a¦ [markdown] -- Total number of bytes returned in the query result. -- @@ -5832,13 +4882,9 @@ Total number of bytes returned in the query result. [%hardbreaks] {blank} a¦ Integer - -a¦ -*scanConsistency* + -_optional_ -a¦ - -[markdown] +a¦ *scanConsistency* + +optional +a¦ [markdown] -- The value of the query setting Scan Consistency used for the query. -- @@ -5846,13 +4892,9 @@ The value of the query setting Scan Consistency used for the query. [%hardbreaks] {blank} a¦ String - -a¦ -*serviceTime* + -_optional_ -a¦ - -[markdown] +a¦ *serviceTime* + +optional +a¦ [markdown] -- Total amount of calendar time taken to complete the query. -- @@ -5860,13 +4902,9 @@ Total amount of calendar time taken to complete the query. [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*sessionMemory* + -_optional_ -a¦ - -[markdown] +a¦ *sessionMemory* + +optional +a¦ [markdown] -- The memory session size for the request, in bytes. @@ -5880,13 +4918,9 @@ This metric is available only when `node-quota` and `node-quota-val-percent` are [%hardbreaks] {blank} a¦ Integer (bytes) - -a¦ -*state* + -_optional_ -a¦ - -[markdown] +a¦ *state* + +optional +a¦ [markdown] -- The state of the query execution, such as `completed`, `running`, `cancelled`. @@ -5899,13 +4933,9 @@ To find requests that were successful, use this field in conjunction with the `e [%hardbreaks] {blank} a¦ String - -a¦ -*statement* + -_optional_ -a¦ - -[markdown] +a¦ *statement* + +optional +a¦ [markdown] -- The query statement being executed. -- @@ -5913,13 +4943,9 @@ The query statement being executed. [%hardbreaks] {blank} a¦ String - -a¦ -*useCBO* + -_optional_ -a¦ - -[markdown] +a¦ *useCBO* + +optional +a¦ [markdown] -- Whether the cost-based optimizer is enabled for the query. -- @@ -5927,13 +4953,9 @@ Whether the cost-based optimizer is enabled for the query. [%hardbreaks] {blank} a¦ Boolean - -a¦ -*usedMemory* + -_optional_ -a¦ - -[markdown] +a¦ *usedMemory* + +optional +a¦ [markdown] -- The amount of document memory used to execute the request. This property is only returned if a memory quota is set for the query. @@ -5942,13 +4964,9 @@ This property is only returned if a memory quota is set for the query. [%hardbreaks] {blank} a¦ Integer - -a¦ -*userAgent* + -_optional_ -a¦ - -[markdown] +a¦ *userAgent* + +optional +a¦ [markdown] -- Name of the client application or program that issued the query. -- @@ -5956,13 +4974,9 @@ Name of the client application or program that issued the query. [%hardbreaks] {blank} a¦ String - -a¦ -*users* + -_optional_ -a¦ - -[markdown] +a¦ *users* + +optional +a¦ [markdown] -- Username with whose privileges the query is run. -- @@ -5970,13 +4984,9 @@ Username with whose privileges the query is run. [%hardbreaks] {blank} a¦ String - -a¦ -*waitTime* + -_optional_ -a¦ - -[markdown] +a¦ *waitTime* + +optional +a¦ [markdown] -- The total sum of [kernTime][kern_time] across all operators. @@ -5987,13 +4997,9 @@ The total sum of [kernTime][kern_time] across all operators. *Example:* `+++"1.201307s"+++` {blank} a¦ String (duration) - -a¦ -*~analysis* + -_optional_ -a¦ - -[markdown] +a¦ *~analysis* + +optional +a¦ [markdown] -- An array of text phrases that provide a basic analysis of the request execution. These phrases highlight notable aspects of the execution, such as high document counts during primary scans or warnings related to memory and resource usages. @@ -6002,8 +5008,7 @@ These phrases highlight notable aspects of the execution, such as high document [%hardbreaks] *Example:* `["High IO time","High primary scan document count"]` {blank} -a¦ String - array +a¦ String array |=== @@ -6011,28 +5016,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/Requests/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Requests/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Requests/definition-after.adoc[opts=optional] - - - +ifndef::show-Requests[] +:leveloffset: -1 +endif::show-Requests[] -// markup not found, no include::{specDir}definitions/Settings/definition-before.adoc[opts=optional] +include::{specDir}definitions/Requests/definition-after.adoc[opts=optional] +include::{specDir}definitions/Settings/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Settings[] [#Settings] +endif::show-Settings[] +ifndef::show-Settings[] +:leveloffset: +1 + +[discrete#Settings] +endif::show-Settings[] = Settings :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Settings/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Settings/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -6040,17 +5048,14 @@ endif::collapse-models[] //tag::Settings[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ [#atrcollection-srv] *atrcollection* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [atrcollection_req]: #atrcollection_req @@ -6078,13 +5083,10 @@ If a request does not include this parameter, the node-level `atrcollection` set *Example:* `+++"default:`travel-sample`.transaction.test"+++` {blank} a¦ String - a¦ [#auto-prepare] *auto-prepare* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [auto-prepare]: ../n1ql-language-reference/prepare.html#auto-prepare @@ -6102,13 +5104,10 @@ Refer to [Auto-Prepare][auto-prepare] for more information. *Example:* `true` {blank} a¦ Boolean - a¦ [#cleanupclientattempts] *cleanupclientattempts* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryCleanupClientAttempts]: #queryCleanupClientAttempts @@ -6129,13 +5128,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `false` {blank} a¦ Boolean - a¦ [#cleanuplostattempts] *cleanuplostattempts* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryCleanupLostAttempts]: #queryCleanupLostAttempts @@ -6156,13 +5152,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `false` {blank} a¦ Boolean - a¦ [#cleanupwindow] *cleanupwindow* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryCleanupWindow]: #queryCleanupWindow @@ -6197,13 +5190,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `+++"30s"+++` {blank} a¦ String (duration) - a¦ [#completed] *completed* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config @@ -6215,13 +5205,10 @@ include::index.adoc[tag=desc-Logging_Parameters, opts=optional] [%hardbreaks] {blank} a¦ xref:Logging_Parameters[] - a¦ [#completed-limit] *completed-limit* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config @@ -6250,13 +5237,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `7000` {blank} a¦ Integer (int32) - a¦ [#completed-max-plan-size] *completed-max-plan-size* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config @@ -6287,13 +5271,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Maximum:* `20840448` {blank} a¦ Integer (int32) - a¦ [#completed-stream-size] *completed-stream-size* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [sys-history]: monitoring-n1ql-query.html#sys-history @@ -6314,13 +5295,10 @@ Refer to [Stream Completed Requests][sys-history] for more information and examp [%hardbreaks] {blank} a¦ Integer (int32) - a¦ [#completed-threshold] *completed-threshold* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config @@ -6350,13 +5328,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `7000` {blank} a¦ Integer (int32) - a¦ [#controls-srv] *controls* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [controls_req]: #controls_req @@ -6381,13 +5356,10 @@ If a request does not include this parameter, the node-level `controls` setting *Example:* `true` {blank} a¦ Boolean - a¦ [#cpuprofile] *cpuprofile* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- The absolute path and filename to write the CPU profile to a local file. @@ -6403,13 +5375,10 @@ To stop `cpuprofile`, run with the empty setting of `""`. *Example:* `+++"/tmp/info.txt"+++` {blank} a¦ String - a¦ [#debug] *debug* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Use debug mode. @@ -6421,13 +5390,10 @@ When set to `true`, extra logging is provided. *Example:* `true` {blank} a¦ Boolean - a¦ [#distribute] *distribute* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- This field is only available with the POST method. When specified alongside other settings, this field instructs the node that is processing the request to cascade those settings to all other query nodes. @@ -6438,13 +5404,10 @@ The actual value of this field is ignored. *Example:* `true` {blank} a¦ Boolean - a¦ [#functions-limit] *functions-limit* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Maximum number of user-defined functions. -- @@ -6454,13 +5417,10 @@ Maximum number of user-defined functions. *Example:* `7000` {blank} a¦ Integer (int32) - a¦ [#keep-alive-length] *keep-alive-length* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Maximum size of buffered result. -- @@ -6470,13 +5430,10 @@ Maximum size of buffered result. *Example:* `7000` {blank} a¦ Integer (int32) - a¦ [#loglevel] *loglevel* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryLogLevel]: #queryLogLevel @@ -6520,13 +5477,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `+++"DEBUG"+++` {blank} a¦ String - a¦ [#max-index-api] *max-index-api* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Max index API. This setting is provided for technical support only. @@ -6535,13 +5489,10 @@ This setting is provided for technical support only. [%hardbreaks] {blank} a¦ Integer (int32) - a¦ [#max-parallelism-srv] *max-parallelism* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [max-parallelism]: ../n1ql-language-reference/index-partitioning.html#max-parallelism @@ -6580,13 +5531,10 @@ NOTE: To enable queries to run in parallel, you must specify the cluster-level ` *Example:* `0` {blank} a¦ Integer (int32) - a¦ [#memory-quota-srv] *memory-quota* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryMemoryQuota]: #queryMemoryQuota @@ -6621,13 +5569,10 @@ If a request includes this parameter, it will be capped by the node-level `memor *Example:* `4` {blank} a¦ Integer (int32) - a¦ [#memprofile] *memprofile* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Filename to write the diagnostic memory usage log. @@ -6641,13 +5586,10 @@ To stop `memprofile`, run with the empty setting of `""`. *Example:* `+++"/tmp/memory-usage.log"+++` {blank} a¦ String - a¦ [#mutexprofile] *mutexprofile* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Mutex profile. This setting is provided for technical support only. @@ -6657,13 +5599,10 @@ This setting is provided for technical support only. *Default:* `false` {blank} a¦ Boolean - a¦ [#n1ql-feat-ctrl] *n1ql-feat-ctrl* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryN1QLFeatCtrl]: #queryN1QLFeatCtrl @@ -6686,13 +5625,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `16460` {blank} a¦ Integer (int32) - a¦ [#node-quota] *node-quota* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryNodeQuota]: #queryNodeQuota @@ -6723,13 +5659,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `0` {blank} a¦ Integer (int32) - a¦ [#node-quota-val-percent] *node-quota-val-percent* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryNodeQuotaValPercent]: #queryNodeQuotaValPercent @@ -6752,13 +5685,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Maximum:* `100` {blank} a¦ Integer (int32) - a¦ [#num-cpus] *num-cpus* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryNumCpus]: #queryNumCpus @@ -6785,13 +5715,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `0` {blank} a¦ Integer (int32) - a¦ [#numatrs-srv] *numatrs* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryNumAtrs]: #queryNumAtrs @@ -6812,13 +5739,10 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] {blank} a¦ String - a¦ [#pipeline-batch-srv] *pipeline-batch* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryPipelineBatch]: #queryPipelineBatch @@ -6844,13 +5768,10 @@ The minimum of that and the node-level `pipeline-batch` setting is applied. *Example:* `64` {blank} a¦ Integer (int32) - a¦ [#pipeline-cap-srv] *pipeline-cap* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryPipelineCap]: #queryPipelineCap @@ -6876,13 +5797,10 @@ The minimum of that and the node-level `pipeline-cap` setting is applied. *Example:* `1024` {blank} a¦ Integer (int32) - a¦ [#plus-servicers] *plus-servicers* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- The number of service threads for transactions where the scan consistency is `request_plus` or `at_plus`. The default is 16 times the number of logical cores. @@ -6892,13 +5810,10 @@ The default is 16 times the number of logical cores. *Example:* `16` {blank} a¦ Integer (int32) - a¦ [#prepared-limit] *prepared-limit* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryPreparedLimit]: #queryPreparedLimit @@ -6920,13 +5835,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `65536` {blank} a¦ Integer (int32) - a¦ [#pretty-srv] *pretty* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [pretty_req]: #pretty_req @@ -6947,13 +5859,10 @@ If a request does not include this parameter, the node-level setting is used, wh *Example:* `true` {blank} a¦ Boolean - a¦ [#profile-srv] *profile* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [monitor-profile-details]: monitoring-n1ql-query.html#monitor-profile-details @@ -6991,13 +5900,10 @@ If a request does not include this parameter, the node-level `profile` setting w *Example:* `+++"phases"+++` {blank} a¦ String - a¦ [#request-size-cap] *request-size-cap* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Maximum size of a request. -- @@ -7007,13 +5913,10 @@ Maximum size of a request. *Example:* `70000` {blank} a¦ Integer (int32) - a¦ [#scan-cap-srv] *scan-cap* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryScanCap]: #queryScanCap @@ -7043,13 +5946,10 @@ The minimum of that and the node-level `scan-cap` setting is applied. *Example:* `1024` {blank} a¦ Integer (int32) - a¦ [#servicers] *servicers* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- The number of service threads for the query. The default is 4 times the number of cores on the query node. @@ -7060,13 +5960,10 @@ The default is 4 times the number of cores on the query node. *Example:* `8` {blank} a¦ Integer (int32) - a¦ [#timeout-srv] *timeout* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryTimeout]: #queryTimeout @@ -7098,13 +5995,10 @@ The minimum of that and the node-level `timeout` setting is applied. *Example:* `500000000` {blank} a¦ Long (int64) - a¦ [#txtimeout-srv] *txtimeout* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [tximplicit]: #tximplicit @@ -7141,13 +6035,10 @@ The minimum of that and the node-level `txtimeout` setting is applied. *Example:* `500000000` {blank} a¦ Long (int64) - a¦ [#use-cbo-srv] *use-cbo* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryUseCBO]: #queryUseCBO @@ -7173,13 +6064,10 @@ If a request does not include this parameter, the node-level setting is used, wh *Example:* `false` {blank} a¦ Boolean - a¦ [#use-replica-srv] *use-replica* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryUseReplica]: #queryUseReplica @@ -7229,28 +6117,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/Settings/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Settings/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Settings/definition-after.adoc[opts=optional] - - - +ifndef::show-Settings[] +:leveloffset: -1 +endif::show-Settings[] -// markup not found, no include::{specDir}definitions/Statements/definition-before.adoc[opts=optional] +include::{specDir}definitions/Settings/definition-after.adoc[opts=optional] +include::{specDir}definitions/Statements/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Statements[] [#Statements] +endif::show-Statements[] +ifndef::show-Statements[] +:leveloffset: +1 + +[discrete#Statements] +endif::show-Statements[] = Prepared Statements :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Statements/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Statements/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -7258,17 +6149,13 @@ endif::collapse-models[] //tag::Statements[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*encoded_plan* + -_required_ -a¦ - -[markdown] +a¦ *encoded_plan* + +required +a¦ [markdown] -- The full prepared statement in encoded format. -- @@ -7276,13 +6163,9 @@ The full prepared statement in encoded format. [%hardbreaks] {blank} a¦ String - -a¦ -*featureControls* + -_optional_ -a¦ - -[markdown] +a¦ *featureControls* + +optional +a¦ [markdown] -- This property is provided for technical support only. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. @@ -7291,13 +6174,9 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} a¦ Integer - -a¦ -*indexApiVersion* + -_optional_ -a¦ - -[markdown] +a¦ *indexApiVersion* + +optional +a¦ [markdown] -- This property is provided for technical support only. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. @@ -7306,13 +6185,9 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} a¦ Integer - -a¦ -*name* + -_required_ -a¦ - -[markdown] +a¦ *name* + +required +a¦ [markdown] -- The name of the prepared statement. This may be a UUID that was assigned automatically, or a name that was user-specified when the statement was created. @@ -7321,13 +6196,9 @@ This may be a UUID that was assigned automatically, or a name that was user-spec [%hardbreaks] {blank} a¦ String - -a¦ -*namespace* + -_optional_ -a¦ - -[markdown] +a¦ *namespace* + +optional +a¦ [markdown] -- The namespace in which the prepared statement is stored. Currently, only the `default` namespace is available. @@ -7336,13 +6207,9 @@ Currently, only the `default` namespace is available. [%hardbreaks] {blank} a¦ String - -a¦ -*node* + -_optional_ -a¦ - -[markdown] +a¦ *node* + +optional +a¦ [markdown] -- The node on which the prepared statement is stored. -- @@ -7350,13 +6217,9 @@ The node on which the prepared statement is stored. [%hardbreaks] {blank} a¦ String - -a¦ -*statement* + -_required_ -a¦ - -[markdown] +a¦ *statement* + +required +a¦ [markdown] -- The text of the query. -- @@ -7364,13 +6227,9 @@ The text of the query. [%hardbreaks] {blank} a¦ String - -a¦ -*uses* + -_required_ -a¦ - -[markdown] +a¦ *uses* + +required +a¦ [markdown] -- The count of times the prepared statement has been executed. -- @@ -7378,16 +6237,12 @@ The count of times the prepared statement has been executed. [%hardbreaks] {blank} a¦ Integer - -a¦ -*avgElapsedTime* + -_optional_ -a¦ - -[markdown] --- -The mean time taken from when the request to execute the prepared statement was acknowledged by the service, to when the request was completed. -It includes the time taken by the service to schedule the request. +a¦ *avgElapsedTime* + +optional +a¦ [markdown] +-- +The mean time taken from when the request to execute the prepared statement was acknowledged by the service, to when the request was completed. +It includes the time taken by the service to schedule the request. This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. @@ -7396,13 +6251,9 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*avgServiceTime* + -_optional_ -a¦ - -[markdown] +a¦ *avgServiceTime* + +optional +a¦ [markdown] -- The mean amount of calendar time taken to complete the execution of the prepared statement. @@ -7413,13 +6264,9 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*lastUse* + -_optional_ -a¦ - -[markdown] +a¦ *lastUse* + +optional +a¦ [markdown] -- Date and time of last use. @@ -7429,13 +6276,9 @@ This property is only returned when the prepared statement has been executed. [%hardbreaks] {blank} a¦ Date (date-time) - -a¦ -*maxElapsedTime* + -_optional_ -a¦ - -[markdown] +a¦ *maxElapsedTime* + +optional +a¦ [markdown] -- The maximum time taken from when the request to execute the prepared statement was acknowledged by the service, to when the request was completed. It includes the time taken by the service to schedule the request. @@ -7447,13 +6290,9 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*maxServiceTime* + -_optional_ -a¦ - -[markdown] +a¦ *maxServiceTime* + +optional +a¦ [markdown] -- The maximum amount of calendar time taken to complete the execution of the prepared statement. @@ -7464,13 +6303,9 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*minElapsedTime* + -_optional_ -a¦ - -[markdown] +a¦ *minElapsedTime* + +optional +a¦ [markdown] -- The minimum time taken from when the request to execute the prepared statement was acknowledged by the service, to when the request was completed. It includes the time taken by the service to schedule the request. @@ -7482,13 +6317,9 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*minServiceTime* + -_optional_ -a¦ - -[markdown] +a¦ *minServiceTime* + +optional +a¦ [markdown] -- The minimum amount of calendar time taken to complete the execution of the prepared statement. @@ -7506,28 +6337,31 @@ a¦ String (duration) -// markup not found, no include::{specDir}definitions/Statements/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Statements/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Statements/definition-after.adoc[opts=optional] - - - +ifndef::show-Statements[] +:leveloffset: -1 +endif::show-Statements[] -// markup not found, no include::{specDir}definitions/Statistics/definition-before.adoc[opts=optional] +include::{specDir}definitions/Statements/definition-after.adoc[opts=optional] +include::{specDir}definitions/Statistics/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Statistics[] [#Statistics] +endif::show-Statistics[] +ifndef::show-Statistics[] +:leveloffset: +1 + +[discrete#Statistics] +endif::show-Statistics[] = Statistics :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Statistics/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Statistics/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -7535,17 +6369,13 @@ endif::collapse-models[] //tag::Statistics[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*active_requests.count* + -_optional_ -a¦ - -[markdown] +a¦ *active_requests.count* + +optional +a¦ [markdown] -- Total number of active requests. -- @@ -7553,13 +6383,9 @@ Total number of active requests. [%hardbreaks] {blank} a¦ Integer - -a¦ -*at_plus.count* + -_optional_ -a¦ - -[markdown] +a¦ *at_plus.count* + +optional +a¦ [markdown] -- Total number of query requests with `at_plus` index consistency. -- @@ -7567,13 +6393,9 @@ Total number of query requests with `at_plus` index consistency. [%hardbreaks] {blank} a¦ Integer - -a¦ -*audit_actions.count* + -_optional_ -a¦ - -[markdown] +a¦ *audit_actions.count* + +optional +a¦ [markdown] -- The total number of audit records sent to the server. Some requests cause more than one audit record to be emitted. @@ -7583,13 +6405,9 @@ Records in the output queue that have not yet been sent to the server are not co [%hardbreaks] {blank} a¦ Integer - -a¦ -*audit_actions_failed.count* + -_optional_ -a¦ - -[markdown] +a¦ *audit_actions_failed.count* + +optional +a¦ [markdown] -- The total number of audit records sent to the server that failed. -- @@ -7597,13 +6415,9 @@ The total number of audit records sent to the server that failed. [%hardbreaks] {blank} a¦ Integer - -a¦ -*audit_requests_filtered.count* + -_optional_ -a¦ - -[markdown] +a¦ *audit_requests_filtered.count* + +optional +a¦ [markdown] -- The number of potentially auditable requests that cause no audit action to be taken. -- @@ -7611,13 +6425,9 @@ The number of potentially auditable requests that cause no audit action to be ta [%hardbreaks] {blank} a¦ Integer - -a¦ -*audit_requests_total.count* + -_optional_ -a¦ - -[markdown] +a¦ *audit_requests_total.count* + +optional +a¦ [markdown] -- The total number of potentially auditable requests sent to the query engine. -- @@ -7625,13 +6435,9 @@ The total number of potentially auditable requests sent to the query engine. [%hardbreaks] {blank} a¦ Integer - -a¦ -*cancelled.count* + -_optional_ -a¦ - -[markdown] +a¦ *cancelled.count* + +optional +a¦ [markdown] -- Total number of cancelled requests. -- @@ -7639,13 +6445,9 @@ Total number of cancelled requests. [%hardbreaks] {blank} a¦ Integer - -a¦ -*deletes.count* + -_optional_ -a¦ - -[markdown] +a¦ *deletes.count* + +optional +a¦ [markdown] -- Total number of DELETE operations. -- @@ -7653,13 +6455,9 @@ Total number of DELETE operations. [%hardbreaks] {blank} a¦ Integer - -a¦ -*errors.count* + -_optional_ -a¦ - -[markdown] +a¦ *errors.count* + +optional +a¦ [markdown] -- The total number of query errors returned so far. -- @@ -7667,13 +6465,9 @@ The total number of query errors returned so far. [%hardbreaks] {blank} a¦ Integer - -a¦ -*index_scans.count* + -_optional_ -a¦ - -[markdown] +a¦ *index_scans.count* + +optional +a¦ [markdown] -- Total number of secondary index scans. -- @@ -7681,13 +6475,9 @@ Total number of secondary index scans. [%hardbreaks] {blank} a¦ Integer - -a¦ -*inserts.count* + -_optional_ -a¦ - -[markdown] +a¦ *inserts.count* + +optional +a¦ [markdown] -- Total number of INSERT operations. -- @@ -7695,13 +6485,9 @@ Total number of INSERT operations. [%hardbreaks] {blank} a¦ Integer - -a¦ -*invalid_requests.count* + -_optional_ -a¦ - -[markdown] +a¦ *invalid_requests.count* + +optional +a¦ [markdown] -- Total number of requests for unsupported endpoints. -- @@ -7709,13 +6495,9 @@ Total number of requests for unsupported endpoints. [%hardbreaks] {blank} a¦ Integer - -a¦ -*mutations.count* + -_optional_ -a¦ - -[markdown] +a¦ *mutations.count* + +optional +a¦ [markdown] -- Total number of document mutations. -- @@ -7723,13 +6505,9 @@ Total number of document mutations. [%hardbreaks] {blank} a¦ Integer - -a¦ -*prepared.count* + -_optional_ -a¦ - -[markdown] +a¦ *prepared.count* + +optional +a¦ [markdown] -- Total number of prepared statements executed. -- @@ -7737,13 +6515,9 @@ Total number of prepared statements executed. [%hardbreaks] {blank} a¦ Integer - -a¦ -*primary_scans.count* + -_optional_ -a¦ - -[markdown] +a¦ *primary_scans.count* + +optional +a¦ [markdown] -- Total number of primary index scans. -- @@ -7751,13 +6525,9 @@ Total number of primary index scans. [%hardbreaks] {blank} a¦ Integer - -a¦ -*queued_requests.count* + -_optional_ -a¦ - -[markdown] +a¦ *queued_requests.count* + +optional +a¦ [markdown] -- Total number of queued requests. -- @@ -7765,13 +6535,9 @@ Total number of queued requests. [%hardbreaks] {blank} a¦ Integer - -a¦ -*request_time.count* + -_optional_ -a¦ - -[markdown] +a¦ *request_time.count* + +optional +a¦ [markdown] -- Total end-to-end time to process all queries (ns). -- @@ -7779,13 +6545,9 @@ Total end-to-end time to process all queries (ns). [%hardbreaks] {blank} a¦ Integer - -a¦ -*request_timer.15m.rate* + -_optional_ -a¦ - -[markdown] +a¦ *request_timer.15m.rate* + +optional +a¦ [markdown] -- Number of query requests processed per second. 15-minute exponentially weighted moving average. @@ -7793,14 +6555,10 @@ Number of query requests processed per second. [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*request_timer.1m.rate* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *request_timer.1m.rate* + +optional +a¦ [markdown] -- Number of query requests processed per second. 1-minute exponentially weighted moving average. @@ -7808,14 +6566,10 @@ Number of query requests processed per second. [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*request_timer.5m.rate* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *request_timer.5m.rate* + +optional +a¦ [markdown] -- Number of query requests processed per second. 5-minute exponentially weighted moving average. @@ -7823,14 +6577,10 @@ Number of query requests processed per second. [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*request_timer.75%* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *request_timer.75%* + +optional +a¦ [markdown] -- End-to-end time to process a query (ns). The 75th percentile. @@ -7838,14 +6588,10 @@ The 75th percentile. [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*request_timer.95%* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *request_timer.95%* + +optional +a¦ [markdown] -- End-to-end time to process a query (ns). The 95th percentile. @@ -7853,14 +6599,10 @@ The 95th percentile. [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*request_timer.99%* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *request_timer.99%* + +optional +a¦ [markdown] -- End-to-end time to process a query (ns). The 99th percentile. @@ -7868,14 +6610,10 @@ The 99th percentile. [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*request_timer.99.9%* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *request_timer.99.9%* + +optional +a¦ [markdown] -- End-to-end time to process a query (ns). The 99.9th percentile. @@ -7883,14 +6621,10 @@ The 99.9th percentile. [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*request_timer.count* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *request_timer.count* + +optional +a¦ [markdown] -- Total number of query requests. -- @@ -7898,13 +6632,9 @@ Total number of query requests. [%hardbreaks] {blank} a¦ Integer - -a¦ -*request_timer.max* + -_optional_ -a¦ - -[markdown] +a¦ *request_timer.max* + +optional +a¦ [markdown] -- End-to-end time to process a query (ns). The maximum value. @@ -7913,13 +6643,9 @@ The maximum value. [%hardbreaks] {blank} a¦ Integer - -a¦ -*request_timer.mean* + -_optional_ -a¦ - -[markdown] +a¦ *request_timer.mean* + +optional +a¦ [markdown] -- End-to-end time to process a query (ns). The mean value. @@ -7927,14 +6653,10 @@ The mean value. [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*request_timer.mean.rate* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *request_timer.mean.rate* + +optional +a¦ [markdown] -- Number of query requests processed per second. Mean rate since the query service started. @@ -7942,14 +6664,10 @@ Mean rate since the query service started. [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*request_timer.median* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *request_timer.median* + +optional +a¦ [markdown] -- End-to-end time to process a query (ns). The median value. @@ -7957,14 +6675,10 @@ The median value. [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*request_timer.min* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *request_timer.min* + +optional +a¦ [markdown] -- End-to-end time to process a query (ns). The minimum value. @@ -7973,13 +6687,9 @@ The minimum value. [%hardbreaks] {blank} a¦ Integer - -a¦ -*request_timer.stddev* + -_optional_ -a¦ - -[markdown] +a¦ *request_timer.stddev* + +optional +a¦ [markdown] -- End-to-end time to process a query (ns). The standard deviation. @@ -7987,14 +6697,10 @@ The standard deviation. [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*requests.count* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *requests.count* + +optional +a¦ [markdown] -- Total number of query requests. -- @@ -8002,13 +6708,9 @@ Total number of query requests. [%hardbreaks] {blank} a¦ Integer - -a¦ -*requests_1000ms.count* + -_optional_ -a¦ - -[markdown] +a¦ *requests_1000ms.count* + +optional +a¦ [markdown] -- Number of queries that take longer than 1000ms. -- @@ -8016,13 +6718,9 @@ Number of queries that take longer than 1000ms. [%hardbreaks] {blank} a¦ Integer - -a¦ -*requests_250ms.count* + -_optional_ -a¦ - -[markdown] +a¦ *requests_250ms.count* + +optional +a¦ [markdown] -- Number of queries that take longer than 250ms. -- @@ -8030,13 +6728,9 @@ Number of queries that take longer than 250ms. [%hardbreaks] {blank} a¦ Integer - -a¦ -*requests_5000ms.count* + -_optional_ -a¦ - -[markdown] +a¦ *requests_5000ms.count* + +optional +a¦ [markdown] -- Number of queries that take longer than 5000ms. -- @@ -8044,13 +6738,9 @@ Number of queries that take longer than 5000ms. [%hardbreaks] {blank} a¦ Integer - -a¦ -*requests_500ms.count* + -_optional_ -a¦ - -[markdown] +a¦ *requests_500ms.count* + +optional +a¦ [markdown] -- Number of queries that take longer than 500ms. -- @@ -8058,13 +6748,9 @@ Number of queries that take longer than 500ms. [%hardbreaks] {blank} a¦ Integer - -a¦ -*result_count.count* + -_optional_ -a¦ - -[markdown] +a¦ *result_count.count* + +optional +a¦ [markdown] -- Total number of results (documents) returned by the query engine. -- @@ -8072,13 +6758,9 @@ Total number of results (documents) returned by the query engine. [%hardbreaks] {blank} a¦ Integer - -a¦ -*result_size.count* + -_optional_ -a¦ - -[markdown] +a¦ *result_size.count* + +optional +a¦ [markdown] -- Total size of data returned by the query engine (bytes). -- @@ -8086,13 +6768,9 @@ Total size of data returned by the query engine (bytes). [%hardbreaks] {blank} a¦ Integer - -a¦ -*scan_plus.count* + -_optional_ -a¦ - -[markdown] +a¦ *scan_plus.count* + +optional +a¦ [markdown] -- Total number of query requests with `request_plus` index consistency. -- @@ -8100,13 +6778,9 @@ Total number of query requests with `request_plus` index consistency. [%hardbreaks] {blank} a¦ Integer - -a¦ -*selects.count* + -_optional_ -a¦ - -[markdown] +a¦ *selects.count* + +optional +a¦ [markdown] -- Total number of SELECT requests. -- @@ -8114,13 +6788,9 @@ Total number of SELECT requests. [%hardbreaks] {blank} a¦ Integer - -a¦ -*service_time.count* + -_optional_ -a¦ - -[markdown] +a¦ *service_time.count* + +optional +a¦ [markdown] -- Time to execute all queries (ns). -- @@ -8128,13 +6798,9 @@ Time to execute all queries (ns). [%hardbreaks] {blank} a¦ Integer - -a¦ -*unbounded.count* + -_optional_ -a¦ - -[markdown] +a¦ *unbounded.count* + +optional +a¦ [markdown] -- Total number of query requests with `not_bounded` index consistency. -- @@ -8142,13 +6808,9 @@ Total number of query requests with `not_bounded` index consistency. [%hardbreaks] {blank} a¦ Integer - -a¦ -*updates.count* + -_optional_ -a¦ - -[markdown] +a¦ *updates.count* + +optional +a¦ [markdown] -- Total number of UPDATE requests. -- @@ -8156,13 +6818,9 @@ Total number of UPDATE requests. [%hardbreaks] {blank} a¦ Integer - -a¦ -*warnings.count* + -_optional_ -a¦ - -[markdown] +a¦ *warnings.count* + +optional +a¦ [markdown] -- The total number of query warnings returned so far. -- @@ -8177,28 +6835,31 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/Statistics/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Statistics/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Statistics/definition-after.adoc[opts=optional] - - - +ifndef::show-Statistics[] +:leveloffset: -1 +endif::show-Statistics[] -// markup not found, no include::{specDir}definitions/Vitals/definition-before.adoc[opts=optional] +include::{specDir}definitions/Statistics/definition-after.adoc[opts=optional] +include::{specDir}definitions/Vitals/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Vitals[] [#Vitals] +endif::show-Vitals[] +ifndef::show-Vitals[] +:leveloffset: +1 + +[discrete#Vitals] +endif::show-Vitals[] = Vital Statistics :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Vitals/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Vitals/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -8206,17 +6867,13 @@ endif::collapse-models[] //tag::Vitals[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*bucket.IO.stats* + -_optional_ -a¦ - -[markdown] +a¦ *bucket.IO.stats* + +optional +a¦ [markdown] -- The number of reads and retries for each bucket. -- @@ -8224,13 +6881,9 @@ The number of reads and retries for each bucket. [%hardbreaks] {blank} a¦ Object - -a¦ -*uptime* + -_optional_ -a¦ - -[markdown] +a¦ *uptime* + +optional +a¦ [markdown] -- The uptime of the query engine. -- @@ -8238,13 +6891,9 @@ The uptime of the query engine. [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*local.time* + -_optional_ -a¦ - -[markdown] +a¦ *local.time* + +optional +a¦ [markdown] -- The local time of the query engine. -- @@ -8252,13 +6901,9 @@ The local time of the query engine. [%hardbreaks] {blank} a¦ Date (date-time) - -a¦ -*version* + -_optional_ -a¦ - -[markdown] +a¦ *version* + +optional +a¦ [markdown] -- The version of the query engine. -- @@ -8266,13 +6911,9 @@ The version of the query engine. [%hardbreaks] {blank} a¦ String - -a¦ -*total.threads* + -_optional_ -a¦ - -[markdown] +a¦ *total.threads* + +optional +a¦ [markdown] -- The number of active threads used by the query engine. -- @@ -8280,13 +6921,9 @@ The number of active threads used by the query engine. [%hardbreaks] {blank} a¦ Integer - -a¦ -*cores* + -_optional_ -a¦ - -[markdown] +a¦ *cores* + +optional +a¦ [markdown] -- The maximum number of logical cores available to the query engine. -- @@ -8294,13 +6931,9 @@ The maximum number of logical cores available to the query engine. [%hardbreaks] {blank} a¦ Integer - -a¦ -*ffdc.total* + -_optional_ -a¦ - -[markdown] +a¦ *ffdc.total* + +optional +a¦ [markdown] -- The total number of times FFDC has been invoked since the last restart. -- @@ -8308,13 +6941,9 @@ The total number of times FFDC has been invoked since the last restart. [%hardbreaks] {blank} a¦ Integer - -a¦ -*gc.num* + -_optional_ -a¦ - -[markdown] +a¦ *gc.num* + +optional +a¦ [markdown] -- The target heap size of the next garbage collection cycle. -- @@ -8322,13 +6951,9 @@ The target heap size of the next garbage collection cycle. [%hardbreaks] {blank} a¦ Long (int64) - -a¦ -*gc.pause.time* + -_optional_ -a¦ - -[markdown] +a¦ *gc.pause.time* + +optional +a¦ [markdown] -- The total time spent pausing for garbage collection since the query engine started (ns). -- @@ -8336,13 +6961,9 @@ The total time spent pausing for garbage collection since the query engine start [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*gc.pause.percent* + -_optional_ -a¦ - -[markdown] +a¦ *gc.pause.percent* + +optional +a¦ [markdown] -- The percentage of time spent pausing for garbage collection since the last time the statistics were checked. -- @@ -8350,13 +6971,9 @@ The percentage of time spent pausing for garbage collection since the last time [%hardbreaks] {blank} a¦ Long (int64) - -a¦ -*healthy* + -_optional_ -a¦ - -[markdown] +a¦ *healthy* + +optional +a¦ [markdown] -- False when either the unbounded or plus request queues are full; true otherwise. -- @@ -8364,13 +6981,9 @@ False when either the unbounded or plus request queues are full; true otherwise. [%hardbreaks] {blank} a¦ Boolean - -a¦ -*host.memory.free* + -_optional_ -a¦ - -[markdown] +a¦ *host.memory.free* + +optional +a¦ [markdown] -- Amount of free memory on the host. -- @@ -8378,13 +6991,9 @@ Amount of free memory on the host. [%hardbreaks] {blank} a¦ Long (int64) - -a¦ -*host.memory.quota* + -_optional_ -a¦ - -[markdown] +a¦ *host.memory.quota* + +optional +a¦ [markdown] -- The host memory quota. This reflects the node-quota setting. @@ -8393,13 +7002,9 @@ This reflects the node-quota setting. [%hardbreaks] {blank} a¦ Long (int64) - -a¦ -*host.memory.total* + -_optional_ -a¦ - -[markdown] +a¦ *host.memory.total* + +optional +a¦ [markdown] -- Total memory on the host. -- @@ -8407,13 +7012,9 @@ Total memory on the host. [%hardbreaks] {blank} a¦ Long (int64) - -a¦ -*host.memory.value_quota* + -_optional_ -a¦ - -[markdown] +a¦ *host.memory.value_quota* + +optional +a¦ [markdown] -- This the total document memory quota on the node. -- @@ -8421,13 +7022,9 @@ This the total document memory quota on the node. [%hardbreaks] {blank} a¦ Long (int64) - -a¦ -*load* + -_optional_ -a¦ - -[markdown] +a¦ *load* + +optional +a¦ [markdown] -- A calculation for how busy the server is. -- @@ -8435,13 +7032,9 @@ A calculation for how busy the server is. [%hardbreaks] {blank} a¦ Integer - -a¦ -*loadfactor* + -_optional_ -a¦ - -[markdown] +a¦ *loadfactor* + +optional +a¦ [markdown] -- The moving 15 minute average of the load calculation. -- @@ -8449,13 +7042,9 @@ The moving 15 minute average of the load calculation. [%hardbreaks] {blank} a¦ Integer - -a¦ -*memory.usage* + -_optional_ -a¦ - -[markdown] +a¦ *memory.usage* + +optional +a¦ [markdown] -- The amount of memory allocated for heap objects (bytes). This increases as heap objects are allocated, and decreases as objects are freed. @@ -8464,13 +7053,9 @@ This increases as heap objects are allocated, and decreases as objects are freed [%hardbreaks] {blank} a¦ Long (int64) - -a¦ -*memory.total* + -_optional_ -a¦ - -[markdown] +a¦ *memory.total* + +optional +a¦ [markdown] -- The cumulative amount of memory allocated for heap objects (bytes). This increases as heap objects are allocated, but does not decrease when objects are freed. @@ -8479,13 +7064,9 @@ This increases as heap objects are allocated, but does not decrease when objects [%hardbreaks] {blank} a¦ Long (int64) - -a¦ -*memory.system* + -_optional_ -a¦ - -[markdown] +a¦ *memory.system* + +optional +a¦ [markdown] -- The total amount of memory obtained from the operating system (bytes). This measures the virtual address space reserved by the query engine for heaps, stacks, and other internal data structures. @@ -8494,13 +7075,9 @@ This measures the virtual address space reserved by the query engine for heaps, [%hardbreaks] {blank} a¦ Long (int64) - -a¦ -*node* + -_optional_ -a¦ - -[markdown] +a¦ *node* + +optional +a¦ [markdown] -- The name or IP address and port of the node. -- @@ -8508,13 +7085,9 @@ The name or IP address and port of the node. [%hardbreaks] {blank} a¦ String - -a¦ -*node.allocated.values* + -_optional_ -a¦ - -[markdown] +a¦ *node.allocated.values* + +optional +a¦ [markdown] -- The total number of values allocated to contain documents or computations around documents. (This is only of relevance internally.) @@ -8523,13 +7096,9 @@ The total number of values allocated to contain documents or computations around [%hardbreaks] {blank} a¦ Integer - -a¦ -*node.memory.usage* + -_optional_ -a¦ - -[markdown] +a¦ *node.memory.usage* + +optional +a¦ [markdown] -- The currently allocated document memory on the node. -- @@ -8537,13 +7106,9 @@ The currently allocated document memory on the node. [%hardbreaks] {blank} a¦ Integer - -a¦ -*cpu.user.percent* + -_optional_ -a¦ - -[markdown] +a¦ *cpu.user.percent* + +optional +a¦ [markdown] -- CPU usage. The percentage of time spent executing user code since the last time the statistics were checked. @@ -8552,13 +7117,9 @@ The percentage of time spent executing user code since the last time the statist [%hardbreaks] {blank} a¦ Long (int64) - -a¦ -*cpu.sys.percent* + -_optional_ -a¦ - -[markdown] +a¦ *cpu.sys.percent* + +optional +a¦ [markdown] -- CPU usage. The percentage of time spent executing system code since the last time the statistics were checked. @@ -8567,13 +7128,9 @@ The percentage of time spent executing system code since the last time the stati [%hardbreaks] {blank} a¦ Long (int64) - -a¦ -*process.memory.usage* + -_optional_ -a¦ - -[markdown] +a¦ *process.memory.usage* + +optional +a¦ [markdown] -- Current process memory use. -- @@ -8581,27 +7138,19 @@ Current process memory use. [%hardbreaks] {blank} a¦ Integer - -a¦ -*process.percore.cpupercent* + -_optional_ -a¦ - -[markdown] +a¦ *process.percore.cpupercent* + +optional +a¦ [markdown] -- Average CPU usage per core. -- [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*process.rss* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *process.rss* + +optional +a¦ [markdown] -- Process RSS (bytes) -- @@ -8609,13 +7158,9 @@ Process RSS (bytes) [%hardbreaks] {blank} a¦ Integer - -a¦ -*process.service.usage* + -_optional_ -a¦ - -[markdown] +a¦ *process.service.usage* + +optional +a¦ [markdown] -- The number of active servicers for the dominant workload — unbound queue servicers or plus queue servicers. -- @@ -8623,13 +7168,9 @@ The number of active servicers for the dominant workload — unbound queue s [%hardbreaks] {blank} a¦ Integer - -a¦ -*request.completed.count* + -_optional_ -a¦ - -[markdown] +a¦ *request.completed.count* + +optional +a¦ [markdown] -- Total number of completed requests. -- @@ -8637,13 +7178,9 @@ Total number of completed requests. [%hardbreaks] {blank} a¦ Integer - -a¦ -*request.active.count* + -_optional_ -a¦ - -[markdown] +a¦ *request.active.count* + +optional +a¦ [markdown] -- Total number of active requests. -- @@ -8651,13 +7188,9 @@ Total number of active requests. [%hardbreaks] {blank} a¦ Integer - -a¦ -*request.per.sec.1min* + -_optional_ -a¦ - -[markdown] +a¦ *request.per.sec.1min* + +optional +a¦ [markdown] -- Number of query requests processed per second. 1-minute exponentially weighted moving average. @@ -8665,14 +7198,10 @@ Number of query requests processed per second. [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*request.per.sec.5min* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *request.per.sec.5min* + +optional +a¦ [markdown] -- Number of query requests processed per second. 5-minute exponentially weighted moving average. @@ -8680,14 +7209,10 @@ Number of query requests processed per second. [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*request.per.sec.15min* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *request.per.sec.15min* + +optional +a¦ [markdown] -- Number of query requests processed per second. 15-minute exponentially weighted moving average. @@ -8695,14 +7220,10 @@ Number of query requests processed per second. [%hardbreaks] {blank} -a¦ Big Decimal - -a¦ -*request.queued.count* + -_optional_ -a¦ - -[markdown] +a¦ BigDecimal +a¦ *request.queued.count* + +optional +a¦ [markdown] -- Number of queued requests. -- @@ -8710,13 +7231,9 @@ Number of queued requests. [%hardbreaks] {blank} a¦ Integer - -a¦ -*request.quota.used.hwm* + -_optional_ -a¦ - -[markdown] +a¦ *request.quota.used.hwm* + +optional +a¦ [markdown] -- High water mark for request quota use. -- @@ -8724,13 +7241,9 @@ High water mark for request quota use. [%hardbreaks] {blank} a¦ Integer - -a¦ -*request_time.mean* + -_optional_ -a¦ - -[markdown] +a¦ *request_time.mean* + +optional +a¦ [markdown] -- End-to-end time to process a query. The mean value. @@ -8739,13 +7252,9 @@ The mean value. [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*request_time.median* + -_optional_ -a¦ - -[markdown] +a¦ *request_time.median* + +optional +a¦ [markdown] -- End-to-end time to process a query. The median value. @@ -8754,13 +7263,9 @@ The median value. [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*request_time.80percentile* + -_optional_ -a¦ - -[markdown] +a¦ *request_time.80percentile* + +optional +a¦ [markdown] -- End-to-end time to process a query. The 80th percentile. @@ -8769,13 +7274,9 @@ The 80th percentile. [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*request_time.95percentile* + -_optional_ -a¦ - -[markdown] +a¦ *request_time.95percentile* + +optional +a¦ [markdown] -- End-to-end time to process a query. The 95th percentile. @@ -8784,13 +7285,9 @@ The 95th percentile. [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*request_time.99percentile* + -_optional_ -a¦ - -[markdown] +a¦ *request_time.99percentile* + +optional +a¦ [markdown] -- End-to-end time to process a query. The 99th percentile. @@ -8799,13 +7296,9 @@ The 99th percentile. [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*request.prepared.percent* + -_optional_ -a¦ - -[markdown] +a¦ *request.prepared.percent* + +optional +a¦ [markdown] -- Percentage of requests that are prepared statements. -- @@ -8813,13 +7306,9 @@ Percentage of requests that are prepared statements. [%hardbreaks] {blank} a¦ Integer - -a¦ -*servicers.paused.count* + -_optional_ -a¦ - -[markdown] +a¦ *servicers.paused.count* + +optional +a¦ [markdown] -- Number of servicers temporarily paused due to memory pressure. (Applies to serverless environments only.) @@ -8828,13 +7317,9 @@ Number of servicers temporarily paused due to memory pressure. [%hardbreaks] {blank} a¦ Integer - -a¦ -*servicers.paused.total* + -_optional_ -a¦ - -[markdown] +a¦ *servicers.paused.total* + +optional +a¦ [markdown] -- Number of times servicers have been temporarily paused. (Applies to serverless environments only.) @@ -8843,13 +7328,9 @@ Number of times servicers have been temporarily paused. [%hardbreaks] {blank} a¦ Integer - -a¦ -*temp.hwm* + -_optional_ -a¦ - -[markdown] +a¦ *temp.hwm* + +optional +a¦ [markdown] -- High water mark for temp space use directly by query. (Doesn't include use by the GSI and Search clients.) @@ -8858,13 +7339,9 @@ High water mark for temp space use directly by query. [%hardbreaks] {blank} a¦ Integer - -a¦ -*temp.usage* + -_optional_ -a¦ - -[markdown] +a¦ *temp.usage* + +optional +a¦ [markdown] -- Current Query temp space use. (Doesn't include use by the GSI and Search clients.) @@ -8880,47 +7357,43 @@ a¦ Integer -// markup not found, no include::{specDir}definitions/Vitals/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Vitals/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Vitals/definition-after.adoc[opts=optional] - +ifndef::show-Vitals[] +:leveloffset: -1 +endif::show-Vitals[] +include::{specDir}definitions/Vitals/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] - +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security :leveloffset: +1 -// markup not found, no include::{specDir}security/document-begin.adoc[opts=optional] - +include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/Default/security-scheme-before.adoc[opts=optional] -// markup not found, no include::{specDir}security/Default/security-scheme-before.adoc[opts=optional] - - -[[security-default]] +[[security-Default]] = Default :leveloffset: +1 -// markup not found, no include::{specDir}security/Default/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Default/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -8929,16 +7402,13 @@ Credentials can be passed via HTTP headers (HTTP basic authentication). -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/Default/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Default/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/Default/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/Default/security-scheme-after.adoc[opts=optional] @@ -8946,8 +7416,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/n1ql-rest-functions/functions.gradle b/docs/modules/n1ql-rest-functions/functions.gradle index e252e8e2..3ca6bc7a 100644 --- a/docs/modules/n1ql-rest-functions/functions.gradle +++ b/docs/modules/n1ql-rest-functions/functions.gradle @@ -45,6 +45,7 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file diff --git a/docs/modules/n1ql-rest-functions/pages/index.adoc b/docs/modules/n1ql-rest-functions/pages/index.adoc index becdc545..93b28638 100644 --- a/docs/modules/n1ql-rest-functions/pages/index.adoc +++ b/docs/modules/n1ql-rest-functions/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbase/query :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -32,7 +31,7 @@ This API enables you to manage the JavaScript libraries and objects that are use [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -67,7 +66,6 @@ The host name or IP address of a node running the Query Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -83,31 +81,26 @@ The Query Service REST port. Use `18093` for secure access. |=== - include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}overview/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 1 - +:count-apis: 0 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -115,18 +108,14 @@ xref:tag-Default[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Default] = Default :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:delete_library[] @@ -135,36 +124,31 @@ xref:get_library[] xref:post_library[] -//tag::delete_library[] - -// markup not found, no include::{specDir}paths/delete_library/operation-before.adoc[opts=optional] +//tag::delete_library[] +include::{specDir}paths/delete_library/operation-before.adoc[opts=optional] [#delete_library] = Delete a Library :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_library/operation-begin.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-begin.adoc[opts=optional] .... DELETE /evaluator/v1/libraries/{library} .... - -// markup not found, no include::{specDir}paths/delete_library/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-description-before.adoc[opts=optional] [#delete_library-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_library/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -174,29 +158,25 @@ By default, this operation deletes a global library. For a scoped library, you must specify the bucket and scope. -- - include::{specDir}paths/delete_library/operation-description-end.adoc[opts=optional] -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/delete_library/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/delete_library/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_library/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/delete_library/operation-parameters-before.adoc[opts=optional] [#delete_library-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_library/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-parameters-begin.adoc[opts=optional] [#delete_library-path] .Path Parameters @@ -207,11 +187,8 @@ include::{specDir}paths/delete_library/operation-description-end.adoc[opts=optio ¦ Name ¦ Description ¦ Schema a¦ *library* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a library. -- @@ -222,7 +199,6 @@ The name of a library. a¦ String |=== - [#delete_library-query] .Query Parameters {blank} @@ -232,11 +208,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped libraries only. The bucket in which the library is stored. @@ -246,13 +219,9 @@ The bucket in which the library is stored. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped libraries only. The scope in which the library is stored. @@ -266,29 +235,24 @@ a¦ String |=== - - - include::{specDir}paths/delete_library/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/delete_library/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/delete_library/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_library/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-responses-before.adoc[opts=optional] [#delete_library-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_library/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -300,12 +264,14 @@ a| [markdown] The operation was successful. -- a| + | 400 a| [markdown] -- Bad request. The path may not conform to the schema. -- a| + | 404 a| [markdown] -- @@ -315,97 +281,81 @@ a| |=== - -// markup not found, no include::{specDir}paths/delete_library/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/delete_library/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/delete_library/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/delete_library/operation-security-before.adoc[opts=optional] +include::{specDir}paths/delete_library/operation-security-before.adoc[opts=optional] [#delete_library-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/delete_library/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scope[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scope[] -// markup not found, no include::{specDir}paths/delete_library/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/delete_library/operation-security-after.adoc[opts=optional] +include::{specDir}paths/delete_library/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/delete_library/operation-security-after.adoc[opts=optional] include::{snippetDir}delete_library/http-request.adoc[opts=optional] +include::{snippetDir}delete_library/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}delete_library/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/delete_library/operation-end.adoc[opts=optional] +include::{specDir}paths/delete_library/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/delete_library/operation-after.adoc[opts=optional] - +include::{specDir}paths/delete_library/operation-after.adoc[opts=optional] //end::delete_library[] - //tag::get_collection[] - -// markup not found, no include::{specDir}paths/get_collection/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-before.adoc[opts=optional] [#get_collection] = Read All Libraries :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_collection/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-begin.adoc[opts=optional] .... GET /evaluator/v1/libraries .... - -// markup not found, no include::{specDir}paths/get_collection/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-description-before.adoc[opts=optional] [#get_collection-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_collection/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -416,8 +366,7 @@ By default, this operation returns all global libraries and functions, and all s To return all the libraries and functions in a single scope, specify a bucket and scope. -- - -// markup not found, no include::{specDir}paths/get_collection/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-description-end.adoc[opts=optional] @@ -425,24 +374,20 @@ To return all the libraries and functions in a single scope, specify a bucket an .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_collection/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_collection/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_collection/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-parameters-before.adoc[opts=optional] [#get_collection-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_collection/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/get_collection/operation-parameters-begin.adoc[opts=optional] [#get_collection-query] .Query Parameters @@ -453,11 +398,8 @@ To return all the libraries and functions in a single scope, specify a bucket an ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped libraries only. The bucket from which to fetch libraries. @@ -467,13 +409,9 @@ The bucket from which to fetch libraries. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped libraries only. The scope from which to fetch libraries. @@ -487,29 +425,24 @@ a¦ String |=== - - - include::{specDir}paths/get_collection/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_collection/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_collection/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-responses-before.adoc[opts=optional] [#get_collection-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_collection/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -520,8 +453,7 @@ a| [markdown] -- An array of objects, each giving information about a single library. -- -a| xref:Libraries[] - array +a| xref:Libraries[] array | 400 a| [markdown] @@ -532,97 +464,82 @@ a| |=== - -// markup not found, no include::{specDir}paths/get_collection/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Libraries: -// markup not found, no include::{specDir}paths/get_collection/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_collection/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-security-before.adoc[opts=optional] [#get_collection-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_collection/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scope[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scope[] -// markup not found, no include::{specDir}paths/get_collection/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/get_collection/operation-security-after.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_collection/operation-security-after.adoc[opts=optional] include::{snippetDir}get_collection/http-request.adoc[opts=optional] - include::{snippetDir}get_collection/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_collection/operation-end.adoc[opts=optional] +include::{specDir}paths/get_collection/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_collection/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_collection/operation-after.adoc[opts=optional] //end::get_collection[] - //tag::get_library[] - -// markup not found, no include::{specDir}paths/get_library/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_library/operation-before.adoc[opts=optional] [#get_library] = Read a Library :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_library/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_library/operation-begin.adoc[opts=optional] .... GET /evaluator/v1/libraries/{library} .... - -// markup not found, no include::{specDir}paths/get_library/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_library/operation-description-before.adoc[opts=optional] [#get_library-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_library/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_library/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -633,8 +550,7 @@ By default, this operation returns a global library. For a scoped library, you must specify the bucket and scope. -- - -// markup not found, no include::{specDir}paths/get_library/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_library/operation-description-end.adoc[opts=optional] @@ -642,23 +558,20 @@ For a scoped library, you must specify the bucket and scope. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_library/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_library/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_library/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_library/operation-parameters-before.adoc[opts=optional] [#get_library-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_library/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/get_library/operation-parameters-begin.adoc[opts=optional] [#get_library-path] .Path Parameters @@ -669,11 +582,8 @@ For a scoped library, you must specify the bucket and scope. ¦ Name ¦ Description ¦ Schema a¦ *library* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a library. -- @@ -684,7 +594,6 @@ The name of a library. a¦ String |=== - [#get_library-query] .Query Parameters {blank} @@ -694,11 +603,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped libraries only. The bucket in which the library is stored. @@ -708,13 +614,9 @@ The bucket in which the library is stored. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped libraries only. The scope in which the library is stored. @@ -728,29 +630,24 @@ a¦ String |=== - - - include::{specDir}paths/get_library/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/get_library/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/get_library/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_library/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_library/operation-responses-before.adoc[opts=optional] [#get_library-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_library/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_library/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -769,6 +666,7 @@ a| [markdown] Bad request. The path may not conform to the schema. -- a| + | 404 a| [markdown] -- @@ -778,97 +676,82 @@ a| |=== - -// markup not found, no include::{specDir}paths/get_library/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_library/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Functions: -// markup not found, no include::{specDir}paths/get_library/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_library/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_library/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_library/operation-security-before.adoc[opts=optional] [#get_library-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_library/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_library/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scope[] -| http (basic) -| xref:security-global[] - -|=== +| xref:security-Scope[] -// markup not found, no include::{specDir}paths/get_library/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/get_library/operation-security-after.adoc[opts=optional] +include::{specDir}paths/get_library/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_library/operation-security-after.adoc[opts=optional] include::{snippetDir}get_library/http-request.adoc[opts=optional] - include::{snippetDir}get_library/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_library/operation-end.adoc[opts=optional] +include::{specDir}paths/get_library/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_library/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_library/operation-after.adoc[opts=optional] //end::get_library[] - //tag::post_library[] - -// markup not found, no include::{specDir}paths/post_library/operation-before.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-before.adoc[opts=optional] [#post_library] = Create or Update a Library :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_library/operation-begin.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-begin.adoc[opts=optional] .... POST /evaluator/v1/libraries/{library} .... - -// markup not found, no include::{specDir}paths/post_library/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-description-before.adoc[opts=optional] [#post_library-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_library/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -880,7 +763,6 @@ By default, this operation creates or updates a global library. For a scoped library, you must specify the bucket and scope. -- - include::{specDir}paths/post_library/operation-description-end.adoc[opts=optional] @@ -889,23 +771,20 @@ include::{specDir}paths/post_library/operation-description-end.adoc[opts=optiona * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/post_library/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/post_library/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_library/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/post_library/operation-parameters-before.adoc[opts=optional] [#post_library-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_library/operation-parameters-begin.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-parameters-begin.adoc[opts=optional] [#post_library-path] .Path Parameters @@ -916,11 +795,8 @@ include::{specDir}paths/post_library/operation-description-end.adoc[opts=optiona ¦ Name ¦ Description ¦ Schema a¦ *library* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- The name of a library. -- @@ -931,7 +807,6 @@ The name of a library. a¦ String |=== - [#post_library-query] .Query Parameters {blank} @@ -941,11 +816,8 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *bucket* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped libraries only. The bucket in which the library is stored. @@ -955,13 +827,9 @@ The bucket in which the library is stored. {blank} a¦ String - a¦ *scope* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- For scoped libraries only. The scope in which the library is stored. @@ -973,9 +841,6 @@ The scope in which the library is stored. a¦ String |=== - - - [#post_library-body] .Body Parameter {blank} @@ -985,13 +850,10 @@ a¦ String ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -The JavaScript code for all functions in the library. + -- [%hardbreaks] @@ -1008,20 +870,18 @@ include::{specDir}paths/post_library/operation-parameters-end.adoc[opts=optional -// markup not found, no include::{specDir}paths/post_library/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_library/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/post_library/operation-responses-before.adoc[opts=optional] [#post_library-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_library/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -1033,12 +893,14 @@ a| [markdown] The operation was successful. -- a| + | 400 a| [markdown] -- Bad request. The body of the request may be incorrect, or the path may not conform to the schema. -- a| + | 404 a| [markdown] -- @@ -1048,120 +910,109 @@ a| |=== - -// markup not found, no include::{specDir}paths/post_library/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/post_library/operation-responses-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}paths/post_library/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/post_library/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_library/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-security-before.adoc[opts=optional] [#post_library-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_library/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-scope[] -| http (basic) -| xref:security-global[] +| xref:security-Scope[] -|=== -// markup not found, no include::{specDir}paths/post_library/operation-security-end.adoc[opts=optional] - -:leveloffset: -1 +| http (basic) +| xref:security-Global[] +|=== -// markup not found, no include::{specDir}paths/post_library/operation-security-after.adoc[opts=optional] +include::{specDir}paths/post_library/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/post_library/operation-security-after.adoc[opts=optional] include::{snippetDir}post_library/http-request.adoc[opts=optional] +include::{snippetDir}post_library/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}post_library/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/post_library/operation-end.adoc[opts=optional] +include::{specDir}paths/post_library/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_library/operation-after.adoc[opts=optional] - +include::{specDir}paths/post_library/operation-after.adoc[opts=optional] //end::post_library[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 2 - +:count-models: 1 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:Functions[] xref:Libraries[] endif::[] +include::{specDir}definitions/Functions/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/Functions/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Functions[] [#Functions] +endif::show-Functions[] +ifndef::show-Functions[] +:leveloffset: +1 + +[discrete#Functions] +endif::show-Functions[] = Functions :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Functions/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Functions/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1169,18 +1020,14 @@ endif::collapse-models[] //tag::Functions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -** + -_additional + -property_ -a¦ - -[markdown] +a¦ ** + +additional + +property +a¦ [markdown] -- The JavaScript code for all functions in the library. @@ -1198,28 +1045,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/Functions/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Functions/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Functions/definition-after.adoc[opts=optional] - - - +ifndef::show-Functions[] +:leveloffset: -1 +endif::show-Functions[] -// markup not found, no include::{specDir}definitions/Libraries/definition-before.adoc[opts=optional] +include::{specDir}definitions/Functions/definition-after.adoc[opts=optional] +include::{specDir}definitions/Libraries/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Libraries[] [#Libraries] +endif::show-Libraries[] +ifndef::show-Libraries[] +:leveloffset: +1 + +[discrete#Libraries] +endif::show-Libraries[] = Library :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Libraries/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Libraries/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1227,17 +1077,13 @@ endif::collapse-models[] //tag::Libraries[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*name* + -_required_ -a¦ - -[markdown] +a¦ *name* + +required +a¦ [markdown] -- The name of a library. -- @@ -1246,13 +1092,9 @@ The name of a library. *Example:* `+++"math"+++` {blank} a¦ String - -a¦ -*bucket* + -_required_ -a¦ - -[markdown] +a¦ *bucket* + +required +a¦ [markdown] -- For scoped libraries, the bucket in which the library is stored. For global libraries, this string is empty. @@ -1262,13 +1104,9 @@ For global libraries, this string is empty. *Example:* `+++"travel-sample"+++` {blank} a¦ String - -a¦ -*scope* + -_required_ -a¦ - -[markdown] +a¦ *scope* + +required +a¦ [markdown] -- For scoped libraries, the scope in which the library is stored. For global libraries, this string is empty. @@ -1278,13 +1116,9 @@ For global libraries, this string is empty. *Example:* `+++"inventory"+++` {blank} a¦ String - -a¦ -*code* + -_required_ -a¦ - -[markdown] +a¦ *code* + +required +a¦ [markdown] -- The JavaScript code for all functions in the library. -- @@ -1300,26 +1134,26 @@ a¦ String -// markup not found, no include::{specDir}definitions/Libraries/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Libraries/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Libraries/definition-after.adoc[opts=optional] - +ifndef::show-Libraries[] +:leveloffset: -1 +endif::show-Libraries[] +include::{specDir}definitions/Libraries/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] - +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -1329,18 +1163,14 @@ a¦ String include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/Global/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/Global/security-scheme-before.adoc[opts=optional] - - -[[security-global]] +[[security-Global]] = Global :leveloffset: +1 -// markup not found, no include::{specDir}security/Global/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Global/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -1350,29 +1180,22 @@ This role enables you to create, read, update, or delete any global library, but -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/Global/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Global/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/Global/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/Global/security-scheme-after.adoc[opts=optional] - - - - -// markup not found, no include::{specDir}security/Scope/security-scheme-before.adoc[opts=optional] +include::{specDir}security/Scope/security-scheme-before.adoc[opts=optional] - -[[security-scope]] +[[security-Scope]] = Scope :leveloffset: +1 -// markup not found, no include::{specDir}security/Scope/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Scope/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -1383,16 +1206,13 @@ In addition, this role enables you to read any global library, but not to create -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/Scope/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Scope/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/Scope/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/Scope/security-scheme-after.adoc[opts=optional] @@ -1400,8 +1220,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - -// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] +include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/n1ql-rest-query/pages/index.adoc b/docs/modules/n1ql-rest-query/pages/index.adoc index 16ee40fe..49836e14 100644 --- a/docs/modules/n1ql-rest-query/pages/index.adoc +++ b/docs/modules/n1ql-rest-query/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbase/query :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -32,7 +31,7 @@ This API enables you to run SQL++ queries and set request-level parameters. [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -67,7 +66,6 @@ The host name or IP address of a node running the Query Service. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -83,31 +81,26 @@ The Query Service REST port. Use `18093` for secure access. |=== - include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}overview/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 1 - +:count-apis: 0 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -115,54 +108,45 @@ xref:tag-Default[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Default] = Default :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:get_service[] xref:post_service[] -//tag::get_service[] - -// markup not found, no include::{specDir}paths/get_service/operation-before.adoc[opts=optional] +//tag::get_service[] +include::{specDir}paths/get_service/operation-before.adoc[opts=optional] [#get_service] = Read-Only Query Service :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_service/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-begin.adoc[opts=optional] .... GET /query/service .... - -// markup not found, no include::{specDir}paths/get_service/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-description-before.adoc[opts=optional] [#get_service-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_service/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -172,8 +156,7 @@ This method allows you to run SELECT queries, and specify query parameters. This endpoint is intended for situations where use of the `POST` method is restricted. -- - -// markup not found, no include::{specDir}paths/get_service/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_service/operation-description-end.adoc[opts=optional] @@ -181,24 +164,20 @@ This endpoint is intended for situations where use of the `POST` method is restr .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_service/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_service/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_service/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_service/operation-parameters-before.adoc[opts=optional] [#get_service-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_service/operation-parameters-begin.adoc[opts=optional] - - +include::{specDir}paths/get_service/operation-parameters-begin.adoc[opts=optional] [#get_service-query] .Query Parameters @@ -209,11 +188,8 @@ This endpoint is intended for situations where use of the `POST` method is restr ¦ Name ¦ Description ¦ Schema a¦ *body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- Specify the parameters in the query URL in URL-encoded format. The format for URL-encoded parameters is consistent with the syntax for variables according to RFC 6570. @@ -227,21 +203,18 @@ a¦ xref:Request[] |=== - - - -// markup not found, no include::{specDir}paths/get_service/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/get_service/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Request: -// markup not found, no include::{specDir}paths/get_service/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_service/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_service/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-responses-before.adoc[opts=optional] [#get_service-responses] = Responses @@ -250,7 +223,6 @@ a¦ xref:Request[] include::{specDir}paths/get_service/operation-responses-begin.adoc[opts=optional] - [cols="20,60,20"] |=== | HTTP Code | Description | Schema @@ -275,12 +247,14 @@ a| [markdown] Unauthorized. The credentials provided with the request are missing or invalid. -- a| + | 403 a| [markdown] -- Forbidden. There is a read-only violation. Either there was an attempt to create or update in a GET request or a POST request where `readonly` is set, or the client does not have the authorization to modify an object (index, keyspace or namespace) in the statement. -- a| + | 404 a| [markdown] -- @@ -294,30 +268,35 @@ a| [markdown] Method not allowed. The statement in the request references an invalid namespace or keyspace. -- a| + | 409 a| [markdown] -- Conflict. There is an attempt to create an object (keyspace or index) that already exists. -- a| + | 410 a| [markdown] -- Gone. The server is shutting down gracefully. Previously made requests are being completed, but no new requests are being accepted. -- a| + | 413 a| [markdown] -- Payload too large. The query is too large for the Query Service to process. -- a| + | 500 a| [markdown] -- Internal server error. There was an unforeseen problem processing the request. -- a| + | 503 a| [markdown] -- @@ -325,100 +304,87 @@ Service unavailable. There is an issue (that is possibly temporary) preventing t -- a| xref:Response[] - |=== - -// markup not found, no include::{specDir}paths/get_service/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_service/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Response: +:show-Response: +:show-Response: +:show-Response: -// markup not found, no include::{specDir}paths/get_service/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_service/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_service/operation-security-before.adoc[opts=optional] [#get_service-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_service/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-header[] -| apiKey -| xref:security-parameter[] +| xref:security-Header[] -|=== -// markup not found, no include::{specDir}paths/get_service/operation-security-end.adoc[opts=optional] - -:leveloffset: -1 +| apiKey +| xref:security-Parameter[] +|=== -// markup not found, no include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional] +include::{specDir}paths/get_service/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional] include::{snippetDir}get_service/http-request.adoc[opts=optional] +include::{snippetDir}get_service/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}get_service/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/get_service/operation-end.adoc[opts=optional] +include::{specDir}paths/get_service/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_service/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_service/operation-after.adoc[opts=optional] //end::get_service[] - //tag::post_service[] - -// markup not found, no include::{specDir}paths/post_service/operation-before.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-before.adoc[opts=optional] [#post_service] = Query Service :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_service/operation-begin.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-begin.adoc[opts=optional] .... POST /query/service .... - -// markup not found, no include::{specDir}paths/post_service/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-description-before.adoc[opts=optional] [#post_service-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_service/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-description-begin.adoc[opts=optional] [markdown] -- @@ -426,8 +392,7 @@ Enables you to execute a SQL++ statement. This method allows you to run SELECT queries and other DML statements, and specify query parameters. -- - -// markup not found, no include::{specDir}paths/post_service/operation-description-end.adoc[opts=optional] +include::{specDir}paths/post_service/operation-description-end.adoc[opts=optional] [#post_service-consumes] @@ -439,15 +404,13 @@ This method allows you to run SELECT queries and other DML statements, and speci .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/post_service/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/post_service/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_service/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/post_service/operation-parameters-before.adoc[opts=optional] [#post_service-parameters] = Parameters @@ -456,11 +419,6 @@ This method allows you to run SELECT queries and other DML statements, and speci include::{specDir}paths/post_service/operation-parameters-begin.adoc[opts=optional] - - - - - [#post_service-body] .Body Parameter {blank} @@ -470,13 +428,10 @@ include::{specDir}paths/post_service/operation-parameters-begin.adoc[opts=option ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_required_ -a¦ - - -[markdown] +required +a¦ [markdown] -- -An object specifying one or more query parameters. + -- [%hardbreaks] @@ -487,18 +442,18 @@ a¦ xref:Request[] |=== -// markup not found, no include::{specDir}paths/post_service/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/post_service/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Request: -// markup not found, no include::{specDir}paths/post_service/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_service/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/post_service/operation-responses-before.adoc[opts=optional] [#post_service-responses] = Responses @@ -507,7 +462,6 @@ a¦ xref:Request[] include::{specDir}paths/post_service/operation-responses-begin.adoc[opts=optional] - [cols="20,60,20"] |=== | HTTP Code | Description | Schema @@ -532,12 +486,14 @@ a| [markdown] Unauthorized. The credentials provided with the request are missing or invalid. -- a| + | 403 a| [markdown] -- Forbidden. There is a read-only violation. Either there was an attempt to create or update in a GET request or a POST request where `readonly` is set, or the client does not have the authorization to modify an object (index, keyspace or namespace) in the statement. -- a| + | 404 a| [markdown] -- @@ -551,30 +507,35 @@ a| [markdown] Method not allowed. The statement in the request references an invalid namespace or keyspace. -- a| + | 409 a| [markdown] -- Conflict. There is an attempt to create an object (keyspace or index) that already exists. -- a| + | 410 a| [markdown] -- Gone. The server is shutting down gracefully. Previously made requests are being completed, but no new requests are being accepted. -- a| + | 413 a| [markdown] -- Payload too large. The query is too large for the Query Service to process. -- a| + | 500 a| [markdown] -- Internal server error. There was an unforeseen problem processing the request. -- a| + | 503 a| [markdown] -- @@ -582,104 +543,94 @@ Service unavailable. There is an issue (that is possibly temporary) preventing t -- a| xref:Response[] - |=== - -// markup not found, no include::{specDir}paths/post_service/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/post_service/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Response: +:show-Response: +:show-Response: +:show-Response: -// markup not found, no include::{specDir}paths/post_service/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/post_service/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_service/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-security-before.adoc[opts=optional] [#post_service-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_service/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-header[] -| apiKey -| xref:security-parameter[] - -|=== +| xref:security-Header[] -// markup not found, no include::{specDir}paths/post_service/operation-security-end.adoc[opts=optional] -:leveloffset: -1 +| apiKey +| xref:security-Parameter[] +|=== -// markup not found, no include::{specDir}paths/post_service/operation-security-after.adoc[opts=optional] +include::{specDir}paths/post_service/operation-security-end.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/post_service/operation-security-after.adoc[opts=optional] include::{snippetDir}post_service/http-request.adoc[opts=optional] +include::{snippetDir}post_service/http-response.adoc[opts=optional] -// markup not found, no include::{snippetDir}post_service/http-response.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/post_service/operation-end.adoc[opts=optional] +include::{specDir}paths/post_service/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_service/operation-after.adoc[opts=optional] - +include::{specDir}paths/post_service/operation-after.adoc[opts=optional] //end::post_service[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}paths/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 9 - +:count-models: 8 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:Conditions[] xref:Controls[] @@ -693,19 +644,27 @@ xref:Statistics[] endif::[] +include::{specDir}definitions/Conditions/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/Conditions/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Conditions[] [#Conditions] +endif::show-Conditions[] +ifndef::show-Conditions[] +:leveloffset: +1 + +[discrete#Conditions] +endif::show-Conditions[] = Conditions +ifdef::model-descriptions[] +//tag::desc-Conditions[] +Errors and warnings have the following format. +//end::desc-Conditions[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Conditions/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Conditions/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -713,22 +672,13 @@ endif::collapse-models[] //tag::Conditions[] -ifdef::model-descriptions[] -//tag::desc-Conditions[] -Errors and warnings have the following format. -//end::desc-Conditions[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*code* + -_required_ -a¦ - -[markdown] +a¦ *code* + +required +a¦ [markdown] -- A unique number that identifies the error or warning. The code ranges are partitioned by component. @@ -739,13 +689,9 @@ This property is always present in every condition returned in the Query REST AP [%hardbreaks] {blank} a¦ Integer - -a¦ -*msg* + -_required_ -a¦ - -[markdown] +a¦ *msg* + +required +a¦ [markdown] -- A message describing the error or warning in detail. This property is always present in every condition returned in the Query REST API or captured in a log. @@ -754,13 +700,9 @@ This property is always present in every condition returned in the Query REST AP [%hardbreaks] {blank} a¦ String - -a¦ -*name* + -_optional_ -a¦ - -[markdown] +a¦ *name* + +optional +a¦ [markdown] -- Unique name that has a 1:1 mapping to the code. Uniquely identifies the condition. @@ -772,13 +714,9 @@ The name should be fully qualified. *Example:* `+++"indexing.scan.io_failure"+++` {blank} a¦ String - -a¦ -*sev* + -_optional_ -a¦ - -[markdown] +a¦ *sev* + +optional +a¦ [markdown] -- One of the following SQL++ severity levels, listed in order of severity: @@ -791,13 +729,9 @@ One of the following SQL++ severity levels, listed in order of severity: [%hardbreaks] {blank} a¦ Integer - -a¦ -*temp* + -_optional_ -a¦ - -[markdown] +a¦ *temp* + +optional +a¦ [markdown] -- Indicates if the condition is transient — for example, the queue is full. If the value is `false`, it tells clients and users that a retry without modification produces the same condition. @@ -815,26 +749,36 @@ a¦ Boolean include::{specDir}definitions/Conditions/definition-end.adoc[opts=optional] - :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Conditions/definition-after.adoc[opts=optional] - - - +ifndef::show-Conditions[] +:leveloffset: -1 +endif::show-Conditions[] -// markup not found, no include::{specDir}definitions/Controls/definition-before.adoc[opts=optional] +include::{specDir}definitions/Conditions/definition-after.adoc[opts=optional] +include::{specDir}definitions/Controls/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Controls[] [#Controls] +endif::show-Controls[] +ifndef::show-Controls[] +:leveloffset: +1 + +[discrete#Controls] +endif::show-Controls[] = Controls +ifdef::model-descriptions[] +//tag::desc-Controls[] +An object containing runtime information provided along with the request. +Present only if `controls` was set to true in the request parameters. +//end::desc-Controls[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Controls/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Controls/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -842,23 +786,13 @@ endif::collapse-models[] //tag::Controls[] -ifdef::model-descriptions[] -//tag::desc-Controls[] -An object containing runtime information provided along with the request. -Present only if `controls` was set to true in the request parameters. -//end::desc-Controls[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*scan_consistency* + -_optional_ -a¦ - -[markdown] +a¦ *scan_consistency* + +optional +a¦ [markdown] -- The value of the query setting Scan Consistency used for the query. -- @@ -866,13 +800,9 @@ The value of the query setting Scan Consistency used for the query. [%hardbreaks] {blank} a¦ String - -a¦ -*use_cbo* + -_optional_ -a¦ - -[markdown] +a¦ *use_cbo* + +optional +a¦ [markdown] -- Whether the cost-based optimizer was enabled for the query. -- @@ -880,13 +810,9 @@ Whether the cost-based optimizer was enabled for the query. [%hardbreaks] {blank} a¦ Boolean - -a¦ -*memoryQuota* + -_optional_ -a¦ - -[markdown] +a¦ *memoryQuota* + +optional +a¦ [markdown] -- The memory quota for the request, in MB. This property is only returned if a memory quota was set for the query. @@ -895,13 +821,9 @@ This property is only returned if a memory quota was set for the query. [%hardbreaks] {blank} a¦ Integer (unsigned) - -a¦ -*stmtType* + -_optional_ -a¦ - -[markdown] +a¦ *stmtType* + +optional +a¦ [markdown] -- The type of query statement. -- @@ -919,26 +841,29 @@ a¦ String include::{specDir}definitions/Controls/definition-end.adoc[opts=optional] - :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Controls/definition-after.adoc[opts=optional] - - - +ifndef::show-Controls[] +:leveloffset: -1 +endif::show-Controls[] -// markup not found, no include::{specDir}definitions/Credentials/definition-before.adoc[opts=optional] +include::{specDir}definitions/Controls/definition-after.adoc[opts=optional] +include::{specDir}definitions/Credentials/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Credentials[] [#Credentials] +endif::show-Credentials[] +ifndef::show-Credentials[] +:leveloffset: +1 + +[discrete#Credentials] +endif::show-Credentials[] = Credentials :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Credentials/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Credentials/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -946,17 +871,13 @@ endif::collapse-models[] //tag::Credentials[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*user* + -_optional_ -a¦ - -[markdown] +a¦ *user* + +optional +a¦ [markdown] -- An identity for authentication. Note that bucket names may be prefixed with `local:`, and admin names may be prefixed with `admin:`. @@ -966,13 +887,9 @@ Note that bucket names may be prefixed with `local:`, and admin names may be pre *Example:* `+++"local:bucket-name"+++` {blank} a¦ String - -a¦ -*pass* + -_optional_ -a¦ - -[markdown] +a¦ *pass* + +optional +a¦ [markdown] -- A password for authentication. -- @@ -988,28 +905,39 @@ a¦ String -// markup not found, no include::{specDir}definitions/Credentials/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Credentials/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Credentials/definition-after.adoc[opts=optional] +ifndef::show-Credentials[] +:leveloffset: -1 +endif::show-Credentials[] +include::{specDir}definitions/Credentials/definition-after.adoc[opts=optional] +include::{specDir}definitions/Execution_Timings/definition-before.adoc[opts=optional] +ifdef::show-Execution_Timings[] +[#Execution_Timings] +endif::show-Execution_Timings[] +ifndef::show-Execution_Timings[] +:leveloffset: +1 -// markup not found, no include::{specDir}definitions/Execution_Timings/definition-before.adoc[opts=optional] +[discrete#Execution_Timings] +endif::show-Execution_Timings[] += Execution Timings +ifdef::model-descriptions[] +//tag::desc-Execution_Timings[] +Present only if `profile` was set to `"timings"` in the request parameters. -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] -[#Execution_Timings] -= Execution Timings +The execution details for various phases involved in the query execution, such as kernel and service execution times, number of documents processed at each query operator in each phase, and number of phase switches. +//end::desc-Execution_Timings[] +endif::model-descriptions[] :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Execution_Timings/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Execution_Timings/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1017,24 +945,13 @@ endif::collapse-models[] //tag::Execution_Timings[] -ifdef::model-descriptions[] -//tag::desc-Execution_Timings[] -Present only if `profile` was set to `"timings"` in the request parameters. - -The execution details for various phases involved in the query execution, such as kernel and service execution times, number of documents processed at each query operator in each phase, and number of phase switches. -//end::desc-Execution_Timings[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*#operator* + -_required_ -a¦ - -[markdown] +a¦ *#operator* + +required +a¦ [markdown] -- Name of the operator. -- @@ -1043,13 +960,9 @@ Name of the operator. *Example:* `+++"Fetch"+++` {blank} a¦ String - -a¦ -*#stats* + -_required_ -a¦ - -[markdown] +a¦ *#stats* + +required +a¦ [markdown] -- include::index.adoc[tag=desc-Statistics, opts=optional] -- @@ -1057,13 +970,9 @@ include::index.adoc[tag=desc-Statistics, opts=optional] [%hardbreaks] {blank} a¦ xref:Statistics[] - -a¦ -*~child* + -_optional_ -a¦ - -[markdown] +a¦ *~child* + +optional +a¦ [markdown] -- Further nested operators, each with their own execution timings. -- @@ -1078,28 +987,37 @@ a¦ Object -// markup not found, no include::{specDir}definitions/Execution_Timings/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Execution_Timings/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Execution_Timings/definition-after.adoc[opts=optional] - - - +ifndef::show-Execution_Timings[] +:leveloffset: -1 +endif::show-Execution_Timings[] -// markup not found, no include::{specDir}definitions/Metrics/definition-before.adoc[opts=optional] +include::{specDir}definitions/Execution_Timings/definition-after.adoc[opts=optional] +include::{specDir}definitions/Metrics/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Metrics[] [#Metrics] +endif::show-Metrics[] +ifndef::show-Metrics[] +:leveloffset: +1 + +[discrete#Metrics] +endif::show-Metrics[] = Metrics +ifdef::model-descriptions[] +//tag::desc-Metrics[] +An object containing metrics about the request. +//end::desc-Metrics[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Metrics/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Metrics/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1107,22 +1025,13 @@ endif::collapse-models[] //tag::Metrics[] -ifdef::model-descriptions[] -//tag::desc-Metrics[] -An object containing metrics about the request. -//end::desc-Metrics[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*elapsedTime* + -_required_ -a¦ - -[markdown] +a¦ *elapsedTime* + +required +a¦ [markdown] -- The total time taken for the request, that is the time from when the request was received until the results were returned. -- @@ -1130,13 +1039,9 @@ The total time taken for the request, that is the time from when the request was [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*executionTime* + -_required_ -a¦ - -[markdown] +a¦ *executionTime* + +required +a¦ [markdown] -- The time taken for the execution of the request, that is the time from when query execution started until the results were returned. -- @@ -1144,13 +1049,9 @@ The time taken for the execution of the request, that is the time from when quer [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*resultCount* + -_required_ -a¦ - -[markdown] +a¦ *resultCount* + +required +a¦ [markdown] -- The total number of objects in the results. -- @@ -1158,13 +1059,9 @@ The total number of objects in the results. [%hardbreaks] {blank} a¦ Integer (unsigned) - -a¦ -*resultSize* + -_required_ -a¦ - -[markdown] +a¦ *resultSize* + +required +a¦ [markdown] -- The total number of bytes in the results. -- @@ -1172,13 +1069,9 @@ The total number of bytes in the results. [%hardbreaks] {blank} a¦ Integer (unsigned) - -a¦ -*naturalLanguageProcessingTime* + -_optional_ -a¦ - -[markdown] +a¦ *naturalLanguageProcessingTime* + +optional +a¦ [markdown] -- The total time spent processing a natural language request. The cumulation of authentication, collecting schema, and time waiting for the response from the LLM, or wait time for the natural language request to be serviced. @@ -1187,13 +1080,9 @@ The cumulation of authentication, collecting schema, and time waiting for the re [%hardbreaks] {blank} a¦ String (duration) - -a¦ -*mutationCount* + -_optional_ -a¦ - -[markdown] +a¦ *mutationCount* + +optional +a¦ [markdown] -- The number of mutations that were made during the request. -- @@ -1201,13 +1090,9 @@ The number of mutations that were made during the request. [%hardbreaks] {blank} a¦ Integer (unsigned) - -a¦ -*sortCount* + -_optional_ -a¦ - -[markdown] +a¦ *sortCount* + +optional +a¦ [markdown] -- The number of objects that were sorted. Present only if the request includes `ORDER BY`. @@ -1218,13 +1103,9 @@ If a query includes ORDER BY, LIMIT, or OFFSET clauses, an application can use t [%hardbreaks] {blank} a¦ Integer (unsigned) - -a¦ -*usedMemory* + -_optional_ -a¦ - -[markdown] +a¦ *usedMemory* + +optional +a¦ [markdown] -- The amount of document memory used to execute the request. This property is only returned if a memory quota was set for the query. @@ -1233,13 +1114,9 @@ This property is only returned if a memory quota was set for the query. [%hardbreaks] {blank} a¦ Integer (unsigned) - -a¦ -*errorCount* + -_optional_ -a¦ - -[markdown] +a¦ *errorCount* + +optional +a¦ [markdown] -- The number of errors that occurred during the request. -- @@ -1247,13 +1124,9 @@ The number of errors that occurred during the request. [%hardbreaks] {blank} a¦ Integer (unsigned) - -a¦ -*warningCount* + -_optional_ -a¦ - -[markdown] +a¦ *warningCount* + +optional +a¦ [markdown] -- The number of warnings that occurred during the request. -- @@ -1261,13 +1134,9 @@ The number of warnings that occurred during the request. [%hardbreaks] {blank} a¦ Integer (unsigned) - -a¦ -*sessionMemory* + -_optional_ -a¦ - -[markdown] +a¦ *sessionMemory* + +optional +a¦ [markdown] -- The memory session size for the request, in bytes. @@ -1290,26 +1159,36 @@ a¦ Integer (bytes) include::{specDir}definitions/Metrics/definition-end.adoc[opts=optional] - :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Metrics/definition-after.adoc[opts=optional] - - - +ifndef::show-Metrics[] +:leveloffset: -1 +endif::show-Metrics[] -// markup not found, no include::{specDir}definitions/Profile/definition-before.adoc[opts=optional] +include::{specDir}definitions/Metrics/definition-after.adoc[opts=optional] +include::{specDir}definitions/Profile/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Profile[] [#Profile] +endif::show-Profile[] +ifndef::show-Profile[] +:leveloffset: +1 + +[discrete#Profile] +endif::show-Profile[] = Profile +ifdef::model-descriptions[] +//tag::desc-Profile[] +An object containing monitoring and profiling information about the request. +Present only if `profile` was set to `"phases"` or `"timings"` in the request parameters. +//end::desc-Profile[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Profile/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Profile/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1317,23 +1196,13 @@ endif::collapse-models[] //tag::Profile[] -ifdef::model-descriptions[] -//tag::desc-Profile[] -An object containing monitoring and profiling information about the request. -Present only if `profile` was set to `"phases"` or `"timings"` in the request parameters. -//end::desc-Profile[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*requestTime* + -_required_ -a¦ - -[markdown] +a¦ *requestTime* + +required +a¦ [markdown] -- Timestamp when the query was received. -- @@ -1341,13 +1210,9 @@ Timestamp when the query was received. [%hardbreaks] {blank} a¦ Date (date-time) - -a¦ -*servicingHost* + -_required_ -a¦ - -[markdown] +a¦ *servicingHost* + +required +a¦ [markdown] -- IP address and port number of the node where the query was executed. -- @@ -1355,13 +1220,9 @@ IP address and port number of the node where the query was executed. [%hardbreaks] {blank} a¦ String - -a¦ -*phaseCounts* + -_required_ -a¦ - -[markdown] +a¦ *phaseCounts* + +required +a¦ [markdown] -- Count of documents processed at selective phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc. -- @@ -1370,13 +1231,9 @@ Count of documents processed at selective phases involved in the query execution *Example:* `{"fetch":16,"indexScan":187}` {blank} a¦ Object - -a¦ -*phaseOperators* + -_required_ -a¦ - -[markdown] +a¦ *phaseOperators* + +required +a¦ [markdown] -- Indicates the numbers of each kind of query operator involved in different phases of the query processing. @@ -1391,13 +1248,9 @@ This is in essence the count of all the operators in the `executionTimings` obje *Example:* `{"authorize":1,"fetch":1,"indexScan":2}` {blank} a¦ Object - -a¦ -*phaseTimes* + -_required_ -a¦ - -[markdown] +a¦ *phaseTimes* + +required +a¦ [markdown] -- Cumulative execution times for various phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc. -- @@ -1406,13 +1259,9 @@ Cumulative execution times for various phases involved in the query execution, s *Example:* `{"authorize":"823.631µs","fetch":"656.873µs","indexScan":"29.146543ms","instantiate":"236.221µs","parse":"826.382µs","plan":"11.831101ms","run":"16.892181ms"}` {blank} a¦ Object - -a¦ -*executionTimings* + -_optional_ -a¦ - -[markdown] +a¦ *executionTimings* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-Execution_Timings, opts=optional] -- @@ -1420,13 +1269,9 @@ include::index.adoc[tag=desc-Execution_Timings, opts=optional] [%hardbreaks] {blank} a¦ xref:Execution_Timings[] - -a¦ -*ioTime* + -_optional_ -a¦ - -[markdown] +a¦ *ioTime* + +optional +a¦ [markdown] -- The total sum of [servTime](#serv_time) across all operators. @@ -1436,13 +1281,9 @@ The total sum of [servTime](#serv_time) across all operators. *Example:* `+++"752.858519ms"+++` {blank} a¦ String (duration) - -a¦ -*waitTime* + -_optional_ -a¦ - -[markdown] +a¦ *waitTime* + +optional +a¦ [markdown] -- The total sum of [kernTime](#kern_time) across all operators. @@ -1450,15 +1291,11 @@ The total sum of [kernTime](#kern_time) across all operators. [%hardbreaks] *Example:* `+++"1.201307s"+++` -{blank} -a¦ String (duration) - -a¦ -*cpuTime* + -_optional_ -a¦ - -[markdown] +{blank} +a¦ String (duration) +a¦ *cpuTime* + +optional +a¦ [markdown] -- The total sum of [execTime](#exec_time) across all operators. @@ -1468,13 +1305,9 @@ The total sum of [execTime](#exec_time) across all operators. *Example:* `+++"90.734075ms"+++` {blank} a¦ String (duration) - -a¦ -*~analysis* + -_optional_ -a¦ - -[markdown] +a¦ *~analysis* + +optional +a¦ [markdown] -- An array of text phrases that provide a basic analysis of the request execution. These phrases highlight notable aspects of the execution, such as high document counts during primary scans or warnings related to memory and resource usages. @@ -1484,8 +1317,7 @@ These phrases highlight notable aspects of the execution, such as high document [%hardbreaks] *Example:* `["High IO time","High primary scan document count"]` {blank} -a¦ String - array +a¦ String array |=== @@ -1493,28 +1325,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/Profile/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Profile/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Profile/definition-after.adoc[opts=optional] - - - +ifndef::show-Profile[] +:leveloffset: -1 +endif::show-Profile[] -// markup not found, no include::{specDir}definitions/Request/definition-before.adoc[opts=optional] +include::{specDir}definitions/Profile/definition-after.adoc[opts=optional] +include::{specDir}definitions/Request/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Request[] [#Request] +endif::show-Request[] +ifndef::show-Request[] +:leveloffset: +1 + +[discrete#Request] +endif::show-Request[] = Request Parameters :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Request/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Request/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -1522,17 +1357,14 @@ endif::collapse-models[] //tag::Request[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ [#args] *args* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [section_srh_tlm_n1b]: #section_srh_tlm_n1b @@ -1551,15 +1383,11 @@ Refer to [Named Parameters and Positional Parameters][section_srh_tlm_n1b] for d [%hardbreaks] *Example:* `["LAX",6]` {blank} -a¦ Any Type - array - +a¦ Any Type array a¦ [#atrcollection_req] *atrcollection* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [atrcollection-srv]: #atrcollection-srv @@ -1586,13 +1414,10 @@ The request-level parameter overrides the node-level setting. *Example:* `+++"default:`travel-sample`.transaction.test"+++` {blank} a¦ String - a¦ [#auto_execute] *auto_execute* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [auto-execute]: ../n1ql-language-reference/prepare.html#auto-execute @@ -1611,13 +1436,10 @@ Refer to [Auto-Execute][auto-execute] for more information. *Example:* `true` {blank} a¦ Boolean - a¦ [#client_context_id] *client_context_id* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- A piece of data supplied by the client that is echoed in the response, if present. SQL++ is agnostic about the content of this parameter; it is just echoed in the response. @@ -1629,13 +1451,10 @@ SQL++ is agnostic about the content of this parameter; it is just echoed in the [%hardbreaks] {blank} a¦ String - a¦ [#compression] *compression* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Compression format to use for response data on the wire. @@ -1648,13 +1467,10 @@ Values are case-insensitive. *Example:* `+++"zip"+++` {blank} a¦ String - a¦ [#controls_req] *controls* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [controls-srv]: #controls-srv @@ -1678,13 +1494,10 @@ The request-level parameter overrides the node-level setting. *Example:* `true` {blank} a¦ Boolean - a¦ [#creds] *creds* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Specifies the login credentials. The Query API supports two types of identity: local (or bucket) and admin. @@ -1698,15 +1511,11 @@ If credentials are supplied in the request header, then HTTP Basic Authenticatio [%hardbreaks] *Example:* `[{"user":"local:bucket-name","pass":"password"},{"user":"admin:admin-name","pass":"password"}]` {blank} -a¦ xref:Credentials[] - array - +a¦ xref:Credentials[] array a¦ [#durability_level] *durability_level* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- The level of [durability][durability] for mutations produced by the request. @@ -1727,13 +1536,10 @@ Set the durability level to `"none"` or `""` to specify no durability. *Example:* `+++"none"+++` {blank} a¦ String - a¦ [#encoded_plan] *encoded_plan* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- In clusters running Couchbase Server 6.5 and later, this parameter is ignored and has no effect. It is included for compatibility with previous versions. @@ -1742,13 +1548,10 @@ It is included for compatibility with previous versions. [%hardbreaks] {blank} a¦ String - a¦ [#encoding] *encoding* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Desired character encoding for the query results. @@ -1759,13 +1562,10 @@ Only possible value is `UTF-8` and is case-insensitive. *Default:* `+++"UTF-8"+++` {blank} a¦ String - a¦ [#format] *format* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Desired format for the query results. @@ -1778,13 +1578,10 @@ Values are case-insensitive. *Example:* `+++"XML"+++` {blank} a¦ String - a¦ [#kvtimeout] *kvtimeout* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- The approximate time to wait for a KV get operation before timing out. This applies to statements within a transaction, and to non-transactional statements, whether `durability_level` is set or not. @@ -1811,13 +1608,10 @@ When disabled, no timeout is applied and the KV operation runs for however long *Example:* `+++"10ms"+++` {blank} a¦ String - a¦ [#max_parallelism_req] *max_parallelism* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [max-parallelism-srv]: #max-parallelism-srv @@ -1848,13 +1642,10 @@ To enable queries to run in parallel, you must specify the cluster-level `queryM *Example:* `3` {blank} a¦ Integer (int32) - a¦ [#memory_quota_req] *memory_quota* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [memory-quota-srv]: #memory-quota-srv @@ -1890,13 +1681,10 @@ When you change the cluster-level setting, the node-level setting is overwritten *Example:* `4` {blank} a¦ Integer (int32) - a¦ [#metrics] *metrics* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Specifies that metrics should be returned with query results. -- @@ -1906,13 +1694,10 @@ Specifies that metrics should be returned with query results. *Example:* `false` {blank} a¦ Boolean - a¦ [#namespace] *namespace* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Specifies the namespace to use. Currently, only the `default` namespace is available. @@ -1922,10 +1707,9 @@ Currently, only the `default` namespace is available. *Example:* `+++"default"+++` {blank} a¦ String - a¦ [#natural] *natural* + -_optional_ +optional a¦ [.status]##Couchbase Server 8.0## [markdown] @@ -1951,10 +1735,9 @@ If you don't specify all four parameters, the Query Service returns an error. *Example:* `+++"Show me count of airlines per country"+++` {blank} a¦ String - a¦ [#natural_cred] *natural_cred* + -_optional_ +optional a¦ [.status]##Couchbase Server 8.0## [markdown] @@ -1975,10 +1758,9 @@ If you don't specify all four parameters, the Query Service returns an error. *Example:* `+++"username:password"+++` {blank} a¦ String (password) - a¦ [#natural_orgid] *natural_orgid* + -_optional_ +optional a¦ [.status]##Couchbase Server 8.0## [markdown] @@ -1997,10 +1779,9 @@ If you don't specify all four parameters, the Query Service returns an error. [%hardbreaks] {blank} a¦ UUID (uuid) - a¦ [#natural_context] *natural_context* + -_optional_ +optional a¦ [.status]##Couchbase Server 8.0## [markdown] @@ -2032,10 +1813,9 @@ If you don't specify all four parameters, the Query Service returns an error. *Example:* `+++"travel-sample, travel-sample.inventory.airline, airline"+++` {blank} a¦ String - a¦ [#natural_output] *natural_output* + -_optional_ +optional a¦ [.status]##Couchbase Server 8.0## [markdown] @@ -2062,13 +1842,10 @@ This parameter is available in clusters running Couchbase Server 8.0 and later. *Default:* `+++"sql"+++` {blank} a¦ String - a¦ [#numatrs_req] *numatrs* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Reserved for future use. This parameter is ignored and has no effect. @@ -2077,13 +1854,10 @@ This parameter is ignored and has no effect. [%hardbreaks] {blank} a¦ Integer (int32) - a¦ [#pipeline_batch_req] *pipeline_batch* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [pipeline-batch-srv]: #pipeline-batch-srv @@ -2108,13 +1882,10 @@ When you change the cluster-level setting, the node-level setting is overwritten *Example:* `64` {blank} a¦ Integer (int32) - a¦ [#pipeline_cap_req] *pipeline_cap* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [pipeline-cap-srv]: #pipeline-cap-srv @@ -2139,13 +1910,10 @@ When you change the cluster-level setting, the node-level setting is overwritten *Example:* `1024` {blank} a¦ Integer (int32) - a¦ [#prepared] *prepared* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [execute]: ../n1ql-language-reference/execute.html @@ -2165,13 +1933,10 @@ If both `prepared` and `statement` are present and non-empty, an error is return *Example:* `+++"[127.0.0.1:8091]pricy_hotel"+++` {blank} a¦ String - a¦ [#preserve_expiry] *preserve_expiry* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Specifies whether documents should keep their current expiration setting when modified by a DML statement. @@ -2188,13 +1953,10 @@ Not supported for statements in a transaction. *Example:* `true` {blank} a¦ Boolean - a¦ [#pretty_req] *pretty* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [pretty-srv]: #pretty-srv @@ -2214,13 +1976,10 @@ The request-level parameter overrides the node-level setting. *Example:* `false` {blank} a¦ Boolean - a¦ [#profile_req] *profile* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [profile-srv]: #profile-srv @@ -2254,13 +2013,10 @@ The request-level parameter overrides the node-level setting. *Example:* `+++"phases"+++` {blank} a¦ String - a¦ [#query_context] *query_context* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Specifies the namespace, bucket, and scope used to resolve partial keyspace references within the request. @@ -2274,13 +2030,10 @@ If the namespace name is omitted, the default namespace in the current session i *Example:* `+++"default:travel-sample.inventory"+++` {blank} a¦ String - a¦ [#readonly] *readonly* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Controls whether a query can change a resulting recordset. @@ -2301,13 +2054,10 @@ When using GET requests, it's best to set `readonly` to `true`. *Example:* `true` {blank} a¦ Boolean - a¦ [#scan_cap_req] *scan_cap* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [scan-cap-srv]: #scan-cap-srv @@ -2336,13 +2086,10 @@ When you change the cluster-level setting, the node-level setting is overwritten *Example:* `1024` {blank} a¦ Integer (int32) - a¦ [#scan_consistency] *scan_consistency* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [transactional-scan-consistency]: #transactional-scan-consistency @@ -2388,13 +2135,10 @@ Refer to [Transactional Scan Consistency][transactional-scan-consistency] for de *Example:* `+++"at_plus"+++` {blank} a¦ String - a¦ [#scan_vector] *scan_vector* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- _Required_ if `scan_consistency` is `at_plus` and `scan_vectors` not provided. @@ -2419,13 +2163,10 @@ For queries referencing multiple keyspaces, use `scan_vectors`. *Example:* `{"5":[5409393,"VB5ID"],"19":[47574574,"VB19ID"]}` {blank} a¦ Object - a¦ [#scan_vectors] *scan_vectors* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- _Required_ if `scan_consistency` is `at_plus` and `scan_vector` not provided. @@ -2438,13 +2179,10 @@ The scan vectors can be Full or Sparse. [%hardbreaks] {blank} a¦ Object - a¦ [#scan_wait] *scan_wait* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Can be supplied with `scan_consistency` values of `request_plus`, `statement_plus` and `at_plus`. @@ -2471,13 +2209,10 @@ Specify `0` or a negative integer to disable. *Example:* `+++"30m"+++` {blank} a¦ String (duration) - a¦ [#signature] *signature* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Include a header for the results schema in the response. -- @@ -2487,13 +2222,10 @@ Include a header for the results schema in the response. *Example:* `false` {blank} a¦ Boolean - a¦ [#sort_projection] *sort_projection* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- If `true`, causes statement projection terms to be sorted alphabetically. @@ -2505,13 +2237,10 @@ If `false` (the default), statement projection terms are returned in the order s *Example:* `true` {blank} a¦ Boolean - a¦ [#statement] *statement* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- _Required_ if `prepared` or `natural` not provided. @@ -2532,13 +2261,10 @@ This restriction does not apply when specifying the request parameters in JSON f *Example:* `+++"SELECT * FROM `travel-sample`.inventory.hotel LIMIT 1"+++` {blank} a¦ String - a¦ [#timeout_req] *timeout* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [timeout-srv]: #timeout-srv @@ -2582,13 +2308,10 @@ When you change the cluster-level setting, the node-level setting is overwritten *Example:* `+++"30m"+++` {blank} a¦ String (duration) - a¦ [#txdata] *txdata* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Transaction data. For internal use only. @@ -2597,13 +2320,10 @@ For internal use only. [%hardbreaks] {blank} a¦ Object - a¦ [#txid] *txid* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- _Required_ for statements within a transaction. @@ -2619,13 +2339,10 @@ The transaction must be active and non-expired. *Example:* `+++"d81d9b4a-b758-4f98-b007-87ba262d3a51"+++` {blank} a¦ UUID (UUID) - a¦ [#tximplicit] *tximplicit* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Specifies that a DML statement is a singleton transaction. @@ -2641,13 +2358,10 @@ If the `txid` request-level parameter is set, the `tximplicit` parameter is igno *Example:* `true` {blank} a¦ Boolean - a¦ [#txstmtnum] *txstmtnum* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Transaction statement number. The transaction statement number must be a positive integer, and must be higher than any previous transaction statement numbers in the transaction. @@ -2658,13 +2372,10 @@ If the transaction statement number is lower than the transaction statement numb *Example:* `10` {blank} a¦ Integer (int32) - a¦ [#txtimeout_req] *txtimeout* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [txtimeout-srv]: #txtimeout-srv @@ -2712,13 +2423,10 @@ When you change the cluster-level setting, the node-level setting is overwritten *Example:* `+++"30m"+++` {blank} a¦ String (duration) - a¦ [#use_cbo_req] *use_cbo* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [use-cbo-srv]: #use-cbo-srv @@ -2743,10 +2451,9 @@ When you change the cluster-level setting, the node-level setting is overwritten *Example:* `true` {blank} a¦ Boolean - a¦ [#use_fts] *use_fts* + -_optional_ +optional a¦ [.edition]##{enterprise}## [markdown] @@ -2773,13 +2480,10 @@ Refer to [Flex Indexes][flex-indexes] for more information. *Example:* `true` {blank} a¦ Boolean - a¦ [#use_replica_req] *use_replica* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [use-replica-srv]: #use-replica-srv @@ -2823,14 +2527,11 @@ When you change the cluster-level setting, the node-level setting is overwritten *Example:* `+++"true"+++` {blank} a¦ String - a¦ [#identifier] *<$identifier>* + -_additional + -property_ -a¦ - -[markdown] +additional + +property +a¦ [markdown] -- ifdef::alt-markdown-links[] [section_srh_tlm_n1b]: #section_srh_tlm_n1b @@ -2858,6 +2559,7 @@ Refer to [Named Parameters and Positional Parameters][section_srh_tlm_n1b] for d -- [%hardbreaks] +*Nullable:* yes *Example:* `LAX` {blank} a¦ Any Type @@ -2868,28 +2570,37 @@ a¦ Any Type -// markup not found, no include::{specDir}definitions/Request/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Request/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Request/definition-after.adoc[opts=optional] - - - +ifndef::show-Request[] +:leveloffset: -1 +endif::show-Request[] -// markup not found, no include::{specDir}definitions/Response/definition-before.adoc[opts=optional] +include::{specDir}definitions/Request/definition-after.adoc[opts=optional] +include::{specDir}definitions/Response/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Response[] [#Response] +endif::show-Response[] +ifndef::show-Response[] +:leveloffset: +1 + +[discrete#Response] +endif::show-Response[] = Response Body +ifdef::model-descriptions[] +//tag::desc-Response[] +The response body has the following structure. +//end::desc-Response[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Response/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Response/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -2897,22 +2608,13 @@ endif::collapse-models[] //tag::Response[] -ifdef::model-descriptions[] -//tag::desc-Response[] -The response body has the following structure. -//end::desc-Response[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*requestID* + -_optional_ -a¦ - -[markdown] +a¦ *requestID* + +optional +a¦ [markdown] -- A unique identifier for the response. -- @@ -2920,13 +2622,9 @@ A unique identifier for the response. [%hardbreaks] {blank} a¦ UUID (UUID) - -a¦ -*clientContextID* + -_optional_ -a¦ - -[markdown] +a¦ *clientContextID* + +optional +a¦ [markdown] -- The client context ID of the request, if one was supplied — see `client_context_id` in the request parameters. -- @@ -2934,10 +2632,8 @@ The client context ID of the request, if one was supplied — see `client_co [%hardbreaks] {blank} a¦ String - -a¦ -*generated_statement* + -_optional_ +a¦ *generated_statement* + +optional a¦ [.status]##Couchbase Server 8.0## [markdown] @@ -2949,13 +2645,9 @@ The generated statement, if the request was a natural language prompt. *Example:* `+++"SELECT country, COUNT(*) AS `airline_count` FROM `travel-sample`.`inventory`.`airline` AS `a` GROUP BY country"+++` {blank} a¦ String - -a¦ -*signature* + -_optional_ -a¦ - -[markdown] +a¦ *signature* + +optional +a¦ [markdown] -- The schema of the results. Present only when the query completes successfully. @@ -2965,13 +2657,9 @@ Present only when the query completes successfully. *Example:* `{"id":"json"}` {blank} a¦ Object - -a¦ -*results* + -_optional_ -a¦ - -[markdown] +a¦ *results* + +optional +a¦ [markdown] -- An array of all the objects returned by the query. An object can be any JSON value. @@ -2979,15 +2667,10 @@ An object can be any JSON value. [%hardbreaks] {blank} -a¦ Any Type - array - -a¦ -*status* + -_optional_ -a¦ - -[markdown] +a¦ Any Type array +a¦ *status* + +optional +a¦ [markdown] -- The status of the request. -- @@ -2996,13 +2679,9 @@ The status of the request. *Values:* `"success"`, `"running"`, `"errors"`, `"completed"`, `"stopped"`, `"timeout"`, `"fatal"` {blank} a¦ String - -a¦ -*errors* + -_optional_ -a¦ - -[markdown] +a¦ *errors* + +optional +a¦ [markdown] -- An array of 0 or more error objects. If an error occurred during processing of the request, it will be represented by an error object in this list. @@ -3010,15 +2689,10 @@ If an error occurred during processing of the request, it will be represented by [%hardbreaks] {blank} -a¦ xref:Conditions[] - array - -a¦ -*warnings* + -_optional_ -a¦ - -[markdown] +a¦ xref:Conditions[] array +a¦ *warnings* + +optional +a¦ [markdown] -- An array of 0 or more warning objects. If a warning occurred during processing of the request, it is represented by a warning object in this list. @@ -3026,15 +2700,10 @@ If a warning occurred during processing of the request, it is represented by a w [%hardbreaks] {blank} -a¦ xref:Conditions[] - array - -a¦ -*metrics* + -_optional_ -a¦ - -[markdown] +a¦ xref:Conditions[] array +a¦ *metrics* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-Metrics, opts=optional] -- @@ -3042,13 +2711,9 @@ include::index.adoc[tag=desc-Metrics, opts=optional] [%hardbreaks] {blank} a¦ xref:Metrics[] - -a¦ -*controls* + -_optional_ -a¦ - -[markdown] +a¦ *controls* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-Controls, opts=optional] -- @@ -3056,13 +2721,9 @@ include::index.adoc[tag=desc-Controls, opts=optional] [%hardbreaks] {blank} a¦ xref:Controls[] - -a¦ -*profile* + -_optional_ -a¦ - -[markdown] +a¦ *profile* + +optional +a¦ [markdown] -- include::index.adoc[tag=desc-Profile, opts=optional] -- @@ -3077,28 +2738,37 @@ a¦ xref:Profile[] -// markup not found, no include::{specDir}definitions/Response/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Response/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Response/definition-after.adoc[opts=optional] - - - +ifndef::show-Response[] +:leveloffset: -1 +endif::show-Response[] -// markup not found, no include::{specDir}definitions/Statistics/definition-before.adoc[opts=optional] +include::{specDir}definitions/Response/definition-after.adoc[opts=optional] +include::{specDir}definitions/Statistics/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Statistics[] [#Statistics] +endif::show-Statistics[] +ifndef::show-Statistics[] +:leveloffset: +1 + +[discrete#Statistics] +endif::show-Statistics[] = Statistics +ifdef::model-descriptions[] +//tag::desc-Statistics[] +Statistics collected for the operator. +//end::desc-Statistics[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Statistics/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Statistics/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -3106,22 +2776,13 @@ endif::collapse-models[] //tag::Statistics[] -ifdef::model-descriptions[] -//tag::desc-Statistics[] -Statistics collected for the operator. -//end::desc-Statistics[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*#itemsIn* + -_optional_ -a¦ - -[markdown] +a¦ *#itemsIn* + +optional +a¦ [markdown] -- Number of input documents to the operator. -- @@ -3130,13 +2791,9 @@ Number of input documents to the operator. *Example:* `187` {blank} a¦ Integer (int32) - -a¦ -*#itemsOut* + -_optional_ -a¦ - -[markdown] +a¦ *#itemsOut* + +optional +a¦ [markdown] -- Number of output documents after the operator processing. -- @@ -3145,13 +2802,9 @@ Number of output documents after the operator processing. *Example:* `16` {blank} a¦ Integer (int32) - -a¦ -*#phaseSwitches* + -_optional_ -a¦ - -[markdown] +a¦ *#phaseSwitches* + +optional +a¦ [markdown] -- Number of switches between executing, waiting for services, or waiting for the goroutine scheduler. -- @@ -3160,13 +2813,10 @@ Number of switches between executing, waiting for services, or waiting for the g *Example:* `413` {blank} a¦ Integer (int32) - a¦ [#exec_time] *execTime* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Time spent executing the operator code inside SQL++ query engine. -- @@ -3175,13 +2825,10 @@ Time spent executing the operator code inside SQL++ query engine. *Example:* `+++"128.434µs"+++` {blank} a¦ String (duration) - a¦ [#kern_time] *kernTime* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Time spent waiting to be scheduled for CPU time. -- @@ -3190,13 +2837,10 @@ Time spent waiting to be scheduled for CPU time. *Example:* `+++"15.027879ms"+++` {blank} a¦ String (duration) - a¦ [#serv_time] *servTime* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- Time spent waiting for another service, such as index or data. @@ -3218,24 +2862,24 @@ a¦ String (duration) include::{specDir}definitions/Statistics/definition-end.adoc[opts=optional] - :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Statistics/definition-after.adoc[opts=optional] - +ifndef::show-Statistics[] +:leveloffset: -1 +endif::show-Statistics[] +include::{specDir}definitions/Statistics/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] - +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -3245,18 +2889,14 @@ include::{specDir}definitions/Statistics/definition-end.adoc[opts=optional] include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/Header/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/Header/security-scheme-before.adoc[opts=optional] - - -[[security-header]] +[[security-Header]] = Header :leveloffset: +1 -// markup not found, no include::{specDir}security/Header/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Header/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -3265,29 +2905,22 @@ This method can only be used to provide a single credential. -- [%hardbreaks] -__Type__ : http +*Type:* http - -// markup not found, no include::{specDir}security/Header/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Header/security-scheme-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}security/Header/security-scheme-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/Header/security-scheme-after.adoc[opts=optional] - - - +include::{specDir}security/Parameter/security-scheme-before.adoc[opts=optional] -// markup not found, no include::{specDir}security/Parameter/security-scheme-before.adoc[opts=optional] - - -[[security-parameter]] +[[security-Parameter]] = Parameter :leveloffset: +1 -// markup not found, no include::{specDir}security/Parameter/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Parameter/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -3297,17 +2930,14 @@ This is the only method that can provide multiple credentials for a request. .API Key [%hardbreaks] -__Key parameter__ : creds -__Key in__ : query - +*Key parameter:* creds +*Key in:* query -// markup not found, no include::{specDir}security/Parameter/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Parameter/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/Parameter/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/Parameter/security-scheme-after.adoc[opts=optional] @@ -3315,8 +2945,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/n1ql-rest-query/query-service.gradle b/docs/modules/n1ql-rest-query/query-service.gradle index 1358ec7c..d700d972 100644 --- a/docs/modules/n1ql-rest-query/query-service.gradle +++ b/docs/modules/n1ql-rest-query/query-service.gradle @@ -46,6 +46,7 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/pages/index.adoc b/docs/modules/n1ql-rest-settings/pages/index.adoc index 356772ac..d0fb3cd4 100644 --- a/docs/modules/n1ql-rest-settings/pages/index.adoc +++ b/docs/modules/n1ql-rest-settings/pages/index.adoc @@ -12,16 +12,15 @@ DO NOT EDIT! See https://github.com/couchbase/query :leveloffset: 1 -include::{specDir}overview/document-before.adoc[opts=optional] +include::{specDir}overview/document-before.adoc[opts=optional] [[overview]] = Overview :leveloffset: +1 -// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] - +include::{specDir}overview/document-begin.adoc[opts=optional] [markdown] -- @@ -32,7 +31,7 @@ This API enables you to view or specify cluster-level Query settings. [discrete#version] = Version information [%hardbreaks] -__Version__ : 8.0 +*Version:* 8.0 [discrete#host] = Host information @@ -67,7 +66,6 @@ The host name or IP address of any node in the Couchbase cluster. -- [%hardbreaks] - *Example:* `+++localhost+++` // end @@ -83,31 +81,26 @@ The Cluster administration REST port. Use `18091` for secure access. Note that |=== - include::{specDir}overview/document-end.adoc[opts=optional] :leveloffset: -1 +include::{specDir}overview/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] +include::{specDir}paths/document-before.adoc[opts=optional] [[resources]] = Resources -:count-apis: 1 - +:count-apis: 0 :leveloffset: +1 -// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] +include::{specDir}paths/document-begin.adoc[opts=optional] This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] The operations are grouped in the following categories. [%hardbreaks] @@ -115,18 +108,14 @@ xref:tag-Default[] endif::[] -ifeval::[{count-apis} > 1] +ifeval::[{count-apis} > 0] [#tag-Default] = Default :leveloffset: +1 -ifeval::["" != ""] - -endif::[] -ifeval::["" == ""] **{toc-title}** endif::[] -endif::[] + [%hardbreaks] xref:get_access[] @@ -135,44 +124,38 @@ xref:post_access[] xref:post_settings[] -//tag::get_access[] - -// markup not found, no include::{specDir}paths/get_access/operation-before.adoc[opts=optional] +//tag::get_access[] +include::{specDir}paths/get_access/operation-before.adoc[opts=optional] [#get_access] = Retrieve CURL Access List :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_access/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_access/operation-begin.adoc[opts=optional] .... GET /settings/querySettings/curlWhitelist .... - -// markup not found, no include::{specDir}paths/get_access/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_access/operation-description-before.adoc[opts=optional] [#get_access-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_access/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_access/operation-description-begin.adoc[opts=optional] [markdown] -- Returns the cluster-level CURL access settings only. -- - -// markup not found, no include::{specDir}paths/get_access/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_access/operation-description-end.adoc[opts=optional] @@ -180,33 +163,29 @@ Returns the cluster-level CURL access settings only. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_access/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_access/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_access/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_access/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_access/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_access/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_access/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_access/operation-responses-before.adoc[opts=optional] [#get_access-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_access/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_access/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -219,106 +198,86 @@ An object determining which URLs may be accessed by the `CURL()` function. -- a| xref:Access[] - |=== - -// markup not found, no include::{specDir}paths/get_access/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_access/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Access: -// markup not found, no include::{specDir}paths/get_access/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_access/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_access/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_access/operation-security-before.adoc[opts=optional] [#get_access-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_access/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_access/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_access/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_access/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_access/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_access/operation-security-after.adoc[opts=optional] include::{snippetDir}get_access/http-request.adoc[opts=optional] - include::{snippetDir}get_access/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_access/operation-end.adoc[opts=optional] +include::{specDir}paths/get_access/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_access/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_access/operation-after.adoc[opts=optional] //end::get_access[] - //tag::get_settings[] - -// markup not found, no include::{specDir}paths/get_settings/operation-before.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-before.adoc[opts=optional] [#get_settings] = Retrieve Cluster-Level Query Settings :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-begin.adoc[opts=optional] .... GET /settings/querySettings .... - -// markup not found, no include::{specDir}paths/get_settings/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-description-before.adoc[opts=optional] [#get_settings-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-description-begin.adoc[opts=optional] [markdown] -- Returns all cluster-level query settings, including the CURL access settings. -- - -// markup not found, no include::{specDir}paths/get_settings/operation-description-end.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-description-end.adoc[opts=optional] @@ -326,33 +285,29 @@ Returns all cluster-level query settings, including the CURL access settings. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/get_settings/operation-description-after.adoc[opts=optional] - +:leveloffset: -1 -// markup not found, no include::{specDir}paths/get_settings/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-description-after.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-parameters-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_settings/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_settings/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-responses-before.adoc[opts=optional] [#get_settings-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -365,106 +320,86 @@ An object giving cluster-level query settings. -- a| xref:Settings[] - |=== - -// markup not found, no include::{specDir}paths/get_settings/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Settings: -// markup not found, no include::{specDir}paths/get_settings/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get_settings/operation-security-before.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-security-before.adoc[opts=optional] [#get_settings-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/get_settings/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/get_settings/operation-security-end.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional] include::{snippetDir}get_settings/http-request.adoc[opts=optional] - include::{snippetDir}get_settings/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/get_settings/operation-end.adoc[opts=optional] +include::{specDir}paths/get_settings/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/get_settings/operation-after.adoc[opts=optional] - +include::{specDir}paths/get_settings/operation-after.adoc[opts=optional] //end::get_settings[] - //tag::post_access[] - -// markup not found, no include::{specDir}paths/post_access/operation-before.adoc[opts=optional] - +include::{specDir}paths/post_access/operation-before.adoc[opts=optional] [#post_access] = Update CURL Access List :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_access/operation-begin.adoc[opts=optional] - +include::{specDir}paths/post_access/operation-begin.adoc[opts=optional] .... POST /settings/querySettings/curlWhitelist .... - -// markup not found, no include::{specDir}paths/post_access/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/post_access/operation-description-before.adoc[opts=optional] [#post_access-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_access/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/post_access/operation-description-begin.adoc[opts=optional] [markdown] -- Updates the cluster-level CURL access settings only. -- - -// markup not found, no include::{specDir}paths/post_access/operation-description-end.adoc[opts=optional] +include::{specDir}paths/post_access/operation-description-end.adoc[opts=optional] [#post_access-consumes] @@ -476,27 +411,20 @@ Updates the cluster-level CURL access settings only. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/post_access/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/post_access/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_access/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/post_access/operation-parameters-before.adoc[opts=optional] [#post_access-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_access/operation-parameters-begin.adoc[opts=optional] - - - - - +include::{specDir}paths/post_access/operation-parameters-begin.adoc[opts=optional] [#post_access-body] .Body Parameter @@ -507,13 +435,10 @@ Updates the cluster-level CURL access settings only. ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- -An object determining which URLs may be accessed by the `CURL()` function. + -- [%hardbreaks] @@ -524,26 +449,25 @@ a¦ xref:Access[] |=== -// markup not found, no include::{specDir}paths/post_access/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/post_access/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Access: -// markup not found, no include::{specDir}paths/post_access/operation-parameters-after.adoc[opts=optional] +include::{specDir}paths/post_access/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_access/operation-responses-before.adoc[opts=optional] - +include::{specDir}paths/post_access/operation-responses-before.adoc[opts=optional] [#post_access-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_access/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/post_access/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -563,106 +487,86 @@ Returns an error message if a parameter or value is incorrect. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/post_access/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/post_access/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Access: -// markup not found, no include::{specDir}paths/post_access/operation-responses-after.adoc[opts=optional] +include::{specDir}paths/post_access/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_access/operation-security-before.adoc[opts=optional] - +include::{specDir}paths/post_access/operation-security-before.adoc[opts=optional] [#post_access-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_access/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/post_access/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/post_access/operation-security-end.adoc[opts=optional] +include::{specDir}paths/post_access/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_access/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/post_access/operation-security-after.adoc[opts=optional] include::{snippetDir}post_access/http-request.adoc[opts=optional] - include::{snippetDir}post_access/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/post_access/operation-end.adoc[opts=optional] +include::{specDir}paths/post_access/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_access/operation-after.adoc[opts=optional] - +include::{specDir}paths/post_access/operation-after.adoc[opts=optional] //end::post_access[] - //tag::post_settings[] - -// markup not found, no include::{specDir}paths/post_settings/operation-before.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-before.adoc[opts=optional] [#post_settings] = Update Cluster-Level Query Settings :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-begin.adoc[opts=optional] .... POST /settings/querySettings .... - -// markup not found, no include::{specDir}paths/post_settings/operation-description-before.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-description-before.adoc[opts=optional] [#post_settings-description] = Description :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-description-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-description-begin.adoc[opts=optional] [markdown] -- Updates cluster-level query settings, including the CURL access settings. -- - -// markup not found, no include::{specDir}paths/post_settings/operation-description-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-description-end.adoc[opts=optional] [#post_settings-consumes] @@ -674,27 +578,20 @@ Updates cluster-level query settings, including the CURL access settings. .Produces * application/json -:leveloffset: -1 - - -// markup not found, no include::{specDir}paths/post_settings/operation-description-after.adoc[opts=optional] +:leveloffset: -1 +include::{specDir}paths/post_settings/operation-description-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-before.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-parameters-before.adoc[opts=optional] [#post_settings-parameters] = Parameters :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-begin.adoc[opts=optional] - - - - - +include::{specDir}paths/post_settings/operation-parameters-begin.adoc[opts=optional] [#post_settings-body] .Body Parameter @@ -705,13 +602,10 @@ Updates cluster-level query settings, including the CURL access settings. ¦ Name ¦ Description ¦ Schema a¦ *Body* + -_optional_ -a¦ - - -[markdown] +optional +a¦ [markdown] -- -An object specifying cluster-level query settings. + -- [%hardbreaks] @@ -722,26 +616,25 @@ a¦ xref:Settings[] |=== -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-parameters-end.adoc[opts=optional] :leveloffset: -1 +:show-Settings: -// markup not found, no include::{specDir}paths/post_settings/operation-parameters-after.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-parameters-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_settings/operation-responses-before.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-responses-before.adoc[opts=optional] [#post_settings-responses] = Responses :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-responses-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-responses-begin.adoc[opts=optional] [cols="20,60,20"] |=== @@ -761,121 +654,113 @@ Returns an error message if a parameter or value is incorrect. -- a| Object - |=== - -// markup not found, no include::{specDir}paths/post_settings/operation-responses-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-responses-end.adoc[opts=optional] :leveloffset: -1 +:show-Settings: -// markup not found, no include::{specDir}paths/post_settings/operation-responses-after.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-responses-after.adoc[opts=optional] -// markup not found, no include::{specDir}paths/post_settings/operation-security-before.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-security-before.adoc[opts=optional] [#post_settings-security] = Security :leveloffset: +1 -// markup not found, no include::{specDir}paths/post_settings/operation-security-begin.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-security-begin.adoc[opts=optional] [cols="20,80"] |=== | Type | Name | http (basic) -| xref:security-default[] +| xref:security-Default[] |=== - -// markup not found, no include::{specDir}paths/post_settings/operation-security-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-security-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optional] - - +include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optional] include::{snippetDir}post_settings/http-request.adoc[opts=optional] - include::{snippetDir}post_settings/http-response.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/post_settings/operation-end.adoc[opts=optional] +include::{specDir}paths/post_settings/operation-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/post_settings/operation-after.adoc[opts=optional] - +include::{specDir}paths/post_settings/operation-after.adoc[opts=optional] //end::post_settings[] -ifeval::[{count-apis} > 1] + +ifeval::[{count-apis} > 0] :leveloffset: -1 endif::[] -// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] +include::{specDir}paths/document-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] - +include::{specDir}paths/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] - +include::{specDir}definitions/document-before.adoc[opts=optional] [#models] = Definitions -:count-models: 2 - +:count-models: 1 :leveloffset: +1 -// markup not found, no include::{specDir}definitions/document-begin.adoc[opts=optional] - +include::{specDir}definitions/document-begin.adoc[opts=optional] This section describes the properties consumed and returned by this REST API. -ifeval::[{count-models} > 1] -ifdef::collapse-models[] +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] [.two-columns] -endif::collapse-models[] +endif::[] [%hardbreaks] xref:Access[] xref:Settings[] endif::[] +include::{specDir}definitions/Access/definition-before.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/Access/definition-before.adoc[opts=optional] - - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Access[] [#Access] +endif::show-Access[] +ifndef::show-Access[] +:leveloffset: +1 + +[discrete#Access] +endif::show-Access[] = Access +ifdef::model-descriptions[] +//tag::desc-Access[] +An object which determines which URLs may be accessed by the `CURL()` function. +//end::desc-Access[] +endif::model-descriptions[] + :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Access/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Access/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -883,22 +768,13 @@ endif::collapse-models[] //tag::Access[] -ifdef::model-descriptions[] -//tag::desc-Access[] -An object which determines which URLs may be accessed by the `CURL()` function. -//end::desc-Access[] -endif::model-descriptions[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema -a¦ -*all_access* + -_required_ -a¦ - -[markdown] +a¦ *all_access* + +required +a¦ [markdown] -- Defines whether the user has access to all URLs, or only URLs specified by the access list. @@ -910,13 +786,9 @@ Setting this field to `true` enables access to all endpoints. [%hardbreaks] {blank} a¦ Boolean - -a¦ -*allowed_urls* + -_optional_ -a¦ - -[markdown] +a¦ *allowed_urls* + +optional +a¦ [markdown] -- An array of strings, each of which is a URL to which you wish to grant access. Each URL is a prefix match. @@ -930,15 +802,10 @@ Note that each URL must include the port, protocol, and all other components of [%hardbreaks] {blank} -a¦ String - array - -a¦ -*disallowed_urls* + -_optional_ -a¦ - -[markdown] +a¦ String array +a¦ *disallowed_urls* + +optional +a¦ [markdown] -- An array of strings, each of which is a URL that will be restricted for all roles. Each URL is a prefix match. @@ -951,8 +818,7 @@ Note that each URL must include the port, protocol, and all other components of [%hardbreaks] {blank} -a¦ String - array +a¦ String array |=== @@ -960,28 +826,31 @@ a¦ String -// markup not found, no include::{specDir}definitions/Access/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Access/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Access/definition-after.adoc[opts=optional] - - - +ifndef::show-Access[] +:leveloffset: -1 +endif::show-Access[] -// markup not found, no include::{specDir}definitions/Settings/definition-before.adoc[opts=optional] +include::{specDir}definitions/Access/definition-after.adoc[opts=optional] +include::{specDir}definitions/Settings/definition-before.adoc[opts=optional] -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] +ifdef::show-Settings[] [#Settings] +endif::show-Settings[] +ifndef::show-Settings[] +:leveloffset: +1 + +[discrete#Settings] +endif::show-Settings[] = Settings :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Settings/definition-begin.adoc[opts=optional] +include::{specDir}definitions/Settings/definition-begin.adoc[opts=optional] .icon:brackets-curly[fw] Object @@ -989,17 +858,14 @@ endif::collapse-models[] //tag::Settings[] - [cols="25,55,20",separator=¦] |=== ¦ Property ¦ ¦ Schema a¦ [#queryCleanupClientAttempts] *queryCleanupClientAttempts* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [cleanupclientattempts]: #cleanupclientattempts @@ -1020,13 +886,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `false` {blank} a¦ Boolean - a¦ [#queryCleanupLostAttempts] *queryCleanupLostAttempts* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [cleanuplostattempts]: #cleanuplostattempts @@ -1047,13 +910,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `false` {blank} a¦ Boolean - a¦ [#queryCleanupWindow] *queryCleanupWindow* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [cleanupwindow]: #cleanupwindow @@ -1088,13 +948,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `+++"30s"+++` {blank} a¦ String (duration) - a¦ [#queryCompletedLimit] *queryCompletedLimit* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config @@ -1123,13 +980,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `7000` {blank} a¦ Integer (int32) - a¦ [#queryCompletedMaxPlanSize] *queryCompletedMaxPlanSize* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config @@ -1160,13 +1014,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Maximum:* `20840448` {blank} a¦ Integer (int32) - a¦ [#queryCompletedThreshold] *queryCompletedThreshold* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config @@ -1196,13 +1047,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `7000` {blank} a¦ Integer (int32) - a¦ [#queryLogLevel] *queryLogLevel* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [loglevel]: #loglevel @@ -1246,13 +1094,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `+++"DEBUG"+++` {blank} a¦ String - a¦ [#queryMaxParallelism] *queryMaxParallelism* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [max-parallelism]: ../n1ql-language-reference/index-partitioning.html#max-parallelism @@ -1292,13 +1137,10 @@ NOTE: To enable queries to run in parallel, you must specify the cluster-level ` *Example:* `0` {blank} a¦ Integer (int32) - a¦ [#queryMemoryQuota] *queryMemoryQuota* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [memory-quota-srv]: #memory-quota-srv @@ -1330,13 +1172,10 @@ If a request includes this parameter, it will be capped by the node-level `memor *Example:* `4` {blank} a¦ Integer (int32) - a¦ [#queryN1QLFeatCtrl] *queryN1QLFeatCtrl* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [n1ql-feat-ctrl]: #n1ql-feat-ctrl @@ -1356,13 +1195,10 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] {blank} a¦ Integer (int32) - a¦ [#queryNodeQuota] *queryNodeQuota* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [node-quota]: #node-quota @@ -1393,13 +1229,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `0` {blank} a¦ Integer (int32) - a¦ [#queryNodeQuotaValPercent] *queryNodeQuotaValPercent* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [node-quota-val-percent]: #node-quota-val-percent @@ -1422,13 +1255,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Maximum:* `100` {blank} a¦ Integer (int32) - a¦ [#queryNumAtrs] *queryNumAtrs* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [numatrs-srv]: #numatrs-srv @@ -1452,13 +1282,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `512` {blank} a¦ Integer (int32) - a¦ [#queryNumCpus] *queryNumCpus* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [num-cpus]: #num-cpus @@ -1485,13 +1312,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `0` {blank} a¦ Integer (int32) - a¦ [#queryPipelineBatch] *queryPipelineBatch* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [pipeline-batch-srv]: #pipeline-batch-srv @@ -1517,13 +1341,10 @@ The minimum of that and the node-level `pipeline-batch` setting is applied. *Example:* `64` {blank} a¦ Integer (int32) - a¦ [#queryPipelineCap] *queryPipelineCap* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [pipeline-cap-srv]: #pipeline-cap-srv @@ -1549,13 +1370,10 @@ The minimum of that and the node-level `pipeline-cap` setting is applied. *Example:* `1024` {blank} a¦ Integer (int32) - a¦ [#queryPreparedLimit] *queryPreparedLimit* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [prepared-limit]: #prepared-limit @@ -1577,13 +1395,10 @@ When you change the cluster-level setting, the node-level setting is over-writte *Example:* `65536` {blank} a¦ Integer (int32) - a¦ [#queryScanCap] *queryScanCap* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [scan-cap-srv]: #scan-cap-srv @@ -1613,13 +1428,10 @@ The minimum of that and the node-level `scan-cap` setting is applied. *Example:* `1024` {blank} a¦ Integer (int32) - a¦ [#queryTimeout] *queryTimeout* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [timeout-srv]: #timeout-srv @@ -1651,13 +1463,10 @@ The minimum of that and the node-level `timeout` setting is applied. *Example:* `500000000` {blank} a¦ Long (int64) - a¦ [#queryTxTimeout] *queryTxTimeout* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [tximplicit]: #tximplicit @@ -1702,13 +1511,10 @@ If a request includes this parameter, it will be capped by the node-level `txtim *Example:* `+++"0.5s"+++` {blank} a¦ String (duration) - a¦ [#queryTmpSpaceDir] *queryTmpSpaceDir* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- The path to which the Index Service writes temporary backfill files, and the Query Service writes spill files, to store any transient data during query processing. @@ -1722,13 +1528,10 @@ The default path is `var/lib/couchbase/tmp` within the Couchbase Server installa *Example:* `+++"/opt/couchbase/var/lib/couchbase/tmp"+++` {blank} a¦ String - a¦ [#queryTmpSpaceSize] *queryTmpSpaceSize* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- In MiB, the maximum size of temporary backfill files for each indexer, and the maximum size of temporary files for spilled sorting and other operations. In a cluster with both secondary indexing and full text search, the limit for disk space use is three times this setting. @@ -1744,13 +1547,10 @@ The maximum size is limited only by the available disk space. *Example:* `2048` {blank} a¦ Integer (int32) - a¦ [#queryUseCBO] *queryUseCBO* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [use-cbo-srv]: #use-cbo-srv @@ -1776,13 +1576,10 @@ If a request does not include this parameter, the node-level setting is used, wh *Example:* `false` {blank} a¦ Boolean - a¦ [#queryUseReplica] *queryUseReplica* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- ifdef::alt-markdown-links[] [use-replica-srv]: #use-replica-srv @@ -1825,13 +1622,10 @@ If the request-level parameter and the node-level setting are both `unset`, read *Example:* `+++"on"+++` {blank} a¦ String - a¦ [#queryCurlWhitelist] *queryCurlWhitelist* + -_optional_ -a¦ - -[markdown] +optional +a¦ [markdown] -- include::index.adoc[tag=desc-Access, opts=optional] -- @@ -1846,26 +1640,26 @@ a¦ xref:Access[] -// markup not found, no include::{specDir}definitions/Settings/definition-end.adoc[opts=optional] - +include::{specDir}definitions/Settings/definition-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/Settings/definition-after.adoc[opts=optional] - +ifndef::show-Settings[] +:leveloffset: -1 +endif::show-Settings[] +include::{specDir}definitions/Settings/definition-after.adoc[opts=optional] -// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] +include::{specDir}definitions/document-end.adoc[opts=optional] :leveloffset: -1 -// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] +include::{specDir}definitions/document-after.adoc[opts=optional] -// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] - +include::{specDir}security/document-before.adoc[opts=optional] [[security]] = Security @@ -1875,18 +1669,14 @@ a¦ xref:Access[] include::{specDir}security/document-begin.adoc[opts=optional] +include::{specDir}security/Default/security-scheme-before.adoc[opts=optional] - -// markup not found, no include::{specDir}security/Default/security-scheme-before.adoc[opts=optional] - - -[[security-default]] +[[security-Default]] = Default :leveloffset: +1 -// markup not found, no include::{specDir}security/Default/security-scheme-begin.adoc[opts=optional] - +include::{specDir}security/Default/security-scheme-begin.adoc[opts=optional] [markdown] -- @@ -1897,16 +1687,13 @@ Users must have one of the following RBAC roles: -- [%hardbreaks] -__Type__ : http - +*Type:* http -// markup not found, no include::{specDir}security/Default/security-scheme-end.adoc[opts=optional] +include::{specDir}security/Default/security-scheme-end.adoc[opts=optional] :leveloffset: -1 - -// markup not found, no include::{specDir}security/Default/security-scheme-after.adoc[opts=optional] - +include::{specDir}security/Default/security-scheme-after.adoc[opts=optional] @@ -1914,8 +1701,6 @@ include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 - - include::{specDir}security/document-after.adoc[opts=optional] diff --git a/docs/modules/n1ql-rest-settings/partials/paths/get_access/http-response.adoc b/docs/modules/n1ql-rest-settings/partials/paths/get_access/http-response.adoc index 4e12ac00..1192e767 100644 --- a/docs/modules/n1ql-rest-settings/partials/paths/get_access/http-response.adoc +++ b/docs/modules/n1ql-rest-settings/partials/paths/get_access/http-response.adoc @@ -4,6 +4,6 @@ .Response 200 [source,json] ---- -include::example$query-settings-get-access.jsonc[] +include::example$query-settings-get-access.json[] ---- ==== \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/partials/paths/get_settings/http-response.adoc b/docs/modules/n1ql-rest-settings/partials/paths/get_settings/http-response.adoc index ddc93fb2..b9d7c4ac 100644 --- a/docs/modules/n1ql-rest-settings/partials/paths/get_settings/http-response.adoc +++ b/docs/modules/n1ql-rest-settings/partials/paths/get_settings/http-response.adoc @@ -4,6 +4,6 @@ .Response 200 [source,json] ---- -include::example$query-settings-get-settings.jsonc[] +include::example$query-settings-get-settings.json[] ---- ==== \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/partials/paths/post_access/http-response.adoc b/docs/modules/n1ql-rest-settings/partials/paths/post_access/http-response.adoc index 07b227aa..1baebaba 100644 --- a/docs/modules/n1ql-rest-settings/partials/paths/post_access/http-response.adoc +++ b/docs/modules/n1ql-rest-settings/partials/paths/post_access/http-response.adoc @@ -4,6 +4,6 @@ .Response 200 [source,json] ---- -include::example$query-settings-post-access.jsonc[] +include::example$query-settings-post-access.json[] ---- ==== \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/partials/paths/post_settings/http-response.adoc b/docs/modules/n1ql-rest-settings/partials/paths/post_settings/http-response.adoc index b017bbdc..14b0fe85 100644 --- a/docs/modules/n1ql-rest-settings/partials/paths/post_settings/http-response.adoc +++ b/docs/modules/n1ql-rest-settings/partials/paths/post_settings/http-response.adoc @@ -4,6 +4,6 @@ .Response 200 [source,json] ---- -include::example$query-settings-post-settings.jsonc[] +include::example$query-settings-post-settings.json[] ---- ==== \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/query-settings.gradle b/docs/modules/n1ql-rest-settings/query-settings.gradle index 9f967c64..daffeee5 100644 --- a/docs/modules/n1ql-rest-settings/query-settings.gradle +++ b/docs/modules/n1ql-rest-settings/query-settings.gradle @@ -39,6 +39,7 @@ openApiGenerate { generateAliasAsModel: "true" ] generateAliasAsModel = true + engine = "handlebars" } tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file diff --git a/templates/index.handlebars b/templates/index.handlebars new file mode 100644 index 00000000..4ca774b5 --- /dev/null +++ b/templates/index.handlebars @@ -0,0 +1,421 @@ += {{{appName}}} +:keywords: OpenAPI, REST +:specDir: partial$ +:snippetDir: partial$paths/ +:page-topic-type: reference +:page-toclevels: 2 +{{! If headerAttributes is true, include document attributes from the named partial}} +{{~#if headerAttributes ~}} +include::partial$header-attributes.adoc[opts=optional] +{{~/if}} + +[comment] +This file is created automatically by OpenAPI Generator. +DO NOT EDIT! See https://{{gitHost}}/{{gitUserId}}/{{gitRepoId}} + +:leveloffset: 1 + +{{! *** OVERVIEW *** }} +include::{specDir}overview/document-before.adoc[opts=optional] + +[[overview]] += Overview + +:leveloffset: +1 + +include::{specDir}overview/document-begin.adoc[opts=optional] + +{{#if useIntroduction ~}} +[markdown] +-- +{{{unescapedAppDescription}}} +-- +{{~/if}} + +{{#with version ~}} +[discrete#version] += Version information +[%hardbreaks] +*Version:* {{{this}}} +{{~/with}} + +{{#each servers ~}} +[discrete#host] +{{#if @first ~}} += Host information +{{/if}} +.... +{{url}} +.... + +{{#with description ~}} +[markdown] +-- +{{{this}}} +-- +{{~/with}} + +{{#each variables ~}} +{{#if @first ~}} +[cols="20,80"] +|=== +| Component | Description +{{/if}} +a| *{{name}}* +a| [markdown] +-- +{{{description}}} +-- + +[%hardbreaks] +{{#each enumValues}}{{#if @first}}*Values:* {{/if}}`{{this}}`{{#unless @last}}, {{/unless}} +{{~else with value}}*Example:* `+++{{this}}+++`{{/each}} +// end +{{#if @last}} +|=== +{{~/if}} +{{~/each}}{{! variables }} +{{~/each}}{{! servers }} + +include::{specDir}overview/document-end.adoc[opts=optional] + +:leveloffset: -1 + +include::{specDir}overview/document-after.adoc[opts=optional] + +{{! *** PATHS *** }} +include::{specDir}paths/document-before.adoc[opts=optional] + +[[resources]] += Resources + +{{#with apiInfo ~}} +{{#each apis ~}} +{{#if @last ~}} +:count-apis: {{@index}} +{{~/if}} +{{~/each}} +{{~/with}} +:leveloffset: +1 + +include::{specDir}paths/document-begin.adoc[opts=optional] + +{{! Table of contents for endpoints }} +This section describes the operations available with this REST API. +ifeval::[{count-apis} > 0] +The operations are grouped in the following categories. + +[%hardbreaks] +{{#with apiInfo ~}} +{{#each apis ~}} +xref:tag-{{baseName}}[] +{{/each}}{{~/with ~}} +endif::[] + +{{! Endpoint body }} +{{#with apiInfo ~}} +{{#each apis ~}} + +ifeval::[{count-apis} > 0] +[#tag-{{baseName}}] += {{#with operations.operation.[0].tags.[0].name ~}} +{{#capitalize}}{{this}}{{/capitalize}}{{! FIXME: assumes first tag in first operation is the same as this API }} +{{~ else ~}} +{{baseName}} +{{~/with}} +:leveloffset: +1 + +{{#with operationTagDescription ~}} +{{this}} +{{~ else ~}} +**{toc-title}** +{{~/with}} +endif::[] + +{{! Table of contents for operations }} +{{#with operations ~}} +[%hardbreaks] +{{#each operation ~}} +xref:{{operationIdOriginal}}[] +{{/each}} + +{{! *** OPERATION BODY *** }} +{{#each operation ~}} +//tag::{{operationIdOriginal}}[] + +include::{specDir}paths/{{operationIdOriginal}}/operation-before.adoc[opts=optional] + +[#{{operationIdOriginal}}] +{{#if useMethodAndPath ~}} += {{httpMethod}} {{path}} +{{~else ~}} += {{summary}} +{{~/if}} + +:leveloffset: +1 + +include::{specDir}paths/{{operationIdOriginal}}/operation-begin.adoc[opts=optional] + +{{#if useMethodAndPath ~}} +{{summary}} +{{~else ~}} +.... +{{httpMethod}} {{path}} +.... +{{~/if ~}} +{{#if isDeprecated}} + +CAUTION: This operation is deprecated, and will be removed in a future release. +{{~/if}} + +{{! *** OPERATION DESCRIPTION *** }} +include::{specDir}paths/{{operationIdOriginal}}/operation-description-before.adoc[opts=optional] + +[#{{operationIdOriginal}}-description] += Description + +:leveloffset: +1 + +include::{specDir}paths/{{operationIdOriginal}}/operation-description-begin.adoc[opts=optional] + +[markdown] +-- +{{{unescapedNotes}}} +-- + +include::{specDir}paths/{{operationIdOriginal}}/operation-description-end.adoc[opts=optional] + +{{! *** OPERATION CONSUMES / PRODUCES *** }} +{{#if hasConsumes ~}} +[#{{operationIdOriginal}}-consumes] +.Consumes +{{#each consumes ~}} +* {{{mediaType}}} +{{/each}} +{{~/if}} +{{#if hasProduces ~}} +[#{{operationIdOriginal}}-produces] +.Produces +{{#each produces ~}} +* {{{mediaType}}} +{{/each}} +{{~/if}} + +:leveloffset: -1 + +include::{specDir}paths/{{operationIdOriginal}}/operation-description-after.adoc[opts=optional] + +{{! *** OPERATION PARAMETERS *** }} +include::{specDir}paths/{{operationIdOriginal}}/operation-parameters-before.adoc[opts=optional] + +{{> params}} + +{{#unless skipExamples ~}} +{{#if hasBodyParam ~}} +{{#each requestBodyExamples ~}} +.Request Body Example +==== +{{#with example ~}} +[source,json] +---- +{{{this}}} +---- +{{~/with}} +==== +{{~/each}} +{{~/if}} +{{~/unless}} + +include::{specDir}paths/{{operationIdOriginal}}/operation-parameters-after.adoc[opts=optional] + +{{! *** OPERATION RESPONSES *** }} +include::{specDir}paths/{{operationIdOriginal}}/operation-responses-before.adoc[opts=optional] + +{{#each responses ~}} +{{#if @first ~}} +[#{{operationIdOriginal}}-responses] += Responses + +:leveloffset: +1 + +include::{specDir}paths/{{operationIdOriginal}}/operation-responses-begin.adoc[opts=optional] + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema +{{/if}}{{! @first }} +| {{code}} +a| [markdown] +-- +{{{message}}} +-- +a| {{#with returnProperty}}{{>schemas}}{{/with}} +{{#if @last}} +|=== + +include::{specDir}paths/{{operationIdOriginal}}/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 +{{~/if}}{{! @last}} +{{~/each}}{{! responses }} +{{#each responses ~}} +{{#with returnProperty}}{{>tocs}}{{/with}} +{{~/each}} + +{{#unless skipExamples ~}} +{{#if hasExamples ~}} +{{#each examples ~}} +.Response Examples +==== +{{#with example ~}} +[source,json] +---- +{{{this}}} +---- +{{~/with}} +==== +{{~/each}} +{{~/if}} +{{~/unless}}{{! skipExamples }} + +include::{specDir}paths/{{operationIdOriginal}}/operation-responses-after.adoc[opts=optional] + +{{! *** OPERATION SECURITY *** }} +include::{specDir}paths/{{operationIdOriginal}}/operation-security-before.adoc[opts=optional] + +{{#each authMethods ~}} +{{#if @first ~}} +[#{{operationIdOriginal}}-security] += Security + +:leveloffset: +1 + +include::{specDir}paths/{{operationIdOriginal}}/operation-security-begin.adoc[opts=optional] + +[cols="20,80"] +|=== +| Type | Name +{{~/if}}{{! @first }} + +| {{type}}{{#with scheme}} ({{this}}){{/with}} +| xref:security-{{name}}[] + +{{#if @last ~}} +|=== + +include::{specDir}paths/{{operationIdOriginal}}/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 +{{~/if}}{{! @last}} +{{~/each}}{{! authMethods }} + +include::{specDir}paths/{{operationIdOriginal}}/operation-security-after.adoc[opts=optional] + +{{! *** OPERATION SAMPLES *** }} +{{!~ Include partials for operation sample requests and responses }} +{{!~ The partials should have a level 1 title; the level offset pushes the title down to the correct section level. }} + +include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] + +include::{snippetDir}{{operationIdOriginal}}/http-response.adoc[opts=optional] + +include::{specDir}paths/{{operationIdOriginal}}/operation-end.adoc[opts=optional] + +:leveloffset: -1 + +include::{specDir}paths/{{operationIdOriginal}}/operation-after.adoc[opts=optional] + +//end::{{operationIdOriginal}}[] + +{{/each}}{{! operation }} +{{~/with}}{{! operations }} + +ifeval::[{count-apis} > 0] +:leveloffset: -1 +endif::[] + +{{/each}}{{! apis }} +{{~/with}}{{! apiInfo }} + +include::{specDir}paths/document-end.adoc[opts=optional] + +:leveloffset: -1 + +include::{specDir}paths/document-after.adoc[opts=optional] + +{{! *** MODELS *** }} +{{> models}} + +{{! *** SECURITY *** }} +include::{specDir}security/document-before.adoc[opts=optional] + +{{#if hasAuthMethods ~}} +[[security]] += Security + +:leveloffset: +1 + +include::{specDir}security/document-begin.adoc[opts=optional] + +{{! *** SECURITY SCHEMES *** }} +{{#each authMethods~}} +include::{specDir}security/{{name}}/security-scheme-before.adoc[opts=optional] + +[[security-{{name}}]] += {{#with vendorExtensions.x-displayName}}{{{this}}}{{else}}{{name}}{{/with}} + +:leveloffset: +1 + +include::{specDir}security/{{name}}/security-scheme-begin.adoc[opts=optional] + +{{#with description ~}} +[markdown] +-- +{{{this}}} +-- +{{~/with}} + +{{#if isBasic ~}} +{{#if isBasicBasic ~}} +[%hardbreaks] +*Type:* {{type}} +{{~else if isBasicBearer ~}} +[%hardbreaks] +*Type:* {{type}} +*Scheme:* {{scheme}} +{{#with bearerFormat}}*Format:* {{this}}{{/with}} +{{~/if}} +{{~else if isOAuth ~}} +.OAuth +[%hardbreaks] +*Authorization URL:* {{authorizationUrl}} +*Token URL:* {{tokenUrl}} +{{~else if isApiKey ~}} +.API Key +[%hardbreaks] +*Key parameter:* {{keyParamName}} +*Key in:* {{#if isKeyInQuery}}query{{/if}} {{#if isKeyInHeader}}header{{/if}} +{{~/if}} + +include::{specDir}security/{{name}}/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + +include::{specDir}security/{{name}}/security-scheme-after.adoc[opts=optional] + +{{/each}}{{! authMethods }} + +include::{specDir}security/document-end.adoc[opts=optional] + +:leveloffset: -1 +{{~/if}}{{! hasAuthMethods }} + +include::{specDir}security/document-after.adoc[opts=optional] + +{{! *** EXTERNAL DOCS *** }} +{{#each externalDocs ~}} +[[see-also]] += See Also + +* link:{{url}}[{{description}}] +{{~/each}} \ No newline at end of file diff --git a/templates/index.mustache b/templates/index.mustache deleted file mode 100644 index 5f71f063..00000000 --- a/templates/index.mustache +++ /dev/null @@ -1,473 +0,0 @@ -= {{{appName}}} -:keywords: OpenAPI, REST -:specDir: partial$ -:snippetDir: partial$paths/ -:page-topic-type: reference -:page-toclevels: 2 -{{! If headerAttributes is true, include document attributes from the named partial}} -{{#headerAttributes}} -include::partial$header-attributes.adoc[opts=optional] -{{/headerAttributes}} - -[comment] -This file is created automatically by OpenAPI Generator. -DO NOT EDIT! See https://{{gitHost}}/{{gitUserId}}/{{gitRepoId}} - -{{! include partial before overview }} -:leveloffset: 1 -{{#specinclude}}/overview/document-before.adoc{{/specinclude}} - -{{! *** OVERVIEW *** }} -[[overview]] -= Overview - -{{! include partial before overview body }} -:leveloffset: +1 -{{#specinclude}}/overview/document-begin.adoc{{/specinclude}} - -{{! If useIntroduction is true, include the API description}} -{{#useIntroduction}} -[markdown] --- -{{{unescapedAppDescription}}} --- -{{/useIntroduction}} - -{{#version}} -[discrete#version] -= Version information -[%hardbreaks] -__Version__ : {{{version}}} -{{/version}} - -{{#servers}} -[discrete#host] -{{#-first}} -= Host information - -{{/-first}} -.... -{{url}} -.... - -{{#description}} -[markdown] --- -{{{description}}} --- -{{/description}} - -{{#variables}} -{{#-first}} -[cols="20,80"] -|=== -| Component | Description - -{{/-first}} -a| *{{name}}* -a| [markdown] --- -{{{description}}} --- - -[%hardbreaks] -{{! enumerated values}} -{{#enumValues}}{{#-first}}*Values:* {{/-first}}{{^-last}}`{{this}}`, {{/-last}}{{#-last}}`{{this}}`{{/-last}}{{/enumValues}} -{{! default value if no enumerated values }} -{{^enumValues}} -{{#value}}*Example:* `+++{{this}}+++`{{/value}} -{{/enumValues}} -// end - -{{#-last}} -|=== -{{/-last}} -{{/variables}} -{{/servers}} - -{{! include partial after overview body }} -{{#specinclude}}/overview/document-end.adoc{{/specinclude}} -:leveloffset: -1 - -{{! include partial after overview }} -{{#specinclude}}/overview/document-after.adoc{{/specinclude}} - -{{! include partial before paths }} -{{#specinclude}}/paths/document-before.adoc{{/specinclude}} - -{{! *** PATHS *** }} -[[resources]] -= Resources - -{{! Count the APIs }} -{{#apiInfo}} -{{#apis}} -{{#-last}} -:count-apis: {{-index}} -{{/-last}} -{{/apis}} -{{/apiInfo}} - -{{! include partial before paths body }} -:leveloffset: +1 -{{#specinclude}}/paths/document-begin.adoc{{/specinclude}} - -{{! Table of contents for endpoints }} -This section describes the operations available with this REST API. -ifeval::[{count-apis} > 1] -The operations are grouped in the following categories. - -[%hardbreaks] -{{#apiInfo}} -{{#apis}} -xref:tag-{{baseName}}[] -{{/apis}} -{{/apiInfo}} -endif::[] - -{{! Endpoint body }} -{{#apiInfo}} -{{#apis}} - -ifeval::[{count-apis} > 1] -{{! tag description }} -[#tag-{{baseName}}] -= {{#lambda.uncamelize}}{{baseName}}{{/lambda.uncamelize}} -:leveloffset: +1 - -ifeval::["{{operationTagDescription}}" != ""] -{{operationTagDescription}} -endif::[] -ifeval::["{{operationTagDescription}}" == ""] -**{toc-title}** -endif::[] -endif::[] - -{{#operations}} -{{! Table of contents for operations }} -[%hardbreaks] -{{#operation}} -xref:{{operationIdOriginal}}[] -{{/operation}} - -{{! Operation body }} -{{#operation}} - -//tag::{{operationIdOriginal}}[] - -{{! include partial before operation }} -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-before.adoc{{/specinclude}} - -[#{{operationIdOriginal}}] -{{#useMethodAndPath}} -= {{httpMethod}} {{path}} -{{/useMethodAndPath}} -{{^useMethodAndPath}} -= {{summary}} -{{/useMethodAndPath}} - -{{! include partial before operation body }} -:leveloffset: +1 -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-begin.adoc{{/specinclude}} - -{{#useMethodAndPath}} -{{summary}} -{{/useMethodAndPath}} -{{^useMethodAndPath}} -.... -{{httpMethod}} {{path}} -.... -{{/useMethodAndPath}} - -{{! Deprecation caution }} -{{#isDeprecated}} -CAUTION: This operation is deprecated, and will be removed in a future release. -{{/isDeprecated}} - -{{! *** OPERATION DESCRIPTION *** }} -{{! include partial before operation description }} -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-description-before.adoc{{/specinclude}} - -[#{{operationIdOriginal}}-description] -= Description - -{{! include partial before operation description body }} -:leveloffset: +1 -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-description-begin.adoc{{/specinclude}} - -[markdown] --- -{{{unescapedNotes}}} --- - -{{! include partials after operation description body }} -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-description-end.adoc{{/specinclude}} - -{{! *** OPERATION CONSUMES *** }} -{{#hasConsumes}} -[#{{operationIdOriginal}}-consumes] -.Consumes -{{#consumes}} -* {{{mediaType}}} -{{/consumes}} -{{/hasConsumes}} - -{{! *** OPERATION PRODUCES *** }} -{{#hasProduces}} -[#{{operationIdOriginal}}-produces] -.Produces -{{#produces}} -* {{{mediaType}}} -{{/produces}} -{{/hasProduces}} - -:leveloffset: -1 - -{{! include partial after operation description }} -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-description-after.adoc{{/specinclude}} - -{{! *** OPERATION PARAMETERS *** }} -{{! include partial before operation parameters }} -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-parameters-before.adoc{{/specinclude}} - -{{> params}} - -{{! request body example }} -{{^skipExamples}} -{{#hasBodyParam}} -//tag::example-{{bodyParam.dataType}}[] -{{#requestBodyExamples}} -==== -{{#example}} -[source,json] ----- -{{{example}}} ----- -{{/example}} -==== -{{/requestBodyExamples}} -//end::example-{{bodyParam.dataType}}[] -{{/hasBodyParam}} -{{/skipExamples}} - -{{! include partials after the operation parameters }} -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-parameters-after.adoc{{/specinclude}} - -{{! *** OPERATION RESPONSES *** }} -{{! include partial before operation responses }} -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-responses-before.adoc{{/specinclude}} - -{{! If there are responses: anchor, title, and table header }} -{{#responses}} -{{#-first}} -[#{{operationIdOriginal}}-responses] -= Responses - -{{! include partial before operation responses body }} -:leveloffset: +1 -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-responses-begin.adoc{{/specinclude}} - -[cols="20,60,20"] -|=== -| HTTP Code | Description | Schema -{{/-first}} -{{/responses}} - -{{! Iterate through responses }} -{{#responses}} -| {{code}} -a| [markdown] --- -{{{message}}} --- -a| {{#returnProperty}}{{>schemas}}{{/returnProperty}} -{{/responses}} - -{{! If there are responses: table footer }} -{{#responses}} -{{#-last}} -|=== - -{{! include partials after operation responses body }} -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-responses-end.adoc{{/specinclude}} -:leveloffset: -1 -{{/-last}} -{{/responses}} - -{{! Response example }} -{{^skipExamples}} -{{#hasExamples}} -//tag::example-{{returnProperty.dataType}}[] -{{#examples}} -==== -{{#example}} -[source,json] ----- -{{{example}}} ----- -{{/example}} -==== -{{/examples}} -//end::example-{{returnProperty.dataType}}[] -{{/hasExamples}} -{{/skipExamples}} - -{{! include partials after operation responses }} -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-responses-after.adoc{{/specinclude}} - -{{! *** OPERATION SECURITY *** }} -{{! include partial before operation security }} -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-security-before.adoc{{/specinclude}} - -{{! If there is operation security: anchor, title, and table header }} -{{#authMethods}} -{{#-first}} -[#{{operationIdOriginal}}-security] -= Security - -{{! include partial before operation security body }} -:leveloffset: +1 -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-security-begin.adoc{{/specinclude}} - -[cols="20,80"] -|=== -| Type | Name -{{/-first}} -{{/authMethods}} - -{{! Iterate through operation security }} -{{#authMethods}} -| {{type}}{{#scheme}} ({{scheme}}){{/scheme}} -| xref:security-{{#lambda.camelcase}}{{name}}{{/lambda.camelcase}}[] -{{/authMethods}} - -{{! If there is operation security: table footer }} -{{#authMethods}} -{{#-last}} -|=== - -{{! include partials after operation security body }} -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-security-end.adoc{{/specinclude}} -:leveloffset: -1 -{{/-last}} -{{/authMethods}} - -{{! include partials after operation security }} -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-security-after.adoc{{/specinclude}} - -{{! *** OPERATION SAMPLES *** }} -{{! Include partials for operation sample requests and responses }} -{{! The partials should have a level 1 title; the level offset pushes the title down to the correct section level. }} -{{#snippetinclude}}{{operationIdOriginal}}/http-request.adoc{{/snippetinclude}} -{{#snippetinclude}}{{operationIdOriginal}}/http-response.adoc{{/snippetinclude}} - -{{! include partials after operation body }} -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-end.adoc{{/specinclude}} -:leveloffset: -1 - -{{! include partials after the operation }} -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-after.adoc{{/specinclude}} - -//end::{{operationIdOriginal}}[] - -{{/operation}} -{{/operations}} - -ifeval::[{count-apis} > 1] -:leveloffset: -1 -endif::[] - -{{/apis}} -{{/apiInfo}} - -{{! include partial after paths body }} -{{#specinclude}}/paths/document-end.adoc{{/specinclude}} -:leveloffset: -1 - -{{! include partial after paths }} -{{#specinclude}}/paths/document-after.adoc{{/specinclude}} - -{{! *** MODELS *** }} -{{> models}} - -{{! include partial before security }} -{{#specinclude}}/security/document-before.adoc{{/specinclude}} - -{{! *** SECURITY *** }} -{{#hasAuthMethods}} -[[security]] -= Security - -{{! include partial before security body }} -:leveloffset: +1 -{{#specinclude}}/security/document-begin.adoc{{/specinclude}} - -{{#authMethods}} - -{{! include partial before security scheme }} -{{#specinclude}}/security/{{name}}/security-scheme-before.adoc{{/specinclude}} - -[[security-{{#lambda.camelcase}}{{name}}{{/lambda.camelcase}}]] -= {{#lambda.uncamelize}}{{name}}{{/lambda.uncamelize}} - -{{! include partial before security scheme body }} -:leveloffset: +1 -{{#specinclude}}/security/{{name}}/security-scheme-begin.adoc{{/specinclude}} - -{{#description}} -[markdown] --- -{{{description}}} --- -{{/description}} - -{{#isBasic}} -{{#isBasicBasic}} -[%hardbreaks] -__Type__ : {{type}} -{{/isBasicBasic}} -{{#isBasicBearer}} -[%hardbreaks] -__Type__ : {{type}} -__Scheme__ : {{scheme}} -{{#bearerFormat}}__Format__: {{bearerFormat}}{{/bearerFormat}} -{{/isBasicBearer}} -{{/isBasic}} -{{#isOAuth}} -.OAuth -[%hardbreaks] -__Authorization URL__ : {{authorizationUrl}} -__Token URL__ : {{tokenUrl}} -{{/isOAuth}} -{{#isApiKey}} -.API Key -[%hardbreaks] -__Key parameter__ : {{keyParamName}} -__Key in__ : {{#isKeyInQuery}}query{{/isKeyInQuery}} {{#isKeyInHeader}}header{{/isKeyInHeader}} -{{/isApiKey}} - -{{! include partial after security scheme body }} -{{#specinclude}}/security/{{name}}/security-scheme-end.adoc{{/specinclude}} -:leveloffset: -1 - -{{! include partial after security scheme }} -{{#specinclude}}/security/{{name}}/security-scheme-after.adoc{{/specinclude}} - -{{/authMethods}} - -{{! include partial after security body }} -{{#specinclude}}/security/document-end.adoc{{/specinclude}} -:leveloffset: -1 - -{{/hasAuthMethods}} - -{{! include partial after security }} -{{#specinclude}}/security/document-after.adoc{{/specinclude}} - -{{! *** EXTERNAL DOCS *** }} -{{#externalDocs}} -[[see-also]] -= See Also - -* link:{{url}}[{{description}}] -{{/externalDocs}} diff --git a/templates/model.handlebars b/templates/model.handlebars new file mode 100644 index 00000000..51da94ed --- /dev/null +++ b/templates/model.handlebars @@ -0,0 +1,47 @@ +.icon:brackets-curly[fw] Object +{blank} + +//tag::{{name}}[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +{{#each vars ~}} +a¦ {{#with vendorExtensions.x-desc-name}}[#{{this}}] +{{/with ~}} +{{#with vendorExtensions.x-alt-title}}*{{{this}}}*{{else}}*{{baseName}}*{{/with}} + +{{#with required}}required{{else}}optional{{/with}} +a¦ {{>property}} +a¦ {{>schemas}} +{{/each}} +{{~#with additionalProperties ~}} +a¦ {{#with vendorExtensions.x-desc-name}}[#{{this}}] +{{/with ~}} +{{#with vendorExtensions.x-additionalPropertiesName}}*<{{this}}>* +{{/with}} +additional + +property +a¦ {{>property}} +a¦ {{>schemas}} +{{/with}} +|=== + +//end::{{name}}[] + +{{! Polymorphism}} +{{~#if hasDiscriminatorWithNonEmptyMapping ~}} +This schema has alternative properties, depending on the value of *{{discriminatorName}}*: +{{#with discriminator ~}} + +[cols="25,55,20"] +|=== +| Value | | Schema +{{#each mappedModels ~}} + +a| `{{mappingName}}` +a| {{{model.unescapedDescription}}} +a| xref:{{modelName}}[] +{{/each}} +|=== +{{~/with}} +{{~/if}} \ No newline at end of file diff --git a/templates/model.mustache b/templates/model.mustache deleted file mode 100644 index 57a957cf..00000000 --- a/templates/model.mustache +++ /dev/null @@ -1,62 +0,0 @@ -.icon:brackets-curly[fw] Object -{blank} - -{{! tag for partial}} -//tag::{{name}}[] - -{{! Create partial model description }} -{{#description}} -ifdef::model-descriptions[] -//tag::desc-{{name}}[] -{{{unescapedDescription}}} -//end::desc-{{name}}[] -endif::model-descriptions[] -{{/description}} - -[cols="25,55,20",separator=¦] -|=== -¦ Property ¦ ¦ Schema - -{{#vars}} -{{! DEFINITION NAME }} -a¦ {{#vendorExtensions}}{{#x-desc-name}}[#{{this}}]{{/x-desc-name}}{{/vendorExtensions}} -{{#vendorExtensions.x-alt-title}}*{{{this}}}*{{/vendorExtensions.x-alt-title}}{{^vendorExtensions.x-alt-title}}*{{baseName}}*{{/vendorExtensions.x-alt-title}} + -_{{#required}}required{{/required}}{{^required}}optional{{/required}}_ -{{! DEFINITION DESCRIPTION }} -a¦ {{>property}} -{{! DEFINITION SCHEMA }} -a¦ {{>schemas}} -{{/vars}} -{{#additionalProperties}} -{{! ADDITIONAL PROPERTY NAME }} -a¦ {{#vendorExtensions}}{{#x-desc-name}}[#{{this}}]{{/x-desc-name}} -{{#x-additionalPropertiesName}}*<{{this}}>* +{{/x-additionalPropertiesName}}{{/vendorExtensions}} -_additional + -property_ -{{! ADDITIONAL PROPERTY DESCRIPTION }} -a¦ {{>property}} -{{! ADDITIONAL PROPERTY SCHEMA }} -a¦ {{>schemas}} -{{/additionalProperties}} -|=== - -{{! end tag for partial}} -//end::{{name}}[] - -{{! Polymorphism}} -{{#hasDiscriminatorWithNonEmptyMapping}} -This schema has alternative properties, depending on the value of *{{discriminatorName}}*: -{{#discriminator}} - -[cols="25,55,20"] -|=== -| Value | | Schema -{{#mappedModels}} - -a| `{{mappingName}}` -a| {{{model.unescapedDescription}}} -a| xref:{{modelName}}[] -{{/mappedModels}} -|=== -{{/discriminator}} -{{/hasDiscriminatorWithNonEmptyMapping}} \ No newline at end of file diff --git a/templates/models.handlebars b/templates/models.handlebars new file mode 100644 index 00000000..ec64412a --- /dev/null +++ b/templates/models.handlebars @@ -0,0 +1,168 @@ +include::{specDir}definitions/document-before.adoc[opts=optional] + +[#models] += Definitions + +{{#each models ~}} +{{#with model ~}} +{{#unless isEnum ~}} +{{#if @last ~}} +:count-models: {{@index}} +{{~/if}} +{{~/unless}} +{{~/with}} +{{~/each}} +:leveloffset: +1 + +include::{specDir}definitions/document-begin.adoc[opts=optional] + +This section describes the properties consumed and returned by this REST API. + +ifeval::[{count-models} > 0] +ifeval::[{count-models} > 8] +[.two-columns] +endif::[] +[%hardbreaks] +{{#each models ~}} +{{#with model ~}} +{{#if isEnum ~}} +ifdef::enum-definitions[] +xref:{{name}}[] +endif::enum-definitions[] +{{~else ~}} +xref:{{name}}[] +{{~/if}} +{{~/with}} +{{/each ~}} +endif::[] + +{{! *** DEFINITION *** }} +{{#each models ~}} +{{#with model ~}} +include::{specDir}definitions/{{name}}/definition-before.adoc[opts=optional] + +{{#if isEnum ~}} +ifdef::enum-definitions[]{{! omit enums from model list. Probably going to regret this }} +{{/if~}} +ifdef::show-{{name}}[] +[#{{name}}] +endif::show-{{name}}[] +ifndef::show-{{name}}[] +:leveloffset: +1 + +[discrete#{{name}}] +endif::show-{{name}}[] += {{#with title}}{{this}}{{else}}{{classname}}{{/with}} + +{{#with description ~}} +ifdef::model-descriptions[] +//tag::desc-{{name}}[] +{{{unescapedDescription}}} +//end::desc-{{name}}[] +endif::model-descriptions[] + +{{/with~}} + +:leveloffset: +1 + +include::{specDir}definitions/{{name}}/definition-begin.adoc[opts=optional] + +{{#with composedSchemas ~}} +.icon:bars[fw] Composite Schema +{blank} + +//tag::{{name}}[] +{{#each oneOf ~}} +{{#if @first ~}} +[cols="25,55,20",separator=¦] +|=== +¦ One{nbsp}of{nbsp}... ¦ ¦ Schema +{{/if}} +a¦ {{#unless @first}}or{{/unless}} +a¦ {{>property}} +a¦ {{>schemas}} +{{#if @last ~}} +|=== +{{/if}} +{{~/each}} +{{~#each anyOf ~}} +{{#if @first }} +[cols="25,55,20",separator=¦] +|=== +¦ Any{nbsp}of{nbsp}... ¦ ¦ Schema +{{/if}} +a¦ {{#unless @first}}and{nbsp}/ or{{/unless}} +a¦ {{>property}} +a¦ {{>schemas}} +{{#if @last ~}} +|=== +{{/if}} +{{~/each}} +{{~#each allOf ~}} +{{#if @first ~}} +[cols="25,55,20",separator=¦] +|=== +¦ All{nbsp}of{nbsp}... ¦ ¦ Schema +{{/if}} +a¦ {{#unless @first}}and{{/unless}} +a¦ {{>property}} +a¦ {{>schemas}} +{{#if @last ~}} +|=== +{{/if}} +{{~/each}} +//end::{{name}}[] +{{~else ~}}{{! composedSchemas }} +{{#if hasVars ~}} +{{>model}} +{{~else if isMap ~}} +{{>model}} +{{~else if isEnum ~}} +.icon:menu[fw] Enumeration +{blank} + +{{>property}} +.Schema +//tag::type-{{name}}[] +{{>schemas}} +//end::type-{{name}}[] +{{~else if isString ~}} +.icon:quote-left[fw] String +{blank} + +{{>property}} +{{~else if isArray ~}} +.icon:brackets[fw] Array +{blank} + +{{>property}} + +{{#with items ~}} +.Schema +{{>schema}} array +{{~/with}} +{{~/if}}{{! hasVars }} +{{~/with}}{{! composedSchemas }} + +include::{specDir}definitions/{{name}}/definition-end.adoc[opts=optional] + +:leveloffset: -1 + +ifndef::show-{{name}}[] +:leveloffset: -1 +endif::show-{{name}}[] + +{{#if isEnum ~}} +endif::enum-definitions[] + +{{/if~}} + +include::{specDir}definitions/{{name}}/definition-after.adoc[opts=optional] +{{/with}}{{! model }} +{{/each}}{{! models }} + +include::{specDir}definitions/document-end.adoc[opts=optional] + +:leveloffset: -1 + +include::{specDir}definitions/document-after.adoc[opts=optional] \ No newline at end of file diff --git a/templates/models.mustache b/templates/models.mustache deleted file mode 100644 index 3d0751be..00000000 --- a/templates/models.mustache +++ /dev/null @@ -1,188 +0,0 @@ -{{! include partial before definitions }} -{{#specinclude}}/definitions/document-before.adoc{{/specinclude}} - -[#models] -= Definitions - -{{! Count the models }} -{{#models}} -{{#model}} -{{^isEnum}} -{{#-last}} -:count-models: {{-index}} -{{/-last}} -{{/isEnum}} -{{/model}} -{{/models}} - -{{! include partial before definitions body }} -:leveloffset: +1 -{{#specinclude}}/definitions/document-begin.adoc{{/specinclude}} - -{{! Table of contents }} -This section describes the properties consumed and returned by this REST API. - -ifeval::[{count-models} > 1] -ifdef::collapse-models[] -[.two-columns] -endif::collapse-models[] -[%hardbreaks] -{{#models}} -{{#model}} -{{#isEnum}} -ifdef::enum-definitions[] -{{/isEnum}} -xref:{{name}}[] -{{#isEnum}} -endif::enum-definitions[] -{{/isEnum}} -{{/model}} -{{/models}} -endif::[] - -{{! *** DEFINITION *** }} -{{#models}} -{{#model}} -{{! omit enums from model list. Probably going to regret this }} -{{#isEnum}} -ifdef::enum-definitions[] -[#{{name}}] -= {{#title}}{{title}}{{/title}}{{^title}}{{classname}}{{/title}} - -.icon:menu[fw] Enumeration -{blank} - -{{#description}} -//tag::desc-{{name}}[] -{{{unescapedDescription}}} -//end::desc-{{name}}[] - -{{/description}} -.Schema -//tag::type-{{name}}[] -{{>schemas}} -//end::type-{{name}}[] -endif::enum-definitions[] -{{/isEnum}} -{{^isEnum}} - -{{! include partial before definition }} -{{#specinclude}}/definitions/{{name}}/definition-before.adoc{{/specinclude}} - -ifdef::collapse-models[] -[discrete] -endif::collapse-models[] -[#{{name}}] -= {{#title}}{{title}}{{/title}}{{^title}}{{classname}}{{/title}} - -{{! include partial before definition body }} -:leveloffset: +1 -{{#specinclude}}/definitions/{{name}}/definition-begin.adoc{{/specinclude}} - -{{^composedSchemas}} -{{#hasVars}} -{{>model}} -{{/hasVars}} -{{^hasVars}} -{{#isMap}} -{{>model}} -{{/isMap}} -{{/hasVars}} -{{#isString}} -.icon:quote-left[fw] String -{blank} - -{{>property}} -{{/isString}} -{{#isArray}} -.icon:brackets[fw] Array -{blank} - -{{>property}} - -{{#items}} -.Schema -{{>schema}} array -{{/items}} -{{/isArray}} -{{/composedSchemas}} -{{#composedSchemas}} -.icon:bars[fw] Composite Schema -{blank} - -{{! tag for partial}} -//tag::{{name}}[] - -{{! Create partial model description }} -{{#description}} -ifdef::model-descriptions[] -//tag::desc-{{name}}[] -{{{unescapedDescription}}} -//end::desc-{{name}}[] -endif::model-descriptions[] -{{/description}} - -{{#oneOf}} -{{#-first}} -[cols="25,55,20",separator=¦] -|=== -¦ One{nbsp}of{nbsp}... ¦ ¦ Schema - -{{/-first}} -a¦ {{^-first}}_or_{{/-first}} -a¦ {{>property}} -a¦ {{>schemas}} -{{#-last}} -|=== -{{/-last}} -{{/oneOf}} -{{#anyOf}} -{{#-first}} -[cols="25,55,20",separator=¦] -|=== -¦ Any{nbsp}of{nbsp}... ¦ ¦ Schema - -{{/-first}} -a¦ {{^-first}}_and{nbsp}/ or_{{/-first}} -a¦ {{>property}} -a¦ {{>schemas}} -{{#-last}} -|=== -{{/-last}} -{{/anyOf}} -{{#allOf}} -{{#-first}} -[cols="25,55,20",separator=¦] -|=== -¦ All{nbsp}of{nbsp}... ¦ ¦ Schema - -{{/-first}} -a¦ {{^-first}}_and_{{/-first}} -a¦ {{>property}} -a¦ {{>schemas}} -{{#-last}} -|=== -{{/-last}} -{{/allOf}} - -{{! end tag for partial}} -//end::{{name}}[] -{{/composedSchemas}} - -{{! include partial after definition body }} -{{#specinclude}}/definitions/{{name}}/definition-end.adoc{{/specinclude}} - -{{! include partial after definition }} -:leveloffset: -1 -{{#specinclude}}/definitions/{{name}}/definition-after.adoc{{/specinclude}} - -{{/isEnum}} -{{/model}} -{{/models}} - -{{! include partial after definitions body }} -{{#specinclude}}/definitions/document-end.adoc{{/specinclude}} - -{{! include partial after definitions }} -:leveloffset: -1 -{{#specinclude}}/definitions/document-after.adoc{{/specinclude}} \ No newline at end of file diff --git a/templates/param.handlebars b/templates/param.handlebars new file mode 100644 index 00000000..601dc8b8 --- /dev/null +++ b/templates/param.handlebars @@ -0,0 +1,26 @@ +a¦ *{{#if isBodyParam}}Body{{else}}{{baseName}}{{/if}}* + +{{#if required}}required{{else}}optional{{/if}} +a¦ {{#with vendorExtensions.x-desc-edition}}[.edition]##{{this}}##{{#unless vendorExtensions.x-desc-status}} + +{{/unless}}{{/with ~}} +{{#with vendorExtensions.x-desc-status}}[.status]##{{this}}## + +{{/with~}} +[markdown] +-- +{{#with unescapedDescription ~}} +{{{this}}} +{{~/with ~}} +{{~#if isEnumRef ~}} +include::index.adoc[tag=desc-{{dataType}}, opts=optional]{{! if this is an enum reference, fetch remote description}} +{{~/if}} +-- + +[%hardbreaks] +{{#with allowableValues ~}} +*Values:* {{#each enumVars}}`{{value}}`{{#unless @last}}, {{/unless}}{{/each}} +{{/with ~}} +{{>values ~}} +{blank} + +a¦ {{>schemas }} diff --git a/templates/param.mustache b/templates/param.mustache deleted file mode 100644 index 68e06af2..00000000 --- a/templates/param.mustache +++ /dev/null @@ -1,74 +0,0 @@ -a¦ *{{#isBodyParam}}Body{{/isBodyParam}}{{^isBodyParam}}{{baseName}}{{/isBodyParam}}* + -_{{#required}}required{{/required}}{{^required}}optional{{/required}}_ -a¦ {{#vendorExtensions}} -{{#x-desc-edition}}[.edition]##{{this}}##{{/x-desc-edition}}{{#x-desc-status}}[.status]##{{this}}##{{/x-desc-status}} -{{/vendorExtensions}} - -[markdown] --- -{{#unescapedDescription}} -{{{unescapedDescription}}} -{{/unescapedDescription}} -{{^unescapedDescription}} -{{{description}}} -{{/unescapedDescription}} -{{! if this is an enum reference, fetch remote description}} -{{#isEnumRef}} -include::index.adoc[tag=desc-{{dataType}}, opts=optional] -{{/isEnumRef}} --- - -[%hardbreaks] -{{! enumerated values}} -{{#allowableValues}} -*Values:* {{#enumVars}}{{^-last}}`{{value}}`, {{/-last}}{{#-last}}`{{value}}`{{/-last}}{{/enumVars}} -{{/allowableValues}} -{{! default value}} -{{#vendorExtensions.x-has-default}} -*Default:* `{{#isString}}+++"{{/isString}}{{{defaultValue}}}{{#isString}}"+++{{/isString}}` -{{/vendorExtensions.x-has-default}} -{{! pattern}} -{{#pattern}} -*Pattern:* `+++{{{pattern}}}+++` -{{/pattern}} -{{! minimum value}} -{{#minimum}} -*Minimum:* `{{{minimum}}}`{{#exclusiveMinimum}} (exclusive){{/exclusiveMinimum}} -{{/minimum}} -{{! maximum value}} -{{#maximum}} -*Maximum:* `{{{maximum}}}`{{#exclusiveMaximum}} (exclusive){{/exclusiveMaximum}} -{{/maximum}} -{{! multiple of value}} -{{#multipleOf}} -*Multiple of:* `{{{multipleOf}}}` -{{/multipleOf}} -{{! minimum length value}} -{{#minLength}} -*Minimum length:* `{{{minLength}}}` -{{/minLength}} -{{! maximum length value}} -{{#maxLength}} -*Maximum length:* `{{{maxLength}}}` -{{/maxLength}} -{{! minimum items value}} -{{#minItems}} -*Minimum items:* `{{{minItems}}}` -{{/minItems}} -{{! maximum items value}} -{{#maxItems}} -*Maximum items:* `{{{maxItems}}}` -{{/maxItems}} -{{! unique items value}} -{{#uniqueItems}} -*Unique items:* `{{{uniqueItems}}}` -{{/uniqueItems}} -{{! example -- deprecated}} -{{#isBodyParam}} -{{#vendorExtensions.x-has-example}} -*Example:* `{{#isString}}+++"{{/isString}}{{{example}}}{{#isString}}"+++{{/isString}}` -{{/vendorExtensions.x-has-example}} -{{/isBodyParam}} -{blank} - -a¦ {{>schemas}} diff --git a/templates/params.handlebars b/templates/params.handlebars new file mode 100644 index 00000000..26994dee --- /dev/null +++ b/templates/params.handlebars @@ -0,0 +1,110 @@ +{{#if hasParams ~}} +[#{{operationIdOriginal}}-parameters] += Parameters + +:leveloffset: +1 + +include::{specDir}paths/{{operationIdOriginal}}/operation-parameters-begin.adoc[opts=optional] + +{{#if hasPathParams ~}} +[#{{operationIdOriginal}}-path] +{{#if useTableTitles ~}} +.Path Parameters +{blank} +{{~else ~}} += Path Parameters +{{~/if}} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +{{#each pathParams ~}} +{{>param}} +{{~/each}} +|=== +{{/if ~}} + +{{#if hasQueryParams ~}} +[#{{operationIdOriginal}}-query] +{{#if useTableTitles ~}} +.Query Parameters +{blank} +{{~else ~}} += Query Parameters +{{~/if}} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +{{#each queryParams ~}} +{{>param}} +{{~/each}} +|=== +{{/if ~}} + +{{#if hasHeaderParams ~}} +[#{{operationIdOriginal}}-header] +{{#if useTableTitles ~}} +.Header Parameters +{blank} +{{~else ~}} += Header Parameters +{{~/if}} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +{{#each headerParams ~}} +{{>param}} +{{~/each}} +|=== +{{/if ~}} + +{{#if hasFormParams ~}} +[#{{operationIdOriginal}}-form] +{{#if useTableTitles ~}} +.Form Parameters +{blank} +{{~else ~}} += Form Parameters +{{~/if}} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +{{#each formParams ~}} +{{>param}} +{{~/each}} +|=== +{{/if ~}} + +{{#if hasBodyParam ~}} +[#{{operationIdOriginal}}-body] +{{#if useTableTitles ~}} +.Body Parameter +{blank} +{{~else ~}} += Body Parameter +{{~/if}} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +{{#each bodyParams ~}} +{{>param}} +{{~/each}} +|=== +{{/if}} + +include::{specDir}paths/{{operationIdOriginal}}/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 +{{#each allParams ~}} +{{>tocs}} +{{~/each}} +{{~/if}}{{! hasParams }} \ No newline at end of file diff --git a/templates/params.mustache b/templates/params.mustache deleted file mode 100644 index 5b75171e..00000000 --- a/templates/params.mustache +++ /dev/null @@ -1,112 +0,0 @@ -{{#hasParams}} -[#{{operationIdOriginal}}-parameters] -= Parameters - -{{! include partial before operation parameters body }} -:leveloffset: +1 -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-parameters-begin.adoc{{/specinclude}} - -{{#hasPathParams}} -[#{{operationIdOriginal}}-path] -{{^useTableTitles}} -= Path Parameters -{{/useTableTitles}} -{{#useTableTitles}} -.Path Parameters -{blank} -{{/useTableTitles}} - -[cols="20,60,20",separator=¦] -|=== -¦ Name ¦ Description ¦ Schema - -{{#pathParams}} -{{>param}} -{{/pathParams}} -|=== -{{/hasPathParams}} - -{{#hasQueryParams}} -[#{{operationIdOriginal}}-query] -{{^useTableTitles}} -= Query Parameters -{{/useTableTitles}} -{{#useTableTitles}} -.Query Parameters -{blank} -{{/useTableTitles}} - -[cols="20,60,20",separator=¦] -|=== -¦ Name ¦ Description ¦ Schema - -{{#queryParams}} -{{>param}} -{{/queryParams}} -|=== -{{/hasQueryParams}} - -{{#hasHeaderParams}} -[#{{operationIdOriginal}}-header] -{{^useTableTitles}} -= Header Parameters -{{/useTableTitles}} -{{#useTableTitles}} -.Header Parameters -{blank} -{{/useTableTitles}} - -[cols="20,60,20",separator=¦] -|=== -¦ Name ¦ Description ¦ Schema - -{{#headerParams}} -{{>param}} -{{/headerParams}} -|=== -{{/hasHeaderParams}} - -{{#hasFormParams}} -[#{{operationIdOriginal}}-form] -{{^useTableTitles}} -= Form Parameters -{{/useTableTitles}} -{{#useTableTitles}} -.Form Parameters -{blank} -{{/useTableTitles}} - -[cols="20,60,20",separator=¦] -|=== -¦ Name ¦ Description ¦ Schema - -{{#formParams}} -{{>param}} -{{/formParams}} -|=== -{{/hasFormParams}} - -{{#hasBodyParam}} -[#{{operationIdOriginal}}-body] -{{^useTableTitles}} -= Body Parameter -{{/useTableTitles}} -{{#useTableTitles}} -.Body Parameter -{blank} -{{/useTableTitles}} - -[cols="20,60,20",separator=¦] -|=== -¦ Name ¦ Description ¦ Schema - -{{#bodyParams}} -{{>param}} -{{/bodyParams}} -|=== -{{/hasBodyParam}} - -{{! include partial after operation parameters body }} -{{#specinclude}}/paths/{{operationIdOriginal}}/operation-parameters-end.adoc{{/specinclude}} -:leveloffset: -1 -{{/hasParams}} \ No newline at end of file diff --git a/templates/property.handlebars b/templates/property.handlebars new file mode 100644 index 00000000..8b0f9409 --- /dev/null +++ b/templates/property.handlebars @@ -0,0 +1,43 @@ +{{#with vendorExtensions.x-desc-edition}}[.edition]##{{this}}##{{#unless vendorExtensions.x-desc-status}} + +{{/unless}}{{/with ~}} +{{#with vendorExtensions.x-desc-status}}[.status]##{{this}}## + +{{/with~}} +[markdown] +-- +{{#with vendorExtensions.x-desc-refs ~}} +ifdef::alt-markdown-links[] +{{this}} + +endif::alt-markdown-links[] +{{/with ~}} +{{#with ref ~}} +include::index.adoc[tag=desc-{{dataType}}, opts=optional] +{{~else with description~}} +{{{unescapedDescription}}} +{{~/with}} +{{~#with vendorExtensions.x-desc-more}} + +// tag::desc-more[] +{{{this}}} +// end::desc-more[] +{{~/with}} +-- +{{~#each vendorExtensions.x-enumDescriptions ~}} +{{#if @first}} + +[horizontal.enum] +{{/if~}} +`{{#if isString}}"{{/if}}{{@key}}{{#if isString}}"{{/if}}`::{{! FIXME: Update CSS no bold for hdlist1 in enum }} +{{{this}}} +{{/each}} + +[%hardbreaks] +{{#if isEnum ~}} +{{#with allowableValues ~}} +*Values:* {{#each values}}`{{#if isString}}"{{/if}}{{this}}{{#if isString}}"{{/if}}`{{#unless @last}}, {{/unless}}{{/each}} +{{~/with}} +{{/if ~}} +{{>values ~}} +{blank} \ No newline at end of file diff --git a/templates/property.mustache b/templates/property.mustache deleted file mode 100644 index 173ebcef..00000000 --- a/templates/property.mustache +++ /dev/null @@ -1,93 +0,0 @@ -{{#vendorExtensions}} -{{#x-desc-edition}}[.edition]##{{this}}##{{/x-desc-edition}}{{#x-desc-status}}[.status]##{{this}}##{{/x-desc-status}} -{{/vendorExtensions}} - -[markdown] --- -{{#vendorExtensions}} -{{#x-desc-refs}} -ifdef::alt-markdown-links[] -{{this}} - -endif::alt-markdown-links[] -{{/x-desc-refs}} -{{/vendorExtensions}} -{{#description}} -{{{unescapedDescription}}} -{{/description}} -{{#vendorExtensions}} -{{#x-desc-more}} - -// tag::desc-more[] -{{{this}}} -// end::desc-more[] -{{/x-desc-more}} -{{/vendorExtensions}} -{{! if ref is present, fetch remote description}} -{{#ref}} -include::index.adoc[tag=desc-{{dataType}}, opts=optional] -{{/ref}} --- -{{#vendorExtensions}} -{{#x-enumDescriptions}} - -.Enum Descriptions -.... -{{{this}}} -.... -{{/x-enumDescriptions}} -{{/vendorExtensions}} - -[%hardbreaks] -{{! enumerated values}} -{{#isEnum}} -{{#allowableValues}} -*Values:* {{#values}}{{^-last}}`{{#isString}}"{{/isString}}{{this}}{{#isString}}"{{/isString}}`, {{/-last}}{{#-last}}`{{#isString}}"{{/isString}}{{this}}{{#isString}}"{{/isString}}`{{/-last}}{{/values}} -{{/allowableValues}} -{{/isEnum}} -{{! default value}} -{{#vendorExtensions.x-has-default}} -*Default:* `{{#isString}}+++"{{/isString}}{{{defaultValue}}}{{#isString}}"+++{{/isString}}` -{{/vendorExtensions.x-has-default}} -{{! pattern}} -{{#pattern}} -*Pattern:* `+++{{{pattern}}}+++` -{{/pattern}} -{{! minimum value}} -{{#minimum}} -*Minimum:* `{{{minimum}}}`{{#exclusiveMinimum}} (exclusive){{/exclusiveMinimum}} -{{/minimum}} -{{! maximum value}} -{{#maximum}} -*Maximum:* `{{{maximum}}}`{{#exclusiveMaximum}} (exclusive){{/exclusiveMaximum}} -{{/maximum}} -{{! multiple of value}} -{{#multipleOf}} -*Multiple of:* `{{{multipleOf}}}` -{{/multipleOf}} -{{! minimum length value}} -{{#minLength}} -*Minimum length:* `{{{minLength}}}` -{{/minLength}} -{{! maximum length value}} -{{#maxLength}} -*Maximum length:* `{{{maxLength}}}` -{{/maxLength}} -{{! minimum items value}} -{{#minItems}} -*Minimum items:* `{{{minItems}}}` -{{/minItems}} -{{! maximum items value}} -{{#maxItems}} -*Maximum items:* `{{{maxItems}}}` -{{/maxItems}} -{{! unique items value}} -{{#uniqueItems}} -*Unique items:* `{{{uniqueItems}}}` -{{/uniqueItems}} -{{! example -- deprecated}} -{{#vendorExtensions.x-has-example}} -*Example:* `{{#isString}}+++"{{/isString}}{{{example}}}{{#isString}}"+++{{/isString}}` -{{/vendorExtensions.x-has-example}} -{{! OpenAPI generator doesn't support externalDocs in schemas, so don't try }} -{blank} \ No newline at end of file diff --git a/templates/schema.handlebars b/templates/schema.handlebars new file mode 100644 index 00000000..5da6dbcd --- /dev/null +++ b/templates/schema.handlebars @@ -0,0 +1,11 @@ +{{#with ref ~}} +xref:{{dataType}}[] +{{~else if isModel ~}} +xref:{{dataType}}[] +{{~else if isMap ~}} +xref:{{dataType}}[] +{{~else if isAnyType ~}} +Any Type +{{~else ~}} +{{dataType}}{{#with dataFormat}} ({{{this}}}){{/with}} +{{~/with}} \ No newline at end of file diff --git a/templates/schema.mustache b/templates/schema.mustache deleted file mode 100644 index c1c83eab..00000000 --- a/templates/schema.mustache +++ /dev/null @@ -1,29 +0,0 @@ -{{! If this has a reference, create a link to that object; }} -{{#ref}} -xref:{{dataType}}[] -{{/ref}} -{{! ... if it has no reference, then: }} -{{^ref}} -{{! ... if it's a model, create a link to that object; }} -{{#isModel}} -xref:{{dataType}}[] -{{/isModel}} -{{! ... if it's not a model, then: }} -{{^isModel}} -{{! ... if it's a map, create a link to that object; }} -{{#isMap}} -xref:{{dataType}}[] -{{/isMap}} -{{! ... if it isn't a map, then: }} -{{^isMap}} -{{! ... if this has a specific data type, output the data type and data format; }} -{{^isAnyType}} -{{#lambda.uncamelize}}{{dataType}}{{/lambda.uncamelize}}{{#dataFormat}} ({{{dataFormat}}}){{/dataFormat}} -{{/isAnyType}} -{{! ... if not, just output the base type. }} -{{#isAnyType}} -{{#lambda.uncamelize}}{{baseType}}{{/lambda.uncamelize}} -{{/isAnyType}} -{{/isMap}} -{{/isModel}} -{{/ref}} \ No newline at end of file diff --git a/templates/schemas.handlebars b/templates/schemas.handlebars new file mode 100644 index 00000000..9a377ae2 --- /dev/null +++ b/templates/schemas.handlebars @@ -0,0 +1,7 @@ +{{#if isEnumRef}} +include::index.adoc[tag=type-{{dataType}}, opts=optional] +{{~else if isArray ~}} +{{#with items}}{{>schema}}{{/with}} array +{{~else ~}} +{{>schema}} +{{~/if}} \ No newline at end of file diff --git a/templates/schemas.mustache b/templates/schemas.mustache deleted file mode 100644 index 812c5cf8..00000000 --- a/templates/schemas.mustache +++ /dev/null @@ -1,16 +0,0 @@ -{{! If this is an enum ref: }} -{{#isEnumRef}} - -include::index.adoc[tag=type-{{dataType}}, opts=optional] -{{/isEnumRef}} -{{! If this is not an enum ref, then ... }} -{{^isEnumRef}} -{{! If this is an array: }} -{{#isArray}} -{{#items}}{{>schema}}{{/items}} array -{{/isArray}} -{{! If this is not an array: }} -{{^isArray}} -{{>schema}} -{{/isArray}} -{{/isEnumRef}} \ No newline at end of file diff --git a/templates/toc.handlebars b/templates/toc.handlebars new file mode 100644 index 00000000..004f31a1 --- /dev/null +++ b/templates/toc.handlebars @@ -0,0 +1,7 @@ +{{#with ref ~}} +:show-{{dataType}}: +{{else if isModel ~}} +:show-{{dataType}}: +{{else if isMap ~}} +:show-{{dataType}}: +{{/with ~}} \ No newline at end of file diff --git a/templates/tocs.handlebars b/templates/tocs.handlebars new file mode 100644 index 00000000..9a511d70 --- /dev/null +++ b/templates/tocs.handlebars @@ -0,0 +1,7 @@ +{{#unless isEnumRef ~}} +{{#if isArray ~}} +{{#with items}}{{>toc}}{{/with}} +{{~else ~}} +{{>toc}} +{{~/if}} +{{~/unless}} \ No newline at end of file diff --git a/templates/values.handlebars b/templates/values.handlebars new file mode 100644 index 00000000..2b399379 --- /dev/null +++ b/templates/values.handlebars @@ -0,0 +1,37 @@ +{{#if vendorExtensions.x-has-default ~}} +*Default:* `{{#if isString}}+++"{{/if}}{{{defaultValue}}}{{#if isString}}"+++{{/if}}` +{{/if}} +{{~#with pattern ~}} +*Pattern:* `+++{{{this}}}+++` +{{/with}} +{{~#with minimum ~}} +*Minimum:* `{{{this}}}`{{#if exclusiveMinimum}} (exclusive){{/if}} +{{/with}} +{{~#with maximum ~}} +*Maximum:* `{{{this}}}`{{#if exclusiveMaximum}} (exclusive){{/if}} +{{/with}} +{{~#with multipleOf ~}} +*Multiple of:* `{{{this}}}` +{{/with}} +{{~#with minLength ~}} +*Minimum length:* `{{{this}}}` +{{/with}} +{{~#with maxLength ~}} +*Maximum length:* `{{{this}}}` +{{/with}} +{{~#with minItems ~}} +*Minimum items:* `{{{this}}}` +{{/with}} +{{~#with maxItems ~}} +*Maximum items:* `{{{this}}}` +{{/with}} +{{~#if uniqueItems ~}} +*Unique items:* yes +{{/if}} +{{~#if isNullable ~}} +*Nullable:* yes +{{/if}} +{{~#if vendorExtensions.x-has-example ~}} +*Example:* `{{#if isString}}+++"{{/if}}{{{example}}}{{#if isString}}"+++{{/if}}` +{{/if ~}} +{{! OpenAPI generator doesn't support externalDocs in schemas, so don't try }} \ No newline at end of file