diff --git a/build.gradle b/build.gradle index 7bfefd4b..a8e27363 100644 --- a/build.gradle +++ b/build.gradle @@ -26,6 +26,7 @@ wrapper { defaultTasks 'admin:openApiGenerate', 'query-service:openApiGenerate', 'query-settings:openApiGenerate', + 'eventing:openApiGenerate', 'functions:openApiGenerate', 'indexes:openApiGenerate', 'analytics-admin:openApiGenerate', diff --git a/docs/modules/analytics-rest-admin/pages/index.adoc b/docs/modules/analytics-rest-admin/pages/index.adoc index b64b7f39..9635b7bd 100644 --- a/docs/modules/analytics-rest-admin/pages/index.adoc +++ b/docs/modules/analytics-rest-admin/pages/index.adoc @@ -59,7 +59,7 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* @@ -70,7 +70,7 @@ The host name or IP address of a node running the Analytics service. [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* @@ -81,7 +81,7 @@ The Analytics service REST port. Use `18095` for secure access. [%hardbreaks] *Values:* `8095`, `18095` -*Example:* `pass:c[8095]` +*Example:* `+++8095+++` // end |=== @@ -179,6 +179,15 @@ Cancels an active request. // markup not found, no include::{specDir}paths/cancel_request/operation-description-end.adoc[opts=optional] + +[#cancel_request-consumes] +.Consumes +* application/x-www-form-urlencoded + +[#cancel_request-produces] +.Produces +* application/json + :leveloffset: -1 @@ -204,13 +213,13 @@ Cancels an active request. .Form Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *client_context_id* + +a¦ *client_context_id* + _required_ -a| +a¦ [markdown] @@ -221,7 +230,7 @@ Identifier passed by the client that is used to identify an active request to be [%hardbreaks] {blank} -a| String +a¦ String @@ -239,16 +248,6 @@ a| String // markup not found, no include::{specDir}paths/cancel_request/operation-parameters-after.adoc[opts=optional] -[#cancel_request-produces] -= Produces - -* application/json - -[#cancel_request-consumes] -= Consumes - -* application/x-www-form-urlencoded - // markup not found, no include::{specDir}paths/cancel_request/operation-responses-before.adoc[opts=optional] @@ -388,6 +387,12 @@ Shows various details about the current status of the Analytics Service, such as // markup not found, no include::{specDir}paths/cluster_status/operation-description-end.adoc[opts=optional] + + +[#cluster_status-produces] +.Produces +* application/json + :leveloffset: -1 @@ -405,12 +410,6 @@ Shows various details about the current status of the Analytics Service, such as // markup not found, no include::{specDir}paths/cluster_status/operation-parameters-after.adoc[opts=optional] -[#cluster_status-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/cluster_status/operation-responses-before.adoc[opts=optional] @@ -546,6 +545,12 @@ Gets a list of all completed analytic requests. // markup not found, no include::{specDir}paths/completed_requests/operation-description-end.adoc[opts=optional] + + +[#completed_requests-produces] +.Produces +* application/json + :leveloffset: -1 @@ -563,12 +568,6 @@ Gets a list of all completed analytic requests. // markup not found, no include::{specDir}paths/completed_requests/operation-parameters-after.adoc[opts=optional] -[#completed_requests-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/completed_requests/operation-responses-before.adoc[opts=optional] @@ -704,6 +703,12 @@ Shows the progress of ingestion by the Analytics service, for each Analytics col // markup not found, no include::{specDir}paths/ingestion_status/operation-description-end.adoc[opts=optional] + + +[#ingestion_status-produces] +.Produces +* application/json + :leveloffset: -1 @@ -721,12 +726,6 @@ Shows the progress of ingestion by the Analytics service, for each Analytics col // markup not found, no include::{specDir}paths/ingestion_status/operation-parameters-after.adoc[opts=optional] -[#ingestion_status-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/ingestion_status/operation-responses-before.adoc[opts=optional] @@ -866,6 +865,12 @@ 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] + + +[#monitor_node-produces] +.Produces +* application/json + :leveloffset: -1 @@ -883,12 +888,6 @@ NOTE: This endpoint may not return meaningful results in Couchbase Server 7.0 an // markup not found, no include::{specDir}paths/monitor_node/operation-parameters-after.adoc[opts=optional] -[#monitor_node-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/monitor_node/operation-responses-before.adoc[opts=optional] @@ -1024,6 +1023,12 @@ Restarts all Analytics Service nodes in the cluster. // markup not found, no include::{specDir}paths/restart_cluster/operation-description-end.adoc[opts=optional] + + +[#restart_cluster-produces] +.Produces +* application/json + :leveloffset: -1 @@ -1041,12 +1046,6 @@ Restarts all Analytics Service nodes in the cluster. // markup not found, no include::{specDir}paths/restart_cluster/operation-parameters-after.adoc[opts=optional] -[#restart_cluster-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/restart_cluster/operation-responses-before.adoc[opts=optional] @@ -1182,6 +1181,12 @@ Restarts the specified Analytics Service node. // markup not found, no include::{specDir}paths/restart_node/operation-description-end.adoc[opts=optional] + + +[#restart_node-produces] +.Produces +* application/json + :leveloffset: -1 @@ -1199,12 +1204,6 @@ Restarts the specified Analytics Service node. // markup not found, no include::{specDir}paths/restart_node/operation-parameters-after.adoc[opts=optional] -[#restart_node-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/restart_node/operation-responses-before.adoc[opts=optional] @@ -1340,6 +1339,12 @@ 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] + + +[#return_active_requests-produces] +.Produces +* application/json + :leveloffset: -1 @@ -1357,12 +1362,6 @@ Gets a list of the analytic requests that are running. // markup not found, no include::{specDir}paths/return_active_requests/operation-parameters-after.adoc[opts=optional] -[#return_active_requests-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/return_active_requests/operation-responses-before.adoc[opts=optional] @@ -1539,14 +1538,14 @@ An object containing a single links property. //end::desc-Ingestion[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *links* + _optional_ -a| +a¦ [markdown] -- @@ -1555,7 +1554,7 @@ An array of objects, each giving information about a single linked Analytics sco [%hardbreaks] {blank} -a| <> +a¦ <> array |=== @@ -1595,14 +1594,14 @@ endif::collapse-models[] //tag::IngestionLink[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *name* + _optional_ -a| +a¦ [markdown] -- @@ -1610,15 +1609,15 @@ The name of the link. -- [%hardbreaks] -*Example:* `pass:c["Local"]` +*Example:* `+++"Local"+++` {blank} -a| String +a¦ String -a| +a¦ *scope* + _optional_ -a| +a¦ [markdown] -- @@ -1626,15 +1625,15 @@ The name of the Analytics scope. -- [%hardbreaks] -*Example:* `pass:c["travel-sample/inventory"]` +*Example:* `+++"travel-sample/inventory"+++` {blank} -a| String +a¦ String -a| +a¦ *status* + _optional_ -a| +a¦ [markdown] -- @@ -1643,15 +1642,15 @@ The status of the Analytics scope. [%hardbreaks] *Values:* `"healthy"`, `"stopped"`, `"unhealthy"`, `"suspended"` -*Example:* `pass:c["healthy"]` +*Example:* `+++"healthy"+++` {blank} -a| String +a¦ String -a| +a¦ *state* + _optional_ -a| +a¦ [markdown] -- @@ -1663,7 +1662,7 @@ Analytics collections which have the same ingestion state within this Analytics [%hardbreaks] {blank} -a| <> +a¦ <> array |=== @@ -1703,14 +1702,14 @@ endif::collapse-models[] //tag::IngestionLinkState[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *timestamp* + _required_ -a| +a¦ [markdown] -- @@ -1720,13 +1719,13 @@ The time since epoch that this sample was calculated, in milliseconds. [%hardbreaks] *Example:* `1631273689161` {blank} -a| Integer +a¦ Integer -a| +a¦ *progress* + _required_ -a| +a¦ [markdown] -- @@ -1738,13 +1737,13 @@ The percentage (fraction from 0 to 1) of ingestion progress at the current time. *Maximum:* `1` *Example:* `0` {blank} -a| Double (double) +a¦ Double (double) -a| +a¦ *timeLag* + _optional_ -a| +a¦ [markdown] -- @@ -1755,13 +1754,13 @@ The estimated time that the ingestion lags behind the Data service, in milliseco [%hardbreaks] *Example:* `9744` {blank} -a| Integer +a¦ Integer -a| +a¦ *itemsProcessed* + _optional_ -a| +a¦ [markdown] -- @@ -1774,13 +1773,13 @@ Note that this value is reset on connect, so it may appear to get smaller. [%hardbreaks] *Example:* `12301` {blank} -a| Integer +a¦ Integer -a| +a¦ *seqnoAdvances* + _optional_ -a| +a¦ [markdown] -- @@ -1791,13 +1790,13 @@ The change in sequence number (seqno) since last connect. Only displayed for Ana [%hardbreaks] *Example:* `61` {blank} -a| Integer +a¦ Integer -a| +a¦ *scopes* + _required_ -a| +a¦ [markdown] -- @@ -1806,7 +1805,7 @@ An array of objects, each one giving information about a single Analytics scope. [%hardbreaks] {blank} -a| <> +a¦ <> array |=== @@ -1846,14 +1845,14 @@ endif::collapse-models[] //tag::IngestionLinkStateScope[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *name* + _required_ -a| +a¦ [markdown] -- @@ -1861,15 +1860,15 @@ The name of the Analytics scope. -- [%hardbreaks] -*Example:* `pass:c["travel-sample/inventory"]` +*Example:* `+++"travel-sample/inventory"+++` {blank} -a| String +a¦ String -a| +a¦ *collections* + _required_ -a| +a¦ [markdown] -- @@ -1878,7 +1877,7 @@ An array of objects, each one giving information about a single Analytics collec [%hardbreaks] {blank} -a| <> +a¦ <> array |=== @@ -1918,14 +1917,14 @@ endif::collapse-models[] //tag::IngestionLinkStateScopeColl[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *name* + _required_ -a| +a¦ [markdown] -- @@ -1933,9 +1932,9 @@ The name of the Analytics collection. -- [%hardbreaks] -*Example:* `pass:c["route"]` +*Example:* `+++"route"+++` {blank} -a| String +a¦ String |=== @@ -1980,14 +1979,14 @@ An object containing one or more nested scope objects, one for each available An //end::desc-Mutations[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ _additional + property_ -a| +a¦ [markdown] -- @@ -1996,7 +1995,7 @@ include::index.adoc[tag=desc-MutationsColl, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ <> |=== @@ -2044,14 +2043,14 @@ The name of the object is the name of the Analytics scope, in display form. For //end::desc-MutationsColl[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ _additional + property_ -a| +a¦ [markdown] -- @@ -2061,7 +2060,7 @@ The number of mutations in the DCP queue that have not yet been ingested. The na [%hardbreaks] {blank} -a| Integer +a¦ Integer |=== @@ -2106,14 +2105,14 @@ An object giving information about an Analytics service request. //end::desc-Request[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *cancellable* + _optional_ -a| +a¦ [markdown] -- @@ -2122,13 +2121,13 @@ Whether this request can be cancelled. [%hardbreaks] {blank} -a| Boolean +a¦ Boolean -a| +a¦ *clientContextID* + _optional_ -a| +a¦ [markdown] -- @@ -2136,15 +2135,15 @@ A context ID for debugging purposes. -- [%hardbreaks] -*Example:* `pass:c["28379d60-7139-44d6-b57a-95935540b586"]` +*Example:* `+++"28379d60-7139-44d6-b57a-95935540b586"+++` {blank} -a| String +a¦ String -a| +a¦ *elapsedTime* + _optional_ -a| +a¦ [markdown] -- @@ -2154,13 +2153,13 @@ How long the request has been running in seconds. [%hardbreaks] *Example:* `0.126` {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *jobCreateTime* + _optional_ -a| +a¦ [markdown] -- @@ -2168,15 +2167,15 @@ The date and time when the request's job was created. -- [%hardbreaks] -*Example:* `pass:c["2024-05-28T19:47:02.512"]` +*Example:* `+++"2024-05-28T19:47:02.512"+++` {blank} -a| String +a¦ String -a| +a¦ *jobId* + _optional_ -a| +a¦ [markdown] -- @@ -2185,15 +2184,15 @@ The request's job ID. This value can be null if request did not run (for example -- [%hardbreaks] -*Example:* `pass:c["JID:0.14"]` +*Example:* `+++"JID:0.14"+++` {blank} -a| String +a¦ String -a| +a¦ *jobQueueTime* + _optional_ -a| +a¦ [markdown] -- @@ -2203,13 +2202,13 @@ How long the request's job has been in the queue waiting to run in seconds. [%hardbreaks] *Example:* `0` {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *jobRequiredCPUs* + _optional_ -a| +a¦ [markdown] -- @@ -2219,13 +2218,13 @@ The number of CPU cores required to run this request. [%hardbreaks] *Example:* `1` {blank} -a| Integer +a¦ Integer -a| +a¦ *jobRequiredMemory* + _optional_ -a| +a¦ [markdown] -- @@ -2236,13 +2235,13 @@ The bytes of RAM being used to process this request. [%hardbreaks] *Example:* `34013184` {blank} -a| Integer +a¦ Integer -a| +a¦ *jobStartTime* + _optional_ -a| +a¦ [markdown] -- @@ -2250,15 +2249,15 @@ The date and time the request's job began running. -- [%hardbreaks] -*Example:* `pass:c["2024-05-28T19:47:02.514"]` +*Example:* `+++"2024-05-28T19:47:02.514"+++` {blank} -a| String +a¦ String -a| +a¦ *jobStatus* + _optional_ -a| +a¦ [markdown] -- @@ -2267,15 +2266,15 @@ The state of the request's job. [%hardbreaks] *Values:* `"PENDING"`, `"RUNNING"`, `"TERMINATED"`, `"FAILURE"`, `"FAILURE_BEFORE_EXECUTION"`, `"null"` -*Example:* `pass:c["RUNNING"]` +*Example:* `+++"RUNNING"+++` {blank} -a| String +a¦ String -a| +a¦ *plan* + _optional_ -a| +a¦ [markdown] -- @@ -2284,13 +2283,13 @@ The query plan for this request. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *node* + _optional_ -a| +a¦ [markdown] -- @@ -2298,15 +2297,15 @@ The Analytics node that received the request. -- [%hardbreaks] -*Example:* `pass:c["172.20.0.2:8095"]` +*Example:* `+++"172.20.0.2:8095"+++` {blank} -a| String +a¦ String -a| +a¦ *remoteAddr* + _optional_ -a| +a¦ [markdown] -- @@ -2314,15 +2313,15 @@ The network address and port of the client that made the request. -- [%hardbreaks] -*Example:* `pass:c["172.20.0.123:53612"]` +*Example:* `+++"172.20.0.123:53612"+++` {blank} -a| String +a¦ String -a| +a¦ *requestTime* + _optional_ -a| +a¦ [markdown] -- @@ -2330,15 +2329,15 @@ The date and time the request was received. -- [%hardbreaks] -*Example:* `pass:c["2024-05-28T19:44:07.730"]` +*Example:* `+++"2024-05-28T19:44:07.730"+++` {blank} -a| String +a¦ String -a| +a¦ *scanConsistency* + _optional_ -a| +a¦ [markdown] -- @@ -2346,15 +2345,15 @@ The Scan Consistency setting used for the request's query. -- [%hardbreaks] -*Example:* `pass:c["not_bounded"]` +*Example:* `+++"not_bounded"+++` {blank} -a| String +a¦ String -a| +a¦ *state* + _optional_ -a| +a¦ [markdown] -- @@ -2363,15 +2362,15 @@ The state of the request. [%hardbreaks] *Values:* `"received"`, `"running"`, `"cancelled"`, `"completed"` -*Example:* `pass:c["running"]` +*Example:* `+++"running"+++` {blank} -a| String +a¦ String -a| +a¦ *statement* + _optional_ -a| +a¦ [markdown] -- @@ -2379,15 +2378,15 @@ The SQL++ query statement being run by the request. -- [%hardbreaks] -*Example:* `pass:c["select count(*) from hotel_endorsement_view;"]` +*Example:* `+++"select count(*) from hotel_endorsement_view;"+++` {blank} -a| String +a¦ String -a| +a¦ *userAgent* + _optional_ -a| +a¦ [markdown] -- @@ -2395,15 +2394,15 @@ The user agent string of the browser that made the request. -- [%hardbreaks] -*Example:* `pass:c["Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:126.0) Gecko/20100101 Firefox/126.0"]` +*Example:* `+++"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:126.0) Gecko/20100101 Firefox/126.0"+++` {blank} -a| String +a¦ String -a| +a¦ *users* + _optional_ -a| +a¦ [markdown] -- @@ -2411,15 +2410,15 @@ The user who made the request. -- [%hardbreaks] -*Example:* `pass:c["Administrator"]` +*Example:* `+++"Administrator"+++` {blank} -a| String +a¦ String -a| +a¦ *uuid* + _optional_ -a| +a¦ [markdown] -- @@ -2427,9 +2426,9 @@ The unique identifier for this request. -- [%hardbreaks] -*Example:* `pass:c["91f60338-a3e0-4163-9287-5e723fda29ef"]` +*Example:* `+++"91f60338-a3e0-4163-9287-5e723fda29ef"+++` {blank} -a| String +a¦ String |=== @@ -2474,14 +2473,14 @@ An object giving information about the status of the Analytics service. //end::desc-Status[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *authorizedNodes* + _optional_ -a| +a¦ [markdown] -- @@ -2491,13 +2490,13 @@ An array of strings, each of which is the ID of an authorized Analytics node. [%hardbreaks] *Example:* `["86586a966202b5aa4aed31633f330aba","948fb3af810a9b7bc6c76e2a69ba35d9"]` {blank} -a| String +a¦ String array -a| +a¦ *ccNodeId* + _optional_ -a| +a¦ [markdown] -- @@ -2505,15 +2504,15 @@ The ID of the cluster controller node. -- [%hardbreaks] -*Example:* `pass:c["86586a966202b5aa4aed31633f330aba"]` +*Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} -a| String +a¦ String -a| +a¦ *nodeConfigUri* + _optional_ -a| +a¦ [markdown] -- @@ -2521,15 +2520,15 @@ The path of the Analytics Node Configuration REST API. -- [%hardbreaks] -*Example:* `pass:c["/analytics/config/node"]` +*Example:* `+++"/analytics/config/node"+++` {blank} -a| String +a¦ String -a| +a¦ *nodeDiagnosticsUri* + _optional_ -a| +a¦ [markdown] -- @@ -2538,15 +2537,15 @@ The path of the Analytics Node Diagnostics REST API. For internal use only. -- [%hardbreaks] -*Example:* `pass:c["/analytics/node/diagnostics"]` +*Example:* `+++"/analytics/node/diagnostics"+++` {blank} -a| String +a¦ String -a| +a¦ *nodeRestartUri* + _optional_ -a| +a¦ [markdown] -- @@ -2554,15 +2553,15 @@ The path of the Analytics Node Restart REST API. -- [%hardbreaks] -*Example:* `pass:c["/analytics/node/restart"]` +*Example:* `+++"/analytics/node/restart"+++` {blank} -a| String +a¦ String -a| +a¦ *nodeServiceUri* + _optional_ -a| +a¦ [markdown] -- @@ -2570,15 +2569,15 @@ The path of the Analytics Query Service REST API. -- [%hardbreaks] -*Example:* `pass:c["/analytics/service"]` +*Example:* `+++"/analytics/service"+++` {blank} -a| String +a¦ String -a| +a¦ *serviceConfigUri* + _optional_ -a| +a¦ [markdown] -- @@ -2586,15 +2585,15 @@ The path of the Analytics Service Configuration REST API. -- [%hardbreaks] -*Example:* `pass:c["/analytics/config/service"]` +*Example:* `+++"/analytics/config/service"+++` {blank} -a| String +a¦ String -a| +a¦ *serviceDiagnosticsUri* + _optional_ -a| +a¦ [markdown] -- @@ -2603,15 +2602,15 @@ The full URI of the Analytics Service Diagnostics REST API. For internal use onl -- [%hardbreaks] -*Example:* `pass:c["http://localhost:8095/analytics/cluster/diagnostics"]` +*Example:* `+++"http://localhost:8095/analytics/cluster/diagnostics"+++` {blank} -a| String +a¦ String -a| +a¦ *serviceRestartUri* + _optional_ -a| +a¦ [markdown] -- @@ -2619,15 +2618,15 @@ The full URI of the Analytics Cluster Restart REST API. -- [%hardbreaks] -*Example:* `pass:c["http://localhost:8095/analytics/cluster/restart"]` +*Example:* `+++"http://localhost:8095/analytics/cluster/restart"+++` {blank} -a| String +a¦ String -a| +a¦ *state* + _optional_ -a| +a¦ [markdown] -- @@ -2636,15 +2635,15 @@ The state of the Analytics Service. [%hardbreaks] *Values:* `"ACTIVE"`, `"REBALANCE_REQUIRED"`, `"UNUSABLE"`, `"SHUTTING_DOWN"` -*Example:* `pass:c["ACTIVE"]` +*Example:* `+++"ACTIVE"+++` {blank} -a| String +a¦ String -a| +a¦ *nodes* + _optional_ -a| +a¦ [markdown] -- @@ -2653,13 +2652,13 @@ An array of objects, each giving information about one Analytics node. [%hardbreaks] {blank} -a| <> +a¦ <> array -a| +a¦ *partitions* + _optional_ -a| +a¦ [markdown] -- @@ -2668,13 +2667,13 @@ An array of objects, each giving information about one Analytics partition. [%hardbreaks] {blank} -a| <> +a¦ <> array -a| +a¦ *partitionsTopology* + _optional_ -a| +a¦ [markdown] -- @@ -2683,7 +2682,7 @@ include::index.adoc[tag=desc-StatusTopology, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ <> |=== @@ -2723,14 +2722,14 @@ endif::collapse-models[] //tag::StatusNodes[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *apiBase* + _optional_ -a| +a¦ [markdown] -- @@ -2738,15 +2737,15 @@ The URI scheme, host, and port for HTTP access to Analytics REST APIs on this no -- [%hardbreaks] -*Example:* `pass:c["http://192.168.8.101:8095"]` +*Example:* `+++"http://192.168.8.101:8095"+++` {blank} -a| String +a¦ String -a| +a¦ *apiBaseHttps* + _optional_ -a| +a¦ [markdown] -- @@ -2754,15 +2753,15 @@ The URI scheme, host, and port for secure HTTPS access to Analytics REST APIs on -- [%hardbreaks] -*Example:* `pass:c["https://192.168.8.101:18095"]` +*Example:* `+++"https://192.168.8.101:18095"+++` {blank} -a| String +a¦ String -a| +a¦ *nodeId* + _optional_ -a| +a¦ [markdown] -- @@ -2770,15 +2769,15 @@ The ID of the node. -- [%hardbreaks] -*Example:* `pass:c["86586a966202b5aa4aed31633f330aba"]` +*Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} -a| String +a¦ String -a| +a¦ *nodeName* + _optional_ -a| +a¦ [markdown] -- @@ -2786,9 +2785,9 @@ The name or IP address of the node, including the cluster administration port. -- [%hardbreaks] -*Example:* `pass:c["192.168.8.101:8091"]` +*Example:* `+++"192.168.8.101:8091"+++` {blank} -a| String +a¦ String |=== @@ -2828,14 +2827,14 @@ endif::collapse-models[] //tag::StatusPartitions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *active* + _optional_ -a| +a¦ [markdown] -- @@ -2845,13 +2844,13 @@ Indicates whether this partition is active. [%hardbreaks] *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *activeNodeId* + _optional_ -a| +a¦ [markdown] -- @@ -2859,15 +2858,15 @@ The ID of the node where this partition is currently active. -- [%hardbreaks] -*Example:* `pass:c["86586a966202b5aa4aed31633f330aba"]` +*Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} -a| String +a¦ String -a| +a¦ *iodeviceNum* + _optional_ -a| +a¦ [markdown] -- @@ -2877,13 +2876,13 @@ The number of the IO Device where this partition is located. [%hardbreaks] *Example:* `0` {blank} -a| Integer +a¦ Integer -a| +a¦ *nodeId* + _optional_ -a| +a¦ [markdown] -- @@ -2891,15 +2890,15 @@ The ID of the node where this partition originated. -- [%hardbreaks] -*Example:* `pass:c["86586a966202b5aa4aed31633f330aba"]` +*Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} -a| String +a¦ String -a| +a¦ *partitionId* + _optional_ -a| +a¦ [markdown] -- @@ -2909,13 +2908,13 @@ The ID of this partition. [%hardbreaks] *Example:* `0` {blank} -a| Integer +a¦ Integer -a| +a¦ *path* + _optional_ -a| +a¦ [markdown] -- @@ -2923,15 +2922,15 @@ The path of the IO Device where this partition is located. -- [%hardbreaks] -*Example:* `pass:c["/data/@analytics/v_iodevice_0"]` +*Example:* `+++"/data/@analytics/v_iodevice_0"+++` {blank} -a| String +a¦ String -a| +a¦ *pendingActivation* + _optional_ -a| +a¦ [markdown] -- @@ -2941,7 +2940,7 @@ Indicates whether this partition is waiting to become active. [%hardbreaks] *Example:* `false` {blank} -a| Boolean +a¦ Boolean |=== @@ -2986,14 +2985,14 @@ An object giving information about the partition topology. //end::desc-StatusTopology[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *balanced* + _optional_ -a| +a¦ [markdown] -- @@ -3003,13 +3002,13 @@ Indicates whether the Analytics nodes are balanced. [%hardbreaks] *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *ccNodeId* + _optional_ -a| +a¦ [markdown] -- @@ -3017,15 +3016,15 @@ The ID of the cluster controller node. -- [%hardbreaks] -*Example:* `pass:c["86586a966202b5aa4aed31633f330aba"]` +*Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} -a| String +a¦ String -a| +a¦ *metadataPartition* + _optional_ -a| +a¦ [markdown] -- @@ -3035,13 +3034,13 @@ The ID of the metadata partition. [%hardbreaks] *Example:* `-1` {blank} -a| Integer +a¦ Integer -a| +a¦ *numReplicas* + _optional_ -a| +a¦ [markdown] -- @@ -3051,13 +3050,13 @@ The number of Analytics replicas. [%hardbreaks] *Example:* `1` {blank} -a| Integer +a¦ Integer -a| +a¦ *revision* + _optional_ -a| +a¦ [markdown] -- @@ -3067,13 +3066,13 @@ The revision number of the partition topology. [%hardbreaks] *Example:* `1` {blank} -a| Integer +a¦ Integer -a| +a¦ *version* + _optional_ -a| +a¦ [markdown] -- @@ -3083,13 +3082,13 @@ The version number of the partition topology. [%hardbreaks] *Example:* `1` {blank} -a| Integer +a¦ Integer -a| +a¦ *partitions* + _optional_ -a| +a¦ [markdown] -- @@ -3098,7 +3097,7 @@ An array of objects, each giving information about the state of one Analytics pa [%hardbreaks] {blank} -a| <> +a¦ <> array |=== @@ -3138,14 +3137,14 @@ endif::collapse-models[] //tag::StatusTopologyState[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *id* + _optional_ -a| +a¦ [markdown] -- @@ -3155,13 +3154,13 @@ The partition ID. [%hardbreaks] *Example:* `0` {blank} -a| Integer +a¦ Integer -a| +a¦ *master* + _optional_ -a| +a¦ [markdown] -- @@ -3169,15 +3168,15 @@ The ID of the node where the partition is currently active. -- [%hardbreaks] -*Example:* `pass:c["86586a966202b5aa4aed31633f330aba"]` +*Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} -a| String +a¦ String -a| +a¦ *origin* + _optional_ -a| +a¦ [markdown] -- @@ -3185,15 +3184,15 @@ The ID of the node where the partition originated. -- [%hardbreaks] -*Example:* `pass:c["86586a966202b5aa4aed31633f330aba"]` +*Example:* `+++"86586a966202b5aa4aed31633f330aba"+++` {blank} -a| String +a¦ String -a| +a¦ *replicas* + _optional_ -a| +a¦ [markdown] -- @@ -3202,7 +3201,7 @@ An array of objects, each giving information about the state of one Analytics re [%hardbreaks] {blank} -a| <> +a¦ <> array |=== @@ -3242,14 +3241,14 @@ endif::collapse-models[] //tag::StatusTopologyStateReplicas[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *location* + _optional_ -a| +a¦ [markdown] -- @@ -3257,15 +3256,15 @@ The name or IP address of the node where this replica is located, including the -- [%hardbreaks] -*Example:* `pass:c["192.168.8.102:9120"]` +*Example:* `+++"192.168.8.102:9120"+++` {blank} -a| String +a¦ String -a| +a¦ *nodeId* + _optional_ -a| +a¦ [markdown] -- @@ -3273,15 +3272,15 @@ The ID of the node where this replica is located. -- [%hardbreaks] -*Example:* `pass:c["948fb3af810a9b7bc6c76e2a69ba35d9"]` +*Example:* `+++"948fb3af810a9b7bc6c76e2a69ba35d9"+++` {blank} -a| String +a¦ String -a| +a¦ *status* + _optional_ -a| +a¦ [markdown] -- @@ -3290,15 +3289,15 @@ The synchronization status of the replica. [%hardbreaks] *Values:* `"IN_SYNC"`, `"CATCHING_UP"`, `"DISCONNECTED"` -*Example:* `pass:c["IN_SYNC"]` +*Example:* `+++"IN_SYNC"+++` {blank} -a| String +a¦ String -a| +a¦ *syncProgress* + _optional_ -a| +a¦ [markdown] -- @@ -3310,7 +3309,7 @@ The percentage (fraction from 0 to 1) of synchronization progress for this repli *Maximum:* `1` *Example:* `1` {blank} -a| Double (double) +a¦ Double (double) |=== @@ -3468,3 +3467,4 @@ include::{specDir}security/document-end.adoc[opts=optional] // markup not found, no include::{specDir}security/document-after.adoc[opts=optional] + diff --git a/docs/modules/analytics-rest-config/pages/index.adoc b/docs/modules/analytics-rest-config/pages/index.adoc index 35dad25a..cb611b7e 100644 --- a/docs/modules/analytics-rest-config/pages/index.adoc +++ b/docs/modules/analytics-rest-config/pages/index.adoc @@ -59,7 +59,7 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* @@ -70,7 +70,7 @@ The host name or IP address of a node running the Analytics service. [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* @@ -81,7 +81,7 @@ The Analytics service REST port. Use `18095` for secure access. [%hardbreaks] *Values:* `8095`, `18095` -*Example:* `pass:c[8095]` +*Example:* `+++8095+++` // end |=== @@ -175,6 +175,12 @@ 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] + + +[#get_node-produces] +.Produces +* application/json + :leveloffset: -1 @@ -192,12 +198,6 @@ Views node-specific parameters, which apply to the node receiving the request. // markup not found, no include::{specDir}paths/get_node/operation-parameters-after.adoc[opts=optional] -[#get_node-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_node/operation-responses-before.adoc[opts=optional] @@ -327,6 +327,12 @@ Views service-level parameters, which apply to all nodes running the Analytics s // markup not found, no include::{specDir}paths/get_service/operation-description-end.adoc[opts=optional] + + +[#get_service-produces] +.Produces +* application/json + :leveloffset: -1 @@ -344,12 +350,6 @@ Views service-level parameters, which apply to all nodes running the Analytics s // markup not found, no include::{specDir}paths/get_service/operation-parameters-after.adoc[opts=optional] -[#get_service-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_service/operation-responses-before.adoc[opts=optional] @@ -486,6 +486,16 @@ or restart the Analytics cluster using the [Cluster Restart API][2]. // markup not found, no include::{specDir}paths/put_node/operation-description-end.adoc[opts=optional] + +[#put_node-consumes] +.Consumes +* application/json +* application/x-www-form-urlencoded + +[#put_node-produces] +.Produces +* application/json + :leveloffset: -1 @@ -512,13 +522,13 @@ include::{specDir}paths/put_node/operation-parameters-begin.adoc[opts=optional] .Body Parameter {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *Body* + +a¦ *Body* + _optional_ -a| +a¦ [markdown] @@ -529,7 +539,7 @@ An object specifying one or more of the configurable node-level parameters on th [%hardbreaks] {blank} -a| <> +a¦ <> @@ -546,17 +556,6 @@ a| <> // markup not found, no include::{specDir}paths/put_node/operation-parameters-after.adoc[opts=optional] -[#put_node-produces] -= Produces - -* application/json - -[#put_node-consumes] -= Consumes - -* application/json -* application/x-www-form-urlencoded - // markup not found, no include::{specDir}paths/put_node/operation-responses-before.adoc[opts=optional] @@ -697,6 +696,16 @@ you must restart the Analytics cluster using the [Cluster Restart API][1]. // markup not found, no include::{specDir}paths/put_service/operation-description-end.adoc[opts=optional] + +[#put_service-consumes] +.Consumes +* application/json +* application/x-www-form-urlencoded + +[#put_service-produces] +.Produces +* application/json + :leveloffset: -1 @@ -723,13 +732,13 @@ include::{specDir}paths/put_service/operation-parameters-begin.adoc[opts=optiona .Body Parameter {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *Body* + +a¦ *Body* + _optional_ -a| +a¦ [markdown] @@ -740,7 +749,7 @@ An object specifying one or more of the configurable service-level parameters. [%hardbreaks] {blank} -a| <> +a¦ <> @@ -757,17 +766,6 @@ a| <> // markup not found, no include::{specDir}paths/put_service/operation-parameters-after.adoc[opts=optional] -[#put_service-produces] -= Produces - -* application/json - -[#put_service-consumes] -= Consumes - -* application/json -* application/x-www-form-urlencoded - // markup not found, no include::{specDir}paths/put_service/operation-responses-before.adoc[opts=optional] @@ -928,14 +926,14 @@ endif::collapse-models[] //tag::Errors[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *error* + _required_ -a| +a¦ [markdown] -- @@ -944,7 +942,7 @@ An error message. [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -984,14 +982,14 @@ endif::collapse-models[] //tag::Node[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *jvmArgs* + _optional_ -a| +a¦ [markdown] -- @@ -1011,13 +1009,13 @@ To pass arguments opaquely, you may use [Java command-line argument files][3]. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *storageBuffercacheSize* + _optional_ -a| +a¦ [markdown] -- @@ -1029,13 +1027,13 @@ The default is 1/4 of the allocated Analytics Service memory. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *storageMemorycomponentGlobalbudget* + _optional_ -a| +a¦ [markdown] -- @@ -1047,7 +1045,7 @@ The default is 1/4 of the allocated Analytics Service memory. [%hardbreaks] {blank} -a| Integer +a¦ Integer |=== @@ -1087,14 +1085,14 @@ endif::collapse-models[] //tag::Service[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *activeMemoryGlobalBudget* + _optional_ -a| +a¦ [markdown] -- @@ -1104,13 +1102,13 @@ The memory budget (in bytes) for the active runtime. [%hardbreaks] *Default:* `67108864` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *activeStopTimeout* + _optional_ -a| +a¦ [markdown] -- @@ -1120,13 +1118,13 @@ The maximum time (in seconds) to wait for a graceful stop of an active runtime. [%hardbreaks] *Default:* `3600` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *activeSuspendTimeout* + _optional_ -a| +a¦ [markdown] -- @@ -1136,13 +1134,13 @@ The maximum time (in seconds) to wait for a graceful suspend of an active runtim [%hardbreaks] *Default:* `3600` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *analyticsBroadcastDcpStateMutationCount* + _optional_ -a| +a¦ [markdown] -- @@ -1152,13 +1150,13 @@ The number of processed mutations after which the DCP state is broadcast to stor [%hardbreaks] *Default:* `10000` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *analyticsHttpRequestQueueSize* + _optional_ -a| +a¦ [markdown] -- @@ -1168,13 +1166,13 @@ The maximum number of HTTP requests to queue pending ability to execute. [%hardbreaks] *Default:* `256` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *analyticsHttpThreadCount* + _optional_ -a| +a¦ [markdown] -- @@ -1184,13 +1182,13 @@ The number of threads to service HTTP requests. [%hardbreaks] *Default:* `16` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *bindAddress* + _optional_ -a| +a¦ [markdown] -- @@ -1199,13 +1197,13 @@ The bind address to use. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *bindToHost* + _optional_ -a| +a¦ [markdown] -- @@ -1215,13 +1213,13 @@ Bind to configured hostname instead of wildcard address. [%hardbreaks] *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *clusterConnectRetries* + _optional_ -a| +a¦ [markdown] -- @@ -1231,13 +1229,13 @@ Number of attempts to contact CC before giving up. [%hardbreaks] *Default:* `5` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *collectDcpStateFromNodesTimeout* + _optional_ -a| +a¦ [markdown] -- @@ -1247,13 +1245,13 @@ The maximum time to wait to collect DCP state from all nodes in seconds. [%hardbreaks] *Default:* `600` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *compilerFramesize* + _optional_ -a| +a¦ [markdown] -- @@ -1263,13 +1261,13 @@ The page size (in bytes) for computation. [%hardbreaks] *Default:* `32768` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *compilerGroupmemory* + _optional_ -a| +a¦ [markdown] -- @@ -1279,13 +1277,13 @@ The memory budget (in bytes) for a group by operator instance in a partition. [%hardbreaks] *Default:* `33554432` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *compilerJoinmemory* + _optional_ -a| +a¦ [markdown] -- @@ -1295,13 +1293,13 @@ The memory budget (in bytes) for a join operator instance in a partition. [%hardbreaks] *Default:* `33554432` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *compilerParallelism* + _optional_ -a| +a¦ [markdown] -- @@ -1312,13 +1310,13 @@ The degree of parallelism for query execution. Zero means to use the storage par [%hardbreaks] *Default:* `0` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *compilerSortParallel* + _optional_ -a| +a¦ [markdown] -- @@ -1328,13 +1326,13 @@ Enables or disables full parallel sort. [%hardbreaks] *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *compilerSortmemory* + _optional_ -a| +a¦ [markdown] -- @@ -1344,13 +1342,13 @@ The memory budget (in bytes) for a sort operator instance in a partition. [%hardbreaks] *Default:* `33554432` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *compilerWindowmemory* + _optional_ -a| +a¦ [markdown] -- @@ -1360,13 +1358,13 @@ The memory budget (in bytes) for a window operator instance in a partition. [%hardbreaks] *Default:* `33554432` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *coresMultiplier* + _optional_ -a| +a¦ [markdown] -- @@ -1376,13 +1374,13 @@ The factor to multiply by the number of cores to determine maximum query concurr [%hardbreaks] *Default:* `3` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *dcpBufferAckWatermark* + _optional_ -a| +a¦ [markdown] -- @@ -1395,13 +1393,13 @@ The percentage of DCP connection buffer size at which to acknowledge bytes consu *Minimum:* `1` *Maximum:* `100` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *dcpChannelReconnectRemoteIdleSeconds* + _optional_ -a| +a¦ [markdown] -- @@ -1412,13 +1410,13 @@ Reconnect remote DCP channels that are idle for the specified number of seconds [%hardbreaks] *Default:* `120` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *dcpConnectionBufferSize* + _optional_ -a| +a¦ [markdown] -- @@ -1430,13 +1428,13 @@ Otherwise, the default is 1% of the JVM maximum heap size divided by the number [%hardbreaks] {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *deadlockWatchdogHaltDelaySeconds* + _optional_ -a| +a¦ [markdown] -- @@ -1446,13 +1444,13 @@ The delay (in seconds) to wait for graceful shutdown due to deadlocked threads, [%hardbreaks] *Default:* `120` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *deadlockWatchdogPollSeconds* + _optional_ -a| +a¦ [markdown] -- @@ -1462,13 +1460,13 @@ The frequency (in seconds) to scan for deadlocked threads. [%hardbreaks] *Default:* `300` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *jobHistorySize* + _optional_ -a| +a¦ [markdown] -- @@ -1478,13 +1476,13 @@ Limits the number of historical jobs remembered by the system to the specified v [%hardbreaks] *Default:* `10` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *jobQueueCapacity* + _optional_ -a| +a¦ [markdown] -- @@ -1494,13 +1492,13 @@ The maximum number of jobs to queue before rejecting new jobs. [%hardbreaks] *Default:* `4096` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *jvmArgs* + _optional_ -a| +a¦ [markdown] -- @@ -1517,13 +1515,13 @@ To pass arguments opaquely, you may use [Java command-line argument files][3]. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *logLevel* + _optional_ -a| +a¦ [markdown] -- @@ -1531,15 +1529,15 @@ The logging level. -- [%hardbreaks] -*Default:* `pass:c["DEBUG"]` +*Default:* `+++"DEBUG"+++` {blank} -a| String +a¦ String -a| +a¦ *maxWebRequestSize* + _optional_ -a| +a¦ [markdown] -- @@ -1549,13 +1547,13 @@ The maximum accepted web request size in bytes. [%hardbreaks] *Default:* `52428800` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *netBufferCount* + _optional_ -a| +a¦ [markdown] -- @@ -1565,13 +1563,13 @@ Number of network buffers per input/output channel. [%hardbreaks] *Default:* `1` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *netThreadCount* + _optional_ -a| +a¦ [markdown] -- @@ -1581,13 +1579,13 @@ Number of threads to use for Network I/O. [%hardbreaks] *Default:* `1` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *rebalancePullDatasetSizeFrequency* + _optional_ -a| +a¦ [markdown] -- @@ -1597,13 +1595,13 @@ The frequency at which the Analytics collection size is pulled from nodes during [%hardbreaks] *Default:* `5` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *remoteLinkConnectTimeoutSeconds* + _optional_ -a| +a¦ [markdown] -- @@ -1614,13 +1612,13 @@ The maximum time (in seconds) to wait for a remote link connection to establish. [%hardbreaks] *Default:* `60` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *remoteLinkSocketTimeoutSeconds* + _optional_ -a| +a¦ [markdown] -- @@ -1631,13 +1629,13 @@ The maximum time (in seconds) to wait after establishing the connection for remo [%hardbreaks] *Default:* `60` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *requestsArchiveSize* + _optional_ -a| +a¦ [markdown] -- @@ -1647,13 +1645,13 @@ The maximum number of archived requests to maintain. [%hardbreaks] *Default:* `50` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *resultSweepThreshold* + _optional_ -a| +a¦ [markdown] -- @@ -1663,13 +1661,13 @@ The duration within which an instance of the result cleanup should be invoked in [%hardbreaks] *Default:* `60000` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *resultTtl* + _optional_ -a| +a¦ [markdown] -- @@ -1679,13 +1677,13 @@ Limits the amount of time results for asynchronous jobs should be retained by th [%hardbreaks] *Default:* `86400000` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *storageBuffercacheMaxopenfiles* + _optional_ -a| +a¦ [markdown] -- @@ -1695,13 +1693,13 @@ The maximum number of open files in the buffer cache. [%hardbreaks] *Default:* `2147483647` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *storageBuffercachePagesize* + _optional_ -a| +a¦ [markdown] -- @@ -1711,13 +1709,13 @@ The page size in bytes for pages in the buffer cache. [%hardbreaks] *Default:* `131072` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *storageCompressionBlock* + _optional_ -a| +a¦ [markdown] -- @@ -1725,15 +1723,15 @@ The default compression scheme for the storage. -- [%hardbreaks] -*Default:* `pass:c["snappy"]` +*Default:* `+++"snappy"+++` {blank} -a| String +a¦ String -a| +a¦ *storageMemorycomponentNumcomponents* + _optional_ -a| +a¦ [markdown] -- @@ -1743,13 +1741,13 @@ The number of memory components to be used per LSM index. [%hardbreaks] *Default:* `2` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *storageMemorycomponentPagesize* + _optional_ -a| +a¦ [markdown] -- @@ -1759,13 +1757,13 @@ The page size in bytes for pages allocated to memory components. [%hardbreaks] *Default:* `131072` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *storageWriteRateLimit* + _optional_ -a| +a¦ [markdown] -- @@ -1776,13 +1774,13 @@ The maximum disk write rate for each storage partition in bytes per second. Disa [%hardbreaks] *Default:* `0` {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *threaddumpFrequencySeconds* + _optional_ -a| +a¦ [markdown] -- @@ -1792,13 +1790,13 @@ The frequency (in seconds) at which to log diagnostic thread dumps. [%hardbreaks] *Default:* `300` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *threaddumpLogLevel* + _optional_ -a| +a¦ [markdown] -- @@ -1806,15 +1804,15 @@ The log level at which to emit diagnostic thread dumps. -- [%hardbreaks] -*Default:* `pass:c["DEBUG"]` +*Default:* `+++"DEBUG"+++` {blank} -a| String +a¦ String -a| +a¦ *traceCategories* + _optional_ -a| +a¦ [markdown] -- @@ -1825,13 +1823,13 @@ Categories for tracing. The default is the empty array — no categories. [%hardbreaks] *Default:* `[]` {blank} -a| String +a¦ String array -a| +a¦ *txnDatasetCheckpointInterval* + _optional_ -a| +a¦ [markdown] -- @@ -1841,7 +1839,7 @@ The interval (in seconds) after which an Analytics collection is considered idle [%hardbreaks] *Default:* `3600` {blank} -a| Integer (int32) +a¦ Integer (int32) |=== @@ -1925,3 +1923,4 @@ include::{specDir}security/document-end.adoc[opts=optional] // markup not found, no include::{specDir}security/document-after.adoc[opts=optional] + diff --git a/docs/modules/analytics-rest-library/pages/index.adoc b/docs/modules/analytics-rest-library/pages/index.adoc index f43ef615..4a098278 100644 --- a/docs/modules/analytics-rest-library/pages/index.adoc +++ b/docs/modules/analytics-rest-library/pages/index.adoc @@ -59,7 +59,7 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* @@ -70,7 +70,7 @@ The host name or IP address of a node running the Analytics service. [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* @@ -81,7 +81,7 @@ The Analytics service REST port. Use `18095` for secure access. [%hardbreaks] *Values:* `8095`, `18095` -*Example:* `pass:c[8095]` +*Example:* `+++8095+++` // end |=== @@ -174,6 +174,12 @@ Deletes the specified library entirely. // markup not found, no include::{specDir}paths/delete_library/operation-description-end.adoc[opts=optional] + + +[#delete_library-produces] +.Produces +* application/json + :leveloffset: -1 @@ -196,13 +202,13 @@ Deletes the specified library entirely. .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *library* + +a¦ *library* + _required_ -a| +a¦ [markdown] @@ -213,13 +219,13 @@ The name of a library. [%hardbreaks] {blank} -a| String +a¦ String -a| *scope* + +a¦ *scope* + _required_ -a| +a¦ [markdown] @@ -233,7 +239,7 @@ The scope name may contain one or two identifiers, separated by a slash (/). You [%hardbreaks] {blank} -a| String +a¦ String @@ -254,12 +260,6 @@ a| String // markup not found, no include::{specDir}paths/delete_library/operation-parameters-after.adoc[opts=optional] -[#delete_library-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/delete_library/operation-responses-before.adoc[opts=optional] @@ -395,6 +395,12 @@ Returns all libraries and functions. // markup not found, no include::{specDir}paths/get_collection/operation-description-end.adoc[opts=optional] + + +[#get_collection-produces] +.Produces +* application/json + :leveloffset: -1 @@ -412,12 +418,6 @@ Returns all libraries and functions. // markup not found, no include::{specDir}paths/get_collection/operation-parameters-after.adoc[opts=optional] -[#get_collection-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_collection/operation-responses-before.adoc[opts=optional] @@ -554,6 +554,15 @@ Creates the specified library and its associated functions. If the specified lib include::{specDir}paths/post_library/operation-description-end.adoc[opts=optional] + +[#post_library-consumes] +.Consumes +* multipart/form-data + +[#post_library-produces] +.Produces +* application/json + :leveloffset: -1 @@ -576,13 +585,13 @@ include::{specDir}paths/post_library/operation-description-end.adoc[opts=optiona .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *library* + +a¦ *library* + _required_ -a| +a¦ [markdown] @@ -593,13 +602,13 @@ The name of a library. [%hardbreaks] {blank} -a| String +a¦ String -a| *scope* + +a¦ *scope* + _required_ -a| +a¦ [markdown] @@ -613,7 +622,7 @@ The scope name may contain one or two identifiers, separated by a slash (/). You [%hardbreaks] {blank} -a| String +a¦ String @@ -625,13 +634,13 @@ a| String .Form Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *data* + +a¦ *data* + _required_ -a| +a¦ [markdown] @@ -642,13 +651,13 @@ The library and all its dependencies, packaged by shiv. [%hardbreaks] {blank} -a| File (binary) +a¦ File (binary) -a| *type* + +a¦ *type* + _required_ -a| +a¦ [markdown] @@ -660,7 +669,7 @@ The language of the library. *Values:* `"python"` {blank} -a| String +a¦ String @@ -678,16 +687,6 @@ a| String // markup not found, no include::{specDir}paths/post_library/operation-parameters-after.adoc[opts=optional] -[#post_library-produces] -= Produces - -* application/json - -[#post_library-consumes] -= Consumes - -* multipart/form-data - // markup not found, no include::{specDir}paths/post_library/operation-responses-before.adoc[opts=optional] @@ -849,14 +848,14 @@ endif::collapse-models[] //tag::Errors[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *error* + _required_ -a| +a¦ [markdown] -- @@ -865,7 +864,7 @@ An error message. [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -905,14 +904,14 @@ endif::collapse-models[] //tag::Libraries[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *scope* + _optional_ -a| +a¦ [markdown] -- @@ -923,15 +922,15 @@ The scope name may contain one or two identifiers, separated by a slash (/). -- [%hardbreaks] -*Example:* `pass:c["travel-sample/inventory"]` +*Example:* `+++"travel-sample/inventory"+++` {blank} -a| String +a¦ String -a| +a¦ *hash_md5* + _optional_ -a| +a¦ [markdown] -- @@ -940,13 +939,13 @@ A MD5 hash of the library residing on the server. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *name* + _optional_ -a| +a¦ [markdown] -- @@ -954,9 +953,9 @@ The name of the library. -- [%hardbreaks] -*Example:* `pass:c["mylib"]` +*Example:* `+++"mylib"+++` {blank} -a| String +a¦ String |=== @@ -1072,3 +1071,4 @@ include::{specDir}security/document-end.adoc[opts=optional] // markup not found, no include::{specDir}security/document-after.adoc[opts=optional] + diff --git a/docs/modules/analytics-rest-links/pages/index.adoc b/docs/modules/analytics-rest-links/pages/index.adoc index 6deb775f..5712be75 100644 --- a/docs/modules/analytics-rest-links/pages/index.adoc +++ b/docs/modules/analytics-rest-links/pages/index.adoc @@ -58,7 +58,7 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* @@ -69,7 +69,7 @@ The host name or IP address of a node running the Analytics service. [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* @@ -80,7 +80,7 @@ The Analytics service REST port. Use `18095` for secure access. [%hardbreaks] *Values:* `8095`, `18095` -*Example:* `pass:c[8095]` +*Example:* `+++8095+++` // end |=== @@ -177,6 +177,15 @@ 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] + +[#delete_alt-consumes] +.Consumes +* application/x-www-form-urlencoded + +[#delete_alt-produces] +.Produces +* application/json + :leveloffset: -1 @@ -202,13 +211,13 @@ An alternative endpoint for [deleting a link](#delete_link), provided for backwa .Form Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *dataverse* + +a¦ *dataverse* + _required_ -a| +a¦ [markdown] @@ -219,13 +228,13 @@ The name of the Analytics scope containing the link. With this parameter, the s [%hardbreaks] {blank} -a| String +a¦ String -a| *name* + +a¦ *name* + _required_ -a| +a¦ [markdown] @@ -236,7 +245,7 @@ The name of the link. [%hardbreaks] {blank} -a| String +a¦ String @@ -254,16 +263,6 @@ a| String // markup not found, no include::{specDir}paths/delete_alt/operation-parameters-after.adoc[opts=optional] -[#delete_alt-produces] -= Produces - -* application/json - -[#delete_alt-consumes] -= Consumes - -* application/x-www-form-urlencoded - // markup not found, no include::{specDir}paths/delete_alt/operation-responses-before.adoc[opts=optional] @@ -400,6 +399,15 @@ An alternative endpoint for [creating a link](#post_link), provided for backward // markup not found, no include::{specDir}paths/post_alt/operation-description-end.adoc[opts=optional] + +[#post_alt-consumes] +.Consumes +* application/x-www-form-urlencoded + +[#post_alt-produces] +.Produces +* application/json + :leveloffset: -1 @@ -425,13 +433,13 @@ An alternative endpoint for [creating a link](#post_link), provided for backward .Form Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *dataverse* + +a¦ *dataverse* + _required_ -a| +a¦ [markdown] @@ -442,13 +450,13 @@ The name of the Analytics scope containing the link. With this parameter, the s [%hardbreaks] {blank} -a| String +a¦ String -a| *name* + +a¦ *name* + _required_ -a| +a¦ [markdown] @@ -459,13 +467,13 @@ The name of the link. [%hardbreaks] {blank} -a| String +a¦ String -a| *type* + +a¦ *type* + _required_ -a| +a¦ [markdown] @@ -478,13 +486,13 @@ include::index.adoc[tag=desc-CommonType, opts=optional] *Values:* `"couchbase"`, `"s3"`, `"azureblob"`, `"gcs"` {blank} -a| +a¦ include::index.adoc[tag=type-CommonType, opts=optional] -a| *hostname* + +a¦ *hostname* + _required_ -a| +a¦ [markdown] @@ -495,13 +503,13 @@ For Couchbase links only. The remote hostname. [%hardbreaks] {blank} -a| String +a¦ String -a| *username* + +a¦ *username* + _optional_ -a| +a¦ [markdown] @@ -512,13 +520,13 @@ For Couchbase links only. The remote username. Required for links with no encryp [%hardbreaks] {blank} -a| String +a¦ String -a| *password* + +a¦ *password* + _optional_ -a| +a¦ [markdown] @@ -529,13 +537,13 @@ For Couchbase links only. The remote password. Required for links with no encryp [%hardbreaks] {blank} -a| String +a¦ String -a| *encryption* + +a¦ *encryption* + _required_ -a| +a¦ [markdown] @@ -547,13 +555,13 @@ For Couchbase links only. The type of encryption used by the link. For details, *Values:* `"none"`, `"half"`, `"full"` {blank} -a| String +a¦ String -a| *certificate* + +a¦ *certificate* + _optional_ -a| +a¦ [markdown] @@ -564,13 +572,13 @@ For Couchbase links only. The content of the target cluster root certificate. Re [%hardbreaks] {blank} -a| String +a¦ String -a| *clientCertificate* + +a¦ *clientCertificate* + _optional_ -a| +a¦ [markdown] @@ -581,13 +589,13 @@ For Couchbase links, this is the content of the client certificate. Required for [%hardbreaks] {blank} -a| String +a¦ String -a| *clientKey* + +a¦ *clientKey* + _optional_ -a| +a¦ [markdown] @@ -598,13 +606,13 @@ For Couchbase links only. The content of the client key. Required for links with [%hardbreaks] {blank} -a| String +a¦ String -a| *accessKeyId* + +a¦ *accessKeyId* + _required_ -a| +a¦ [markdown] @@ -615,13 +623,13 @@ For S3 links only. The Amazon S3 access key ID. [%hardbreaks] {blank} -a| String +a¦ String -a| *secretAccessKey* + +a¦ *secretAccessKey* + _required_ -a| +a¦ [markdown] @@ -632,13 +640,13 @@ For S3 links only. The Amazon S3 secret access key. You should URL-encode this [%hardbreaks] {blank} -a| String +a¦ String -a| *sessionToken* + +a¦ *sessionToken* + _optional_ -a| +a¦ [markdown] @@ -649,13 +657,13 @@ For S3 links only. The Amazon S3 session token. Use this parameter if you want t [%hardbreaks] {blank} -a| String +a¦ String -a| *region* + +a¦ *region* + _required_ -a| +a¦ [markdown] @@ -666,13 +674,13 @@ For S3 links only. The Amazon S3 region. [%hardbreaks] {blank} -a| String +a¦ String -a| *serviceEndpoint* + +a¦ *serviceEndpoint* + _optional_ -a| +a¦ [markdown] @@ -683,13 +691,13 @@ For S3 links only. The Amazon S3 service endpoint. [%hardbreaks] {blank} -a| String +a¦ String -a| *endpoint* + +a¦ *endpoint* + _optional_ -a| +a¦ [markdown] @@ -700,13 +708,13 @@ For Azure Blob links and Google Cloud Storage links. The endpoint URI. Required [%hardbreaks] {blank} -a| String +a¦ String -a| *accountName* + +a¦ *accountName* + _optional_ -a| +a¦ [markdown] @@ -717,13 +725,13 @@ For Azure Blob links only. The account name. Used for shared key authentication. [%hardbreaks] {blank} -a| String +a¦ String -a| *accountKey* + +a¦ *accountKey* + _optional_ -a| +a¦ [markdown] @@ -734,13 +742,13 @@ For Azure Blob links only. The account key. Used for shared key authentication. [%hardbreaks] {blank} -a| String +a¦ String -a| *sharedAccessSignature* + +a¦ *sharedAccessSignature* + _optional_ -a| +a¦ [markdown] @@ -751,13 +759,13 @@ For Azure Blob links only. A token that can be used for authentication. Used for [%hardbreaks] {blank} -a| String +a¦ String -a| *managedIdentityId* + +a¦ *managedIdentityId* + _optional_ -a| +a¦ [markdown] @@ -768,13 +776,13 @@ For Azure Blob links only. The managed identity ID. Used for managed identity au [%hardbreaks] {blank} -a| String +a¦ String -a| *clientId* + +a¦ *clientId* + _optional_ -a| +a¦ [markdown] @@ -785,13 +793,13 @@ For Azure Blob links only. The client ID for the registered application. Used fo [%hardbreaks] {blank} -a| String +a¦ String -a| *tenantId* + +a¦ *tenantId* + _optional_ -a| +a¦ [markdown] @@ -802,13 +810,13 @@ For Azure Blob links only. The tenant ID where the registered application is cre [%hardbreaks] {blank} -a| String +a¦ String -a| *clientSecret* + +a¦ *clientSecret* + _optional_ -a| +a¦ [markdown] @@ -819,13 +827,13 @@ For Azure Blob links only. The client secret for the registered application. Use [%hardbreaks] {blank} -a| String +a¦ String -a| *clientCertificatePassword* + +a¦ *clientCertificatePassword* + _optional_ -a| +a¦ [markdown] @@ -836,13 +844,13 @@ For Azure Blob links only. The client certificate password for the registered ap [%hardbreaks] {blank} -a| String +a¦ String -a| *jsonCredentials* + +a¦ *jsonCredentials* + _optional_ -a| +a¦ [markdown] @@ -853,13 +861,13 @@ For Google Cloud Storage links only. The JSON credentials of the link. This par [%hardbreaks] {blank} -a| String +a¦ String -a| *applicationDefaultCredentials* + +a¦ *applicationDefaultCredentials* + _optional_ -a| +a¦ [markdown] @@ -871,7 +879,7 @@ For Google Cloud Storage links only. If present, indicates that the link should *Values:* `"true"` {blank} -a| String +a¦ String @@ -889,16 +897,6 @@ a| String // markup not found, no include::{specDir}paths/post_alt/operation-parameters-after.adoc[opts=optional] -[#post_alt-produces] -= Produces - -* application/json - -[#post_alt-consumes] -= Consumes - -* application/x-www-form-urlencoded - // markup not found, no include::{specDir}paths/post_alt/operation-responses-before.adoc[opts=optional] @@ -1036,6 +1034,15 @@ 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] + +[#put_alt-consumes] +.Consumes +* application/x-www-form-urlencoded + +[#put_alt-produces] +.Produces +* application/json + :leveloffset: -1 @@ -1061,13 +1068,13 @@ An alternative endpoint for [editing a link](#put_link), provided for backward c .Form Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *dataverse* + +a¦ *dataverse* + _required_ -a| +a¦ [markdown] @@ -1078,13 +1085,13 @@ The name of the Analytics scope containing the link. With this parameter, the s [%hardbreaks] {blank} -a| String +a¦ String -a| *name* + +a¦ *name* + _required_ -a| +a¦ [markdown] @@ -1095,13 +1102,13 @@ The name of the link. [%hardbreaks] {blank} -a| String +a¦ String -a| *type* + +a¦ *type* + _optional_ -a| +a¦ [markdown] @@ -1114,13 +1121,13 @@ include::index.adoc[tag=desc-CommonTypeEdit, opts=optional] *Values:* `"couchbase"`, `"s3"`, `"azureblob"`, `"gcs"` {blank} -a| +a¦ include::index.adoc[tag=type-CommonTypeEdit, opts=optional] -a| *hostname* + +a¦ *hostname* + _required_ -a| +a¦ [markdown] @@ -1131,13 +1138,13 @@ For Couchbase links only. The remote hostname. [%hardbreaks] {blank} -a| String +a¦ String -a| *username* + +a¦ *username* + _optional_ -a| +a¦ [markdown] @@ -1148,13 +1155,13 @@ For Couchbase links only. The remote username. Required for links with no encryp [%hardbreaks] {blank} -a| String +a¦ String -a| *password* + +a¦ *password* + _optional_ -a| +a¦ [markdown] @@ -1165,13 +1172,13 @@ For Couchbase links only. The remote password. Required for links with no encryp [%hardbreaks] {blank} -a| String +a¦ String -a| *encryption* + +a¦ *encryption* + _required_ -a| +a¦ [markdown] @@ -1183,13 +1190,13 @@ For Couchbase links only. The type of encryption used by the link. For details, *Values:* `"none"`, `"half"`, `"full"` {blank} -a| String +a¦ String -a| *certificate* + +a¦ *certificate* + _optional_ -a| +a¦ [markdown] @@ -1200,13 +1207,13 @@ For Couchbase links only. The content of the target cluster root certificate. Re [%hardbreaks] {blank} -a| String +a¦ String -a| *clientCertificate* + +a¦ *clientCertificate* + _optional_ -a| +a¦ [markdown] @@ -1217,13 +1224,13 @@ For Couchbase links, this is the content of the client certificate. Required for [%hardbreaks] {blank} -a| String +a¦ String -a| *clientKey* + +a¦ *clientKey* + _optional_ -a| +a¦ [markdown] @@ -1234,13 +1241,13 @@ For Couchbase links only. The content of the client key. Required for links with [%hardbreaks] {blank} -a| String +a¦ String -a| *accessKeyId* + +a¦ *accessKeyId* + _required_ -a| +a¦ [markdown] @@ -1251,13 +1258,13 @@ For S3 links only. The Amazon S3 access key ID. [%hardbreaks] {blank} -a| String +a¦ String -a| *secretAccessKey* + +a¦ *secretAccessKey* + _required_ -a| +a¦ [markdown] @@ -1268,13 +1275,13 @@ For S3 links only. The Amazon S3 secret access key. You should URL-encode this [%hardbreaks] {blank} -a| String +a¦ String -a| *sessionToken* + +a¦ *sessionToken* + _optional_ -a| +a¦ [markdown] @@ -1285,13 +1292,13 @@ For S3 links only. The Amazon S3 session token. Use this parameter if you want t [%hardbreaks] {blank} -a| String +a¦ String -a| *region* + +a¦ *region* + _required_ -a| +a¦ [markdown] @@ -1302,13 +1309,13 @@ For S3 links only. The Amazon S3 region. [%hardbreaks] {blank} -a| String +a¦ String -a| *serviceEndpoint* + +a¦ *serviceEndpoint* + _optional_ -a| +a¦ [markdown] @@ -1319,13 +1326,13 @@ For S3 links only. The Amazon S3 service endpoint. [%hardbreaks] {blank} -a| String +a¦ String -a| *endpoint* + +a¦ *endpoint* + _optional_ -a| +a¦ [markdown] @@ -1336,13 +1343,13 @@ For Azure Blob links and Google Cloud Storage links. The endpoint URI. Required [%hardbreaks] {blank} -a| String +a¦ String -a| *accountName* + +a¦ *accountName* + _optional_ -a| +a¦ [markdown] @@ -1353,13 +1360,13 @@ For Azure Blob links only. The account name. Used for shared key authentication. [%hardbreaks] {blank} -a| String +a¦ String -a| *accountKey* + +a¦ *accountKey* + _optional_ -a| +a¦ [markdown] @@ -1370,13 +1377,13 @@ For Azure Blob links only. The account key. Used for shared key authentication. [%hardbreaks] {blank} -a| String +a¦ String -a| *sharedAccessSignature* + +a¦ *sharedAccessSignature* + _optional_ -a| +a¦ [markdown] @@ -1387,13 +1394,13 @@ For Azure Blob links only. A token that can be used for authentication. Used for [%hardbreaks] {blank} -a| String +a¦ String -a| *managedIdentityId* + +a¦ *managedIdentityId* + _optional_ -a| +a¦ [markdown] @@ -1404,13 +1411,13 @@ For Azure Blob links only. The managed identity ID. Used for managed identity au [%hardbreaks] {blank} -a| String +a¦ String -a| *clientId* + +a¦ *clientId* + _optional_ -a| +a¦ [markdown] @@ -1421,13 +1428,13 @@ For Azure Blob links only. The client ID for the registered application. Used fo [%hardbreaks] {blank} -a| String +a¦ String -a| *tenantId* + +a¦ *tenantId* + _optional_ -a| +a¦ [markdown] @@ -1438,13 +1445,13 @@ For Azure Blob links only. The tenant ID where the registered application is cre [%hardbreaks] {blank} -a| String +a¦ String -a| *clientSecret* + +a¦ *clientSecret* + _optional_ -a| +a¦ [markdown] @@ -1455,13 +1462,13 @@ For Azure Blob links only. The client secret for the registered application. Use [%hardbreaks] {blank} -a| String +a¦ String -a| *clientCertificatePassword* + +a¦ *clientCertificatePassword* + _optional_ -a| +a¦ [markdown] @@ -1472,13 +1479,13 @@ For Azure Blob links only. The client certificate password for the registered ap [%hardbreaks] {blank} -a| String +a¦ String -a| *jsonCredentials* + +a¦ *jsonCredentials* + _optional_ -a| +a¦ [markdown] @@ -1489,13 +1496,13 @@ For Google Cloud Storage links only. The JSON credentials of the link. This par [%hardbreaks] {blank} -a| String +a¦ String -a| *applicationDefaultCredentials* + +a¦ *applicationDefaultCredentials* + _optional_ -a| +a¦ [markdown] @@ -1507,7 +1514,7 @@ For Google Cloud Storage links only. If present, indicates that the link should *Values:* `"true"` {blank} -a| String +a¦ String @@ -1525,16 +1532,6 @@ a| String // markup not found, no include::{specDir}paths/put_alt/operation-parameters-after.adoc[opts=optional] -[#put_alt-produces] -= Produces - -* application/json - -[#put_alt-consumes] -= Consumes - -* application/x-www-form-urlencoded - // markup not found, no include::{specDir}paths/put_alt/operation-responses-before.adoc[opts=optional] @@ -1693,6 +1690,12 @@ Returns information about all links in all Analytics scopes. // markup not found, no include::{specDir}paths/get_all/operation-description-end.adoc[opts=optional] + + +[#get_all-produces] +.Produces +* application/json + :leveloffset: -1 @@ -1716,13 +1719,13 @@ Returns information about all links in all Analytics scopes. .Query Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *dataverse* + +a¦ *dataverse* + _optional_ -a| +a¦ [markdown] @@ -1738,13 +1741,13 @@ This parameter is provided for backward compatibility. Note that it is deprecate [%hardbreaks] {blank} -a| String +a¦ String -a| *name* + +a¦ *name* + _optional_ -a| +a¦ [markdown] @@ -1758,13 +1761,13 @@ This parameter is provided for backward compatibility. Note that it is deprecate [%hardbreaks] {blank} -a| String +a¦ String -a| *type* + +a¦ *type* + _optional_ -a| +a¦ [markdown] @@ -1777,7 +1780,7 @@ The type of the link. If this parameter is omitted, all link types are retrieved *Values:* `"couchbase"`, `"s3"`, `"azureblob"`, `"gcs"` {blank} -a| String +a¦ String @@ -1797,12 +1800,6 @@ a| String // markup not found, no include::{specDir}paths/get_all/operation-parameters-after.adoc[opts=optional] -[#get_all-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_all/operation-responses-before.adoc[opts=optional] @@ -1940,6 +1937,12 @@ 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] + + +[#get_scope-produces] +.Produces +* application/json + :leveloffset: -1 @@ -1962,13 +1965,13 @@ Returns information about all links in the specified Analytics scope. .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *scope* + +a¦ *scope* + _required_ -a| +a¦ [markdown] @@ -1982,7 +1985,7 @@ With this parameter, the scope name may contain one or two identifiers, separate [%hardbreaks] {blank} -a| String +a¦ String @@ -1992,13 +1995,13 @@ a| String .Query Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *type* + +a¦ *type* + _optional_ -a| +a¦ [markdown] @@ -2011,7 +2014,7 @@ The type of the link. If this parameter is omitted, all link types are retrieved *Values:* `"couchbase"`, `"s3"`, `"azureblob"`, `"gcs"` {blank} -a| String +a¦ String @@ -2031,12 +2034,6 @@ a| String // markup not found, no include::{specDir}paths/get_scope/operation-parameters-after.adoc[opts=optional] -[#get_scope-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_scope/operation-responses-before.adoc[opts=optional] @@ -2200,6 +2197,12 @@ 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] + + +[#delete_link-produces] +.Produces +* application/json + :leveloffset: -1 @@ -2222,13 +2225,13 @@ Deletes a link in the specified Analytics scope. The link cannot be deleted if a .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *scope* + +a¦ *scope* + _required_ -a| +a¦ [markdown] @@ -2242,13 +2245,13 @@ With this parameter, the scope name may contain one or two identifiers, separate [%hardbreaks] {blank} -a| String +a¦ String -a| *name* + +a¦ *name* + _required_ -a| +a¦ [markdown] @@ -2259,7 +2262,7 @@ The name of the link. [%hardbreaks] {blank} -a| String +a¦ String @@ -2280,12 +2283,6 @@ a| String // markup not found, no include::{specDir}paths/delete_link/operation-parameters-after.adoc[opts=optional] -[#delete_link-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/delete_link/operation-responses-before.adoc[opts=optional] @@ -2421,6 +2418,12 @@ 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] + + +[#get_link-produces] +.Produces +* application/json + :leveloffset: -1 @@ -2443,13 +2446,13 @@ Returns information about a link in the specified Analytics scope. .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *scope* + +a¦ *scope* + _required_ -a| +a¦ [markdown] @@ -2463,13 +2466,13 @@ With this parameter, the scope name may contain one or two identifiers, separate [%hardbreaks] {blank} -a| String +a¦ String -a| *name* + +a¦ *name* + _required_ -a| +a¦ [markdown] @@ -2480,7 +2483,7 @@ The name of the link. [%hardbreaks] {blank} -a| String +a¦ String @@ -2490,13 +2493,13 @@ a| String .Query Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *type* + +a¦ *type* + _optional_ -a| +a¦ [markdown] @@ -2509,7 +2512,7 @@ include::index.adoc[tag=desc-CommonTypeEdit, opts=optional] *Values:* `"couchbase"`, `"s3"`, `"azureblob"`, `"gcs"` {blank} -a| +a¦ include::index.adoc[tag=type-CommonTypeEdit, opts=optional] @@ -2529,12 +2532,6 @@ include::index.adoc[tag=type-CommonTypeEdit, opts=optional] // markup not found, no include::{specDir}paths/get_link/operation-parameters-after.adoc[opts=optional] -[#get_link-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_link/operation-responses-before.adoc[opts=optional] @@ -2672,6 +2669,15 @@ Creates a link in the specified Analytics scope. // markup not found, no include::{specDir}paths/post_link/operation-description-end.adoc[opts=optional] + +[#post_link-consumes] +.Consumes +* application/x-www-form-urlencoded + +[#post_link-produces] +.Produces +* application/json + :leveloffset: -1 @@ -2694,13 +2700,13 @@ include::{specDir}paths/post_link/operation-description-after.adoc[opts=optional .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *scope* + +a¦ *scope* + _required_ -a| +a¦ [markdown] @@ -2714,13 +2720,13 @@ With this parameter, the scope name may contain one or two identifiers, separate [%hardbreaks] {blank} -a| String +a¦ String -a| *name* + +a¦ *name* + _required_ -a| +a¦ [markdown] @@ -2731,7 +2737,7 @@ The name of the link. [%hardbreaks] {blank} -a| String +a¦ String @@ -2743,13 +2749,13 @@ a| String .Form Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *type* + +a¦ *type* + _required_ -a| +a¦ [markdown] @@ -2762,13 +2768,13 @@ include::index.adoc[tag=desc-CommonType, opts=optional] *Values:* `"couchbase"`, `"s3"`, `"azureblob"`, `"gcs"` {blank} -a| +a¦ include::index.adoc[tag=type-CommonType, opts=optional] -a| *hostname* + +a¦ *hostname* + _required_ -a| +a¦ [markdown] @@ -2779,13 +2785,13 @@ For Couchbase links only. The remote hostname. [%hardbreaks] {blank} -a| String +a¦ String -a| *username* + +a¦ *username* + _optional_ -a| +a¦ [markdown] @@ -2796,13 +2802,13 @@ For Couchbase links only. The remote username. Required for links with no encryp [%hardbreaks] {blank} -a| String +a¦ String -a| *password* + +a¦ *password* + _optional_ -a| +a¦ [markdown] @@ -2813,13 +2819,13 @@ For Couchbase links only. The remote password. Required for links with no encryp [%hardbreaks] {blank} -a| String +a¦ String -a| *encryption* + +a¦ *encryption* + _required_ -a| +a¦ [markdown] @@ -2831,13 +2837,13 @@ For Couchbase links only. The type of encryption used by the link. For details, *Values:* `"none"`, `"half"`, `"full"` {blank} -a| String +a¦ String -a| *certificate* + +a¦ *certificate* + _optional_ -a| +a¦ [markdown] @@ -2848,13 +2854,13 @@ For Couchbase links only. The content of the target cluster root certificate. Re [%hardbreaks] {blank} -a| String +a¦ String -a| *clientCertificate* + +a¦ *clientCertificate* + _optional_ -a| +a¦ [markdown] @@ -2865,13 +2871,13 @@ For Couchbase links, this is the content of the client certificate. Required for [%hardbreaks] {blank} -a| String +a¦ String -a| *clientKey* + +a¦ *clientKey* + _optional_ -a| +a¦ [markdown] @@ -2882,13 +2888,13 @@ For Couchbase links only. The content of the client key. Required for links with [%hardbreaks] {blank} -a| String +a¦ String -a| *accessKeyId* + +a¦ *accessKeyId* + _required_ -a| +a¦ [markdown] @@ -2899,13 +2905,13 @@ For S3 links only. The Amazon S3 access key ID. [%hardbreaks] {blank} -a| String +a¦ String -a| *secretAccessKey* + +a¦ *secretAccessKey* + _required_ -a| +a¦ [markdown] @@ -2916,13 +2922,13 @@ For S3 links only. The Amazon S3 secret access key. You should URL-encode this [%hardbreaks] {blank} -a| String +a¦ String -a| *sessionToken* + +a¦ *sessionToken* + _optional_ -a| +a¦ [markdown] @@ -2933,13 +2939,13 @@ For S3 links only. The Amazon S3 session token. Use this parameter if you want t [%hardbreaks] {blank} -a| String +a¦ String -a| *region* + +a¦ *region* + _required_ -a| +a¦ [markdown] @@ -2950,13 +2956,13 @@ For S3 links only. The Amazon S3 region. [%hardbreaks] {blank} -a| String +a¦ String -a| *serviceEndpoint* + +a¦ *serviceEndpoint* + _optional_ -a| +a¦ [markdown] @@ -2967,13 +2973,13 @@ For S3 links only. The Amazon S3 service endpoint. [%hardbreaks] {blank} -a| String +a¦ String -a| *endpoint* + +a¦ *endpoint* + _optional_ -a| +a¦ [markdown] @@ -2984,13 +2990,13 @@ For Azure Blob links and Google Cloud Storage links. The endpoint URI. Required [%hardbreaks] {blank} -a| String +a¦ String -a| *accountName* + +a¦ *accountName* + _optional_ -a| +a¦ [markdown] @@ -3001,13 +3007,13 @@ For Azure Blob links only. The account name. Used for shared key authentication. [%hardbreaks] {blank} -a| String +a¦ String -a| *accountKey* + +a¦ *accountKey* + _optional_ -a| +a¦ [markdown] @@ -3018,13 +3024,13 @@ For Azure Blob links only. The account key. Used for shared key authentication. [%hardbreaks] {blank} -a| String +a¦ String -a| *sharedAccessSignature* + +a¦ *sharedAccessSignature* + _optional_ -a| +a¦ [markdown] @@ -3035,13 +3041,13 @@ For Azure Blob links only. A token that can be used for authentication. Used for [%hardbreaks] {blank} -a| String +a¦ String -a| *managedIdentityId* + +a¦ *managedIdentityId* + _optional_ -a| +a¦ [markdown] @@ -3052,13 +3058,13 @@ For Azure Blob links only. The managed identity ID. Used for managed identity au [%hardbreaks] {blank} -a| String +a¦ String -a| *clientId* + +a¦ *clientId* + _optional_ -a| +a¦ [markdown] @@ -3069,13 +3075,13 @@ For Azure Blob links only. The client ID for the registered application. Used fo [%hardbreaks] {blank} -a| String +a¦ String -a| *tenantId* + +a¦ *tenantId* + _optional_ -a| +a¦ [markdown] @@ -3086,13 +3092,13 @@ For Azure Blob links only. The tenant ID where the registered application is cre [%hardbreaks] {blank} -a| String +a¦ String -a| *clientSecret* + +a¦ *clientSecret* + _optional_ -a| +a¦ [markdown] @@ -3103,13 +3109,13 @@ For Azure Blob links only. The client secret for the registered application. Use [%hardbreaks] {blank} -a| String +a¦ String -a| *clientCertificatePassword* + +a¦ *clientCertificatePassword* + _optional_ -a| +a¦ [markdown] @@ -3120,13 +3126,13 @@ For Azure Blob links only. The client certificate password for the registered ap [%hardbreaks] {blank} -a| String +a¦ String -a| *jsonCredentials* + +a¦ *jsonCredentials* + _optional_ -a| +a¦ [markdown] @@ -3137,13 +3143,13 @@ For Google Cloud Storage links only. The JSON credentials of the link. This par [%hardbreaks] {blank} -a| String +a¦ String -a| *applicationDefaultCredentials* + +a¦ *applicationDefaultCredentials* + _optional_ -a| +a¦ [markdown] @@ -3155,7 +3161,7 @@ For Google Cloud Storage links only. If present, indicates that the link should *Values:* `"true"` {blank} -a| String +a¦ String @@ -3173,16 +3179,6 @@ a| String // markup not found, no include::{specDir}paths/post_link/operation-parameters-after.adoc[opts=optional] -[#post_link-produces] -= Produces - -* application/json - -[#post_link-consumes] -= Consumes - -* application/x-www-form-urlencoded - // markup not found, no include::{specDir}paths/post_link/operation-responses-before.adoc[opts=optional] @@ -3319,6 +3315,15 @@ 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] + +[#put_link-consumes] +.Consumes +* application/x-www-form-urlencoded + +[#put_link-produces] +.Produces +* application/json + :leveloffset: -1 @@ -3341,13 +3346,13 @@ Edits an existing link in the specified Analytics scope. The link name, type, an .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *scope* + +a¦ *scope* + _required_ -a| +a¦ [markdown] @@ -3361,13 +3366,13 @@ With this parameter, the scope name may contain one or two identifiers, separate [%hardbreaks] {blank} -a| String +a¦ String -a| *name* + +a¦ *name* + _required_ -a| +a¦ [markdown] @@ -3378,7 +3383,7 @@ The name of the link. [%hardbreaks] {blank} -a| String +a¦ String @@ -3390,13 +3395,13 @@ a| String .Form Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *type* + +a¦ *type* + _optional_ -a| +a¦ [markdown] @@ -3409,13 +3414,13 @@ include::index.adoc[tag=desc-CommonTypeEdit, opts=optional] *Values:* `"couchbase"`, `"s3"`, `"azureblob"`, `"gcs"` {blank} -a| +a¦ include::index.adoc[tag=type-CommonTypeEdit, opts=optional] -a| *hostname* + +a¦ *hostname* + _required_ -a| +a¦ [markdown] @@ -3426,13 +3431,13 @@ For Couchbase links only. The remote hostname. [%hardbreaks] {blank} -a| String +a¦ String -a| *username* + +a¦ *username* + _optional_ -a| +a¦ [markdown] @@ -3443,13 +3448,13 @@ For Couchbase links only. The remote username. Required for links with no encryp [%hardbreaks] {blank} -a| String +a¦ String -a| *password* + +a¦ *password* + _optional_ -a| +a¦ [markdown] @@ -3460,13 +3465,13 @@ For Couchbase links only. The remote password. Required for links with no encryp [%hardbreaks] {blank} -a| String +a¦ String -a| *encryption* + +a¦ *encryption* + _required_ -a| +a¦ [markdown] @@ -3478,13 +3483,13 @@ For Couchbase links only. The type of encryption used by the link. For details, *Values:* `"none"`, `"half"`, `"full"` {blank} -a| String +a¦ String -a| *certificate* + +a¦ *certificate* + _optional_ -a| +a¦ [markdown] @@ -3495,13 +3500,13 @@ For Couchbase links only. The content of the target cluster root certificate. Re [%hardbreaks] {blank} -a| String +a¦ String -a| *clientCertificate* + +a¦ *clientCertificate* + _optional_ -a| +a¦ [markdown] @@ -3512,13 +3517,13 @@ For Couchbase links, this is the content of the client certificate. Required for [%hardbreaks] {blank} -a| String +a¦ String -a| *clientKey* + +a¦ *clientKey* + _optional_ -a| +a¦ [markdown] @@ -3529,13 +3534,13 @@ For Couchbase links only. The content of the client key. Required for links with [%hardbreaks] {blank} -a| String +a¦ String -a| *accessKeyId* + +a¦ *accessKeyId* + _required_ -a| +a¦ [markdown] @@ -3546,13 +3551,13 @@ For S3 links only. The Amazon S3 access key ID. [%hardbreaks] {blank} -a| String +a¦ String -a| *secretAccessKey* + +a¦ *secretAccessKey* + _required_ -a| +a¦ [markdown] @@ -3563,13 +3568,13 @@ For S3 links only. The Amazon S3 secret access key. You should URL-encode this [%hardbreaks] {blank} -a| String +a¦ String -a| *sessionToken* + +a¦ *sessionToken* + _optional_ -a| +a¦ [markdown] @@ -3580,13 +3585,13 @@ For S3 links only. The Amazon S3 session token. Use this parameter if you want t [%hardbreaks] {blank} -a| String +a¦ String -a| *region* + +a¦ *region* + _required_ -a| +a¦ [markdown] @@ -3597,13 +3602,13 @@ For S3 links only. The Amazon S3 region. [%hardbreaks] {blank} -a| String +a¦ String -a| *serviceEndpoint* + +a¦ *serviceEndpoint* + _optional_ -a| +a¦ [markdown] @@ -3614,13 +3619,13 @@ For S3 links only. The Amazon S3 service endpoint. [%hardbreaks] {blank} -a| String +a¦ String -a| *endpoint* + +a¦ *endpoint* + _optional_ -a| +a¦ [markdown] @@ -3631,13 +3636,13 @@ For Azure Blob links and Google Cloud Storage links. The endpoint URI. Required [%hardbreaks] {blank} -a| String +a¦ String -a| *accountName* + +a¦ *accountName* + _optional_ -a| +a¦ [markdown] @@ -3648,13 +3653,13 @@ For Azure Blob links only. The account name. Used for shared key authentication. [%hardbreaks] {blank} -a| String +a¦ String -a| *accountKey* + +a¦ *accountKey* + _optional_ -a| +a¦ [markdown] @@ -3665,13 +3670,13 @@ For Azure Blob links only. The account key. Used for shared key authentication. [%hardbreaks] {blank} -a| String +a¦ String -a| *sharedAccessSignature* + +a¦ *sharedAccessSignature* + _optional_ -a| +a¦ [markdown] @@ -3682,13 +3687,13 @@ For Azure Blob links only. A token that can be used for authentication. Used for [%hardbreaks] {blank} -a| String +a¦ String -a| *managedIdentityId* + +a¦ *managedIdentityId* + _optional_ -a| +a¦ [markdown] @@ -3699,13 +3704,13 @@ For Azure Blob links only. The managed identity ID. Used for managed identity au [%hardbreaks] {blank} -a| String +a¦ String -a| *clientId* + +a¦ *clientId* + _optional_ -a| +a¦ [markdown] @@ -3716,13 +3721,13 @@ For Azure Blob links only. The client ID for the registered application. Used fo [%hardbreaks] {blank} -a| String +a¦ String -a| *tenantId* + +a¦ *tenantId* + _optional_ -a| +a¦ [markdown] @@ -3733,13 +3738,13 @@ For Azure Blob links only. The tenant ID where the registered application is cre [%hardbreaks] {blank} -a| String +a¦ String -a| *clientSecret* + +a¦ *clientSecret* + _optional_ -a| +a¦ [markdown] @@ -3750,13 +3755,13 @@ For Azure Blob links only. The client secret for the registered application. Use [%hardbreaks] {blank} -a| String +a¦ String -a| *clientCertificatePassword* + +a¦ *clientCertificatePassword* + _optional_ -a| +a¦ [markdown] @@ -3767,13 +3772,13 @@ For Azure Blob links only. The client certificate password for the registered ap [%hardbreaks] {blank} -a| String +a¦ String -a| *jsonCredentials* + +a¦ *jsonCredentials* + _optional_ -a| +a¦ [markdown] @@ -3784,13 +3789,13 @@ For Google Cloud Storage links only. The JSON credentials of the link. This par [%hardbreaks] {blank} -a| String +a¦ String -a| *applicationDefaultCredentials* + +a¦ *applicationDefaultCredentials* + _optional_ -a| +a¦ [markdown] @@ -3802,7 +3807,7 @@ For Google Cloud Storage links only. If present, indicates that the link should *Values:* `"true"` {blank} -a| String +a¦ String @@ -3820,16 +3825,6 @@ a| String // markup not found, no include::{specDir}paths/put_link/operation-parameters-after.adoc[opts=optional] -[#put_link-produces] -= Produces - -* application/json - -[#put_link-consumes] -= Consumes - -* application/x-www-form-urlencoded - // markup not found, no include::{specDir}paths/put_link/operation-responses-before.adoc[opts=optional] @@ -4052,14 +4047,14 @@ These properties are common to all links. //end::desc-ResponseAll[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *scope* + _required_ -a| +a¦ [markdown] -- @@ -4070,15 +4065,15 @@ The scope name may contain one or two identifiers, separated by a slash (/). -- [%hardbreaks] -*Example:* `pass:c["travel-sample/inventory"]` +*Example:* `+++"travel-sample/inventory"+++` {blank} -a| String +a¦ String -a| +a¦ *name* + _required_ -a| +a¦ [markdown] -- @@ -4086,15 +4081,15 @@ The name of the link. -- [%hardbreaks] -*Example:* `pass:c["myLink"]` +*Example:* `+++"myLink"+++` {blank} -a| String +a¦ String -a| [#type] +a¦ [#type] *type* + _required_ -a| +a¦ [markdown] -- @@ -4109,7 +4104,7 @@ The type of the link. [%hardbreaks] *Values:* `"couchbase"`, `"s3"`, `"azureblob"`, `"gcs"` {blank} -a| String +a¦ String |=== @@ -4208,14 +4203,14 @@ endif::collapse-models[] //tag::ResponseAzureBlobSpecific[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *accountKey* + _optional_ -a| +a¦ [markdown] -- @@ -4224,15 +4219,15 @@ The account key. Used for shared key authentication. This is redacted for the sa -- [%hardbreaks] -*Example:* `pass:c[""]` +*Example:* `+++""+++` {blank} -a| String +a¦ String -a| +a¦ *accountName* + _optional_ -a| +a¦ [markdown] -- @@ -4241,15 +4236,15 @@ The account name. Used for shared key authentication. If not set, this property -- [%hardbreaks] -*Example:* `pass:c["myAccountName"]` +*Example:* `+++"myAccountName"+++` {blank} -a| String +a¦ String -a| +a¦ *clientCertificate* + _optional_ -a| +a¦ [markdown] -- @@ -4258,15 +4253,15 @@ The client certificate for the registered application. Used for Azure Active Dir -- [%hardbreaks] -*Example:* `pass:c[""]` +*Example:* `+++""+++` {blank} -a| String +a¦ String -a| +a¦ *clientCertificatePassword* + _optional_ -a| +a¦ [markdown] -- @@ -4275,15 +4270,15 @@ The client certificate password for the registered application. Used for Azure A -- [%hardbreaks] -*Example:* `pass:c[""]` +*Example:* `+++""+++` {blank} -a| String +a¦ String -a| +a¦ *clientId* + _optional_ -a| +a¦ [markdown] -- @@ -4292,15 +4287,15 @@ The client ID for the registered application. Used for Azure Active Directory cl -- [%hardbreaks] -*Example:* `pass:c["myClientID"]` +*Example:* `+++"myClientID"+++` {blank} -a| String +a¦ String -a| +a¦ *clientSecret* + _optional_ -a| +a¦ [markdown] -- @@ -4309,15 +4304,15 @@ The client secret for the registered application. Used for Azure Active Director -- [%hardbreaks] -*Example:* `pass:c[""]` +*Example:* `+++""+++` {blank} -a| String +a¦ String -a| +a¦ *endpoint* + _required_ -a| +a¦ [markdown] -- @@ -4325,15 +4320,15 @@ The endpoint URI. -- [%hardbreaks] -*Example:* `pass:c["my.endpoint.uri"]` +*Example:* `+++"my.endpoint.uri"+++` {blank} -a| String +a¦ String -a| +a¦ *managedIdentityId* + _optional_ -a| +a¦ [markdown] -- @@ -4342,15 +4337,15 @@ The managed identity ID. Used for managed identity authentication. If not set, t -- [%hardbreaks] -*Example:* `pass:c["myManagedIdentityID"]` +*Example:* `+++"myManagedIdentityID"+++` {blank} -a| String +a¦ String -a| +a¦ *sharedAccessSignature* + _optional_ -a| +a¦ [markdown] -- @@ -4359,15 +4354,15 @@ A token that can be used for authentication. Used for shared access signature au -- [%hardbreaks] -*Example:* `pass:c[""]` +*Example:* `+++""+++` {blank} -a| String +a¦ String -a| +a¦ *tenantId* + _optional_ -a| +a¦ [markdown] -- @@ -4376,9 +4371,9 @@ The tenant ID where the registered application is created. Used for Azure Active -- [%hardbreaks] -*Example:* `pass:c["myTenantID"]` +*Example:* `+++"myTenantID"+++` {blank} -a| String +a¦ String |=== @@ -4455,14 +4450,14 @@ endif::collapse-models[] //tag::ResponseCouchbaseSpecific[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *activeHostname* + _required_ -a| +a¦ [markdown] -- @@ -4470,15 +4465,15 @@ The remote hostname. -- [%hardbreaks] -*Example:* `pass:c["remoteHostName:8091"]` +*Example:* `+++"remoteHostName:8091"+++` {blank} -a| String +a¦ String -a| +a¦ *bootstrapAlternateAddress* + _required_ -a| +a¦ [markdown] -- @@ -4488,13 +4483,13 @@ Specifies whether the provided (bootstrap) hostname is an alternative address. [%hardbreaks] *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *bootstrapHostname* + _required_ -a| +a¦ [markdown] -- @@ -4502,15 +4497,15 @@ The provided (bootstrap) hostname. -- [%hardbreaks] -*Example:* `pass:c["remoteHostName:8091"]` +*Example:* `+++"remoteHostName:8091"+++` {blank} -a| String +a¦ String -a| +a¦ *certificate* + _required_ -a| +a¦ [markdown] -- @@ -4520,13 +4515,13 @@ The content of the target cluster root certificate. Only set for links with full [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *clientCertificate* + _required_ -a| +a¦ [markdown] -- @@ -4536,13 +4531,13 @@ The content of the client certificate. Only set for links with full encryption u [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *clientKey* + _required_ -a| +a¦ [markdown] -- @@ -4552,13 +4547,13 @@ The content of the client key. Only set for links with full encryption using cli [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *clusterCompatibility* + _required_ -a| +a¦ [markdown] -- @@ -4568,13 +4563,13 @@ For internal use only. [%hardbreaks] *Example:* `393221` {blank} -a| Integer +a¦ Integer -a| [#encryption] +a¦ [#encryption] *encryption* + _required_ -a| +a¦ [markdown] -- @@ -4589,13 +4584,13 @@ The type of encryption used by the link. [%hardbreaks] *Values:* `"none"`, `"half"`, `"full"` {blank} -a| String +a¦ String -a| +a¦ *nodes* + _required_ -a| +a¦ [markdown] -- @@ -4604,13 +4599,13 @@ An array of objects, each of which contains information about a node in the targ [%hardbreaks] {blank} -a| <> +a¦ <> array -a| +a¦ *password* + _required_ -a| +a¦ [markdown] -- @@ -4619,15 +4614,15 @@ The password used to connect to the link. This is redacted for the sake of secur -- [%hardbreaks] -*Example:* `pass:c[""]` +*Example:* `+++""+++` {blank} -a| String +a¦ String -a| +a¦ *username* + _required_ -a| +a¦ [markdown] -- @@ -4636,15 +4631,15 @@ The remote username. Not set for links with full encryption using client certifi -- [%hardbreaks] -*Example:* `pass:c["remote.user"]` +*Example:* `+++"remote.user"+++` {blank} -a| String +a¦ String -a| +a¦ *uuid* + _required_ -a| +a¦ [markdown] -- @@ -4652,9 +4647,9 @@ A UUID uniquely identifying the link. -- [%hardbreaks] -*Example:* `pass:c["6331e2a390125b662f7bcfd63ecb3a73"]` +*Example:* `+++"6331e2a390125b662f7bcfd63ecb3a73"+++` {blank} -a| UUID (UUID) +a¦ UUID (UUID) |=== @@ -4694,14 +4689,14 @@ endif::collapse-models[] //tag::ResponseCouchbaseSpecificNode[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *alternateAddresses* + _optional_ -a| +a¦ [markdown] -- @@ -4711,13 +4706,13 @@ The alternate address defined on the node, if any. If not defined, this property [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *hostname* + _optional_ -a| +a¦ [markdown] -- @@ -4727,13 +4722,13 @@ The hostname of the node. If not defined, this property returns `null`. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *services* + _optional_ -a| +a¦ [markdown] -- @@ -4742,7 +4737,7 @@ include::index.adoc[tag=desc-ResponseCouchbaseSpecificNodeServices, opts=optiona [%hardbreaks] {blank} -a| <> +a¦ <> |=== @@ -4787,14 +4782,14 @@ An object giving information about the services and ports configured on this nod //end::desc-ResponseCouchbaseSpecificNodeServices[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *cbas* + _optional_ -a| +a¦ [markdown] -- @@ -4804,13 +4799,13 @@ The port number for a connection to the Analytics service. [%hardbreaks] *Example:* `8095` {blank} -a| Integer +a¦ Integer -a| +a¦ *cbasSSL* + _optional_ -a| +a¦ [markdown] -- @@ -4820,13 +4815,13 @@ The port number for an encrypted connection to the Analytics service. [%hardbreaks] *Example:* `18095` {blank} -a| Integer +a¦ Integer -a| +a¦ *kv* + _optional_ -a| +a¦ [markdown] -- @@ -4836,13 +4831,13 @@ The port number for a connection to the Data service. [%hardbreaks] *Example:* `11210` {blank} -a| Integer +a¦ Integer -a| +a¦ *kvSSL* + _optional_ -a| +a¦ [markdown] -- @@ -4852,13 +4847,13 @@ The port number for an encrypted connection to the Data service. [%hardbreaks] *Example:* `11207` {blank} -a| Integer +a¦ Integer -a| +a¦ *mgmt* + _optional_ -a| +a¦ [markdown] -- @@ -4868,13 +4863,13 @@ The port number for a connection to the Cluster Manager service. [%hardbreaks] *Example:* `8091` {blank} -a| Integer +a¦ Integer -a| +a¦ *mgmtSSL* + _optional_ -a| +a¦ [markdown] -- @@ -4884,7 +4879,7 @@ The port number for an encrypted connection to the Cluster Manager service. [%hardbreaks] *Example:* `18091` {blank} -a| Integer +a¦ Integer |=== @@ -4961,14 +4956,14 @@ endif::collapse-models[] //tag::ResponseGCSSpecific[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *applicationDefaultCredentials* + _required_ -a| +a¦ [markdown] -- @@ -4978,15 +4973,15 @@ If present, indicates that the link should use the Google Application Default Cr [%hardbreaks] *Values:* `"true"` -*Example:* `pass:c["true"]` +*Example:* `+++"true"+++` {blank} -a| String +a¦ String -a| +a¦ *endpoint* + _required_ -a| +a¦ [markdown] -- @@ -4995,15 +4990,15 @@ The endpoint URI. If not set, this property returns `null`. -- [%hardbreaks] -*Example:* `pass:c["https://storage.googleapis.com"]` +*Example:* `+++"https://storage.googleapis.com"+++` {blank} -a| String +a¦ String -a| +a¦ *jsonCredentials* + _required_ -a| +a¦ [markdown] -- @@ -5012,9 +5007,9 @@ The JSON credentials of the link. If not set, this property returns `null`. -- [%hardbreaks] -*Example:* `pass:c[""]` +*Example:* `+++""+++` {blank} -a| String +a¦ String |=== @@ -5091,14 +5086,14 @@ endif::collapse-models[] //tag::ResponseS3Specific[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *accessKeyId* + _required_ -a| +a¦ [markdown] -- @@ -5106,15 +5101,15 @@ The Amazon S3 access key ID. -- [%hardbreaks] -*Example:* `pass:c["myAccessKey"]` +*Example:* `+++"myAccessKey"+++` {blank} -a| String +a¦ String -a| +a¦ *region* + _required_ -a| +a¦ [markdown] -- @@ -5122,15 +5117,15 @@ The Amazon S3 region. -- [%hardbreaks] -*Example:* `pass:c["us-east-1"]` +*Example:* `+++"us-east-1"+++` {blank} -a| String +a¦ String -a| +a¦ *secretAccessKey* + _required_ -a| +a¦ [markdown] -- @@ -5139,15 +5134,15 @@ The Amazon S3 secret access key. This is redacted for the sake of security. -- [%hardbreaks] -*Example:* `pass:c[""]` +*Example:* `+++""+++` {blank} -a| String +a¦ String -a| +a¦ *sessionToken* + _optional_ -a| +a¦ [markdown] -- @@ -5156,15 +5151,15 @@ The Amazon S3 session token. Indicates that the link has temporary access, and t -- [%hardbreaks] -*Example:* `pass:c[""]` +*Example:* `+++""+++` {blank} -a| String +a¦ String -a| +a¦ *serviceEndpoint* + _required_ -a| +a¦ [markdown] -- @@ -5173,9 +5168,9 @@ Amazon S3 service endpoint. If not set, this property returns `null`. -- [%hardbreaks] -*Example:* `pass:c["my.endpoint.uri"]` +*Example:* `+++"my.endpoint.uri"+++` {blank} -a| String +a¦ String |=== @@ -5215,14 +5210,14 @@ endif::collapse-models[] //tag::Wrong[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *error* + _required_ -a| +a¦ [markdown] -- @@ -5231,7 +5226,7 @@ An error message. [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -5315,3 +5310,4 @@ include::{specDir}security/document-end.adoc[opts=optional] // markup not found, no include::{specDir}security/document-after.adoc[opts=optional] + diff --git a/docs/modules/analytics-rest-service/pages/index.adoc b/docs/modules/analytics-rest-service/pages/index.adoc index 6d140943..fe3a5576 100644 --- a/docs/modules/analytics-rest-service/pages/index.adoc +++ b/docs/modules/analytics-rest-service/pages/index.adoc @@ -59,7 +59,7 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* @@ -70,7 +70,7 @@ The host name or IP address of a node running the Analytics service. [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* @@ -81,7 +81,7 @@ The Analytics service REST port. Use `18095` for secure access. [%hardbreaks] *Values:* `8095`, `18095` -*Example:* `pass:c[8095]` +*Example:* `+++8095+++` // end |=== @@ -175,6 +175,12 @@ An alternative endpoint for the [Read-Only Query Service](#get_service), provide // markup not found, no include::{specDir}paths/get_query/operation-description-end.adoc[opts=optional] + + +[#get_query-produces] +.Produces +* application/json + :leveloffset: -1 @@ -198,13 +204,13 @@ An alternative endpoint for the [Read-Only Query Service](#get_service), provide .Query Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *body* + +a¦ *body* + _required_ -a| +a¦ [markdown] @@ -215,7 +221,7 @@ Specify the parameters in the query URL in URL-encoded format. [%hardbreaks] {blank} -a| <> +a¦ <> @@ -235,12 +241,6 @@ a| <> // markup not found, no include::{specDir}paths/get_query/operation-parameters-after.adoc[opts=optional] -[#get_query-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_query/operation-responses-before.adoc[opts=optional] @@ -381,6 +381,12 @@ 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] + + +[#get_service-produces] +.Produces +* application/json + :leveloffset: -1 @@ -404,13 +410,13 @@ This is intended for situations where use of the `POST` method is restricted. .Query Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *body* + +a¦ *body* + _required_ -a| +a¦ [markdown] @@ -421,7 +427,7 @@ Specify the parameters in the query URL in URL-encoded format. [%hardbreaks] {blank} -a| <> +a¦ <> @@ -441,12 +447,6 @@ a| <> // markup not found, no include::{specDir}paths/get_service/operation-parameters-after.adoc[opts=optional] -[#get_service-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_service/operation-responses-before.adoc[opts=optional] @@ -584,6 +584,16 @@ An alternative endpoint for the [Query Service](#post_service), provided for too // markup not found, no include::{specDir}paths/post_query/operation-description-end.adoc[opts=optional] + +[#post_query-consumes] +.Consumes +* application/json +* application/x-www-form-urlencoded + +[#post_query-produces] +.Produces +* application/json + :leveloffset: -1 @@ -610,13 +620,13 @@ include::{specDir}paths/post_query/operation-parameters-begin.adoc[opts=optional .Body Parameter {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *Body* + +a¦ *Body* + _required_ -a| +a¦ [markdown] @@ -627,7 +637,7 @@ An object specifying one or more query parameters. [%hardbreaks] {blank} -a| <> +a¦ <> @@ -644,17 +654,6 @@ a| <> // markup not found, no include::{specDir}paths/post_query/operation-parameters-after.adoc[opts=optional] -[#post_query-produces] -= Produces - -* application/json - -[#post_query-consumes] -= Consumes - -* application/json -* application/x-www-form-urlencoded - // markup not found, no include::{specDir}paths/post_query/operation-responses-before.adoc[opts=optional] @@ -774,6 +773,16 @@ 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] + +[#post_service-consumes] +.Consumes +* application/json +* application/x-www-form-urlencoded + +[#post_service-produces] +.Produces +* application/json + :leveloffset: -1 @@ -800,13 +809,13 @@ include::{specDir}paths/post_service/operation-parameters-begin.adoc[opts=option .Body Parameter {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *Body* + +a¦ *Body* + _required_ -a| +a¦ [markdown] @@ -817,7 +826,7 @@ An object specifying one or more query parameters. [%hardbreaks] {blank} -a| <> +a¦ <> @@ -834,17 +843,6 @@ a| <> // markup not found, no include::{specDir}paths/post_service/operation-parameters-after.adoc[opts=optional] -[#post_service-produces] -= Produces - -* application/json - -[#post_service-consumes] -= Consumes - -* application/json -* application/x-www-form-urlencoded - // markup not found, no include::{specDir}paths/post_service/operation-responses-before.adoc[opts=optional] @@ -1052,14 +1050,14 @@ endif::collapse-models[] //tag::ParametersCommon[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *statement* + _required_ -a| +a¦ [markdown] -- @@ -1068,13 +1066,13 @@ Specifies at least one valid SQL\+\+ for Analytics statement to run. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *client_context_id* + _optional_ -a| +a¦ [markdown] -- @@ -1084,13 +1082,13 @@ An identifier passed by the client that is returned verbatim in the query respon [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *format* + _optional_ -a| +a¦ [markdown] -- @@ -1102,15 +1100,15 @@ Note that the only possible format is `JSON`. [%hardbreaks] *Values:* `"JSON"` -*Default:* `pass:c["JSON"]` +*Default:* `+++"JSON"+++` {blank} -a| String +a¦ String -a| +a¦ *pretty* + _optional_ -a| +a¦ [markdown] -- @@ -1120,13 +1118,13 @@ If `true`, the result is indented. [%hardbreaks] *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *query_context* + _optional_ -a| +a¦ [markdown] -- @@ -1135,15 +1133,15 @@ A scope for the statement. The value of this parameter must start with `default: -- [%hardbreaks] -*Default:* `pass:c["default:Default"]` +*Default:* `+++"default:Default"+++` {blank} -a| String +a¦ String -a| +a¦ *readonly* + _optional_ -a| +a¦ [markdown] -- @@ -1153,13 +1151,13 @@ If `true`, then DDL statements are not allowed. [%hardbreaks] *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *scan_consistency* + _optional_ -a| +a¦ [markdown] -- @@ -1169,15 +1167,15 @@ The consistency guarantee constraint for index scanning. If `not_bounded`, the q [%hardbreaks] *Values:* `"not_bounded"`, `"request_plus"` -*Default:* `pass:c["not_bounded"]` +*Default:* `+++"not_bounded"+++` {blank} -a| String +a¦ String -a| +a¦ *scan_wait* + _optional_ -a| +a¦ [markdown] -- @@ -1186,15 +1184,15 @@ The maximum time to wait for datasets to be updated before the query is executed -- [%hardbreaks] -*Default:* `pass:c[""]` +*Default:* `+++""+++` {blank} -a| String +a¦ String -a| +a¦ *timeout* + _optional_ -a| +a¦ [markdown] -- @@ -1203,15 +1201,15 @@ Maximum time to spend on the request before timing out. The format includes an a -- [%hardbreaks] -*Default:* `pass:c[""]` +*Default:* `+++""+++` {blank} -a| String +a¦ String -a| +a¦ *args* + _optional_ -a| +a¦ [markdown] -- @@ -1220,13 +1218,13 @@ An array of positional parameter values. [%hardbreaks] {blank} -a| Any Type +a¦ Any Type array -a| +a¦ _additional + property_ -a| +a¦ [markdown] -- @@ -1235,7 +1233,7 @@ A named parameter value. [%hardbreaks] {blank} -a| Any Type +a¦ Any Type |=== @@ -1275,14 +1273,14 @@ endif::collapse-models[] //tag::ParametersLocal[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *plan-format* + _optional_ -a| +a¦ [markdown] -- @@ -1291,15 +1289,15 @@ The plan format. [%hardbreaks] *Values:* `"JSON"`, `"STRING"` -*Default:* `pass:c["JSON"]` +*Default:* `+++"JSON"+++` {blank} -a| String +a¦ String -a| +a¦ *logical-plan* + _optional_ -a| +a¦ [markdown] -- @@ -1309,13 +1307,13 @@ If `true`, the logical plan is included in the query response. [%hardbreaks] *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *optimized-logical-plan* + _optional_ -a| +a¦ [markdown] -- @@ -1325,13 +1323,13 @@ If `true`, the optimized logical plan is included in the query response. [%hardbreaks] *Default:* `true` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *expression-tree* + _optional_ -a| +a¦ [markdown] -- @@ -1341,13 +1339,13 @@ If `true`, the expression tree is included in the query response. [%hardbreaks] *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *rewritten-expression-tree* + _optional_ -a| +a¦ [markdown] -- @@ -1357,13 +1355,13 @@ If `true`, the rewritten expression tree is included in the query response. [%hardbreaks] *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *job* + _optional_ -a| +a¦ [markdown] -- @@ -1373,13 +1371,13 @@ If `true`, the job details are included in the query response. [%hardbreaks] *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *max-warnings* + _optional_ -a| +a¦ [markdown] -- @@ -1389,7 +1387,7 @@ An integer specifying the maximum number of warning messages to be included in t [%hardbreaks] *Default:* `0` {blank} -a| Integer (int32) +a¦ Integer (int32) |=== @@ -1466,14 +1464,14 @@ endif::collapse-models[] //tag::ResponsesCommon[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *requestID* + _optional_ -a| +a¦ [markdown] -- @@ -1482,13 +1480,13 @@ A unique identifier for the response. [%hardbreaks] {blank} -a| UUID (UUID) +a¦ UUID (UUID) -a| +a¦ *clientContextID* + _optional_ -a| +a¦ [markdown] -- @@ -1504,13 +1502,13 @@ refer to `client_context_id` in [Query Parameters][1]. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *signature* + _optional_ -a| +a¦ [markdown] -- @@ -1520,13 +1518,13 @@ The schema of the results. Present only when the query completes successfully. [%hardbreaks] {blank} -a| Object +a¦ Object -a| +a¦ *results* + _optional_ -a| +a¦ [markdown] -- @@ -1536,13 +1534,13 @@ An array of all the objects returned by the query. An object can be any JSON val [%hardbreaks] {blank} -a| Any Type +a¦ Any Type array -a| +a¦ *status* + _optional_ -a| +a¦ [markdown] -- @@ -1552,13 +1550,13 @@ The status of the request. [%hardbreaks] *Values:* `"success"`, `"running"`, `"failed"`, `"timeout"`, `"fatal"` {blank} -a| String +a¦ String -a| +a¦ *errors* + _optional_ -a| +a¦ [markdown] -- @@ -1568,13 +1566,13 @@ An array of error objects. Present only if 1 or more errors are returned during [%hardbreaks] {blank} -a| <> +a¦ <> array -a| +a¦ *warnings* + _optional_ -a| +a¦ [markdown] -- @@ -1595,13 +1593,13 @@ By default, no warnings are returned, even if warnings have occurred during proc [%hardbreaks] {blank} -a| <> +a¦ <> array -a| +a¦ *metrics* + _optional_ -a| +a¦ [markdown] -- @@ -1610,7 +1608,7 @@ include::index.adoc[tag=desc-ResponsesCommonYardsticks, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ <> |=== @@ -1650,14 +1648,14 @@ endif::collapse-models[] //tag::ResponsesCommonErrors[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *code* + _optional_ -a| +a¦ [markdown] -- @@ -1666,13 +1664,13 @@ A number that identifies the error. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *msg* + _optional_ -a| +a¦ [markdown] -- @@ -1682,7 +1680,7 @@ A message describing the error in detail. Refer to [Error Codes](/server/7.6/ana [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -1722,14 +1720,14 @@ endif::collapse-models[] //tag::ResponsesCommonWarnings[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *code* + _optional_ -a| +a¦ [markdown] -- @@ -1738,13 +1736,13 @@ A number that identifies the warning. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *msg* + _optional_ -a| +a¦ [markdown] -- @@ -1753,7 +1751,7 @@ A message describing the warning in detail. [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -1798,14 +1796,14 @@ An object containing metrics about the request. //end::desc-ResponsesCommonYardsticks[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *elapsedTime* + _optional_ -a| +a¦ [markdown] -- @@ -1815,13 +1813,13 @@ The total time taken for the request, that is the time from when the request was [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *executionTime* + _optional_ -a| +a¦ [markdown] -- @@ -1831,13 +1829,13 @@ The time taken for the execution of the request, that is the time from when quer [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *resultCount* + _optional_ -a| +a¦ [markdown] -- @@ -1846,13 +1844,13 @@ The total number of objects in the results. [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) -a| +a¦ *resultSize* + _optional_ -a| +a¦ [markdown] -- @@ -1861,13 +1859,13 @@ The total number of bytes in the results. [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) -a| +a¦ *errorCount* + _optional_ -a| +a¦ [markdown] -- @@ -1876,13 +1874,13 @@ The number of errors that occurred during the request. [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) -a| +a¦ *warningCount* + _optional_ -a| +a¦ [markdown] -- @@ -1891,7 +1889,7 @@ The number of warnings that occurred during the request. [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) |=== @@ -1931,14 +1929,14 @@ endif::collapse-models[] //tag::ResponsesLocal[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *plans* + _optional_ -a| +a¦ [markdown] -- @@ -1947,13 +1945,13 @@ include::index.adoc[tag=desc-ResponsesLocalPlans, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ <> -a| +a¦ *metrics* + _optional_ -a| +a¦ [markdown] -- @@ -1962,7 +1960,7 @@ include::index.adoc[tag=desc-ResponsesLocalYardsticks, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ <> |=== @@ -2007,14 +2005,14 @@ An object containing the query plans, if requested. //end::desc-ResponsesLocalPlans[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *logicalPlan* + _optional_ -a| +a¦ [markdown] -- @@ -2023,13 +2021,13 @@ The logical plan. [%hardbreaks] {blank} -a| Object +a¦ Object -a| +a¦ *optimizedLogicalPlan* + _optional_ -a| +a¦ [markdown] -- @@ -2038,13 +2036,13 @@ The optimized logical plan. [%hardbreaks] {blank} -a| Object +a¦ Object -a| +a¦ *rewrittenExpressionTree* + _optional_ -a| +a¦ [markdown] -- @@ -2053,13 +2051,13 @@ The rewritten expression tree. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *expressionTree* + _optional_ -a| +a¦ [markdown] -- @@ -2068,13 +2066,13 @@ The expression tree. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *job* + _optional_ -a| +a¦ [markdown] -- @@ -2083,7 +2081,7 @@ The job details. [%hardbreaks] {blank} -a| Object +a¦ Object |=== @@ -2128,14 +2126,14 @@ An object containing metrics about the request. //end::desc-ResponsesLocalYardsticks[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *processedObjects* + _optional_ -a| +a¦ [markdown] -- @@ -2144,7 +2142,7 @@ Number of processed tuples during query execution. [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) |=== @@ -2231,3 +2229,4 @@ include::{specDir}security/document-end.adoc[opts=optional] // markup not found, no include::{specDir}security/document-after.adoc[opts=optional] + diff --git a/docs/modules/analytics-rest-settings/pages/index.adoc b/docs/modules/analytics-rest-settings/pages/index.adoc index e5e945d8..da1f049d 100644 --- a/docs/modules/analytics-rest-settings/pages/index.adoc +++ b/docs/modules/analytics-rest-settings/pages/index.adoc @@ -59,7 +59,7 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* @@ -70,7 +70,7 @@ The host name or IP address of a node running the Analytics service. [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* @@ -81,7 +81,7 @@ The Cluster administration REST port. Use `18091` for secure access. Note that [%hardbreaks] *Values:* `8091`, `18091` -*Example:* `pass:c[8091]` +*Example:* `+++8091+++` // end |=== @@ -174,6 +174,12 @@ Retrieves cluster-level Analytics settings. Note that only one setting is availa include::{specDir}paths/get_settings/operation-description-end.adoc[opts=optional] + + +[#get_settings-produces] +.Produces +* application/json + :leveloffset: -1 @@ -191,12 +197,6 @@ include::{specDir}paths/get_settings/operation-description-end.adoc[opts=optiona // markup not found, no include::{specDir}paths/get_settings/operation-parameters-after.adoc[opts=optional] -[#get_settings-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_settings/operation-responses-before.adoc[opts=optional] @@ -327,6 +327,15 @@ Sets cluster-level Analytics settings. Note that only one setting is available: include::{specDir}paths/post_settings/operation-description-end.adoc[opts=optional] + +[#post_settings-consumes] +.Consumes +* application/x-www-form-urlencoded + +[#post_settings-produces] +.Produces +* application/json + :leveloffset: -1 @@ -352,13 +361,13 @@ include::{specDir}paths/post_settings/operation-description-end.adoc[opts=option .Form Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *numReplicas* + +a¦ *numReplicas* + _optional_ -a| +a¦ [markdown] @@ -371,7 +380,7 @@ Specifies the number of replicas for Analytics. *Maximum:* `3` {blank} -a| Integer +a¦ Integer @@ -389,16 +398,6 @@ a| Integer // markup not found, no include::{specDir}paths/post_settings/operation-parameters-after.adoc[opts=optional] -[#post_settings-produces] -= Produces - -* application/json - -[#post_settings-consumes] -= Consumes - -* application/x-www-form-urlencoded - // markup not found, no include::{specDir}paths/post_settings/operation-responses-before.adoc[opts=optional] @@ -559,14 +558,14 @@ endif::collapse-models[] //tag::Settings[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *numReplicas* + _optional_ -a| +a¦ [markdown] -- @@ -578,7 +577,7 @@ Specifies the number of replicas for Analytics. *Maximum:* `3` *Example:* `3` {blank} -a| Integer +a¦ Integer |=== @@ -663,3 +662,4 @@ include::{specDir}security/document-end.adoc[opts=optional] // markup not found, no include::{specDir}security/document-after.adoc[opts=optional] + diff --git a/docs/modules/eventing-rest-api/pages/index.adoc b/docs/modules/eventing-rest-api/pages/index.adoc new file mode 100644 index 00000000..8ea2f439 --- /dev/null +++ b/docs/modules/eventing-rest-api/pages/index.adoc @@ -0,0 +1,8582 @@ += Eventing REST API +:keywords: OpenAPI, REST +:specDir: partial$ +:snippetDir: partial$paths/ +:page-topic-type: reference +:page-toclevels: 2 +include::partial$header-attributes.adoc[opts=optional] + +[comment] +This file is created automatically by OpenAPI Generator. +DO NOT EDIT! See https://github.com/couchbase/cb-swagger + +:leveloffset: 1 + +include::{specDir}overview/document-before.adoc[opts=optional] + + +[[overview]] += Overview + +:leveloffset: +1 + +// markup not found, no include::{specDir}overview/document-begin.adoc[opts=optional] + + +[markdown] +-- +The Eventing REST API provides methods to work with and manipulate Couchbase Eventing functions. +-- + +[discrete#version] += Version information +[%hardbreaks] +__Version__ : 7.6 + +[discrete#host] += Host information + +.... +{scheme}://{host}:{port} +.... + +[markdown] +-- +The URL scheme, host, and port are as follows. +-- + +[cols="20,80"] +|=== +| Component | Description + +a| *scheme* +a| [markdown] +-- +The URL scheme. Use `https` for secure access. +-- + +[%hardbreaks] +*Values:* `http`, `https` +*Example:* `+++http+++` +// end + +a| *host* +a| [markdown] +-- +The host name or IP address of a node running the Eventing service. +-- + +[%hardbreaks] + +*Example:* `+++localhost+++` +// end + +a| *port* +a| [markdown] +-- +The Eventing service REST port. Use `18096` for secure access. +-- + +[%hardbreaks] +*Values:* `8096`, `18096` +*Example:* `+++8096+++` +// end + +|=== + + +include::{specDir}overview/document-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}overview/document-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/document-before.adoc[opts=optional] + + +[[resources]] += Resources + +:count-apis: 7 + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/document-begin.adoc[opts=optional] + + +This section describes the operations available with this REST API. +ifeval::[{count-apis} > 1] +The operations are grouped in the following categories. + +[%hardbreaks] +<> +<> +<> +<> +<> +<> +<> +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Activation] += Activation +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +<> +<> +<> +<> + + + +// markup not found, no 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] + + +.... +POST /api/v1/functions/{function}/deploy +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Deploys an undeployed function. +This is the preferred invocation. +-- + + +// markup not found, no include::{specDir}paths/basic_deploy/operation-description-end.adoc[opts=optional] + + + + +:leveloffset: -1 + + +// 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] + + +[#basic_deploy-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/basic_deploy/operation-parameters-begin.adoc[opts=optional] + + +[#basic_deploy-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *function* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + +[#basic_deploy-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/basic_deploy/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/basic_deploy/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}basic_deploy/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/basic_deploy/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +POST /api/v1/functions/{function}/pause +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Pauses a function and creates a DCP checkpoint such that on a subsequent resume no mutations will be lost. +This is the preferred invocation. +-- + + +// markup not found, no include::{specDir}paths/basic_pause/operation-description-end.adoc[opts=optional] + + + + +:leveloffset: -1 + + +// 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] + + +[#basic_pause-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/basic_pause/operation-parameters-begin.adoc[opts=optional] + + +[#basic_pause-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *function* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + +[#basic_pause-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/basic_pause/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/basic_pause/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}basic_pause/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/basic_pause/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +POST /api/v1/functions/(function}/resume +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Resumes a paused function from its paused DCP checkpoint. +This is the preferred invocation. +-- + + +// 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] + + + +// markup not found, no 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] + + +[#basic_resume-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *function* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + +[#basic_resume-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/basic_resume/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/basic_resume/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}basic_resume/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/basic_resume/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +POST /api/v1/functions/{function}/undeploy +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Undeploys a function. +This is the preferred invocation. +-- + + +// markup not found, no include::{specDir}paths/basic_undeploy/operation-description-end.adoc[opts=optional] + + + + +:leveloffset: -1 + + +// 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] + + +[#basic_undeploy-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/basic_undeploy/operation-parameters-begin.adoc[opts=optional] + + +[#basic_undeploy-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *function* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + +[#basic_undeploy-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/basic_undeploy/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/basic_undeploy/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}basic_undeploy/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/basic_undeploy/operation-after.adoc[opts=optional] + + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Advanced] += Advanced +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +<> +<> +<> +<> +<> +<> +<> +<> +<> +<> +<> +<> +<> +<> + + + +// markup not found, no 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] + + +.... +POST /api/v1/functions/{function} +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Creates or imports a single function. +-- + + +// markup not found, no include::{specDir}paths/adv_function_import/operation-description-end.adoc[opts=optional] + + +[#adv_function_import-consumes] +.Consumes +* application/json + + +:leveloffset: -1 + + +// markup not found, no 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] + + +[#adv_function_import-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_function_import/operation-parameters-begin.adoc[opts=optional] + + +[#adv_function_import-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *function* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + +[#adv_function_import-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + +[#adv_function_import-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_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] +{blank} + +a¦ <> + + + +|=== + + +// markup not found, no include::{specDir}paths/adv_function_import/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no 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] + + +[#adv_function_import-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_function_import/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/adv_function_import/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_function_import/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}adv_function_import/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_function_import/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +POST /api/v1/functions +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Creates or imports multiple functions. + +Note that 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] + + +[#adv_function_import_all-consumes] +.Consumes +* application/json + + +:leveloffset: -1 + + +// markup not found, no 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] + + +[#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] + + + + + + +[#adv_function_import_all-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_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] +{blank} + +a¦ <> + + + +|=== + + +// markup not found, no include::{specDir}paths/adv_function_import_all/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no 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] + + +[#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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> + +|=== + + +// markup not found, no 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::{snippetDir}adv_function_import_all/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_function_import_all/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +GET /api/v1/functions/{function} +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Provides a listing of a complete function definition available in the cluster. +The function could be in any state: deployed, undeployed, or paused. +If saved to a file the function definition can be imported into the cluster or a different cluster. +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] + + + +[#adv_function_view-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no 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] + + +[#adv_function_view-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_function_view/operation-parameters-begin.adoc[opts=optional] + + +[#adv_function_view-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *function* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + +[#adv_function_view-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Returns a single function definition object. +-- +a| <> + + +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/adv_function_view/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no 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] + + +[#adv_function_view-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_function_view/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/adv_function_view/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_function_view/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}adv_function_view/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_function_view/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +GET /api/v1/functions +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Provides an array of definitions of all functions available in the cluster. +The functions may be in any state: deployed, undeployed, or paused. +If saved to a file the function definitions can be imported into the cluster or a different cluster. +However any changes to the function definition made to the file outside the UI are discouraged. + +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] + + + +[#adv_function_view_all-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_function_view_all/operation-description-after.adoc[opts=optional] + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Returns an array containing one or more function definition objects. +-- +a| <> + array + +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/adv_function_view_all/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no 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] + + +[#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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> + +|=== + + +// markup not found, no 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::{snippetDir}adv_function_view_all/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_function_view_all/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +DELETE /api/v1/functions/{function} +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Deletes a specific function from the cluster. + +WARNING: Use this API with caution, as it is irreversible. +-- + + +// 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] + + + +// markup not found, no 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] + + +[#adv_function_zap-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *function* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + +[#adv_function_zap-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/adv_function_zap/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_function_zap/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}adv_function_zap/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_function_zap/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +DELETE /api/v1/functions +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Deletes **all functions** from the cluster. +WARNING: Use this API with caution, as it is 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. +-- + + +// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-description-end.adoc[opts=optional] + + + + +:leveloffset: -1 + + +// 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] + + + + + + +// markup not found, no 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] + + +[#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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> + +|=== + + +// markup not found, no 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::{snippetDir}adv_function_zap_all/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +GET /api/v1/export +.... + + + +// markup not found, no 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] + + +[markdown] +-- +This is a convenience method to export all function definitions. +Exported functions are always set to the undeployed state at the time of export, regardless of their state in the cluster. +If saved to a file the function definitions can be imported into the cluster or a different cluster. +However any changes to the function definition made to the file outside the UI are discouraged. + +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] + + + +[#adv_multiple_export-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_multiple_export/operation-description-after.adoc[opts=optional] + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Returns an array containing one or more function definition objects. +-- +a| <> + array + +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/adv_multiple_export/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no 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] + + +[#adv_multiple_export-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_multiple_export/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> + +|=== + + +// markup not found, no 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::{snippetDir}adv_multiple_export/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_multiple_export/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +POST /api/v1/import +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Imports multiple functions. + +Note that 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] + + +[#adv_multiple_import-consumes] +.Consumes +* application/json + + +:leveloffset: -1 + + +// markup not found, no 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] + + +[#adv_multiple_import-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_multiple_import/operation-parameters-begin.adoc[opts=optional] + + + + + + +[#adv_multiple_import-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_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] +{blank} + +a¦ <> + + + +|=== + + +// markup not found, no include::{specDir}paths/adv_multiple_import/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no 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] + + +[#adv_multiple_import-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_multiple_import/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> + +|=== + + +// markup not found, no 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::{snippetDir}adv_multiple_import/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_multiple_import/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +GET /api/v1/functions/{function}/settings +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Return or export the full settings for one eventing function in the cluster. +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] + + + +[#adv_settings_get-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no 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] + + +[#adv_settings_get-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_settings_get/operation-parameters-begin.adoc[opts=optional] + + +[#adv_settings_get-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *function* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + +[#adv_settings_get-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Returns an object showing settings for the specified function. +-- +a| <> + + +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/adv_settings_get/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no 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] + + +[#adv_settings_get-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_settings_get/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/adv_settings_get/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_settings_get/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}adv_settings_get/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_settings_get/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +POST /api/v1/functions/{function}/settings +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Updates an undeployed or paused function with the provided settings. +You can only alter settings when the function is paused or undeployed; attempting to adjust a deployed function will result in an error. +During an edit, settings provided are merged. +Unspecified attributes retain their prior values. + +Note that you must always specify `deployment_status` and `processing_status` when using this REST endpoint to update any option or set of options. +To get the current values of `deployment_status` and `processing_status`, see [View All Functions Status](#status_all) or [View Function Status](#status_function). + +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] + + +[#adv_settings_update-consumes] +.Consumes +* application/json + + +:leveloffset: -1 + + +// markup not found, no 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] + + +[#adv_settings_update-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_settings_update/operation-parameters-begin.adoc[opts=optional] + + +[#adv_settings_update-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *function* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + +[#adv_settings_update-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + +[#adv_settings_update-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_required_ +a¦ + + +[markdown] +-- +An object providing settings for the specified function. +-- + +[%hardbreaks] +{blank} + +a¦ <> + + + +|=== + + +// markup not found, no include::{specDir}paths/adv_settings_update/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no 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] + + +[#adv_settings_update-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_settings_update/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/adv_settings_update/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_settings_update/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}adv_settings_update/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_settings_update/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +GET /api/v1/functions/{function}/config +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Export or return the configuration of the source keyspace and the eventing storage (metadata) keyspace for the specified function. +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] + + + +[#adv_structure_get-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no 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] + + +[#adv_structure_get-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_structure_get/operation-parameters-begin.adoc[opts=optional] + + +[#adv_structure_get-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *function* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + +[#adv_structure_get-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Returns an object showing the configuration of the specified function. +-- +a| <> + + +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/adv_structure_get/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no 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] + + +[#adv_structure_get-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_structure_get/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/adv_structure_get/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_structure_get/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}adv_structure_get/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_structure_get/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +POST /api/v1/functions/{function}/config +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Import the configuration and alter the source keyspace and the eventing storage (metadata) keyspace for the specified function. +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] + + +[#adv_structure_update-consumes] +.Consumes +* application/json + + +:leveloffset: -1 + + +// markup not found, no 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] + + +[#adv_structure_update-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_structure_update/operation-parameters-begin.adoc[opts=optional] + + +[#adv_structure_update-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *function* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + +[#adv_structure_update-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + +[#adv_structure_update-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_required_ +a¦ + + +[markdown] +-- +An object providing the configuration for the specified function. +-- + +[%hardbreaks] +{blank} + +a¦ <> + + + +|=== + + +// markup not found, no include::{specDir}paths/adv_structure_update/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no 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] + + +[#adv_structure_update-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_structure_update/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/adv_structure_update/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_structure_update/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}adv_structure_update/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_structure_update/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +GET /api/v1/functions/{function}/appcode +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Export only the JavaScript code for the specified function. +Note that unlike [View a Function](#adv_function_view), the JavaScript is not escaped, and the code is runnable in other environments. +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] + + + +[#adv_text_get-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no 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] + + +[#adv_text_get-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_text_get/operation-parameters-begin.adoc[opts=optional] + + +[#adv_text_get-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *function* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + +[#adv_text_get-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Returns a string showing the code for the specified function. +-- +a| String + + +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/adv_text_get/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_text_get/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}adv_text_get/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_text_get/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +POST /api/v1/functions/{function}/appcode +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Import only the JavaScript code for the specified function. +Note that unlike [Create or Import Function](#adv_function_import), the JavaScript is not escaped and could come from other environments. +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] + + +[#adv_text_update-consumes] +.Consumes +* application/json + + +:leveloffset: -1 + + +// markup not found, no 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] + + +[#adv_text_update-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/adv_text_update/operation-parameters-begin.adoc[opts=optional] + + +[#adv_text_update-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *function* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + +[#adv_text_update-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + +[#adv_text_update-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_required_ +a¦ + + +[markdown] +-- +A string providing the code for the specified function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/adv_text_update/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_text_update/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}adv_text_update/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/adv_text_update/operation-after.adoc[opts=optional] + + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-GlobalConfig] += Global Config +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +<> +<> + + + +// markup not found, no include::{specDir}paths/config_get/operation-before.adoc[opts=optional] + + +[#config_get] += List Global Config + +:leveloffset: +1 + +// markup not found, no 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] + + +[#config_get-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/config_get/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Shows all global configuration settings. +There are currently just two settings: `enable_debugger` and `ram_quota`. +Both of these settings can also be adjusted via the UI. +-- + + +// markup not found, no include::{specDir}paths/config_get/operation-description-end.adoc[opts=optional] + + + +[#config_get-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no 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] + + + + + + +// markup not found, no 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] + + +[#config_get-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/config_get/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Returns an object showing the global configuration settings. +-- +a| <> + + +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/config_get/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no 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] + + +[#config_get-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/config_get/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/config_get/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/config_get/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}config_get/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/config_get/operation-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}paths/config_update/operation-before.adoc[opts=optional] + + +[#config_update] += Modify Global Config + +:leveloffset: +1 + +// markup not found, no 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] + + +[#config_update-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/config_update/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Modify global configuration settings. +During an edit, settings provided are merged. +Unspecified attributes retain their prior values. +The response indicates whether the Eventing service must be restarted for the new changes to take effect. +-- + + +// markup not found, no include::{specDir}paths/config_update/operation-description-end.adoc[opts=optional] + + +[#config_update-consumes] +.Consumes +* application/json + + +: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] + + +[#config_update-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/config_update/operation-parameters-begin.adoc[opts=optional] + + + + + + +[#config_update-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_required_ +a¦ + + +[markdown] +-- +An object providing the global configuration settings. +-- + +[%hardbreaks] +{blank} + +a¦ <> + + + +|=== + + +// markup not found, no include::{specDir}paths/config_update/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no 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] + + +[#config_update-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/config_update/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/config_update/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/config_update/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}config_update/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/config_update/operation-after.adoc[opts=optional] + + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-List] += List +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +<> +<> + + + +// markup not found, no 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] + + +.... +GET /api/v1/list/functions +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Returns a list (array) of the names of all Eventing functions in the cluster. +The returned list can also be filtered — see [List Filtered Functions](#list_query). + +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/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] + + + + + + +// markup not found, no 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] + + +[#list_all-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/list_all/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> + +|=== + + +// markup not found, no 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::{snippetDir}list_all/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/list_all/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +GET /api/v1/list/functions/query +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Returns a list (array) of the names of all Eventing functions in the cluster. +The returned list can be filtered by the following: + +- Deployed status : in this case, paused is considered deployed. +- Source bucket: the listen to keyspace. +- Function type: whether the function modifies its own listen to keyspace. + +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/list_query/operation-description-end.adoc[opts=optional] + + + + +:leveloffset: -1 + + +// 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] + + +[#list_query-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/list_query/operation-parameters-begin.adoc[opts=optional] + + + +[#list_query-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *deployed* + +_optional_ +a¦ + + +[markdown] +-- +If `true`, returns the names of all deployed (or paused) functions. +If `false`, returns the names of all undeployed functions. +-- + +[%hardbreaks] +{blank} + +a¦ Boolean + + + +a¦ *source_bucket* + +_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. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *function_type* + +_optional_ +a¦ + + +[markdown] +-- +The function type. + +- `sbm`: Returns the names of Eventing functions in the cluster that modify their own source keyspace. +- `notsbm`: Returns the names of Eventing functions in the cluster that do not modify their own source keyspace. +-- + +[%hardbreaks] +*Values:* `"sbm"`, `"notsbm"` +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> + +|=== + + +// markup not found, no 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::{snippetDir}list_query/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/list_query/operation-after.adoc[opts=optional] + + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Logging] += Logging +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +<> + + + +// markup not found, no 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] + + +.... +GET /getAppLog +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Returns the most recent application log messages for the specified function. +-- + + +// 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] + + + +// markup not found, no 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] + + + +[#log_view-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *name* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *aggregate* + +_optional_ +a¦ + + +[markdown] +-- +If `false`, the API accesses a single Eventing node. +If `true`, the API accesses all Eventing nodes. +-- + +[%hardbreaks] +*Default:* `false` +{blank} + +a¦ Boolean + + + +a¦ *size* + +_optional_ +a¦ + + +[markdown] +-- +The approximate amount of logging information returned. +Note that 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. +-- + +[%hardbreaks] +*Default:* `40960` +{blank} + +a¦ Integer + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/log_view/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/log_view/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}log_view/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/log_view/operation-after.adoc[opts=optional] + + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Statistics] += Statistics +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +<> +<> +<> +<> +<> + + + +// markup not found, no 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] + + +.... +GET /api/v1/stats +.... + + + +// markup not found, no 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] + + +[markdown] +-- +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. +-- + + +// markup not found, no include::{specDir}paths/stats_all/operation-description-end.adoc[opts=optional] + + + + +:leveloffset: -1 + + +// 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] + + +[#stats_all-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/stats_all/operation-parameters-begin.adoc[opts=optional] + + + +[#stats_all-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *type* + +_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. + +Omitting this parameter excludes `dcp_event_backlog_per_vb`, `doc_timer_debug_stats`, `latency_stats`, `plasma_stats`, and `seqs_processed` from the response. +-- + +[%hardbreaks] +*Values:* `"full"` +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> + +|=== + + +// markup not found, no 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::{snippetDir}stats_all/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/stats_all/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +GET /getExecutionStats +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Retrieve only execution statistics. +This returns the subset of statistics for the node. +-- + + +// 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] + + + +// markup not found, no 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] + + + +[#stats_execution-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *name* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/stats_execution/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/stats_execution/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}stats_execution/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/stats_execution/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +GET /getFailureStats +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Retrieve only failure statistics. +This returns the subset of statistics for the node. +-- + + +// markup not found, no include::{specDir}paths/stats_failure/operation-description-end.adoc[opts=optional] + + + + +:leveloffset: -1 + + +// 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] + + +[#stats_failure-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/stats_failure/operation-parameters-begin.adoc[opts=optional] + + + +[#stats_failure-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *name* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/stats_failure/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/stats_failure/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}stats_failure/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/stats_failure/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +GET /getLatencyStats +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Retrieve only latency statistics. +This returns the subset of statistics for the node. +-- + + +// markup not found, no include::{specDir}paths/stats_latency/operation-description-end.adoc[opts=optional] + + + + +:leveloffset: -1 + + +// 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] + + +[#stats_latency-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/stats_latency/operation-parameters-begin.adoc[opts=optional] + + + +[#stats_latency-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *name* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/stats_latency/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/stats_latency/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}stats_latency/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/stats_latency/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +GET /resetStatsCounters +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Resets statistics for the specified function. +-- + + +// 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] + + + +// markup not found, no 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] + + + +[#stats_reset-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *appName* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/stats_reset/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/stats_reset/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}stats_reset/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/stats_reset/operation-after.adoc[opts=optional] + + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Status] += Status +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +<> +<> + + + +// markup not found, no 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] + + +.... +GET /api/v1/status +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Returns a list (array) of all eventing functions, showing their corresponding `composite_status`. +A function's status can have one of the following values: undeployed, deploying, deployed, undeploying, paused, and pausing. +Note that there is no value of resuming; when resuming a paused eventing function, the `composite_status` returns `deploying` until it reaches the deployed state. + +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/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] + + + + + + +// markup not found, no 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] + + +[#status_all-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/status_all/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> + +|=== + + +// markup not found, no 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::{snippetDir}status_all/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/status_all/operation-after.adoc[opts=optional] + + + + +// markup not found, no 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] + + +.... +GET /api/v1/status/{function} +.... + + + +// markup not found, no 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] + + +[markdown] +-- +Returns the specified function, showing its corresponding `composite_status`. +It can have one of the following values: undeployed, deploying, deployed, undeploying, paused, and pausing. +Note that there is no value of resuming; when resuming a paused eventing function, the `composite_status` returns `deploying` until it reaches the deployed state. +-- + + +// markup not found, no include::{specDir}paths/status_function/operation-description-end.adoc[opts=optional] + + + + +:leveloffset: -1 + + +// 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] + + +[#status_function-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/status_function/operation-parameters-begin.adoc[opts=optional] + + +[#status_function-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *function* + +_required_ +a¦ + + +[markdown] +-- +The name of a function. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + +[#status_function-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The bucket to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped functions only. +The scope to which the function belongs. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| +| 404 +a| [markdown] +-- +Failure. +-- +a| + +|=== + + +// markup not found, no 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] + + + +// markup not found, no 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] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| <> +| http (basic) +| <> + +|=== + + +// markup not found, no include::{specDir}paths/status_function/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/status_function/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}status_function/http-request.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] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/status_function/operation-after.adoc[opts=optional] + + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + + +// markup not found, no include::{specDir}paths/document-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/document-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}definitions/document-before.adoc[opts=optional] + + +[#models] += Definitions + +:count-models: 10 + +:leveloffset: +1 + +// markup not found, no 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[] +[.two-columns] +endif::collapse-models[] +[%hardbreaks] +<> +<> +<> +<> +<> +<> +<> +<> +<> +<> +endif::[] + + + +include::{specDir}definitions/AddFunction/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#AddFunction] += Function Request + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/AddFunction/definition-begin.adoc[opts=optional] + + +.icon:bars[fw] Composite Schema +{blank} + +One of the following: + +* <> + + +* <> + array + + + +// markup not found, no include::{specDir}definitions/AddFunction/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/AddFunction/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/AddFunctions/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#AddFunctions] += Functions Request + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/AddFunctions/definition-begin.adoc[opts=optional] + + +.icon:bars[fw] Composite Schema +{blank} + +One of the following: + +* <> + + +* <> + array + + + +// markup not found, no include::{specDir}definitions/AddFunctions/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/AddFunctions/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/depcfg_schema/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#depcfg_schema] += Deployment Config + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/depcfg_schema/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//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] +-- +-- + +[%hardbreaks] +{blank} +a¦ <> + array + +a¦ +*curl* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ <> + array + +a¦ +*metadata_bucket* + +_required_ +a¦ + +[markdown] +-- +bucket to store eventing checkpoints and timers +-- + +[%hardbreaks] +*Minimum length:* `1` +{blank} +a¦ String + + +a¦ +*metadata_scope* + +_optional_ +a¦ + +[markdown] +-- +scope to store eventing checkpoints and timers +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*metadata_collection* + +_optional_ +a¦ + +[markdown] +-- +collection to store eventing checkpoints and timers +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*source_bucket* + +_required_ +a¦ + +[markdown] +-- +bucket to listen to for document mutations +-- + +[%hardbreaks] +*Minimum length:* `1` +{blank} +a¦ String + + +a¦ +*source_scope* + +_optional_ +a¦ + +[markdown] +-- +scope to listen to for document mutations +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*source_collection* + +_optional_ +a¦ + +[markdown] +-- +collection to listen to for document mutations +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*constants* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ <> + array + +|=== + +//end::depcfg_schema[] + + + + +// markup not found, no 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] + + + + +// markup not found, no include::{specDir}definitions/depcfg_schema_constants_inner/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#depcfg_schema_constants_inner] += Deployment Constants + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/depcfg_schema_constants_inner/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::depcfg_schema_constants_inner[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*value* + +_required_ +a¦ + +[markdown] +-- +alias name of the constant binding +-- + +[%hardbreaks] +*Pattern:* `+++/^[a-zA-Z_$][a-zA-Z0-9_$]*$/+++` +*Minimum length:* `1` +*Maximum length:* `64` +{blank} +a¦ String + + +a¦ +*literal* + +_required_ +a¦ + +[markdown] +-- +literal value bound to the alias name +-- + +[%hardbreaks] +*Minimum length:* `1` +{blank} +a¦ String + + +|=== + +//end::depcfg_schema_constants_inner[] + + + + +// markup not found, no 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] + + + + +// markup not found, no include::{specDir}definitions/depcfg_schema_buckets_inner/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#depcfg_schema_buckets_inner] += Deployment Keyspace + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/depcfg_schema_buckets_inner/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::depcfg_schema_buckets_inner[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*alias* + +_required_ +a¦ + +[markdown] +-- +symbolic name used in code to refer to this binding +-- + +[%hardbreaks] +*Pattern:* `+++/^[a-zA-Z_$][a-zA-Z0-9_$]*$/+++` +*Minimum length:* `1` +*Maximum length:* `64` +{blank} +a¦ String + + +a¦ +*bucket_name* + +_required_ +a¦ + +[markdown] +-- +name of the bucket this binding maps to +-- + +[%hardbreaks] +*Minimum length:* `1` +{blank} +a¦ String + + +a¦ +*scope_name* + +_optional_ +a¦ + +[markdown] +-- +name of the scope this binding maps to +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*collection_name* + +_optional_ +a¦ + +[markdown] +-- +name of the collection this binding maps to +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*access* + +_required_ +a¦ + +[markdown] +-- +bucket access level (read or read+write) +-- + +[%hardbreaks] +*Values:* `"r"`, `"rw"` +{blank} +a¦ String + + +|=== + +//end::depcfg_schema_buckets_inner[] + + + + +// markup not found, no 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] + + + + +// markup not found, no include::{specDir}definitions/depcfg_schema_curl_inner/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#depcfg_schema_curl_inner] += Deployment URL + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/depcfg_schema_curl_inner/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::depcfg_schema_curl_inner[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*hostname* + +_required_ +a¦ + +[markdown] +-- +full URL (including any path) that this binding connects +-- + +[%hardbreaks] +*Pattern:* `+++/^https?:\/\//+++` +*Minimum length:* `1` +{blank} +a¦ URI (uri) + + +a¦ +*value* + +_required_ +a¦ + +[markdown] +-- +symbolic name used in code to refer to this binding +-- + +[%hardbreaks] +*Pattern:* `+++/^[a-zA-Z_$][a-zA-Z0-9_$]*$/+++` +*Minimum length:* `1` +*Maximum length:* `64` +{blank} +a¦ String + + +a¦ +*auth_type* + +_required_ +a¦ + +[markdown] +-- +http authentication method to use with this endpoint +-- + +[%hardbreaks] +*Values:* `"no-auth"`, `"basic"`, `"bearer"`, `"digest"` +{blank} +a¦ String + + +a¦ +*username* + +_optional_ +a¦ + +[markdown] +-- +username for http auth methods that use it +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*password* + +_optional_ +a¦ + +[markdown] +-- +password for http auth methods that use it +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*bearer_key* + +_optional_ +a¦ + +[markdown] +-- +bearer key for bearer auth +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*allow_cookies* + +_required_ +a¦ + +[markdown] +-- +allow cookies on the session +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*validate_ssl_certificate* + +_required_ +a¦ + +[markdown] +-- +validate remote server certificate using OS mechanisms +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +|=== + +//end::depcfg_schema_curl_inner[] + + + + +// markup not found, no 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] + + + + +// markup not found, no include::{specDir}definitions/handler_schema/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#handler_schema] += Function Definition + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/handler_schema/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::handler_schema[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*appcode* + +_required_ +a¦ + +[markdown] +-- +handler code +-- + +[%hardbreaks] +*Minimum length:* `1` +{blank} +a¦ String + + +a¦ +*depcfg* + +_required_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-depcfg_schema, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ <> + + +a¦ +*version* + +_required_ +a¦ + +[markdown] +-- +authoring tool. use 'external' if authored or edited outside eventing ui +-- + +[%hardbreaks] +*Pattern:* `+++/^evt-[5-7].[0-9]+.[0-9]+-[0-9]{4}-(ee|ce)$/+++` +{blank} +a¦ String + + +a¦ +*enforce_schema* + +_optional_ +a¦ + +[markdown] +-- +enforces stricter validation for all settings and configuration fields. +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*handleruuid* + +_optional_ +a¦ + +[markdown] +-- +unique id of the the handler. generated by server +-- + +[%hardbreaks] +*Minimum:* `0` +{blank} +a¦ Integer + + +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] +-- +-- + +[%hardbreaks] +*Pattern:* `+++/^[a-zA-Z0-9][a-zA-Z0-9_-]*$/+++` +*Minimum length:* `1` +*Maximum length:* `100` +{blank} +a¦ String + + +a¦ +*settings* + +_required_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-settings_schema, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ <> + + +a¦ +*function_scope* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-function_scope_schema, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ <> + + +|=== + +//end::handler_schema[] + + + + +// markup not found, no 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] + + + + +// markup not found, no include::{specDir}definitions/function_scope_schema/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#function_scope_schema] += Function Scope + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/function_scope_schema/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//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] +-- +bucket to which function belongs +-- + +[%hardbreaks] +*Minimum length:* `1` +{blank} +a¦ String + + +a¦ +*scope* + +_required_ +a¦ + +[markdown] +-- +scope to which function belongs +-- + +[%hardbreaks] +*Minimum length:* `1` +{blank} +a¦ String + + +|=== + +//end::function_scope_schema[] + + + + +// markup not found, no 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] + + + + +// markup not found, no include::{specDir}definitions/settings_schema/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#settings_schema] += Function Settings + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/settings_schema/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::settings_schema[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*cpp_worker_thread_count* + +_optional_ +a¦ + +[markdown] +-- +number of threads each worker utilizes +-- + +[%hardbreaks] +*Minimum:* `1` +{blank} +a¦ Integer + + +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 +-- + +[%hardbreaks] +*Values:* `"everything"`, `"from_now"` +{blank} +a¦ String + + +a¦ +*deployment_status* + +_optional_ +a¦ + +[markdown] +-- +indicates if the function is deployed. true=deployed, false=undeployed +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*description* + +_optional_ +a¦ + +[markdown] +-- +free form text for user to describe the handler. no functional role +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*execution_timeout* + +_optional_ +a¦ + +[markdown] +-- +maximum time the handler can run before it is forcefully terminated (in seconds) +-- + +[%hardbreaks] +*Minimum:* `1` +{blank} +a¦ Integer + + +a¦ +*on_deploy_timeout* + +_optional_ +a¦ + +[markdown] +-- +maximum time the OnDeploy handler can run before it is terminated (in seconds) +-- + +[%hardbreaks] +*Minimum:* `1` +{blank} +a¦ Integer + + +a¦ +*language_compatibility* + +_optional_ +a¦ + +[markdown] +-- +eventing language version this handler assumes in terms of syntax and behavior +-- + +[%hardbreaks] +*Values:* `"6.6.2"`, `"6.0.0"`, `"6.5.0"`, `"7.2.0"` +{blank} +a¦ String + + +a¦ +*lcb_inst_capacity* + +_optional_ +a¦ + +[markdown] +-- +maximum number of libcouchbase connections that may be opened and pooled +-- + +[%hardbreaks] +*Minimum:* `1` +{blank} +a¦ Integer + + +a¦ +*lcb_retry_count* + +_optional_ +a¦ + +[markdown] +-- +number of retries of retriable libcouchbase failures. 0 keeps trying till execution_timeout +-- + +[%hardbreaks] +*Minimum:* `0` +{blank} +a¦ Integer + + +a¦ +*lcb_timeout* + +_optional_ +a¦ + +[markdown] +-- +maximum time the lcb command is waited until completion before we terminate the request(in seconds) +-- + +[%hardbreaks] +*Minimum:* `1` +{blank} +a¦ Integer + + +a¦ +*log_level* + +_optional_ +a¦ + +[markdown] +-- +level of detail in system logging +-- + +[%hardbreaks] +*Values:* `"INFO"`, `"ERROR"`, `"WARNING"`, `"DEBUG"`, `"TRACE"` +{blank} +a¦ String + + +a¦ +*n1ql_consistency* + +_optional_ +a¦ + +[markdown] +-- +consistency level used by n1ql statements in the handler +-- + +[%hardbreaks] +*Values:* `"none"`, `"request"` +{blank} +a¦ String + + +a¦ +*num_timer_partitions* + +_optional_ +a¦ + +[markdown] +-- +number of timer shards. defaults to number of vbuckets +-- + +[%hardbreaks] +*Values:* `1`, `2`, `4`, `8`, `16`, `32`, `64`, `128`, `256`, `512`, `1024` +{blank} +a¦ Integer + + +a¦ +*processing_status* + +_optional_ +a¦ + +[markdown] +-- +indicates if the function is running (i.e., not paused). true=running, false=paused +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*sock_batch_size* + +_optional_ +a¦ + +[markdown] +-- +batch size for messages from producer to consumer. normally, this must not be specified +-- + +[%hardbreaks] +*Minimum:* `1` +{blank} +a¦ Integer + + +a¦ +*tick_duration* + +_optional_ +a¦ + +[markdown] +-- +duration to log stats from this handler, in milliseconds +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*timer_context_size* + +_optional_ +a¦ + +[markdown] +-- +size limit of timer context object +-- + +[%hardbreaks] +*Minimum:* `20` +*Maximum:* `20971520` +{blank} +a¦ Integer + + +a¦ +*user_prefix* + +_optional_ +a¦ + +[markdown] +-- +key prefix for all data stored in metadata by this handler +-- + +[%hardbreaks] +*Minimum length:* `1` +{blank} +a¦ String + + +a¦ +*worker_count* + +_optional_ +a¦ + +[markdown] +-- +number of worker processes handler utilizes on each eventing node +-- + +[%hardbreaks] +*Minimum:* `1` +{blank} +a¦ Integer + + +a¦ +*n1ql_prepare_all* + +_optional_ +a¦ + +[markdown] +-- +automatically prepare all n1ql statements in the handler +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +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] +-- +code to automatically append to bottom of handler code +-- + +[%hardbreaks] +{blank} +a¦ String + array + +a¦ +*enable_applog_rotation* + +_optional_ +a¦ + +[markdown] +-- +enable rotating this handlers log() message files +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*app_log_dir* + +_optional_ +a¦ + +[markdown] +-- +directory to write content of log() message files +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*app_log_max_size* + +_optional_ +a¦ + +[markdown] +-- +rotate logs when file grows to this size in bytes approximately +-- + +[%hardbreaks] +*Minimum:* `1024` +{blank} +a¦ Integer + + +a¦ +*app_log_max_files* + +_optional_ +a¦ + +[markdown] +-- +number of log() message files to retain when rotating +-- + +[%hardbreaks] +*Minimum:* `1` +{blank} +a¦ Integer + + +a¦ +*checkpoint_interval* + +_optional_ +a¦ + +[markdown] +-- +number of seconds before writing a progress checkpoint +-- + +[%hardbreaks] +*Minimum:* `1` +{blank} +a¦ Integer + + +a¦ +*bucket_cache_size* + +_optional_ +a¦ + +[markdown] +-- +maximum size in bytes the bucket cache can grow to +-- + +[%hardbreaks] +*Minimum:* `20971520` +{blank} +a¦ Integer + + +a¦ +*bucket_cache_age* + +_optional_ +a¦ + +[markdown] +-- +time in milliseconds after which a cached bucket object is considered stale +-- + +[%hardbreaks] +*Minimum:* `1` +{blank} +a¦ Integer + + +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 +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*allow_transaction_mutations* + +_optional_ +a¦ + +[markdown] +-- +allow staged transaction mutations +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*allow_sync_documents* + +_optional_ +a¦ + +[markdown] +-- +allow sync gateway mutations +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*cursor_aware* + +_optional_ +a¦ + +[markdown] +-- +syncgateway aware function +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*high_seq_check_interval* + +_optional_ +a¦ + +[markdown] +-- +number of milliseconds before checking for high seq number +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*max_unacked_bytes* + +_optional_ +a¦ + +[markdown] +-- +max MBs to wait to send more bytes to c++ side +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*max_unacked_count* + +_optional_ +a¦ + +[markdown] +-- +max number of messages on c++ side +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*message_flush_time* + +_optional_ +a¦ + +[markdown] +-- +number of milliseconds before sending message to c++ side +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*max_parallel_vb* + +_optional_ +a¦ + +[markdown] +-- +number of parallel vb request per cpp thread +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +|=== + +//end::settings_schema[] + + + + +// markup not found, no 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] + + + + +// markup not found, no include::{specDir}definitions/UnivConfig/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#UnivConfig] += Global Config + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/UnivConfig/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::UnivConfig[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*ram_quota* + +_optional_ +a¦ + +[markdown] +-- +The memory allocation for the Eventing Service, per node. +-- + +[%hardbreaks] +*Default:* `256` +*Example:* `512` +{blank} +a¦ Integer + + +a¦ +*enable_debugger* + +_optional_ +a¦ + +[markdown] +-- +Enables the Eventing service debugger. +For details, see [Debugging and Diagnosability](/server/7.6/eventing/eventing-debugging-and-diagnosability.html). +-- + +[%hardbreaks] +*Default:* `false` +{blank} +a¦ Boolean + + +|=== + +//end::UnivConfig[] + + + + +// markup not found, no include::{specDir}definitions/UnivConfig/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/UnivConfig/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/document-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/document-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}security/document-before.adoc[opts=optional] + + +[[security]] += Security + +:leveloffset: +1 + +include::{specDir}security/document-begin.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}security/Global/security-scheme-before.adoc[opts=optional] + + +[[security-global]] += Global + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Global/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +Global functions with a function scope of ``*.*`` can only be made or managed by users with the Full Admin or Eventing Full Admin role. +For global functions, you do not need to pass the `bucket` and `scope` query parameters to specify the function scope. +The credentials must be an administrator username and password. + +Note that this is the default function scope for all functions after an upgrade from a prior version. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/Global/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/Global/security-scheme-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}security/Scoped/security-scheme-before.adoc[opts=optional] + + +[[security-scoped]] += Scoped + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Scoped/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +For scoped functions, you must pass the `bucket` and `scope` query parameters to specify the function scope. +The credentials are the username and password of any authorized user. + +You can quote the REST call on the command line to escape the `&` and `?` characters. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/Scoped/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/Scoped/security-scheme-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}security/Unscoped/security-scheme-before.adoc[opts=optional] + + +[[security-unscoped]] += Unscoped + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Unscoped/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +Unscoped REST API calls do not require you to specify the function scope. +The action is fully determined by the username and password credentials passed to the REST call. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no 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/document-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] + + diff --git a/docs/modules/eventing-rest-api/partials/definitions/AddFunction/definition-before.adoc b/docs/modules/eventing-rest-api/partials/definitions/AddFunction/definition-before.adoc new file mode 100644 index 00000000..bd4b8319 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/definitions/AddFunction/definition-before.adoc @@ -0,0 +1,4 @@ +[NOTE] +==== +Changes to the Eventing function definition files made outside of this REST API or the interactive UI are only supported if you adhere to the Eventing schemas described here. +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/header-attributes.adoc b/docs/modules/eventing-rest-api/partials/header-attributes.adoc new file mode 100644 index 00000000..690e987b --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/header-attributes.adoc @@ -0,0 +1,4 @@ +:page-aliases: eventing:eventing-api.adoc +:page-edition: Enterprise Edition +:page-partial: +:!example-caption: diff --git a/docs/modules/eventing-rest-api/partials/overview/document-before.adoc b/docs/modules/eventing-rest-api/partials/overview/document-before.adoc new file mode 100644 index 00000000..1fb78375 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/overview/document-before.adoc @@ -0,0 +1,57 @@ +// Pass through HTML table styles for this page. +// This overrides Swagger2Markup's table layout defaults. + +ifdef::basebackend-html[] +++++ + +++++ +endif::[] \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/overview/document-end.adoc b/docs/modules/eventing-rest-api/partials/overview/document-end.adoc new file mode 100644 index 00000000..a30fdd90 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/overview/document-end.adoc @@ -0,0 +1,9 @@ +[discrete] += Examples on this page + +In the HTTP request examples: + +* `$HOST` is the host name or IP address of a node running the Eventing service. +* `$ADMIN` is the user name of an administrator -- see <>. +* `$USER` is the user name of any authorized user -- see <>. +* `$PASSWORD` is the password to connect to Couchbase Server. \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/adv_function_import/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/adv_function_import/http-request.adoc new file mode 100644 index 00000000..8eae594f --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/adv_function_import/http-request.adoc @@ -0,0 +1,21 @@ += Example HTTP Requests + +.Import a global function +==== +.Curl request +[source,sh] +---- +curl -XPOST -d @./my_function.json \ + "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function" +---- +==== + +.Import a scoped function +==== +.Curl request +[source,sh] +---- +curl -XPOST -d @./my_function.json \ + "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data" +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/adv_function_import_all/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/adv_function_import_all/http-request.adoc new file mode 100644 index 00000000..cf57e1b4 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/adv_function_import_all/http-request.adoc @@ -0,0 +1,11 @@ += Example HTTP Requests + +.Import multiple functions +==== +.Curl request +[source,sh] +---- +curl -XPOST -d @./array_of_functions.json \ + "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions" +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/adv_function_view/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/adv_function_view/http-request.adoc new file mode 100644 index 00000000..d2ffc02f --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/adv_function_view/http-request.adoc @@ -0,0 +1,39 @@ += Example HTTP Requests + +.View a global function definition +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function" +---- +==== + +.View a scoped function definition +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data" +---- +==== + +.Save a global function definition to file +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function" \ + -o my_function.json +---- +==== + +.Save a scoped function definition to file +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data" \ + -o my_function.json +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/adv_function_view_all/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/adv_function_view_all/http-request.adoc new file mode 100644 index 00000000..481a1d17 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/adv_function_view_all/http-request.adoc @@ -0,0 +1,20 @@ += Example HTTP Requests + +.View all function definitions +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions" +---- +==== + +.Save all function definitions to file +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions" \ + -o array_of_functions.json +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/adv_function_zap/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/adv_function_zap/http-request.adoc new file mode 100644 index 00000000..1ac865cb --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/adv_function_zap/http-request.adoc @@ -0,0 +1,19 @@ += Example HTTP Requests + +.Delete a global function +==== +.Curl request +[source,sh] +---- +curl -XDELETE "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function" +---- +==== + +.Delete a scoped function +==== +.Curl request +[source,sh] +---- +curl -XDELETE "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function?bucket=bulk&scope=data" +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/adv_function_zap_all/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/adv_function_zap_all/http-request.adoc new file mode 100644 index 00000000..90adf782 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/adv_function_zap_all/http-request.adoc @@ -0,0 +1,10 @@ += Example HTTP Request + +.Delete all functions +==== +.Curl request +[source,sh] +---- +curl -XDELETE "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions" +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/adv_multiple_export/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/adv_multiple_export/http-request.adoc new file mode 100644 index 00000000..1115682b --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/adv_multiple_export/http-request.adoc @@ -0,0 +1,20 @@ += Example HTTP Requests + +.View all function definitions +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/export" +---- +==== + +.Save all function definitions to file +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/export" \ + -o array_of_functions.json +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/adv_multiple_import/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/adv_multiple_import/http-request.adoc new file mode 100644 index 00000000..f8c02946 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/adv_multiple_import/http-request.adoc @@ -0,0 +1,11 @@ += Example HTTP Requests + +.Import multiple functions +==== +.Curl request +[source,sh] +---- +curl -XPOST -d @./array_of_functions.json \ + "http://$USER:$PASSWORD@$HOST:8096/api/v1/import" +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/adv_settings_get/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/adv_settings_get/http-request.adoc new file mode 100644 index 00000000..c15b5b65 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/adv_settings_get/http-request.adoc @@ -0,0 +1,39 @@ += Example HTTP Requests + +.View global function settings +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings" +---- +==== + +.View scoped function settings +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data" +---- +==== + +.Save global function settings to file +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings" \ + -o my_function.json +---- +==== + +.Save scoped function settings to file +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data" \ + -o my_function.json +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/adv_settings_update/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/adv_settings_update/http-request.adoc new file mode 100644 index 00000000..72823de4 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/adv_settings_update/http-request.adoc @@ -0,0 +1,159 @@ += Example HTTP Requests + +.Update global function settings +==== +This example updates the `worker_count` setting. + +.Curl request +[source,sh] +---- +curl -XPOST -d '{ + "deployment_status": false, + "processing_status": false, + "worker_count": 6 +}' "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings" +---- +==== + +.Update scoped function settings +==== +This example updates the `worker_count` setting. + +.Curl request +[source,sh] +---- +curl -XPOST -d '{ + "deployment_status": false, + "processing_status": false, + "worker_count": 6 +}' "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data" +---- +==== + +.Update undeployed global function settings +==== +This example updates the `app_log_max_files` and `app_log_max_size` settings. +The function is currently undeployed. + +.Curl request +[source,sh] +---- +curl -XPOST -d '{ + "deployment_status": false, + "processing_status": false, + "app_log_max_files": 5 + "app_log_max_size":10485760 +}' "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings" +---- +==== + +.Update undeployed scoped function settings +==== +This example updates the `app_log_max_files` and `app_log_max_size` settings. +The function is currently undeployed. + +.Curl request +[source,sh] +---- +curl -XPOST -d '{ + "deployment_status": false, + "processing_status": false, + "app_log_max_files": 5, + "app_log_max_size": 10485760 +}' "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data" +---- +==== + +.Update paused global function settings +==== +This example updates the `timer_context_size` setting. +The function is currently paused. + +.Curl request +[source,sh] +---- +curl -XPOST -d '{ + "deployment_status": true, + "processing_status": false, + "timer_context_size": 2048 +}' "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings" +---- +==== + +.Update paused scoped function settings +==== +This example updates the `timer_context_size` setting. +The function is currently paused. + +.Curl request +[source,sh] +---- +curl -XPOST -d '{ + "deployment_status": true, + "processing_status": false, + "timer_context_size": 2048 +}' "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data" +---- +==== + +.Update paused global function settings and resume +==== +This example updates the `worker_count` setting and resumes. +The function is currently paused. + +.Curl request +[source,sh] +---- +curl -XPOST -d '{ + "deployment_status": true, + "processing_status": true, + "worker_count": 8 +}' "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings" +---- +==== + +.Update paused scoped function settings and resume +==== +This example updates the `worker_count` setting and resumes. +The function is currently paused. + +.Curl request +[source,sh] +---- +curl -XPOST -d '{ + "deployment_status": true, + "processing_status": true, + "worker_count": 8 +}' "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data" +---- +==== + +.Deploy an undeployed global function -- deprecated +==== +.Curl request +[source,sh] +---- +curl -XPOST -d '{ + "deployment_status": true, + "processing_status": true +}' "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings" +---- + +Deprecated. +See <> for the preferred invocation. +==== + +.Deploy an undeployed scoped function -- deprecated +==== +.Curl request +[source,sh] +---- +curl -XPOST -d '{ + "deployment_status": true, + "processing_status": true +}' "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data" +---- + +Deprecated. +See <> for the preferred invocation. +==== diff --git a/docs/modules/eventing-rest-api/partials/paths/adv_structure_get/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/adv_structure_get/http-request.adoc new file mode 100644 index 00000000..c906e7d9 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/adv_structure_get/http-request.adoc @@ -0,0 +1,39 @@ += Example HTTP Requests + +.View global function config +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config" +---- +==== + +.View scoped function config +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config?bucket=bulk&scope=data" +---- +==== + +.Save global function config to file +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config" \ + -o my_function.json +---- +==== + +.Save scoped function config to file +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config?bucket=bulk&scope=data" \ + -o my_function.json +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/adv_structure_update/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/adv_structure_update/http-request.adoc new file mode 100644 index 00000000..d9efafca --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/adv_structure_update/http-request.adoc @@ -0,0 +1,63 @@ += Example HTTP Requests + +.Update global function config +==== +This example alters the source and eventing storage keyspaces. + +.Curl request +[source,sh] +---- +curl -XPOST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config" \ + -d '{ + "source_bucket": "bulk", + "source_scope": "orders", + "source_collection": "customer01", + "metadata_bucket": "rr100", + "metadata_scope": "eventing", + "metadata_collection": "metadata" +}' +---- +==== + +.Update scoped function config +==== +This example alters the source and eventing storage keyspaces. + +.Curl request +[source,sh] +---- +curl -XPOST "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config?bucket=bulk&scope=data"\ + -d '{ + "source_bucket": "bulk", + "source_scope": "orders", + "source_collection": "customer01", + "metadata_bucket": "rr100", + "metadata_scope": "eventing", + "metadata_collection": "metadata" +}' +---- +==== + +.Update global function config from file +==== +This example alters the source and eventing storage keyspaces from a file. + +.Curl request +[source,sh] +---- +curl -XPOST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config" \ + -d @./my_function.json +---- +==== + +.Update scoped function config from file +==== +This example alters the source and eventing storage keyspaces from a file. + +.Curl request +[source,sh] +---- +curl -XPOST "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/config?bucket=bulk&scope=data" \ + -d @./my_function.json +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/adv_text_get/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/adv_text_get/http-request.adoc new file mode 100644 index 00000000..300dcdd2 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/adv_text_get/http-request.adoc @@ -0,0 +1,39 @@ += Example HTTP Requests + +.View global function code +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appcode" +---- +==== + +.View scoped function code +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appcode?bucket=bulk&scope=data" +---- +==== + +.Save global function code to file +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appcode" \ + -o my_function.json +---- +==== + +.Save scoped function code to file +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appcode?bucket=bulk&scope=data" \ + -o my_function.json +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/adv_text_update/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/adv_text_update/http-request.adoc new file mode 100644 index 00000000..beee5e18 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/adv_text_update/http-request.adoc @@ -0,0 +1,71 @@ += Example HTTP Requests + +.Update global function code +==== +.Curl request +[source,sh] +---- +curl -XPOST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appcode" \ + --data-binary 'function OnUpdate(doc, meta) { log("id",meta.id); }' +---- +==== + +.Update scoped function code +==== +.Curl request +[source,sh] +---- +curl -XPOST "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/appcode?bucket=bulk&scope=data" \ + --data-binary 'function OnUpdate(doc, meta) { log("id",meta.id); }' +---- +==== + +.Update global function code from file +==== +This example uses the `--data-binary` option. +Do not use `-d`. + +.Curl request +[source,sh] +---- +curl -XPOST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/import" \ + --data-binary @./my_function.json +---- +==== + +.Update scoped function code from file +==== +This example uses the `--data-binary` option. +Do not use `-d`. + +.Curl request +[source,sh] +---- +curl -XPOST "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/import?bucket=bulk&scope=data" \ + --data-binary @./my_function.json +---- +==== + +.Update global function code from file -- alternative +==== +This example uses the `--upload-file` option. + +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/import" \ + --upload-file ./my_function.json +---- +==== + +.Update scoped function code from file -- alternative +==== +This example uses the `--upload-file` option. + +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/import?bucket=bulk&scope=data" \ + --upload-file ./my_function.json +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/basic_deploy/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/basic_deploy/http-request.adoc new file mode 100644 index 00000000..a49aa113 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/basic_deploy/http-request.adoc @@ -0,0 +1,19 @@ += Example HTTP Requests + +.Deploy a global function +==== +.Curl request +[source,sh] +---- +curl -XPOST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/deploy" +---- +==== + +.Deploy a scoped function +==== +.Curl request +[source,sh] +---- +curl -XPOST "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/deploy?bucket=bulk&scope=data" +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/basic_pause/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/basic_pause/http-request.adoc new file mode 100644 index 00000000..2046bf1b --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/basic_pause/http-request.adoc @@ -0,0 +1,19 @@ += Example HTTP Requests + +.Pause a global function +==== +.Curl request +[source,sh] +---- +curl -XPOST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/pause" +---- +==== + +.Pause a scoped function +==== +.Curl request +[source,sh] +---- +curl -XPOST "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/pause?bucket=bulk&scope=data" +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/basic_resume/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/basic_resume/http-request.adoc new file mode 100644 index 00000000..0faebc43 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/basic_resume/http-request.adoc @@ -0,0 +1,19 @@ += Example HTTP Requests + +.Resume a global function +==== +.Curl request +[source,sh] +---- +curl -XPOST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/resume" +---- +==== + +.Resume a scoped function +==== +.Curl request +[source,sh] +---- +curl -XPOST "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/resume?bucket=bulk&scope=data" +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/basic_undeploy/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/basic_undeploy/http-request.adoc new file mode 100644 index 00000000..83cd66f1 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/basic_undeploy/http-request.adoc @@ -0,0 +1,19 @@ += Example HTTP Requests + +.Undeploy a global function +==== +.Curl request +[source,sh] +---- +curl -XPOST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/undeploy" +---- +==== + +.Undeploy a scoped function +==== +.Curl request +[source,sh] +---- +curl -XPOST "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/undeploy?bucket=bulk&scope=data" +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/config_get/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/config_get/http-request.adoc new file mode 100644 index 00000000..2fc22054 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/config_get/http-request.adoc @@ -0,0 +1,10 @@ += Example HTTP Requests + +.View global configuration +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/config" +---- +==== diff --git a/docs/modules/eventing-rest-api/partials/paths/config_update/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/config_update/http-request.adoc new file mode 100644 index 00000000..9e5b603d --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/config_update/http-request.adoc @@ -0,0 +1,45 @@ += Example HTTP Requests + +.Alter RAM quota +==== +.Curl request +[source,sh] +---- +curl -XPOST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/config" \ + -d '{"ram_quota": 512}' +---- +==== + +.Enable debugger +==== +.Curl request +[source,sh] +---- +curl -XPOST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/config" \ + -d '{"enable_debugger": true}' +---- +==== + +.Allow interbucket recursion +==== +This example disables the safety checks that prevent basic infinite recursive Eventing functions. + +.Curl request +[source,sh] +---- +curl -X POST -u $ADMIN:$PASSWORD "http://$HOST:8091/_p/event/api/v1/config" \ + -d '{"allow_interbucket_recursion": true}' +---- +==== + +.Disallow interbucket recursion +==== +This example restores the default setting, which applies some sanity checks to prevent basic infinite recursive Eventing functions. + +.Curl request +[source,sh] +---- +curl -X POST -u $ADMIN:$PASSWORD "http://$HOST:8091/_p/event/api/v1/config" + -d '{"allow_interbucket_recursion": false}' +---- +==== diff --git a/docs/modules/eventing-rest-api/partials/paths/config_update/operation-description-after.adoc b/docs/modules/eventing-rest-api/partials/paths/config_update/operation-description-after.adoc new file mode 100644 index 00000000..caedb31e --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/config_update/operation-description-after.adoc @@ -0,0 +1,8 @@ +[NOTE] +.Interbucket Recursion +==== +If you need to turn off infinite recursion protection for Eventing functions, you can use an alternative REST API endpoint to enable interbucket recursion. +For details, see xref:eventing:troubleshooting-best-practices.adoc#cyclicredun[Troubleshooting and Best Practices]. + +Allowing interbucket recursion is highly discouraged unless you have an advanced use case and follow strict non-production coding and verification. +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/list_all/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/list_all/http-request.adoc new file mode 100644 index 00000000..ec867774 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/list_all/http-request.adoc @@ -0,0 +1,10 @@ += Example HTTP Requests + +.List all functions +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/list/functions" +---- +==== diff --git a/docs/modules/eventing-rest-api/partials/paths/list_query/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/list_query/http-request.adoc new file mode 100644 index 00000000..ddde7608 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/list_query/http-request.adoc @@ -0,0 +1,30 @@ += Example HTTP Requests + +.List all deployed functions +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/list/functions/query?deployed=true" +---- + +If you had specified `deployed=false`, you would get all undeployed functions. +==== + +.List all functions with source keyspace in a specific bucket +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/list/functions/query?source_bucket=bulk" +---- +==== + +.List all functions that do not modify their source keyspace +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/list/functions/query?function_type=notsbm" +---- +==== diff --git a/docs/modules/eventing-rest-api/partials/paths/log_view/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/log_view/http-request.adoc new file mode 100644 index 00000000..1449172d --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/log_view/http-request.adoc @@ -0,0 +1,59 @@ += Example HTTP Requests + +.View global function log from a single node +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/getAppLog?name=my_function" +---- +==== + +.View scoped function log from a single node +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/getAppLog?name=my_function&bucket=bulk&scope=data" +---- +==== + +.View global function log from all Eventing nodes +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/getAppLog?name=my_function&aggregate=true" +---- +==== + +.View scoped function log from all Eventing nodes +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/getAppLog?name=my_function&aggregate=true&bucket=bulk&scope=data" +---- +==== + +.View size-limited global function log +==== +This example fetches recent Application log info from all Eventing nodes, limited to 2048 bytes. + +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/getAppLog?name=my_function&aggregate=true&size=2048" +---- +==== + +.View size-limited scoped function log +==== +This example fetches recent Application log info from all Eventing nodes, limited to 2048 bytes. + +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/getAppLog?name=my_function&aggregate=true&size=2048&bucket=bulk&scope=data" +---- +==== diff --git a/docs/modules/eventing-rest-api/partials/paths/stats_all/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/stats_all/http-request.adoc new file mode 100644 index 00000000..082da823 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/stats_all/http-request.adoc @@ -0,0 +1,19 @@ += Example HTTP Requests + +.Get basic statistics +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/stats" +---- +==== + +.Get full statistics +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/stats?type=full" +---- +==== diff --git a/docs/modules/eventing-rest-api/partials/paths/stats_execution/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/stats_execution/http-request.adoc new file mode 100644 index 00000000..5163df01 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/stats_execution/http-request.adoc @@ -0,0 +1,19 @@ += Example HTTP Requests + +.View execution statistics for global function +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/getExecutionStats?name=my_function" +---- +==== + +.View execution statistics for scoped function +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/getExecutionStats?name=my_function&bucket=bulk&scope=data" +---- +==== diff --git a/docs/modules/eventing-rest-api/partials/paths/stats_failure/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/stats_failure/http-request.adoc new file mode 100644 index 00000000..ff9da0bf --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/stats_failure/http-request.adoc @@ -0,0 +1,19 @@ += Example HTTP Requests + +.View failure statistics for global function +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/getFailureStats?name=my_function" +---- +==== + +.View failure statistics for scoped function +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/getFailureStats?name=my_function&bucket=bulk&scope=data" +---- +==== diff --git a/docs/modules/eventing-rest-api/partials/paths/stats_latency/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/stats_latency/http-request.adoc new file mode 100644 index 00000000..65fe5717 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/stats_latency/http-request.adoc @@ -0,0 +1,19 @@ += Example HTTP Requests + +.View latency statistics for global function +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/getLatencyStats?name=my_function" +---- +==== + +.View latency statistics for scoped function +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/getLatencyStats?name=my_function&bucket=bulk&scope=data" +---- +==== diff --git a/docs/modules/eventing-rest-api/partials/paths/stats_reset/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/stats_reset/http-request.adoc new file mode 100644 index 00000000..8410846d --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/stats_reset/http-request.adoc @@ -0,0 +1,19 @@ += Example HTTP Requests + +.Reset statistics for global function +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/resetStatsCounters?appName=my_function" +---- +==== + +.Reset statistics for scoped function +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/resetStatsCounters?appName=my_function&bucket=bulk&scope=data" +---- +==== diff --git a/docs/modules/eventing-rest-api/partials/paths/status_all/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/status_all/http-request.adoc new file mode 100644 index 00000000..a755e5f5 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/status_all/http-request.adoc @@ -0,0 +1,10 @@ += Example HTTP Requests + +.View status of all functions +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/status" +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/paths/status_function/http-request.adoc b/docs/modules/eventing-rest-api/partials/paths/status_function/http-request.adoc new file mode 100644 index 00000000..a5ade24e --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/status_function/http-request.adoc @@ -0,0 +1,19 @@ += Example HTTP Requests + +.View global function status +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/status/my_function" +---- +==== + +.View scoped function status +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$USER:$PASSWORD@$HOST:8096/api/v1/status/my_function?bucket=bulk&scope=data" +---- +==== \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/security/document-begin.adoc b/docs/modules/eventing-rest-api/partials/security/document-begin.adoc new file mode 100644 index 00000000..52e27bc5 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/security/document-begin.adoc @@ -0,0 +1,2 @@ +The Eventing REST APIs support HTTP basic authentication. +Credentials can be passed via HTTP headers. \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/partials/security/document-end.adoc b/docs/modules/eventing-rest-api/partials/security/document-end.adoc new file mode 100644 index 00000000..bb718fc4 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/security/document-end.adoc @@ -0,0 +1 @@ +Refer to xref:eventing:eventing-rbac.adoc[] for more details. \ 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 6746c795..b19d64c6 100644 --- a/docs/modules/index-rest-stats/pages/index.adoc +++ b/docs/modules/index-rest-stats/pages/index.adoc @@ -58,7 +58,7 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* @@ -69,7 +69,7 @@ The host name or IP address of a node running the Index service. [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* @@ -80,7 +80,7 @@ The Index service REST port. Use `19102` for secure access. [%hardbreaks] *Values:* `9102`, `19102` -*Example:* `pass:c[9102]` +*Example:* `+++9102+++` // end |=== @@ -173,6 +173,12 @@ Returns statistics for an index. // markup not found, no include::{specDir}paths/get_index_stats/operation-description-end.adoc[opts=optional] + + +[#get_index_stats-produces] +.Produces +* application/json + :leveloffset: -1 @@ -195,13 +201,13 @@ Returns statistics for an index. .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *keyspace* + +a¦ *keyspace* + _required_ -a| +a¦ [markdown] @@ -219,13 +225,13 @@ For example, `` `bucket.1`.scope.collection ``. [%hardbreaks] {blank} -a| String +a¦ String -a| *index* + +a¦ *index* + _required_ -a| +a¦ [markdown] @@ -236,7 +242,7 @@ The name of an index. [%hardbreaks] {blank} -a| String +a¦ String @@ -246,13 +252,13 @@ a| String .Query Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *pretty* + +a¦ *pretty* + _optional_ -a| +a¦ [markdown] @@ -264,13 +270,13 @@ Whether the output should be formatted with indentations and newlines. *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| *partition* + +a¦ *partition* + _optional_ -a| +a¦ [markdown] @@ -282,13 +288,13 @@ Whether statistics for index partitions should be included. *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| *redact* + +a¦ *redact* + _optional_ -a| +a¦ [markdown] @@ -301,13 +307,13 @@ Whether keyspace and index names should be redacted in the output. *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| *skipEmpty* + +a¦ *skipEmpty* + _optional_ -a| +a¦ [markdown] @@ -319,7 +325,7 @@ Whether empty, null, or zero statistics should be omitted from the output. *Default:* `false` {blank} -a| Boolean +a¦ Boolean @@ -339,12 +345,6 @@ include::{specDir}paths/get_index_stats/operation-parameters-end.adoc[opts=optio // markup not found, no include::{specDir}paths/get_index_stats/operation-parameters-after.adoc[opts=optional] -[#get_index_stats-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_index_stats/operation-responses-before.adoc[opts=optional] @@ -472,6 +472,12 @@ 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] + + +[#get_keyspace_stats-produces] +.Produces +* application/json + :leveloffset: -1 @@ -494,13 +500,13 @@ Returns statistics for all indexes within a bucket, scope, or collection. .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *keyspace* + +a¦ *keyspace* + _required_ -a| +a¦ [markdown] @@ -518,7 +524,7 @@ For example, `` `bucket.1`.scope.collection ``. [%hardbreaks] {blank} -a| String +a¦ String @@ -528,13 +534,13 @@ a| String .Query Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *pretty* + +a¦ *pretty* + _optional_ -a| +a¦ [markdown] @@ -546,13 +552,13 @@ Whether the output should be formatted with indentations and newlines. *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| *redact* + +a¦ *redact* + _optional_ -a| +a¦ [markdown] @@ -565,13 +571,13 @@ Whether keyspace and index names should be redacted in the output. *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| *skipEmpty* + +a¦ *skipEmpty* + _optional_ -a| +a¦ [markdown] @@ -583,7 +589,7 @@ Whether empty, null, or zero statistics should be omitted from the output. *Default:* `false` {blank} -a| Boolean +a¦ Boolean @@ -603,12 +609,6 @@ include::{specDir}paths/get_keyspace_stats/operation-parameters-end.adoc[opts=op // markup not found, no include::{specDir}paths/get_keyspace_stats/operation-parameters-after.adoc[opts=optional] -[#get_keyspace_stats-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_keyspace_stats/operation-responses-before.adoc[opts=optional] @@ -736,6 +736,12 @@ 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] + + +[#get_node_stats-produces] +.Produces +* application/json + :leveloffset: -1 @@ -759,13 +765,13 @@ Returns statistics for an index node, and for all indexes on that node. .Query Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *pretty* + +a¦ *pretty* + _optional_ -a| +a¦ [markdown] @@ -777,13 +783,13 @@ Whether the output should be formatted with indentations and newlines. *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| *redact* + +a¦ *redact* + _optional_ -a| +a¦ [markdown] @@ -796,13 +802,13 @@ Whether keyspace and index names should be redacted in the output. *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| *skipEmpty* + +a¦ *skipEmpty* + _optional_ -a| +a¦ [markdown] @@ -814,7 +820,7 @@ Whether empty, null, or zero statistics should be omitted from the output. *Default:* `false` {blank} -a| Boolean +a¦ Boolean @@ -834,12 +840,6 @@ a| Boolean // markup not found, no include::{specDir}paths/get_node_stats/operation-parameters-after.adoc[opts=optional] -[#get_node_stats-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_node_stats/operation-responses-before.adoc[opts=optional] @@ -1029,14 +1029,14 @@ endif::collapse-models[] //tag::NodeIdxNode[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *indexer* + _required_ -a| +a¦ [markdown] -- @@ -1045,7 +1045,7 @@ include::index.adoc[tag=desc-NodeIdxNodeIndexer, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ <> |=== @@ -1090,14 +1090,14 @@ A nested object containing statistics for the current index node. //end::desc-NodeIdxNodeIndexer[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *indexer_state* + _optional_ -a| +a¦ [markdown] -- @@ -1106,15 +1106,15 @@ Current state of the Index service on this node. [%hardbreaks] *Values:* `"Active"`, `"Pause"`, `"Warmup"` -*Example:* `pass:c["Active"]` +*Example:* `+++"Active"+++` {blank} -a| String +a¦ String -a| +a¦ *memory_quota* + _optional_ -a| +a¦ [markdown] -- @@ -1126,13 +1126,13 @@ Memory quota assigned to the Index service on this node by user configuration (b *Maximum:* `1099511992567` *Example:* `536870912` {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *memory_total_storage* + _optional_ -a| [.edition]##{enterprise}## +a¦ [.edition]##{enterprise}## [markdown] -- @@ -1144,13 +1144,13 @@ This also accounts for memory fragmentation. [%hardbreaks] *Example:* `71794688` {blank} -a| Integer +a¦ Integer -a| +a¦ *memory_used* + _optional_ -a| +a¦ [markdown] -- @@ -1160,13 +1160,13 @@ Amount of memory used by the Index service on this node (bytes). [%hardbreaks] *Example:* `360192000` {blank} -a| Integer +a¦ Integer -a| +a¦ *total_indexer_gc_pause_ns* + _optional_ -a| +a¦ [markdown] -- @@ -1176,7 +1176,7 @@ The total time the indexer has spent in GC pause since last startup (ns). [%hardbreaks] *Example:* `309778455` {blank} -a| Integer +a¦ Integer |=== @@ -1253,14 +1253,14 @@ endif::collapse-models[] //tag::PartIdxIndexes[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ _additional + property_ -a| +a¦ [markdown] -- @@ -1269,7 +1269,7 @@ include::index.adoc[tag=desc-PartIdxPartitionsIndex, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ <> |=== @@ -1309,14 +1309,14 @@ endif::collapse-models[] //tag::PartIdxPartitions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ _additional + property_ -a| +a¦ [markdown] -- @@ -1325,7 +1325,7 @@ include::index.adoc[tag=desc-PartIdxPartitionsIndex, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ <> |=== @@ -1370,14 +1370,14 @@ A nested object containing statistics for an index or index partition. //end::desc-PartIdxPartitionsIndex[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *avg_array_length* + _optional_ -a| +a¦ [markdown] -- @@ -1388,13 +1388,13 @@ The average number of items indexed per document. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *avg_drain_rate* + _optional_ -a| +a¦ [markdown] -- @@ -1403,13 +1403,13 @@ Average number of items flushed from memory to disk storage per second. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *avg_item_size* + _optional_ -a| +a¦ [markdown] -- @@ -1418,13 +1418,13 @@ Average size of the keys. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *avg_scan_latency* + _optional_ -a| +a¦ [markdown] -- @@ -1433,13 +1433,13 @@ Average time to serve a scan request (nanoseconds). [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *cache_hit_percent* + _optional_ -a| [.edition]##{enterprise}## +a¦ [.edition]##{enterprise}## [markdown] -- @@ -1448,13 +1448,13 @@ Percentage of memory accesses that were served from the managed cache. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *cache_hits* + _optional_ -a| +a¦ [markdown] -- @@ -1463,13 +1463,13 @@ Accesses to this index data from RAM. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *cache_misses* + _optional_ -a| +a¦ [markdown] -- @@ -1478,13 +1478,13 @@ Accesses to this index data from disk. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *data_size* + _optional_ -a| +a¦ [markdown] -- @@ -1494,13 +1494,13 @@ The size of indexable data that is maintained for the index or partition (bytes) [%hardbreaks] *Example:* `95728` {blank} -a| Integer +a¦ Integer -a| +a¦ *disk_size* + _optional_ -a| +a¦ [markdown] -- @@ -1510,13 +1510,13 @@ Total disk file size consumed by the index or partition. [%hardbreaks] *Example:* `889054` {blank} -a| Integer +a¦ Integer -a| +a¦ *docid_count* + _optional_ -a| +a¦ [markdown] -- @@ -1527,13 +1527,13 @@ The number of documents currently indexed. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *frag_percent* + _optional_ -a| +a¦ [markdown] -- @@ -1545,13 +1545,13 @@ TIP: At small index sizes of less than a hundred kB, the static overhead of the [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *initial_build_progress* + _optional_ -a| +a¦ [markdown] -- @@ -1565,13 +1565,13 @@ For an index partition, the value is listed as `0`. [%hardbreaks] *Example:* `100` {blank} -a| Integer +a¦ Integer -a| +a¦ *items_count* + _optional_ -a| +a¦ [markdown] -- @@ -1581,13 +1581,13 @@ The number of items currently indexed. [%hardbreaks] *Example:* `2155` {blank} -a| Integer +a¦ Integer -a| +a¦ *last_known_scan_time* + _optional_ -a| +a¦ [markdown] -- @@ -1600,13 +1600,13 @@ NOTE: This statistic is persisted to disk every 15 minutes, so it is preserved w [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *num_docs_indexed* + _optional_ -a| +a¦ [markdown] -- @@ -1615,13 +1615,13 @@ Number of documents indexed by the indexer since last startup. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *num_docs_pending* + _optional_ -a| +a¦ [markdown] -- @@ -1630,13 +1630,13 @@ Number of documents pending to be indexed. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *num_docs_queued* + _optional_ -a| +a¦ [markdown] -- @@ -1645,13 +1645,13 @@ Number of documents queued to be indexed. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *num_items_flushed* + _optional_ -a| +a¦ [markdown] -- @@ -1660,13 +1660,13 @@ Number of items flushed from memory to disk storage. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *num_pending_requests* + _optional_ -a| +a¦ [markdown] -- @@ -1675,13 +1675,13 @@ Number of requests received but not yet served by the indexer. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *num_requests* + _optional_ -a| +a¦ [markdown] -- @@ -1690,13 +1690,13 @@ Number of requests served by the indexer since last startup. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *num_rows_returned* + _optional_ -a| +a¦ [markdown] -- @@ -1705,13 +1705,13 @@ Total number of rows returned so far by the indexer. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *num_scan_errors* + _optional_ -a| +a¦ [markdown] -- @@ -1720,13 +1720,13 @@ Number of requests that failed due to errors other than timeout. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *num_scan_timeouts* + _optional_ -a| +a¦ [markdown] -- @@ -1735,13 +1735,13 @@ Number of requests that timed out, either waiting for snapshots or during scan i [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *recs_in_mem* + _optional_ -a| [.edition]##{enterprise}## +a¦ [.edition]##{enterprise}## [markdown] -- @@ -1754,13 +1754,13 @@ For memory-optimized index storage, this is the same as `items_count`. [%hardbreaks] *Example:* `2155` {blank} -a| Integer +a¦ Integer -a| +a¦ *recs_on_disk* + _optional_ -a| [.edition]##{enterprise}## +a¦ [.edition]##{enterprise}## [markdown] -- @@ -1770,13 +1770,13 @@ For memory-optimized index storage, this is `0`. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *resident_percent* + _optional_ -a| [.edition]##{enterprise}## +a¦ [.edition]##{enterprise}## [markdown] -- @@ -1786,13 +1786,13 @@ Percentage of the data held in memory. [%hardbreaks] *Example:* `100` {blank} -a| Integer +a¦ Integer -a| +a¦ *scan_bytes_read* + _optional_ -a| +a¦ [markdown] -- @@ -1801,13 +1801,13 @@ Number of bytes read by a scan since last startup. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *total_scan_duration* + _optional_ -a| +a¦ [markdown] -- @@ -1816,7 +1816,7 @@ Total time spent by the indexer in scanning rows since last startup (nanoseconds [%hardbreaks] {blank} -a| Integer +a¦ Integer |=== @@ -1930,3 +1930,4 @@ include::{specDir}security/document-end.adoc[opts=optional] // markup not found, no include::{specDir}security/document-after.adoc[opts=optional] + diff --git a/docs/modules/n1ql-rest-admin/pages/index.adoc b/docs/modules/n1ql-rest-admin/pages/index.adoc index ff0ef6ae..d8b203be 100644 --- a/docs/modules/n1ql-rest-admin/pages/index.adoc +++ b/docs/modules/n1ql-rest-admin/pages/index.adoc @@ -59,7 +59,7 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* @@ -70,7 +70,7 @@ The host name or IP address of a node running the Query service. [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* @@ -81,7 +81,7 @@ The Query service REST port. Use `18093` for secure access. [%hardbreaks] *Values:* `8093`, `18093` -*Example:* `pass:c[8093]` +*Example:* `+++8093+++` // end |=== @@ -182,6 +182,12 @@ Terminates the specified active query request. // markup not found, no include::{specDir}paths/delete_active_request/operation-description-end.adoc[opts=optional] + + +[#delete_active_request-produces] +.Produces +* application/json + :leveloffset: -1 @@ -204,13 +210,13 @@ Terminates the specified active query request. .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *request* + +a¦ *request* + _required_ -a| +a¦ [markdown] @@ -223,7 +229,7 @@ This is the `requestID` that was assigned automatically when the statement was c [%hardbreaks] {blank} -a| String +a¦ String @@ -244,12 +250,6 @@ a| String // markup not found, no include::{specDir}paths/delete_active_request/operation-parameters-after.adoc[opts=optional] -[#delete_active_request-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/delete_active_request/operation-responses-before.adoc[opts=optional] @@ -381,6 +381,12 @@ Returns all active index requests. // markup not found, no include::{specDir}paths/get_active_indexes/operation-description-end.adoc[opts=optional] + + +[#get_active_indexes-produces] +.Produces +* application/json + :leveloffset: -1 @@ -398,12 +404,6 @@ Returns all active index requests. // markup not found, no include::{specDir}paths/get_active_indexes/operation-parameters-after.adoc[opts=optional] -[#get_active_indexes-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_active_indexes/operation-responses-before.adoc[opts=optional] @@ -526,6 +526,12 @@ Returns the specified active query request. // markup not found, no include::{specDir}paths/get_active_request/operation-description-end.adoc[opts=optional] + + +[#get_active_request-produces] +.Produces +* application/json + :leveloffset: -1 @@ -548,13 +554,13 @@ Returns the specified active query request. .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *request* + +a¦ *request* + _required_ -a| +a¦ [markdown] @@ -567,7 +573,7 @@ This is the `requestID` that was assigned automatically when the statement was c [%hardbreaks] {blank} -a| String +a¦ String @@ -588,12 +594,6 @@ a| String // markup not found, no include::{specDir}paths/get_active_request/operation-parameters-after.adoc[opts=optional] -[#get_active_request-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_active_request/operation-responses-before.adoc[opts=optional] @@ -716,6 +716,12 @@ Returns all active query requests. // markup not found, no include::{specDir}paths/get_active_requests/operation-description-end.adoc[opts=optional] + + +[#get_active_requests-produces] +.Produces +* application/json + :leveloffset: -1 @@ -733,12 +739,6 @@ Returns all active query requests. // markup not found, no include::{specDir}paths/get_active_requests/operation-parameters-after.adoc[opts=optional] -[#get_active_requests-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_active_requests/operation-responses-before.adoc[opts=optional] @@ -886,6 +886,12 @@ Purges the specified completed request. // markup not found, no include::{specDir}paths/delete_completed_request/operation-description-end.adoc[opts=optional] + + +[#delete_completed_request-produces] +.Produces +* application/json + :leveloffset: -1 @@ -908,13 +914,13 @@ Purges the specified completed request. .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *request* + +a¦ *request* + _required_ -a| +a¦ [markdown] @@ -927,7 +933,7 @@ This is the `requestID` that was assigned automatically when the statement was c [%hardbreaks] {blank} -a| String +a¦ String @@ -948,12 +954,6 @@ a| String // markup not found, no include::{specDir}paths/delete_completed_request/operation-parameters-after.adoc[opts=optional] -[#delete_completed_request-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/delete_completed_request/operation-responses-before.adoc[opts=optional] @@ -1085,6 +1085,12 @@ Returns all completed index requests. // markup not found, no include::{specDir}paths/get_completed_indexes/operation-description-end.adoc[opts=optional] + + +[#get_completed_indexes-produces] +.Produces +* application/json + :leveloffset: -1 @@ -1102,12 +1108,6 @@ Returns all completed index requests. // markup not found, no include::{specDir}paths/get_completed_indexes/operation-parameters-after.adoc[opts=optional] -[#get_completed_indexes-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_completed_indexes/operation-responses-before.adoc[opts=optional] @@ -1230,6 +1230,12 @@ Returns the specified completed request. // markup not found, no include::{specDir}paths/get_completed_request/operation-description-end.adoc[opts=optional] + + +[#get_completed_request-produces] +.Produces +* application/json + :leveloffset: -1 @@ -1252,13 +1258,13 @@ Returns the specified completed request. .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *request* + +a¦ *request* + _required_ -a| +a¦ [markdown] @@ -1271,7 +1277,7 @@ This is the `requestID` that was assigned automatically when the statement was c [%hardbreaks] {blank} -a| String +a¦ String @@ -1292,12 +1298,6 @@ a| String // markup not found, no include::{specDir}paths/get_completed_request/operation-parameters-after.adoc[opts=optional] -[#get_completed_request-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_completed_request/operation-responses-before.adoc[opts=optional] @@ -1420,6 +1420,12 @@ Returns all completed requests. // markup not found, no include::{specDir}paths/get_completed_requests/operation-description-end.adoc[opts=optional] + + +[#get_completed_requests-produces] +.Produces +* application/json + :leveloffset: -1 @@ -1437,12 +1443,6 @@ Returns all completed requests. // markup not found, no include::{specDir}paths/get_completed_requests/operation-parameters-after.adoc[opts=optional] -[#get_completed_requests-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_completed_requests/operation-responses-before.adoc[opts=optional] @@ -1590,6 +1590,12 @@ Returns information about the specified cluster. // markup not found, no include::{specDir}paths/get_cluster/operation-description-end.adoc[opts=optional] + + +[#get_cluster-produces] +.Produces +* application/json + :leveloffset: -1 @@ -1612,13 +1618,13 @@ Returns information about the specified cluster. .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *cluster* + +a¦ *cluster* + _required_ -a| +a¦ [markdown] @@ -1629,7 +1635,7 @@ The name of a cluster. [%hardbreaks] {blank} -a| String +a¦ String @@ -1650,12 +1656,6 @@ a| String // markup not found, no include::{specDir}paths/get_cluster/operation-parameters-after.adoc[opts=optional] -[#get_cluster-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_cluster/operation-responses-before.adoc[opts=optional] @@ -1777,6 +1777,12 @@ Returns information about all clusters. // markup not found, no include::{specDir}paths/get_clusters/operation-description-end.adoc[opts=optional] + + +[#get_clusters-produces] +.Produces +* application/json + :leveloffset: -1 @@ -1794,12 +1800,6 @@ Returns information about all clusters. // markup not found, no include::{specDir}paths/get_clusters/operation-parameters-after.adoc[opts=optional] -[#get_clusters-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_clusters/operation-responses-before.adoc[opts=optional] @@ -1921,6 +1921,12 @@ 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] + + +[#get_config-produces] +.Produces +* application/json + :leveloffset: -1 @@ -1938,12 +1944,6 @@ Returns the configuration of the query service on the cluster. // markup not found, no include::{specDir}paths/get_config/operation-parameters-after.adoc[opts=optional] -[#get_config-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_config/operation-responses-before.adoc[opts=optional] @@ -2065,6 +2065,12 @@ 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] + + +[#get_node-produces] +.Produces +* application/json + :leveloffset: -1 @@ -2087,13 +2093,13 @@ Returns information about the specified node in the specified cluster. .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *cluster* + +a¦ *cluster* + _required_ -a| +a¦ [markdown] @@ -2104,13 +2110,13 @@ The name of a cluster. [%hardbreaks] {blank} -a| String +a¦ String -a| *node* + +a¦ *node* + _required_ -a| +a¦ [markdown] @@ -2121,7 +2127,7 @@ The name of a node. [%hardbreaks] {blank} -a| String +a¦ String @@ -2142,12 +2148,6 @@ a| String // markup not found, no include::{specDir}paths/get_node/operation-parameters-after.adoc[opts=optional] -[#get_node-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_node/operation-responses-before.adoc[opts=optional] @@ -2269,6 +2269,12 @@ Returns information about all nodes in the specified cluster. // markup not found, no include::{specDir}paths/get_nodes/operation-description-end.adoc[opts=optional] + + +[#get_nodes-produces] +.Produces +* application/json + :leveloffset: -1 @@ -2291,13 +2297,13 @@ Returns information about all nodes in the specified cluster. .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *cluster* + +a¦ *cluster* + _required_ -a| +a¦ [markdown] @@ -2308,7 +2314,7 @@ The name of a cluster. [%hardbreaks] {blank} -a| String +a¦ String @@ -2329,12 +2335,6 @@ a| String // markup not found, no include::{specDir}paths/get_nodes/operation-parameters-after.adoc[opts=optional] -[#get_nodes-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_nodes/operation-responses-before.adoc[opts=optional] @@ -2483,6 +2483,12 @@ A message is written to `query.log` whenever the garbage collector endpoint is i // markup not found, no include::{specDir}paths/get_gc/operation-description-end.adoc[opts=optional] + + +[#get_gc-produces] +.Produces +* application/json + :leveloffset: -1 @@ -2500,12 +2506,6 @@ A message is written to `query.log` whenever the garbage collector endpoint is i // markup not found, no include::{specDir}paths/get_gc/operation-parameters-after.adoc[opts=optional] -[#get_gc-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_gc/operation-responses-before.adoc[opts=optional] @@ -2635,6 +2635,12 @@ 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] + + +[#get_ping-produces] +.Produces +* application/json + :leveloffset: -1 @@ -2652,12 +2658,6 @@ Returns a minimal response, indicating that the service is running and reachable // markup not found, no include::{specDir}paths/get_ping/operation-parameters-after.adoc[opts=optional] -[#get_ping-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_ping/operation-responses-before.adoc[opts=optional] @@ -2763,6 +2763,12 @@ A message is written to `query.log` whenever the garbage collector endpoint is i // markup not found, no include::{specDir}paths/post_gc/operation-description-end.adoc[opts=optional] + + +[#post_gc-produces] +.Produces +* application/json + :leveloffset: -1 @@ -2780,12 +2786,6 @@ A message is written to `query.log` whenever the garbage collector endpoint is i // markup not found, no include::{specDir}paths/post_gc/operation-parameters-after.adoc[opts=optional] -[#post_gc-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/post_gc/operation-responses-before.adoc[opts=optional] @@ -2941,6 +2941,12 @@ Deletes the specified prepared statement. // markup not found, no include::{specDir}paths/delete_prepared/operation-description-end.adoc[opts=optional] + + +[#delete_prepared-produces] +.Produces +* application/json + :leveloffset: -1 @@ -2963,13 +2969,13 @@ Deletes the specified prepared statement. .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *name* + +a¦ *name* + _required_ -a| +a¦ [markdown] @@ -2982,7 +2988,7 @@ This may be a UUID that was assigned automatically, or a name that was user-spec [%hardbreaks] {blank} -a| String +a¦ String @@ -3003,12 +3009,6 @@ a| String // markup not found, no include::{specDir}paths/delete_prepared/operation-parameters-after.adoc[opts=optional] -[#delete_prepared-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/delete_prepared/operation-responses-before.adoc[opts=optional] @@ -3137,6 +3137,12 @@ Returns the specified prepared statement. // markup not found, no include::{specDir}paths/get_prepared/operation-description-end.adoc[opts=optional] + + +[#get_prepared-produces] +.Produces +* application/json + :leveloffset: -1 @@ -3159,13 +3165,13 @@ Returns the specified prepared statement. .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *name* + +a¦ *name* + _required_ -a| +a¦ [markdown] @@ -3178,7 +3184,7 @@ This may be a UUID that was assigned automatically, or a name that was user-spec [%hardbreaks] {blank} -a| String +a¦ String @@ -3199,12 +3205,6 @@ a| String // markup not found, no include::{specDir}paths/get_prepared/operation-parameters-after.adoc[opts=optional] -[#get_prepared-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_prepared/operation-responses-before.adoc[opts=optional] @@ -3330,6 +3330,12 @@ Returns all prepared index statements. // markup not found, no include::{specDir}paths/get_prepared_indexes/operation-description-end.adoc[opts=optional] + + +[#get_prepared_indexes-produces] +.Produces +* application/json + :leveloffset: -1 @@ -3347,12 +3353,6 @@ Returns all prepared index statements. // markup not found, no include::{specDir}paths/get_prepared_indexes/operation-parameters-after.adoc[opts=optional] -[#get_prepared_indexes-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_prepared_indexes/operation-responses-before.adoc[opts=optional] @@ -3475,6 +3475,12 @@ Returns all prepared statements. // markup not found, no include::{specDir}paths/get_prepareds/operation-description-end.adoc[opts=optional] + + +[#get_prepareds-produces] +.Produces +* application/json + :leveloffset: -1 @@ -3492,12 +3498,6 @@ Returns all prepared statements. // markup not found, no include::{specDir}paths/get_prepareds/operation-parameters-after.adoc[opts=optional] -[#get_prepareds-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_prepareds/operation-responses-before.adoc[opts=optional] @@ -3643,6 +3643,12 @@ Returns node-level query settings. // markup not found, no include::{specDir}paths/get_settings/operation-description-end.adoc[opts=optional] + + +[#get_settings-produces] +.Produces +* application/json + :leveloffset: -1 @@ -3660,12 +3666,6 @@ include::{specDir}paths/get_settings/operation-description-after.adoc[opts=optio // markup not found, no include::{specDir}paths/get_settings/operation-parameters-after.adoc[opts=optional] -[#get_settings-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_settings/operation-responses-before.adoc[opts=optional] @@ -3788,6 +3788,16 @@ Updates node-level query settings. // markup not found, no include::{specDir}paths/post_settings/operation-description-end.adoc[opts=optional] + +[#post_settings-consumes] +.Consumes +* application/json +* application/x-www-form-urlencoded + +[#post_settings-produces] +.Produces +* application/json + :leveloffset: -1 @@ -3814,13 +3824,13 @@ include::{specDir}paths/post_settings/operation-description-after.adoc[opts=opti .Body Parameter {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *Body* + +a¦ *Body* + _optional_ -a| +a¦ [markdown] @@ -3831,7 +3841,7 @@ An object specifying node-level query settings. [%hardbreaks] {blank} -a| <> +a¦ <> @@ -3848,19 +3858,8 @@ a| <> // markup not found, no include::{specDir}paths/post_settings/operation-parameters-after.adoc[opts=optional] -[#post_settings-produces] -= Produces -* application/json - -[#post_settings-consumes] -= Consumes - -* application/json -* application/x-www-form-urlencoded - - -// markup not found, no include::{specDir}paths/post_settings/operation-responses-before.adoc[opts=optional] +// markup not found, no include::{specDir}paths/post_settings/operation-responses-before.adoc[opts=optional] [#post_settings-responses] @@ -4005,6 +4004,12 @@ Currently unused. // markup not found, no include::{specDir}paths/get_debug_vars/operation-description-end.adoc[opts=optional] + + +[#get_debug_vars-produces] +.Produces +* text/html + :leveloffset: -1 @@ -4022,12 +4027,6 @@ Currently unused. // markup not found, no include::{specDir}paths/get_debug_vars/operation-parameters-after.adoc[opts=optional] -[#get_debug_vars-produces] -= Produces - -* text/html - - // markup not found, no include::{specDir}paths/get_debug_vars/operation-responses-before.adoc[opts=optional] @@ -4130,6 +4129,12 @@ Returns the specified statistic. // markup not found, no include::{specDir}paths/get_stat/operation-description-end.adoc[opts=optional] + + +[#get_stat-produces] +.Produces +* application/json + :leveloffset: -1 @@ -4152,13 +4157,13 @@ Returns the specified statistic. .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *stat* + +a¦ *stat* + _required_ -a| +a¦ [markdown] @@ -4173,7 +4178,7 @@ You cannot specify a metric. *Values:* `"active_requests"`, `"at_plus"`, `"audit_actions"`, `"audit_actions_failed"`, `"audit_requests_filtered"`, `"audit_requests_total"`, `"cancelled"`, `"deletes"`, `"errors"`, `"index_scans"`, `"inserts"`, `"invalid_requests"`, `"mutations"`, `"prepared"`, `"primary_scans"`, `"queued_requests"`, `"request_time"`, `"request_timer"`, `"requests"`, `"requests_1000ms"`, `"requests_250ms"`, `"requests_5000ms"`, `"requests_500ms"`, `"result_count"`, `"result_size"`, `"scan_plus"`, `"selects"`, `"service_time"`, `"unbounded"`, `"updates"`, `"warnings"` {blank} -a| String +a¦ String @@ -4194,12 +4199,6 @@ a| String // markup not found, no include::{specDir}paths/get_stat/operation-parameters-after.adoc[opts=optional] -[#get_stat-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_stat/operation-responses-before.adoc[opts=optional] @@ -4321,6 +4320,12 @@ Returns all statistics. // markup not found, no include::{specDir}paths/get_stats/operation-description-end.adoc[opts=optional] + + +[#get_stats-produces] +.Produces +* application/json + :leveloffset: -1 @@ -4338,12 +4343,6 @@ Returns all statistics. // markup not found, no include::{specDir}paths/get_stats/operation-parameters-after.adoc[opts=optional] -[#get_stats-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_stats/operation-responses-before.adoc[opts=optional] @@ -4467,6 +4466,12 @@ This information can be very useful to assess the current workload and performan // markup not found, no include::{specDir}paths/get_vitals/operation-description-end.adoc[opts=optional] + + +[#get_vitals-produces] +.Produces +* application/json + :leveloffset: -1 @@ -4484,12 +4489,6 @@ This information can be very useful to assess the current workload and performan // markup not found, no include::{specDir}paths/get_vitals/operation-parameters-after.adoc[opts=optional] -[#get_vitals-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_vitals/operation-responses-before.adoc[opts=optional] @@ -4643,14 +4642,14 @@ endif::collapse-models[] //tag::Clusters[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *name* + _optional_ -a| +a¦ [markdown] -- @@ -4659,13 +4658,13 @@ The name of the cluster. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *datastore* + _optional_ -a| +a¦ [markdown] -- @@ -4674,13 +4673,13 @@ The URL of the datastore. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *configstore* + _optional_ -a| +a¦ [markdown] -- @@ -4689,13 +4688,13 @@ The URL of the configstore. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *accountstore* + _optional_ -a| +a¦ [markdown] -- @@ -4704,13 +4703,13 @@ The URL of the accountstore. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *version* + _optional_ -a| +a¦ [markdown] -- @@ -4718,7 +4717,7 @@ a| [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -4758,14 +4757,14 @@ endif::collapse-models[] //tag::Garbage[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *freed* + _required_ -a| +a¦ [markdown] -- @@ -4774,13 +4773,13 @@ The amount of memory freed. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *released* + _optional_ -a| +a¦ [markdown] -- @@ -4791,13 +4790,13 @@ The amount of memory released to the OS. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *status* + _required_ -a| +a¦ [markdown] -- @@ -4806,7 +4805,7 @@ The status of the garbage collector. [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -4857,14 +4856,14 @@ Refer to [Configure the Completed Requests][sys-completed-config] for more infor //end::desc-Logging_Parameters[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *aborted* + _optional_ -a| +a¦ [markdown] -- @@ -4875,13 +4874,13 @@ If true, all requests that generate a panic are logged. *Default:* `null` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *client* + _optional_ -a| +a¦ [markdown] -- @@ -4891,16 +4890,16 @@ If specified, all completed requests from this IP address are logged. -- [%hardbreaks] -*Default:* `pass:c[""]` -*Example:* `pass:c["172.1.2.3"]` +*Default:* `+++""+++` +*Example:* `+++"172.1.2.3"+++` {blank} -a| String +a¦ String -a| +a¦ *context* + _optional_ -a| +a¦ [markdown] -- @@ -4920,13 +4919,13 @@ Refer to the [request-level][client_context_id] `client_context_id` parameter fo [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *error* + _optional_ -a| +a¦ [markdown] -- @@ -4939,13 +4938,13 @@ If specified, all completed queries returning this error number are logged. *Default:* `null` *Example:* `12003` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *tag* + _optional_ -a| +a¦ [markdown] -- @@ -4958,16 +4957,16 @@ Refer to [Configure the Completed Requests][sys-completed-config] for more infor -- [%hardbreaks] -*Default:* `pass:c[""]` -*Example:* `pass:c["both_user_and_error"]` +*Default:* `+++""+++` +*Example:* `+++"both_user_and_error"+++` {blank} -a| String +a¦ String -a| +a¦ *threshold* + _optional_ -a| +a¦ [markdown] -- @@ -4982,13 +4981,13 @@ This is another way of specifying the [node-level](#completed-threshold) `comple *Default:* `1000` *Example:* `7000` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *user* + _optional_ -a| +a¦ [markdown] -- @@ -4998,10 +4997,10 @@ If specified, all completed queries with this user name are logged. -- [%hardbreaks] -*Default:* `pass:c[""]` -*Example:* `pass:c["marco"]` +*Default:* `+++""+++` +*Example:* `+++"marco"+++` {blank} -a| String +a¦ String |=== @@ -5041,14 +5040,14 @@ endif::collapse-models[] //tag::Metrics[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *count* + _optional_ -a| +a¦ [markdown] -- @@ -5057,13 +5056,13 @@ A single value that represents the current state. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *15m.rate* + _optional_ -a| +a¦ [markdown] -- @@ -5072,13 +5071,13 @@ a| [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *1m.rate* + _optional_ -a| +a¦ [markdown] -- @@ -5087,13 +5086,13 @@ a| [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *5m.rate* + _optional_ -a| +a¦ [markdown] -- @@ -5102,13 +5101,13 @@ a| [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *mean.rate* + _optional_ -a| +a¦ [markdown] -- @@ -5117,13 +5116,13 @@ Mean rate since the query service started. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *max* + _optional_ -a| +a¦ [markdown] -- @@ -5132,13 +5131,13 @@ The maximum value. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *mean* + _optional_ -a| +a¦ [markdown] -- @@ -5147,13 +5146,13 @@ The mean value. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *median* + _optional_ -a| +a¦ [markdown] -- @@ -5162,13 +5161,13 @@ The median value. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *min* + _optional_ -a| +a¦ [markdown] -- @@ -5177,13 +5176,13 @@ The minimum value. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *stddev* + _optional_ -a| +a¦ [markdown] -- @@ -5192,13 +5191,13 @@ The standard deviation. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *75%* + _optional_ -a| +a¦ [markdown] -- @@ -5207,13 +5206,13 @@ The 75th percentile. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *95%* + _optional_ -a| +a¦ [markdown] -- @@ -5222,13 +5221,13 @@ The 95th percentile. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *99%* + _optional_ -a| +a¦ [markdown] -- @@ -5237,13 +5236,13 @@ The 99th percentile. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *99.9%* + _optional_ -a| +a¦ [markdown] -- @@ -5252,7 +5251,7 @@ The 99.9th percentile. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal |=== @@ -5292,14 +5291,14 @@ endif::collapse-models[] //tag::Nodes[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *cluster* + _optional_ -a| +a¦ [markdown] -- @@ -5308,13 +5307,13 @@ The name of the cluster. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *name* + _optional_ -a| +a¦ [markdown] -- @@ -5323,13 +5322,13 @@ The URL of the node, including port number. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *queryEndpoint* + _optional_ -a| +a¦ [markdown] -- @@ -5338,13 +5337,13 @@ The HTTP URL of the query endpoint. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *adminEndpoint* + _optional_ -a| +a¦ [markdown] -- @@ -5353,13 +5352,13 @@ The HTTP URL of the admin endpoint. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *querySecure* + _optional_ -a| +a¦ [markdown] -- @@ -5368,13 +5367,13 @@ The HTTPS URL of the query endpoint. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *adminSecure* + _optional_ -a| +a¦ [markdown] -- @@ -5383,13 +5382,13 @@ The HTTPS URL of the admin endpoint. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *options* + _optional_ -a| +a¦ [markdown] -- @@ -5397,7 +5396,7 @@ a| [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -5437,14 +5436,14 @@ endif::collapse-models[] //tag::Requests[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *clientContextID* + _optional_ -a| +a¦ [markdown] -- @@ -5462,13 +5461,13 @@ Refer to the [request-level][client_context_id] `client_context_id` parameter fo [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *elapsedTime* + _optional_ -a| +a¦ [markdown] -- @@ -5479,13 +5478,13 @@ It includes the time taken by the service to schedule the request. [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *errorCount* + _optional_ -a| +a¦ [markdown] -- @@ -5494,13 +5493,13 @@ Total number of errors encountered while executing the query. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *memoryQuota* + _optional_ -a| +a¦ [markdown] -- @@ -5511,13 +5510,13 @@ This property is only returned if a memory quota is set for the query. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *node* + _optional_ -a| +a¦ [markdown] -- @@ -5526,13 +5525,13 @@ IP address and port number of the node where the query is executed. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *phaseCounts* + _optional_ -a| +a¦ [markdown] -- @@ -5546,13 +5545,13 @@ Polling the active requests again may return different values. [%hardbreaks] *Example:* `{"fetch":16,"indexScan":187}` {blank} -a| Object +a¦ Object -a| +a¦ *phaseOperators* + _optional_ -a| +a¦ [markdown] -- @@ -5567,13 +5566,13 @@ A union select would have twice as many operator counts, one per each branch of [%hardbreaks] *Example:* `{"authorize":1,"fetch":1,"indexScan":2}` {blank} -a| Object +a¦ Object -a| +a¦ *phaseTimes* + _optional_ -a| +a¦ [markdown] -- @@ -5587,13 +5586,13 @@ Polling the active requests again may return different values. [%hardbreaks] *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¦ Object -a| +a¦ *remoteAddr* + _optional_ -a| +a¦ [markdown] -- @@ -5602,13 +5601,13 @@ IP address and port number of the client application, from where the query is re [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *requestId* + _optional_ -a| +a¦ [markdown] -- @@ -5617,13 +5616,13 @@ Unique request ID internally generated for the query. [%hardbreaks] {blank} -a| UUID (uuid) +a¦ UUID (uuid) -a| +a¦ *requestTime* + _optional_ -a| +a¦ [markdown] -- @@ -5632,13 +5631,13 @@ Timestamp when the query is received. [%hardbreaks] {blank} -a| Date (date-time) +a¦ Date (date-time) -a| +a¦ *resultCount* + _optional_ -a| +a¦ [markdown] -- @@ -5647,13 +5646,13 @@ Total number of documents returned in the query result. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *resultSize* + _optional_ -a| +a¦ [markdown] -- @@ -5662,13 +5661,13 @@ Total number of bytes returned in the query result. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *scanConsistency* + _optional_ -a| +a¦ [markdown] -- @@ -5677,13 +5676,13 @@ The value of the query setting Scan Consistency used for the query. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *serviceTime* + _optional_ -a| +a¦ [markdown] -- @@ -5692,13 +5691,13 @@ Total amount of calendar time taken to complete the query. [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *state* + _optional_ -a| +a¦ [markdown] -- @@ -5713,13 +5712,13 @@ To find requests that were successful, use this field in conjunction with the `e [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *statement* + _optional_ -a| +a¦ [markdown] -- @@ -5728,13 +5727,13 @@ The query statement being executed. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *useCBO* + _optional_ -a| +a¦ [markdown] -- @@ -5743,13 +5742,13 @@ Whether the cost-based optimizer is enabled for the query. [%hardbreaks] {blank} -a| Boolean +a¦ Boolean -a| +a¦ *usedMemory* + _optional_ -a| +a¦ [markdown] -- @@ -5760,13 +5759,13 @@ This property is only returned if a memory quota is set for the query. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *userAgent* + _optional_ -a| +a¦ [markdown] -- @@ -5775,13 +5774,13 @@ Name of the client application or program that issued the query. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *users* + _optional_ -a| +a¦ [markdown] -- @@ -5790,7 +5789,7 @@ Username with whose privileges the query is run. [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -5830,14 +5829,14 @@ endif::collapse-models[] //tag::Settings[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| [#atrcollection-srv] +a¦ [#atrcollection-srv] *atrcollection* + _optional_ -a| +a¦ [markdown] -- @@ -5862,16 +5861,16 @@ If a request does not include this parameter, the node-level `atrcollection` set -- [%hardbreaks] -*Default:* `pass:c[""]` -*Example:* `pass:c["default:`travel-sample`.transaction.test"]` +*Default:* `+++""+++` +*Example:* `+++"default:`travel-sample`.transaction.test"+++` {blank} -a| String +a¦ String -a| [#auto-prepare] +a¦ [#auto-prepare] *auto-prepare* + _optional_ -a| +a¦ [markdown] -- @@ -5887,13 +5886,13 @@ Refer to [Auto-Prepare][auto-prepare] for more information. *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#cleanupclientattempts] +a¦ [#cleanupclientattempts] *cleanupclientattempts* + _optional_ -a| +a¦ [markdown] -- @@ -5915,13 +5914,13 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `true` *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#cleanuplostattempts] +a¦ [#cleanuplostattempts] *cleanuplostattempts* + _optional_ -a| +a¦ [markdown] -- @@ -5943,13 +5942,13 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `true` *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#cleanupwindow] +a¦ [#cleanupwindow] *cleanupwindow* + _optional_ -a| +a¦ [markdown] -- @@ -5981,16 +5980,16 @@ When you change the cluster-level setting, the node-level setting is over-writte -- [%hardbreaks] -*Default:* `pass:c["60s"]` -*Example:* `pass:c["30s"]` +*Default:* `+++"60s"+++` +*Example:* `+++"30s"+++` {blank} -a| String (duration) +a¦ String (duration) -a| [#completed] +a¦ [#completed] *completed* + _optional_ -a| +a¦ [markdown] -- @@ -5999,13 +5998,13 @@ include::index.adoc[tag=desc-Logging_Parameters, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ <> -a| [#completed-limit] +a¦ [#completed-limit] *completed-limit* + _optional_ -a| +a¦ [markdown] -- @@ -6033,13 +6032,13 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `4000` *Example:* `7000` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#completed-max-plan-size] +a¦ [#completed-max-plan-size] *completed-max-plan-size* + _optional_ -a| +a¦ [markdown] -- @@ -6069,13 +6068,13 @@ When you change the cluster-level setting, the node-level setting is over-writte *Minimum:* `0` *Maximum:* `20840448` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#completed-threshold] +a¦ [#completed-threshold] *completed-threshold* + _optional_ -a| +a¦ [markdown] -- @@ -6104,13 +6103,13 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `1000` *Example:* `7000` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#controls-srv] +a¦ [#controls-srv] *controls* + _optional_ -a| +a¦ [markdown] -- @@ -6136,13 +6135,13 @@ If a request does not include this parameter, the node-level `controls` setting *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#cpuprofile] +a¦ [#cpuprofile] *cpuprofile* + _optional_ -a| +a¦ [markdown] -- @@ -6157,16 +6156,16 @@ To stop `cpuprofile`, run with the empty setting of `""`. -- [%hardbreaks] -*Default:* `pass:c[""]` -*Example:* `pass:c["/tmp/info.txt"]` +*Default:* `+++""+++` +*Example:* `+++"/tmp/info.txt"+++` {blank} -a| String +a¦ String -a| [#debug] +a¦ [#debug] *debug* + _optional_ -a| +a¦ [markdown] -- @@ -6180,13 +6179,13 @@ When set to `true`, extra logging is provided. *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#distribute] +a¦ [#distribute] *distribute* + _optional_ -a| +a¦ [markdown] -- @@ -6199,13 +6198,13 @@ The actual value of this field is ignored. [%hardbreaks] *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#functions-limit] +a¦ [#functions-limit] *functions-limit* + _optional_ -a| +a¦ [markdown] -- @@ -6216,13 +6215,13 @@ Maximum number of user-defined functions. *Default:* `16384` *Example:* `7000` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#keep-alive-length] +a¦ [#keep-alive-length] *keep-alive-length* + _optional_ -a| +a¦ [markdown] -- @@ -6233,13 +6232,13 @@ Maximum size of buffered result. *Default:* `16384` *Example:* `7000` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#loglevel] +a¦ [#loglevel] *loglevel* + _optional_ -a| +a¦ [markdown] -- @@ -6281,16 +6280,16 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] *Values:* `"DEBUG"`, `"TRACE"`, `"INFO"`, `"WARN"`, `"ERROR"`, `"SEVERE"`, `"NONE"` -*Default:* `pass:c["INFO"]` -*Example:* `pass:c["DEBUG"]` +*Default:* `+++"INFO"+++` +*Example:* `+++"DEBUG"+++` {blank} -a| String +a¦ String -a| [#max-index-api] +a¦ [#max-index-api] *max-index-api* + _optional_ -a| +a¦ [markdown] -- @@ -6301,13 +6300,13 @@ This setting is provided for technical support only. [%hardbreaks] {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#max-parallelism-srv] +a¦ [#max-parallelism-srv] *max-parallelism* + _optional_ -a| +a¦ [markdown] -- @@ -6346,13 +6345,13 @@ Refer to [Max Parallelism][max-parallelism] for more information. *Default:* `1` *Example:* `0` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#memory-quota-srv] +a¦ [#memory-quota-srv] *memory-quota* + _optional_ -a| +a¦ [markdown] -- @@ -6389,13 +6388,13 @@ If a request includes this parameter, it will be capped by the node-level `memor *Default:* `0` *Example:* `4` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#memprofile] +a¦ [#memprofile] *memprofile* + _optional_ -a| +a¦ [markdown] -- @@ -6408,16 +6407,16 @@ To stop `memprofile`, run with the empty setting of `""`. -- [%hardbreaks] -*Default:* `pass:c[""]` -*Example:* `pass:c["/tmp/memory-usage.log"]` +*Default:* `+++""+++` +*Example:* `+++"/tmp/memory-usage.log"+++` {blank} -a| String +a¦ String -a| [#mutexprofile] +a¦ [#mutexprofile] *mutexprofile* + _optional_ -a| +a¦ [markdown] -- @@ -6429,13 +6428,13 @@ This setting is provided for technical support only. [%hardbreaks] *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#n1ql-feat-ctrl] +a¦ [#n1ql-feat-ctrl] *n1ql-feat-ctrl* + _optional_ -a| +a¦ [markdown] -- @@ -6459,13 +6458,13 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `76` *Example:* `16460` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#node-quota] +a¦ [#node-quota] *node-quota* + _optional_ -a| +a¦ [markdown] -- @@ -6490,13 +6489,13 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] *Default:* `0` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#node-quota-val-percent] +a¦ [#node-quota-val-percent] *node-quota-val-percent* + _optional_ -a| +a¦ [markdown] -- @@ -6520,13 +6519,13 @@ When you change the cluster-level setting, the node-level setting is over-writte *Minimum:* `0` *Maximum:* `100` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#num-cpus] +a¦ [#num-cpus] *num-cpus* + _optional_ -a| +a¦ [markdown] -- @@ -6554,13 +6553,13 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] *Default:* `0` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#numatrs-srv] +a¦ [#numatrs-srv] *numatrs* + _optional_ -a| +a¦ [markdown] -- @@ -6586,13 +6585,13 @@ The minimum of that and the node-level `numatrs` setting is applied. [%hardbreaks] {blank} -a| String +a¦ String -a| [#pipeline-batch-srv] +a¦ [#pipeline-batch-srv] *pipeline-batch* + _optional_ -a| +a¦ [markdown] -- @@ -6619,13 +6618,13 @@ The minimum of that and the node-level `pipeline-batch` setting is applied. *Default:* `16` *Example:* `64` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#pipeline-cap-srv] +a¦ [#pipeline-cap-srv] *pipeline-cap* + _optional_ -a| +a¦ [markdown] -- @@ -6652,13 +6651,13 @@ The minimum of that and the node-level `pipeline-cap` setting is applied. *Default:* `512` *Example:* `1024` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#plus-servicers] +a¦ [#plus-servicers] *plus-servicers* + _optional_ -a| +a¦ [markdown] -- @@ -6670,13 +6669,13 @@ The default is 16 times the number of logical cores. [%hardbreaks] *Example:* `16` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#prepared-limit] +a¦ [#prepared-limit] *prepared-limit* + _optional_ -a| +a¦ [markdown] -- @@ -6699,13 +6698,13 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `16384` *Example:* `65536` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#pretty-srv] +a¦ [#pretty-srv] *pretty* + _optional_ -a| +a¦ [markdown] -- @@ -6727,13 +6726,13 @@ If a request does not include this parameter, the node-level setting is used, wh *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#profile-srv] +a¦ [#profile-srv] *profile* + _optional_ -a| +a¦ [markdown] -- @@ -6767,16 +6766,16 @@ If a request does not include this parameter, the node-level `profile` setting w [%hardbreaks] *Values:* `"off"`, `"phases"`, `"timings"` -*Default:* `pass:c["off"]` -*Example:* `pass:c["phases"]` +*Default:* `+++"off"+++` +*Example:* `+++"phases"+++` {blank} -a| String +a¦ String -a| [#request-size-cap] +a¦ [#request-size-cap] *request-size-cap* + _optional_ -a| +a¦ [markdown] -- @@ -6787,13 +6786,13 @@ Maximum size of a request. *Default:* `67108864` *Example:* `70000` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#scan-cap-srv] +a¦ [#scan-cap-srv] *scan-cap* + _optional_ -a| +a¦ [markdown] -- @@ -6824,13 +6823,13 @@ The minimum of that and the node-level `scan-cap` setting is applied. *Default:* `512` *Example:* `1024` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#servicers] +a¦ [#servicers] *servicers* + _optional_ -a| +a¦ [markdown] -- @@ -6845,13 +6844,13 @@ Note that the overall node memory quota is this setting multiplied by the [node- *Default:* `32` *Example:* `8` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#timeout-srv] +a¦ [#timeout-srv] *timeout* + _optional_ -a| +a¦ [markdown] -- @@ -6884,13 +6883,13 @@ The minimum of that and the node-level `timeout` setting is applied. *Default:* `0` *Example:* `500000000` {blank} -a| Long (int64) +a¦ Long (int64) -a| [#txtimeout-srv] +a¦ [#txtimeout-srv] *txtimeout* + _optional_ -a| +a¦ [markdown] -- @@ -6927,13 +6926,13 @@ The minimum of that and the node-level `txtimeout` setting is applied. *Default:* `0` *Example:* `500000000` {blank} -a| Long (int64) +a¦ Long (int64) -a| [#use-cbo-srv] +a¦ [#use-cbo-srv] *use-cbo* + _optional_ -a| +a¦ [markdown] -- @@ -6960,13 +6959,13 @@ If a request does not include this parameter, the node-level setting is used, wh *Default:* `true` *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#use-replica-srv] +a¦ [#use-replica-srv] *use-replica* + _optional_ -a| +a¦ [markdown] -- @@ -7007,10 +7006,10 @@ If a query uses sequential scan and a data node becomes unavailable, the query m [%hardbreaks] *Values:* `"off"`, `"on"`, `"unset"` -*Default:* `pass:c["unset"]` -*Example:* `pass:c["on"]` +*Default:* `+++"unset"+++` +*Example:* `+++"on"+++` {blank} -a| String +a¦ String |=== @@ -7050,14 +7049,14 @@ endif::collapse-models[] //tag::Statements[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *encoded_plan* + _required_ -a| +a¦ [markdown] -- @@ -7066,13 +7065,13 @@ The full prepared statement in encoded format. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *featureControls* + _optional_ -a| +a¦ [markdown] -- @@ -7083,13 +7082,13 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *indexApiVersion* + _optional_ -a| +a¦ [markdown] -- @@ -7100,13 +7099,13 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *name* + _required_ -a| +a¦ [markdown] -- @@ -7117,13 +7116,13 @@ This may be a UUID that was assigned automatically, or a name that was user-spec [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *namespace* + _optional_ -a| +a¦ [markdown] -- @@ -7134,13 +7133,13 @@ Currently, only the `default` namespace is available. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *node* + _optional_ -a| +a¦ [markdown] -- @@ -7150,13 +7149,13 @@ The node on which the prepared statement is stored. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *statement* + _required_ -a| +a¦ [markdown] -- @@ -7165,13 +7164,13 @@ The text of the query. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *uses* + _required_ -a| +a¦ [markdown] -- @@ -7180,13 +7179,13 @@ The count of times the prepared statement has been executed. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *avgElapsedTime* + _optional_ -a| +a¦ [markdown] -- @@ -7200,13 +7199,13 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *avgServiceTime* + _optional_ -a| +a¦ [markdown] -- @@ -7219,13 +7218,13 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *lastUse* + _optional_ -a| +a¦ [markdown] -- @@ -7237,13 +7236,13 @@ This property is only returned when the prepared statement has been executed. [%hardbreaks] {blank} -a| Date (date-time) +a¦ Date (date-time) -a| +a¦ *maxElapsedTime* + _optional_ -a| +a¦ [markdown] -- @@ -7257,13 +7256,13 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *maxServiceTime* + _optional_ -a| +a¦ [markdown] -- @@ -7276,13 +7275,13 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *minElapsedTime* + _optional_ -a| +a¦ [markdown] -- @@ -7296,13 +7295,13 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *minServiceTime* + _optional_ -a| +a¦ [markdown] -- @@ -7315,7 +7314,7 @@ It is only returned when retrieving a specific prepared statement, not when retr [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) |=== @@ -7355,14 +7354,14 @@ endif::collapse-models[] //tag::Statistics[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *active_requests.count* + _optional_ -a| +a¦ [markdown] -- @@ -7371,13 +7370,13 @@ Total number of active requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *at_plus.count* + _optional_ -a| +a¦ [markdown] -- @@ -7386,13 +7385,13 @@ Total number of query requests with `at_plus` index consistency. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *audit_actions.count* + _optional_ -a| +a¦ [markdown] -- @@ -7404,13 +7403,13 @@ Records in the output queue that have not yet been sent to the server are not co [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *audit_actions_failed.count* + _optional_ -a| +a¦ [markdown] -- @@ -7419,13 +7418,13 @@ The total number of audit records sent to the server that failed. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *audit_requests_filtered.count* + _optional_ -a| +a¦ [markdown] -- @@ -7434,13 +7433,13 @@ The number of potentially auditable requests that cause no audit action to be ta [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *audit_requests_total.count* + _optional_ -a| +a¦ [markdown] -- @@ -7449,13 +7448,13 @@ The total number of potentially auditable requests sent to the query engine. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *cancelled.count* + _optional_ -a| +a¦ [markdown] -- @@ -7464,13 +7463,13 @@ Total number of cancelled requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *deletes.count* + _optional_ -a| +a¦ [markdown] -- @@ -7479,13 +7478,13 @@ Total number of DELETE operations. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *errors.count* + _optional_ -a| +a¦ [markdown] -- @@ -7494,13 +7493,13 @@ The total number of query errors returned so far. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *index_scans.count* + _optional_ -a| +a¦ [markdown] -- @@ -7509,13 +7508,13 @@ Total number of secondary index scans. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *inserts.count* + _optional_ -a| +a¦ [markdown] -- @@ -7524,13 +7523,13 @@ Total number of INSERT operations. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *invalid_requests.count* + _optional_ -a| +a¦ [markdown] -- @@ -7539,13 +7538,13 @@ Total number of requests for unsupported endpoints. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *mutations.count* + _optional_ -a| +a¦ [markdown] -- @@ -7554,13 +7553,13 @@ Total number of document mutations. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *prepared.count* + _optional_ -a| +a¦ [markdown] -- @@ -7569,13 +7568,13 @@ Total number of prepared statements executed. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *primary_scans.count* + _optional_ -a| +a¦ [markdown] -- @@ -7584,13 +7583,13 @@ Total number of primary index scans. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *queued_requests.count* + _optional_ -a| +a¦ [markdown] -- @@ -7599,13 +7598,13 @@ Total number of queued requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request_time.count* + _optional_ -a| +a¦ [markdown] -- @@ -7614,13 +7613,13 @@ Total end-to-end time to process all queries (ns). [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request_timer.15m.rate* + _optional_ -a| +a¦ [markdown] -- @@ -7631,13 +7630,13 @@ Number of query requests processed per second. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.1m.rate* + _optional_ -a| +a¦ [markdown] -- @@ -7648,13 +7647,13 @@ Number of query requests processed per second. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.5m.rate* + _optional_ -a| +a¦ [markdown] -- @@ -7665,13 +7664,13 @@ Number of query requests processed per second. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.75%* + _optional_ -a| +a¦ [markdown] -- @@ -7682,13 +7681,13 @@ The 75th percentile. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.95%* + _optional_ -a| +a¦ [markdown] -- @@ -7699,13 +7698,13 @@ The 95th percentile. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.99%* + _optional_ -a| +a¦ [markdown] -- @@ -7716,13 +7715,13 @@ The 99th percentile. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.99.9%* + _optional_ -a| +a¦ [markdown] -- @@ -7733,13 +7732,13 @@ The 99.9th percentile. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.count* + _optional_ -a| +a¦ [markdown] -- @@ -7748,13 +7747,13 @@ Total number of query requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request_timer.max* + _optional_ -a| +a¦ [markdown] -- @@ -7765,13 +7764,13 @@ The maximum value. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request_timer.mean* + _optional_ -a| +a¦ [markdown] -- @@ -7782,13 +7781,13 @@ The mean value. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.mean.rate* + _optional_ -a| +a¦ [markdown] -- @@ -7799,13 +7798,13 @@ Mean rate since the query service started. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.median* + _optional_ -a| +a¦ [markdown] -- @@ -7816,13 +7815,13 @@ The median value. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.min* + _optional_ -a| +a¦ [markdown] -- @@ -7833,13 +7832,13 @@ The minimum value. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request_timer.stddev* + _optional_ -a| +a¦ [markdown] -- @@ -7850,13 +7849,13 @@ The standard deviation. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *requests.count* + _optional_ -a| +a¦ [markdown] -- @@ -7865,13 +7864,13 @@ Total number of query requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *requests_1000ms.count* + _optional_ -a| +a¦ [markdown] -- @@ -7880,13 +7879,13 @@ Number of queries that take longer than 1000ms. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *requests_250ms.count* + _optional_ -a| +a¦ [markdown] -- @@ -7895,13 +7894,13 @@ Number of queries that take longer than 250ms. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *requests_5000ms.count* + _optional_ -a| +a¦ [markdown] -- @@ -7910,13 +7909,13 @@ Number of queries that take longer than 5000ms. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *requests_500ms.count* + _optional_ -a| +a¦ [markdown] -- @@ -7925,13 +7924,13 @@ Number of queries that take longer than 500ms. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *result_count.count* + _optional_ -a| +a¦ [markdown] -- @@ -7940,13 +7939,13 @@ Total number of results (documents) returned by the query engine. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *result_size.count* + _optional_ -a| +a¦ [markdown] -- @@ -7955,13 +7954,13 @@ Total size of data returned by the query engine (bytes). [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *scan_plus.count* + _optional_ -a| +a¦ [markdown] -- @@ -7970,13 +7969,13 @@ Total number of query requests with `request_plus` index consistency. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *selects.count* + _optional_ -a| +a¦ [markdown] -- @@ -7985,13 +7984,13 @@ Total number of SELECT requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *service_time.count* + _optional_ -a| +a¦ [markdown] -- @@ -8000,13 +7999,13 @@ Time to execute all queries (ns). [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *unbounded.count* + _optional_ -a| +a¦ [markdown] -- @@ -8015,13 +8014,13 @@ Total number of query requests with `not_bounded` index consistency. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *updates.count* + _optional_ -a| +a¦ [markdown] -- @@ -8030,13 +8029,13 @@ Total number of UPDATE requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *warnings.count* + _optional_ -a| +a¦ [markdown] -- @@ -8045,7 +8044,7 @@ The total number of query warnings returned so far. [%hardbreaks] {blank} -a| Integer +a¦ Integer |=== @@ -8085,14 +8084,14 @@ endif::collapse-models[] //tag::Vitals[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *bucket.IO.stats* + _optional_ -a| +a¦ [markdown] -- @@ -8101,13 +8100,13 @@ The number of reads and retries for each bucket. [%hardbreaks] {blank} -a| Object +a¦ Object -a| +a¦ *uptime* + _optional_ -a| +a¦ [markdown] -- @@ -8116,13 +8115,13 @@ The uptime of the query engine. [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *local.time* + _optional_ -a| +a¦ [markdown] -- @@ -8131,13 +8130,13 @@ The local time of the query engine. [%hardbreaks] {blank} -a| Date (date-time) +a¦ Date (date-time) -a| +a¦ *version* + _optional_ -a| +a¦ [markdown] -- @@ -8146,13 +8145,13 @@ The version of the query engine. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *total.threads* + _optional_ -a| +a¦ [markdown] -- @@ -8161,13 +8160,13 @@ The number of active threads used by the query engine. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *cores* + _optional_ -a| +a¦ [markdown] -- @@ -8176,13 +8175,13 @@ The maximum number of logical cores available to the query engine. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *ffdc.total* + _optional_ -a| +a¦ [markdown] -- @@ -8191,13 +8190,13 @@ The total number of times FFDC has been invoked since the last restart. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *gc.num* + _optional_ -a| +a¦ [markdown] -- @@ -8206,13 +8205,13 @@ The target heap size of the next garbage collection cycle. [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *gc.pause.time* + _optional_ -a| +a¦ [markdown] -- @@ -8221,13 +8220,13 @@ The total time spent pausing for garbage collection since the query engine start [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *gc.pause.percent* + _optional_ -a| +a¦ [markdown] -- @@ -8236,13 +8235,13 @@ The percentage of time spent pausing for garbage collection since the last time [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *healthy* + _optional_ -a| +a¦ [markdown] -- @@ -8251,13 +8250,13 @@ False when either the unbounded or plus request queues are full; true otherwise. [%hardbreaks] {blank} -a| Boolean +a¦ Boolean -a| +a¦ *host.memory.free* + _optional_ -a| +a¦ [markdown] -- @@ -8266,13 +8265,13 @@ Amount of free memory on the host. [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *host.memory.quota* + _optional_ -a| +a¦ [markdown] -- @@ -8283,13 +8282,13 @@ This reflects the node-quota setting. [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *host.memory.total* + _optional_ -a| +a¦ [markdown] -- @@ -8298,13 +8297,13 @@ Total memory on the host. [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *host.memory.value_quota* + _optional_ -a| +a¦ [markdown] -- @@ -8313,13 +8312,13 @@ This the total document memory quota on the node. [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *load* + _optional_ -a| +a¦ [markdown] -- @@ -8328,13 +8327,13 @@ A calculation for how busy the server is. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *loadfactor* + _optional_ -a| +a¦ [markdown] -- @@ -8343,13 +8342,13 @@ The moving 15 minute average of the load calculation. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *memory.usage* + _optional_ -a| +a¦ [markdown] -- @@ -8360,13 +8359,13 @@ This increases as heap objects are allocated, and decreases as objects are freed [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *memory.total* + _optional_ -a| +a¦ [markdown] -- @@ -8377,13 +8376,13 @@ This increases as heap objects are allocated, but does not decrease when objects [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *memory.system* + _optional_ -a| +a¦ [markdown] -- @@ -8394,13 +8393,13 @@ This measures the virtual address space reserved by the query engine for heaps, [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *node* + _optional_ -a| +a¦ [markdown] -- @@ -8409,13 +8408,13 @@ The name or IP address and port of the node. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *node.allocated.values* + _optional_ -a| +a¦ [markdown] -- @@ -8426,13 +8425,13 @@ The total number of values allocated to contain documents or computations around [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *node.memory.usage* + _optional_ -a| +a¦ [markdown] -- @@ -8441,13 +8440,13 @@ The currently allocated document memory on the node. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *cpu.user.percent* + _optional_ -a| +a¦ [markdown] -- @@ -8458,13 +8457,13 @@ The percentage of time spent executing user code since the last time the statist [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *cpu.sys.percent* + _optional_ -a| +a¦ [markdown] -- @@ -8475,13 +8474,13 @@ The percentage of time spent executing system code since the last time the stati [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *process.memory.usage* + _optional_ -a| +a¦ [markdown] -- @@ -8490,13 +8489,13 @@ Current process memory use. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *process.percore.cpupercent* + _optional_ -a| +a¦ [markdown] -- @@ -8505,13 +8504,13 @@ Average CPU usage per core. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *process.rss* + _optional_ -a| +a¦ [markdown] -- @@ -8520,13 +8519,13 @@ Process RSS (bytes) [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *process.service.usage* + _optional_ -a| +a¦ [markdown] -- @@ -8535,13 +8534,13 @@ The number of active servicers for the dominant workload — unbound queue s [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request.completed.count* + _optional_ -a| +a¦ [markdown] -- @@ -8550,13 +8549,13 @@ Total number of completed requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request.active.count* + _optional_ -a| +a¦ [markdown] -- @@ -8565,13 +8564,13 @@ Total number of active requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request.per.sec.1min* + _optional_ -a| +a¦ [markdown] -- @@ -8582,13 +8581,13 @@ Number of query requests processed per second. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request.per.sec.5min* + _optional_ -a| +a¦ [markdown] -- @@ -8599,13 +8598,13 @@ Number of query requests processed per second. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request.per.sec.15min* + _optional_ -a| +a¦ [markdown] -- @@ -8616,13 +8615,13 @@ Number of query requests processed per second. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request.queued.count* + _optional_ -a| +a¦ [markdown] -- @@ -8631,13 +8630,13 @@ Number of queued requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request.quota.used.hwm* + _optional_ -a| +a¦ [markdown] -- @@ -8646,13 +8645,13 @@ High water mark for request quota use. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request_time.mean* + _optional_ -a| +a¦ [markdown] -- @@ -8663,13 +8662,13 @@ The mean value. [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *request_time.median* + _optional_ -a| +a¦ [markdown] -- @@ -8680,13 +8679,13 @@ The median value. [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *request_time.80percentile* + _optional_ -a| +a¦ [markdown] -- @@ -8697,13 +8696,13 @@ The 80th percentile. [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *request_time.95percentile* + _optional_ -a| +a¦ [markdown] -- @@ -8714,13 +8713,13 @@ The 95th percentile. [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *request_time.99percentile* + _optional_ -a| +a¦ [markdown] -- @@ -8731,13 +8730,13 @@ The 99th percentile. [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *request.prepared.percent* + _optional_ -a| +a¦ [markdown] -- @@ -8746,13 +8745,13 @@ Percentage of requests that are prepared statements. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *servicers.paused.count* + _optional_ -a| +a¦ [markdown] -- @@ -8763,13 +8762,13 @@ Number of servicers temporarily paused due to memory pressure. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *servicers.paused.total* + _optional_ -a| +a¦ [markdown] -- @@ -8780,13 +8779,13 @@ Number of times servicers have been temporarily paused. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *temp.hwm* + _optional_ -a| +a¦ [markdown] -- @@ -8797,13 +8796,13 @@ High water mark for temp space use directly by query. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *temp.usage* + _optional_ -a| +a¦ [markdown] -- @@ -8814,7 +8813,7 @@ Current Query temp space use. [%hardbreaks] {blank} -a| Integer +a¦ Integer |=== @@ -8896,3 +8895,4 @@ include::{specDir}security/document-end.adoc[opts=optional] include::{specDir}security/document-after.adoc[opts=optional] + diff --git a/docs/modules/n1ql-rest-functions/pages/index.adoc b/docs/modules/n1ql-rest-functions/pages/index.adoc index ec2a1e53..40db58fe 100644 --- a/docs/modules/n1ql-rest-functions/pages/index.adoc +++ b/docs/modules/n1ql-rest-functions/pages/index.adoc @@ -58,7 +58,7 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* @@ -69,7 +69,7 @@ The host name or IP address of a node running the Query service. [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* @@ -80,7 +80,7 @@ The Query service REST port. Use `18093` for secure access. [%hardbreaks] *Values:* `8093`, `18093` -*Example:* `pass:c[8093]` +*Example:* `+++8093+++` // end |=== @@ -178,6 +178,9 @@ For a scoped library, you must specify the bucket and scope. include::{specDir}paths/delete_library/operation-description-end.adoc[opts=optional] + + + :leveloffset: -1 @@ -200,13 +203,13 @@ include::{specDir}paths/delete_library/operation-description-end.adoc[opts=optio .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *library* + +a¦ *library* + _required_ -a| +a¦ [markdown] @@ -217,7 +220,7 @@ The name of a library. [%hardbreaks] {blank} -a| String +a¦ String @@ -227,13 +230,13 @@ a| String .Query Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *bucket* + +a¦ *bucket* + _optional_ -a| +a¦ [markdown] @@ -245,13 +248,13 @@ For scoped libraries only. The bucket in which the library is stored. [%hardbreaks] {blank} -a| String +a¦ String -a| *scope* + +a¦ *scope* + _optional_ -a| +a¦ [markdown] @@ -263,7 +266,7 @@ For scoped libraries only. The scope in which the library is stored. [%hardbreaks] {blank} -a| String +a¦ String @@ -284,8 +287,6 @@ include::{specDir}paths/delete_library/operation-parameters-end.adoc[opts=option - - // markup not found, no include::{specDir}paths/delete_library/operation-responses-before.adoc[opts=optional] @@ -421,6 +422,12 @@ By default, this operation returns all global libraries and functions, and all s // markup not found, no include::{specDir}paths/get_collection/operation-description-end.adoc[opts=optional] + + +[#get_collection-produces] +.Produces +* application/json + :leveloffset: -1 @@ -444,13 +451,13 @@ By default, this operation returns all global libraries and functions, and all s .Query Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *bucket* + +a¦ *bucket* + _optional_ -a| +a¦ [markdown] @@ -462,13 +469,13 @@ For scoped libraries only. The bucket from which to fetch libraries. [%hardbreaks] {blank} -a| String +a¦ String -a| *scope* + +a¦ *scope* + _optional_ -a| +a¦ [markdown] @@ -480,7 +487,7 @@ For scoped libraries only. The scope from which to fetch libraries. [%hardbreaks] {blank} -a| String +a¦ String @@ -500,12 +507,6 @@ include::{specDir}paths/get_collection/operation-parameters-end.adoc[opts=option // markup not found, no include::{specDir}paths/get_collection/operation-parameters-after.adoc[opts=optional] -[#get_collection-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_collection/operation-responses-before.adoc[opts=optional] @@ -638,6 +639,12 @@ By default, this operation returns a global library. For a scoped library, you m // markup not found, no include::{specDir}paths/get_library/operation-description-end.adoc[opts=optional] + + +[#get_library-produces] +.Produces +* application/json + :leveloffset: -1 @@ -660,13 +667,13 @@ By default, this operation returns a global library. For a scoped library, you m .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *library* + +a¦ *library* + _required_ -a| +a¦ [markdown] @@ -677,7 +684,7 @@ The name of a library. [%hardbreaks] {blank} -a| String +a¦ String @@ -687,13 +694,13 @@ a| String .Query Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *bucket* + +a¦ *bucket* + _optional_ -a| +a¦ [markdown] @@ -705,13 +712,13 @@ For scoped libraries only. The bucket in which the library is stored. [%hardbreaks] {blank} -a| String +a¦ String -a| *scope* + +a¦ *scope* + _optional_ -a| +a¦ [markdown] @@ -723,7 +730,7 @@ For scoped libraries only. The scope in which the library is stored. [%hardbreaks] {blank} -a| String +a¦ String @@ -743,12 +750,6 @@ include::{specDir}paths/get_library/operation-parameters-end.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_library/operation-parameters-after.adoc[opts=optional] -[#get_library-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_library/operation-responses-before.adoc[opts=optional] @@ -887,6 +888,12 @@ By default, this operation creates or updates a global library. For a scoped lib include::{specDir}paths/post_library/operation-description-end.adoc[opts=optional] + +[#post_library-consumes] +.Consumes +* application/json + + :leveloffset: -1 @@ -909,13 +916,13 @@ include::{specDir}paths/post_library/operation-description-end.adoc[opts=optiona .Path Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *library* + +a¦ *library* + _required_ -a| +a¦ [markdown] @@ -926,7 +933,7 @@ The name of a library. [%hardbreaks] {blank} -a| String +a¦ String @@ -936,13 +943,13 @@ a| String .Query Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *bucket* + +a¦ *bucket* + _optional_ -a| +a¦ [markdown] @@ -954,13 +961,13 @@ For scoped libraries only. The bucket in which the library is stored. [%hardbreaks] {blank} -a| String +a¦ String -a| *scope* + +a¦ *scope* + _optional_ -a| +a¦ [markdown] @@ -972,7 +979,7 @@ For scoped libraries only. The scope in which the library is stored. [%hardbreaks] {blank} -a| String +a¦ String @@ -984,13 +991,13 @@ a| String .Body Parameter {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *Body* + +a¦ *Body* + _required_ -a| +a¦ [markdown] @@ -1001,7 +1008,7 @@ The JavaScript code for all functions in the library. [%hardbreaks] {blank} -a| String +a¦ String @@ -1019,12 +1026,6 @@ include::{specDir}paths/post_library/operation-parameters-end.adoc[opts=optional -[#post_library-consumes] -= Consumes - -* application/json - - // markup not found, no include::{specDir}paths/post_library/operation-responses-before.adoc[opts=optional] @@ -1181,14 +1182,14 @@ endif::collapse-models[] //tag::Functions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ _additional + property_ -a| +a¦ [markdown] -- @@ -1199,9 +1200,9 @@ The name of the property is the name of the library. -- [%hardbreaks] -*Example:* `pass:c["function add(a, b) { return a + b; } function mul(a, b) { return a * b; }"]` +*Example:* `+++"function add(a, b) { return a + b; } function mul(a, b) { return a * b; }"+++` {blank} -a| String +a¦ String |=== @@ -1241,14 +1242,14 @@ endif::collapse-models[] //tag::Libraries[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *name* + _required_ -a| +a¦ [markdown] -- @@ -1256,15 +1257,15 @@ The name of a library. -- [%hardbreaks] -*Example:* `pass:c["math"]` +*Example:* `+++"math"+++` {blank} -a| String +a¦ String -a| +a¦ *bucket* + _required_ -a| +a¦ [markdown] -- @@ -1273,15 +1274,15 @@ For scoped libraries, the bucket in which the library is stored. For global libr -- [%hardbreaks] -*Example:* `pass:c["travel-sample"]` +*Example:* `+++"travel-sample"+++` {blank} -a| String +a¦ String -a| +a¦ *scope* + _required_ -a| +a¦ [markdown] -- @@ -1290,15 +1291,15 @@ For scoped libraries, the scope in which the library is stored. For global libra -- [%hardbreaks] -*Example:* `pass:c["inventory"]` +*Example:* `+++"inventory"+++` {blank} -a| String +a¦ String -a| +a¦ *code* + _required_ -a| +a¦ [markdown] -- @@ -1307,9 +1308,9 @@ The JavaScript code for all functions in the library. -- [%hardbreaks] -*Example:* `pass:c["function add(a, b) { return a + b; } function mul(a, b) { return a * b; }"]` +*Example:* `+++"function add(a, b) { return a + b; } function mul(a, b) { return a * b; }"+++` {blank} -a| String +a¦ String |=== @@ -1426,3 +1427,4 @@ include::{specDir}security/document-end.adoc[opts=optional] // markup not found, no 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 39c7e1a9..30685246 100644 --- a/docs/modules/n1ql-rest-query/pages/index.adoc +++ b/docs/modules/n1ql-rest-query/pages/index.adoc @@ -59,7 +59,7 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* @@ -70,7 +70,7 @@ The host name or IP address of a node running the Query service. [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* @@ -81,7 +81,7 @@ The Query service REST port. Use `18093` for secure access. [%hardbreaks] *Values:* `8093`, `18093` -*Example:* `pass:c[8093]` +*Example:* `+++8093+++` // end |=== @@ -176,6 +176,12 @@ This endpoint is intended for situations where use of the `POST` method is restr // markup not found, no include::{specDir}paths/get_service/operation-description-end.adoc[opts=optional] + + +[#get_service-produces] +.Produces +* application/json + :leveloffset: -1 @@ -199,13 +205,13 @@ This endpoint is intended for situations where use of the `POST` method is restr .Query Parameters {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *body* + +a¦ *body* + _required_ -a| +a¦ [markdown] @@ -217,7 +223,7 @@ The format for URL-encoded parameters is consistent with the syntax for variable [%hardbreaks] {blank} -a| <> +a¦ <> @@ -237,12 +243,6 @@ a| <> // markup not found, no include::{specDir}paths/get_service/operation-parameters-after.adoc[opts=optional] -[#get_service-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_service/operation-responses-before.adoc[opts=optional] @@ -427,6 +427,16 @@ Enables you to execute a SQL++ statement. This method allows you to run queries // markup not found, no include::{specDir}paths/post_service/operation-description-end.adoc[opts=optional] + +[#post_service-consumes] +.Consumes +* application/json +* application/x-www-form-urlencoded + +[#post_service-produces] +.Produces +* application/json + :leveloffset: -1 @@ -453,13 +463,13 @@ include::{specDir}paths/post_service/operation-parameters-begin.adoc[opts=option .Body Parameter {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *Body* + +a¦ *Body* + _required_ -a| +a¦ [markdown] @@ -470,7 +480,7 @@ An object specifying one or more query parameters. [%hardbreaks] {blank} -a| <> +a¦ <> @@ -487,17 +497,6 @@ a| <> // markup not found, no include::{specDir}paths/post_service/operation-parameters-after.adoc[opts=optional] -[#post_service-produces] -= Produces - -* application/json - -[#post_service-consumes] -= Consumes - -* application/json -* application/x-www-form-urlencoded - // markup not found, no include::{specDir}paths/post_service/operation-responses-before.adoc[opts=optional] @@ -717,14 +716,14 @@ Errors and warnings have the following format. //end::desc-Conditions[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *code* + _required_ -a| +a¦ [markdown] -- @@ -734,13 +733,13 @@ A unique number that identifies the error or warning. The code ranges are partit [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *msg* + _required_ -a| +a¦ [markdown] -- @@ -750,13 +749,13 @@ A message describing the error or warning in detail. This property is always pre [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *name* + _optional_ -a| +a¦ [markdown] -- @@ -765,15 +764,15 @@ Unique name that has a 1:1 mapping to the code. Uniquely identifies the conditio -- [%hardbreaks] -*Example:* `pass:c["indexing.scan.io_failure"]` +*Example:* `+++"indexing.scan.io_failure"+++` {blank} -a| String +a¦ String -a| +a¦ *sev* + _optional_ -a| +a¦ [markdown] -- @@ -788,13 +787,13 @@ One of the following SQL++ severity levels, listed in order of severity: [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *temp* + _optional_ -a| +a¦ [markdown] -- @@ -804,7 +803,7 @@ Indicates if the condition is transient — for example, the queue is full. [%hardbreaks] {blank} -a| Boolean +a¦ Boolean |=== @@ -850,14 +849,14 @@ An object containing runtime information provided along with the request. Presen //end::desc-Controls[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *scan_consistency* + _optional_ -a| +a¦ [markdown] -- @@ -866,13 +865,13 @@ The value of the query setting Scan Consistency used for the query. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *use_cbo* + _optional_ -a| +a¦ [markdown] -- @@ -881,13 +880,13 @@ Whether the cost-based optimizer was enabled for the query. [%hardbreaks] {blank} -a| Boolean +a¦ Boolean -a| +a¦ *memoryQuota* + _optional_ -a| +a¦ [markdown] -- @@ -897,13 +896,13 @@ The memory quota for the request, in MB. This property is only returned if a mem [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) -a| +a¦ *stmtType* + _optional_ -a| +a¦ [markdown] -- @@ -911,9 +910,9 @@ The type of query statement. -- [%hardbreaks] -*Example:* `pass:c["SELECT"]` +*Example:* `+++"SELECT"+++` {blank} -a| String +a¦ String |=== @@ -953,14 +952,14 @@ endif::collapse-models[] //tag::Credentials[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *user* + _optional_ -a| +a¦ [markdown] -- @@ -969,15 +968,15 @@ An identity for authentication. Note that bucket names may be prefixed with `loc -- [%hardbreaks] -*Example:* `pass:c["local:bucket-name"]` +*Example:* `+++"local:bucket-name"+++` {blank} -a| String +a¦ String -a| +a¦ *pass* + _optional_ -a| +a¦ [markdown] -- @@ -985,9 +984,9 @@ A password for authentication. -- [%hardbreaks] -*Example:* `pass:c["password"]` +*Example:* `+++"password"+++` {blank} -a| String +a¦ String |=== @@ -1035,14 +1034,14 @@ The execution details for various phases involved in the query execution, such a //end::desc-Execution_Timings[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *#operator* + _required_ -a| +a¦ [markdown] -- @@ -1050,15 +1049,15 @@ Name of the operator. -- [%hardbreaks] -*Example:* `pass:c["Fetch"]` +*Example:* `+++"Fetch"+++` {blank} -a| String +a¦ String -a| +a¦ *#stats* + _required_ -a| +a¦ [markdown] -- @@ -1067,13 +1066,13 @@ include::index.adoc[tag=desc-Statistics, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ <> -a| +a¦ *~child* + _optional_ -a| +a¦ [markdown] -- @@ -1082,7 +1081,7 @@ Further nested operators, each with their own execution timings. [%hardbreaks] {blank} -a| Object +a¦ Object |=== @@ -1127,14 +1126,14 @@ An object containing metrics about the request. //end::desc-Metrics[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *elapsedTime* + _required_ -a| +a¦ [markdown] -- @@ -1143,13 +1142,13 @@ The total time taken for the request, that is the time from when the request was [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *executionTime* + _required_ -a| +a¦ [markdown] -- @@ -1158,13 +1157,13 @@ The time taken for the execution of the request, that is the time from when quer [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *resultCount* + _required_ -a| +a¦ [markdown] -- @@ -1173,13 +1172,13 @@ The total number of objects in the results. [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) -a| +a¦ *resultSize* + _required_ -a| +a¦ [markdown] -- @@ -1188,13 +1187,13 @@ The total number of bytes in the results. [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) -a| +a¦ *mutationCount* + _optional_ -a| +a¦ [markdown] -- @@ -1203,13 +1202,13 @@ The number of mutations that were made during the request. [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) -a| +a¦ *sortCount* + _optional_ -a| +a¦ [markdown] -- @@ -1221,13 +1220,13 @@ If a query includes ORDER BY, LIMIT, or OFFSET clauses, an application can use t [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) -a| +a¦ *usedMemory* + _optional_ -a| +a¦ [markdown] -- @@ -1237,13 +1236,13 @@ The amount of document memory used to execute the request. This property is only [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) -a| +a¦ *errorCount* + _optional_ -a| +a¦ [markdown] -- @@ -1252,13 +1251,13 @@ The number of errors that occurred during the request. [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) -a| +a¦ *warningCount* + _optional_ -a| +a¦ [markdown] -- @@ -1267,7 +1266,7 @@ The number of warnings that occurred during the request. [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) |=== @@ -1313,14 +1312,14 @@ An object containing monitoring and profiling information about the request. Pre //end::desc-Profile[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *requestTime* + _required_ -a| +a¦ [markdown] -- @@ -1329,13 +1328,13 @@ Timestamp when the query was received. [%hardbreaks] {blank} -a| Date (date-time) +a¦ Date (date-time) -a| +a¦ *servicingHost* + _required_ -a| +a¦ [markdown] -- @@ -1344,13 +1343,13 @@ IP address and port number of the node where the query was executed. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *phaseCounts* + _required_ -a| +a¦ [markdown] -- @@ -1361,13 +1360,13 @@ Count of documents processed at selective phases involved in the query execution [%hardbreaks] *Example:* `{"fetch":16,"indexScan":187}` {blank} -a| Object +a¦ Object -a| +a¦ *phaseOperators* + _required_ -a| +a¦ [markdown] -- @@ -1384,13 +1383,13 @@ This is in essence the count of all the operators in the `executionTimings` obje [%hardbreaks] *Example:* `{"authorize":1,"fetch":1,"indexScan":2}` {blank} -a| Object +a¦ Object -a| +a¦ *phaseTimes* + _required_ -a| +a¦ [markdown] -- @@ -1401,13 +1400,13 @@ Cumulative execution times for various phases involved in the query execution, s [%hardbreaks] *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¦ Object -a| +a¦ *executionTimings* + _optional_ -a| +a¦ [markdown] -- @@ -1416,7 +1415,7 @@ include::index.adoc[tag=desc-Execution_Timings, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ <> |=== @@ -1456,14 +1455,14 @@ endif::collapse-models[] //tag::Request[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| [#args] +a¦ [#args] *args* + _optional_ -a| +a¦ [markdown] -- @@ -1481,13 +1480,13 @@ Refer to [Named Parameters and Positional Parameters][section_srh_tlm_n1b] for d [%hardbreaks] *Example:* `["LAX",6]` {blank} -a| Any Type +a¦ Any Type array -a| [#atrcollection_req] +a¦ [#atrcollection_req] *atrcollection* + _optional_ -a| +a¦ [markdown] -- @@ -1512,15 +1511,15 @@ The request-level parameter overrides the node-level setting. -- [%hardbreaks] -*Example:* `pass:c["default:`travel-sample`.transaction.test"]` +*Example:* `+++"default:`travel-sample`.transaction.test"+++` {blank} -a| String +a¦ String -a| [#auto_execute] +a¦ [#auto_execute] *auto_execute* + _optional_ -a| +a¦ [markdown] -- @@ -1537,13 +1536,13 @@ Refer to [Auto-Execute][auto-execute] for more information. *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#client_context_id] +a¦ [#client_context_id] *client_context_id* + _optional_ -a| +a¦ [markdown] -- @@ -1557,13 +1556,13 @@ SQL++ is agnostic about the content of this parameter; it is just echoed in the [%hardbreaks] {blank} -a| String +a¦ String -a| [#compression] +a¦ [#compression] *compression* + _optional_ -a| +a¦ [markdown] -- @@ -1575,16 +1574,16 @@ Values are case-insensitive. [%hardbreaks] *Values:* `"ZIP"`, `"RLE"`, `"LZMA"`, `"LZO"`, `"NONE"` -*Default:* `pass:c["NONE"]` -*Example:* `pass:c["zip"]` +*Default:* `+++"NONE"+++` +*Example:* `+++"zip"+++` {blank} -a| String +a¦ String -a| [#controls_req] +a¦ [#controls_req] *controls* + _optional_ -a| +a¦ [markdown] -- @@ -1609,13 +1608,13 @@ The request-level parameter overrides the node-level setting. [%hardbreaks] *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#creds] +a¦ [#creds] *creds* + _optional_ -a| +a¦ [markdown] -- @@ -1632,13 +1631,13 @@ 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| <> +a¦ <> array -a| [#durability_level] +a¦ [#durability_level] *durability_level* + _optional_ -a| +a¦ [markdown] -- @@ -1658,16 +1657,16 @@ Set the durability level to `"none"` or `""` to specify no durability. [%hardbreaks] *Values:* `""`, `"none"`, `"majority"`, `"majorityAndPersistActive"`, `"persistToMajority"` -*Default:* `pass:c["majority"]` -*Example:* `pass:c["none"]` +*Default:* `+++"majority"+++` +*Example:* `+++"none"+++` {blank} -a| String +a¦ String -a| [#encoded_plan] +a¦ [#encoded_plan] *encoded_plan* + _optional_ -a| +a¦ [markdown] -- @@ -1678,13 +1677,13 @@ It is included for compatibility with previous versions of Couchbase Server. [%hardbreaks] {blank} -a| String +a¦ String -a| [#encoding] +a¦ [#encoding] *encoding* + _optional_ -a| +a¦ [markdown] -- @@ -1695,15 +1694,15 @@ Only possible value is `UTF-8` and is case-insensitive. -- [%hardbreaks] -*Default:* `pass:c["UTF-8"]` +*Default:* `+++"UTF-8"+++` {blank} -a| String +a¦ String -a| [#format] +a¦ [#format] *format* + _optional_ -a| +a¦ [markdown] -- @@ -1715,16 +1714,16 @@ Values are case-insensitive. [%hardbreaks] *Values:* `"JSON"`, `"XML"`, `"CSV"`, `"TSV"` -*Default:* `pass:c["JSON"]` -*Example:* `pass:c["XML"]` +*Default:* `+++"JSON"+++` +*Example:* `+++"XML"+++` {blank} -a| String +a¦ String -a| [#kvtimeout] +a¦ [#kvtimeout] *kvtimeout* + _optional_ -a| +a¦ [markdown] -- @@ -1750,16 +1749,16 @@ When disabled, no timeout is applied and the KV operation runs for however long -- [%hardbreaks] -*Default:* `pass:c["2.5s"]` -*Example:* `pass:c["10ms"]` +*Default:* `+++"2.5s"+++` +*Example:* `+++"10ms"+++` {blank} -a| String +a¦ String -a| [#max_parallelism_req] +a¦ [#max_parallelism_req] *max_parallelism* + _optional_ -a| +a¦ [markdown] -- @@ -1791,13 +1790,13 @@ The default value is the same as the number of partitions of the index selected [%hardbreaks] *Example:* `3` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#memory_quota_req] +a¦ [#memory_quota_req] *memory_quota* + _optional_ -a| +a¦ [markdown] -- @@ -1834,13 +1833,13 @@ When you change the cluster-level setting, the node-level setting is overwritten *Default:* `0` *Example:* `4` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#metrics] +a¦ [#metrics] *metrics* + _optional_ -a| +a¦ [markdown] -- @@ -1851,13 +1850,13 @@ Specifies that metrics should be returned with query results. *Default:* `true` *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#namespace] +a¦ [#namespace] *namespace* + _optional_ -a| +a¦ [markdown] -- @@ -1866,15 +1865,15 @@ Specifies the namespace to use. Currently, only the `default` namespace is avail -- [%hardbreaks] -*Example:* `pass:c["default"]` +*Example:* `+++"default"+++` {blank} -a| String +a¦ String -a| [#numatrs_req] +a¦ [#numatrs_req] *numatrs* + _optional_ -a| +a¦ [markdown] -- @@ -1903,13 +1902,13 @@ When you change the cluster-level setting, the node-level setting is overwritten *Default:* `1024` *Example:* `512` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#pipeline_batch_req] +a¦ [#pipeline_batch_req] *pipeline_batch* + _optional_ -a| +a¦ [markdown] -- @@ -1935,13 +1934,13 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `64` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#pipeline_cap_req] +a¦ [#pipeline_cap_req] *pipeline_cap* + _optional_ -a| +a¦ [markdown] -- @@ -1967,13 +1966,13 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `1024` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#prepared] +a¦ [#prepared] *prepared* + _optional_ -a| +a¦ [markdown] -- @@ -1989,15 +1988,15 @@ If both `prepared` and `statement` are present and non-empty, an error is return -- [%hardbreaks] -*Example:* `pass:c["[127.0.0.1:8091]pricy_hotel"]` +*Example:* `+++"[127.0.0.1:8091]pricy_hotel"+++` {blank} -a| String +a¦ String -a| [#preserve_expiry] +a¦ [#preserve_expiry] *preserve_expiry* + _optional_ -a| +a¦ [markdown] -- @@ -2016,13 +2015,13 @@ Not supported for statements in a transaction. *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#pretty_req] +a¦ [#pretty_req] *pretty* + _optional_ -a| +a¦ [markdown] -- @@ -2043,13 +2042,13 @@ The request-level parameter overrides the node-level setting. [%hardbreaks] *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#profile_req] +a¦ [#profile_req] *profile* + _optional_ -a| +a¦ [markdown] -- @@ -2082,15 +2081,15 @@ The request-level parameter overrides the node-level setting. [%hardbreaks] *Values:* `"off"`, `"phases"`, `"timings"` -*Example:* `pass:c["phases"]` +*Example:* `+++"phases"+++` {blank} -a| String +a¦ String -a| [#query_context] +a¦ [#query_context] *query_context* + _optional_ -a| +a¦ [markdown] -- @@ -2103,16 +2102,16 @@ If the namespace name is omitted, the default namespace in the current session i -- [%hardbreaks] -*Default:* `pass:c["default:"]` -*Example:* `pass:c["default:travel-sample.inventory"]` +*Default:* `+++"default:"+++` +*Example:* `+++"default:travel-sample.inventory"+++` {blank} -a| String +a¦ String -a| [#readonly] +a¦ [#readonly] *readonly* + _optional_ -a| +a¦ [markdown] -- @@ -2135,13 +2134,13 @@ When using GET requests, it's best to set `readonly` to `true`. *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#scan_cap_req] +a¦ [#scan_cap_req] *scan_cap* + _optional_ -a| +a¦ [markdown] -- @@ -2171,13 +2170,13 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `1024` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#scan_consistency] +a¦ [#scan_consistency] *scan_consistency* + _optional_ -a| +a¦ [markdown] -- @@ -2218,16 +2217,16 @@ Refer to [Transactional Scan Consistency][transactional-scan-consistency] for de [%hardbreaks] *Values:* `"not_bounded"`, `"at_plus"`, `"request_plus"`, `"statement_plus"` -*Default:* `pass:c["not_bounded"]` -*Example:* `pass:c["at_plus"]` +*Default:* `+++"not_bounded"+++` +*Example:* `+++"at_plus"+++` {blank} -a| String +a¦ String -a| [#scan_vector] +a¦ [#scan_vector] *scan_vector* + _optional_ -a| +a¦ [markdown] -- @@ -2254,13 +2253,13 @@ For queries referencing multiple keyspaces, use `scan_vectors`. [%hardbreaks] *Example:* `{"5":[5409393,"VB5ID"],"19":[47574574,"VB19ID"]}` {blank} -a| Object +a¦ Object -a| [#scan_vectors] +a¦ [#scan_vectors] *scan_vectors* + _optional_ -a| +a¦ [markdown] -- @@ -2275,13 +2274,13 @@ The scan vectors can be Full or Sparse. [%hardbreaks] {blank} -a| Object +a¦ Object -a| [#scan_wait] +a¦ [#scan_wait] *scan_wait* + _optional_ -a| +a¦ [markdown] -- @@ -2307,16 +2306,16 @@ Specify `0` or a negative integer to disable. -- [%hardbreaks] -*Default:* `pass:c[""]` -*Example:* `pass:c["30m"]` +*Default:* `+++""+++` +*Example:* `+++"30m"+++` {blank} -a| String (duration) +a¦ String (duration) -a| [#signature] +a¦ [#signature] *signature* + _optional_ -a| +a¦ [markdown] -- @@ -2327,13 +2326,13 @@ Include a header for the results schema in the response. *Default:* `true` *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#sort_projection] +a¦ [#sort_projection] *sort_projection* + _optional_ -a| +a¦ [markdown] -- @@ -2347,13 +2346,13 @@ If `false` (the default), statement projection terms are returned in the order s *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#statement] +a¦ [#statement] *statement* + _optional_ -a| +a¦ [markdown] -- @@ -2374,15 +2373,15 @@ This restriction does not apply when specifying the request parameters in JSON f -- [%hardbreaks] -*Example:* `pass:c["SELECT * FROM `travel-sample`.inventory.hotel LIMIT 1"]` +*Example:* `+++"SELECT * FROM `travel-sample`.inventory.hotel LIMIT 1"+++` {blank} -a| String +a¦ String -a| [#timeout_req] +a¦ [#timeout_req] *timeout* + _optional_ -a| +a¦ [markdown] -- @@ -2424,15 +2423,15 @@ When you change the cluster-level setting, the node-level setting is overwritten -- [%hardbreaks] -*Example:* `pass:c["30m"]` +*Example:* `+++"30m"+++` {blank} -a| String (duration) +a¦ String (duration) -a| [#txdata] +a¦ [#txdata] *txdata* + _optional_ -a| +a¦ [markdown] -- @@ -2443,13 +2442,13 @@ For internal use only. [%hardbreaks] {blank} -a| Object +a¦ Object -a| [#txid] +a¦ [#txid] *txid* + _optional_ -a| +a¦ [markdown] -- @@ -2465,15 +2464,15 @@ The transaction must be active and non-expired. -- [%hardbreaks] -*Example:* `pass:c["d81d9b4a-b758-4f98-b007-87ba262d3a51"]` +*Example:* `+++"d81d9b4a-b758-4f98-b007-87ba262d3a51"+++` {blank} -a| UUID (UUID) +a¦ UUID (UUID) -a| [#tximplicit] +a¦ [#tximplicit] *tximplicit* + _optional_ -a| +a¦ [markdown] -- @@ -2491,13 +2490,13 @@ If the [txid](#txid) request-level parameter is set, the `tximplicit` parameter *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#txstmtnum] +a¦ [#txstmtnum] *txstmtnum* + _optional_ -a| +a¦ [markdown] -- @@ -2510,13 +2509,13 @@ If the transaction statement number is lower than the transaction statement numb [%hardbreaks] *Example:* `10` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#txtimeout_req] +a¦ [#txtimeout_req] *txtimeout* + _optional_ -a| +a¦ [markdown] -- @@ -2563,15 +2562,15 @@ The default is `"15s"` for cbq files or scripts, `"2m"` for interactive cbq sess -- [%hardbreaks] -*Example:* `pass:c["30m"]` +*Example:* `+++"30m"+++` {blank} -a| String (duration) +a¦ String (duration) -a| [#use_cbo_req] +a¦ [#use_cbo_req] *use_cbo* + _optional_ -a| +a¦ [markdown] -- @@ -2597,13 +2596,13 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#use_fts] +a¦ [#use_fts] *use_fts* + _optional_ -a| [.edition]##{enterprise}## +a¦ [.edition]##{enterprise}## [markdown] -- @@ -2625,13 +2624,13 @@ Refer to [Flex Indexes][flex-indexes] for more information. *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#use_replica_req] +a¦ [#use_replica_req] *use_replica* + _optional_ -a| +a¦ [markdown] -- @@ -2673,16 +2672,16 @@ If a query uses sequential scan and a data node becomes unavailable, the query m [%hardbreaks] *Values:* `"off"`, `"on"`, `"unset"` -*Default:* `pass:c["unset"]` -*Example:* `pass:c["true"]` +*Default:* `+++"unset"+++` +*Example:* `+++"true"+++` {blank} -a| String +a¦ String -a| [#identifier] +a¦ [#identifier] _additional + property_ -a| +a¦ [markdown] -- @@ -2705,7 +2704,7 @@ Refer to [Named Parameters and Positional Parameters][section_srh_tlm_n1b] for d [%hardbreaks] {blank} -a| Any Type +a¦ Any Type |=== @@ -2750,14 +2749,14 @@ The response body has the following structure. //end::desc-Response[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *requestID* + _optional_ -a| +a¦ [markdown] -- @@ -2766,13 +2765,13 @@ A unique identifier for the response. [%hardbreaks] {blank} -a| UUID (UUID) +a¦ UUID (UUID) -a| +a¦ *clientContextID* + _optional_ -a| +a¦ [markdown] -- @@ -2781,13 +2780,13 @@ The client context ID of the request, if one was supplied — see `client_co [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *signature* + _optional_ -a| +a¦ [markdown] -- @@ -2798,13 +2797,13 @@ The schema of the results. Present only when the query completes successfully. [%hardbreaks] *Example:* `{"id":"json"}` {blank} -a| Object +a¦ Object -a| +a¦ *results* + _optional_ -a| +a¦ [markdown] -- @@ -2814,13 +2813,13 @@ An array of all the objects returned by the query. An object can be any JSON val [%hardbreaks] {blank} -a| Any Type +a¦ Any Type array -a| +a¦ *status* + _optional_ -a| +a¦ [markdown] -- @@ -2830,13 +2829,13 @@ The status of the request. [%hardbreaks] *Values:* `"success"`, `"running"`, `"errors"`, `"completed"`, `"stopped"`, `"timeout"`, `"fatal"` {blank} -a| String +a¦ String -a| +a¦ *errors* + _optional_ -a| +a¦ [markdown] -- @@ -2846,13 +2845,13 @@ An array of 0 or more error objects. If an error occurred during processing of t [%hardbreaks] {blank} -a| <> +a¦ <> array -a| +a¦ *warnings* + _optional_ -a| +a¦ [markdown] -- @@ -2862,13 +2861,13 @@ An array of 0 or more warning objects. If a warning occurred during processing o [%hardbreaks] {blank} -a| <> +a¦ <> array -a| +a¦ *metrics* + _optional_ -a| +a¦ [markdown] -- @@ -2877,13 +2876,13 @@ include::index.adoc[tag=desc-Metrics, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ <> -a| +a¦ *controls* + _optional_ -a| +a¦ [markdown] -- @@ -2892,13 +2891,13 @@ include::index.adoc[tag=desc-Controls, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ <> -a| +a¦ *profile* + _optional_ -a| +a¦ [markdown] -- @@ -2907,7 +2906,7 @@ include::index.adoc[tag=desc-Profile, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ <> |=== @@ -2952,14 +2951,14 @@ Statistics collected for the operator. //end::desc-Statistics[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *#itemsIn* + _optional_ -a| +a¦ [markdown] -- @@ -2969,13 +2968,13 @@ Number of input documents to the operator. [%hardbreaks] *Example:* `187` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *#itemsOut* + _optional_ -a| +a¦ [markdown] -- @@ -2985,13 +2984,13 @@ Number of output documents after the operator processing. [%hardbreaks] *Example:* `16` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *#phaseSwitches* + _optional_ -a| +a¦ [markdown] -- @@ -3001,13 +3000,13 @@ Number of switches between executing, waiting for services, or waiting for the g [%hardbreaks] *Example:* `413` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *execTime* + _optional_ -a| +a¦ [markdown] -- @@ -3015,15 +3014,15 @@ Time spent executing the operator code inside SQL++ query engine. -- [%hardbreaks] -*Example:* `pass:c["128.434µs"]` +*Example:* `+++"128.434µs"+++` {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *kernTime* + _optional_ -a| +a¦ [markdown] -- @@ -3031,15 +3030,15 @@ Time spent waiting to be scheduled for CPU time. -- [%hardbreaks] -*Example:* `pass:c["15.027879ms"]` +*Example:* `+++"15.027879ms"+++` {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *servTime* + _optional_ -a| +a¦ [markdown] -- @@ -3052,9 +3051,9 @@ For fetch, it is time spent waiting on the KV store. -- [%hardbreaks] -*Example:* `pass:c["1.590934ms"]` +*Example:* `+++"1.590934ms"+++` {blank} -a| String (duration) +a¦ String (duration) |=== @@ -3169,3 +3168,4 @@ include::{specDir}security/document-end.adoc[opts=optional] include::{specDir}security/document-after.adoc[opts=optional] + diff --git a/docs/modules/n1ql-rest-settings/pages/index.adoc b/docs/modules/n1ql-rest-settings/pages/index.adoc index 44e9d27a..f4025088 100644 --- a/docs/modules/n1ql-rest-settings/pages/index.adoc +++ b/docs/modules/n1ql-rest-settings/pages/index.adoc @@ -58,7 +58,7 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* @@ -69,7 +69,7 @@ The host name or IP address of a node running the Query service. [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* @@ -80,7 +80,7 @@ The Cluster administration REST port. Use `18091` for secure access. Note that [%hardbreaks] *Values:* `8091`, `18091` -*Example:* `pass:c[8091]` +*Example:* `+++8091+++` // end |=== @@ -174,6 +174,12 @@ Returns the cluster-level CURL access settings only. // markup not found, no include::{specDir}paths/get_access/operation-description-end.adoc[opts=optional] + + +[#get_access-produces] +.Produces +* application/json + :leveloffset: -1 @@ -191,12 +197,6 @@ Returns the cluster-level CURL access settings only. // markup not found, no include::{specDir}paths/get_access/operation-parameters-after.adoc[opts=optional] -[#get_access-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_access/operation-responses-before.adoc[opts=optional] @@ -318,6 +318,12 @@ 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] + + +[#get_settings-produces] +.Produces +* application/json + :leveloffset: -1 @@ -335,12 +341,6 @@ Returns all cluster-level query settings, including the CURL access settings. // markup not found, no include::{specDir}paths/get_settings/operation-parameters-after.adoc[opts=optional] -[#get_settings-produces] -= Produces - -* application/json - - // markup not found, no include::{specDir}paths/get_settings/operation-responses-before.adoc[opts=optional] @@ -462,6 +462,16 @@ Updates the cluster-level CURL access settings only. // markup not found, no include::{specDir}paths/post_access/operation-description-end.adoc[opts=optional] + +[#post_access-consumes] +.Consumes +* application/json +* application/x-www-form-urlencoded + +[#post_access-produces] +.Produces +* application/json + :leveloffset: -1 @@ -488,13 +498,13 @@ Updates the cluster-level CURL access settings only. .Body Parameter {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *Body* + +a¦ *Body* + _optional_ -a| +a¦ [markdown] @@ -505,7 +515,7 @@ An object determining which URLs may be accessed by the `CURL()` function. [%hardbreaks] {blank} -a| <> +a¦ <> @@ -522,17 +532,6 @@ a| <> // markup not found, no include::{specDir}paths/post_access/operation-parameters-after.adoc[opts=optional] -[#post_access-produces] -= Produces - -* application/json - -[#post_access-consumes] -= Consumes - -* application/json -* application/x-www-form-urlencoded - // markup not found, no include::{specDir}paths/post_access/operation-responses-before.adoc[opts=optional] @@ -662,6 +661,16 @@ 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] + +[#post_settings-consumes] +.Consumes +* application/json +* application/x-www-form-urlencoded + +[#post_settings-produces] +.Produces +* application/json + :leveloffset: -1 @@ -688,13 +697,13 @@ Updates cluster-level query settings, including the CURL access settings. .Body Parameter {blank} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema -a| *Body* + +a¦ *Body* + _optional_ -a| +a¦ [markdown] @@ -705,7 +714,7 @@ An object specifying cluster-level query settings. [%hardbreaks] {blank} -a| <> +a¦ <> @@ -722,17 +731,6 @@ a| <> // markup not found, no include::{specDir}paths/post_settings/operation-parameters-after.adoc[opts=optional] -[#post_settings-produces] -= Produces - -* application/json - -[#post_settings-consumes] -= Consumes - -* application/json -* application/x-www-form-urlencoded - // markup not found, no include::{specDir}paths/post_settings/operation-responses-before.adoc[opts=optional] @@ -891,14 +889,14 @@ An object which determines which URLs may be accessed by the `CURL()` function. //end::desc-Access[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *all_access* + _required_ -a| +a¦ [markdown] -- @@ -912,13 +910,13 @@ Setting this field to `true` enables access to all endpoints. [%hardbreaks] {blank} -a| Boolean +a¦ Boolean -a| +a¦ *allowed_urls* + _optional_ -a| +a¦ [markdown] -- @@ -935,13 +933,13 @@ Note that each URL must include the port, protocol, and all other components of [%hardbreaks] {blank} -a| String +a¦ String array -a| +a¦ *disallowed_urls* + _optional_ -a| +a¦ [markdown] -- @@ -957,7 +955,7 @@ Note that each URL must include the port, protocol, and all other components of [%hardbreaks] {blank} -a| String +a¦ String array |=== @@ -997,14 +995,14 @@ endif::collapse-models[] //tag::Settings[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| [#queryCleanupClientAttempts] +a¦ [#queryCleanupClientAttempts] *queryCleanupClientAttempts* + _optional_ -a| +a¦ [markdown] -- @@ -1026,13 +1024,13 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `true` *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#queryCleanupLostAttempts] +a¦ [#queryCleanupLostAttempts] *queryCleanupLostAttempts* + _optional_ -a| +a¦ [markdown] -- @@ -1054,13 +1052,13 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `true` *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#queryCleanupWindow] +a¦ [#queryCleanupWindow] *queryCleanupWindow* + _optional_ -a| +a¦ [markdown] -- @@ -1092,16 +1090,16 @@ When you change the cluster-level setting, the node-level setting is over-writte -- [%hardbreaks] -*Default:* `pass:c["60s"]` -*Example:* `pass:c["30s"]` +*Default:* `+++"60s"+++` +*Example:* `+++"30s"+++` {blank} -a| String (duration) +a¦ String (duration) -a| [#queryCompletedLimit] +a¦ [#queryCompletedLimit] *queryCompletedLimit* + _optional_ -a| +a¦ [markdown] -- @@ -1129,13 +1127,13 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `4000` *Example:* `7000` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryCompletedMaxPlanSize] +a¦ [#queryCompletedMaxPlanSize] *queryCompletedMaxPlanSize* + _optional_ -a| +a¦ [markdown] -- @@ -1165,13 +1163,13 @@ When you change the cluster-level setting, the node-level setting is over-writte *Minimum:* `0` *Maximum:* `20840448` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryCompletedThreshold] +a¦ [#queryCompletedThreshold] *queryCompletedThreshold* + _optional_ -a| +a¦ [markdown] -- @@ -1200,13 +1198,13 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `1000` *Example:* `7000` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryLogLevel] +a¦ [#queryLogLevel] *queryLogLevel* + _optional_ -a| +a¦ [markdown] -- @@ -1248,16 +1246,16 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] *Values:* `"DEBUG"`, `"TRACE"`, `"INFO"`, `"WARN"`, `"ERROR"`, `"SEVERE"`, `"NONE"` -*Default:* `pass:c["INFO"]` -*Example:* `pass:c["DEBUG"]` +*Default:* `+++"INFO"+++` +*Example:* `+++"DEBUG"+++` {blank} -a| String +a¦ String -a| [#queryMaxParallelism] +a¦ [#queryMaxParallelism] *queryMaxParallelism* + _optional_ -a| +a¦ [markdown] -- @@ -1296,13 +1294,13 @@ Refer to [Max Parallelism][max-parallelism] for more information. *Default:* `1` *Example:* `0` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryMemoryQuota] +a¦ [#queryMemoryQuota] *queryMemoryQuota* + _optional_ -a| +a¦ [markdown] -- @@ -1335,13 +1333,13 @@ If a request includes this parameter, it will be capped by the node-level `memor *Default:* `0` *Example:* `4` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryN1qlFeatCtrl] +a¦ [#queryN1qlFeatCtrl] *queryN1qlFeatCtrl* + _optional_ -a| +a¦ [markdown] -- @@ -1362,13 +1360,13 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryNodeQuota] +a¦ [#queryNodeQuota] *queryNodeQuota* + _optional_ -a| +a¦ [markdown] -- @@ -1393,13 +1391,13 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] *Default:* `0` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryNodeQuotaValPercent] +a¦ [#queryNodeQuotaValPercent] *queryNodeQuotaValPercent* + _optional_ -a| +a¦ [markdown] -- @@ -1423,13 +1421,13 @@ When you change the cluster-level setting, the node-level setting is over-writte *Minimum:* `0` *Maximum:* `100` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryNumAtrs] +a¦ [#queryNumAtrs] *queryNumAtrs* + _optional_ -a| +a¦ [markdown] -- @@ -1459,13 +1457,13 @@ If a request includes this parameter, it will be capped by the node-level `numat *Exclusive minimum:* `true` *Example:* `512` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryNumCpus] +a¦ [#queryNumCpus] *queryNumCpus* + _optional_ -a| +a¦ [markdown] -- @@ -1493,13 +1491,13 @@ When you change the cluster-level setting, the node-level setting is over-writte [%hardbreaks] *Default:* `0` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryPipelineBatch] +a¦ [#queryPipelineBatch] *queryPipelineBatch* + _optional_ -a| +a¦ [markdown] -- @@ -1526,13 +1524,13 @@ The minimum of that and the node-level `pipeline-batch` setting is applied. *Default:* `16` *Example:* `64` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryPipelineCap] +a¦ [#queryPipelineCap] *queryPipelineCap* + _optional_ -a| +a¦ [markdown] -- @@ -1559,13 +1557,13 @@ The minimum of that and the node-level `pipeline-cap` setting is applied. *Default:* `512` *Example:* `1024` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryPreparedLimit] +a¦ [#queryPreparedLimit] *queryPreparedLimit* + _optional_ -a| +a¦ [markdown] -- @@ -1588,13 +1586,13 @@ When you change the cluster-level setting, the node-level setting is over-writte *Default:* `16384` *Example:* `65536` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryScanCap] +a¦ [#queryScanCap] *queryScanCap* + _optional_ -a| +a¦ [markdown] -- @@ -1625,13 +1623,13 @@ The minimum of that and the node-level `scan-cap` setting is applied. *Default:* `512` *Example:* `1024` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryTimeout] +a¦ [#queryTimeout] *queryTimeout* + _optional_ -a| +a¦ [markdown] -- @@ -1664,13 +1662,13 @@ The minimum of that and the node-level `timeout` setting is applied. *Default:* `0` *Example:* `500000000` {blank} -a| Long (int64) +a¦ Long (int64) -a| [#queryTxTimeout] +a¦ [#queryTxTimeout] *queryTxTimeout* + _optional_ -a| +a¦ [markdown] -- @@ -1712,16 +1710,16 @@ If a request includes this parameter, it will be capped by the node-level `txtim -- [%hardbreaks] -*Default:* `pass:c["0ms"]` -*Example:* `pass:c["0.5s"]` +*Default:* `+++"0ms"+++` +*Example:* `+++"0.5s"+++` {blank} -a| String (duration) +a¦ String (duration) -a| [#queryTmpSpaceDir] +a¦ [#queryTmpSpaceDir] *queryTmpSpaceDir* + _optional_ -a| +a¦ [markdown] -- @@ -1735,15 +1733,15 @@ The default path is `var/lib/couchbase/tmp` within the Couchbase Server installa -- [%hardbreaks] -*Example:* `pass:c["/opt/couchbase/var/lib/couchbase/tmp"]` +*Example:* `+++"/opt/couchbase/var/lib/couchbase/tmp"+++` {blank} -a| String +a¦ String -a| [#queryTmpSpaceSize] +a¦ [#queryTmpSpaceSize] *queryTmpSpaceSize* + _optional_ -a| +a¦ [markdown] -- @@ -1760,13 +1758,13 @@ The maximum size is limited only by the available disk space. *Default:* `5120` *Example:* `2048` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryUseCBO] +a¦ [#queryUseCBO] *queryUseCBO* + _optional_ -a| +a¦ [markdown] -- @@ -1793,13 +1791,13 @@ If a request does not include this parameter, the node-level setting is used, wh *Default:* `true` *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#queryUseReplica] +a¦ [#queryUseReplica] *queryUseReplica* + _optional_ -a| +a¦ [markdown] -- @@ -1840,16 +1838,16 @@ If a query uses sequential scan and a data node becomes unavailable, the query m [%hardbreaks] *Values:* `"off"`, `"on"`, `"unset"` -*Default:* `pass:c["unset"]` -*Example:* `pass:c["on"]` +*Default:* `+++"unset"+++` +*Example:* `+++"on"+++` {blank} -a| String +a¦ String -a| [#queryCurlWhitelist] +a¦ [#queryCurlWhitelist] *queryCurlWhitelist* + _optional_ -a| +a¦ [markdown] -- @@ -1858,7 +1856,7 @@ include::index.adoc[tag=desc-Access, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ <> |=== @@ -1941,3 +1939,4 @@ include::{specDir}security/document-end.adoc[opts=optional] include::{specDir}security/document-after.adoc[opts=optional] + diff --git a/settings.gradle b/settings.gradle index 0783ca6c..1e580782 100644 --- a/settings.gradle +++ b/settings.gradle @@ -2,6 +2,7 @@ rootProject.name = 'cb-swagger' include 'admin', 'query-settings', 'query-service', + 'eventing', 'functions', 'indexes', 'analytics-admin', @@ -16,6 +17,8 @@ project(':query-settings').projectDir = new File (settingsDir, 'src/query-settin project(':query-settings').buildFileName = 'query-settings.gradle' project(':query-service').projectDir = new File (settingsDir, 'src/query-service') project(':query-service').buildFileName = 'query-service.gradle' +project(':eventing').projectDir = new File (settingsDir, 'src/eventing') +project(':eventing').buildFileName = 'eventing.gradle' project(':functions').projectDir = new File (settingsDir, 'src/functions') project(':functions').buildFileName = 'functions.gradle' project(':indexes').projectDir = new File (settingsDir, 'src/indexes') diff --git a/src/eventing/eventing.gradle b/src/eventing/eventing.gradle new file mode 100644 index 00000000..7d4d0f16 --- /dev/null +++ b/src/eventing/eventing.gradle @@ -0,0 +1,32 @@ +apply plugin: 'org.openapi.generator' + +openApiGenerate { + generatorName = "asciidoc" + inputSpec = file("swagger/eventing.yaml").getAbsolutePath().toString() + outputDir = "${rootDir}/docs/modules/eventing-rest-api/pages" + templateDir = "${rootDir}/templates" + gitRepoId = "cb-swagger" + gitUserId = "couchbase" + additionalProperties = [ + specDir: "${rootDir}/docs/modules/eventing-rest-api/partials/", + snippetDir: "${rootDir}/docs/modules/eventing-rest-api/partials/paths/", + headerAttributes: "true", + useIntroduction: "true", + useTableTitles: "true", + skipExamples: "true", + legacyDiscriminatorBehavior: "true" + ] + globalProperties = [ + generateAliasAsModel: "true" + ] + generateAliasAsModel = true + modelNameMappings = [ + handler_schema: "Function Definition", + function_scope_schema: "Function Scope", + settings_schema: "Function Settings", + depcfg_schema: "Deployment Config", + depcfg_schema_buckets_inner: "Deployment Keyspace", + depcfg_schema_constants_inner: "Deployment Constants", + depcfg_schema_curl_inner: "Deployment URL" + ] +} \ No newline at end of file diff --git a/src/eventing/swagger/eventing.yaml b/src/eventing/swagger/eventing.yaml new file mode 100644 index 00000000..4d295344 --- /dev/null +++ b/src/eventing/swagger/eventing.yaml @@ -0,0 +1,929 @@ +openapi: 3.0.3 +info: + title: Eventing REST API + version: '7.6' + description: |- + The Eventing REST API provides methods to work with and manipulate Couchbase Eventing functions. + +servers: + - url: '{scheme}://{host}:{port}' + description: The URL scheme, host, and port are as follows. + variables: + scheme: + default: http + description: |- + The URL scheme. + Use `https` for secure access. + enum: + - http + - https + host: + default: localhost + description: The host name or IP address of a node running the Eventing service. + port: + default: "8096" + description: |- + The Eventing service REST port. + Use `18096` for secure access. + enum: + - "8096" + - "18096" + +paths: + /api/v1/functions/{function}/deploy: + parameters: + - $ref: "#/components/parameters/PathFunction" + - $ref: "#/components/parameters/QueryBucket" + - $ref: "#/components/parameters/QueryScope" + post: + operationId: basic_deploy + summary: Deploy a Function + description: |- + Deploys an undeployed function. + This is the preferred invocation. + tags: + - activation + security: + - Global: [] + - Scoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + + /api/v1/functions/{function}/undeploy: + parameters: + - $ref: "#/components/parameters/PathFunction" + - $ref: "#/components/parameters/QueryBucket" + - $ref: "#/components/parameters/QueryScope" + post: + operationId: basic_undeploy + summary: Undeploy a Function + description: |- + Undeploys a function. + This is the preferred invocation. + tags: + - activation + security: + - Global: [] + - Scoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + + /api/v1/functions/{function}/pause: + parameters: + - $ref: "#/components/parameters/PathFunction" + - $ref: "#/components/parameters/QueryBucket" + - $ref: "#/components/parameters/QueryScope" + post: + operationId: basic_pause + summary: Pause a Function + description: |- + Pauses a function and creates a DCP checkpoint such that on a subsequent resume no mutations will be lost. + This is the preferred invocation. + tags: + - activation + security: + - Global: [] + - Scoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + + /api/v1/functions/(function}/resume: + parameters: + - $ref: "#/components/parameters/PathFunction" + - $ref: "#/components/parameters/QueryBucket" + - $ref: "#/components/parameters/QueryScope" + post: + operationId: basic_resume + summary: Resume a Function + description: |- + Resumes a paused function from its paused DCP checkpoint. + This is the preferred invocation. + tags: + - activation + security: + - Global: [] + - Scoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /api/v1/functions/{function}: + parameters: + - $ref: "#/components/parameters/PathFunction" + - $ref: "#/components/parameters/QueryBucket" + - $ref: "#/components/parameters/QueryScope" + post: + operationId: adv_function_import + summary: Create or Import a Function + description: |- + Creates or imports a single function. + tags: + - advanced + requestBody: + required: true + description: |- + 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. + content: + application/json: + schema: + $ref: '#/components/schemas/AddFunction' + security: + - Global: [] + - Scoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + get: + operationId: adv_function_view + summary: View a Function + description: |- + Provides a listing of a complete function definition available in the cluster. + The function could be in any state: deployed, undeployed, or paused. + If saved to a file the function definition can be imported into the cluster or a different cluster. + However any changes to the function definition made to the file outside the UI are discouraged. + tags: + - advanced + security: + - Global: [] + - Scoped: [] + responses: + "200": + description: Returns a single function definition object. + content: + application/json: + schema: + $ref: "#/components/schemas/handler_schema" + "404": + $ref: '#/components/responses/Goof' + delete: + operationId: adv_function_zap + summary: Delete Function + description: |- + Deletes a specific function from the cluster. + + WARNING: Use this API with caution, as it is irreversible. + tags: + - advanced + security: + - Global: [] + - Scoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /api/v1/functions: + post: + operationId: adv_function_import_all + summary: Create or Import Multiple Functions + description: |- + Creates or imports multiple functions. + + Note that 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). + tags: + - advanced + requestBody: + required: true + description: |- + 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. + content: + application/json: + schema: + $ref: '#/components/schemas/AddFunctions' + security: + - Unscoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + get: + operationId: adv_function_view_all + summary: View Multiple Functions + description: |- + Provides an array of definitions of all functions available in the cluster. + The functions may be in any state: deployed, undeployed, or paused. + If saved to a file the function definitions can be imported into the cluster or a different cluster. + However any changes to the function definition made to the file outside the UI are discouraged. + + 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. + tags: + - advanced + security: + - Unscoped: [] + responses: + "200": + description: Returns an array containing one or more function definition objects. + content: + application/json: + schema: + type: array + items: + $ref: "#/components/schemas/handler_schema" + "404": + $ref: '#/components/responses/Goof' + delete: + operationId: adv_function_zap_all + summary: Delete Multiple Functions + description: |- + Deletes **all functions** from the cluster. + WARNING: Use this API with caution, as it is 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. + tags: + - advanced + security: + - Unscoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /api/v1/import: + post: + operationId: adv_multiple_import + summary: Import Multiple Functions + description: |- + Imports multiple functions. + + Note that 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). + tags: + - advanced + requestBody: + required: true + description: |- + 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. + content: + application/json: + schema: + $ref: '#/components/schemas/AddFunctions' + security: + - Unscoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /api/v1/export: + get: + operationId: adv_multiple_export + summary: Export Multiple Functions + description: |- + This is a convenience method to export all function definitions. + Exported functions are always set to the undeployed state at the time of export, regardless of their state in the cluster. + If saved to a file the function definitions can be imported into the cluster or a different cluster. + However any changes to the function definition made to the file outside the UI are discouraged. + + 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. + tags: + - advanced + security: + - Unscoped: [] + responses: + "200": + description: Returns an array containing one or more function definition objects. + content: + application/json: + schema: + type: array + items: + $ref: "#/components/schemas/handler_schema" + "404": + $ref: '#/components/responses/Goof' + + /api/v1/functions/{function}/settings: + parameters: + - $ref: "#/components/parameters/PathFunction" + - $ref: "#/components/parameters/QueryBucket" + - $ref: "#/components/parameters/QueryScope" + get: + operationId: adv_settings_get + summary: View Function Settings + description: |- + Return or export the full settings for one eventing function in the cluster. + The settings can be subsequently imported. + However any changes to the function settings made to the file outside the UI are discouraged. + tags: + - advanced + security: + - Global: [] + - Scoped: [] + responses: + "200": + description: Returns an object showing settings for the specified function. + content: + application/json: + schema: + $ref: "#/components/schemas/settings_schema" + "404": + $ref: '#/components/responses/Goof' + post: + operationId: adv_settings_update + summary: Update Function Settings + description: |- + Updates an undeployed or paused function with the provided settings. + You can only alter settings when the function is paused or undeployed; attempting to adjust a deployed function will result in an error. + During an edit, settings provided are merged. + Unspecified attributes retain their prior values. + + Note that you must always specify `deployment_status` and `processing_status` when using this REST endpoint to update any option or set of options. + To get the current values of `deployment_status` and `processing_status`, see [View All Functions Status](#status_all) or [View Function Status](#status_function). + + By adjusting `deployment_status` and `processing_status` this command can also deploy or resume a function; however, it cannot pause or undeploy a function. + tags: + - advanced + requestBody: + required: true + description: |- + An object providing settings for the specified function. + content: + application/json: + schema: + $ref: "#/components/schemas/settings_schema" + security: + - Global: [] + - Scoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /api/v1/functions/{function}/config: + parameters: + - $ref: "#/components/parameters/PathFunction" + - $ref: "#/components/parameters/QueryBucket" + - $ref: "#/components/parameters/QueryScope" + get: + operationId: adv_structure_get + summary: View Function Config + description: |- + Export or return the configuration of the source keyspace and the eventing storage (metadata) keyspace for the specified function. + The definition can be subsequently imported. + However any changes to the function definition made to the file outside the UI are discouraged. + tags: + - advanced + security: + - Global: [] + - Scoped: [] + responses: + "200": + description: Returns an object showing the configuration of the specified function. + content: + application/json: + schema: + $ref: '#/components/schemas/depcfg_schema' + + "404": + $ref: '#/components/responses/Goof' + post: + operationId: adv_structure_update + summary: Update Function Config + description: |- + Import the configuration and alter the source keyspace and the eventing storage (metadata) keyspace for the specified function. + You can only change these values if a function is in the undeployed state and the two keyspaces exist. + tags: + - advanced + requestBody: + required: true + description: |- + An object providing the configuration for the specified function. + content: + application/json: + schema: + $ref: '#/components/schemas/depcfg_schema' + security: + - Global: [] + - Scoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /api/v1/functions/{function}/appcode: + parameters: + - $ref: "#/components/parameters/PathFunction" + - $ref: "#/components/parameters/QueryBucket" + - $ref: "#/components/parameters/QueryScope" + get: + operationId: adv_text_get + summary: View Function Code + description: |- + Export only the JavaScript code for the specified function. + Note that unlike [View a Function](#adv_function_view), the JavaScript is not escaped, and the code is runnable in other environments. + The JavaScript code can be subsequently imported. + However any changes to the function definition made to the file outside the UI are discouraged. + tags: + - advanced + security: + - Global: [] + - Scoped: [] + responses: + "200": + description: Returns a string showing the code for the specified function. + content: + application/json: + schema: + $ref: "#/components/schemas/AppCode" + "404": + $ref: '#/components/responses/Goof' + post: + operationId: adv_text_update + summary: Update Function Code + description: |- + Import only the JavaScript code for the specified function. + Note that unlike [Create or Import Function](#adv_function_import), the JavaScript is not escaped and could come from other environments. + 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. + tags: + - advanced + requestBody: + required: true + description: A string providing the code for the specified function. + content: + application/json: + schema: + $ref: '#/components/schemas/AppCode' + + security: + - Global: [] + - Scoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /api/v1/status: + get: + operationId: status_all + summary: View All Functions Status + description: |- + Returns a list (array) of all eventing functions, showing their corresponding `composite_status`. + A function's status can have one of the following values: undeployed, deploying, deployed, undeploying, paused, and pausing. + Note that there is no value of resuming; when resuming a paused eventing function, the `composite_status` returns `deploying` until it reaches the deployed state. + + 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. + tags: + - status + security: + - Unscoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /api/v1/status/{function}: + parameters: + - $ref: "#/components/parameters/PathFunction" + - $ref: "#/components/parameters/QueryBucket" + - $ref: "#/components/parameters/QueryScope" + get: + operationId: status_function + summary: View Function Status + description: |- + Returns the specified function, showing its corresponding `composite_status`. + It can have one of the following values: undeployed, deploying, deployed, undeploying, paused, and pausing. + Note that there is no value of resuming; when resuming a paused eventing function, the `composite_status` returns `deploying` until it reaches the deployed state. + tags: + - status + security: + - Global: [] + - Scoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /getAppLog: + parameters: + - $ref: "#/components/parameters/QueryFunction" + - $ref: "#/components/parameters/QueryBucket" + - $ref: "#/components/parameters/QueryScope" + - $ref: "#/components/parameters/QueryAggregate" + - $ref: "#/components/parameters/QuerySize" + get: + operationId: log_view + summary: Get Log for a Function + description: Returns the most recent application log messages for the specified function. + tags: + - logging + security: + - Global: [] + - Scoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /api/v1/list/functions: + get: + operationId: list_all + summary: List All Functions + description: |- + Returns a list (array) of the names of all Eventing functions in the cluster. + The returned list can also be filtered — see [List Filtered Functions](#list_query). + + 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. + tags: + - list + security: + - Unscoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /api/v1/list/functions/query: + get: + operationId: list_query + summary: List Filtered Functions + description: |- + Returns a list (array) of the names of all Eventing functions in the cluster. + The returned list can be filtered by the following: + + - Deployed status : in this case, paused is considered deployed. + - Source bucket: the listen to keyspace. + - Function type: whether the function modifies its own listen to keyspace. + + 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. + tags: + - list + parameters: + - name: deployed + schema: + type: boolean + default: false + in: query + required: false + description: |- + If `true`, returns the names of all deployed (or paused) functions. + If `false`, returns the names of all undeployed functions. + - name: source_bucket + schema: + type: string + in: query + required: false + description: |- + The name of a bucket. + Returns the names of Eventing functions in the cluster that have a source keyspace under the specified bucket. + - name: function_type + schema: + type: string + enum: + - sbm + - notsbm + in: query + required: false + description: |- + The function type. + + - `sbm`: Returns the names of Eventing functions in the cluster that modify their own source keyspace. + - `notsbm`: Returns the names of Eventing functions in the cluster that do not modify their own source keyspace. + security: + - Unscoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /api/v1/config: + get: + operationId: config_get + summary: List Global Config + description: |- + Shows all global configuration settings. + There are currently just two settings: `enable_debugger` and `ram_quota`. + Both of these settings can also be adjusted via the UI. + tags: + - global config + security: + - Unscoped: [] + responses: + "200": + description: Returns an object showing the global configuration settings. + content: + application/json: + schema: + $ref: "#/components/schemas/UnivConfig" + "404": + $ref: '#/components/responses/Goof' + post: + operationId: config_update + summary: Modify Global Config + description: |- + Modify global configuration settings. + During an edit, settings provided are merged. + Unspecified attributes retain their prior values. + The response indicates whether the Eventing service must be restarted for the new changes to take effect. + tags: + - global config + requestBody: + required: true + description: An object providing the global configuration settings. + content: + application/json: + schema: + $ref: "#/components/schemas/UnivConfig" + security: + - Unscoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /api/v1/stats: + get: + operationId: stats_all + summary: Get All Statistics + description: |- + 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. + parameters: + - name: type + schema: + type: string + enum: + - full + in: query + required: false + description: |- + Including this parameter returns the full statistics set, inclusive of events processing, events remaining, execution, failure, latency, worker PIDs and sequence processed. + + Omitting this parameter excludes `dcp_event_backlog_per_vb`, `doc_timer_debug_stats`, `latency_stats`, `plasma_stats`, and `seqs_processed` from the response. + tags: + - statistics + security: + - Unscoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /getExecutionStats: + parameters: + - $ref: "#/components/parameters/QueryFunction" + - $ref: "#/components/parameters/QueryBucket" + - $ref: "#/components/parameters/QueryScope" + get: + operationId: stats_execution + summary: Get Execution Statistics + description: |- + Retrieve only execution statistics. + This returns the subset of statistics for the node. + tags: + - statistics + security: + - Global: [] + - Scoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /getLatencyStats: + parameters: + - $ref: "#/components/parameters/QueryFunction" + - $ref: "#/components/parameters/QueryBucket" + - $ref: "#/components/parameters/QueryScope" + get: + operationId: stats_latency + summary: Get Latency Statistics + description: |- + Retrieve only latency statistics. + This returns the subset of statistics for the node. + tags: + - statistics + security: + - Global: [] + - Scoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /getFailureStats: + parameters: + - $ref: "#/components/parameters/QueryFunction" + - $ref: "#/components/parameters/QueryBucket" + - $ref: "#/components/parameters/QueryScope" + get: + operationId: stats_failure + summary: Get Failure Statistics + description: |- + Retrieve only failure statistics. + This returns the subset of statistics for the node. + tags: + - statistics + security: + - Global: [] + - Scoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + + /resetStatsCounters: + parameters: + - $ref: "#/components/parameters/QueryBucket" + - $ref: "#/components/parameters/QueryScope" + - name: appName + schema: + type: string + in: query + required: true + description: The name of a function. + get: + operationId: stats_reset + summary: Reset Statistics + description: Resets statistics for the specified function. + tags: + - statistics + security: + - Global: [] + - Scoped: [] + responses: + "200": + $ref: '#/components/responses/OK' + "404": + $ref: '#/components/responses/Goof' + +components: + parameters: + PathFunction: + name: function + schema: + type: string + in: path + required: true + description: The name of a function. + + QueryBucket: + name: bucket + schema: + type: string + in: query + required: false + description: |- + For scoped functions only. + The bucket to which the function belongs. + + QueryScope: + name: scope + schema: + type: string + in: query + required: false + description: |- + For scoped functions only. + The scope to which the function belongs. + + QueryFunction: + name: name + schema: + type: string + in: query + required: true + description: The name of a function. + + QueryAggregate: + name: aggregate + schema: + type: boolean + default: false + in: query + required: false + x-has-default: true + description: |- + If `false`, the API accesses a single Eventing node. + If `true`, the API accesses all Eventing nodes. + + QuerySize: + name: size + schema: + type: integer + default: 40960 + in: query + required: false + x-has-default: true + description: |- + The approximate amount of logging information returned. + Note that 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. + + schemas: + settings_schema: + $ref: 'https://raw.githubusercontent.com/couchbase/eventing/refs/heads/master/parser/settings_schema.json' + + depcfg_schema: + $ref: 'https://raw.githubusercontent.com/couchbase/eventing/refs/heads/master/parser/depcfg_schema.json' + + handler_schema: + $ref: 'https://raw.githubusercontent.com/couchbase/eventing/refs/heads/master/parser/handler_schema.json' + + AppCode: + type: string + example: function OnUpdate(doc, meta) { log("id",meta.id); } + x-has-example: true + + AddFunction: + title: Function Request + oneOf: + - $ref: "#/components/schemas/handler_schema" + - type: array + description: An array containing a single function definition object. + minItems: 1 + maxItems: 1 + items: + $ref: "#/components/schemas/handler_schema" + + AddFunctions: + title: Functions Request + oneOf: + - $ref: "#/components/schemas/handler_schema" + - type: array + description: An array containing one or more function definition objects. + minItems: 1 + items: + $ref: "#/components/schemas/handler_schema" + + UnivConfig: + title: Global Config + type: object + properties: + ram_quota: + type: integer + default: 256 + example: 512 + x-has-example: true + x-has-default: true + description: The memory allocation for the Eventing Service, per node. + enable_debugger: + type: boolean + default: false + x-has-default: true + description: |- + Enables the Eventing service debugger. + For details, see [Debugging and Diagnosability](/server/7.6/eventing/eventing-debugging-and-diagnosability.html). + + responses: + OK: + description: Success. + + Goof: + description: Failure. + + securitySchemes: + Global: + type: http + scheme: basic + description: |- + Global functions with a function scope of ``*.*`` can only be made or managed by users with the Full Admin or Eventing Full Admin role. + For global functions, you do not need to pass the `bucket` and `scope` query parameters to specify the function scope. + The credentials must be an administrator username and password. + + Note that this is the default function scope for all functions after an upgrade from a prior version. + + Scoped: + type: http + scheme: basic + description: |- + For scoped functions, you must pass the `bucket` and `scope` query parameters to specify the function scope. + The credentials are the username and password of any authorized user. + + You can quote the REST call on the command line to escape the `&` and `?` characters. + + Unscoped: + type: http + scheme: basic + description: |- + Unscoped REST API calls do not require you to specify the function scope. + The action is fully determined by the username and password credentials passed to the REST call. diff --git a/templates/index.mustache b/templates/index.mustache index 03b00b9d..46937009 100644 --- a/templates/index.mustache +++ b/templates/index.mustache @@ -74,7 +74,7 @@ a| [markdown] {{! enumerated values}} {{#enumValues}}{{#-first}}*Values:* {{/-first}}{{^-last}}`{{this}}`, {{/-last}}{{#-last}}`{{this}}`{{/-last}}{{/enumValues}} {{! example }} -{{#value}}*Example:* `pass:c[{{this}}]`{{/value}} +{{#value}}*Example:* `+++{{this}}+++`{{/value}} // end {{#-last}} @@ -198,6 +198,25 @@ CAUTION: This operation is deprecated, and will be removed in a future release. {{! 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 }} @@ -230,26 +249,6 @@ CAUTION: This operation is deprecated, and will be removed in a future release. {{! include partials after the operation parameters }} {{#specinclude}}/paths/{{operationIdOriginal}}/operation-parameters-after.adoc{{/specinclude}} -{{! *** OPERATION PRODUCES *** }} -{{#hasProduces}} -[#{{operationIdOriginal}}-produces] -= Produces - -{{#produces}} -* {{{mediaType}}} -{{/produces}} -{{/hasProduces}} - -{{! *** OPERATION CONSUMES *** }} -{{#hasConsumes}} -[#{{operationIdOriginal}}-consumes] -= Consumes - -{{#consumes}} -* {{{mediaType}}} -{{/consumes}} -{{/hasConsumes}} - {{! *** OPERATION RESPONSES *** }} {{! include partial before operation responses }} {{#specinclude}}/paths/{{operationIdOriginal}}/operation-responses-before.adoc{{/specinclude}} @@ -458,3 +457,11 @@ __Key in__ : {{#isKeyInQuery}}query{{/isKeyInQuery}} {{#isKeyInHeader}}header{{/ {{! 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.mustache b/templates/model.mustache index c494d6ea..3f453e4d 100644 --- a/templates/model.mustache +++ b/templates/model.mustache @@ -13,29 +13,29 @@ ifdef::model-descriptions[] endif::model-descriptions[] {{/description}} -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema {{#vars}} {{! DEFINITION NAME }} -a| {{#vendorExtensions}}{{#x-desc-name}}[#{{this}}]{{/x-desc-name}}{{/vendorExtensions}} +a¦ {{#vendorExtensions}}{{#x-desc-name}}[#{{this}}]{{/x-desc-name}}{{/vendorExtensions}} *{{baseName}}* + _{{#required}}required{{/required}}{{^required}}optional{{/required}}_ {{! DEFINITION DESCRIPTION }} -a| {{>property}} +a¦ {{>property}} {{! DEFINITION SCHEMA }} -a| {{>schemas}} +a¦ {{>schemas}} {{/vars}} {{#additionalProperties}} {{! ADDITIONAL PROPERTY NAME }} -a| {{#vendorExtensions}}{{#x-desc-name}}[#{{this}}]{{/x-desc-name}}{{/vendorExtensions}} +a¦ {{#vendorExtensions}}{{#x-desc-name}}[#{{this}}]{{/x-desc-name}}{{/vendorExtensions}} _additional + property_ {{! ADDITIONAL PROPERTY DESCRIPTION }} -a| {{>property}} +a¦ {{>property}} {{! ADDITIONAL PROPERTY SCHEMA }} -a| {{>schemas}} +a¦ {{>schemas}} {{/additionalProperties}} |=== diff --git a/templates/param.mustache b/templates/param.mustache index 9715261c..3e0a6319 100644 --- a/templates/param.mustache +++ b/templates/param.mustache @@ -1,6 +1,6 @@ -a| *{{#isBodyParam}}Body{{/isBodyParam}}{{^isBodyParam}}{{baseName}}{{/isBodyParam}}* + +a¦ *{{#isBodyParam}}Body{{/isBodyParam}}{{^isBodyParam}}{{baseName}}{{/isBodyParam}}* + _{{#required}}required{{/required}}{{^required}}optional{{/required}}_ -a| {{#vendorExtensions}} +a¦ {{#vendorExtensions}} {{#x-desc-edition}}[.edition]##{{this}}##{{/x-desc-edition}}{{#x-desc-status}}[.status]##{{this}}##{{/x-desc-status}} {{/vendorExtensions}} @@ -25,11 +25,11 @@ include::index.adoc[tag=desc-{{dataType}}, opts=optional] {{/allowableValues}} {{! default value}} {{#vendorExtensions.x-has-default}} -*Default:* `{{#isString}}pass:c["{{/isString}}{{{defaultValue}}}{{#isString}}"]{{/isString}}` +*Default:* `{{#isString}}+++"{{/isString}}{{{defaultValue}}}{{#isString}}"+++{{/isString}}` {{/vendorExtensions.x-has-default}} {{! pattern}} {{#pattern}} -*Pattern:* `pass:c[{{{pattern}}}]` +*Pattern:* `+++{{{pattern}}}+++` {{/pattern}} {{! minimum value}} {{#minimum}} @@ -74,9 +74,9 @@ include::index.adoc[tag=desc-{{dataType}}, opts=optional] {{! example -- deprecated}} {{#isBodyParam}} {{#vendorExtensions.x-has-example}} -*Example:* `{{#isString}}pass:c["{{/isString}}{{{example}}}{{#isString}}"]{{/isString}}` +*Example:* `{{#isString}}+++"{{/isString}}{{{example}}}{{#isString}}"+++{{/isString}}` {{/vendorExtensions.x-has-example}} {{/isBodyParam}} {blank} -a| {{>schemas}} +a¦ {{>schemas}} diff --git a/templates/params.mustache b/templates/params.mustache index 56aadcb7..5b75171e 100644 --- a/templates/params.mustache +++ b/templates/params.mustache @@ -16,9 +16,9 @@ {blank} {{/useTableTitles}} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema {{#pathParams}} {{>param}} @@ -36,9 +36,9 @@ {blank} {{/useTableTitles}} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema {{#queryParams}} {{>param}} @@ -56,9 +56,9 @@ {blank} {{/useTableTitles}} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema {{#headerParams}} {{>param}} @@ -76,9 +76,9 @@ {blank} {{/useTableTitles}} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema {{#formParams}} {{>param}} @@ -96,9 +96,9 @@ {blank} {{/useTableTitles}} -[cols="20,60,20"] +[cols="20,60,20",separator=¦] |=== -|Name| Description| Schema +¦ Name ¦ Description ¦ Schema {{#bodyParams}} {{>param}} diff --git a/templates/property.mustache b/templates/property.mustache index 38b0c935..f4f1cfa6 100644 --- a/templates/property.mustache +++ b/templates/property.mustache @@ -30,11 +30,11 @@ include::index.adoc[tag=desc-{{dataType}}, opts=optional] {{/isEnum}} {{! default value}} {{#vendorExtensions.x-has-default}} -*Default:* `{{#isString}}pass:c["{{/isString}}{{{defaultValue}}}{{#isString}}"]{{/isString}}` +*Default:* `{{#isString}}+++"{{/isString}}{{{defaultValue}}}{{#isString}}"+++{{/isString}}` {{/vendorExtensions.x-has-default}} {{! pattern}} {{#pattern}} -*Pattern:* `pass:c[{{{pattern}}}]` +*Pattern:* `+++{{{pattern}}}+++` {{/pattern}} {{! minimum value}} {{#minimum}} @@ -78,6 +78,6 @@ include::index.adoc[tag=desc-{{dataType}}, opts=optional] {{/uniqueItems}} {{! example -- deprecated}} {{#vendorExtensions.x-has-example}} -*Example:* `{{#isString}}pass:c["{{/isString}}{{{example}}}{{#isString}}"]{{/isString}}` +*Example:* `{{#isString}}+++"{{/isString}}{{{example}}}{{#isString}}"+++{{/isString}}` {{/vendorExtensions.x-has-example}} {blank} \ No newline at end of file