diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml deleted file mode 100644 index 2a60b1c0..00000000 --- a/.github/workflows/build.yml +++ /dev/null @@ -1,31 +0,0 @@ -# This workflow will build a Java project with Gradle -# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle - -name: Gradle CI - -on: - push: - branches: [ capella ] - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v2 - - name: Set up JDK 11 - uses: actions/setup-java@v1 - with: - java-version: '11' - - name: Grant execute permission for gradlew - run: chmod +x gradlew - - name: Build with Gradle - run: ./gradlew --rerun-tasks - - name: Push output - run: | - git config user.name github-actions - git config user.email github-actions@github.com - git add . - git commit -m "Build output documentation" || echo "No changes to push" - git push diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 9df05676..f8bd4eba 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,8 +1,13 @@ +# This workflow will build a Java project with Gradle +# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle + name: Gradle CI on: pull_request: branches: [ capella ] + merge_group: + types: [checks_requested] jobs: test: @@ -11,6 +16,8 @@ jobs: steps: - uses: actions/checkout@v2 + with: + ref: ${{ github.event.pull_request.head.ref }} - name: Set up JDK 11 uses: actions/setup-java@v1 with: @@ -19,3 +26,10 @@ jobs: run: chmod +x gradlew - name: Build with Gradle run: ./gradlew --rerun-tasks + - name: Push output + run: | + git config user.name tech-comm-team-couchbase + git config user.email tech-comm-team@couchbase.com + git add . + git commit -m "Build output documentation" || echo "No changes to push" + git push diff --git a/LICENSE b/LICENSE index d1ba878a..2ae20167 100644 --- a/LICENSE +++ b/LICENSE @@ -1,10 +1,11 @@ -Couchbase Developer REST API Documentation © 2024 by Couchbase Inc. +Couchbase Developer REST API Documentation © 2025 by Couchbase Inc. -Files within the top-level src directory are not currently licensed. +Within the top-level `docs` directory, files in each `attachments` subdirectory are licensed under the Business Source License 1.1 (BSL). +For details, see the BSL-Couchbase.txt file in the top-level `licenses` directory. -Files within the top-level docs directory are licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International. -For details, see the CC-BY-NC-SA-4.0.txt file in the top-level licenses directory, or the Creative Commons CC BY-NC-SA 4.0 license page at https://creativecommons.org/licenses/by-nc-sa/4.0/. +All other files within the top-level `docs` directory are licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International. +For details, see the CC-BY-NC-SA-4.0.txt file in the top-level `licenses` directory, or the Creative Commons CC BY-NC-SA 4.0 license page at https://creativecommons.org/licenses/by-nc-sa/4.0/. All other files are derivative works, based on the OpenAPI Generator Gradle Plugin. These files are licensed under the Apache License, Version 2.0, and have been modified by Couchbase Inc. -For details, see the APL2.txt file in the top-level licenses directory, or the OpenAPI Generator repository at https://github.com/OpenAPITools/openapi-generator. \ No newline at end of file +For details, see the APL2.txt file in the top-level `licenses` directory, or the OpenAPI Generator repository at https://github.com/OpenAPITools/openapi-generator. \ No newline at end of file diff --git a/README.adoc b/README.adoc index 61cb39ad..acfe366e 100644 --- a/README.adoc +++ b/README.adoc @@ -5,7 +5,7 @@ This project uses the https://openapi-generator.tech/docs/plugins/#gradle[OpenAP == Usage guide This repository handles several OpenAPI subprojects. -Each subproject is stored in its own subfolder within the `src` folder. +Each subproject is stored in its own subfolder within the `docs/modules` folder. === Build Script @@ -19,12 +19,12 @@ These do not have a gradle build script. === OpenAPI Specification -Within each subproject, the OpenAPI Specification (JSON or YAML) is stored in a folder called `swagger`. +Within each subproject, the OpenAPI Specification (JSON or YAML) is stored in a folder called `attachments`. (For some subprojects, the OpenAPI specification file may be stored remotely, i.e. alongside the development source files.) === AsciiDoc Content -Each generated AsciiDoc page is stored in its own folder in the `docs` folder. +Within each subproject, the generated AsciiDoc page is stored in the `pages` folder. (In Antora terms, each generated AsciiDoc page is stored in its own module.) For each subproject, additional AsciiDoc content may be stored in the `partials` folder and its subfolders. @@ -50,7 +50,7 @@ This project is based on the https://openapi-generator.tech/[OpenAPI Generator] == Licensing -The Couchbase Developer REST API Documentation © 2024 by Couchbase Inc. is licensed under various licenses. +The Couchbase Developer REST API Documentation © 2025 by Couchbase Inc. is licensed under various licenses. The Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) is one such license. See the LICENSE file for details. All licenses used in this repository can be found in the top-level `licenses` directory. diff --git a/build.gradle b/build.gradle index 7bfefd4b..6dbaeb88 100644 --- a/build.gradle +++ b/build.gradle @@ -26,8 +26,16 @@ wrapper { defaultTasks 'admin:openApiGenerate', 'query-service:openApiGenerate', 'query-settings:openApiGenerate', + 'eventing:openApiGenerate', 'functions:openApiGenerate', 'indexes:openApiGenerate', + 'index-settings:openApiGenerate', + 'search-index:openApiGenerate', + 'search-nodes:openApiGenerate', + 'search-advanced:openApiGenerate', + 'search-stats:openApiGenerate', + 'search-query:openApiGenerate', + 'search-manage:openApiGenerate', 'analytics-admin:openApiGenerate', 'analytics-config:openApiGenerate', 'analytics-library:openApiGenerate', diff --git a/src/analytics-admin/analytics-admin.gradle b/docs/modules/analytics-rest-admin/analytics-admin.gradle similarity index 85% rename from src/analytics-admin/analytics-admin.gradle rename to docs/modules/analytics-rest-admin/analytics-admin.gradle index 84a3d4b5..de85902d 100644 --- a/src/analytics-admin/analytics-admin.gradle +++ b/docs/modules/analytics-rest-admin/analytics-admin.gradle @@ -2,11 +2,11 @@ apply plugin: 'org.openapi.generator' openApiGenerate { generatorName = "asciidoc" - inputSpec = file("swagger/analytics-admin.yaml").getAbsolutePath().toString() + inputSpec = file("attachments/_analytics-admin.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/analytics-rest-admin/pages" templateDir = "${rootDir}/templates" gitRepoId = "cb-swagger" - gitUserId = "couchbase" + gitUserId = "couchbaselabs" additionalProperties = [ specDir: "${rootDir}/docs/modules/analytics-rest-admin/partials/", snippetDir: "${rootDir}/docs/modules/analytics-rest-admin/partials/paths/", diff --git a/src/analytics-admin/swagger/analytics-admin.yaml b/docs/modules/analytics-rest-admin/attachments/_analytics-admin.yaml similarity index 99% rename from src/analytics-admin/swagger/analytics-admin.yaml rename to docs/modules/analytics-rest-admin/attachments/_analytics-admin.yaml index 214508e8..ffd2ec61 100644 --- a/src/analytics-admin/swagger/analytics-admin.yaml +++ b/docs/modules/analytics-rest-admin/attachments/_analytics-admin.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Analytics Administration REST APIs - version: capella + version: "8.0" description: | The Analytics Administration REST APIs are provided by the Analytics service. These APIs enables you to manage and monitor the Analytics service. @@ -20,11 +20,11 @@ servers: - https host: default: localhost - description: The host name or IP address of a node running the Analytics service. + description: The host name or IP address of a node running the Analytics Service. port: default: "8095" description: |- - The Analytics service REST port. + The Analytics Service REST port. Use `18095` for secure access. enum: - "8095" @@ -606,6 +606,7 @@ components: landmark: 7 MutationsColl: + x-additionalPropertiesName: scope type: object description: > An object containing one or more collection properties, one for each Analytics collection in the Analytics scope. @@ -615,6 +616,7 @@ components: For example, `` `travel-sample`.inventory ``. title: Collections additionalProperties: + x-additionalPropertiesName: collection type: integer description: > The number of mutations in the DCP queue that have not yet been ingested. diff --git a/src/analytics-admin/gradle.properties b/docs/modules/analytics-rest-admin/gradle.properties similarity index 100% rename from src/analytics-admin/gradle.properties rename to docs/modules/analytics-rest-admin/gradle.properties diff --git a/docs/modules/analytics-rest-admin/pages/index.adoc b/docs/modules/analytics-rest-admin/pages/index.adoc index abfdd0c0..f35d47f8 100644 --- a/docs/modules/analytics-rest-admin/pages/index.adoc +++ b/docs/modules/analytics-rest-admin/pages/index.adoc @@ -8,7 +8,7 @@ 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 +DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 @@ -33,7 +33,7 @@ These APIs enables you to manage and monitor the Analytics service. [discrete#version] = Version information [%hardbreaks] -__Version__ : capella +__Version__ : 8.0 [discrete#host] = Host information @@ -59,29 +59,29 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* a| [markdown] -- -The host name or IP address of a node running the Analytics service. +The host name or IP address of a node running the Analytics Service. -- [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* a| [markdown] -- -The Analytics service REST port. Use `18095` for secure access. +The Analytics Service REST port. Use `18095` for secure access. -- [%hardbreaks] *Values:* `8095`, `18095` -*Example:* `pass:c[8095]` +*Example:* `+++8095+++` // end |=== @@ -114,7 +114,7 @@ ifeval::[{count-apis} > 1] The operations are grouped in the following categories. [%hardbreaks] -<> +xref:tag-Default[] endif::[] @@ -132,16 +132,18 @@ endif::[] endif::[] [%hardbreaks] -<> -<> -<> -<> -<> -<> -<> -<> +xref:cancel_request[] +xref:cluster_status[] +xref:completed_requests[] +xref:ingestion_status[] +xref:monitor_node[] +xref:restart_cluster[] +xref:restart_node[] +xref:return_active_requests[] +//tag::cancel_request[] + // markup not found, no include::{specDir}paths/cancel_request/operation-before.adoc[opts=optional] @@ -179,6 +181,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 +215,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 +232,7 @@ Identifier passed by the client that is used to identify an active request to be [%hardbreaks] {blank} -a| String +a¦ String @@ -239,16 +250,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] @@ -321,7 +322,7 @@ a| | Type | Name | http (basic) -| <> +| xref:security-analyticsManageAnalyticsSelect[] |=== @@ -350,6 +351,10 @@ include::{snippetDir}cancel_request/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/cancel_request/operation-after.adoc[opts=optional] +//end::cancel_request[] + + +//tag::cluster_status[] // markup not found, no include::{specDir}paths/cluster_status/operation-before.adoc[opts=optional] @@ -388,6 +393,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 +416,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] @@ -432,7 +437,7 @@ a| [markdown] -- Success. Returns an object giving the current status of the Analytics Service. -- -a| <> +a| xref:Status[] | 401 @@ -479,7 +484,7 @@ a| | Type | Name | http (basic) -| <> +| xref:security-clusterReadPoolsRead[] |=== @@ -508,6 +513,10 @@ include::{snippetDir}cluster_status/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/cluster_status/operation-after.adoc[opts=optional] +//end::cluster_status[] + + +//tag::completed_requests[] // markup not found, no include::{specDir}paths/completed_requests/operation-before.adoc[opts=optional] @@ -546,6 +555,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 +578,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] @@ -590,7 +599,7 @@ a| [markdown] -- Success. Returns a list of all completed analytic requests. -- -a| <> +a| xref:Request[] array | 401 @@ -637,7 +646,7 @@ a| | Type | Name | http (basic) -| <> +| xref:security-analyticsManageAnalyticsSelect[] |=== @@ -666,6 +675,10 @@ include::{snippetDir}completed_requests/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/completed_requests/operation-after.adoc[opts=optional] +//end::completed_requests[] + + +//tag::ingestion_status[] // markup not found, no include::{specDir}paths/ingestion_status/operation-before.adoc[opts=optional] @@ -704,6 +717,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 +740,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] @@ -748,7 +761,7 @@ a| [markdown] -- Success. Returns an object giving the ingestion status of each Analytics collection. -- -a| <> +a| xref:Ingestion[] | 401 @@ -795,7 +808,7 @@ a| | Type | Name | http (basic) -| <> +| xref:security-analyticsManageAnalyticsSelect[] |=== @@ -824,6 +837,10 @@ include::{snippetDir}ingestion_status/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/ingestion_status/operation-after.adoc[opts=optional] +//end::ingestion_status[] + + +//tag::monitor_node[] // markup not found, no include::{specDir}paths/monitor_node/operation-before.adoc[opts=optional] @@ -866,6 +883,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 +906,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] @@ -910,7 +927,7 @@ a| [markdown] -- Success. Returns an object giving the number of pending mutations for each Analytics collection. -- -a| <> +a| xref:Mutations[] | 401 @@ -957,7 +974,7 @@ a| | Type | Name | http (basic) -| <> +| xref:security-analyticsManageAnalyticsSelect[] |=== @@ -986,6 +1003,10 @@ include::{snippetDir}monitor_node/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/monitor_node/operation-after.adoc[opts=optional] +//end::monitor_node[] + + +//tag::restart_cluster[] // markup not found, no include::{specDir}paths/restart_cluster/operation-before.adoc[opts=optional] @@ -1024,6 +1045,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 +1068,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] @@ -1115,7 +1136,7 @@ a| | Type | Name | http (basic) -| <> +| xref:security-analyticsManage[] |=== @@ -1144,6 +1165,10 @@ include::{snippetDir}restart_cluster/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/restart_cluster/operation-after.adoc[opts=optional] +//end::restart_cluster[] + + +//tag::restart_node[] // markup not found, no include::{specDir}paths/restart_node/operation-before.adoc[opts=optional] @@ -1182,6 +1207,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 +1230,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] @@ -1273,7 +1298,7 @@ a| | Type | Name | http (basic) -| <> +| xref:security-analyticsManage[] |=== @@ -1302,6 +1327,10 @@ include::{snippetDir}restart_node/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/restart_node/operation-after.adoc[opts=optional] +//end::restart_node[] + + +//tag::return_active_requests[] // markup not found, no include::{specDir}paths/return_active_requests/operation-before.adoc[opts=optional] @@ -1340,6 +1369,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 +1392,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] @@ -1384,7 +1413,7 @@ a| [markdown] -- Success. Returns an array id details on the running requests. -- -a| <> +a| xref:Request[] array | 401 @@ -1431,7 +1460,7 @@ a| | Type | Name | http (basic) -| <> +| xref:security-analyticsManageAnalyticsSelect[] |=== @@ -1460,6 +1489,8 @@ include::{snippetDir}return_active_requests/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/return_active_requests/operation-after.adoc[opts=optional] +//end::return_active_requests[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -1496,20 +1527,20 @@ ifdef::collapse-models[] [.two-columns] endif::collapse-models[] [%hardbreaks] -<> -<> -<> -<> -<> -<> -<> -<> -<> -<> -<> -<> -<> -<> +xref:Ingestion[] +xref:IngestionLink[] +xref:IngestionLinkState[] +xref:IngestionLinkStateScope[] +xref:IngestionLinkStateScopeColl[] +xref:Mutations[] +xref:MutationsColl[] +xref:Request[] +xref:Status[] +xref:StatusNodes[] +xref:StatusPartitions[] +xref:StatusTopology[] +xref:StatusTopologyState[] +xref:StatusTopologyStateReplicas[] endif::[] @@ -1539,14 +1570,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 +1586,7 @@ An array of objects, each giving information about a single linked Analytics sco [%hardbreaks] {blank} -a| <> +a¦ xref:IngestionLink[] array |=== @@ -1595,14 +1626,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 +1641,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 +1657,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 +1674,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 +1694,7 @@ Analytics collections which have the same ingestion state within this Analytics [%hardbreaks] {blank} -a| <> +a¦ xref:IngestionLinkState[] array |=== @@ -1703,14 +1734,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 +1751,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 +1769,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 +1786,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 +1805,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 +1822,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 +1837,7 @@ An array of objects, each one giving information about a single Analytics scope. [%hardbreaks] {blank} -a| <> +a¦ xref:IngestionLinkStateScope[] array |=== @@ -1846,14 +1877,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 +1892,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 +1909,7 @@ An array of objects, each one giving information about a single Analytics collec [%hardbreaks] {blank} -a| <> +a¦ xref:IngestionLinkStateScopeColl[] array |=== @@ -1918,14 +1949,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 +1964,9 @@ The name of the Analytics collection. -- [%hardbreaks] -*Example:* `pass:c["route"]` +*Example:* `+++"route"+++` {blank} -a| String +a¦ String |=== @@ -1980,14 +2011,15 @@ 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 +2028,7 @@ include::index.adoc[tag=desc-MutationsColl, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ xref:MutationsColl[] |=== @@ -2044,14 +2076,15 @@ 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 +2094,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 +2139,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 +2155,13 @@ Whether this request can be cancelled. [%hardbreaks] {blank} -a| Boolean +a¦ Boolean -a| +a¦ *clientContextID* + _optional_ -a| +a¦ [markdown] -- @@ -2136,15 +2169,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 +2187,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 +2201,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 +2218,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 +2236,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 +2252,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 +2269,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 +2283,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 +2300,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 +2317,13 @@ The query plan for this request. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *node* + _optional_ -a| +a¦ [markdown] -- @@ -2298,15 +2331,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 +2347,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 +2363,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 +2379,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 +2396,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 +2412,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 +2428,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 +2444,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 +2460,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 +2507,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 +2524,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 +2538,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 +2554,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 +2571,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 +2587,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 +2603,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 +2619,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 +2636,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 +2652,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 +2669,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 +2686,13 @@ An array of objects, each giving information about one Analytics node. [%hardbreaks] {blank} -a| <> +a¦ xref:StatusNodes[] array -a| +a¦ *partitions* + _optional_ -a| +a¦ [markdown] -- @@ -2668,13 +2701,13 @@ An array of objects, each giving information about one Analytics partition. [%hardbreaks] {blank} -a| <> +a¦ xref:StatusPartitions[] array -a| +a¦ *partitionsTopology* + _optional_ -a| +a¦ [markdown] -- @@ -2683,7 +2716,7 @@ include::index.adoc[tag=desc-StatusTopology, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ xref:StatusTopology[] |=== @@ -2723,14 +2756,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 +2771,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 +2787,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 +2803,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 +2819,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 +2861,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 +2878,13 @@ Indicates whether this partition is active. [%hardbreaks] *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *activeNodeId* + _optional_ -a| +a¦ [markdown] -- @@ -2859,15 +2892,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 +2910,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 +2924,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 +2942,13 @@ The ID of this partition. [%hardbreaks] *Example:* `0` {blank} -a| Integer +a¦ Integer -a| +a¦ *path* + _optional_ -a| +a¦ [markdown] -- @@ -2923,15 +2956,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 +2974,7 @@ Indicates whether this partition is waiting to become active. [%hardbreaks] *Example:* `false` {blank} -a| Boolean +a¦ Boolean |=== @@ -2986,14 +3019,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 +3036,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 +3050,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 +3068,13 @@ The ID of the metadata partition. [%hardbreaks] *Example:* `-1` {blank} -a| Integer +a¦ Integer -a| +a¦ *numReplicas* + _optional_ -a| +a¦ [markdown] -- @@ -3051,13 +3084,13 @@ The number of Analytics replicas. [%hardbreaks] *Example:* `1` {blank} -a| Integer +a¦ Integer -a| +a¦ *revision* + _optional_ -a| +a¦ [markdown] -- @@ -3067,13 +3100,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 +3116,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 +3131,7 @@ An array of objects, each giving information about the state of one Analytics pa [%hardbreaks] {blank} -a| <> +a¦ xref:StatusTopologyState[] array |=== @@ -3138,14 +3171,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 +3188,13 @@ The partition ID. [%hardbreaks] *Example:* `0` {blank} -a| Integer +a¦ Integer -a| +a¦ *master* + _optional_ -a| +a¦ [markdown] -- @@ -3169,15 +3202,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 +3218,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 +3235,7 @@ An array of objects, each giving information about the state of one Analytics re [%hardbreaks] {blank} -a| <> +a¦ xref:StatusTopologyStateReplicas[] array |=== @@ -3242,14 +3275,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 +3290,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 +3306,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 +3323,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 +3343,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 +3501,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-admin/partials/security/document-begin.adoc b/docs/modules/analytics-rest-admin/partials/security/document-begin.adoc index 5df917db..7ec44140 100644 --- a/docs/modules/analytics-rest-admin/partials/security/document-begin.adoc +++ b/docs/modules/analytics-rest-admin/partials/security/document-begin.adoc @@ -1,2 +1,2 @@ The Analytics Administration REST APIs support HTTP basic authentication. -Credentials can be passed via HTTP headers. \ No newline at end of file +Pass your credentials through HTTP headers. \ No newline at end of file diff --git a/docs/modules/analytics-rest-admin/partials/security/document-end.adoc b/docs/modules/analytics-rest-admin/partials/security/document-end.adoc index 8911b27a..5330f469 100644 --- a/docs/modules/analytics-rest-admin/partials/security/document-end.adoc +++ b/docs/modules/analytics-rest-admin/partials/security/document-end.adoc @@ -1 +1 @@ -Refer to xref:learn:security/roles.adoc[] for more details. \ No newline at end of file +For more information, see xref:learn:security/roles.adoc[]. \ No newline at end of file diff --git a/src/analytics-config/analytics-config.gradle b/docs/modules/analytics-rest-config/analytics-config.gradle similarity index 85% rename from src/analytics-config/analytics-config.gradle rename to docs/modules/analytics-rest-config/analytics-config.gradle index 8a0d47e5..4fe23dd8 100644 --- a/src/analytics-config/analytics-config.gradle +++ b/docs/modules/analytics-rest-config/analytics-config.gradle @@ -2,11 +2,11 @@ apply plugin: 'org.openapi.generator' openApiGenerate { generatorName = "asciidoc" - inputSpec = file("swagger/analytics-config.yaml").getAbsolutePath().toString() + inputSpec = file("attachments/_analytics-config.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/analytics-rest-config/pages" templateDir = "${rootDir}/templates" gitRepoId = "cb-swagger" - gitUserId = "couchbase" + gitUserId = "couchbaselabs" additionalProperties = [ specDir: "${rootDir}/docs/modules/analytics-rest-config/partials/", snippetDir: "${rootDir}/docs/modules/analytics-rest-config/partials/paths/", diff --git a/src/analytics-config/swagger/analytics-config.yaml b/docs/modules/analytics-rest-config/attachments/_analytics-config.yaml similarity index 99% rename from src/analytics-config/swagger/analytics-config.yaml rename to docs/modules/analytics-rest-config/attachments/_analytics-config.yaml index 4091adc9..117c4c06 100644 --- a/src/analytics-config/swagger/analytics-config.yaml +++ b/docs/modules/analytics-rest-config/attachments/_analytics-config.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Analytics Configuration REST API - version: capella + version: "8.0" description: | The Analytics Configuration REST API is provided by the Analytics service. This API enables you to configure Analytics nodes and clusters. @@ -20,11 +20,11 @@ servers: - https host: default: localhost - description: The host name or IP address of a node running the Analytics service. + description: The host name or IP address of a node running the Analytics Service. port: default: "8095" description: |- - The Analytics service REST port. + The Analytics Service REST port. Use `18095` for secure access. enum: - "8095" diff --git a/src/analytics-config/gradle.properties b/docs/modules/analytics-rest-config/gradle.properties similarity index 100% rename from src/analytics-config/gradle.properties rename to docs/modules/analytics-rest-config/gradle.properties diff --git a/docs/modules/analytics-rest-config/pages/index.adoc b/docs/modules/analytics-rest-config/pages/index.adoc index 9b8593da..969a2e01 100644 --- a/docs/modules/analytics-rest-config/pages/index.adoc +++ b/docs/modules/analytics-rest-config/pages/index.adoc @@ -8,7 +8,7 @@ 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 +DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 @@ -33,7 +33,7 @@ This API enables you to configure Analytics nodes and clusters. [discrete#version] = Version information [%hardbreaks] -__Version__ : capella +__Version__ : 8.0 [discrete#host] = Host information @@ -59,29 +59,29 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* a| [markdown] -- -The host name or IP address of a node running the Analytics service. +The host name or IP address of a node running the Analytics Service. -- [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* a| [markdown] -- -The Analytics service REST port. Use `18095` for secure access. +The Analytics Service REST port. Use `18095` for secure access. -- [%hardbreaks] *Values:* `8095`, `18095` -*Example:* `pass:c[8095]` +*Example:* `+++8095+++` // end |=== @@ -114,7 +114,7 @@ ifeval::[{count-apis} > 1] The operations are grouped in the following categories. [%hardbreaks] -<> +xref:tag-Default[] endif::[] @@ -132,12 +132,14 @@ endif::[] endif::[] [%hardbreaks] -<> -<> -<> -<> +xref:get_node[] +xref:get_service[] +xref:put_node[] +xref:put_service[] +//tag::get_node[] + // markup not found, no include::{specDir}paths/get_node/operation-before.adoc[opts=optional] @@ -175,6 +177,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 +200,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] @@ -219,7 +221,7 @@ a| [markdown] -- Success. Returns an object listing the configurable node-level parameters and their current values. -- -a| <> +a| xref:Node[] | 401 @@ -260,7 +262,7 @@ a| Object | Type | Name | http (basic) -| <> +| xref:security-analyticsManage[] |=== @@ -289,6 +291,10 @@ include::{snippetDir}get_node/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_node/operation-after.adoc[opts=optional] +//end::get_node[] + + +//tag::get_service[] // markup not found, no include::{specDir}paths/get_service/operation-before.adoc[opts=optional] @@ -327,6 +333,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 +356,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] @@ -371,7 +377,7 @@ a| [markdown] -- Success. Returns an object listing the configurable service-level parameters and their current values. -- -a| <> +a| xref:Service[] | 401 @@ -412,7 +418,7 @@ a| Object | Type | Name | http (basic) -| <> +| xref:security-analyticsManage[] |=== @@ -441,6 +447,10 @@ include::{snippetDir}get_service/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_service/operation-after.adoc[opts=optional] +//end::get_service[] + + +//tag::put_node[] // markup not found, no include::{specDir}paths/put_node/operation-before.adoc[opts=optional] @@ -486,6 +496,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 +532,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 +549,7 @@ An object specifying one or more of the configurable node-level parameters on th [%hardbreaks] {blank} -a| <> +a¦ xref:Node[] @@ -546,17 +566,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] @@ -584,7 +593,7 @@ a| [markdown] -- Bad request. Unknown parameter or incorrect value. -- -a| <> +a| xref:Errors[] | 401 @@ -625,7 +634,7 @@ a| Object | Type | Name | http (basic) -| <> +| xref:security-analyticsManage[] |=== @@ -654,6 +663,10 @@ include::{snippetDir}put_node/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/put_node/operation-after.adoc[opts=optional] +//end::put_node[] + + +//tag::put_service[] // markup not found, no include::{specDir}paths/put_service/operation-before.adoc[opts=optional] @@ -697,6 +710,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 +746,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 +763,7 @@ An object specifying one or more of the configurable service-level parameters. [%hardbreaks] {blank} -a| <> +a¦ xref:Service[] @@ -757,17 +780,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] @@ -795,7 +807,7 @@ a| [markdown] -- Bad request. Unknown parameter or incorrect value. -- -a| <> +a| xref:Errors[] | 401 @@ -836,7 +848,7 @@ a| Object | Type | Name | http (basic) -| <> +| xref:security-analyticsManage[] |=== @@ -865,6 +877,8 @@ include::{snippetDir}put_service/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/put_service/operation-after.adoc[opts=optional] +//end::put_service[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -901,9 +915,9 @@ ifdef::collapse-models[] [.two-columns] endif::collapse-models[] [%hardbreaks] -<> -<> -<> +xref:Errors[] +xref:Node[] +xref:Service[] endif::[] @@ -928,14 +942,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 +958,7 @@ An error message. [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -984,14 +998,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] -- @@ -1010,13 +1024,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] -- @@ -1028,13 +1042,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] -- @@ -1046,7 +1060,7 @@ The default is 1/4 of the allocated Analytics Service memory. [%hardbreaks] {blank} -a| Integer +a¦ Integer |=== @@ -1086,14 +1100,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] -- @@ -1103,13 +1117,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] -- @@ -1119,13 +1133,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] -- @@ -1135,13 +1149,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] -- @@ -1151,13 +1165,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] -- @@ -1167,13 +1181,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] -- @@ -1183,13 +1197,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] -- @@ -1198,13 +1212,13 @@ The bind address to use. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *bindToHost* + _optional_ -a| +a¦ [markdown] -- @@ -1214,13 +1228,13 @@ Bind to configured hostname instead of wildcard address. [%hardbreaks] *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *clusterConnectRetries* + _optional_ -a| +a¦ [markdown] -- @@ -1230,13 +1244,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] -- @@ -1246,13 +1260,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] -- @@ -1262,13 +1276,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] -- @@ -1278,13 +1292,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] -- @@ -1294,13 +1308,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] -- @@ -1311,13 +1325,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] -- @@ -1327,13 +1341,13 @@ Enables or disables full parallel sort. [%hardbreaks] *Default:* `false` {blank} -a| Boolean +a¦ Boolean -a| +a¦ *compilerSortmemory* + _optional_ -a| +a¦ [markdown] -- @@ -1343,13 +1357,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] -- @@ -1359,13 +1373,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] -- @@ -1375,13 +1389,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] -- @@ -1394,13 +1408,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] -- @@ -1411,13 +1425,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] -- @@ -1429,13 +1443,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] -- @@ -1445,13 +1459,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] -- @@ -1461,13 +1475,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] -- @@ -1477,13 +1491,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] -- @@ -1493,13 +1507,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] -- @@ -1515,13 +1529,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] -- @@ -1529,15 +1543,15 @@ The logging level. -- [%hardbreaks] -*Default:* `pass:c["DEBUG"]` +*Default:* `+++"DEBUG"+++` {blank} -a| String +a¦ String -a| +a¦ *maxWebRequestSize* + _optional_ -a| +a¦ [markdown] -- @@ -1547,13 +1561,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] -- @@ -1563,13 +1577,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] -- @@ -1579,13 +1593,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] -- @@ -1595,13 +1609,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] -- @@ -1612,13 +1626,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] -- @@ -1629,13 +1643,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] -- @@ -1645,13 +1659,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] -- @@ -1661,13 +1675,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] -- @@ -1677,13 +1691,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] -- @@ -1693,13 +1707,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] -- @@ -1709,13 +1723,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] -- @@ -1723,15 +1737,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] -- @@ -1741,13 +1755,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] -- @@ -1757,13 +1771,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] -- @@ -1774,13 +1788,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] -- @@ -1790,13 +1804,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] -- @@ -1804,15 +1818,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] -- @@ -1823,13 +1837,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] -- @@ -1839,7 +1853,7 @@ The interval (in seconds) after which an Analytics collection is considered idle [%hardbreaks] *Default:* `3600` {blank} -a| Integer (int32) +a¦ Integer (int32) |=== @@ -1923,3 +1937,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/partials/security/document-begin.adoc b/docs/modules/analytics-rest-config/partials/security/document-begin.adoc index ac4b0445..0942d209 100644 --- a/docs/modules/analytics-rest-config/partials/security/document-begin.adoc +++ b/docs/modules/analytics-rest-config/partials/security/document-begin.adoc @@ -1,2 +1,2 @@ The Analytics Configuration REST API supports HTTP basic authentication. -Credentials can be passed via HTTP headers. \ No newline at end of file +Pass your credentials through HTTP headers. \ No newline at end of file diff --git a/docs/modules/analytics-rest-config/partials/security/document-end.adoc b/docs/modules/analytics-rest-config/partials/security/document-end.adoc index 8911b27a..5330f469 100644 --- a/docs/modules/analytics-rest-config/partials/security/document-end.adoc +++ b/docs/modules/analytics-rest-config/partials/security/document-end.adoc @@ -1 +1 @@ -Refer to xref:learn:security/roles.adoc[] for more details. \ No newline at end of file +For more information, see xref:learn:security/roles.adoc[]. \ No newline at end of file diff --git a/src/analytics-library/analytics-library.gradle b/docs/modules/analytics-rest-library/analytics-library.gradle similarity index 85% rename from src/analytics-library/analytics-library.gradle rename to docs/modules/analytics-rest-library/analytics-library.gradle index e5404bc7..d61ae235 100644 --- a/src/analytics-library/analytics-library.gradle +++ b/docs/modules/analytics-rest-library/analytics-library.gradle @@ -2,11 +2,11 @@ apply plugin: 'org.openapi.generator' openApiGenerate { generatorName = "asciidoc" - inputSpec = file("swagger/analytics-library.yaml").getAbsolutePath().toString() + inputSpec = file("attachments/_analytics-library.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/analytics-rest-library/pages" templateDir = "${rootDir}/templates" gitRepoId = "cb-swagger" - gitUserId = "couchbase" + gitUserId = "couchbaselabs" additionalProperties = [ specDir: "${rootDir}/docs/modules/analytics-rest-library/partials/", snippetDir: "${rootDir}/docs/modules/analytics-rest-library/partials/paths/", diff --git a/src/analytics-library/swagger/analytics-library.yaml b/docs/modules/analytics-rest-library/attachments/_analytics-library.yaml similarity index 98% rename from src/analytics-library/swagger/analytics-library.yaml rename to docs/modules/analytics-rest-library/attachments/_analytics-library.yaml index e5dbe660..e1d0a431 100644 --- a/src/analytics-library/swagger/analytics-library.yaml +++ b/docs/modules/analytics-rest-library/attachments/_analytics-library.yaml @@ -20,11 +20,11 @@ servers: - https host: default: localhost - description: The host name or IP address of a node running the Analytics service. + description: The host name or IP address of a node running the Analytics Service. port: default: "8095" description: |- - The Analytics service REST port. + The Analytics Service REST port. Use `18095` for secure access. enum: - "8095" diff --git a/src/analytics-library/gradle.properties b/docs/modules/analytics-rest-library/gradle.properties similarity index 100% rename from src/analytics-library/gradle.properties rename to docs/modules/analytics-rest-library/gradle.properties diff --git a/docs/modules/analytics-rest-library/pages/index.adoc b/docs/modules/analytics-rest-library/pages/index.adoc index f43ef615..d6dac74d 100644 --- a/docs/modules/analytics-rest-library/pages/index.adoc +++ b/docs/modules/analytics-rest-library/pages/index.adoc @@ -8,7 +8,7 @@ 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 +DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 @@ -59,29 +59,29 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* a| [markdown] -- -The host name or IP address of a node running the Analytics service. +The host name or IP address of a node running the Analytics Service. -- [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* a| [markdown] -- -The Analytics service REST port. Use `18095` for secure access. +The Analytics Service REST port. Use `18095` for secure access. -- [%hardbreaks] *Values:* `8095`, `18095` -*Example:* `pass:c[8095]` +*Example:* `+++8095+++` // end |=== @@ -114,7 +114,7 @@ ifeval::[{count-apis} > 1] The operations are grouped in the following categories. [%hardbreaks] -<> +xref:tag-Default[] endif::[] @@ -132,11 +132,13 @@ endif::[] endif::[] [%hardbreaks] -<> -<> -<> +xref:delete_library[] +xref:get_collection[] +xref:post_library[] +//tag::delete_library[] + // markup not found, no include::{specDir}paths/delete_library/operation-before.adoc[opts=optional] @@ -174,6 +176,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 +204,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 +221,13 @@ The name of a library. [%hardbreaks] {blank} -a| String +a¦ String -a| *scope* + +a¦ *scope* + _required_ -a| +a¦ [markdown] @@ -233,7 +241,7 @@ The scope name may contain one or two identifiers, separated by a slash (/). You [%hardbreaks] {blank} -a| String +a¦ String @@ -254,12 +262,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] @@ -295,7 +297,7 @@ a| [markdown] -- Internal server error. Incorrect path or port number, incorrect credentials, badly formatted parameters, or missing arguments. -- -a| <> +a| xref:Errors[] @@ -328,7 +330,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-fullAdmin[] |=== @@ -357,6 +359,10 @@ include::{snippetDir}delete_library/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/delete_library/operation-after.adoc[opts=optional] +//end::delete_library[] + + +//tag::get_collection[] // markup not found, no include::{specDir}paths/get_collection/operation-before.adoc[opts=optional] @@ -395,6 +401,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 +424,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] @@ -439,7 +445,7 @@ a| [markdown] -- Success. Returns an array of objects, each of which contains information about a single library. -- -a| <> +a| xref:Libraries[] array | 404 @@ -453,7 +459,7 @@ a| [markdown] -- Internal server error. Incorrect path or port number, incorrect credentials, badly formatted parameters, or missing arguments. -- -a| <> +a| xref:Errors[] @@ -486,7 +492,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-analyticsAdmin[] |=== @@ -515,6 +521,10 @@ include::{snippetDir}get_collection/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_collection/operation-after.adoc[opts=optional] +//end::get_collection[] + + +//tag::post_library[] // markup not found, no include::{specDir}paths/post_library/operation-before.adoc[opts=optional] @@ -554,6 +564,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 +595,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 +612,13 @@ The name of a library. [%hardbreaks] {blank} -a| String +a¦ String -a| *scope* + +a¦ *scope* + _required_ -a| +a¦ [markdown] @@ -613,7 +632,7 @@ The scope name may contain one or two identifiers, separated by a slash (/). You [%hardbreaks] {blank} -a| String +a¦ String @@ -625,13 +644,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 +661,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 +679,7 @@ The language of the library. *Values:* `"python"` {blank} -a| String +a¦ String @@ -678,16 +697,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] @@ -717,7 +726,7 @@ a| [markdown] -- Bad request. A parameter has an incorrect value. -- -a| <> +a| xref:Errors[] | 500 @@ -725,7 +734,7 @@ a| [markdown] -- Internal server error. Incorrect path or port number, incorrect credentials, badly formatted parameters, or missing arguments. -- -a| <> +a| xref:Errors[] @@ -758,7 +767,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-fullAdmin[] |=== @@ -787,6 +796,8 @@ include::{snippetDir}post_library/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/post_library/operation-after.adoc[opts=optional] +//end::post_library[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -823,8 +834,8 @@ ifdef::collapse-models[] [.two-columns] endif::collapse-models[] [%hardbreaks] -<> -<> +xref:Errors[] +xref:Libraries[] endif::[] @@ -849,14 +860,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 +876,7 @@ An error message. [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -905,14 +916,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 +934,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 +951,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 +965,9 @@ The name of the library. -- [%hardbreaks] -*Example:* `pass:c["mylib"]` +*Example:* `+++"mylib"+++` {blank} -a| String +a¦ String |=== @@ -1072,3 +1083,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/partials/security/document-begin.adoc b/docs/modules/analytics-rest-library/partials/security/document-begin.adoc index 83f1e8ef..dd8f818e 100644 --- a/docs/modules/analytics-rest-library/partials/security/document-begin.adoc +++ b/docs/modules/analytics-rest-library/partials/security/document-begin.adoc @@ -1,2 +1,2 @@ The Analytics Library REST API supports HTTP basic authentication. -Credentials can be passed via HTTP headers. \ No newline at end of file +Pass your credentials through HTTP headers. \ No newline at end of file diff --git a/docs/modules/analytics-rest-library/partials/security/document-end.adoc b/docs/modules/analytics-rest-library/partials/security/document-end.adoc index 8911b27a..5330f469 100644 --- a/docs/modules/analytics-rest-library/partials/security/document-end.adoc +++ b/docs/modules/analytics-rest-library/partials/security/document-end.adoc @@ -1 +1 @@ -Refer to xref:learn:security/roles.adoc[] for more details. \ No newline at end of file +For more information, see xref:learn:security/roles.adoc[]. \ No newline at end of file diff --git a/src/analytics-links/analytics-links.gradle b/docs/modules/analytics-rest-links/analytics-links.gradle similarity index 85% rename from src/analytics-links/analytics-links.gradle rename to docs/modules/analytics-rest-links/analytics-links.gradle index 47f7ba3e..77bbbebb 100644 --- a/src/analytics-links/analytics-links.gradle +++ b/docs/modules/analytics-rest-links/analytics-links.gradle @@ -2,11 +2,11 @@ apply plugin: 'org.openapi.generator' openApiGenerate { generatorName = "asciidoc" - inputSpec = file("swagger/analytics-links.yaml").getAbsolutePath().toString() + inputSpec = file("attachments/_analytics-links.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/analytics-rest-links/pages" templateDir = "${rootDir}/templates" gitRepoId = "cb-swagger" - gitUserId = "couchbase" + gitUserId = "couchbaselabs" additionalProperties = [ specDir: "${rootDir}/docs/modules/analytics-rest-links/partials/", snippetDir: "${rootDir}/docs/modules/analytics-rest-links/partials/paths/", diff --git a/src/analytics-links/swagger/analytics-links.yaml b/docs/modules/analytics-rest-links/attachments/_analytics-links.yaml similarity index 99% rename from src/analytics-links/swagger/analytics-links.yaml rename to docs/modules/analytics-rest-links/attachments/_analytics-links.yaml index 77181f67..dc9d851a 100644 --- a/src/analytics-links/swagger/analytics-links.yaml +++ b/docs/modules/analytics-rest-links/attachments/_analytics-links.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Analytics Links REST API - version: capella + version: "8.0" description: |- The Analytics Links REST API is provided by the Analytics service. This API enables you to manage the links to remote Couchbase clusters and external data sources. @@ -20,11 +20,11 @@ servers: - https host: default: localhost - description: The host name or IP address of a node running the Analytics service. + description: The host name or IP address of a node running the Analytics Service. port: default: "8095" description: |- - The Analytics service REST port. + The Analytics Service REST port. Use `18095` for secure access. enum: - "8095" @@ -826,7 +826,7 @@ components: ResponseAll: title: Links - description: These properties are common to all links. + description: Properties common to all links. type: object discriminator: propertyName: type @@ -879,6 +879,7 @@ components: ResponseCouchbaseSpecific: title: Couchbase Specific Response + description: Properties specific to remote Couchbase links. type: object required: - activeHostname @@ -1051,6 +1052,7 @@ components: ResponseS3Specific: title: S3 Specific Response + description: Properties specific to S3 links. type: object required: - accessKeyId @@ -1101,6 +1103,7 @@ components: ResponseAzureBlobSpecific: title: Azure Blob Specific Response + description: Properties specific to Azure Blob links. type: object required: - endpoint @@ -1205,6 +1208,7 @@ components: ResponseGCSSpecific: title: GCS Specific Response + description: Properties specific to Google Cloud Storage links. type: object required: - applicationDefaultCredentials diff --git a/src/analytics-links/gradle.properties b/docs/modules/analytics-rest-links/gradle.properties similarity index 100% rename from src/analytics-links/gradle.properties rename to docs/modules/analytics-rest-links/gradle.properties diff --git a/docs/modules/analytics-rest-links/pages/index.adoc b/docs/modules/analytics-rest-links/pages/index.adoc index b66a75bc..ffbc8a7d 100644 --- a/docs/modules/analytics-rest-links/pages/index.adoc +++ b/docs/modules/analytics-rest-links/pages/index.adoc @@ -8,7 +8,7 @@ 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 +DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 @@ -32,7 +32,7 @@ This API enables you to manage the links to remote Couchbase clusters and extern [discrete#version] = Version information [%hardbreaks] -__Version__ : capella +__Version__ : 8.0 [discrete#host] = Host information @@ -58,29 +58,29 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* a| [markdown] -- -The host name or IP address of a node running the Analytics service. +The host name or IP address of a node running the Analytics Service. -- [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* a| [markdown] -- -The Analytics service REST port. Use `18095` for secure access. +The Analytics Service REST port. Use `18095` for secure access. -- [%hardbreaks] *Values:* `8095`, `18095` -*Example:* `pass:c[8095]` +*Example:* `+++8095+++` // end |=== @@ -113,9 +113,9 @@ ifeval::[{count-apis} > 1] The operations are grouped in the following categories. [%hardbreaks] -<> -<> -<> +xref:tag-LegacyMethods[] +xref:tag-MultipleLinks[] +xref:tag-SingleLinks[] endif::[] @@ -133,11 +133,13 @@ endif::[] endif::[] [%hardbreaks] -<> -<> -<> +xref:delete_alt[] +xref:post_alt[] +xref:put_alt[] +//tag::delete_alt[] + // markup not found, no include::{specDir}paths/delete_alt/operation-before.adoc[opts=optional] @@ -177,6 +179,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 +213,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 +230,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 +247,7 @@ The name of the link. [%hardbreaks] {blank} -a| String +a¦ String @@ -254,16 +265,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] @@ -291,7 +292,7 @@ a| [markdown] -- Bad request. A parameter has an incorrect value. -- -a| <> +a| xref:Wrong[] | 500 @@ -299,7 +300,7 @@ a| [markdown] -- Internal Server Error. Incorrect path or port number, incorrect credentials, badly formatted parameters, or missing arguments. -- -a| <> +a| xref:Wrong[] @@ -332,7 +333,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-analyticsManage[] |=== @@ -361,6 +362,10 @@ a| <> // markup not found, no include::{specDir}paths/delete_alt/operation-after.adoc[opts=optional] +//end::delete_alt[] + + +//tag::post_alt[] // markup not found, no include::{specDir}paths/post_alt/operation-before.adoc[opts=optional] @@ -400,6 +405,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 +439,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 +456,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 +473,13 @@ The name of the link. [%hardbreaks] {blank} -a| String +a¦ String -a| *type* + +a¦ *type* + _required_ -a| +a¦ [markdown] @@ -478,13 +492,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 +509,13 @@ For Couchbase links only. The remote hostname. [%hardbreaks] {blank} -a| String +a¦ String -a| *username* + +a¦ *username* + _optional_ -a| +a¦ [markdown] @@ -512,13 +526,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 +543,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 +561,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 +578,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 +595,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 +612,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 +629,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 +646,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 +663,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 +680,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 +697,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 +714,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 +731,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 +748,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 +765,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 +782,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 +799,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 +816,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 +833,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 +850,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 +867,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 +885,7 @@ For Google Cloud Storage links only. If present, indicates that the link should *Values:* `"true"` {blank} -a| String +a¦ String @@ -889,16 +903,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] @@ -926,7 +930,7 @@ a| [markdown] -- Bad request. A parameter has an incorrect value. -- -a| <> +a| xref:Wrong[] | 500 @@ -934,7 +938,7 @@ a| [markdown] -- Internal Server Error. Incorrect path or port number, incorrect credentials, badly formatted parameters, or missing arguments. -- -a| <> +a| xref:Wrong[] @@ -967,7 +971,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-analyticsManage[] |=== @@ -996,6 +1000,10 @@ a| <> // markup not found, no include::{specDir}paths/post_alt/operation-after.adoc[opts=optional] +//end::post_alt[] + + +//tag::put_alt[] // markup not found, no include::{specDir}paths/put_alt/operation-before.adoc[opts=optional] @@ -1036,6 +1044,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 +1078,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 +1095,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 +1112,13 @@ The name of the link. [%hardbreaks] {blank} -a| String +a¦ String -a| *type* + +a¦ *type* + _optional_ -a| +a¦ [markdown] @@ -1114,13 +1131,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 +1148,13 @@ For Couchbase links only. The remote hostname. [%hardbreaks] {blank} -a| String +a¦ String -a| *username* + +a¦ *username* + _optional_ -a| +a¦ [markdown] @@ -1148,13 +1165,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 +1182,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 +1200,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 +1217,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 +1234,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 +1251,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 +1268,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 +1285,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 +1302,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 +1319,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 +1336,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 +1353,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 +1370,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 +1387,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 +1404,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 +1421,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 +1438,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 +1455,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 +1472,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 +1489,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 +1506,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 +1524,7 @@ For Google Cloud Storage links only. If present, indicates that the link should *Values:* `"true"` {blank} -a| String +a¦ String @@ -1525,16 +1542,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] @@ -1562,7 +1569,7 @@ a| [markdown] -- Bad request. A parameter has an incorrect value. -- -a| <> +a| xref:Wrong[] | 500 @@ -1570,7 +1577,7 @@ a| [markdown] -- Internal Server Error. Incorrect path or port number, incorrect credentials, badly formatted parameters, or missing arguments. -- -a| <> +a| xref:Wrong[] @@ -1603,7 +1610,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-analyticsManage[] |=== @@ -1632,6 +1639,8 @@ a| <> // markup not found, no include::{specDir}paths/put_alt/operation-after.adoc[opts=optional] +//end::put_alt[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -1652,10 +1661,12 @@ endif::[] endif::[] [%hardbreaks] -<> -<> +xref:get_all[] +xref:get_scope[] +//tag::get_all[] + // markup not found, no include::{specDir}paths/get_all/operation-before.adoc[opts=optional] @@ -1693,6 +1704,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 +1733,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 +1755,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 +1775,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 +1794,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 +1814,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] @@ -1824,7 +1835,7 @@ a| [markdown] -- Success. Returns an array of objects, each of which contains information about a link. -- -a| <> +a| xref:ResponseAll[] array | 400 @@ -1832,7 +1843,7 @@ a| [markdown] -- Bad request. A parameter has an incorrect value. -- -a| <> +a| xref:Wrong[] | 500 @@ -1840,7 +1851,7 @@ a| [markdown] -- Internal Server Error. Incorrect path or port number, incorrect credentials, badly formatted parameters, or missing arguments. -- -a| <> +a| xref:Wrong[] @@ -1873,7 +1884,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-analyticsManage[] |=== @@ -1902,6 +1913,10 @@ include::{snippetDir}get_all/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_all/operation-after.adoc[opts=optional] +//end::get_all[] + + +//tag::get_scope[] // markup not found, no include::{specDir}paths/get_scope/operation-before.adoc[opts=optional] @@ -1940,6 +1955,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 +1983,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 +2003,7 @@ With this parameter, the scope name may contain one or two identifiers, separate [%hardbreaks] {blank} -a| String +a¦ String @@ -1992,13 +2013,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 +2032,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 +2052,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] @@ -2058,7 +2073,7 @@ a| [markdown] -- Success. Returns an array of objects, each of which contains information about a link. -- -a| <> +a| xref:ResponseAll[] array | 400 @@ -2066,7 +2081,7 @@ a| [markdown] -- Bad request. A parameter has an incorrect value. -- -a| <> +a| xref:Wrong[] | 500 @@ -2074,7 +2089,7 @@ a| [markdown] -- Internal Server Error. Incorrect path or port number, incorrect credentials, badly formatted parameters, or missing arguments. -- -a| <> +a| xref:Wrong[] @@ -2107,7 +2122,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-analyticsManage[] |=== @@ -2136,6 +2151,8 @@ include::{snippetDir}get_scope/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_scope/operation-after.adoc[opts=optional] +//end::get_scope[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -2156,12 +2173,14 @@ endif::[] endif::[] [%hardbreaks] -<> -<> -<> -<> +xref:delete_link[] +xref:get_link[] +xref:post_link[] +xref:put_link[] +//tag::delete_link[] + // markup not found, no include::{specDir}paths/delete_link/operation-before.adoc[opts=optional] @@ -2200,6 +2219,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 +2247,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 +2267,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 +2284,7 @@ The name of the link. [%hardbreaks] {blank} -a| String +a¦ String @@ -2280,12 +2305,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] @@ -2313,7 +2332,7 @@ a| [markdown] -- Bad request. A parameter has an incorrect value. -- -a| <> +a| xref:Wrong[] | 500 @@ -2321,7 +2340,7 @@ a| [markdown] -- Internal Server Error. Incorrect path or port number, incorrect credentials, badly formatted parameters, or missing arguments. -- -a| <> +a| xref:Wrong[] @@ -2354,7 +2373,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-analyticsManage[] |=== @@ -2383,6 +2402,10 @@ include::{snippetDir}delete_link/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/delete_link/operation-after.adoc[opts=optional] +//end::delete_link[] + + +//tag::get_link[] // markup not found, no include::{specDir}paths/get_link/operation-before.adoc[opts=optional] @@ -2421,6 +2444,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 +2472,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 +2492,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 +2509,7 @@ The name of the link. [%hardbreaks] {blank} -a| String +a¦ String @@ -2490,13 +2519,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 +2538,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 +2558,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] @@ -2556,7 +2579,7 @@ a| [markdown] -- Success. Returns an array of objects, each of which contains information about a link. -- -a| <> +a| xref:ResponseAll[] array | 400 @@ -2564,7 +2587,7 @@ a| [markdown] -- Bad request. A parameter has an incorrect value. -- -a| <> +a| xref:Wrong[] | 500 @@ -2572,7 +2595,7 @@ a| [markdown] -- Internal Server Error. Incorrect path or port number, incorrect credentials, badly formatted parameters, or missing arguments. -- -a| <> +a| xref:Wrong[] @@ -2605,7 +2628,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-analyticsManage[] |=== @@ -2634,6 +2657,10 @@ include::{snippetDir}get_link/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_link/operation-after.adoc[opts=optional] +//end::get_link[] + + +//tag::post_link[] // markup not found, no include::{specDir}paths/post_link/operation-before.adoc[opts=optional] @@ -2672,6 +2699,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 +2730,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 +2750,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 +2767,7 @@ The name of the link. [%hardbreaks] {blank} -a| String +a¦ String @@ -2743,13 +2779,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 +2798,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 +2815,13 @@ For Couchbase links only. The remote hostname. [%hardbreaks] {blank} -a| String +a¦ String -a| *username* + +a¦ *username* + _optional_ -a| +a¦ [markdown] @@ -2796,13 +2832,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 +2849,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 +2867,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 +2884,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 +2901,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 +2918,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 +2935,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 +2952,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 +2969,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 +2986,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 +3003,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 +3020,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 +3037,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 +3054,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 +3071,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 +3088,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 +3105,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 +3122,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 +3139,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 +3156,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 +3173,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 +3191,7 @@ For Google Cloud Storage links only. If present, indicates that the link should *Values:* `"true"` {blank} -a| String +a¦ String @@ -3173,16 +3209,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] @@ -3210,7 +3236,7 @@ a| [markdown] -- Bad request. A parameter has an incorrect value. -- -a| <> +a| xref:Wrong[] | 500 @@ -3218,7 +3244,7 @@ a| [markdown] -- Internal Server Error. Incorrect path or port number, incorrect credentials, badly formatted parameters, or missing arguments. -- -a| <> +a| xref:Wrong[] @@ -3251,7 +3277,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-analyticsManage[] |=== @@ -3280,6 +3306,10 @@ include::{snippetDir}post_link/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/post_link/operation-after.adoc[opts=optional] +//end::post_link[] + + +//tag::put_link[] // markup not found, no include::{specDir}paths/put_link/operation-before.adoc[opts=optional] @@ -3319,6 +3349,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 +3380,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 +3400,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 +3417,7 @@ The name of the link. [%hardbreaks] {blank} -a| String +a¦ String @@ -3390,13 +3429,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 +3448,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 +3465,13 @@ For Couchbase links only. The remote hostname. [%hardbreaks] {blank} -a| String +a¦ String -a| *username* + +a¦ *username* + _optional_ -a| +a¦ [markdown] @@ -3443,13 +3482,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 +3499,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 +3517,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 +3534,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 +3551,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 +3568,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 +3585,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 +3602,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 +3619,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 +3636,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 +3653,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 +3670,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 +3687,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 +3704,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 +3721,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 +3738,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 +3755,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 +3772,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 +3789,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 +3806,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 +3823,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 +3841,7 @@ For Google Cloud Storage links only. If present, indicates that the link should *Values:* `"true"` {blank} -a| String +a¦ String @@ -3820,16 +3859,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] @@ -3857,7 +3886,7 @@ a| [markdown] -- Bad request. A parameter has an incorrect value. -- -a| <> +a| xref:Wrong[] | 500 @@ -3865,7 +3894,7 @@ a| [markdown] -- Internal Server Error. Incorrect path or port number, incorrect credentials, badly formatted parameters, or missing arguments. -- -a| <> +a| xref:Wrong[] @@ -3898,7 +3927,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-analyticsManage[] |=== @@ -3927,6 +3956,8 @@ include::{snippetDir}put_link/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/put_link/operation-after.adoc[opts=optional] +//end::put_link[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -3964,23 +3995,23 @@ ifdef::collapse-models[] endif::collapse-models[] [%hardbreaks] ifdef::enum-definitions[] -<> +xref:CommonType[] endif::enum-definitions[] ifdef::enum-definitions[] -<> +xref:CommonTypeEdit[] endif::enum-definitions[] -<> -<> -<> -<> -<> -<> -<> -<> -<> -<> -<> -<> +xref:ResponseAll[] +xref:ResponseAzureBlob[] +xref:ResponseAzureBlobSpecific[] +xref:ResponseCouchbase[] +xref:ResponseCouchbaseSpecific[] +xref:ResponseCouchbaseSpecificNode[] +xref:ResponseCouchbaseSpecificNodeServices[] +xref:ResponseGCS[] +xref:ResponseGCSSpecific[] +xref:ResponseS3[] +xref:ResponseS3Specific[] +xref:Wrong[] endif::[] ifdef::enum-definitions[] @@ -4048,18 +4079,18 @@ endif::collapse-models[] ifdef::model-descriptions[] //tag::desc-ResponseAll[] -These properties are common to all links. +Properties 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 +4101,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 +4117,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 +4140,7 @@ The type of the link. [%hardbreaks] *Values:* `"couchbase"`, `"s3"`, `"azureblob"`, `"gcs"` {blank} -a| String +a¦ String |=== @@ -4124,19 +4155,19 @@ This schema has alternative properties, depending on the value of *type*: a| `azureblob` a| These properties are returned for Azure Blob links. -a| <> +a| xref:ResponseAzureBlob[] a| `couchbase` a| These properties are returned for remote Couchbase links. -a| <> +a| xref:ResponseCouchbase[] a| `gcs` a| These properties are returned for Google Cloud Storage links. -a| <> +a| xref:ResponseGCS[] a| `s3` a| These properties are returned for S3 links. -a| <> +a| xref:ResponseS3[] |=== @@ -4168,15 +4199,48 @@ endif::collapse-models[] .icon:bars[fw] Composite Schema {blank} -All of the following: +//tag::ResponseAzureBlob[] + +ifdef::model-descriptions[] +//tag::desc-ResponseAzureBlob[] +These properties are returned for Azure Blob links. +//end::desc-ResponseAzureBlob[] +endif::model-descriptions[] -* <> +[cols="25,55,20",separator=¦] +|=== +¦ All{nbsp}of{nbsp}... ¦ ¦ Schema +a¦ +a¦ -* <> +[markdown] +-- +include::index.adoc[tag=desc-ResponseAll, opts=optional] +-- +[%hardbreaks] +{blank} +a¦ xref:ResponseAll[] +a¦ _and_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-ResponseAzureBlobSpecific, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:ResponseAzureBlobSpecific[] + + +|=== + +//end::ResponseAzureBlob[] + // markup not found, no include::{specDir}definitions/ResponseAzureBlob/definition-end.adoc[opts=optional] @@ -4207,15 +4271,20 @@ endif::collapse-models[] //tag::ResponseAzureBlobSpecific[] +ifdef::model-descriptions[] +//tag::desc-ResponseAzureBlobSpecific[] +Properties specific to Azure Blob links. +//end::desc-ResponseAzureBlobSpecific[] +endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *accountKey* + _optional_ -a| +a¦ [markdown] -- @@ -4224,15 +4293,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 +4310,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 +4327,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 +4344,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 +4361,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 +4378,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 +4394,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 +4411,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 +4428,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 +4445,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 |=== @@ -4415,14 +4484,47 @@ endif::collapse-models[] .icon:bars[fw] Composite Schema {blank} -All of the following: +//tag::ResponseCouchbase[] + +ifdef::model-descriptions[] +//tag::desc-ResponseCouchbase[] +These properties are returned for remote Couchbase links. +//end::desc-ResponseCouchbase[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ All{nbsp}of{nbsp}... ¦ ¦ Schema + +a¦ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-ResponseAll, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:ResponseAll[] + + +a¦ _and_ +a¦ -* <> +[markdown] +-- +include::index.adoc[tag=desc-ResponseCouchbaseSpecific, opts=optional] +-- +[%hardbreaks] +{blank} +a¦ xref:ResponseCouchbaseSpecific[] -* <> +|=== +//end::ResponseCouchbase[] // markup not found, no include::{specDir}definitions/ResponseCouchbase/definition-end.adoc[opts=optional] @@ -4454,15 +4556,20 @@ endif::collapse-models[] //tag::ResponseCouchbaseSpecific[] +ifdef::model-descriptions[] +//tag::desc-ResponseCouchbaseSpecific[] +Properties specific to remote Couchbase links. +//end::desc-ResponseCouchbaseSpecific[] +endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *activeHostname* + _required_ -a| +a¦ [markdown] -- @@ -4470,15 +4577,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 +4595,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 +4609,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 +4627,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 +4643,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 +4659,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 +4675,13 @@ For internal use only. [%hardbreaks] *Example:* `393221` {blank} -a| Integer +a¦ Integer -a| [#encryption] +a¦ [#encryption] *encryption* + _required_ -a| +a¦ [markdown] -- @@ -4589,13 +4696,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 +4711,13 @@ An array of objects, each of which contains information about a node in the targ [%hardbreaks] {blank} -a| <> +a¦ xref:ResponseCouchbaseSpecificNode[] array -a| +a¦ *password* + _required_ -a| +a¦ [markdown] -- @@ -4619,15 +4726,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 +4743,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 +4759,9 @@ A UUID uniquely identifying the link. -- [%hardbreaks] -*Example:* `pass:c["6331e2a390125b662f7bcfd63ecb3a73"]` +*Example:* `+++"6331e2a390125b662f7bcfd63ecb3a73"+++` {blank} -a| UUID (UUID) +a¦ UUID (UUID) |=== @@ -4694,14 +4801,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 +4818,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 +4834,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 +4849,7 @@ include::index.adoc[tag=desc-ResponseCouchbaseSpecificNodeServices, opts=optiona [%hardbreaks] {blank} -a| <> +a¦ xref:ResponseCouchbaseSpecificNodeServices[] |=== @@ -4787,14 +4894,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 +4911,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 +4927,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 +4943,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 +4959,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 +4975,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 +4991,7 @@ The port number for an encrypted connection to the Cluster Manager service. [%hardbreaks] *Example:* `18091` {blank} -a| Integer +a¦ Integer |=== @@ -4921,15 +5028,48 @@ endif::collapse-models[] .icon:bars[fw] Composite Schema {blank} -All of the following: +//tag::ResponseGCS[] -* <> +ifdef::model-descriptions[] +//tag::desc-ResponseGCS[] +These properties are returned for Google Cloud Storage links. +//end::desc-ResponseGCS[] +endif::model-descriptions[] +[cols="25,55,20",separator=¦] +|=== +¦ All{nbsp}of{nbsp}... ¦ ¦ Schema + +a¦ +a¦ -* <> +[markdown] +-- +include::index.adoc[tag=desc-ResponseAll, opts=optional] +-- +[%hardbreaks] +{blank} +a¦ xref:ResponseAll[] +a¦ _and_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-ResponseGCSSpecific, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:ResponseGCSSpecific[] + + +|=== + +//end::ResponseGCS[] + // markup not found, no include::{specDir}definitions/ResponseGCS/definition-end.adoc[opts=optional] @@ -4960,15 +5100,20 @@ endif::collapse-models[] //tag::ResponseGCSSpecific[] +ifdef::model-descriptions[] +//tag::desc-ResponseGCSSpecific[] +Properties specific to Google Cloud Storage links. +//end::desc-ResponseGCSSpecific[] +endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *applicationDefaultCredentials* + _required_ -a| +a¦ [markdown] -- @@ -4978,15 +5123,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 +5140,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 +5157,9 @@ The JSON credentials of the link. If not set, this property returns `null`. -- [%hardbreaks] -*Example:* `pass:c[""]` +*Example:* `+++""+++` {blank} -a| String +a¦ String |=== @@ -5051,14 +5196,47 @@ endif::collapse-models[] .icon:bars[fw] Composite Schema {blank} -All of the following: +//tag::ResponseS3[] + +ifdef::model-descriptions[] +//tag::desc-ResponseS3[] +These properties are returned for S3 links. +//end::desc-ResponseS3[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ All{nbsp}of{nbsp}... ¦ ¦ Schema + +a¦ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-ResponseAll, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:ResponseAll[] + -* <> +a¦ _and_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-ResponseS3Specific, opts=optional] +-- +[%hardbreaks] +{blank} +a¦ xref:ResponseS3Specific[] -* <> +|=== +//end::ResponseS3[] // markup not found, no include::{specDir}definitions/ResponseS3/definition-end.adoc[opts=optional] @@ -5090,15 +5268,20 @@ endif::collapse-models[] //tag::ResponseS3Specific[] +ifdef::model-descriptions[] +//tag::desc-ResponseS3Specific[] +Properties specific to S3 links. +//end::desc-ResponseS3Specific[] +endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *accessKeyId* + _required_ -a| +a¦ [markdown] -- @@ -5106,15 +5289,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 +5305,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 +5322,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 +5339,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 +5356,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 +5398,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 +5414,7 @@ An error message. [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -5315,3 +5498,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/partials/security/document-begin.adoc b/docs/modules/analytics-rest-links/partials/security/document-begin.adoc index 9f28e161..3b730f23 100644 --- a/docs/modules/analytics-rest-links/partials/security/document-begin.adoc +++ b/docs/modules/analytics-rest-links/partials/security/document-begin.adoc @@ -1,2 +1,2 @@ The Analytics Links REST API supports HTTP basic authentication. -Credentials can be passed via HTTP headers. \ No newline at end of file +Pass your credentials through HTTP headers. \ No newline at end of file diff --git a/docs/modules/analytics-rest-links/partials/security/document-end.adoc b/docs/modules/analytics-rest-links/partials/security/document-end.adoc index 8911b27a..5330f469 100644 --- a/docs/modules/analytics-rest-links/partials/security/document-end.adoc +++ b/docs/modules/analytics-rest-links/partials/security/document-end.adoc @@ -1 +1 @@ -Refer to xref:learn:security/roles.adoc[] for more details. \ No newline at end of file +For more information, see xref:learn:security/roles.adoc[]. \ No newline at end of file diff --git a/src/analytics-service/analytics-service.gradle b/docs/modules/analytics-rest-service/analytics-service.gradle similarity index 85% rename from src/analytics-service/analytics-service.gradle rename to docs/modules/analytics-rest-service/analytics-service.gradle index 2ad5a3ac..31f779a7 100644 --- a/src/analytics-service/analytics-service.gradle +++ b/docs/modules/analytics-rest-service/analytics-service.gradle @@ -2,11 +2,11 @@ apply plugin: 'org.openapi.generator' openApiGenerate { generatorName = "asciidoc" - inputSpec = file("swagger/analytics-service.yaml").getAbsolutePath().toString() + inputSpec = file("attachments/_analytics-service.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/analytics-rest-service/pages" templateDir = "${rootDir}/templates" gitRepoId = "cb-swagger" - gitUserId = "couchbase" + gitUserId = "couchbaselabs" additionalProperties = [ specDir: "${rootDir}/docs/modules/analytics-rest-service/partials/", snippetDir: "${rootDir}/docs/modules/analytics-rest-service/partials/paths/", diff --git a/src/analytics-service/swagger/analytics-service.yaml b/docs/modules/analytics-rest-service/attachments/_analytics-service.yaml similarity index 97% rename from src/analytics-service/swagger/analytics-service.yaml rename to docs/modules/analytics-rest-service/attachments/_analytics-service.yaml index 0be29cca..2a7ea9bd 100644 --- a/src/analytics-service/swagger/analytics-service.yaml +++ b/docs/modules/analytics-rest-service/attachments/_analytics-service.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Analytics Service REST API - version: capella + version: "8.0" description: | The Analytics Service REST API is provided by the Analytics service. This API enables you to run Analytics queries and set request-level parameters. @@ -20,11 +20,11 @@ servers: - https host: default: localhost - description: The host name or IP address of a node running the Analytics service. + description: The host name or IP address of a node running the Analytics Service. port: default: "8095" description: |- - The Analytics service REST port. + The Analytics Service REST port. Use `18095` for secure access. enum: - "8095" @@ -132,6 +132,7 @@ components: # Use YAML anchors for properties which are also available as query parameters ParametersCommon: title: Common Parameters + description: Parameters common with the Query Service. type: object required: - statement @@ -204,12 +205,14 @@ components: description: An array of positional parameter values. items: {} additionalProperties: + x-additionalPropertiesName: '$identifier' description: A named parameter value. # For the Query Parameters page # Use YAML anchors for properties which are also available as query parameters ParametersLocal: title: Analytics Parameters + description: Parameters specific to the Analytics Service. type: object properties: plan-format: @@ -263,6 +266,7 @@ components: # For the Query Responses page ResponsesCommon: title: Common Responses + description: Responses common with the Query Service. type: object properties: requestID: @@ -328,6 +332,7 @@ components: # For the Query Responses page ResponsesLocal: title: Analytics Responses + description: Responses specific to the Analytics Service. type: object properties: plans: diff --git a/src/analytics-service/gradle.properties b/docs/modules/analytics-rest-service/gradle.properties similarity index 100% rename from src/analytics-service/gradle.properties rename to docs/modules/analytics-rest-service/gradle.properties diff --git a/docs/modules/analytics-rest-service/pages/index.adoc b/docs/modules/analytics-rest-service/pages/index.adoc index 4801f648..6fed3ddb 100644 --- a/docs/modules/analytics-rest-service/pages/index.adoc +++ b/docs/modules/analytics-rest-service/pages/index.adoc @@ -8,7 +8,7 @@ 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 +DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 @@ -33,7 +33,7 @@ This API enables you to run Analytics queries and set request-level parameters. [discrete#version] = Version information [%hardbreaks] -__Version__ : capella +__Version__ : 8.0 [discrete#host] = Host information @@ -59,29 +59,29 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* a| [markdown] -- -The host name or IP address of a node running the Analytics service. +The host name or IP address of a node running the Analytics Service. -- [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* a| [markdown] -- -The Analytics service REST port. Use `18095` for secure access. +The Analytics Service REST port. Use `18095` for secure access. -- [%hardbreaks] *Values:* `8095`, `18095` -*Example:* `pass:c[8095]` +*Example:* `+++8095+++` // end |=== @@ -114,7 +114,7 @@ ifeval::[{count-apis} > 1] The operations are grouped in the following categories. [%hardbreaks] -<> +xref:tag-Default[] endif::[] @@ -132,12 +132,14 @@ endif::[] endif::[] [%hardbreaks] -<> -<> -<> -<> +xref:get_query[] +xref:get_service[] +xref:post_query[] +xref:post_service[] +//tag::get_query[] + // markup not found, no include::{specDir}paths/get_query/operation-before.adoc[opts=optional] @@ -175,6 +177,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 +206,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 +223,7 @@ Specify the parameters in the query URL in URL-encoded format. [%hardbreaks] {blank} -a| <> +a¦ xref:Parameters[] @@ -235,12 +243,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] @@ -262,7 +264,7 @@ a| [markdown] -- The operation was successful. -- -a| <> +a| xref:Responses[] | 400 @@ -270,7 +272,7 @@ a| [markdown] -- Bad request. A parameter has an incorrect value. -- -a| <> +a| xref:Responses[] | 401 @@ -278,7 +280,7 @@ a| [markdown] -- Unauthorized. The user name or password may be incorrect. -- -a| <> +a| xref:Responses[] @@ -311,7 +313,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-analyticsManageAnalyticsSelect[] |=== @@ -340,6 +342,10 @@ a| <> // markup not found, no include::{specDir}paths/get_query/operation-after.adoc[opts=optional] +//end::get_query[] + + +//tag::get_service[] // markup not found, no include::{specDir}paths/get_service/operation-before.adoc[opts=optional] @@ -381,6 +387,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 +416,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 +433,7 @@ Specify the parameters in the query URL in URL-encoded format. [%hardbreaks] {blank} -a| <> +a¦ xref:Parameters[] @@ -441,12 +453,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] @@ -468,7 +474,7 @@ a| [markdown] -- The operation was successful. -- -a| <> +a| xref:Responses[] | 400 @@ -476,7 +482,7 @@ a| [markdown] -- Bad request. A parameter has an incorrect value. -- -a| <> +a| xref:Responses[] | 401 @@ -484,7 +490,7 @@ a| [markdown] -- Unauthorized. The user name or password may be incorrect. -- -a| <> +a| xref:Responses[] @@ -517,7 +523,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-analyticsManageAnalyticsSelect[] |=== @@ -546,6 +552,10 @@ include::{snippetDir}get_service/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_service/operation-after.adoc[opts=optional] +//end::get_service[] + + +//tag::post_query[] // markup not found, no include::{specDir}paths/post_query/operation-before.adoc[opts=optional] @@ -584,6 +594,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 +630,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 +647,7 @@ An object specifying one or more query parameters. [%hardbreaks] {blank} -a| <> +a¦ xref:Parameters[] @@ -644,17 +664,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] @@ -676,7 +685,7 @@ a| [markdown] -- The operation was successful. -- -a| <> +a| xref:Responses[] | 400 @@ -684,7 +693,7 @@ a| [markdown] -- Bad request. A parameter has an incorrect value. -- -a| <> +a| xref:Responses[] | 401 @@ -692,7 +701,7 @@ a| [markdown] -- Unauthorized. The user name or password may be incorrect. -- -a| <> +a| xref:Responses[] @@ -735,6 +744,10 @@ a| <> // markup not found, no include::{specDir}paths/post_query/operation-after.adoc[opts=optional] +//end::post_query[] + + +//tag::post_service[] // markup not found, no include::{specDir}paths/post_service/operation-before.adoc[opts=optional] @@ -774,6 +787,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 +823,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 +840,7 @@ An object specifying one or more query parameters. [%hardbreaks] {blank} -a| <> +a¦ xref:Parameters[] @@ -834,17 +857,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] @@ -866,7 +878,7 @@ a| [markdown] -- The operation was successful. -- -a| <> +a| xref:Responses[] | 400 @@ -874,7 +886,7 @@ a| [markdown] -- Bad request. A parameter has an incorrect value. -- -a| <> +a| xref:Responses[] | 401 @@ -882,7 +894,7 @@ a| [markdown] -- Unauthorized. The user name or password may be incorrect. -- -a| <> +a| xref:Responses[] @@ -915,7 +927,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-analyticsManageAnalyticsSelect[] |=== @@ -944,6 +956,8 @@ include::{snippetDir}post_service/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/post_service/operation-after.adoc[opts=optional] +//end::post_service[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -980,17 +994,17 @@ ifdef::collapse-models[] [.two-columns] endif::collapse-models[] [%hardbreaks] -<> -<> -<> -<> -<> -<> -<> -<> -<> -<> -<> +xref:Parameters[] +xref:ParametersCommon[] +xref:ParametersLocal[] +xref:Responses[] +xref:ResponsesCommon[] +xref:ResponsesCommonErrors[] +xref:ResponsesCommonWarnings[] +xref:ResponsesCommonYardsticks[] +xref:ResponsesLocal[] +xref:ResponsesLocalPlans[] +xref:ResponsesLocalYardsticks[] endif::[] @@ -1012,14 +1026,42 @@ endif::collapse-models[] .icon:bars[fw] Composite Schema {blank} -All of the following: +//tag::Parameters[] + + +[cols="25,55,20",separator=¦] +|=== +¦ All{nbsp}of{nbsp}... ¦ ¦ Schema + +a¦ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-ParametersCommon, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:ParametersCommon[] + -* <> +a¦ _and_ +a¦ +[markdown] +-- +include::index.adoc[tag=desc-ParametersLocal, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:ParametersLocal[] -* <> +|=== +//end::Parameters[] // markup not found, no include::{specDir}definitions/Parameters/definition-end.adoc[opts=optional] @@ -1051,15 +1093,20 @@ endif::collapse-models[] //tag::ParametersCommon[] +ifdef::model-descriptions[] +//tag::desc-ParametersCommon[] +Parameters common with the Query Service. +//end::desc-ParametersCommon[] +endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *statement* + _required_ -a| +a¦ [markdown] -- @@ -1068,13 +1115,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 +1131,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 +1149,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 +1167,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 +1182,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 +1200,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 +1216,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 +1233,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 +1250,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 +1267,14 @@ An array of positional parameter values. [%hardbreaks] {blank} -a| Any Type +a¦ Any Type array -a| +a¦ +*<$identifier>* + _additional + property_ -a| +a¦ [markdown] -- @@ -1235,7 +1283,7 @@ A named parameter value. [%hardbreaks] {blank} -a| Any Type +a¦ Any Type |=== @@ -1274,15 +1322,20 @@ endif::collapse-models[] //tag::ParametersLocal[] +ifdef::model-descriptions[] +//tag::desc-ParametersLocal[] +Parameters specific to the Analytics Service. +//end::desc-ParametersLocal[] +endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *plan-format* + _optional_ -a| +a¦ [markdown] -- @@ -1291,15 +1344,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 +1362,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 +1378,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 +1394,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 +1410,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 +1426,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 +1442,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) |=== @@ -1426,14 +1479,42 @@ endif::collapse-models[] .icon:bars[fw] Composite Schema {blank} -All of the following: +//tag::Responses[] + + +[cols="25,55,20",separator=¦] +|=== +¦ All{nbsp}of{nbsp}... ¦ ¦ Schema + +a¦ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-ResponsesCommon, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:ResponsesCommon[] + -* <> +a¦ _and_ +a¦ +[markdown] +-- +include::index.adoc[tag=desc-ResponsesLocal, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:ResponsesLocal[] -* <> +|=== +//end::Responses[] // markup not found, no include::{specDir}definitions/Responses/definition-end.adoc[opts=optional] @@ -1465,15 +1546,20 @@ endif::collapse-models[] //tag::ResponsesCommon[] +ifdef::model-descriptions[] +//tag::desc-ResponsesCommon[] +Responses common with the Query Service. +//end::desc-ResponsesCommon[] +endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *requestID* + _optional_ -a| +a¦ [markdown] -- @@ -1482,13 +1568,13 @@ A unique identifier for the response. [%hardbreaks] {blank} -a| UUID (UUID) +a¦ UUID (UUID) -a| +a¦ *clientContextID* + _optional_ -a| +a¦ [markdown] -- @@ -1504,13 +1590,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 +1606,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 +1622,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 +1638,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 +1654,13 @@ An array of error objects. Present only if 1 or more errors are returned during [%hardbreaks] {blank} -a| <> +a¦ xref:ResponsesCommonErrors[] array -a| +a¦ *warnings* + _optional_ -a| +a¦ [markdown] -- @@ -1595,13 +1681,13 @@ By default, no warnings are returned, even if warnings have occurred during proc [%hardbreaks] {blank} -a| <> +a¦ xref:ResponsesCommonWarnings[] array -a| +a¦ *metrics* + _optional_ -a| +a¦ [markdown] -- @@ -1610,7 +1696,7 @@ include::index.adoc[tag=desc-ResponsesCommonYardsticks, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ xref:ResponsesCommonYardsticks[] |=== @@ -1650,14 +1736,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 +1752,13 @@ A number that identifies the error. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *msg* + _optional_ -a| +a¦ [markdown] -- @@ -1682,7 +1768,7 @@ A message describing the error in detail. Refer to [Error Codes](/cloud/analytic [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -1722,14 +1808,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 +1824,13 @@ A number that identifies the warning. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *msg* + _optional_ -a| +a¦ [markdown] -- @@ -1753,7 +1839,7 @@ A message describing the warning in detail. [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -1798,14 +1884,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 +1901,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 +1917,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 +1932,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 +1947,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 +1962,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 +1977,7 @@ The number of warnings that occurred during the request. [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) |=== @@ -1930,15 +2016,20 @@ endif::collapse-models[] //tag::ResponsesLocal[] +ifdef::model-descriptions[] +//tag::desc-ResponsesLocal[] +Responses specific to the Analytics Service. +//end::desc-ResponsesLocal[] +endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *plans* + _optional_ -a| +a¦ [markdown] -- @@ -1947,13 +2038,13 @@ include::index.adoc[tag=desc-ResponsesLocalPlans, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ xref:ResponsesLocalPlans[] -a| +a¦ *metrics* + _optional_ -a| +a¦ [markdown] -- @@ -1962,7 +2053,7 @@ include::index.adoc[tag=desc-ResponsesLocalYardsticks, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ xref:ResponsesLocalYardsticks[] |=== @@ -2007,14 +2098,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 +2114,13 @@ The logical plan. [%hardbreaks] {blank} -a| Object +a¦ Object -a| +a¦ *optimizedLogicalPlan* + _optional_ -a| +a¦ [markdown] -- @@ -2038,13 +2129,13 @@ The optimized logical plan. [%hardbreaks] {blank} -a| Object +a¦ Object -a| +a¦ *rewrittenExpressionTree* + _optional_ -a| +a¦ [markdown] -- @@ -2053,13 +2144,13 @@ The rewritten expression tree. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *expressionTree* + _optional_ -a| +a¦ [markdown] -- @@ -2068,13 +2159,13 @@ The expression tree. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *job* + _optional_ -a| +a¦ [markdown] -- @@ -2083,7 +2174,7 @@ The job details. [%hardbreaks] {blank} -a| Object +a¦ Object |=== @@ -2128,14 +2219,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 +2235,7 @@ Number of processed tuples during query execution. [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) |=== @@ -2231,3 +2322,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/partials/security/document-begin.adoc b/docs/modules/analytics-rest-service/partials/security/document-begin.adoc index 69660b1b..fe93a428 100644 --- a/docs/modules/analytics-rest-service/partials/security/document-begin.adoc +++ b/docs/modules/analytics-rest-service/partials/security/document-begin.adoc @@ -1,2 +1,2 @@ The Analytics Service REST API supports HTTP basic authentication. -Credentials can be passed via HTTP headers. \ No newline at end of file +Pass your credentials through HTTP headers. \ No newline at end of file diff --git a/docs/modules/analytics-rest-service/partials/security/document-end.adoc b/docs/modules/analytics-rest-service/partials/security/document-end.adoc index 8911b27a..5330f469 100644 --- a/docs/modules/analytics-rest-service/partials/security/document-end.adoc +++ b/docs/modules/analytics-rest-service/partials/security/document-end.adoc @@ -1 +1 @@ -Refer to xref:learn:security/roles.adoc[] for more details. \ No newline at end of file +For more information, see xref:learn:security/roles.adoc[]. \ No newline at end of file diff --git a/src/analytics-settings/analytics-settings.gradle b/docs/modules/analytics-rest-settings/analytics-settings.gradle similarity index 85% rename from src/analytics-settings/analytics-settings.gradle rename to docs/modules/analytics-rest-settings/analytics-settings.gradle index 338f827a..1708f3db 100644 --- a/src/analytics-settings/analytics-settings.gradle +++ b/docs/modules/analytics-rest-settings/analytics-settings.gradle @@ -2,11 +2,11 @@ apply plugin: 'org.openapi.generator' openApiGenerate { generatorName = "asciidoc" - inputSpec = file("swagger/analytics-settings.yaml").getAbsolutePath().toString() + inputSpec = file("attachments/_analytics-settings.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/analytics-rest-settings/pages" templateDir = "${rootDir}/templates" gitRepoId = "cb-swagger" - gitUserId = "couchbase" + gitUserId = "couchbaselabs" additionalProperties = [ specDir: "${rootDir}/docs/modules/analytics-rest-settings/partials/", snippetDir: "${rootDir}/docs/modules/analytics-rest-settings/partials/paths/", diff --git a/src/analytics-settings/swagger/analytics-settings.yaml b/docs/modules/analytics-rest-settings/attachments/_analytics-settings.yaml similarity index 98% rename from src/analytics-settings/swagger/analytics-settings.yaml rename to docs/modules/analytics-rest-settings/attachments/_analytics-settings.yaml index b1d2b812..56b9786a 100644 --- a/src/analytics-settings/swagger/analytics-settings.yaml +++ b/docs/modules/analytics-rest-settings/attachments/_analytics-settings.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Analytics Settings REST API - version: capella + version: "8.0" description: | The Analytics Settings REST API is provided by the Analytics service. This API enables you to view or set cluster-level Analytics settings. @@ -20,7 +20,7 @@ servers: - https host: default: localhost - description: The host name or IP address of a node running the Analytics service. + description: The host name or IP address of a node running the Analytics Service. port: default: "8091" description: |- diff --git a/src/analytics-settings/gradle.properties b/docs/modules/analytics-rest-settings/gradle.properties similarity index 100% rename from src/analytics-settings/gradle.properties rename to docs/modules/analytics-rest-settings/gradle.properties diff --git a/docs/modules/analytics-rest-settings/pages/index.adoc b/docs/modules/analytics-rest-settings/pages/index.adoc index 9afcc159..52052bb2 100644 --- a/docs/modules/analytics-rest-settings/pages/index.adoc +++ b/docs/modules/analytics-rest-settings/pages/index.adoc @@ -8,7 +8,7 @@ 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 +DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 @@ -33,7 +33,7 @@ This API enables you to view or set cluster-level Analytics settings. [discrete#version] = Version information [%hardbreaks] -__Version__ : capella +__Version__ : 8.0 [discrete#host] = Host information @@ -59,18 +59,18 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* a| [markdown] -- -The host name or IP address of a node running the Analytics service. +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 |=== @@ -114,7 +114,7 @@ ifeval::[{count-apis} > 1] The operations are grouped in the following categories. [%hardbreaks] -<> +xref:tag-Default[] endif::[] @@ -132,10 +132,12 @@ endif::[] endif::[] [%hardbreaks] -<> -<> +xref:get_settings[] +xref:post_settings[] +//tag::get_settings[] + // markup not found, no include::{specDir}paths/get_settings/operation-before.adoc[opts=optional] @@ -174,6 +176,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 +199,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] @@ -218,7 +220,7 @@ a| [markdown] -- The operation was successful. -- -a| <> +a| xref:Settings[] | 401 @@ -259,7 +261,7 @@ a| Object | Type | Name | http (basic) -| <> +| xref:security-clusterReadPoolsRead[] |=== @@ -288,6 +290,10 @@ include::{snippetDir}get_settings/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_settings/operation-after.adoc[opts=optional] +//end::get_settings[] + + +//tag::post_settings[] // markup not found, no include::{specDir}paths/post_settings/operation-before.adoc[opts=optional] @@ -327,6 +333,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 +367,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 +386,7 @@ Specifies the number of replicas for Analytics. *Maximum:* `3` {blank} -a| Integer +a¦ Integer @@ -389,16 +404,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] @@ -420,7 +425,7 @@ a| [markdown] -- The operation was successful. -- -a| <> +a| xref:Settings[] | 400 @@ -469,7 +474,7 @@ a| Object | Type | Name | http (basic) -| <> +| xref:security-clusterReadPoolsRead[] |=== @@ -498,6 +503,8 @@ include::{snippetDir}post_settings/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/post_settings/operation-after.adoc[opts=optional] +//end::post_settings[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -534,7 +541,7 @@ ifdef::collapse-models[] [.two-columns] endif::collapse-models[] [%hardbreaks] -<> +xref:Settings[] endif::[] @@ -559,14 +566,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 +585,7 @@ Specifies the number of replicas for Analytics. *Maximum:* `3` *Example:* `3` {blank} -a| Integer +a¦ Integer |=== @@ -663,3 +670,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/partials/security/document-begin.adoc b/docs/modules/analytics-rest-settings/partials/security/document-begin.adoc index 0dc3c444..6961216f 100644 --- a/docs/modules/analytics-rest-settings/partials/security/document-begin.adoc +++ b/docs/modules/analytics-rest-settings/partials/security/document-begin.adoc @@ -1,2 +1,2 @@ The Analytics Settings REST API supports HTTP basic authentication. -Credentials can be passed via HTTP headers. \ No newline at end of file +Pass your credentials through HTTP headers. \ No newline at end of file diff --git a/docs/modules/analytics-rest-settings/partials/security/document-end.adoc b/docs/modules/analytics-rest-settings/partials/security/document-end.adoc index 8911b27a..5330f469 100644 --- a/docs/modules/analytics-rest-settings/partials/security/document-end.adoc +++ b/docs/modules/analytics-rest-settings/partials/security/document-end.adoc @@ -1 +1 @@ -Refer to xref:learn:security/roles.adoc[] for more details. \ No newline at end of file +For more information, see xref:learn:security/roles.adoc[]. \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/attachments/_eventing.yaml b/docs/modules/eventing-rest-api/attachments/_eventing.yaml new file mode 100644 index 00000000..ea36b404 --- /dev/null +++ b/docs/modules/eventing-rest-api/attachments/_eventing.yaml @@ -0,0 +1,1003 @@ +openapi: 3.0.3 +info: + title: Eventing REST API + version: '8.0' + 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: + parameters: + - name: bucket + schema: + type: string + in: query + required: false + description: |- + For scoped configuration settings only. + The bucket to which the configuration settings apply. + - name: scope + schema: + type: string + in: query + required: false + description: |- + For scoped configuration settings only. + The scope to which the configuration settings apply. + get: + operationId: config_get + summary: List Service Config + description: |- + Shows all service configuration settings. + + In Couchbase Server 8.0 and later, you can list service configuration settings globally, or at the function scope level. + When you list settings at the function scope level, the settings apply only to functions within that function scope. + Some service configuration settings are only available globally. + + Service configuration settings at the function scope level take precedence over global service configuration settings. + If a setting is not specified at the function scope level, the Eventing service checks at the bucket level, and then falls back to the global level. + + You can also see the current values of the `enable_debugger` and `ram_quota` settings via the UI. + tags: + - service config + security: + - Global: [] + - Scoped: [] + responses: + "200": + description: Returns an object showing the service configuration settings. + content: + application/json: + schema: + $ref: "#/components/schemas/UnivConfig" + "404": + $ref: '#/components/responses/Goof' + post: + operationId: config_update + summary: Modify Service Config + description: |- + Modify service 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. + + In Couchbase Server 8.0 and later, you can modify service configuration settings globally, or at the function scope level. + When you modify settings at the function scope level, the settings apply only to functions within that function scope. + Some service configuration settings are only available globally. + + Service configuration settings at the function scope level take precedence over global service configuration settings. + If a setting is not specified at the function scope level, the Eventing service checks at the bucket level, and then falls back to the global level. + + You can also modify the `enable_debugger` and `ram_quota` settings via the UI. + tags: + - service config + requestBody: + required: true + description: An object providing the service configuration settings. + content: + application/json: + schema: + $ref: "#/components/schemas/UnivConfig" + security: + - Global: [] + - Scoped: [] + 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: Service 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. + + This setting is only available globally. + enable_curl: + type: boolean + description: |- + Enables the Eventing curl function. + For details, see [cURL](/cloud/eventing/eventing-curl-spec.html). + + This setting is available globally or at the function scope level. + enable_debugger: + type: boolean + default: false + x-has-default: true + description: |- + Enables the Eventing service debugger. + For details, see [Debugging and Diagnosability](/cloud/eventing/eventing-debugging-and-diagnosability.html). + + This setting is available globally or at the function scope level. + cursor_limit: + type: integer + default: 5 + maximum: 20 + minimum: 1 + x-has-default: true + description: |- + The maximum number of cursor-aware Eventing functions that can coexist on a given source keyspace. + (A cursor-aware Eventing function is one for which the `cursor_aware` setting is `true`.) + + Increasing this setting enables more cursor-aware Eventing functions to register and listen to any given collection. + + Decreasing this setting prevents further cursor-aware Eventing functions from being registered on any given collection; however, it doesn't unregister already registered cursor-aware Eventing functions. + + This setting is only available globally. + num_nodes_running: + type: integer + example: 3 + x-has-example: true + x-desc-status: Couchbase Server 8.0 + description: |- + The number of Eventing nodes on which the functions in scope execute. + + By default, all Eventing functions run on all Eventing nodes. + If this setting is specified, the Evening Service attempts to run the functions in scope on the specified number of nodes. + If fewer nodes are available, the functions run on all available nodes. + + This setting is available globally or at the function scope level. + responses: + OK: + description: Success. + + Goof: + description: Failure. + + securitySchemes: + Global: + type: http + scheme: basic + description: |- + Global functions and service configuration settings 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 and service configuration settings, 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 and service configuration settings, 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/docs/modules/eventing-rest-api/attachments/_overlay.json b/docs/modules/eventing-rest-api/attachments/_overlay.json new file mode 100644 index 00000000..9075e57d --- /dev/null +++ b/docs/modules/eventing-rest-api/attachments/_overlay.json @@ -0,0 +1,33 @@ +{ + "overlay": "1.0.0", + "info": { + "title": "Overlay for Eventing Settings Schema", + "version": 1.0 + }, + "actions": [ + { + "target": "components.schemas.handler_schema", + "update": { + "description": "An object which defines a function." + } + }, + { + "target": "components.schemas.settings_schema.properties.allow_sync_documents", + "update": { + "description": "Specifies whether the function allows Sync Gateway mutations.\n\n* By default, this setting is `true`, for compatibility with previous versions of Couchbase Server.\n\n* When this setting is `false`, the specified function skips all internal Sync Gateway documents, whose IDs are prefixed with `_sync`.\nThis enables the function to work with Sync Gateway.\n\nYou must ensure that none of the documents which contain your own working data have IDs which are prefixed with `_sync`.\n(Note that internal Sync Gateway attachment documents, whose IDs are prefixed with `_sync:att`, are still processed by the specified function.)" + } + }, + { + "target": "components.schemas.settings_schema.properties.cursor_aware", + "update": { + "description": "Specifies whether the function suppresses potential duplicate mutations caused by App Services or Sync Gateway book-keeping.\n\nEnabling this setting guarantees that the Eventing function will only trigger once for any given mutation received from App Services or Sync Gateway.\n\nNote that enabling this setting may have a noticeable impact on the performance of the Eventing function." + } + }, + { + "target": "components.schemas.settings_schema.properties.cursor_checkpoint_timeout", + "update": { + "description": "The maximum time the checkpoint writer can run before it is forcefully terminated (in seconds)." + } + } + ] +} \ No newline at end of file diff --git a/docs/modules/eventing-rest-api/eventing.gradle b/docs/modules/eventing-rest-api/eventing.gradle new file mode 100644 index 00000000..2af99636 --- /dev/null +++ b/docs/modules/eventing-rest-api/eventing.gradle @@ -0,0 +1,58 @@ +plugins { + id("io.datapith.jayOverlay").version("0.1.11") +} + +jayOverlay { + targetFile.set("${projectDir}/build/bundle/eventing.yaml") + overlayFile.set("${projectDir}/attachments/_overlay.json") + outputDir.set("${projectDir}/build/overlay") +} + +apply plugin: 'org.openapi.generator' + +task bundleSpec(type: org.openapitools.generator.gradle.plugin.tasks.GenerateTask) { + generatorName = "openapi-yaml" + inputSpec = file("attachments/_eventing.yaml").getAbsolutePath().toString() + outputDir = "${projectDir}/build/bundle" + globalProperties = [ + generateAliasAsModel: "true" + ] + additionalProperties = [ + outputFile: "eventing.yaml", + ] + generateAliasAsModel = true +} + +openApiGenerate { + generatorName = "asciidoc" + inputSpec = file("build/overlay/eventing.yaml").getAbsolutePath().toString() + outputDir = "${rootDir}/docs/modules/eventing-rest-api/pages" + templateDir = "${rootDir}/templates" + gitRepoId = "cb-swagger" + gitUserId = "couchbaselabs" + 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" + ] +} + +tasks.applyOverlay.dependsOn(bundleSpec) +tasks.openApiGenerate.dependsOn(applyOverlay) 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..c2698b89 --- /dev/null +++ b/docs/modules/eventing-rest-api/pages/index.adoc @@ -0,0 +1,8990 @@ += 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/couchbaselabs/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__ : 8.0 + +[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] +xref:tag-Activation[] +xref:tag-Advanced[] +xref:tag-List[] +xref:tag-Logging[] +xref:tag-ServiceConfig[] +xref:tag-Statistics[] +xref:tag-Status[] +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Activation] += Activation +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:basic_deploy[] +xref:basic_pause[] +xref:basic_resume[] +xref:basic_undeploy[] + + +//tag::basic_deploy[] + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::basic_deploy[] + + +//tag::basic_pause[] + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::basic_pause[] + + +//tag::basic_resume[] + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::basic_resume[] + + +//tag::basic_undeploy[] + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::basic_undeploy[] + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Advanced] += Advanced +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:adv_function_import[] +xref:adv_function_import_all[] +xref:adv_function_view[] +xref:adv_function_view_all[] +xref:adv_function_zap[] +xref:adv_function_zap_all[] +xref:adv_multiple_export[] +xref:adv_multiple_import[] +xref:adv_settings_get[] +xref:adv_settings_update[] +xref:adv_structure_get[] +xref:adv_structure_update[] +xref:adv_text_get[] +xref:adv_text_update[] + + +//tag::adv_function_import[] + + +// markup not found, no include::{specDir}paths/adv_function_import/operation-before.adoc[opts=optional] + + +[#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¦ xref:AddFunction[] + + + +|=== + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::adv_function_import[] + + +//tag::adv_function_import_all[] + + +// markup not found, no include::{specDir}paths/adv_function_import_all/operation-before.adoc[opts=optional] + + +[#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¦ xref:AddFunctions[] + + + +|=== + + +// 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) +| xref:security-unscoped[] + +|=== + + +// 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] + + +//end::adv_function_import_all[] + + +//tag::adv_function_view[] + + +// 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| xref:handler_schema[] + + +| 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::adv_function_view[] + + +//tag::adv_function_view_all[] + + +// markup not found, no include::{specDir}paths/adv_function_view_all/operation-before.adoc[opts=optional] + + +[#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| xref:handler_schema[] + 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) +| xref:security-unscoped[] + +|=== + + +// 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] + + +//end::adv_function_view_all[] + + +//tag::adv_function_zap[] + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::adv_function_zap[] + + +//tag::adv_function_zap_all[] + + +// markup not found, no include::{specDir}paths/adv_function_zap_all/operation-before.adoc[opts=optional] + + +[#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) +| xref:security-unscoped[] + +|=== + + +// 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] + + +//end::adv_function_zap_all[] + + +//tag::adv_multiple_export[] + + +// 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| xref:handler_schema[] + 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) +| xref:security-unscoped[] + +|=== + + +// 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] + + +//end::adv_multiple_export[] + + +//tag::adv_multiple_import[] + + +// 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¦ xref:AddFunctions[] + + + +|=== + + +// 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) +| xref:security-unscoped[] + +|=== + + +// 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] + + +//end::adv_multiple_import[] + + +//tag::adv_settings_get[] + + +// 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| xref:settings_schema[] + + +| 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::adv_settings_get[] + + +//tag::adv_settings_update[] + + +// 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¦ xref:Function Settings[] + + + +|=== + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::adv_settings_update[] + + +//tag::adv_structure_get[] + + +// 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| xref:depcfg_schema[] + + +| 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::adv_structure_get[] + + +//tag::adv_structure_update[] + + +// 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¦ xref:Deployment Config[] + + + +|=== + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::adv_structure_update[] + + +//tag::adv_text_get[] + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::adv_text_get[] + + +//tag::adv_text_update[] + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::adv_text_update[] + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-List] += List +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:list_all[] +xref:list_query[] + + +//tag::list_all[] + + +// markup not found, no include::{specDir}paths/list_all/operation-before.adoc[opts=optional] + + +[#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) +| xref:security-unscoped[] + +|=== + + +// 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] + + +//end::list_all[] + + +//tag::list_query[] + + +// 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) +| xref:security-unscoped[] + +|=== + + +// 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] + + +//end::list_query[] + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Logging] += Logging +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:log_view[] + + +//tag::log_view[] + + +// markup not found, no include::{specDir}paths/log_view/operation-before.adoc[opts=optional] + + +[#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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::log_view[] + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-ServiceConfig] += Service Config +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:config_get[] +xref:config_update[] + + +//tag::config_get[] + + +// markup not found, no include::{specDir}paths/config_get/operation-before.adoc[opts=optional] + + +[#config_get] += List Service 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 service configuration settings. + +In Couchbase Server 8.0 and later, you can list service configuration settings globally, or at the function scope level. +When you list settings at the function scope level, the settings apply only to functions within that function scope. +Some service configuration settings are only available globally. + +Service configuration settings at the function scope level take precedence over global service configuration settings. +If a setting is not specified at the function scope level, the Eventing service checks at the bucket level, and then falls back to the global level. + +You can also see the current values of the `enable_debugger` and `ram_quota` settings via the UI. +-- + + +// markup not found, no include::{specDir}paths/config_get/operation-description-end.adoc[opts=optional] + + + +[#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] + + +[#config_get-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/config_get/operation-parameters-begin.adoc[opts=optional] + + + +[#config_get-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped configuration settings only. +The bucket to which the configuration settings apply. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped configuration settings only. +The scope to which the configuration settings apply. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + +// markup not found, no include::{specDir}paths/config_get/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/config_get/operation-parameters-after.adoc[opts=optional] + + + +// 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 service configuration settings. +-- +a| xref:UnivConfig[] + + +| 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::config_get[] + + +//tag::config_update[] + + +// markup not found, no include::{specDir}paths/config_update/operation-before.adoc[opts=optional] + + +[#config_update] += Modify Service Config + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/config_update/operation-begin.adoc[opts=optional] + + +.... +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 service 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. + +In Couchbase Server 8.0 and later, you can modify service configuration settings globally, or at the function scope level. +When you modify settings at the function scope level, the settings apply only to functions within that function scope. +Some service configuration settings are only available globally. + +Service configuration settings at the function scope level take precedence over global service configuration settings. +If a setting is not specified at the function scope level, the Eventing service checks at the bucket level, and then falls back to the global level. + +You can also modify the `enable_debugger` and `ram_quota` settings via the UI. +-- + + +// markup not found, no include::{specDir}paths/config_update/operation-description-end.adoc[opts=optional] + + +[#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-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *bucket* + +_optional_ +a¦ + + +[markdown] +-- +For scoped configuration settings only. +The bucket to which the configuration settings apply. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *scope* + +_optional_ +a¦ + + +[markdown] +-- +For scoped configuration settings only. +The scope to which the configuration settings apply. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + +[#config_update-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_required_ +a¦ + + +[markdown] +-- +An object providing the service configuration settings. +-- + +[%hardbreaks] +{blank} + +a¦ xref:UnivConfig[] + + + +|=== + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::config_update[] + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Statistics] += Statistics +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:stats_all[] +xref:stats_execution[] +xref:stats_failure[] +xref:stats_latency[] +xref:stats_reset[] + + +//tag::stats_all[] + + +// 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) +| xref:security-unscoped[] + +|=== + + +// 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] + + +//end::stats_all[] + + +//tag::stats_execution[] + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::stats_execution[] + + +//tag::stats_failure[] + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::stats_failure[] + + +//tag::stats_latency[] + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::stats_latency[] + + +//tag::stats_reset[] + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::stats_reset[] + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Status] += Status +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:status_all[] +xref:status_function[] + + +//tag::status_all[] + + +// markup not found, no include::{specDir}paths/status_all/operation-before.adoc[opts=optional] + + +[#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) +| xref:security-unscoped[] + +|=== + + +// 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] + + +//end::status_all[] + + +//tag::status_function[] + + +// 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) +| xref:security-scoped[] +| http (basic) +| xref:security-global[] + +|=== + + +// 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] + + +//end::status_function[] + + +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] +xref:AddFunction[] +xref:AddFunctions[] +xref:depcfg_schema[] +xref:depcfg_schema_constants_inner[] +xref:depcfg_schema_buckets_inner[] +xref:depcfg_schema_curl_inner[] +xref:handler_schema[] +xref:function_scope_schema[] +xref:settings_schema[] +xref:UnivConfig[] +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} + +//tag::AddFunction[] + + +[cols="25,55,20",separator=¦] +|=== +¦ One{nbsp}of{nbsp}... ¦ ¦ Schema + +a¦ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-handler_schema, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:handler_schema[] + + +a¦ _or_ +a¦ + +[markdown] +-- +An array containing a single function definition object. +-- + +[%hardbreaks] +*Minimum items:* `1` +*Maximum items:* `1` +{blank} +a¦ xref:handler_schema[] + array + +|=== + +//end::AddFunction[] + + +// 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} + +//tag::AddFunctions[] + + +[cols="25,55,20",separator=¦] +|=== +¦ One{nbsp}of{nbsp}... ¦ ¦ Schema + +a¦ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-handler_schema, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:handler_schema[] + + +a¦ _or_ +a¦ + +[markdown] +-- +An array containing one or more function definition objects. +-- + +[%hardbreaks] +*Minimum items:* `1` +{blank} +a¦ xref:handler_schema[] + array + +|=== + +//end::AddFunctions[] + + +// 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¦ xref:depcfg_schema_buckets_inner[] + array + +a¦ +*curl* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ xref:depcfg_schema_curl_inner[] + array + +a¦ +*metadata_bucket* + +_required_ +a¦ + +[markdown] +-- +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¦ xref:depcfg_schema_constants_inner[] + 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[] + +ifdef::model-descriptions[] +//tag::desc-handler_schema[] +An object which defines a function. +//end::desc-handler_schema[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*appcode* + +_required_ +a¦ + +[markdown] +-- +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¦ xref:depcfg_schema[] + + +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¦ xref:settings_schema[] + + +a¦ +*function_scope* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-function_scope_schema, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:function_scope_schema[] + + +|=== + +//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¦ +*cursor_checkpoint_timeout* + +_optional_ +a¦ + +[markdown] +-- +The maximum time the checkpoint writer 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] +-- +Specifies whether the function allows Sync Gateway mutations. + +* By default, this setting is `true`, for compatibility with previous versions of Couchbase Server. + +* When this setting is `false`, the specified function skips all internal Sync Gateway documents, whose IDs are prefixed with `_sync`. +This enables the function to work with Sync Gateway. + +You must ensure that none of the documents which contain your own working data have IDs which are prefixed with `_sync`. +(Note that internal Sync Gateway attachment documents, whose IDs are prefixed with `_sync:att`, are still processed by the specified function.) +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*cursor_aware* + +_optional_ +a¦ + +[markdown] +-- +Specifies whether the function suppresses potential duplicate mutations caused by App Services or Sync Gateway book-keeping. + +Enabling this setting guarantees that the Eventing function will only trigger once for any given mutation received from App Services or Sync Gateway. + +Note that enabling this setting may have a noticeable impact on the performance of the Eventing 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] += Service 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. + +This setting is only available globally. +-- + +[%hardbreaks] +*Default:* `256` +*Example:* `512` +{blank} +a¦ Integer + + +a¦ +*enable_curl* + +_optional_ +a¦ + +[markdown] +-- +Enables the Eventing curl function. +For details, see [cURL](/cloud/eventing/eventing-curl-spec.html). + +This setting is available globally or at the function scope level. +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*enable_debugger* + +_optional_ +a¦ + +[markdown] +-- +Enables the Eventing service debugger. +For details, see [Debugging and Diagnosability](/cloud/eventing/eventing-debugging-and-diagnosability.html). + +This setting is available globally or at the function scope level. +-- + +[%hardbreaks] +*Default:* `false` +{blank} +a¦ Boolean + + +a¦ +*cursor_limit* + +_optional_ +a¦ + +[markdown] +-- +The maximum number of cursor-aware Eventing functions that can coexist on a given source keyspace. +(A cursor-aware Eventing function is one for which the `cursor_aware` setting is `true`.) + +Increasing this setting enables more cursor-aware Eventing functions to register and listen to any given collection. + +Decreasing this setting prevents further cursor-aware Eventing functions from being registered on any given collection; however, it doesn't unregister already registered cursor-aware Eventing functions. + +This setting is only available globally. +-- + +[%hardbreaks] +*Default:* `5` +*Minimum:* `1` +*Maximum:* `20` +{blank} +a¦ Integer + + +a¦ +*num_nodes_running* + +_optional_ +a¦ [.status]##Couchbase Server 8.0## + +[markdown] +-- +The number of Eventing nodes on which the functions in scope execute. + +By default, all Eventing functions run on all Eventing nodes. +If this setting is specified, the Evening Service attempts to run the functions in scope on the specified number of nodes. +If fewer nodes are available, the functions run on all available nodes. + +This setting is available globally or at the function scope level. +-- + +[%hardbreaks] +*Example:* `3` +{blank} +a¦ Integer + + +|=== + +//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 and service configuration settings 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 and service configuration settings, 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 and service configuration settings, 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..33290405 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/header-attributes.adoc @@ -0,0 +1,4 @@ +:page-meta-robots: noindex +:page-embargo: EMBARGOED +: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..eb90389b --- /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..a6eff959 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/adv_settings_update/http-request.adoc @@ -0,0 +1,197 @@ += 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" +---- +==== + +[#ex-sync-gateway-global] +.Enable Sync Gateway compatibility for a global function +==== +This example sets `allow_sync_documents` to `false`, to enable compatibility with Sync Gateway. +The function is currently paused. + +.Curl request +[source,sh] +---- +curl -XPOST -d '{ + "deployment_status": true, + "processing_status": false, + "allow_sync_documents": false +}' "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings" +---- + +For details, see xref:sync-gateway::server-compatibility-eventing.adoc[]. +==== + +[#ex-sync-gateway-scoped] +.Enable Sync Gateway compatibility for a scoped function +==== +This example sets `allow_sync_documents` to `false`, to enable compatibility with Sync Gateway. +The function is currently paused. + +.Curl request +[source,sh] +---- +curl -XPOST -d '{ + "deployment_status": true, + "processing_status": false, + "allow_sync_documents": false +}' "http://$USER:$PASSWORD@$HOST:8096/api/v1/functions/my_function/settings?bucket=bulk&scope=data" +---- + +For details, see xref:sync-gateway::server-compatibility-eventing.adoc[]. +==== + +.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..d1843786 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/config_get/http-request.adoc @@ -0,0 +1,19 @@ += Example HTTP Requests + +.View global service configuration settings +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/config" +---- +==== + +.View scoped service configuration settings +==== +.Curl request +[source,sh] +---- +curl -XGET "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/config?bucket=bulk&scope=data" +---- +==== 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..03764422 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/config_update/http-request.adoc @@ -0,0 +1,68 @@ += 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}' +---- +==== + +.Set cursor limit +==== +.Curl request +[source,sh] +---- +curl -XPOST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/config" \ + -d '{"cursor_limit": 10}' +---- +==== + +.Set service configuration settings for a scope +==== +This example specifies that 3 Eventing nodes should run the functions in this scope. +If fewer than 3 nodes are available, the functions will run on all Eventing nodes. + +.Curl request +[source,sh] +---- +curl -XPOST "http://$ADMIN:$PASSWORD@$HOST:8096/api/v1/config?bucket=bulk&scope=data" \ + -d '{"num_nodes_running": 3}' +---- +==== + +.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..3c7f3971 --- /dev/null +++ b/docs/modules/eventing-rest-api/partials/paths/config_update/operation-description-after.adoc @@ -0,0 +1,10 @@ +[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. + +You can only enable or disable interbucket recursion globally, not for specified function scopes. +==== \ 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..c004fd5b --- /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. +Pass your credentials through 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/fts-rest-advanced/examples/get-partition.json b/docs/modules/fts-rest-advanced/examples/get-partition.json new file mode 100644 index 00000000..0a8048ed --- /dev/null +++ b/docs/modules/fts-rest-advanced/examples/get-partition.json @@ -0,0 +1,18 @@ +{ + "pindexes": { + "myFirstIndex_6cc599ab7a85bf3b_0": { + "indexName": "myFirstIndex", + "indexParams": "", + "indexType": "blackhole", + "indexUUID": "6cc599ab7a85bf3b", + "name": "myFirstIndex_6cc599ab7a85bf3b_0", + "sourceName": "", + "sourceParams": "", + "sourcePartitions": "", + "sourceType": "nil", + "sourceUUID": "", + "uuid": "2d9ecb8b574a9f6a" + } + }, + "status": "ok" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-advanced/pages/index.adoc b/docs/modules/fts-rest-advanced/pages/index.adoc new file mode 100644 index 00000000..795f34eb --- /dev/null +++ b/docs/modules/fts-rest-advanced/pages/index.adoc @@ -0,0 +1,2050 @@ += Couchbase Search Advanced 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/cbft + +: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 Advanced Search REST APIs are provided by the Search service. +These APIs enable you to manage and query Search index partitions and to specify advanced settings. +-- + +[discrete#version] += Version information +[%hardbreaks] +__Version__ : 8.0 + +[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 Search Service. +-- + +[%hardbreaks] + +*Example:* `+++localhost+++` +// end + +a| *port* +a| [markdown] +-- +The Search Service REST port. Use `18094` for secure access. +-- + +[%hardbreaks] +*Values:* `8094`, `18094` +*Example:* `+++8094+++` +// end + +|=== + + +// markup not found, no 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: 3 + +: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] +xref:tag-Definition[] +xref:tag-Query[] +xref:tag-Quota[] +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Definition] += Definition +:leveloffset: +1 + +ifeval::["Operations for Search index partition definition." != ""] +Operations for Search index partition definition. +endif::[] +ifeval::["Operations for Search index partition definition." == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:getPartition[] +xref:getPartitionName[] + + +//tag::getPartition[] + + +// markup not found, no include::{specDir}paths/getPartition/operation-before.adoc[opts=optional] + + +[#getPartition] += Get Index Partition Information + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getPartition/operation-begin.adoc[opts=optional] + + +.... +GET /api/pindex +.... + + + +// markup not found, no include::{specDir}paths/getPartition/operation-description-before.adoc[opts=optional] + + +[#getPartition-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getPartition/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Get information about a Search index partition. +-- + + +// markup not found, no include::{specDir}paths/getPartition/operation-description-end.adoc[opts=optional] + + + +[#getPartition-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getPartition/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getPartition/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/getPartition/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getPartition/operation-responses-before.adoc[opts=optional] + + +[#getPartition-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getPartition/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing the Search index partition information. +-- +a| xref:indexPartition[] + + + +|=== + + +// markup not found, no include::{specDir}paths/getPartition/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/getPartition/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getPartition/operation-security-before.adoc[opts=optional] + + +[#getPartition-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getPartition/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-read[] + +|=== + + +// markup not found, no include::{specDir}paths/getPartition/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getPartition/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}getPartition/http-request.adoc[opts=optional] + + +include::{snippetDir}getPartition/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getPartition/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getPartition/operation-after.adoc[opts=optional] + + +//end::getPartition[] + + +//tag::getPartitionName[] + + +// markup not found, no include::{specDir}paths/getPartitionName/operation-before.adoc[opts=optional] + + +[#getPartitionName] += Get Index Partition by Name + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getPartitionName/operation-begin.adoc[opts=optional] + + +.... +GET /api/pindex/{pindexName} +.... + + + +// markup not found, no include::{specDir}paths/getPartitionName/operation-description-before.adoc[opts=optional] + + +[#getPartitionName-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getPartitionName/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Get information about a specific Search index partition by name. +-- + + +// markup not found, no include::{specDir}paths/getPartitionName/operation-description-end.adoc[opts=optional] + + + + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getPartitionName/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getPartitionName/operation-parameters-before.adoc[opts=optional] + + +[#getPartitionName-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getPartitionName/operation-parameters-begin.adoc[opts=optional] + + +[#getPartitionName-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *pindexName* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index partition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/getPartitionName/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/getPartitionName/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getPartitionName/operation-responses-before.adoc[opts=optional] + + +[#getPartitionName-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getPartitionName/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/getPartitionName/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/getPartitionName/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getPartitionName/operation-security-before.adoc[opts=optional] + + +[#getPartitionName-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getPartitionName/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-read[] + +|=== + + +// markup not found, no include::{specDir}paths/getPartitionName/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getPartitionName/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}getPartitionName/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}getPartitionName/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getPartitionName/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getPartitionName/operation-after.adoc[opts=optional] + + +//end::getPartitionName[] + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Query] += Query +:leveloffset: +1 + +ifeval::["Operations for querying Search index partitions." != ""] +Operations for querying Search index partitions. +endif::[] +ifeval::["Operations for querying Search index partitions." == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:getPartitionCount[] +xref:queryPartition[] + + +//tag::getPartitionCount[] + + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-before.adoc[opts=optional] + + +[#getPartitionCount] += Get Index Partition Document Count + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-begin.adoc[opts=optional] + + +.... +GET /api/pindex/{pindexName}/count +.... + + + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-description-before.adoc[opts=optional] + + +[#getPartitionCount-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Get the document count of a specific Search index partition. +-- + + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-description-end.adoc[opts=optional] + + + +[#getPartitionCount-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-parameters-before.adoc[opts=optional] + + +[#getPartitionCount-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-parameters-begin.adoc[opts=optional] + + +[#getPartitionCount-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *pindexName* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index partition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-responses-before.adoc[opts=optional] + + +[#getPartitionCount-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The Search Service returns a response that includes the status `ok`. +-- +a| xref:DocumentCount[] + + + +|=== + + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-security-before.adoc[opts=optional] + + +[#getPartitionCount-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-read[] + +|=== + + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}getPartitionCount/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}getPartitionCount/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getPartitionCount/operation-after.adoc[opts=optional] + + +//end::getPartitionCount[] + + +//tag::queryPartition[] + + +// markup not found, no include::{specDir}paths/queryPartition/operation-before.adoc[opts=optional] + + +[#queryPartition] += Query Index Partition + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/queryPartition/operation-begin.adoc[opts=optional] + + +.... +POST /api/pindex/{pindexName}/query +.... + + + +// markup not found, no include::{specDir}paths/queryPartition/operation-description-before.adoc[opts=optional] + + +[#queryPartition-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/queryPartition/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Execute a query against a specific Search index partition by name. +-- + + +// markup not found, no include::{specDir}paths/queryPartition/operation-description-end.adoc[opts=optional] + + +[#queryPartition-consumes] +.Consumes +* application/json + +[#queryPartition-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/queryPartition/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/queryPartition/operation-parameters-before.adoc[opts=optional] + + +[#queryPartition-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/queryPartition/operation-parameters-begin.adoc[opts=optional] + + +[#queryPartition-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *pindexName* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index partition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + +[#queryPartition-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_required_ +a¦ + + +[markdown] +-- +A JSON object to define the settings for your Search query. For more information about how to create a Search query JSON object, see [Search Request JSON Properties](../search/search-request-params.html). +-- + +[%hardbreaks] +{blank} + +a¦ xref:QueryRequest[] + + + +|=== + + +// markup not found, no include::{specDir}paths/queryPartition/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/queryPartition/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/queryPartition/operation-responses-before.adoc[opts=optional] + + +[#queryPartition-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/queryPartition/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The response object has a status section that must be checked for every request. Under nearly all circumstances, the query response will be HTTP 200 even though individual index shards (partitions) may encounter a timeout or return an error. +-- +a| xref:QueryResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/queryPartition/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/queryPartition/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/queryPartition/operation-security-before.adoc[opts=optional] + + +[#queryPartition-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/queryPartition/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-write[] + +|=== + + +// markup not found, no include::{specDir}paths/queryPartition/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/queryPartition/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}queryPartition/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}queryPartition/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/queryPartition/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/queryPartition/operation-after.adoc[opts=optional] + + +//end::queryPartition[] + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Quota] += Quota +:leveloffset: +1 + +ifeval::["Operations for managing Search memory quota." != ""] +Operations for managing Search memory quota. +endif::[] +ifeval::["Operations for managing Search memory quota." == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:setFtsMemoryQuota[] + + +//tag::setFtsMemoryQuota[] + + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-before.adoc[opts=optional] + + +[#setFtsMemoryQuota] += Set Search Memory Quota + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-begin.adoc[opts=optional] + + +.... +POST /pools/default +.... + + + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-description-before.adoc[opts=optional] + + +[#setFtsMemoryQuota-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Sets the memory quota for the Search Service. +-- + + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-description-end.adoc[opts=optional] + + +[#setFtsMemoryQuota-consumes] +.Consumes +* application/x-www-form-urlencoded + + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-parameters-before.adoc[opts=optional] + + +[#setFtsMemoryQuota-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-parameters-begin.adoc[opts=optional] + + + + + +[#setFtsMemoryQuota-form] +.Form Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *ftsMemoryQuota* + +_optional_ +a¦ + + +[markdown] +-- +The memory quota for the Search service. +-- + +[%hardbreaks] +{blank} + +a¦ Integer + + + +|=== + + + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-responses-before.adoc[opts=optional] + + +[#setFtsMemoryQuota-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Memory quota set. +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-security-before.adoc[opts=optional] + + +[#setFtsMemoryQuota-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-manage[] + +|=== + + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}setFtsMemoryQuota/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}setFtsMemoryQuota/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/setFtsMemoryQuota/operation-after.adoc[opts=optional] + + +//end::setFtsMemoryQuota[] + + +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: 6 + +: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] +xref:DocumentCount[] +xref:indexPartition[] +xref:indexPartitionPIndex[] +xref:indexPartitionPIndexInner[] +xref:QueryRequest[] +xref:QueryResponse[] +endif::[] + + + +// markup not found, no include::{specDir}definitions/DocumentCount/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#DocumentCount] += Document Count + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/DocumentCount/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::DocumentCount[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the operation. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*count* + +_optional_ +a¦ + +[markdown] +-- +The document count for the specified index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +|=== + +//end::DocumentCount[] + + + + +// markup not found, no include::{specDir}definitions/DocumentCount/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/DocumentCount/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/indexPartition/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#indexPartition] += Index Partitions + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/indexPartition/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::indexPartition[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*pindexes* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-indexPartitionPIndex, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:indexPartitionPIndex[] + + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the request. +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::indexPartition[] + + + + +// markup not found, no include::{specDir}definitions/indexPartition/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/indexPartition/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/indexPartitionPIndex/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#indexPartitionPIndex] += Index Partitions Wrapper + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/indexPartitionPIndex/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::indexPartitionPIndex[] + +ifdef::model-descriptions[] +//tag::desc-indexPartitionPIndex[] +An object containing information about 1 or more Search index partitions. +//end::desc-indexPartitionPIndex[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ + +_additional + +property_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-indexPartitionPIndexInner, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:indexPartitionPIndexInner[] + + +|=== + +//end::indexPartitionPIndex[] + + + + +// markup not found, no include::{specDir}definitions/indexPartitionPIndex/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/indexPartitionPIndex/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/indexPartitionPIndexInner/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#indexPartitionPIndexInner] += Index Partition + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/indexPartitionPIndexInner/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::indexPartitionPIndexInner[] + +ifdef::model-descriptions[] +//tag::desc-indexPartitionPIndexInner[] +An object containing information about a single Search index partition. +The name of the property is the name of the Search index partition. +//end::desc-indexPartitionPIndexInner[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*indexName* + +_optional_ +a¦ + +[markdown] +-- +The name of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*indexParams* + +_optional_ +a¦ + +[markdown] +-- +The Search index's type identifier, type mappings, and analyzers. +For more information, see [Params Object](../search/search-index-params.html#params). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*indexType* + +_optional_ +a¦ + +[markdown] +-- +The type of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*indexUUID* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*name* + +_optional_ +a¦ + +[markdown] +-- +The name of the Search index partition. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceName* + +_optional_ +a¦ + +[markdown] +-- +The name of the bucket where the Search index is stored. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceParams* + +_optional_ +a¦ + +[markdown] +-- +Advanced settings for Search index behavior. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*sourcePartitions* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceType* + +_optional_ +a¦ + +[markdown] +-- +The type of the bucket where the Search index is stored. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceUUID* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the bucket where the Search index is stored. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*uuid* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the Search index partition. +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::indexPartitionPIndexInner[] + + + + +// markup not found, no include::{specDir}definitions/indexPartitionPIndexInner/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/indexPartitionPIndexInner/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/QueryRequest/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#QueryRequest] += Query Request + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/QueryRequest/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::QueryRequest[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*query* + +_optional_ +a¦ + +[markdown] +-- +An object that contains the properties for one of the supported query types. +For more information, see [Query Object](../search/search-request-params.html#query-object). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*knn* + +_optional_ +a¦ + +[markdown] +-- +An array that contains objects that describe a Vector Search query. +For more information, see [Knn Objects](../search/search-request-params.html#knn-object). +-- + +[%hardbreaks] +{blank} +a¦ Object + array + +a¦ +*ctl* + +_optional_ +a¦ + +[markdown] +-- +An object that contains properties for query consistency. +For more information, see [Ctl Object](../search/search-request-params.html#ctl). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*size* + +_optional_ +a¦ + +[markdown] +-- +Set the total number of results to return for a single page of search results. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*from* + +_optional_ +a¦ + +[markdown] +-- +Set an offset value to change where pagination starts for search results. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*highlight* + +_optional_ +a¦ + +[markdown] +-- +Contains properties to control search result highlighting. +For more information, see [Highlight Objects](../search/search-request-params.html#highlight). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*fields* + +_optional_ +a¦ + +[markdown] +-- +An array of strings to specify each indexed field you want to return in search results. +-- + +[%hardbreaks] +{blank} +a¦ String + array + +a¦ +*facets* + +_optional_ +a¦ + +[markdown] +-- +Contains nested objects to define each facet you want to return with search results. +For more information, see [Facet Objects](../search/search-request-params.html#facet-name). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*explain* + +_optional_ +a¦ + +[markdown] +-- +Whether to create an explanation for a search result's score in search results. +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*sort* + +_optional_ +a¦ + +[markdown] +-- +Contains an array of strings or JSON objects to set how to sort search results. +For more information, see [Sort Object](../search/search-request-params.html#sort). +-- + +[%hardbreaks] +{blank} +a¦ Any Type + array + +a¦ +*includeLocations* + +_optional_ +a¦ + +[markdown] +-- +Whether to return the position of each occurrence of a search term inside a document. +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*score* + +_optional_ +a¦ + +[markdown] +-- +Whether to include document relevancy scoring in search results. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*search_after* + +_optional_ +a¦ + +[markdown] +-- +Use to control pagination in search results. +-- + +[%hardbreaks] +{blank} +a¦ String + array + +a¦ +*search_before* + +_optional_ +a¦ + +[markdown] +-- +Use to control pagination in search results. +-- + +[%hardbreaks] +{blank} +a¦ String + array + +a¦ +*collections* + +_optional_ +a¦ + +[markdown] +-- +An array of strings that specify the collections where you want to run the query. +-- + +[%hardbreaks] +{blank} +a¦ String + array + +|=== + +//end::QueryRequest[] + + + + +// markup not found, no include::{specDir}definitions/QueryRequest/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/QueryRequest/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/QueryResponse/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#QueryResponse] += Query Response + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/QueryResponse/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::QueryResponse[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the operation. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*results* + +_optional_ +a¦ + +[markdown] +-- +The results of the Search query. +-- + +[%hardbreaks] +{blank} +a¦ Object + array + +|=== + +//end::QueryResponse[] + + + + +// markup not found, no include::{specDir}definitions/QueryResponse/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/QueryResponse/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/Manage/security-scheme-before.adoc[opts=optional] + + +[[security-manage]] += Manage + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Manage/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +You must have the **Search Admin** role, with FTS Manage permissions on the required bucket. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/Manage/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/Manage/security-scheme-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}security/Read/security-scheme-before.adoc[opts=optional] + + +[[security-read]] += Read + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Read/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +You must have the **Search Reader** or **Search Admin** role, with FTS Read permissions on the required bucket. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/Read/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/Read/security-scheme-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}security/Write/security-scheme-before.adoc[opts=optional] + + +[[security-write]] += Write + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Write/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +You must have the **Search Admin** role, with FTS Write permissions on the required bucket. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/Write/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/Write/security-scheme-after.adoc[opts=optional] + + + + +include::{specDir}security/document-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] + + diff --git a/docs/modules/fts-rest-advanced/partials/header-attributes.adoc b/docs/modules/fts-rest-advanced/partials/header-attributes.adoc new file mode 100644 index 00000000..abe379c2 --- /dev/null +++ b/docs/modules/fts-rest-advanced/partials/header-attributes.adoc @@ -0,0 +1,6 @@ +:page-meta-robots: noindex +:page-embargo: EMBARGOED +:page-partial: +:!example-caption: +:description: The Search Advanced REST APIs are provided by the Search Service. \ +These APIs enable you to manage and monitor advanced settings of your Search indexes. diff --git a/docs/modules/fts-rest-advanced/partials/overview/document-before.adoc b/docs/modules/fts-rest-advanced/partials/overview/document-before.adoc new file mode 100644 index 00000000..1fb78375 --- /dev/null +++ b/docs/modules/fts-rest-advanced/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/fts-rest-advanced/partials/paths/getPartition/http-response.adoc b/docs/modules/fts-rest-advanced/partials/paths/getPartition/http-response.adoc new file mode 100644 index 00000000..a43e0469 --- /dev/null +++ b/docs/modules/fts-rest-advanced/partials/paths/getPartition/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$get-partition.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-advanced/partials/security/document-begin.adoc b/docs/modules/fts-rest-advanced/partials/security/document-begin.adoc new file mode 100644 index 00000000..753b6c55 --- /dev/null +++ b/docs/modules/fts-rest-advanced/partials/security/document-begin.adoc @@ -0,0 +1,2 @@ +The Search REST APIs support HTTP basic authentication. +Pass your credentials through HTTP headers. \ No newline at end of file diff --git a/docs/modules/fts-rest-advanced/partials/security/document-end.adoc b/docs/modules/fts-rest-advanced/partials/security/document-end.adoc new file mode 100644 index 00000000..5330f469 --- /dev/null +++ b/docs/modules/fts-rest-advanced/partials/security/document-end.adoc @@ -0,0 +1 @@ +For more information, see xref:learn:security/roles.adoc[]. \ No newline at end of file diff --git a/docs/modules/fts-rest-advanced/search-advanced.gradle b/docs/modules/fts-rest-advanced/search-advanced.gradle new file mode 100644 index 00000000..ba93d58f --- /dev/null +++ b/docs/modules/fts-rest-advanced/search-advanced.gradle @@ -0,0 +1,23 @@ +apply plugin: 'org.openapi.generator' + +openApiGenerate { + generatorName = "asciidoc" + remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/morpheus/docs/spec/advanced/advanced.yaml" + outputDir = "${rootDir}/docs/modules/fts-rest-advanced/pages" + templateDir = "${rootDir}/templates" + gitRepoId = "cbft" + gitUserId = "couchbase" + additionalProperties = [ + specDir: "${rootDir}/docs/modules/fts-rest-advanced/partials/", + snippetDir: "${rootDir}/docs/modules/fts-rest-advanced/partials/paths/", + headerAttributes: "true", + useIntroduction: "true", + useTableTitles: "true", + skipExamples: "true", + legacyDiscriminatorBehavior: "true" + ] + globalProperties = [ + generateAliasAsModel: "true" + ] + generateAliasAsModel = true +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/d-api-index-name-200.json b/docs/modules/fts-rest-indexing/examples/d-api-index-name-200.json new file mode 100644 index 00000000..a6baa02d --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/d-api-index-name-200.json @@ -0,0 +1,4 @@ +{ + "status": "ok", + "uuid": "123294e5a4efbe39" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/d-api-index-name-default.json b/docs/modules/fts-rest-indexing/examples/d-api-index-name-default.json new file mode 100644 index 00000000..9a10b7f9 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/d-api-index-name-default.json @@ -0,0 +1,5 @@ +{ + "error": "rest_auth: preparePerms, err: index not found", + "request": "", + "status": "fail" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/d-api-scoped-index-name-200.json b/docs/modules/fts-rest-indexing/examples/d-api-scoped-index-name-200.json new file mode 100644 index 00000000..052dc44f --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/d-api-scoped-index-name-200.json @@ -0,0 +1,4 @@ +{ + "status": "ok", + "uuid": "687be6a2ad647c34" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/d-api-scoped-index-name-default.json b/docs/modules/fts-rest-indexing/examples/d-api-scoped-index-name-default.json new file mode 100644 index 00000000..9a10b7f9 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/d-api-scoped-index-name-default.json @@ -0,0 +1,5 @@ +{ + "error": "rest_auth: preparePerms, err: index not found", + "request": "", + "status": "fail" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/fts-sample-index-def-response.json b/docs/modules/fts-rest-indexing/examples/fts-sample-index-def-response.json new file mode 100644 index 00000000..c6960632 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/fts-sample-index-def-response.json @@ -0,0 +1,167 @@ +{ + "status": "ok", + "indexDef": { + "type": "fulltext-index", + "name": "color-test", + "uuid": "6ea521a918bd3837", + "sourceType": "gocbcore", + "sourceName": "vector-sample", + "sourceUUID": "614177a67bdfbd2823c5f9c3e62f5991", + "planParams": { + "maxPartitionsPerPIndex": 1024, + "indexPartitions": 1 + }, + "params": { + "doc_config": { + "docid_prefix_delim": "", + "docid_regexp": "", + "mode": "scope.collection.type_field", + "type_field": "type" + }, + "mapping": { + "analysis": {}, + "default_analyzer": "standard", + "default_datetime_parser": "dateTimeOptional", + "default_field": "_all", + "default_mapping": { + "dynamic": false, + "enabled": false + }, + "default_type": "_default", + "docvalues_dynamic": false, + "index_dynamic": false, + "store_dynamic": false, + "type_field": "_type", + "types": { + "color.rgb": { + "dynamic": false, + "enabled": true, + "properties": { + "color": { + "dynamic": false, + "enabled": true, + "fields": [ + { + "analyzer": "en", + "docvalues": true, + "include_in_all": true, + "include_term_vectors": true, + "index": true, + "name": "color", + "store": true, + "type": "text" + } + ] + }, + "colorvect_dot": { + "dynamic": false, + "enabled": true, + "fields": [ + { + "dims": 3, + "index": true, + "name": "colorvect_dot", + "similarity": "dot_product", + "type": "vector", + "vector_index_optimized_for": "recall" + } + ] + } + } + } + } + }, + "store": { + "indexType": "scorch", + "segmentVersion": 16 + } + }, + "sourceParams": {} + }, + "planPIndexes": [ + { + "name": "vector-sample.color.color-test_6ea521a918bd3837_4c1c5584", + "uuid": "1543820346544e08", + "indexType": "fulltext-index", + "indexName": "vector-sample.color.color-test", + "indexUUID": "6ea521a918bd3837", + "sourceType": "gocbcore", + "sourceName": "vector-sample", + "sourceUUID": "614177a67bdfbd2823c5f9c3e62f5991", + "sourcePartitions": "0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128,129,130,131,132,133,134,135,136,137,138,139,140,141,142,143,144,145,146,147,148,149,150,151,152,153,154,155,156,157,158,159,160,161,162,163,164,165,166,167,168,169,170,171,172,173,174,175,176,177,178,179,180,181,182,183,184,185,186,187,188,189,190,191,192,193,194,195,196,197,198,199,200,201,202,203,204,205,206,207,208,209,210,211,212,213,214,215,216,217,218,219,220,221,222,223,224,225,226,227,228,229,230,231,232,233,234,235,236,237,238,239,240,241,242,243,244,245,246,247,248,249,250,251,252,253,254,255,256,257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,275,276,277,278,279,280,281,282,283,284,285,286,287,288,289,290,291,292,293,294,295,296,297,298,299,300,301,302,303,304,305,306,307,308,309,310,311,312,313,314,315,316,317,318,319,320,321,322,323,324,325,326,327,328,329,330,331,332,333,334,335,336,337,338,339,340,341,342,343,344,345,346,347,348,349,350,351,352,353,354,355,356,357,358,359,360,361,362,363,364,365,366,367,368,369,370,371,372,373,374,375,376,377,378,379,380,381,382,383,384,385,386,387,388,389,390,391,392,393,394,395,396,397,398,399,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,419,420,421,422,423,424,425,426,427,428,429,430,431,432,433,434,435,436,437,438,439,440,441,442,443,444,445,446,447,448,449,450,451,452,453,454,455,456,457,458,459,460,461,462,463,464,465,466,467,468,469,470,471,472,473,474,475,476,477,478,479,480,481,482,483,484,485,486,487,488,489,490,491,492,493,494,495,496,497,498,499,500,501,502,503,504,505,506,507,508,509,510,511,512,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,536,537,538,539,540,541,542,543,544,545,546,547,548,549,550,551,552,553,554,555,556,557,558,559,560,561,562,563,564,565,566,567,568,569,570,571,572,573,574,575,576,577,578,579,580,581,582,583,584,585,586,587,588,589,590,591,592,593,594,595,596,597,598,599,600,601,602,603,604,605,606,607,608,609,610,611,612,613,614,615,616,617,618,619,620,621,622,623,624,625,626,627,628,629,630,631,632,633,634,635,636,637,638,639,640,641,642,643,644,645,646,647,648,649,650,651,652,653,654,655,656,657,658,659,660,661,662,663,664,665,666,667,668,669,670,671,672,673,674,675,676,677,678,679,680,681,682,683,684,685,686,687,688,689,690,691,692,693,694,695,696,697,698,699,700,701,702,703,704,705,706,707,708,709,710,711,712,713,714,715,716,717,718,719,720,721,722,723,724,725,726,727,728,729,730,731,732,733,734,735,736,737,738,739,740,741,742,743,744,745,746,747,748,749,750,751,752,753,754,755,756,757,758,759,760,761,762,763,764,765,766,767,768,769,770,771,772,773,774,775,776,777,778,779,780,781,782,783,784,785,786,787,788,789,790,791,792,793,794,795,796,797,798,799,800,801,802,803,804,805,806,807,808,809,810,811,812,813,814,815,816,817,818,819,820,821,822,823,824,825,826,827,828,829,830,831,832,833,834,835,836,837,838,839,840,841,842,843,844,845,846,847,848,849,850,851,852,853,854,855,856,857,858,859,860,861,862,863,864,865,866,867,868,869,870,871,872,873,874,875,876,877,878,879,880,881,882,883,884,885,886,887,888,889,890,891,892,893,894,895,896,897,898,899,900,901,902,903,904,905,906,907,908,909,910,911,912,913,914,915,916,917,918,919,920,921,922,923,924,925,926,927,928,929,930,931,932,933,934,935,936,937,938,939,940,941,942,943,944,945,946,947,948,949,950,951,952,953,954,955,956,957,958,959,960,961,962,963,964,965,966,967,968,969,970,971,972,973,974,975,976,977,978,979,980,981,982,983,984,985,986,987,988,989,990,991,992,993,994,995,996,997,998,999,1000,1001,1002,1003,1004,1005,1006,1007,1008,1009,1010,1011,1012,1013,1014,1015,1016,1017,1018,1019,1020,1021,1022,1023", + "nodes": { + "b7d460b7d4145482ac132dfa23727c5c": { + "canRead": true, + "canWrite": true, + "priority": 0 + } + }, + "indexParams": { + "doc_config": { + "docid_prefix_delim": "", + "docid_regexp": "", + "mode": "scope.collection.type_field", + "type_field": "type" + }, + "mapping": { + "analysis": {}, + "default_analyzer": "standard", + "default_datetime_parser": "dateTimeOptional", + "default_field": "_all", + "default_mapping": { + "dynamic": false, + "enabled": false + }, + "default_type": "_default", + "docvalues_dynamic": false, + "index_dynamic": false, + "store_dynamic": false, + "type_field": "_type", + "types": { + "color.rgb": { + "dynamic": false, + "enabled": true, + "properties": { + "color": { + "dynamic": false, + "enabled": true, + "fields": [ + { + "analyzer": "en", + "docvalues": true, + "include_in_all": true, + "include_term_vectors": true, + "index": true, + "name": "color", + "store": true, + "type": "text" + } + ] + }, + "colorvect_dot": { + "dynamic": false, + "enabled": true, + "fields": [ + { + "dims": 3, + "index": true, + "name": "colorvect_dot", + "similarity": "dot_product", + "type": "vector", + "vector_index_optimized_for": "recall" + } + ] + } + } + } + } + }, + "store": { + "indexType": "scorch", + "segmentVersion": 16 + } + } + } + ], + "warnings": [] +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/fts-sample-success-response-vector-search.json b/docs/modules/fts-rest-indexing/examples/fts-sample-success-response-vector-search.json new file mode 100644 index 00000000..5b6f2205 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/fts-sample-success-response-vector-search.json @@ -0,0 +1,55 @@ +{ + "status": { + "total": 1, + "failed": 0, + "successful": 1 + }, + "request": { + "fields": [ + "*" + ], + "query": { + "match_none": "" + }, + "knn": [ + { + "k": 2, + "field": "colorvect_dot", + "vector": [ + 0.707106781186548, + 0, + 0.707106781186548 + ] + } + ] + }, + "hits": [ + { + "index": "vector-sample.color.color-test_4d6a4a2f00f48fa2_4c1c5584", + "id": "#FF00FF", + "score": 0.9999999403953552, + "sort": [ + "_score" + ], + "fields": { + "color": "magenta / fuchsia" + } + }, + { + "index": "vector-sample.color.color-test_4d6a4a2f00f48fa2_4c1c5584", + "id": "#B000B0", + "score": 0.9999999403953552, + "sort": [ + "_score" + ], + "fields": { + "color": "dark lavender" + } + } + ], + "total_hits": 2, + "cost": 0, + "max_score": 0.9999999403953552, + "took": 4608572, + "facets": null +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/fts-sample-success-response.json b/docs/modules/fts-rest-indexing/examples/fts-sample-success-response.json new file mode 100644 index 00000000..63d06acc --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/fts-sample-success-response.json @@ -0,0 +1,261 @@ +{ + "status": { + "total": 1, + "failed": 0, + "successful": 1 + }, + "request": { + "query": { + "conjuncts": [ + { + "match": "location", + "field": "reviews.content", + "prefix_length": 0, + "fuzziness": 0, + "operator": "or" + }, + { + "match_phrase": "nice view", + "field": "reviews.content" + } + ] + }, + "size": 10, + "from": 0, + "highlight": { + "style": "html", + "fields": [ + "reviews.content" + ] + }, + "fields": null, + "facets": null, + "explain": true, + "sort": [ + "reviews.Ratings.Cleanliness", + { + "by": "field", + "field": "reviews.Ratings.Cleanliness", + "type": "number" + }, + "-_score", + "-_id" + ], + "includeLocations": false, + "score": "none", + "search_after": null, + "search_before": null + }, + "hits": [ + { + "index": "travel-sample.inventory.travel-test_53373d2948c55e82_4c1c5584", + "id": "hotel_7388", + "score": 0, + "explanation": { + "value": 0, + "message": "sum of:", + "children": [ + { + "value": 0, + "message": "product of:", + "children": [ + { + "value": 0, + "message": "sum of:", + "children": [ + { + "value": 0, + "message": "weight(reviews.content:location^1.000000 in \u0000\u0000\u0000\u0000\u0000\u0000\u0003\n), product of:", + "children": [ + { + "value": 0.5320504947307548, + "message": "queryWeight(reviews.content:location^1.000000), product of:", + "children": [ + { + "value": 1, + "message": "boost" + }, + { + "value": 1.4291903588638628, + "message": "idf(docFreq=596, maxDocs=917)" + }, + { + "value": 0.3722740581273647, + "message": "queryNorm" + } + ] + }, + { + "value": 0, + "message": "fieldWeight(reviews.content:location in \u0000\u0000\u0000\u0000\u0000\u0000\u0003\n), product of:", + "children": [ + { + "value": 0, + "message": "tf(termFreq(reviews.content:location)=0" + }, + { + "value": 0, + "message": "fieldNorm(field=reviews.content, doc=\u0000\u0000\u0000\u0000\u0000\u0000\u0003\n)" + }, + { + "value": 1.4291903588638628, + "message": "idf(docFreq=596, maxDocs=917)" + } + ] + } + ] + } + ] + }, + { + "value": 1, + "message": "coord(1/1)" + } + ] + }, + { + "value": 0, + "message": "sum of:", + "children": [ + { + "value": 0, + "message": "weight(reviews.content:view^1.000000 in \u0000\u0000\u0000\u0000\u0000\u0000\u0003\n), product of:", + "children": [ + { + "value": 0.6867550119496617, + "message": "queryWeight(reviews.content:view^1.000000), product of:", + "children": [ + { + "value": 1, + "message": "boost" + }, + { + "value": 1.8447565629585312, + "message": "idf(docFreq=393, maxDocs=917)" + }, + { + "value": 0.3722740581273647, + "message": "queryNorm" + } + ] + }, + { + "value": 0, + "message": "fieldWeight(reviews.content:view in \u0000\u0000\u0000\u0000\u0000\u0000\u0003\n), product of:", + "children": [ + { + "value": 0, + "message": "tf(termFreq(reviews.content:view)=0" + }, + { + "value": 0, + "message": "fieldNorm(field=reviews.content, doc=\u0000\u0000\u0000\u0000\u0000\u0000\u0003\n)" + }, + { + "value": 1.8447565629585312, + "message": "idf(docFreq=393, maxDocs=917)" + } + ] + } + ] + }, + { + "value": 0, + "message": "weight(reviews.content:nice^1.000000 in \u0000\u0000\u0000\u0000\u0000\u0000\u0003\n), product of:", + "children": [ + { + "value": 0.4952674273751292, + "message": "queryWeight(reviews.content:nice^1.000000), product of:", + "children": [ + { + "value": 1, + "message": "boost" + }, + { + "value": 1.3303839377539577, + "message": "idf(docFreq=658, maxDocs=917)" + }, + { + "value": 0.3722740581273647, + "message": "queryNorm" + } + ] + }, + { + "value": 0, + "message": "fieldWeight(reviews.content:nice in \u0000\u0000\u0000\u0000\u0000\u0000\u0003\n), product of:", + "children": [ + { + "value": 0, + "message": "tf(termFreq(reviews.content:nice)=0" + }, + { + "value": 0, + "message": "fieldNorm(field=reviews.content, doc=\u0000\u0000\u0000\u0000\u0000\u0000\u0003\n)" + }, + { + "value": 1.3303839377539577, + "message": "idf(docFreq=658, maxDocs=917)" + } + ] + } + ] + } + ] + } + ] + }, + "locations": { + "reviews.content": { + "location": [ + { + "pos": 312, + "start": 1641, + "end": 1649, + "array_positions": [ + 4 + ] + } + ], + "nice": [ + { + "pos": 165, + "start": 840, + "end": 844, + "array_positions": [ + 2 + ] + } + ], + "view": [ + { + "pos": 166, + "start": 845, + "end": 849, + "array_positions": [ + 2 + ] + } + ] + } + }, + "fragments": { + "reviews.content": [ + "…at\u0026#39;s her name checked us in, very friendly and knowlegeable of the area. I would stay here again get area and right at the street car stop. nice resturants in walking distance. \u003cmark\u003enice\u003c/mark\u003e \u003cmark\u003eview\u003c/mark\u003e of the city o…" + ] + }, + "sort": [ + "􏿿􏿿􏿿", + "􏿿􏿿􏿿", + "_score", + "hotel_7388" + ] + }, + "..." + ], + "total_hits": 27, + "cost": 108906, + "max_score": 0, + "took": 14964461, + "facets": null +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/g-api-index-name-count.json b/docs/modules/fts-rest-indexing/examples/g-api-index-name-count.json new file mode 100644 index 00000000..566913b7 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/g-api-index-name-count.json @@ -0,0 +1,4 @@ +{ + "status": "ok", + "count": 285 +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/g-api-index-name.json b/docs/modules/fts-rest-indexing/examples/g-api-index-name.json new file mode 100644 index 00000000..c6aa52c9 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/g-api-index-name.json @@ -0,0 +1,43 @@ +{ + "indexDef": { + "name": "myFirstIndex", + "params": "", + "planParams": { + "hierarchyRules": null, + "maxPartitionsPerPIndex": 0, + "nodePlanParams": null, + "numReplicas": 0, + "planFrozen": false + }, + "sourceName": "", + "sourceParams": "", + "source": "nil", + "sourceUUID": "", + "type": "fulltext-index", + "uuid": "6cc599ab7a85bf3b" + }, + "planPIndexes": [ + { + "indexName": "myFirstIndex", + "indexParams": "", + "indexType": "bleve", + "indexUUID": "6cc599ab7a85bf3b", + "name": "myFirstIndex_6cc599ab7a85bf3b_0", + "nodes": { + "78fc2ffac2fd9401": { + "canRead": true, + "canWrite": true, + "priority": 0 + } + }, + "sourceName": "", + "sourceParams": "", + "sourcePartitions": "", + "sourceType": "nil", + "sourceUUID": "", + "uuid": "64bed6e2edf354c3" + } + ], + "status": "ok", + "warnings": [] +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/g-api-index.json b/docs/modules/fts-rest-indexing/examples/g-api-index.json new file mode 100644 index 00000000..fc2cdcbd --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/g-api-index.json @@ -0,0 +1,26 @@ +{ + "indexDefs": { + "implVersion": "4.0.0", + "indexDefs": { + "myFirstIndex": { + "name": "myFirstIndex", + "params": "", + "planParams": { + "hierarchyRules": null, + "maxPartitionsPerPIndex": 0, + "nodePlanParams": null, + "numReplicas": 0, + "planFrozen": false + }, + "sourceName": "", + "sourceParams": "", + "sourceType": "nil", + "sourceUUID": "", + "type": "fulltext-index", + "uuid": "6cc599ab7a85bf3b" + } + }, + "uuid": "6cc599ab7a85bf3b" + }, + "status": "ok" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/g-api-scoped-indexes.json b/docs/modules/fts-rest-indexing/examples/g-api-scoped-indexes.json new file mode 100644 index 00000000..49cb6e53 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/g-api-scoped-indexes.json @@ -0,0 +1,118 @@ +{ + "status": "ok", + "indexDefs": { + "uuid": "23cf9530131858b8", + "indexDefs": { + "travel-sample.inventory.travel-hotel": { + "type": "fulltext-index", + "name": "travel-hotel", + "uuid": "a04a16f178846bc4", + "sourceType": "gocbcore", + "sourceName": "travel-sample", + "sourceUUID": "8f866261438f8b0d415a437552f3ae99", + "planParams": { + "maxPartitionsPerPIndex": 1024, + "indexPartitions": 1 + }, + "params": { + "doc_config": { + "docid_prefix_delim": "", + "docid_regexp": "", + "mode": "scope.collection.type_field", + "type_field": "type" + }, + "mapping": { + "analysis": {}, + "default_analyzer": "standard", + "default_datetime_parser": "dateTimeOptional", + "default_field": "_all", + "default_mapping": { + "dynamic": true, + "enabled": false + }, + "default_type": "_default", + "docvalues_dynamic": false, + "index_dynamic": true, + "store_dynamic": false, + "type_field": "_type", + "types": { + "inventory.hotel": { + "dynamic": false, + "enabled": true, + "properties": { + "reviews": { + "dynamic": false, + "enabled": true, + "properties": { + "content": { + "dynamic": false, + "enabled": true, + "fields": [ + { + "docvalues": true, + "include_in_all": true, + "include_term_vectors": true, + "index": true, + "name": "content", + "store": true, + "type": "text" + } + ] + } + } + } + } + } + } + }, + "store": { + "indexType": "scorch", + "segmentVersion": 15 + } + }, + "sourceParams": {} + }, + "travel-sample.inventory.travel-test": { + "type": "fulltext-index", + "name": "travel-test", + "uuid": "766ddce5d41a3b41", + "sourceType": "gocbcore", + "sourceName": "travel-sample", + "sourceUUID": "8f866261438f8b0d415a437552f3ae99", + "planParams": { + "maxPartitionsPerPIndex": 1024, + "indexPartitions": 1 + }, + "params": { + "doc_config": { + "docid_prefix_delim": "", + "docid_regexp": "", + "mode": "scope.collection.type_field", + "type_field": "type" + }, + "mapping": { + "analysis": {}, + "default_analyzer": "standard", + "default_datetime_parser": "dateTimeOptional", + "default_field": "_all", + "default_mapping": { + "dynamic": true, + "enabled": true + }, + "default_type": "_default", + "docvalues_dynamic": false, + "index_dynamic": true, + "store_dynamic": false, + "type_field": "_type" + }, + "store": { + "indexType": "scorch", + "segmentVersion": 15 + } + }, + "sourceParams": {} + } + }, + "implVersion": "5.7.0" + } +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/g-api-scoped-status.json b/docs/modules/fts-rest-indexing/examples/g-api-scoped-status.json new file mode 100644 index 00000000..a02fe919 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/g-api-scoped-status.json @@ -0,0 +1,4 @@ +{ + "status": "ok", + "indexStatus": "Ready" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/g-api-stats-index-name-analyzeDoc-200.json b/docs/modules/fts-rest-indexing/examples/g-api-stats-index-name-analyzeDoc-200.json new file mode 100644 index 00000000..43b9686f --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/g-api-stats-index-name-analyzeDoc-200.json @@ -0,0 +1,118 @@ +{ + "status": "ok", + "analyzed": [ + { + "couchbase blr": { + "Term": "Y291Y2hiYXNlIGJscg==", + "Locations": [ + { + "Field": "title", + "ArrayPositions": [], + "Start": 0, + "End": 13, + "Position": 1 + } + ] + } + }, + { + "he": { + "Term": "aGU=", + "Locations": [ + { + "Field": "name", + "ArrayPositions": [], + "Start": 0, + "End": 5, + "Position": 1 + } + ] + }, + "hel": { + "Term": "aGVs", + "Locations": [ + { + "Field": "name", + "ArrayPositions": [], + "Start": 0, + "End": 5, + "Position": 1 + } + ] + }, + "hell": { + "Term": "aGVsbA==", + "Locations": [ + { + "Field": "name", + "ArrayPositions": [], + "Start": 0, + "End": 5, + "Position": 1 + } + ] + }, + "hello": { + "Term": "aGVsbG8=", + "Locations": [ + { + "Field": "name", + "ArrayPositions": [], + "Start": 0, + "End": 5, + "Position": 1 + } + ] + }, + "wo": { + "Term": "d28=", + "Locations": [ + { + "Field": "name", + "ArrayPositions": [], + "Start": 6, + "End": 11, + "Position": 2 + } + ] + }, + "wor": { + "Term": "d29y", + "Locations": [ + { + "Field": "name", + "ArrayPositions": [], + "Start": 6, + "End": 11, + "Position": 2 + } + ] + }, + "worl": { + "Term": "d29ybA==", + "Locations": [ + { + "Field": "name", + "ArrayPositions": [], + "Start": 6, + "End": 11, + "Position": 2 + } + ] + }, + "world": { + "Term": "d29ybGQ=", + "Locations": [ + { + "Field": "name", + "ArrayPositions": [], + "Start": 6, + "End": 11, + "Position": 2 + } + ] + } + }, + null + ] +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/g-api-stats-index-name-analyzeDoc-body.json b/docs/modules/fts-rest-indexing/examples/g-api-stats-index-name-analyzeDoc-body.json new file mode 100644 index 00000000..af6fff72 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/g-api-stats-index-name-analyzeDoc-body.json @@ -0,0 +1,4 @@ +{ + "name": "hello world", + "title": "couchbase blr" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/g-api-stats-index-name.json b/docs/modules/fts-rest-indexing/examples/g-api-stats-index-name.json new file mode 100644 index 00000000..b8bb7efb --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/g-api-stats-index-name.json @@ -0,0 +1,159 @@ +{ + "feeds": {}, + "pindexes": { + "travel-sample.inventory.travel-test_3858c70e4d4d8df9_4c1c5584": { + "pindexStoreStats": { + "TimerBatchStore": { + "count": 0, + "min": 0, + "max": 0, + "mean": 0.00, + "stddev": 0.00, + "percentiles": { + "99%": 0.00, + "99.9%": 0.00, + "median": 0.00, + "75%": 0.00, + "95%": 0.00 + }, + "rates": { + "mean": 0.00, + "1-min": 0.00, + "5-min": 0.00, + "15-min": 0.00 + } + }, + "Errors": [] + }, + "bleveIndexStats": { + "index": { + "CurFilesIneligibleForRemoval": 0, + "CurOnDiskBytes": 34007668, + "CurOnDiskFiles": 4, + "CurRootEpoch": 0, + "LastMergedEpoch": 44, + "LastPersistedEpoch": 44, + "MaxBatchIntroTime": 0, + "MaxFileMergeZapIntroductionTime": 0, + "MaxFileMergeZapTime": 0, + "MaxMemMergeZapTime": 0, + "TotAnalysisTime": 0, + "TotBatchIntroTime": 0, + "TotBatches": 0, + "TotBatchesEmpty": 0, + "TotBytesReadAtQueryTime": 294892, + "TotBytesWrittenAtIndexTime": 0, + "TotDeletes": 0, + "TotEventTriggerCompleted": 2, + "TotEventTriggerStarted": 2, + "TotFileMergeForceOpsCompleted": 0, + "TotFileMergeForceOpsStarted": 0, + "TotFileMergeIntroductions": 0, + "TotFileMergeIntroductionsDone": 0, + "TotFileMergeIntroductionsObsoleted": 0, + "TotFileMergeIntroductionsSkipped": 0, + "TotFileMergeLoopBeg": 2, + "TotFileMergeLoopEnd": 1, + "TotFileMergeLoopErr": 0, + "TotFileMergePlan": 1, + "TotFileMergePlanErr": 0, + "TotFileMergePlanNone": 1, + "TotFileMergePlanOk": 0, + "TotFileMergePlanTasks": 0, + "TotFileMergePlanTasksDone": 0, + "TotFileMergePlanTasksErr": 0, + "TotFileMergePlanTasksSegments": 0, + "TotFileMergePlanTasksSegmentsEmpty": 0, + "TotFileMergeSegments": 0, + "TotFileMergeSegmentsEmpty": 0, + "TotFileMergeWrittenBytes": 0, + "TotFileMergeZapBeg": 0, + "TotFileMergeZapEnd": 0, + "TotFileMergeZapIntroductionTime": 0, + "TotFileMergeZapTime": 0, + "TotFileSegmentsAtRoot": 1, + "TotIndexTime": 0, + "TotIndexedPlainTextBytes": 0, + "TotIntroduceLoop": 3, + "TotIntroduceMergeBeg": 0, + "TotIntroduceMergeEnd": 0, + "TotIntroducePersistBeg": 0, + "TotIntroducePersistEnd": 0, + "TotIntroduceRevertBeg": 0, + "TotIntroduceRevertEnd": 0, + "TotIntroduceSegmentBeg": 0, + "TotIntroduceSegmentEnd": 0, + "TotIntroducedItems": 0, + "TotIntroducedSegmentsBatch": 0, + "TotIntroducedSegmentsMerge": 0, + "TotItemsToPersist": 0, + "TotMemMergeBeg": 0, + "TotMemMergeDone": 0, + "TotMemMergeErr": 0, + "TotMemMergeSegments": 0, + "TotMemMergeZapBeg": 0, + "TotMemMergeZapEnd": 0, + "TotMemMergeZapTime": 0, + "TotMemorySegmentsAtRoot": 0, + "TotOnErrors": 0, + "TotPersistLoopBeg": 2, + "TotPersistLoopEnd": 1, + "TotPersistLoopErr": 0, + "TotPersistLoopProgress": 0, + "TotPersistLoopWait": 2, + "TotPersistLoopWaitNotified": 0, + "TotPersistedItems": 0, + "TotPersistedSegments": 0, + "TotPersisterMergerNapBreak": 1, + "TotPersisterNapPauseCompleted": 1, + "TotPersisterSlowMergerPause": 0, + "TotPersisterSlowMergerResume": 0, + "TotSnapshotsRemovedFromMetaStore": 0, + "TotTermSearchersFinished": 13, + "TotTermSearchersStarted": 13, + "TotUpdates": 0, + "analysis_time": 0, + "batches": 0, + "deletes": 0, + "errors": 0, + "index_time": 0, + "num_bytes_read_at_query_time": 294892, + "num_bytes_used_disk": 34007668, + "num_bytes_used_disk_by_root": 15644303, + "num_bytes_used_disk_by_root_reclaimable": 0, + "num_bytes_written_at_index_time": 0, + "num_files_on_disk": 4, + "num_items_introduced": 0, + "num_items_persisted": 0, + "num_persister_nap_merger_break": 1, + "num_persister_nap_pause_completed": 1, + "num_plain_text_bytes_indexed": 0, + "num_recs_to_persist": 0, + "num_root_filesegments": 1, + "num_root_memorysegments": 0, + "term_searchers_finished": 13, + "term_searchers_started": 13, + "total_compaction_written_bytes": 0, + "updates": 0 + }, + "search_time": 40353204, + "searches": 1 + }, + "basic": { + "DocCount": 917 + }, + "partitions": {}, + "copyPartitionStats": { + "TotCopyPartitionStart": 0, + "TotCopyPartitionFinished": 0, + "TotCopyPartitionTimeInMs": 0, + "TotCopyPartitionFailed": 0, + "TotCopyPartitionRetries": 0, + "TotCopyPartitionErrors": 0, + "TotCopyPartitionSkipped": 0, + "TotCopyPartitionCancelled": 0, + "TotCopyPartitionOnHttp2": 0 + } + } + } +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/g-api-stats.json b/docs/modules/fts-rest-indexing/examples/g-api-stats.json new file mode 100644 index 00000000..0fd37071 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/g-api-stats.json @@ -0,0 +1,41 @@ +{ + "feeds": { + "myFirstIndex_6cc599ab7a85bf3b": {} + }, + "manager": { + "TotCreateIndex": 1, + "TotCreateIndexOk": 1, + "TotDeleteIndex": 0, + "TotDeleteIndexOk": 0, + "TotIndexControl": 0, + "TotIndexControlOk": 0, + "TotJanitorClosePIndex": 0, + "TotJanitorKick": 2, + "TotJanitorKickErr": 0, + "TotJanitorKickOk": 2, + "TotJanitorKickStart": 2, + "TotJanitorNOOP": 0, + "TotJanitorNOOPOk": 0, + "TotJanitorRemovePIndex": 0, + "TotJanitorSubscriptionEvent": 0, + "TotJanitorUnknownErr": 0, + "TotKick": 0, + "TotPlannerKick": 2, + "TotPlannerKickChanged": 1, + "TotPlannerKickErr": 0, + "TotPlannerKickOk": 2, + "TotPlannerKickStart": 2, + "TotPlannerNOOP": 0, + "TotPlannerNOOPOk": 0, + "TotPlannerSubscriptionEvent": 0, + "TotPlannerUnknownErr": 0, + "TotSaveNodeDef": 2, + "TotSaveNodeDefGetErr": 0, + "TotSaveNodeDefOk": 2, + "TotSaveNodeDefSame": 0, + "TotSaveNodeDefSetErr": 0 + }, + "pindexes": { + "myFirstIndex_6cc599ab7a85bf3b_0": null + } +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/p-api-index-name-200.json b/docs/modules/fts-rest-indexing/examples/p-api-index-name-200.json new file mode 100644 index 00000000..203dee2d --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/p-api-index-name-200.json @@ -0,0 +1,5 @@ +{ + "status": "ok", + "name": "travel-test", + "uuid": "565ca041af3baf9d" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/p-api-index-name-default.json b/docs/modules/fts-rest-indexing/examples/p-api-index-name-default.json new file mode 100644 index 00000000..3df88f58 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/p-api-index-name-default.json @@ -0,0 +1,5 @@ +{ + "error": "rest_create_index: index type is required, indexName: travel-test", + "request": "", + "status": "fail" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/p-api-index-name-query-hybrid.json b/docs/modules/fts-rest-indexing/examples/p-api-index-name-query-hybrid.json new file mode 100644 index 00000000..6a484c1b --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/p-api-index-name-query-hybrid.json @@ -0,0 +1,18 @@ +{ + "fields": ["*"], + "query": { + "min": 70, + "max": 80, + "inclusive_min": false, + "inclusive_max": true, + "field": "brightness" + }, + "knn": [ + { + "k": 10, + "field": "colorvect_dot", + "vector": [ 0.707106781186548, 0, 0.707106781186548 ] + } + ], + "size": 10 +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/p-api-index-name-query-options.json b/docs/modules/fts-rest-indexing/examples/p-api-index-name-query-options.json new file mode 100644 index 00000000..6804db50 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/p-api-index-name-query-options.json @@ -0,0 +1,29 @@ +{ + "ctl": { + "timeout": 10000, + "consistency": { + "level": "at_plus", + "vectors": { + "customerIndex": { + "0": 123, + "1/a0b1c2": 234 + } + } + } + }, + "query": { + "query": "alice smith", + "boost": 1 + }, + "size": 10, + "from": 20, + "highlight": { + "style": null, + "fields": null + }, + "fields": [ + "*" + ], + "facets": null, + "explain": true +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/p-api-index-name-query-regular.json b/docs/modules/fts-rest-indexing/examples/p-api-index-name-query-regular.json new file mode 100644 index 00000000..63931d17 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/p-api-index-name-query-regular.json @@ -0,0 +1,12 @@ +{ + "query": { + "query": "a sample query", + "boost": 1 + }, + "size": 10, + "from": 0, + "highlight": null, + "fields": null, + "facets": null, + "explain": false +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/p-api-pindex-lookup-200.json b/docs/modules/fts-rest-indexing/examples/p-api-pindex-lookup-200.json new file mode 100644 index 00000000..3a1acdf1 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/p-api-pindex-lookup-200.json @@ -0,0 +1,8 @@ +{ + "status": "ok", + "pindexes": { + "travel-sample.inventory.travel-test": { + "id": "travel-sample.inventory.travel-test_123294e5a4efbe39_4c1c5584" + } + } +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/p-api-pindex-lookup-body.json b/docs/modules/fts-rest-indexing/examples/p-api-pindex-lookup-body.json new file mode 100644 index 00000000..35a07516 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/p-api-pindex-lookup-body.json @@ -0,0 +1,3 @@ +{ + "docID": "hotel_5848" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/p-api-scoped-index-name-200.json b/docs/modules/fts-rest-indexing/examples/p-api-scoped-index-name-200.json new file mode 100644 index 00000000..9885ab48 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/p-api-scoped-index-name-200.json @@ -0,0 +1,5 @@ +{ + "status": "ok", + "name": "travel-sample.inventory.travel-test", + "uuid": "654cb62baebf2d26" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/p-api-scoped-index-name-default.json b/docs/modules/fts-rest-indexing/examples/p-api-scoped-index-name-default.json new file mode 100644 index 00000000..2ede4758 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/p-api-scoped-index-name-default.json @@ -0,0 +1,5 @@ +{ + "error": "rest_create_index: index type is required, indexName: travel-test", + "request": {}, + "status": "fail" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/p-api-scoped-query-default.json b/docs/modules/fts-rest-indexing/examples/p-api-scoped-query-default.json new file mode 100644 index 00000000..98bd2539 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/p-api-scoped-query-default.json @@ -0,0 +1,49 @@ +{ + "error": "rest_index: Query, indexName: travel-sample.inventory.travel-test, err: bleve: QueryBleve parsing searchRequest, err: unknown query type", + "request": { + "collections": [ + "hotel" + ], + "ctl": { + "consistency": { + "level": "at_plus", + "results": "complete", + "vectors": { + "searchIndexName": { + "607/205096593892159": 2, + "640/298739127912798": 4 + } + } + }, + "timeout": 10000 + }, + "explain": true, + "from": 0, + "highlight": { + "fields": [ + "reviews.content" + ], + "style": "html" + }, + "includeLocations": false, + "limit": 10, + "offset": 0, + "query": {}, + "score": "none", + "size": 10, + "sort": [ + "reviews.Ratings.Cleanliness", + { + "by": "field", + "desc": false, + "field": "reviews.Ratings.Cleanliness", + "missing": "last", + "mode": "default", + "type": "number" + }, + "-_score", + "-_id" + ] + }, + "status": "fail" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/examples/response-200.json b/docs/modules/fts-rest-indexing/examples/response-200.json new file mode 100644 index 00000000..b523aff9 --- /dev/null +++ b/docs/modules/fts-rest-indexing/examples/response-200.json @@ -0,0 +1,3 @@ +{ + "status": "ok" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/pages/index.adoc b/docs/modules/fts-rest-indexing/pages/index.adoc new file mode 100644 index 00000000..57975c06 --- /dev/null +++ b/docs/modules/fts-rest-indexing/pages/index.adoc @@ -0,0 +1,8177 @@ += Couchbase Search Index Management and Monitoring 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/cbft + +: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 Search Indexing REST API is provided by the Search service. +This API enables you to manage and monitor your Search indexes. +-- + +[discrete#version] += Version information +[%hardbreaks] +__Version__ : 8.0 + +[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 Search Service. +-- + +[%hardbreaks] + +*Example:* `+++localhost+++` +// end + +a| *port* +a| [markdown] +-- +The Search Service REST port. Use `18094` for secure access. +-- + +[%hardbreaks] +*Values:* `8094`, `18094` +*Example:* `+++8094+++` +// end + +|=== + + +// markup not found, no 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: 4 + +: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] +xref:tag-Definitions[] +xref:tag-Management[] +xref:tag-Monitoring[] +xref:tag-Querying[] +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Definitions] += Definitions +:leveloffset: +1 + +ifeval::["Use the following APIs to retrieve Search index definitions, create new Search indexes, or delete an existing Search index." != ""] +Use the following APIs to retrieve Search index definitions, create new Search indexes, or delete an existing Search index. +endif::[] +ifeval::["Use the following APIs to retrieve Search index definitions, create new Search indexes, or delete an existing Search index." == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:d-api-index-name[] +xref:d-api-scoped-index-name[] +xref:g-api-index[] +xref:g-api-index-name[] +xref:g-api-scoped-index[] +xref:g-api-scoped-index-name[] +xref:p-api-index-name[] +xref:p-api-scoped-index-name[] + + +//tag::d-api-index-name[] + + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-before.adoc[opts=optional] + + +[#d-api-index-name] += Delete Index Definition + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-begin.adoc[opts=optional] + + +.... +DELETE /api/index/{INDEX_NAME} +.... + + + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-description-before.adoc[opts=optional] + + +[#d-api-index-name-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Deletes the Search index definition specified in the endpoint URL. +-- + + +include::{specDir}paths/d-api-index-name/operation-description-end.adoc[opts=optional] + + + +[#d-api-index-name-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-parameters-before.adoc[opts=optional] + + +[#d-api-index-name-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-parameters-begin.adoc[opts=optional] + + +[#d-api-index-name-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +You must use the fully qualified name for the index, which includes the bucket and scope. + +To view the full, scoped name for an index for use with this endpoint: + +1. Go to the **Search** tab in the Couchbase Server Web Console. +2. Point to the **Index Name** for an index. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-responses-before.adoc[opts=optional] + + +[#d-api-index-name-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The Search Service returns a response that includes the status `ok`. +-- +a| xref:DeleteIndexResponse[] + + +| 0 +a| [markdown] +-- +The Search Service returns a non-200 HTTP error code when a request fails. +-- +a| Object + + + +|=== + + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-security-before.adoc[opts=optional] + + +[#d-api-index-name-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-write[] + +|=== + + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}d-api-index-name/http-request.adoc[opts=optional] + + +include::{snippetDir}d-api-index-name/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/d-api-index-name/operation-after.adoc[opts=optional] + + +//end::d-api-index-name[] + + +//tag::d-api-scoped-index-name[] + + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-before.adoc[opts=optional] + + +[#d-api-scoped-index-name] += Delete Index Definition (Scoped) + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-begin.adoc[opts=optional] + + +.... +DELETE /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME} +.... + + + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-description-before.adoc[opts=optional] + + +[#d-api-scoped-index-name-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Delete the Search index definition from the bucket and scope specified in the endpoint URL. +This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` value. +-- + + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-description-end.adoc[opts=optional] + + + +[#d-api-scoped-index-name-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-parameters-before.adoc[opts=optional] + + +[#d-api-scoped-index-name-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-parameters-begin.adoc[opts=optional] + + +[#d-api-scoped-index-name-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *BUCKET_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the bucket containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *SCOPE_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the scope containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +-- + +[%hardbreaks] +*Pattern:* `+++/^[A-Za-z][0-9A-Za-z_\\-]*$/+++` +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-responses-before.adoc[opts=optional] + + +[#d-api-scoped-index-name-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object indicating the status of the operation. +-- +a| xref:DeleteIndexResponse[] + + +| 0 +a| [markdown] +-- +The Search Service returns a non-200 HTTP error code when a request fails. +-- +a| Object + + + +|=== + + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-security-before.adoc[opts=optional] + + +[#d-api-scoped-index-name-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-write[] + +|=== + + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}d-api-scoped-index-name/http-request.adoc[opts=optional] + + +include::{snippetDir}d-api-scoped-index-name/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/d-api-scoped-index-name/operation-after.adoc[opts=optional] + + +//end::d-api-scoped-index-name[] + + +//tag::g-api-index[] + + +// markup not found, no include::{specDir}paths/g-api-index/operation-before.adoc[opts=optional] + + +[#g-api-index] += Get All Search Index Definitions + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-index/operation-begin.adoc[opts=optional] + + +.... +GET /api/index +.... + + + +// markup not found, no include::{specDir}paths/g-api-index/operation-description-before.adoc[opts=optional] + + +[#g-api-index-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-index/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns all Search index definitions from the bucket where you have read permissions, as a JSON object. +-- + + +include::{specDir}paths/g-api-index/operation-description-end.adoc[opts=optional] + + + +[#g-api-index-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-index/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-index/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/g-api-index/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-index/operation-responses-before.adoc[opts=optional] + + +[#g-api-index-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-index/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing all Search index definitions. +-- +a| xref:GetIndexesResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/g-api-index/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/g-api-index/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-index/operation-security-before.adoc[opts=optional] + + +[#g-api-index-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-index/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-read[] + +|=== + + +// markup not found, no include::{specDir}paths/g-api-index/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-index/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}g-api-index/http-request.adoc[opts=optional] + + +include::{snippetDir}g-api-index/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-index/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-index/operation-after.adoc[opts=optional] + + +//end::g-api-index[] + + +//tag::g-api-index-name[] + + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-before.adoc[opts=optional] + + +[#g-api-index-name] += Get Index Definition + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-begin.adoc[opts=optional] + + +.... +GET /api/index/{INDEX_NAME} +.... + + + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-description-before.adoc[opts=optional] + + +[#g-api-index-name-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns the definition of the Search index specified in the endpoint URL as a JSON object. +-- + + +include::{specDir}paths/g-api-index-name/operation-description-end.adoc[opts=optional] + + + +[#g-api-index-name-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-parameters-before.adoc[opts=optional] + + +[#g-api-index-name-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-parameters-begin.adoc[opts=optional] + + +[#g-api-index-name-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +You must use the fully qualified name for the index, which includes the bucket and scope. + +To view the full, scoped name for an index for use with this endpoint: + +1. Go to the **Search** tab in the Couchbase Server Web Console. +2. Point to the **Index Name** for an index. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-responses-before.adoc[opts=optional] + + +[#g-api-index-name-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing the Search index definition. +-- +a| xref:GetIndexResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-security-before.adoc[opts=optional] + + +[#g-api-index-name-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-read[] + +|=== + + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}g-api-index-name/http-request.adoc[opts=optional] + + +include::{snippetDir}g-api-index-name/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-index-name/operation-after.adoc[opts=optional] + + +//end::g-api-index-name[] + + +//tag::g-api-scoped-index[] + + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-before.adoc[opts=optional] + + +[#g-api-scoped-index] += Get All Search Index Definitions (Scoped) + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-begin.adoc[opts=optional] + + +.... +GET /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index +.... + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-description-before.adoc[opts=optional] + + +[#g-api-scoped-index-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns all Search index definitions inside the bucket and scope specified in the endpoint URL as a JSON object. +-- + + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-description-end.adoc[opts=optional] + + + +[#g-api-scoped-index-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-parameters-before.adoc[opts=optional] + + +[#g-api-scoped-index-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-parameters-begin.adoc[opts=optional] + + +[#g-api-scoped-index-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *BUCKET_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the bucket containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *SCOPE_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the scope containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-responses-before.adoc[opts=optional] + + +[#g-api-scoped-index-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing all Search index definitions. +-- +a| xref:GetIndexesResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-security-before.adoc[opts=optional] + + +[#g-api-scoped-index-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-read[] + +|=== + + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}g-api-scoped-index/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}g-api-scoped-index/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-scoped-index/operation-after.adoc[opts=optional] + + +//end::g-api-scoped-index[] + + +//tag::g-api-scoped-index-name[] + + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-before.adoc[opts=optional] + + +[#g-api-scoped-index-name] += Get Index Definition (Scoped) + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-begin.adoc[opts=optional] + + +.... +GET /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME} +.... + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-description-before.adoc[opts=optional] + + +[#g-api-scoped-index-name-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns the Search index definition for the Search index specified in the endpoint URL as a JSON object. +This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` value. +-- + + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-description-end.adoc[opts=optional] + + + +[#g-api-scoped-index-name-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-parameters-before.adoc[opts=optional] + + +[#g-api-scoped-index-name-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-parameters-begin.adoc[opts=optional] + + +[#g-api-scoped-index-name-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *BUCKET_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the bucket containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *SCOPE_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the scope containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +-- + +[%hardbreaks] +*Pattern:* `+++/^[A-Za-z][0-9A-Za-z_\\-]*$/+++` +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-responses-before.adoc[opts=optional] + + +[#g-api-scoped-index-name-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing the Search index definition. +-- +a| xref:GetIndexResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-security-before.adoc[opts=optional] + + +[#g-api-scoped-index-name-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-read[] + +|=== + + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}g-api-scoped-index-name/http-request.adoc[opts=optional] + + +include::{snippetDir}g-api-scoped-index-name/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-scoped-index-name/operation-after.adoc[opts=optional] + + +//end::g-api-scoped-index-name[] + + +//tag::p-api-index-name[] + + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-before.adoc[opts=optional] + + +[#p-api-index-name] += Create or Update an Index Definition + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-begin.adoc[opts=optional] + + +.... +PUT /api/index/{INDEX_NAME} +.... + + + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-description-before.adoc[opts=optional] + + +[#p-api-index-name-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +If the Search index in the endpoint URL does not exist, this endpoint uses a JSON object in the request body to create a new index. +If the Search index already exists, this endpoint updates the Search index definition. +-- + + +include::{specDir}paths/p-api-index-name/operation-description-end.adoc[opts=optional] + + +[#p-api-index-name-consumes] +.Consumes +* application/json + +[#p-api-index-name-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-parameters-before.adoc[opts=optional] + + +[#p-api-index-name-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-parameters-begin.adoc[opts=optional] + + +[#p-api-index-name-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +You must use the fully qualified name for the index, which includes the bucket and scope. + +To view the full, scoped name for an index for use with this endpoint: + +1. Go to the **Search** tab in the Couchbase Server Web Console. +2. Point to the **Index Name** for an index. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + +[#p-api-index-name-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_required_ +a¦ + + +[markdown] +-- +The full Search index definition. For a detailed list of all parameters for the request body, see [Search Index JSON Properties](../search/search-index-params.html). +-- + +[%hardbreaks] +{blank} + +a¦ xref:IndexDefinition[] + + + +|=== + + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-responses-before.adoc[opts=optional] + + +[#p-api-index-name-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object indicating the status of the operation. +-- +a| xref:PutIndexResponse[] + + +| 0 +a| [markdown] +-- +The Search Service returns a non-200 HTTP error code when a request fails. +-- +a| Object + + + +|=== + + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-security-before.adoc[opts=optional] + + +[#p-api-index-name-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-write[] + +|=== + + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}p-api-index-name/http-request.adoc[opts=optional] + + +include::{snippetDir}p-api-index-name/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-index-name/operation-after.adoc[opts=optional] + + +//end::p-api-index-name[] + + +//tag::p-api-scoped-index-name[] + + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-before.adoc[opts=optional] + + +[#p-api-scoped-index-name] += Create or Update an Index Definition (Scoped) + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-begin.adoc[opts=optional] + + +.... +PUT /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME} +.... + + + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-description-before.adoc[opts=optional] + + +[#p-api-scoped-index-name-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +If the Search index in the endpoint URL does not exist, this endpoint uses a JSON object in the request body to create a new index. +If the Search index already exists, this endpoint updates the Search index definition. +This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` value. +-- + + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-description-end.adoc[opts=optional] + + +[#p-api-scoped-index-name-consumes] +.Consumes +* application/json + +[#p-api-scoped-index-name-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-parameters-before.adoc[opts=optional] + + +[#p-api-scoped-index-name-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-parameters-begin.adoc[opts=optional] + + +[#p-api-scoped-index-name-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *BUCKET_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the bucket containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *SCOPE_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the scope containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +-- + +[%hardbreaks] +*Pattern:* `+++/^[A-Za-z][0-9A-Za-z_\\-]*$/+++` +{blank} + +a¦ String + + + +|=== + + + + +[#p-api-scoped-index-name-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_required_ +a¦ + + +[markdown] +-- +The full Search index definition. For a detailed list of all parameters for the request body, see [Search Index JSON Properties](../search/search-index-params.html). +-- + +[%hardbreaks] +{blank} + +a¦ xref:IndexDefinition[] + + + +|=== + + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-responses-before.adoc[opts=optional] + + +[#p-api-scoped-index-name-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object indicating the status of the operation. +-- +a| xref:PutIndexResponse[] + + +| 0 +a| [markdown] +-- +The Search Service returns a non-200 HTTP error code when a request fails. +-- +a| Object + + + +|=== + + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-security-before.adoc[opts=optional] + + +[#p-api-scoped-index-name-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-write[] + +|=== + + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}p-api-scoped-index-name/http-request.adoc[opts=optional] + + +include::{snippetDir}p-api-scoped-index-name/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-scoped-index-name/operation-after.adoc[opts=optional] + + +//end::p-api-scoped-index-name[] + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Management] += Management +:leveloffset: +1 + +ifeval::["Use the following endpoints to manage index controls, such as document ingestion, partition assignment, and queries." != ""] +Use the following endpoints to manage index controls, such as document ingestion, partition assignment, and queries. +endif::[] +ifeval::["Use the following endpoints to manage index controls, such as document ingestion, partition assignment, and queries." == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:p-api-idx-name-ingestcontrol[] +xref:p-api-idx-name-planfreezecontrol[] +xref:p-api-idx-name-querycontrol[] +xref:p-api-scoped-ingestcontrol[] +xref:p-api-scoped-planfreezecontrol[] +xref:p-api-scoped-querycontrol[] + + +//tag::p-api-idx-name-ingestcontrol[] + + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-before.adoc[opts=optional] + + +[#p-api-idx-name-ingestcontrol] += Set Index Ingestion Control + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-begin.adoc[opts=optional] + + +.... +POST /api/index/{INDEX_NAME}/ingestControl/{OP} +.... + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-description-before.adoc[opts=optional] + + +[#p-api-idx-name-ingestcontrol-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +For the Search index specified in the endpoint URL, pause or resume index updates and maintenance. +While paused, the Search index does not load any new document mutations. +-- + + +include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-description-end.adoc[opts=optional] + + + +[#p-api-idx-name-ingestcontrol-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-parameters-before.adoc[opts=optional] + + +[#p-api-idx-name-ingestcontrol-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-parameters-begin.adoc[opts=optional] + + +[#p-api-idx-name-ingestcontrol-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +You must use the fully qualified name for the index, which includes the bucket and scope. + +To view the full, scoped name for an index for use with this endpoint: + +1. Go to the **Search** tab in the Couchbase Server Web Console. +2. Point to the **Index Name** for an index. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *OP* + +_required_ +a¦ + + +[markdown] +-- +To pause ingestion and maintenance, set `{OP}` to `pause`. +To resume ingestion and maintenance on a paused index, set `{OP}` to `resume`. +-- + +[%hardbreaks] +*Values:* `"pause"`, `"resume"` +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-responses-before.adoc[opts=optional] + + +[#p-api-idx-name-ingestcontrol-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The Search Service returns a response that includes the status `ok`. +-- +a| xref:MgmtResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-before.adoc[opts=optional] + + +[#p-api-idx-name-ingestcontrol-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-manage[] + +|=== + + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}p-api-idx-name-ingestcontrol/http-request.adoc[opts=optional] + + +include::{snippetDir}p-api-idx-name-ingestcontrol/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-after.adoc[opts=optional] + + +//end::p-api-idx-name-ingestcontrol[] + + +//tag::p-api-idx-name-planfreezecontrol[] + + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-before.adoc[opts=optional] + + +[#p-api-idx-name-planfreezecontrol] += Freeze Index Partition Assignment + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-begin.adoc[opts=optional] + + +.... +POST /api/index/{INDEX_NAME}/planFreezeControl/{OP} +.... + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-description-before.adoc[opts=optional] + + +[#p-api-idx-name-planfreezecontrol-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +For the Search index specified in the endpoint URL, freeze or unfreeze the assignment of index partitions to nodes. +While frozen, the Search index stops assigning partitions during index rebalancing and index definition updates. +-- + + +include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-description-end.adoc[opts=optional] + + + +[#p-api-idx-name-planfreezecontrol-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-parameters-before.adoc[opts=optional] + + +[#p-api-idx-name-planfreezecontrol-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-parameters-begin.adoc[opts=optional] + + +[#p-api-idx-name-planfreezecontrol-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +You must use the fully qualified name for the index, which includes the bucket and scope. + +To view the full, scoped name for an index for use with this endpoint: + +1. Go to the **Search** tab in the Couchbase Server Web Console. +2. Point to the **Index Name** for an index. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *OP* + +_required_ +a¦ + + +[markdown] +-- +To freeze partition assignment, set `{OP}` to `freeze`. +To unfreeze partition assignment on a frozen index, set `{OP}` to `unfreeze`. +-- + +[%hardbreaks] +*Values:* `"freeze"`, `"unfreeze"` +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-responses-before.adoc[opts=optional] + + +[#p-api-idx-name-planfreezecontrol-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The Search Service returns a response that includes the status `ok`. +-- +a| xref:MgmtResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-before.adoc[opts=optional] + + +[#p-api-idx-name-planfreezecontrol-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-manage[] + +|=== + + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}p-api-idx-name-planfreezecontrol/http-request.adoc[opts=optional] + + +include::{snippetDir}p-api-idx-name-planfreezecontrol/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-after.adoc[opts=optional] + + +//end::p-api-idx-name-planfreezecontrol[] + + +//tag::p-api-idx-name-querycontrol[] + + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-before.adoc[opts=optional] + + +[#p-api-idx-name-querycontrol] += Stop Queries on an Index + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-begin.adoc[opts=optional] + + +.... +POST /api/index/{INDEX_NAME}/queryControl/{OP} +.... + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-description-before.adoc[opts=optional] + + +[#p-api-idx-name-querycontrol-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +For the Search index specified in the endpoint URL, disallow or allow queries. +While queries are disallowed, users see an error that the Search index's partitions could not be reached. +-- + + +include::{specDir}paths/p-api-idx-name-querycontrol/operation-description-end.adoc[opts=optional] + + + +[#p-api-idx-name-querycontrol-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-parameters-before.adoc[opts=optional] + + +[#p-api-idx-name-querycontrol-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-parameters-begin.adoc[opts=optional] + + +[#p-api-idx-name-querycontrol-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +You must use the fully qualified name for the index, which includes the bucket and scope. + +To view the full, scoped name for an index for use with this endpoint: + +1. Go to the **Search** tab in the Couchbase Server Web Console. +2. Point to the **Index Name** for an index. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *OP* + +_required_ +a¦ + + +[markdown] +-- +To allow queries against a Search index, set `{OP}` to `allow`. +To block queries against a Search index, set `{OP}` to `disallow`. +-- + +[%hardbreaks] +*Values:* `"allow"`, `"disallow"` +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-responses-before.adoc[opts=optional] + + +[#p-api-idx-name-querycontrol-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The Search Service returns a response that includes the status `ok`. +-- +a| xref:MgmtResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-before.adoc[opts=optional] + + +[#p-api-idx-name-querycontrol-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-manage[] + +|=== + + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}p-api-idx-name-querycontrol/http-request.adoc[opts=optional] + + +include::{snippetDir}p-api-idx-name-querycontrol/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-idx-name-querycontrol/operation-after.adoc[opts=optional] + + +//end::p-api-idx-name-querycontrol[] + + +//tag::p-api-scoped-ingestcontrol[] + + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-before.adoc[opts=optional] + + +[#p-api-scoped-ingestcontrol] += Set Index Ingestion Control (Scoped) + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-begin.adoc[opts=optional] + + +.... +POST /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME}/ingestControl/{OP} +.... + + + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-description-before.adoc[opts=optional] + + +[#p-api-scoped-ingestcontrol-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +For the Search index specified in the endpoint URL, pause or resume index updates and maintenance. +While paused, the Search index does not load any new document mutations. +This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` value. +-- + + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-description-end.adoc[opts=optional] + + + +[#p-api-scoped-ingestcontrol-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-parameters-before.adoc[opts=optional] + + +[#p-api-scoped-ingestcontrol-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-parameters-begin.adoc[opts=optional] + + +[#p-api-scoped-ingestcontrol-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *BUCKET_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the bucket containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *SCOPE_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the scope containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +-- + +[%hardbreaks] +*Pattern:* `+++/^[A-Za-z][0-9A-Za-z_\\-]*$/+++` +{blank} + +a¦ String + + + +a¦ *OP* + +_required_ +a¦ + + +[markdown] +-- +To pause ingestion and maintenance, set `{OP}` to `pause`. +To resume ingestion and maintenance on a paused index, set `{OP}` to `resume`. +-- + +[%hardbreaks] +*Values:* `"pause"`, `"resume"` +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-responses-before.adoc[opts=optional] + + +[#p-api-scoped-ingestcontrol-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The Search Service returns a response that includes the status `ok`. +-- +a| xref:MgmtResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-before.adoc[opts=optional] + + +[#p-api-scoped-ingestcontrol-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-manage[] + +|=== + + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}p-api-scoped-ingestcontrol/http-request.adoc[opts=optional] + + +include::{snippetDir}p-api-scoped-ingestcontrol/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-scoped-ingestcontrol/operation-after.adoc[opts=optional] + + +//end::p-api-scoped-ingestcontrol[] + + +//tag::p-api-scoped-planfreezecontrol[] + + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-before.adoc[opts=optional] + + +[#p-api-scoped-planfreezecontrol] += Freeze Index Partition Assignment (Scoped) + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-begin.adoc[opts=optional] + + +.... +POST /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME}/planFreezeControl/{OP} +.... + + + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-description-before.adoc[opts=optional] + + +[#p-api-scoped-planfreezecontrol-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +For the Search index specified in the endpoint URL, freeze or unfreeze the assignment of index partitions to nodes. +While frozen, the Search index stops assigning partitions during index rebalancing and index definition updates. +This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` value. +-- + + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-description-end.adoc[opts=optional] + + + +[#p-api-scoped-planfreezecontrol-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-parameters-before.adoc[opts=optional] + + +[#p-api-scoped-planfreezecontrol-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-parameters-begin.adoc[opts=optional] + + +[#p-api-scoped-planfreezecontrol-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *BUCKET_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the bucket containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *SCOPE_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the scope containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +-- + +[%hardbreaks] +*Pattern:* `+++/^[A-Za-z][0-9A-Za-z_\\-]*$/+++` +{blank} + +a¦ String + + + +a¦ *OP* + +_required_ +a¦ + + +[markdown] +-- +To freeze partition assignment, set `{OP}` to `freeze`. +To unfreeze partition assignment on a frozen index, set `{OP}` to `unfreeze`. +-- + +[%hardbreaks] +*Values:* `"freeze"`, `"unfreeze"` +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-responses-before.adoc[opts=optional] + + +[#p-api-scoped-planfreezecontrol-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The Search Service returns a response that includes the status `ok`. +-- +a| xref:MgmtResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-before.adoc[opts=optional] + + +[#p-api-scoped-planfreezecontrol-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-manage[] + +|=== + + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}p-api-scoped-planfreezecontrol/http-request.adoc[opts=optional] + + +include::{snippetDir}p-api-scoped-planfreezecontrol/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-after.adoc[opts=optional] + + +//end::p-api-scoped-planfreezecontrol[] + + +//tag::p-api-scoped-querycontrol[] + + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-before.adoc[opts=optional] + + +[#p-api-scoped-querycontrol] += Stop Queries on an Index (Scoped) + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-begin.adoc[opts=optional] + + +.... +POST /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME}/queryControl/{OP} +.... + + + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-description-before.adoc[opts=optional] + + +[#p-api-scoped-querycontrol-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +For the Search index specified in the endpoint URL, disallow or allow queries. +While queries are disallowed, users see an error that the Search index's partitions could not be reached. +This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` value. +-- + + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-description-end.adoc[opts=optional] + + + +[#p-api-scoped-querycontrol-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-parameters-before.adoc[opts=optional] + + +[#p-api-scoped-querycontrol-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-parameters-begin.adoc[opts=optional] + + +[#p-api-scoped-querycontrol-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *BUCKET_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the bucket containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *SCOPE_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the scope containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +-- + +[%hardbreaks] +*Pattern:* `+++/^[A-Za-z][0-9A-Za-z_\\-]*$/+++` +{blank} + +a¦ String + + + +a¦ *OP* + +_required_ +a¦ + + +[markdown] +-- +To allow queries against a Search index, set `{OP}` to `allow`. +To block queries against a Search index, set `{OP}` to `disallow`. +-- + +[%hardbreaks] +*Values:* `"allow"`, `"disallow"` +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-responses-before.adoc[opts=optional] + + +[#p-api-scoped-querycontrol-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The Search Service returns a response that includes the status `ok`. +-- +a| xref:MgmtResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-security-before.adoc[opts=optional] + + +[#p-api-scoped-querycontrol-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-manage[] + +|=== + + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}p-api-scoped-querycontrol/http-request.adoc[opts=optional] + + +include::{snippetDir}p-api-scoped-querycontrol/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-scoped-querycontrol/operation-after.adoc[opts=optional] + + +//end::p-api-scoped-querycontrol[] + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Monitoring] += Monitoring +:leveloffset: +1 + +ifeval::["Use the following endpoints to get statistics about Search indexes for monitoring and debugging." != ""] +Use the following endpoints to get statistics about Search indexes for monitoring and debugging. +endif::[] +ifeval::["Use the following endpoints to get statistics about Search indexes for monitoring and debugging." == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:g-api-scoped-status[] +xref:g-api-stats[] +xref:g-api-stats-index-name[] +xref:g-api-stats-index-name-analyzeDoc[] + + +//tag::g-api-scoped-status[] + + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-before.adoc[opts=optional] + + +[#g-api-scoped-status] += Get Index Status (Scoped) + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-begin.adoc[opts=optional] + + +.... +GET /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME}/status +.... + + + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-description-before.adoc[opts=optional] + + +[#g-api-scoped-status-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns the status of the Search index specified in the endpoint URL, including whether all index partitions are created and ready to use. + +-- + + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-description-end.adoc[opts=optional] + + + +[#g-api-scoped-status-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-parameters-before.adoc[opts=optional] + + +[#g-api-scoped-status-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-parameters-begin.adoc[opts=optional] + + +[#g-api-scoped-status-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *BUCKET_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the bucket containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *SCOPE_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the scope containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +-- + +[%hardbreaks] +*Pattern:* `+++/^[A-Za-z][0-9A-Za-z_\\-]*$/+++` +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-responses-before.adoc[opts=optional] + + +[#g-api-scoped-status-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The Search Service returns a response that includes the status `ok`. +-- +a| xref:StatusResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-security-before.adoc[opts=optional] + + +[#g-api-scoped-status-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-read[] + +|=== + + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}g-api-scoped-status/http-request.adoc[opts=optional] + + +include::{snippetDir}g-api-scoped-status/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-scoped-status/operation-after.adoc[opts=optional] + + +//end::g-api-scoped-status[] + + +//tag::g-api-stats[] + + +// markup not found, no include::{specDir}paths/g-api-stats/operation-before.adoc[opts=optional] + + +[#g-api-stats] += Get Indexing and Data Metrics for All Indexes + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-stats/operation-begin.adoc[opts=optional] + + +.... +GET /api/stats +.... + + + +// markup not found, no include::{specDir}paths/g-api-stats/operation-description-before.adoc[opts=optional] + + +[#g-api-stats-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-stats/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns indexing and data-related metrics, timings, counters, and detailed partition information for all Search indexes, from the node running the Search Service. + +This endpoint returns statistics provided by the Search service. +For additional statistics, see [Get Query, Mutation, and Partition Statistics for the Search Service](../fts-rest-stats/index.html#g-api-nsstats). +-- + + +// markup not found, no include::{specDir}paths/g-api-stats/operation-description-end.adoc[opts=optional] + + + +[#g-api-stats-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-stats/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-stats/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/g-api-stats/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-stats/operation-responses-before.adoc[opts=optional] + + +[#g-api-stats-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-stats/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing indexing and data metrics. +-- +a| xref:StatsNodeResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/g-api-stats/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/g-api-stats/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-stats/operation-security-before.adoc[opts=optional] + + +[#g-api-stats-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-stats/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-statistics[] + +|=== + + +// markup not found, no include::{specDir}paths/g-api-stats/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-stats/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}g-api-stats/http-request.adoc[opts=optional] + + +include::{snippetDir}g-api-stats/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-stats/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-stats/operation-after.adoc[opts=optional] + + +//end::g-api-stats[] + + +//tag::g-api-stats-index-name[] + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-before.adoc[opts=optional] + + +[#g-api-stats-index-name] += Get Indexing and Data Metrics for an Index + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-begin.adoc[opts=optional] + + +.... +GET /api/stats/index/{INDEX_NAME} +.... + + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-description-before.adoc[opts=optional] + + +[#g-api-stats-index-name-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns indexing and data-related metrics, timings, counters, and detailed partition information for the Search index specified in the endpoint URL. + +This endpoint returns statistics provided by the Search service. +For additional statistics, see [Get Query, Mutation, and Partition Statistics for an Index](../fts-rest-stats/index.html#g-api-nsstats-index-name). +-- + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-description-end.adoc[opts=optional] + + + +[#g-api-stats-index-name-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-parameters-before.adoc[opts=optional] + + +[#g-api-stats-index-name-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-parameters-begin.adoc[opts=optional] + + +[#g-api-stats-index-name-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +You must use the fully qualified name for the index, which includes the bucket and scope. + +To view the full, scoped name for an index for use with this endpoint: + +1. Go to the **Search** tab in the Couchbase Server Web Console. +2. Point to the **Index Name** for an index. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-responses-before.adoc[opts=optional] + + +[#g-api-stats-index-name-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing statistics for the specified Search index. +-- +a| xref:StatsIndexResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-security-before.adoc[opts=optional] + + +[#g-api-stats-index-name-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-statistics[] + +|=== + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}g-api-stats-index-name/http-request.adoc[opts=optional] + + +include::{snippetDir}g-api-stats-index-name/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name/operation-after.adoc[opts=optional] + + +//end::g-api-stats-index-name[] + + +//tag::g-api-stats-index-name-analyzeDoc[] + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-before.adoc[opts=optional] + + +[#g-api-stats-index-name-analyzeDoc] += Analyze Document + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-begin.adoc[opts=optional] + + +.... +POST /api/index/{INDEX_NAME}/analyzeDoc +.... + + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-description-before.adoc[opts=optional] + + +[#g-api-stats-index-name-analyzeDoc-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Use the Search index specified in the endpoint URL to analyze a document from the request body. + +-- + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-description-end.adoc[opts=optional] + + +[#g-api-stats-index-name-analyzeDoc-consumes] +.Consumes +* application/json + +[#g-api-stats-index-name-analyzeDoc-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-parameters-before.adoc[opts=optional] + + +[#g-api-stats-index-name-analyzeDoc-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-parameters-begin.adoc[opts=optional] + + +[#g-api-stats-index-name-analyzeDoc-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +You must use the fully qualified name for the index, which includes the bucket and scope. + +To view the full, scoped name for an index for use with this endpoint: + +1. Go to the **Search** tab in the Couchbase Server Web Console. +2. Point to the **Index Name** for an index. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + +[#g-api-stats-index-name-analyzeDoc-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_required_ +a¦ + + +[markdown] +-- +Add any valid JSON document to the request body. +-- + +[%hardbreaks] +{blank} + +a¦ xref:Object[] + + + +|=== + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-responses-before.adoc[opts=optional] + + +[#g-api-stats-index-name-analyzeDoc-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing the analysis of the provided document. +-- +a| xref:DocumentAnalysis[] + + + +|=== + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-before.adoc[opts=optional] + + +[#g-api-stats-index-name-analyzeDoc-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-read[] + +|=== + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}g-api-stats-index-name-analyzeDoc/http-request.adoc[opts=optional] + + +include::{snippetDir}g-api-stats-index-name-analyzeDoc/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-after.adoc[opts=optional] + + +//end::g-api-stats-index-name-analyzeDoc[] + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Querying] += Querying +:leveloffset: +1 + +ifeval::["Use the following endpoints to query the contents of a Search index." != ""] +Use the following endpoints to query the contents of a Search index. +endif::[] +ifeval::["Use the following endpoints to query the contents of a Search index." == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:g-api-index-name-count[] +xref:p-api-index-name-query[] +xref:p-api-pindex-lookup[] +xref:p-api-scoped-query[] + + +//tag::g-api-index-name-count[] + + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-before.adoc[opts=optional] + + +[#g-api-index-name-count] += Get Document Count for an Index + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-begin.adoc[opts=optional] + + +.... +GET /api/index/{INDEX_NAME}/count +.... + + + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-description-before.adoc[opts=optional] + + +[#g-api-index-name-count-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns the number of documents indexed in the specified Search index. + +-- + + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-description-end.adoc[opts=optional] + + + +[#g-api-index-name-count-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-parameters-before.adoc[opts=optional] + + +[#g-api-index-name-count-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-parameters-begin.adoc[opts=optional] + + +[#g-api-index-name-count-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +You must use the fully qualified name for the index, which includes the bucket and scope. + +To view the full, scoped name for an index for use with this endpoint: + +1. Go to the **Search** tab in the Couchbase Server Web Console. +2. Point to the **Index Name** for an index. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-responses-before.adoc[opts=optional] + + +[#g-api-index-name-count-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The Search Service returns a response that includes the status `ok`. +-- +a| xref:DocumentCount[] + + + +|=== + + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-security-before.adoc[opts=optional] + + +[#g-api-index-name-count-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-statistics[] + +|=== + + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}g-api-index-name-count/http-request.adoc[opts=optional] + + +include::{snippetDir}g-api-index-name-count/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-index-name-count/operation-after.adoc[opts=optional] + + +//end::g-api-index-name-count[] + + +//tag::p-api-index-name-query[] + + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-before.adoc[opts=optional] + + +[#p-api-index-name-query] += Query a Search Index + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-begin.adoc[opts=optional] + + +.... +POST /api/index/{INDEX_NAME}/query +.... + + + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-description-before.adoc[opts=optional] + + +[#p-api-index-name-query-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Run a query formatted as a JSON object against the Search index definition specified in the endpoint URL. +The endpoint returns a JSON object as a response. + +-- + + +include::{specDir}paths/p-api-index-name-query/operation-description-end.adoc[opts=optional] + + +[#p-api-index-name-query-consumes] +.Consumes +* application/json + +[#p-api-index-name-query-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-parameters-before.adoc[opts=optional] + + +[#p-api-index-name-query-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-parameters-begin.adoc[opts=optional] + + +[#p-api-index-name-query-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +You must use the fully qualified name for the index, which includes the bucket and scope. + +To view the full, scoped name for an index for use with this endpoint: + +1. Go to the **Search** tab in the Couchbase Server Web Console. +2. Point to the **Index Name** for an index. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + +[#p-api-index-name-query-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_required_ +a¦ + + +[markdown] +-- +A JSON object to define the settings for your Search query. For more information about how to create a Search query JSON object, see [Search Request JSON Properties](../search/search-request-params.html). +-- + +[%hardbreaks] +{blank} + +a¦ xref:QueryRequest[] + + + +|=== + + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-responses-before.adoc[opts=optional] + + +[#p-api-index-name-query-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The response object has a status section that must be checked for every request. Under nearly all circumstances, the query response will be HTTP 200 even though individual index shards (partitions) may encounter a timeout or return an error. +-- +a| xref:QueryResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +include::{specDir}paths/p-api-index-name-query/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-security-before.adoc[opts=optional] + + +[#p-api-index-name-query-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-manage[] + +|=== + + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}p-api-index-name-query/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}p-api-index-name-query/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-index-name-query/operation-after.adoc[opts=optional] + + +//end::p-api-index-name-query[] + + +//tag::p-api-pindex-lookup[] + + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-before.adoc[opts=optional] + + +[#p-api-pindex-lookup] += Look Up the Index Partition for a Document (Scoped) + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-begin.adoc[opts=optional] + + +.... +POST /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME}/pindexLookup +.... + + + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-description-before.adoc[opts=optional] + + +[#p-api-pindex-lookup-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Send a document ID in the request body and return the Search index partition ID where the document is stored. +The endpoint returns a JSON object as a response. + +-- + + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-description-end.adoc[opts=optional] + + +[#p-api-pindex-lookup-consumes] +.Consumes +* application/json + +[#p-api-pindex-lookup-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-parameters-before.adoc[opts=optional] + + +[#p-api-pindex-lookup-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-parameters-begin.adoc[opts=optional] + + +[#p-api-pindex-lookup-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *BUCKET_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the bucket containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *SCOPE_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the scope containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +-- + +[%hardbreaks] +*Pattern:* `+++/^[A-Za-z][0-9A-Za-z_\\-]*$/+++` +{blank} + +a¦ String + + + +|=== + + + + +[#p-api-pindex-lookup-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_required_ +a¦ + + +[markdown] +-- +A valid JSON object that contains the docID property, with a value that matches the document ID for a document in the Search index. +-- + +[%hardbreaks] +{blank} + +a¦ xref:LookupRequest[] + + + +|=== + + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-responses-before.adoc[opts=optional] + + +[#p-api-pindex-lookup-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The Search Service returns a response that includes the status `ok`. +-- +a| xref:LookupResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-security-before.adoc[opts=optional] + + +[#p-api-pindex-lookup-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-manage[] + +|=== + + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}p-api-pindex-lookup/http-request.adoc[opts=optional] + + +include::{snippetDir}p-api-pindex-lookup/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-pindex-lookup/operation-after.adoc[opts=optional] + + +//end::p-api-pindex-lookup[] + + +//tag::p-api-scoped-query[] + + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-before.adoc[opts=optional] + + +[#p-api-scoped-query] += Query a Search Index (Scoped) + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-begin.adoc[opts=optional] + + +.... +POST /api/bucket/{BUCKET_NAME}/scope/{SCOPE_NAME}/index/{INDEX_NAME}/query +.... + + + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-description-before.adoc[opts=optional] + + +[#p-api-scoped-query-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Run a query formatted as a JSON object against the Search index definition specified in the endpoint URL. +The endpoint returns a JSON object as a response. +This endpoint is scoped and does not require a fully qualified `{INDEX_NAME}` value. + +-- + + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-description-end.adoc[opts=optional] + + +[#p-api-scoped-query-consumes] +.Consumes +* application/json + +[#p-api-scoped-query-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-parameters-before.adoc[opts=optional] + + +[#p-api-scoped-query-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-parameters-begin.adoc[opts=optional] + + +[#p-api-scoped-query-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *BUCKET_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the bucket containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *SCOPE_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the scope containing the Search index definition. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +-- + +[%hardbreaks] +*Pattern:* `+++/^[A-Za-z][0-9A-Za-z_\\-]*$/+++` +{blank} + +a¦ String + + + +|=== + + + + +[#p-api-scoped-query-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_required_ +a¦ + + +[markdown] +-- +A JSON object to define the settings for your Search query. For more information about how to create a Search query JSON object, see [Search Request JSON Properties](../search/search-request-params.html). +-- + +[%hardbreaks] +{blank} + +a¦ xref:QueryRequest[] + + + +|=== + + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-responses-before.adoc[opts=optional] + + +[#p-api-scoped-query-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The response object has a status section that must be checked for every request. Under nearly all circumstances, the query response will be HTTP 200 even though individual index shards (partitions) may encounter a timeout or return an error. +-- +a| xref:QueryResponse[] + + +| 0 +a| [markdown] +-- +The Search Service returns a non-200 HTTP error code when a request fails. +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-security-before.adoc[opts=optional] + + +[#p-api-scoped-query-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-manage[] + +|=== + + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}p-api-scoped-query/http-request.adoc[opts=optional] + + +include::{snippetDir}p-api-scoped-query/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/p-api-scoped-query/operation-after.adoc[opts=optional] + + +//end::p-api-scoped-query[] + + +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: 27 + +: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] +xref:DeleteIndexResponse[] +xref:DocumentAnalysis[] +xref:DocumentAnalysisItem[] +xref:DocumentAnalysisItemToken[] +xref:DocumentAnalysisItemTokenLocation[] +xref:DocumentCount[] +xref:GetIndexResponse[] +xref:GetIndexResponsePIndex[] +xref:GetIndexResponsePIndexNodesWrapper[] +xref:GetIndexResponsePIndexNodesWrapperNode[] +xref:GetIndexesResponse[] +xref:GetIndexesResponseIndexes[] +xref:GetIndexesResponseIndexesWrapper[] +xref:IndexDefinition[] +xref:IndexDefinitionPlanParams[] +xref:LookupRequest[] +xref:LookupResponse[] +xref:LookupResponsePartitions[] +xref:LookupResponsePartitionsID[] +xref:MgmtResponse[] +xref:PutIndexResponse[] +xref:QueryRequest[] +xref:QueryResponse[] +xref:StatsIndexResponse[] +xref:StatsNodeResponse[] +xref:StatsNodeResponseMgr[] +xref:StatusResponse[] +endif::[] + + + +// markup not found, no include::{specDir}definitions/DeleteIndexResponse/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#DeleteIndexResponse] += Delete Response + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/DeleteIndexResponse/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::DeleteIndexResponse[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the operation. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*uuid* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::DeleteIndexResponse[] + + + + +// markup not found, no include::{specDir}definitions/DeleteIndexResponse/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/DeleteIndexResponse/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/DocumentAnalysis/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#DocumentAnalysis] += Document Analysis + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/DocumentAnalysis/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::DocumentAnalysis[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the operation. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*analyzed* + +_optional_ +a¦ + +[markdown] +-- +An array of objects containing the analysis of the document. +-- + +[%hardbreaks] +{blank} +a¦ xref:DocumentAnalysisItem[] + array + +|=== + +//end::DocumentAnalysis[] + + + + +// markup not found, no include::{specDir}definitions/DocumentAnalysis/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/DocumentAnalysis/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/DocumentAnalysisItem/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#DocumentAnalysisItem] += Analysis Item + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/DocumentAnalysisItem/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::DocumentAnalysisItem[] + +ifdef::model-descriptions[] +//tag::desc-DocumentAnalysisItem[] +An object containing 1 or more search terms or tokens from the analyzed document. +//end::desc-DocumentAnalysisItem[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ + +_additional + +property_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-DocumentAnalysisItemToken, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:DocumentAnalysisItemToken[] + + +|=== + +//end::DocumentAnalysisItem[] + + + + +// markup not found, no include::{specDir}definitions/DocumentAnalysisItem/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/DocumentAnalysisItem/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/DocumentAnalysisItemToken/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#DocumentAnalysisItemToken] += Analysis Token + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/DocumentAnalysisItemToken/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::DocumentAnalysisItemToken[] + +ifdef::model-descriptions[] +//tag::desc-DocumentAnalysisItemToken[] +An object containing the analysis of a single search term or token from the analyzed document. +The name of the property is the search term or token. +//end::desc-DocumentAnalysisItemToken[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*Term* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*Locations* + +_optional_ +a¦ + +[markdown] +-- +An array of objects describing the locations of the search term or token in the document. +-- + +[%hardbreaks] +{blank} +a¦ xref:DocumentAnalysisItemTokenLocation[] + array + +|=== + +//end::DocumentAnalysisItemToken[] + + + + +// markup not found, no include::{specDir}definitions/DocumentAnalysisItemToken/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/DocumentAnalysisItemToken/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/DocumentAnalysisItemTokenLocation/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#DocumentAnalysisItemTokenLocation] += Analysis Token Location + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/DocumentAnalysisItemTokenLocation/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::DocumentAnalysisItemTokenLocation[] + +ifdef::model-descriptions[] +//tag::desc-DocumentAnalysisItemTokenLocation[] +An object describing the location of a single instance of the search term or token in the analyzed document. +//end::desc-DocumentAnalysisItemTokenLocation[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*Field* + +_optional_ +a¦ + +[markdown] +-- +The field in the document where the token was found. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*ArrayPositions* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Any Type + array + +a¦ +*Start* + +_optional_ +a¦ + +[markdown] +-- +The starting point of the token in the field. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*End* + +_optional_ +a¦ + +[markdown] +-- +The ending point of the token in the field. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*Position* + +_optional_ +a¦ + +[markdown] +-- +The position of the token in the field. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +|=== + +//end::DocumentAnalysisItemTokenLocation[] + + + + +// markup not found, no include::{specDir}definitions/DocumentAnalysisItemTokenLocation/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/DocumentAnalysisItemTokenLocation/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/DocumentCount/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#DocumentCount] += Document Count + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/DocumentCount/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::DocumentCount[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the operation. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*count* + +_optional_ +a¦ + +[markdown] +-- +The document count for the specified index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +|=== + +//end::DocumentCount[] + + + + +// markup not found, no include::{specDir}definitions/DocumentCount/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/DocumentCount/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponse/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#GetIndexResponse] += Index Response + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/GetIndexResponse/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::GetIndexResponse[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*indexDef* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-IndexDefinition, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:IndexDefinition[] + + +a¦ +*planPIndexes* + +_optional_ +a¦ + +[markdown] +-- +An array of objects, each containing information about a single Search index partition. +-- + +[%hardbreaks] +{blank} +a¦ xref:GetIndexResponsePIndex[] + array + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the operation. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*warnings* + +_optional_ +a¦ + +[markdown] +-- +An array of warnings. +-- + +[%hardbreaks] +{blank} +a¦ String + array + +|=== + +//end::GetIndexResponse[] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponse/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/GetIndexResponse/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#GetIndexResponsePIndex] += Plan Partition + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::GetIndexResponsePIndex[] + +ifdef::model-descriptions[] +//tag::desc-GetIndexResponsePIndex[] +An object containing information about a single Search index partition. +//end::desc-GetIndexResponsePIndex[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*indexName* + +_optional_ +a¦ + +[markdown] +-- +The name of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*indexParams* + +_optional_ +a¦ + +[markdown] +-- +The Search index's type identifier, type mappings, and analyzers. +For more information, see [Params Object](../search/search-index-params.html#params). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*indexType* + +_optional_ +a¦ + +[markdown] +-- +The type of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*indexUUID* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*name* + +_optional_ +a¦ + +[markdown] +-- +The name of the Search index partition. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*nodes* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapper, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:GetIndexResponsePIndexNodesWrapper[] + + +a¦ +*sourceName* + +_optional_ +a¦ + +[markdown] +-- +The name of the bucket where the Search index is stored. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceParams* + +_optional_ +a¦ + +[markdown] +-- +Advanced settings for Search index behavior. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*sourcePartitions* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceType* + +_optional_ +a¦ + +[markdown] +-- +The type of the bucket where the Search index is stored. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceUUID* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the bucket where the Search index is stored. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*uuid* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the Search index partition. +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::GetIndexResponsePIndex[] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#GetIndexResponsePIndexNodesWrapper] += Partition Nodes Wrapper + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::GetIndexResponsePIndexNodesWrapper[] + +ifdef::model-descriptions[] +//tag::desc-GetIndexResponsePIndexNodesWrapper[] +An object containing information about 1 or more Search index partition nodes. +//end::desc-GetIndexResponsePIndexNodesWrapper[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ + +_additional + +property_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapperNode, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:GetIndexResponsePIndexNodesWrapperNode[] + + +|=== + +//end::GetIndexResponsePIndexNodesWrapper[] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#GetIndexResponsePIndexNodesWrapperNode] += Partition Node + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::GetIndexResponsePIndexNodesWrapperNode[] + +ifdef::model-descriptions[] +//tag::desc-GetIndexResponsePIndexNodesWrapperNode[] +An object containing information about a single Search index partition node. +The name of the property is the node UUID. +//end::desc-GetIndexResponsePIndexNodesWrapperNode[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*canRead* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*canWrite* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*priority* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +|=== + +//end::GetIndexResponsePIndexNodesWrapperNode[] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/GetIndexesResponse/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#GetIndexesResponse] += Indexes Response + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/GetIndexesResponse/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::GetIndexesResponse[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*indexDefs* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-GetIndexesResponseIndexes, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:GetIndexesResponseIndexes[] + + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the operation. +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::GetIndexesResponse[] + + + + +// markup not found, no include::{specDir}definitions/GetIndexesResponse/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/GetIndexesResponse/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexes/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#GetIndexesResponseIndexes] += Index Definitions + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexes/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::GetIndexesResponseIndexes[] + +ifdef::model-descriptions[] +//tag::desc-GetIndexesResponseIndexes[] +An object containing Search index definitions and related information. +//end::desc-GetIndexesResponseIndexes[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*implVersion* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*indexDefs* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-GetIndexesResponseIndexesWrapper, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:GetIndexesResponseIndexesWrapper[] + + +a¦ +*uuid* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::GetIndexesResponseIndexes[] + + + + +// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexes/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexes/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#GetIndexesResponseIndexesWrapper] += Index Definitions Wrapper + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::GetIndexesResponseIndexesWrapper[] + +ifdef::model-descriptions[] +//tag::desc-GetIndexesResponseIndexesWrapper[] +An object containing 1 or more Search index definitions. +//end::desc-GetIndexesResponseIndexesWrapper[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ + +_additional + +property_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-IndexDefinition, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:IndexDefinition[] + + +|=== + +//end::GetIndexesResponseIndexesWrapper[] + + + + +// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/IndexDefinition/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#IndexDefinition] += Index Definition + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/IndexDefinition/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::IndexDefinition[] + +ifdef::model-descriptions[] +//tag::desc-IndexDefinition[] +The full Search index definition. +For a detailed list of all parameters, see [Search Index JSON Properties](../search/search-index-params.html). +//end::desc-IndexDefinition[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*name* + +_required_ +a¦ + +[markdown] +-- +The name of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*type* + +_required_ +a¦ + +[markdown] +-- +The type of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceName* + +_required_ +a¦ + +[markdown] +-- +The name of the bucket where the Search index is stored. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceUUID* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the bucket where the Search index is stored. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceParams* + +_optional_ +a¦ + +[markdown] +-- +Advanced settings for Search index behavior. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*sourceType* + +_required_ +a¦ + +[markdown] +-- +The type of the bucket where the Search index is stored. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*params* + +_required_ +a¦ + +[markdown] +-- +The Search index's type identifier, type mappings, and analyzers. +For more information, see [Params Object](../search/search-index-params.html#params). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*planParams* + +_required_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-IndexDefinitionPlanParams, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:IndexDefinitionPlanParams[] + + +a¦ +*prevIndexUUID* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the previous index. +Intended for clients that want to check that they are not overwriting the Search index definition updates of concurrent clients. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*uuid* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::IndexDefinition[] + + + + +// markup not found, no include::{specDir}definitions/IndexDefinition/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/IndexDefinition/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#IndexDefinitionPlanParams] += Plan Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::IndexDefinitionPlanParams[] + +ifdef::model-descriptions[] +//tag::desc-IndexDefinitionPlanParams[] +The Search index's partitioning and replication settings. +For more information, see [Plan Params Object](../search/search-index-params.html#planParams). +//end::desc-IndexDefinitionPlanParams[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*hierarchyRules* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*maxPartitionsPerPIndex* + +_optional_ +a¦ + +[markdown] +-- +This setting is deprecated. +Use `indexPartitions` instead. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*indexPartitions* + +_optional_ +a¦ + +[markdown] +-- +The number of partitions to split the Search index into, across the nodes you have available in your database with the Search Service enabled. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*nodePlanParams* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*numReplicas* + +_optional_ +a¦ + +[markdown] +-- +The number of replicas the Search Service creates for the Search index to ensure high availability. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*planFrozen* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +|=== + +//end::IndexDefinitionPlanParams[] + + + + +// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/LookupRequest/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#LookupRequest] += Lookup Request + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/LookupRequest/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::LookupRequest[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*docID* + +_optional_ +a¦ + +[markdown] +-- +The document ID to look up in the Search index. +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::LookupRequest[] + + + + +// markup not found, no include::{specDir}definitions/LookupRequest/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/LookupRequest/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/LookupResponse/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#LookupResponse] += Lookup Response + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/LookupResponse/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::LookupResponse[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the operation. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*pindexes* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-LookupResponsePartitions, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:LookupResponsePartitions[] + + +|=== + +//end::LookupResponse[] + + + + +// markup not found, no include::{specDir}definitions/LookupResponse/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/LookupResponse/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/LookupResponsePartitions/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#LookupResponsePartitions] += Lookup Partition Wrapper + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/LookupResponsePartitions/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::LookupResponsePartitions[] + +ifdef::model-descriptions[] +//tag::desc-LookupResponsePartitions[] +An object containing information about 1 or more Search index partitions. +//end::desc-LookupResponsePartitions[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ + +_additional + +property_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-LookupResponsePartitionsID, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:LookupResponsePartitionsID[] + + +|=== + +//end::LookupResponsePartitions[] + + + + +// markup not found, no include::{specDir}definitions/LookupResponsePartitions/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/LookupResponsePartitions/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/LookupResponsePartitionsID/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#LookupResponsePartitionsID] += Lookup Partition + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/LookupResponsePartitionsID/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::LookupResponsePartitionsID[] + +ifdef::model-descriptions[] +//tag::desc-LookupResponsePartitionsID[] +An object containing information about a single Search index partition. +The name of the property is the Search index partition name. +//end::desc-LookupResponsePartitionsID[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*id* + +_optional_ +a¦ + +[markdown] +-- +The Search index partition ID. +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::LookupResponsePartitionsID[] + + + + +// markup not found, no include::{specDir}definitions/LookupResponsePartitionsID/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/LookupResponsePartitionsID/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/MgmtResponse/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#MgmtResponse] += Management Response + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/MgmtResponse/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::MgmtResponse[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the operation. +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::MgmtResponse[] + + + + +// markup not found, no include::{specDir}definitions/MgmtResponse/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/MgmtResponse/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/PutIndexResponse/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#PutIndexResponse] += Create or Update Response + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/PutIndexResponse/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::PutIndexResponse[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the operation. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*name* + +_optional_ +a¦ + +[markdown] +-- +The name of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*uuid* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::PutIndexResponse[] + + + + +// markup not found, no include::{specDir}definitions/PutIndexResponse/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/PutIndexResponse/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/QueryRequest/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#QueryRequest] += Query Request + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/QueryRequest/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::QueryRequest[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*query* + +_optional_ +a¦ + +[markdown] +-- +An object that contains the properties for one of the supported query types. +For more information, see [Query Object](../search/search-request-params.html#query-object). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*knn* + +_optional_ +a¦ + +[markdown] +-- +An array that contains objects that describe a Vector Search query. +For more information, see [Knn Objects](../search/search-request-params.html#knn-object). +-- + +[%hardbreaks] +{blank} +a¦ Object + array + +a¦ +*ctl* + +_optional_ +a¦ + +[markdown] +-- +An object that contains properties for query consistency. +For more information, see [Ctl Object](../search/search-request-params.html#ctl). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*size* + +_optional_ +a¦ + +[markdown] +-- +Set the total number of results to return for a single page of search results. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*from* + +_optional_ +a¦ + +[markdown] +-- +Set an offset value to change where pagination starts for search results. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*highlight* + +_optional_ +a¦ + +[markdown] +-- +Contains properties to control search result highlighting. +For more information, see [Highlight Objects](../search/search-request-params.html#highlight). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*fields* + +_optional_ +a¦ + +[markdown] +-- +An array of strings to specify each indexed field you want to return in search results. +-- + +[%hardbreaks] +{blank} +a¦ String + array + +a¦ +*facets* + +_optional_ +a¦ + +[markdown] +-- +Contains nested objects to define each facet you want to return with search results. +For more information, see [Facet Objects](../search/search-request-params.html#facet-name). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*explain* + +_optional_ +a¦ + +[markdown] +-- +Whether to create an explanation for a search result's score in search results. +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*sort* + +_optional_ +a¦ + +[markdown] +-- +Contains an array of strings or JSON objects to set how to sort search results. +For more information, see [Sort Object](../search/search-request-params.html#sort). +-- + +[%hardbreaks] +{blank} +a¦ Any Type + array + +a¦ +*includeLocations* + +_optional_ +a¦ + +[markdown] +-- +Whether to return the position of each occurrence of a search term inside a document. +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*score* + +_optional_ +a¦ + +[markdown] +-- +Whether to include document relevancy scoring in search results. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*search_after* + +_optional_ +a¦ + +[markdown] +-- +Use to control pagination in search results. +-- + +[%hardbreaks] +{blank} +a¦ String + array + +a¦ +*search_before* + +_optional_ +a¦ + +[markdown] +-- +Use to control pagination in search results. +-- + +[%hardbreaks] +{blank} +a¦ String + array + +a¦ +*collections* + +_optional_ +a¦ + +[markdown] +-- +An array of strings that specify the collections where you want to run the query. +-- + +[%hardbreaks] +{blank} +a¦ String + array + +|=== + +//end::QueryRequest[] + + + + +// markup not found, no include::{specDir}definitions/QueryRequest/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/QueryRequest/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/QueryResponse/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#QueryResponse] += Query Response + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/QueryResponse/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::QueryResponse[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the operation. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*results* + +_optional_ +a¦ + +[markdown] +-- +The results of the Search query. +-- + +[%hardbreaks] +{blank} +a¦ Object + array + +|=== + +//end::QueryResponse[] + + + + +// markup not found, no include::{specDir}definitions/QueryResponse/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/QueryResponse/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/StatsIndexResponse/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#StatsIndexResponse] += Index Statistics + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/StatsIndexResponse/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::StatsIndexResponse[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*feeds* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*pindexes* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Object + + +|=== + +//end::StatsIndexResponse[] + + + + +// markup not found, no include::{specDir}definitions/StatsIndexResponse/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/StatsIndexResponse/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/StatsNodeResponse/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#StatsNodeResponse] += Node Statistics + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/StatsNodeResponse/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::StatsNodeResponse[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*feeds* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*manager* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-StatsNodeResponseMgr, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:StatsNodeResponseMgr[] + + +a¦ +*pindexes* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Object + + +|=== + +//end::StatsNodeResponse[] + + + + +// markup not found, no include::{specDir}definitions/StatsNodeResponse/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/StatsNodeResponse/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/StatsNodeResponseMgr/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#StatsNodeResponseMgr] += Manager Statistics + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/StatsNodeResponseMgr/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::StatsNodeResponseMgr[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*TotCreateIndex* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotDeleteIndex* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotUpdateIndex* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBatchIntro* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBatchIntroFail* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBatchUpdate* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBatchUpdateFail* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBatchDelete* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBatchDeleteFail* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBatchGet* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBleveDestStart* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBleveDestStop* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBleveDestRemove* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBleveDestUpdate* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBleveDestUpdateFail* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBleveDestIntro* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBleveDestIntroFail* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBleveDestBatch* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBleveDestBatchFail* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBleveDestDelete* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBleveDestDeleteFail* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBleveDestClose* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotBleveDestCloseFail* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotQuery* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*TotQueryFail* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +|=== + +//end::StatsNodeResponseMgr[] + + + + +// markup not found, no include::{specDir}definitions/StatsNodeResponseMgr/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/StatsNodeResponseMgr/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/StatusResponse/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#StatusResponse] += Status Response + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/StatusResponse/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::StatusResponse[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the operation. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*indexStatus* + +_optional_ +a¦ + +[markdown] +-- +The status of the Search index. +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::StatusResponse[] + + + + +// markup not found, no include::{specDir}definitions/StatusResponse/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/StatusResponse/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/Manage/security-scheme-before.adoc[opts=optional] + + +[[security-manage]] += Manage + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Manage/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +You must have the **Search Admin** role, with `cluster.bucket[$BUCKET_NAME].fts!manage` permissions on the required bucket. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/Manage/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/Manage/security-scheme-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}security/Statistics/security-scheme-before.adoc[opts=optional] + + +[[security-statistics]] += Statistics + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Statistics/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +You must have the **Search Admin** role, with `cluster.bucket[$BUCKET_NAME].stats!read` permissions on the required bucket. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/Statistics/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/Statistics/security-scheme-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}security/Read/security-scheme-before.adoc[opts=optional] + + +[[security-read]] += Read + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Read/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +You must have the **Search Reader** or **Search Admin** role, with `cluster.bucket[$BUCKET_NAME].fts!read` permissions on the required bucket. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/Read/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/Read/security-scheme-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}security/Write/security-scheme-before.adoc[opts=optional] + + +[[security-write]] += Write + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Write/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +You must have the **Search Admin** role, with `cluster.bucket[$BUCKET_NAME].fts!write` permissions on the required bucket. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/Write/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/Write/security-scheme-after.adoc[opts=optional] + + + + +include::{specDir}security/document-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] + + diff --git a/docs/modules/fts-rest-indexing/partials/header-attributes.adoc b/docs/modules/fts-rest-indexing/partials/header-attributes.adoc new file mode 100644 index 00000000..3125c4db --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/header-attributes.adoc @@ -0,0 +1,6 @@ +:page-meta-robots: noindex +:page-embargo: EMBARGOED +:page-partial: +:!example-caption: +:description: The Search Indexing REST API is provided by the Search Service. \ +This API enables you to manage and monitor your Search indexes. diff --git a/docs/modules/fts-rest-indexing/partials/overview/document-before.adoc b/docs/modules/fts-rest-indexing/partials/overview/document-before.adoc new file mode 100644 index 00000000..1fb78375 --- /dev/null +++ b/docs/modules/fts-rest-indexing/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/fts-rest-indexing/partials/paths/d-api-index-name/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/d-api-index-name/http-response.adoc new file mode 100644 index 00000000..08be0a1b --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/d-api-index-name/http-response.adoc @@ -0,0 +1,17 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$d-api-index-name-200.json[] +---- +==== + +==== +.Failure Response +[source,json] +---- +include::example$d-api-index-name-default.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/d-api-index-name/operation-description-end.adoc b/docs/modules/fts-rest-indexing/partials/paths/d-api-index-name/operation-description-end.adoc new file mode 100644 index 00000000..271a4840 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/d-api-index-name/operation-description-end.adoc @@ -0,0 +1,2 @@ +NOTE: This endpoint is for legacy Search indexes and may be deprecated in a future release. +Use <> instead. \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/d-api-scoped-index-name/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/d-api-scoped-index-name/http-response.adoc new file mode 100644 index 00000000..f759ea82 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/d-api-scoped-index-name/http-response.adoc @@ -0,0 +1,17 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$d-api-scoped-index-name-200.json[] +---- +==== + +==== +.Failure Response +[source,json] +---- +include::example$d-api-scoped-index-name-default.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/g-api-index-name-count/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/g-api-index-name-count/http-response.adoc new file mode 100644 index 00000000..cd70782e --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/g-api-index-name-count/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$g-api-index-name-count.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/g-api-index-name/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/g-api-index-name/http-response.adoc new file mode 100644 index 00000000..709a3e8d --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/g-api-index-name/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$g-api-index-name.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/g-api-index-name/operation-description-end.adoc b/docs/modules/fts-rest-indexing/partials/paths/g-api-index-name/operation-description-end.adoc new file mode 100644 index 00000000..fa9c62f0 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/g-api-index-name/operation-description-end.adoc @@ -0,0 +1,2 @@ +NOTE: This endpoint is for legacy Search indexes and may be deprecated in a future release. +Use <> instead. \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/g-api-index/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/g-api-index/http-response.adoc new file mode 100644 index 00000000..33a36899 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/g-api-index/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$g-api-index.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/g-api-index/operation-description-end.adoc b/docs/modules/fts-rest-indexing/partials/paths/g-api-index/operation-description-end.adoc new file mode 100644 index 00000000..6552a579 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/g-api-index/operation-description-end.adoc @@ -0,0 +1,2 @@ +NOTE: This endpoint is for legacy Search indexes and may be deprecated in a future release. +Use <> instead. \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-index-name/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-index-name/http-response.adoc new file mode 100644 index 00000000..4a1bb595 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-index-name/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Sample Response for a Vector Search index +[source,json] +---- +include::example$fts-sample-index-def-response.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-indexes/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-indexes/http-response.adoc new file mode 100644 index 00000000..72895fe8 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-indexes/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$g-api-scoped-indexes.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-status/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-status/http-response.adoc new file mode 100644 index 00000000..95f9ad34 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-status/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$g-api-scoped-status.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/g-api-stats-index-name-analyzeDoc/http-request.adoc b/docs/modules/fts-rest-indexing/partials/paths/g-api-stats-index-name-analyzeDoc/http-request.adoc new file mode 100644 index 00000000..87b5caad --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/g-api-stats-index-name-analyzeDoc/http-request.adoc @@ -0,0 +1,9 @@ += Example Request Body + +[#ex-g-api-stats-index-name-analyzeDoc] +==== +[source,json] +---- +include::example$g-api-stats-index-name-analyzeDoc-body.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/g-api-stats-index-name-analyzeDoc/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/g-api-stats-index-name-analyzeDoc/http-response.adoc new file mode 100644 index 00000000..d431e728 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/g-api-stats-index-name-analyzeDoc/http-response.adoc @@ -0,0 +1,15 @@ += Example HTTP Response + +The following example shows the result of analyzing the document from the <> using a Search index with the following settings: + +* A `keyword` analyzer for the `title` field. + +* An `ngram` token filter with a `min` of 2 and a `max` of 5 for the `name` field. + +==== +.Response 200 +[source,json] +---- +include::example$g-api-stats-index-name-analyzeDoc-200.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/g-api-stats-index-name/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/g-api-stats-index-name/http-response.adoc new file mode 100644 index 00000000..0e51e503 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/g-api-stats-index-name/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$g-api-stats-index-name.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/g-api-stats/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/g-api-stats/http-response.adoc new file mode 100644 index 00000000..5036eb30 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/g-api-stats/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$g-api-stats.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-ingestcontrol/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-ingestcontrol/http-response.adoc new file mode 100644 index 00000000..4991e439 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-ingestcontrol/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$response-200.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-ingestcontrol/operation-description-end.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-ingestcontrol/operation-description-end.adoc new file mode 100644 index 00000000..b12f5c5e --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-ingestcontrol/operation-description-end.adoc @@ -0,0 +1,2 @@ +NOTE: This endpoint is for legacy Search indexes and may be deprecated in a future release. +Use <> instead. \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-planfreezecontrol/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-planfreezecontrol/http-response.adoc new file mode 100644 index 00000000..4991e439 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-planfreezecontrol/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$response-200.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-planfreezecontrol/operation-description-end.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-planfreezecontrol/operation-description-end.adoc new file mode 100644 index 00000000..3340e661 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-planfreezecontrol/operation-description-end.adoc @@ -0,0 +1,2 @@ +NOTE: This endpoint is for legacy Search indexes and may be deprecated in a future release. +Use <> instead. \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-querycontrol/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-querycontrol/http-response.adoc new file mode 100644 index 00000000..4991e439 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-querycontrol/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$response-200.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-querycontrol/operation-description-end.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-querycontrol/operation-description-end.adoc new file mode 100644 index 00000000..ed59ae59 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-querycontrol/operation-description-end.adoc @@ -0,0 +1,2 @@ +NOTE: This endpoint is for legacy Search indexes and may be deprecated in a future release. +Use <> instead. \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name-query/http-request.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name-query/http-request.adoc new file mode 100644 index 00000000..dbe0d26c --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name-query/http-request.adoc @@ -0,0 +1,31 @@ += Example Request Body + +The following request body searches for the text a sample query in the documents included in the Search index. + +==== +[source,json] +---- +include::example$p-api-index-name-query-regular.json[] +---- +==== + +The following request body uses from/size for results paging, uses `ctl` for a timeout and the `"at_plus"` consistency level. +On consistency, the index must have incorporated at least mutation sequence-number 123 for partition (vbucket) 0 and mutation sequence-number 234 for partition (vbucket) 1, where vbucket 1 should have a `vbucketUUID` of `a0b1c2`. + +==== +[source,json] +---- +include::example$p-api-index-name-query-options.json[] +---- +==== + +The following hybrid search request body searches for a specified normalized color vector in `colorvect_dot`, but uses regular query parameters to limit the `brightness` value of the returned color to the range of `70-80`: + +==== +[source,json] +---- +include::example$p-api-index-name-query-hybrid.json[] +---- +==== + +For more information about vector searches, see xref:vector-search:vector-search.adoc[]. \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name-query/operation-description-end.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name-query/operation-description-end.adoc new file mode 100644 index 00000000..28b483f1 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name-query/operation-description-end.adoc @@ -0,0 +1,2 @@ +NOTE: This endpoint is for legacy Search indexes and may be deprecated in a future release. +Use <> instead. \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name-query/operation-responses-after.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name-query/operation-responses-after.adoc new file mode 100644 index 00000000..dd79656d --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name-query/operation-responses-after.adoc @@ -0,0 +1,18 @@ += Consistency and Timeouts + +A query can specify a timeout value, a consistency requirement, or both. +This section explains how this affects the query behavior and how to handle the resulting query return values. + +* Logical first phase consistency wait -- if timeout in this period, get 416 error with message saying request could not be satisfied. + +* If consistency wait times out with 416, return value to client will indicate the sequence number range processed so the client will have an idea how far the processing got and has the option of retrying more intelligently. + +* In phase 2, you have the normal pindex timeout. +This will start whenever the first phase completes. +At this point, request will return 200 HTTP response code unless there is an internal server error. + +* Client must check response status, which will return any errors or timeouts for each pindex. +If the response includes the number of errors, and the client can determine whether they need the complete results or can continue as long as enough pindexes return to give a reasonable user experience. +Note that the query return status will be 200 even if all pindexes return errors so it's critical to check the response status and code accordingly. + +* If client sets timeout very low, e.g. 1ms, you may receive a 200 error with all timeouts instead of a consistency wait timeout. diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name/http-response.adoc new file mode 100644 index 00000000..1dcc20a8 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name/http-response.adoc @@ -0,0 +1,17 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$p-api-index-name-200.json[] +---- +==== + +==== +.Failure Response +[source,json] +---- +include::example$p-api-index-name-default.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name/operation-description-end.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name/operation-description-end.adoc new file mode 100644 index 00000000..861b84bd --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name/operation-description-end.adoc @@ -0,0 +1,2 @@ +NOTE: This endpoint is for legacy Search indexes and may be deprecated in a future release. +Use <> instead. \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-pindex-lookup/http-request.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-pindex-lookup/http-request.adoc new file mode 100644 index 00000000..3269fa47 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-pindex-lookup/http-request.adoc @@ -0,0 +1,8 @@ += Example Request Body + +==== +[source,json] +---- +include::example$p-api-pindex-lookup-body.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-pindex-lookup/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-pindex-lookup/http-response.adoc new file mode 100644 index 00000000..f64ec8fd --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-pindex-lookup/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$p-api-pindex-lookup-200.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-index-name/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-index-name/http-response.adoc new file mode 100644 index 00000000..b99e49aa --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-index-name/http-response.adoc @@ -0,0 +1,17 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$p-api-scoped-index-name-200.json[] +---- +==== + +==== +.Failure Response +[source,json] +---- +include::example$p-api-scoped-index-name-default.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-ingestcontrol/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-ingestcontrol/http-response.adoc new file mode 100644 index 00000000..4991e439 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-ingestcontrol/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$response-200.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-planfreezecontrol/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-planfreezecontrol/http-response.adoc new file mode 100644 index 00000000..4991e439 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-planfreezecontrol/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$response-200.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-query/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-query/http-response.adoc new file mode 100644 index 00000000..a7d72313 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-query/http-response.adoc @@ -0,0 +1,25 @@ += Example HTTP Response + +==== +.Failure Response +[source,json] +---- +include::example$p-api-scoped-query-default.json[] +---- +==== + +==== +.Success Response for a Regular Query +[source,json] +---- +include::example$fts-sample-success-response.json[] +---- +==== + +==== +.Success Response for a Hybrid Query +[source,json] +---- +include::example$fts-sample-success-response-vector-search.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-querycontrol/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-querycontrol/http-response.adoc new file mode 100644 index 00000000..4991e439 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-querycontrol/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$response-200.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/security/document-begin.adoc b/docs/modules/fts-rest-indexing/partials/security/document-begin.adoc new file mode 100644 index 00000000..753b6c55 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/security/document-begin.adoc @@ -0,0 +1,2 @@ +The Search REST APIs support HTTP basic authentication. +Pass your credentials through HTTP headers. \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/partials/security/document-end.adoc b/docs/modules/fts-rest-indexing/partials/security/document-end.adoc new file mode 100644 index 00000000..5330f469 --- /dev/null +++ b/docs/modules/fts-rest-indexing/partials/security/document-end.adoc @@ -0,0 +1 @@ +For more information, see xref:learn:security/roles.adoc[]. \ No newline at end of file diff --git a/docs/modules/fts-rest-indexing/search-index.gradle b/docs/modules/fts-rest-indexing/search-index.gradle new file mode 100644 index 00000000..d1393807 --- /dev/null +++ b/docs/modules/fts-rest-indexing/search-index.gradle @@ -0,0 +1,23 @@ +apply plugin: 'org.openapi.generator' + +openApiGenerate { + generatorName = "asciidoc" + remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/morpheus/docs/spec/index/index.yaml" + outputDir = "${rootDir}/docs/modules/fts-rest-indexing/pages" + templateDir = "${rootDir}/templates" + gitRepoId = "cbft" + gitUserId = "couchbase" + additionalProperties = [ + specDir: "${rootDir}/docs/modules/fts-rest-indexing/partials/", + snippetDir: "${rootDir}/docs/modules/fts-rest-indexing/partials/paths/", + headerAttributes: "true", + useIntroduction: "true", + useTableTitles: "true", + skipExamples: "true", + legacyDiscriminatorBehavior: "true" + ] + globalProperties = [ + generateAliasAsModel: "true" + ] + generateAliasAsModel = true +} \ No newline at end of file diff --git a/docs/modules/fts-rest-manage/examples/file-xfer-200.json b/docs/modules/fts-rest-manage/examples/file-xfer-200.json new file mode 100644 index 00000000..b523aff9 --- /dev/null +++ b/docs/modules/fts-rest-manage/examples/file-xfer-200.json @@ -0,0 +1,3 @@ +{ + "status": "ok" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-manage/examples/file-xfer-405.json b/docs/modules/fts-rest-manage/examples/file-xfer-405.json new file mode 100644 index 00000000..6b2eef44 --- /dev/null +++ b/docs/modules/fts-rest-manage/examples/file-xfer-405.json @@ -0,0 +1,4 @@ +{ + "error": "Method not allowed for endpoint", + "status": "fail" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-manage/examples/file-xfer-disable.sh b/docs/modules/fts-rest-manage/examples/file-xfer-disable.sh new file mode 100644 index 00000000..634b8132 --- /dev/null +++ b/docs/modules/fts-rest-manage/examples/file-xfer-disable.sh @@ -0,0 +1,4 @@ +curl -X PUT http://$HOST:8094/api/managerOptions \ +-u $USER:$PASSWORD \ +-H "Content-type:application/json" \ +-d '{"disableFileTransferRebalance": "true" }' \ No newline at end of file diff --git a/docs/modules/fts-rest-manage/examples/file-xfer-enable.sh b/docs/modules/fts-rest-manage/examples/file-xfer-enable.sh new file mode 100644 index 00000000..027d4064 --- /dev/null +++ b/docs/modules/fts-rest-manage/examples/file-xfer-enable.sh @@ -0,0 +1,4 @@ +curl -X PUT http://$HOST:8094/api/managerOptions \ +-u $USER:$PASSWORD \ +-H "Content-type:application/json" \ +-d '{"disableFileTransferRebalance": "false" }' \ No newline at end of file diff --git a/docs/modules/fts-rest-manage/pages/index.adoc b/docs/modules/fts-rest-manage/pages/index.adoc new file mode 100644 index 00000000..938b06c4 --- /dev/null +++ b/docs/modules/fts-rest-manage/pages/index.adoc @@ -0,0 +1,585 @@ += Search Manager Options 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/cbft + +: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 Search Manager Options REST API is provided by the Search service. +This API enables you to set Search manager options; in particular, to configure rebalance based on file transfer. +-- + +[discrete#version] += Version information +[%hardbreaks] +__Version__ : 8.0 + +[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 Search Service. +-- + +[%hardbreaks] + +*Example:* `+++localhost+++` +// end + +a| *port* +a| [markdown] +-- +The Search Service REST port. Use `18094` for secure access. +-- + +[%hardbreaks] +*Values:* `8094`, `18094` +*Example:* `+++8094+++` +// 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: 1 + +: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] +xref:tag-Default[] +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Default] += Default +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:put_options[] + + +//tag::put_options[] + + +// markup not found, no include::{specDir}paths/put_options/operation-before.adoc[opts=optional] + + +[#put_options] += Modify Search Manager Options + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/put_options/operation-begin.adoc[opts=optional] + + +.... +PUT /api/managerOptions +.... + + + +// markup not found, no include::{specDir}paths/put_options/operation-description-before.adoc[opts=optional] + + +[#put_options-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/put_options/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Sets Search manager options. +Note that only one setting is available: `disableFileTransferRebalance`. +-- + + +include::{specDir}paths/put_options/operation-description-end.adoc[opts=optional] + + +[#put_options-consumes] +.Consumes +* application/json + +[#put_options-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/put_options/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/put_options/operation-parameters-before.adoc[opts=optional] + + +[#put_options-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/put_options/operation-parameters-begin.adoc[opts=optional] + + + + + + +[#put_options-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_optional_ +a¦ + + +[markdown] +-- +An object specifying Search manager options. +-- + +[%hardbreaks] +{blank} + +a¦ xref:Options[] + + + +|=== + + +// markup not found, no include::{specDir}paths/put_options/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/put_options/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/put_options/operation-responses-before.adoc[opts=optional] + + +[#put_options-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/put_options/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The operation was successful. +-- +a| xref:Response[] + + +| 401 +a| [markdown] +-- +Failure to authenticate. The user name or password may be incorrect. +-- +a| xref:Response[] + + +| 404 +a| [markdown] +-- +Object not found. The URL may be incorrectly specified. +-- +a| xref:Response[] + + +| 405 +a| [markdown] +-- +Method not allowed. The method may be incorrectly specified. +-- +a| xref:Response[] + + + +|=== + + +// markup not found, no include::{specDir}paths/put_options/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/put_options/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/put_options/operation-security-before.adoc[opts=optional] + + +[#put_options-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/put_options/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-default[] + +|=== + + +// markup not found, no include::{specDir}paths/put_options/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/put_options/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}put_options/http-request.adoc[opts=optional] + + +include::{snippetDir}put_options/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/put_options/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/put_options/operation-after.adoc[opts=optional] + + +//end::put_options[] + + +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: 2 + +: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] +xref:Options[] +xref:Response[] +endif::[] + + + +// markup not found, no include::{specDir}definitions/Options/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#Options] += Options + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/Options/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::Options[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*disableFileTransferRebalance* + +_optional_ +a¦ + +[markdown] +-- +If the value is `false` (the default), new Search Service partitions are created during rebalance by means of partition file transfer. + +If the value is `true`, partitions are created by means of partition build, from scratch, over DCP connections from the Data Service. +-- + +[%hardbreaks] +*Default:* `false` +{blank} +a¦ Boolean + + +|=== + +//end::Options[] + + + + +// markup not found, no include::{specDir}definitions/Options/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/Options/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/Response/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#Response] += Response + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/Response/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::Response[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*status* + +_required_ +a¦ + +[markdown] +-- +The status of the operation. + +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*error* + +_optional_ +a¦ + +[markdown] +-- +The error message, if the operation was not successful. + +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::Response[] + + + + +// markup not found, no include::{specDir}definitions/Response/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/Response/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/Default/security-scheme-before.adoc[opts=optional] + + +[[security-default]] += Default + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Default/security-scheme-begin.adoc[opts=optional] + + + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/Default/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/Default/security-scheme-after.adoc[opts=optional] + + + + +include::{specDir}security/document-end.adoc[opts=optional] + +:leveloffset: -1 + + + +include::{specDir}security/document-after.adoc[opts=optional] + + diff --git a/docs/modules/fts-rest-manage/partials/header-attributes.adoc b/docs/modules/fts-rest-manage/partials/header-attributes.adoc new file mode 100644 index 00000000..f1b232a9 --- /dev/null +++ b/docs/modules/fts-rest-manage/partials/header-attributes.adoc @@ -0,0 +1,6 @@ +:page-meta-robots: noindex +:page-embargo: EMBARGOED +:page-partial: +:!example-caption: +:description: The Search Manager Options REST API is provided by the Search Service. \ +This API enables you to set cluster-level Search settings; in particular, to configure rebalance based on file transfer. diff --git a/docs/modules/fts-rest-manage/partials/overview/document-before.adoc b/docs/modules/fts-rest-manage/partials/overview/document-before.adoc new file mode 100644 index 00000000..1fb78375 --- /dev/null +++ b/docs/modules/fts-rest-manage/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/fts-rest-manage/partials/overview/document-end.adoc b/docs/modules/fts-rest-manage/partials/overview/document-end.adoc new file mode 100644 index 00000000..cf347cd1 --- /dev/null +++ b/docs/modules/fts-rest-manage/partials/overview/document-end.adoc @@ -0,0 +1,8 @@ +[discrete] += Examples on this page + +In the HTTP request examples: + +* `$HOST` is the host name or IP address of a node running the Search Service. +* `$USER` is the user name of an authorized user -- see <>. +* `$PASSWORD` is the password to connect to Couchbase Server. \ No newline at end of file diff --git a/docs/modules/fts-rest-manage/partials/paths/put_options/http-request.adoc b/docs/modules/fts-rest-manage/partials/paths/put_options/http-request.adoc new file mode 100644 index 00000000..fc9ddab4 --- /dev/null +++ b/docs/modules/fts-rest-manage/partials/paths/put_options/http-request.adoc @@ -0,0 +1,25 @@ += Example HTTP Request + +The following example disables the creation of new partitions by means of file transfer. + +==== +.Curl request +[source,sh] +---- +include::example$file-xfer-disable.sh[] +---- +==== + +From this point, Search Service index partitions are built on the new nodes assigned to them during rebalance. + +The following example re-enables the creation of new partitions by means of file transfer: + +==== +.Curl request +[source,sh] +---- +include::example$file-xfer-enable.sh[] +---- +==== + +From this point, Search Service index partitions are again created by file transfer, on the new nodes assigned to them during rebalance. \ No newline at end of file diff --git a/docs/modules/fts-rest-manage/partials/paths/put_options/http-response.adoc b/docs/modules/fts-rest-manage/partials/paths/put_options/http-response.adoc new file mode 100644 index 00000000..dc975839 --- /dev/null +++ b/docs/modules/fts-rest-manage/partials/paths/put_options/http-response.adoc @@ -0,0 +1,17 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$file-xfer-200.json[] +---- +==== + +==== +.Response 405 +[source,json] +---- +include::example$file-xfer-405.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-manage/partials/paths/put_options/operation-description-end.adoc b/docs/modules/fts-rest-manage/partials/paths/put_options/operation-description-end.adoc new file mode 100644 index 00000000..50f79d94 --- /dev/null +++ b/docs/modules/fts-rest-manage/partials/paths/put_options/operation-description-end.adoc @@ -0,0 +1,8 @@ +The Search Service automatically partitions its indexes across all Search nodes in the cluster, ensuring optimal distribution, following rebalance. + +To achieve this, in versions of Couchbase Server prior to 7.1, by default, partitions needing to be newly created were entirely built, on their newly assigned nodes. +In 7.1+, by default, new partitions are created by the transfer of partition files from old nodes to new nodes: this significantly enhances performance. +This is an Enterprise-only feature, which requires all Search Service nodes either to be running 7.1 or later; or to be running 7.0.2, with the feature explicitly switched on by means of this endpoint. +Note that users of 7.1+ can explicitly switch the feature off by means of this endpoint; in which case partition build is used to establish new partitions, rather than file transfer. + +During file transfer, should an unresolvable error occur, file transfer is automatically abandoned, and partition build is used instead. diff --git a/docs/modules/fts-rest-manage/partials/security/document-after.adoc b/docs/modules/fts-rest-manage/partials/security/document-after.adoc new file mode 100644 index 00000000..1a1deca2 --- /dev/null +++ b/docs/modules/fts-rest-manage/partials/security/document-after.adoc @@ -0,0 +1,7 @@ += See Also + +* An overview of rebalance for all services is provided at xref:learn:clusters-and-availability/rebalance.adoc[Rebalance]. + +* An overview of the REST API for the Search Service is provided at xref:rest-api:rest-fts.adoc[Search API]. + +* An architectural summary of the Search Service is provided at xref:learn:services-and-indexes/services/search-service.adoc#search-service-architecture[Search Service Architecture]. \ No newline at end of file diff --git a/docs/modules/fts-rest-manage/partials/security/document-begin.adoc b/docs/modules/fts-rest-manage/partials/security/document-begin.adoc new file mode 100644 index 00000000..753b6c55 --- /dev/null +++ b/docs/modules/fts-rest-manage/partials/security/document-begin.adoc @@ -0,0 +1,2 @@ +The Search REST APIs support HTTP basic authentication. +Pass your credentials through HTTP headers. \ No newline at end of file diff --git a/docs/modules/fts-rest-manage/partials/security/document-end.adoc b/docs/modules/fts-rest-manage/partials/security/document-end.adoc new file mode 100644 index 00000000..5330f469 --- /dev/null +++ b/docs/modules/fts-rest-manage/partials/security/document-end.adoc @@ -0,0 +1 @@ +For more information, see xref:learn:security/roles.adoc[]. \ No newline at end of file diff --git a/src/query-service/query-service.gradle b/docs/modules/fts-rest-manage/search-manage.gradle similarity index 60% rename from src/query-service/query-service.gradle rename to docs/modules/fts-rest-manage/search-manage.gradle index 79acb27c..bfabdc60 100644 --- a/src/query-service/query-service.gradle +++ b/docs/modules/fts-rest-manage/search-manage.gradle @@ -2,14 +2,14 @@ apply plugin: 'org.openapi.generator' openApiGenerate { generatorName = "asciidoc" - inputSpec = file("swagger/query-service.yaml").getAbsolutePath().toString() - outputDir = "${rootDir}/docs/modules/n1ql-rest-query/pages" + remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/morpheus/docs/spec/manage/manage.yaml" + outputDir = "${rootDir}/docs/modules/fts-rest-manage/pages" templateDir = "${rootDir}/templates" - gitRepoId = "cb-swagger" + gitRepoId = "cbft" gitUserId = "couchbase" additionalProperties = [ - specDir: "${rootDir}/docs/modules/n1ql-rest-query/partials/", - snippetDir: "${rootDir}/docs/modules/n1ql-rest-query/partials/paths/", + specDir: "${rootDir}/docs/modules/fts-rest-manage/partials/", + snippetDir: "${rootDir}/docs/modules/fts-rest-manage/partials/paths/", headerAttributes: "true", useIntroduction: "true", useTableTitles: "true", diff --git a/docs/modules/fts-rest-nodes/examples/get-cluster-config.json b/docs/modules/fts-rest-nodes/examples/get-cluster-config.json new file mode 100644 index 00000000..f9dc868a --- /dev/null +++ b/docs/modules/fts-rest-nodes/examples/get-cluster-config.json @@ -0,0 +1,93 @@ +{ + "indexDefs": { + "implVersion": "4.0.0", + "indexDefs": { + "myFirstIndex": { + "name": "myFirstIndex", + "params": "", + "planParams": { + "hierarchyRules": null, + "maxPartitionsPerPIndex": 0, + "nodePlanParams": null, + "numReplicas": 0, + "planFrozen": false + }, + "sourceName": "", + "sourceParams": "", + "sourceType": "nil", + "sourceUUID": "", + "type": "blackhole", + "uuid": "6cc599ab7a85bf3b" + } + }, + "uuid": "6cc599ab7a85bf3b" + }, + "indexDefsCAS": 3, + "indexDefsErr": null, + "nodeDefsKnown": { + "implVersion": "4.0.0", + "nodeDefs": { + "78fc2ffac2fd9401": { + "container": "", + "extras": "", + "hostPort": "0.0.0.0:8094", + "implVersion": "4.0.0", + "tags": null, + "uuid": "78fc2ffac2fd9401", + "weight": 1 + } + }, + "uuid": "2f0d18fb750b2d4a" + }, + "nodeDefsKnownCAS": 1, + "nodeDefsKnownErr": null, + "nodeDefsWanted": { + "implVersion": "4.0.0", + "nodeDefs": { + "78fc2ffac2fd9401": { + "container": "", + "extras": "", + "hostPort": "0.0.0.0:8094", + "implVersion": "4.0.0", + "tags": null, + "uuid": "78fc2ffac2fd9401", + "weight": 1 + } + }, + "uuid": "72d6750878551451" + }, + "nodeDefsWantedCAS": 2, + "nodeDefsWantedErr": null, + "planPIndexes": { + "implVersion": "4.0.0", + "planPIndexes": { + "myFirstIndex_6cc599ab7a85bf3b_0": { + "indexName": "myFirstIndex", + "indexParams": "", + "indexType": "blackhole", + "indexUUID": "6cc599ab7a85bf3b", + "name": "myFirstIndex_6cc599ab7a85bf3b_0", + "nodes": { + "78fc2ffac2fd9401": { + "canRead": true, + "canWrite": true, + "priority": 0 + } + }, + "sourceName": "", + "sourceParams": "", + "sourcePartitions": "", + "sourceType": "nil", + "sourceUUID": "", + "uuid": "64bed6e2edf354c3" + } + }, + "uuid": "6327debf817a5ec7", + "warnings": { + "myFirstIndex": [] + } + }, + "planPIndexesCAS": 5, + "planPIndexesErr": null, + "status": "ok" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-nodes/examples/get-logs.json b/docs/modules/fts-rest-nodes/examples/get-logs.json new file mode 100644 index 00000000..88a3c95b --- /dev/null +++ b/docs/modules/fts-rest-nodes/examples/get-logs.json @@ -0,0 +1,4 @@ +{ + "events": [], + "messages": [] +} \ No newline at end of file diff --git a/docs/modules/fts-rest-nodes/examples/get-runtime-info.json b/docs/modules/fts-rest-nodes/examples/get-runtime-info.json new file mode 100644 index 00000000..0a33f3ee --- /dev/null +++ b/docs/modules/fts-rest-nodes/examples/get-runtime-info.json @@ -0,0 +1,13 @@ +{ + "arch": "amd64", + "go": { + "GOMAXPROCS": 1, + "GOROOT": "/usr/local/go", + "compiler": "gc", + "version": "go1.4" + }, + "numCPU": 8, + "os": "darwin", + "versionData": "4.0.0", + "versionMain": "v0.3.1" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-nodes/pages/index.adoc b/docs/modules/fts-rest-nodes/pages/index.adoc new file mode 100644 index 00000000..d27ac8f3 --- /dev/null +++ b/docs/modules/fts-rest-nodes/pages/index.adoc @@ -0,0 +1,4385 @@ += Couchbase Search Node 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/cbft + +: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 Search Node Configuration REST API is provided by the Search service. +This API enables you to manage and monitor your Search nodes. +-- + +[discrete#version] += Version information +[%hardbreaks] +__Version__ : 8.0 + +[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 Search Service. +-- + +[%hardbreaks] + +*Example:* `+++localhost+++` +// end + +a| *port* +a| [markdown] +-- +The Search Service REST port. Use `18094` for secure access. +-- + +[%hardbreaks] +*Values:* `8094`, `18094` +*Example:* `+++8094+++` +// end + +|=== + + +// markup not found, no 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: 4 + +: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] +xref:tag-Configuration[] +xref:tag-Diagnostics[] +xref:tag-Management[] +xref:tag-Monitoring[] +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Configuration] += Configuration +:leveloffset: +1 + +ifeval::["Operations for node configuration." != ""] +Operations for node configuration. +endif::[] +ifeval::["Operations for node configuration." == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:getClusterConfig[] +xref:managerKick[] +xref:managerMeta[] +xref:refreshClusterConfig[] + + +//tag::getClusterConfig[] + + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-before.adoc[opts=optional] + + +[#getClusterConfig] += Get Cluster Configuration + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-begin.adoc[opts=optional] + + +.... +GET /api/cfg +.... + + + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-description-before.adoc[opts=optional] + + +[#getClusterConfig-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns the node's current view of the cluster's configuration as JSON. +-- + + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-description-end.adoc[opts=optional] + + + +[#getClusterConfig-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-responses-before.adoc[opts=optional] + + +[#getClusterConfig-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing the node's configuration. +-- +a| xref:clusterConfig[] + + + +|=== + + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-security-before.adoc[opts=optional] + + +[#getClusterConfig-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-readClusterSettings[] + +|=== + + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}getClusterConfig/http-request.adoc[opts=optional] + + +include::{snippetDir}getClusterConfig/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getClusterConfig/operation-after.adoc[opts=optional] + + +//end::getClusterConfig[] + + +//tag::managerKick[] + + +// markup not found, no include::{specDir}paths/managerKick/operation-before.adoc[opts=optional] + + +[#managerKick] += Replan Resource Assignments + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/managerKick/operation-begin.adoc[opts=optional] + + +.... +POST /api/managerKick +.... + + + +// markup not found, no include::{specDir}paths/managerKick/operation-description-before.adoc[opts=optional] + + +[#managerKick-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/managerKick/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Forces the node to replan resource assignments, (by running the planner, if enabled) and update its runtime state to reflect the latest plan (by running the janitor, if enabled). +-- + + +// markup not found, no include::{specDir}paths/managerKick/operation-description-end.adoc[opts=optional] + + + + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/managerKick/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/managerKick/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/managerKick/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/managerKick/operation-responses-before.adoc[opts=optional] + + +[#managerKick-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/managerKick/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/managerKick/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/managerKick/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/managerKick/operation-security-before.adoc[opts=optional] + + +[#managerKick-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/managerKick/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-writeClusterSettings[] + +|=== + + +// markup not found, no include::{specDir}paths/managerKick/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/managerKick/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}managerKick/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}managerKick/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/managerKick/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/managerKick/operation-after.adoc[opts=optional] + + +//end::managerKick[] + + +//tag::managerMeta[] + + +// markup not found, no include::{specDir}paths/managerMeta/operation-before.adoc[opts=optional] + + +[#managerMeta] += Get Node Capabilities + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/managerMeta/operation-begin.adoc[opts=optional] + + +.... +GET /api/managerMeta +.... + + + +// markup not found, no include::{specDir}paths/managerMeta/operation-description-before.adoc[opts=optional] + + +[#managerMeta-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/managerMeta/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns information on the node's capabilities, including available indexing and storage options as JSON. +This operation is intended to help management tools and web UIs to be more dynamically metadata driven. +-- + + +// markup not found, no include::{specDir}paths/managerMeta/operation-description-end.adoc[opts=optional] + + + +[#managerMeta-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/managerMeta/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/managerMeta/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/managerMeta/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/managerMeta/operation-responses-before.adoc[opts=optional] + + +[#managerMeta-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/managerMeta/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing the node's capabilities. +-- +a| Object + + + +|=== + + +// markup not found, no include::{specDir}paths/managerMeta/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/managerMeta/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/managerMeta/operation-security-before.adoc[opts=optional] + + +[#managerMeta-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/managerMeta/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-writeClusterSettings[] + +|=== + + +// markup not found, no include::{specDir}paths/managerMeta/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/managerMeta/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}managerMeta/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}managerMeta/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/managerMeta/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/managerMeta/operation-after.adoc[opts=optional] + + +//end::managerMeta[] + + +//tag::refreshClusterConfig[] + + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-before.adoc[opts=optional] + + +[#refreshClusterConfig] += Refresh Node Configuration + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-begin.adoc[opts=optional] + + +.... +POST /api/cfgRefresh +.... + + + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-description-before.adoc[opts=optional] + + +[#refreshClusterConfig-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Requests the node to refresh its configuration from the configuration provider. +-- + + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-description-end.adoc[opts=optional] + + + + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-responses-before.adoc[opts=optional] + + +[#refreshClusterConfig-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-security-before.adoc[opts=optional] + + +[#refreshClusterConfig-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-writeClusterSettings[] + +|=== + + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}refreshClusterConfig/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}refreshClusterConfig/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/refreshClusterConfig/operation-after.adoc[opts=optional] + + +//end::refreshClusterConfig[] + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Diagnostics] += Diagnostics +:leveloffset: +1 + +ifeval::["Operations for node diagnostics." != ""] +Operations for node diagnostics. +endif::[] +ifeval::["Operations for node diagnostics." == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:captureCpuProfile[] +xref:captureMemoryProfile[] +xref:getDiagnostics[] +xref:getLogs[] +xref:getRuntimeArgs[] +xref:getRuntimeInfo[] + + +//tag::captureCpuProfile[] + + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-before.adoc[opts=optional] + + +[#captureCpuProfile] += Capture CPU Profiling Information + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-begin.adoc[opts=optional] + + +.... +POST /api/runtime/profile/cpu +.... + + + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-description-before.adoc[opts=optional] + + +[#captureCpuProfile-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Requests the node to capture local CPU usage profiling information. +-- + + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-description-end.adoc[opts=optional] + + + + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-responses-before.adoc[opts=optional] + + +[#captureCpuProfile-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-security-before.adoc[opts=optional] + + +[#captureCpuProfile-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-manageCluster[] + +|=== + + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}captureCpuProfile/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}captureCpuProfile/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/captureCpuProfile/operation-after.adoc[opts=optional] + + +//end::captureCpuProfile[] + + +//tag::captureMemoryProfile[] + + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-before.adoc[opts=optional] + + +[#captureMemoryProfile] += Capture Memory Profiling Information + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-begin.adoc[opts=optional] + + +.... +POST /api/runtime/profile/memory +.... + + + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-description-before.adoc[opts=optional] + + +[#captureMemoryProfile-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Requests the node to capture local memory usage profiling information. +-- + + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-description-end.adoc[opts=optional] + + + + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-responses-before.adoc[opts=optional] + + +[#captureMemoryProfile-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-security-before.adoc[opts=optional] + + +[#captureMemoryProfile-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-manageCluster[] + +|=== + + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}captureMemoryProfile/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}captureMemoryProfile/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/captureMemoryProfile/operation-after.adoc[opts=optional] + + +//end::captureMemoryProfile[] + + +//tag::getDiagnostics[] + + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-before.adoc[opts=optional] + + +[#getDiagnostics] += Get Diagnostics + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-begin.adoc[opts=optional] + + +.... +GET /api/diag +.... + + + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-description-before.adoc[opts=optional] + + +[#getDiagnostics-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns the full set of diagnostic information from the node as JSON. +The response is the union of the responses from the node's other REST API diagnostic and monitoring endpoints. + +For example, for a 3 node cluster, you could capture diagnostics for each node with something like: + +```shell +curl http://cbft-01:8094/api/diag > cbft-01.json +curl http://cbft-02:8094/api/diag > cbft-02.json +curl http://cbft-03:8094/api/diag > cbft-03.json +``` + +The response JSON object can be quite large, 100s of KB or much more. + +The motivation for this operation is to simplify working with the Couchbase community, forums, technical support, and other engineers, by making data capture from each Search node a single step. +-- + + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-description-end.adoc[opts=optional] + + + +[#getDiagnostics-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-responses-before.adoc[opts=optional] + + +[#getDiagnostics-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing the node's diagnostics. +-- +a| Object + + + +|=== + + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-security-before.adoc[opts=optional] + + +[#getDiagnostics-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-readClusterLogs[] + +|=== + + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}getDiagnostics/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}getDiagnostics/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getDiagnostics/operation-after.adoc[opts=optional] + + +//end::getDiagnostics[] + + +//tag::getLogs[] + + +// markup not found, no include::{specDir}paths/getLogs/operation-before.adoc[opts=optional] + + +[#getLogs] += Get Node Logs + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getLogs/operation-begin.adoc[opts=optional] + + +.... +GET /api/log +.... + + + +// markup not found, no include::{specDir}paths/getLogs/operation-description-before.adoc[opts=optional] + + +[#getLogs-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getLogs/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns recent log messages and key events for the node as JSON. +-- + + +// markup not found, no include::{specDir}paths/getLogs/operation-description-end.adoc[opts=optional] + + + +[#getLogs-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getLogs/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getLogs/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/getLogs/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getLogs/operation-responses-before.adoc[opts=optional] + + +[#getLogs-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getLogs/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing the node's logs. +-- +a| xref:logInfo[] + + + +|=== + + +// markup not found, no include::{specDir}paths/getLogs/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/getLogs/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getLogs/operation-security-before.adoc[opts=optional] + + +[#getLogs-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getLogs/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-readClusterLogs[] + +|=== + + +// markup not found, no include::{specDir}paths/getLogs/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getLogs/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}getLogs/http-request.adoc[opts=optional] + + +include::{snippetDir}getLogs/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getLogs/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getLogs/operation-after.adoc[opts=optional] + + +//end::getLogs[] + + +//tag::getRuntimeArgs[] + + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-before.adoc[opts=optional] + + +[#getRuntimeArgs] += Get Node Runtime Arguments + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-begin.adoc[opts=optional] + + +.... +GET /api/runtime/args +.... + + + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-description-before.adoc[opts=optional] + + +[#getRuntimeArgs-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns information on the node's command-line, parameters, environment variables, and OS process values as JSON. +-- + + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-description-end.adoc[opts=optional] + + + +[#getRuntimeArgs-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-responses-before.adoc[opts=optional] + + +[#getRuntimeArgs-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing the node's runtime arguments. +-- +a| Object + + + +|=== + + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-security-before.adoc[opts=optional] + + +[#getRuntimeArgs-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-readClusterSettings[] + +|=== + + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}getRuntimeArgs/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}getRuntimeArgs/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getRuntimeArgs/operation-after.adoc[opts=optional] + + +//end::getRuntimeArgs[] + + +//tag::getRuntimeInfo[] + + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-before.adoc[opts=optional] + + +[#getRuntimeInfo] += Get Node Runtime Information + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-begin.adoc[opts=optional] + + +.... +GET /api/runtime +.... + + + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-description-before.adoc[opts=optional] + + +[#getRuntimeInfo-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns information on the node's software, such as version strings and slow-changing runtime settings, as JSON. +-- + + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-description-end.adoc[opts=optional] + + + +[#getRuntimeInfo-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-responses-before.adoc[opts=optional] + + +[#getRuntimeInfo-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing the node's runtime information. +-- +a| xref:runtimeInfo[] + + + +|=== + + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-security-before.adoc[opts=optional] + + +[#getRuntimeInfo-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-readClusterSettings[] + +|=== + + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}getRuntimeInfo/http-request.adoc[opts=optional] + + +include::{snippetDir}getRuntimeInfo/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getRuntimeInfo/operation-after.adoc[opts=optional] + + +//end::getRuntimeInfo[] + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Management] += Management +:leveloffset: +1 + +ifeval::["Operations for node management." != ""] +Operations for node management. +endif::[] +ifeval::["Operations for node management." == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:performGC[] + + +//tag::performGC[] + + +// markup not found, no include::{specDir}paths/performGC/operation-before.adoc[opts=optional] + + +[#performGC] += Perform Garbage Collection + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/performGC/operation-begin.adoc[opts=optional] + + +.... +POST /api/runtime/gc +.... + + + +// markup not found, no include::{specDir}paths/performGC/operation-description-before.adoc[opts=optional] + + +[#performGC-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/performGC/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Requests the node to perform a garbage collection. +-- + + +// markup not found, no include::{specDir}paths/performGC/operation-description-end.adoc[opts=optional] + + + + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/performGC/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/performGC/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/performGC/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/performGC/operation-responses-before.adoc[opts=optional] + + +[#performGC-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/performGC/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/performGC/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/performGC/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/performGC/operation-security-before.adoc[opts=optional] + + +[#performGC-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/performGC/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-manageCluster[] + +|=== + + +// markup not found, no include::{specDir}paths/performGC/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/performGC/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}performGC/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}performGC/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/performGC/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/performGC/operation-after.adoc[opts=optional] + + +//end::performGC[] + + +ifeval::[{count-apis} > 1] +:leveloffset: -1 +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Monitoring] += Monitoring +:leveloffset: +1 + +ifeval::["Operations for node monitoring." != ""] +Operations for node monitoring. +endif::[] +ifeval::["Operations for node monitoring." == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:getMemoryStats[] +xref:getRuntimeStats[] + + +//tag::getMemoryStats[] + + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-before.adoc[opts=optional] + + +[#getMemoryStats] += Get Memory Statistics + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-begin.adoc[opts=optional] + + +.... +GET /api/runtime/statsMem +.... + + + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-description-before.adoc[opts=optional] + + +[#getMemoryStats-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns information on the node's low-level garbage collection and memory-related runtime stats as JSON. +-- + + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-description-end.adoc[opts=optional] + + + +[#getMemoryStats-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-responses-before.adoc[opts=optional] + + +[#getMemoryStats-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing the node's memory statistics. +-- +a| Object + + + +|=== + + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-security-before.adoc[opts=optional] + + +[#getMemoryStats-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-manageCluster[] + +|=== + + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}getMemoryStats/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}getMemoryStats/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getMemoryStats/operation-after.adoc[opts=optional] + + +//end::getMemoryStats[] + + +//tag::getRuntimeStats[] + + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-before.adoc[opts=optional] + + +[#getRuntimeStats] += Get Runtime Statistics + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-begin.adoc[opts=optional] + + +.... +GET /api/runtime/stats +.... + + + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-description-before.adoc[opts=optional] + + +[#getRuntimeStats-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns information on the node's low-level runtime stats as JSON. +-- + + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-description-end.adoc[opts=optional] + + + +[#getRuntimeStats-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-responses-before.adoc[opts=optional] + + +[#getRuntimeStats-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A JSON object containing the node's low-level runtime statistics. +-- +a| Object + + + +|=== + + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-security-before.adoc[opts=optional] + + +[#getRuntimeStats-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-manageCluster[] + +|=== + + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}getRuntimeStats/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}getRuntimeStats/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/getRuntimeStats/operation-after.adoc[opts=optional] + + +//end::getRuntimeStats[] + + +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: 19 + +: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] +xref:clusterConfig[] +xref:clusterConfigIndexes[] +xref:clusterConfigNodesKnown[] +xref:clusterConfigNodesWanted[] +xref:clusterConfigNodesWrapper[] +xref:clusterConfigNodesWrapperNode[] +xref:clusterConfigPlan[] +xref:clusterConfigPlanWrapper[] +xref:GetIndexResponsePIndex[] +xref:GetIndexResponsePIndexNodesWrapper[] +xref:GetIndexResponsePIndexNodesWrapperNode[] +xref:GetIndexResponsePlanWrng[] +xref:GetIndexResponsePlanWrngIndex[] +xref:GetIndexesResponseIndexesWrapper[] +xref:IndexDefinition[] +xref:IndexDefinitionPlanParams[] +xref:logInfo[] +xref:runtimeInfo[] +xref:runtimeInfoGo[] +endif::[] + + + +// markup not found, no include::{specDir}definitions/clusterConfig/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#clusterConfig] += Cluster Configuration + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/clusterConfig/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::clusterConfig[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*indexDefs* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-clusterConfigIndexes, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:clusterConfigIndexes[] + + +a¦ +*indexDefsCAS* + +_optional_ +a¦ + +[markdown] +-- +Search index definition concurrency (compare and swap) value. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*indexDefsErr* + +_optional_ +a¦ + +[markdown] +-- +Search index definition error. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*nodeDefsKnown* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-clusterConfigNodesKnown, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:clusterConfigNodesKnown[] + + +a¦ +*nodeDefsKnownCAS* + +_optional_ +a¦ + +[markdown] +-- +Known node definition concurrency (compare and swap) value. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*nodeDefsKnownErr* + +_optional_ +a¦ + +[markdown] +-- +Known node definition error. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*nodeDefsWanted* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-clusterConfigNodesWanted, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:clusterConfigNodesWanted[] + + +a¦ +*nodeDefsWantedCAS* + +_optional_ +a¦ + +[markdown] +-- +Wanted node definition concurrency (compare and swap) value. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*nodeDefsWantedErr* + +_optional_ +a¦ + +[markdown] +-- +Wanted node definition error. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*planPIndexes* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-clusterConfigPlan, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:clusterConfigPlan[] + + +a¦ +*planPIndexesCAS* + +_optional_ +a¦ + +[markdown] +-- +Search index partition concurrency (compare and swap) value. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*planPIndexesErr* + +_optional_ +a¦ + +[markdown] +-- +Search index partition error. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the operation. +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::clusterConfig[] + + + + +// markup not found, no include::{specDir}definitions/clusterConfig/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/clusterConfig/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/clusterConfigIndexes/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#clusterConfigIndexes] += Index Definitions + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/clusterConfigIndexes/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::clusterConfigIndexes[] + +ifdef::model-descriptions[] +//tag::desc-clusterConfigIndexes[] +An object containing Search index definitions and related information. +//end::desc-clusterConfigIndexes[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*implVersion* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*indexDefs* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-GetIndexesResponseIndexesWrapper, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:GetIndexesResponseIndexesWrapper[] + + +|=== + +//end::clusterConfigIndexes[] + + + + +// markup not found, no include::{specDir}definitions/clusterConfigIndexes/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/clusterConfigIndexes/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/clusterConfigNodesKnown/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#clusterConfigNodesKnown] += Known Nodes + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/clusterConfigNodesKnown/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::clusterConfigNodesKnown[] + +ifdef::model-descriptions[] +//tag::desc-clusterConfigNodesKnown[] +An object containing known node definitions and related information. +//end::desc-clusterConfigNodesKnown[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*implVersion* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*nodeDefs* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-clusterConfigNodesWrapper, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:clusterConfigNodesWrapper[] + + +a¦ +*uuid* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::clusterConfigNodesKnown[] + + + + +// markup not found, no include::{specDir}definitions/clusterConfigNodesKnown/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/clusterConfigNodesKnown/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/clusterConfigNodesWanted/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#clusterConfigNodesWanted] += Wanted Nodes + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/clusterConfigNodesWanted/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::clusterConfigNodesWanted[] + +ifdef::model-descriptions[] +//tag::desc-clusterConfigNodesWanted[] +An object containing wanted node definitions and related information. +//end::desc-clusterConfigNodesWanted[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*implVersion* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*nodeDefs* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-clusterConfigNodesWrapper, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:clusterConfigNodesWrapper[] + + +a¦ +*uuid* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::clusterConfigNodesWanted[] + + + + +// markup not found, no include::{specDir}definitions/clusterConfigNodesWanted/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/clusterConfigNodesWanted/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapper/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#clusterConfigNodesWrapper] += Node Definitions Wrapper + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapper/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::clusterConfigNodesWrapper[] + +ifdef::model-descriptions[] +//tag::desc-clusterConfigNodesWrapper[] +An object containing the definitions of 1 or more nodes. +//end::desc-clusterConfigNodesWrapper[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ + +_additional + +property_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-clusterConfigNodesWrapperNode, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:clusterConfigNodesWrapperNode[] + + +|=== + +//end::clusterConfigNodesWrapper[] + + + + +// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapper/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapper/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapperNode/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#clusterConfigNodesWrapperNode] += Node Definition + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapperNode/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::clusterConfigNodesWrapperNode[] + +ifdef::model-descriptions[] +//tag::desc-clusterConfigNodesWrapperNode[] +An object containing the definition of a single node. +The name of the property is the UUID of the node. +//end::desc-clusterConfigNodesWrapperNode[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*container* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*extras* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*hostPort* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*implVersion* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*tags* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*uuid* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*weight* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +|=== + +//end::clusterConfigNodesWrapperNode[] + + + + +// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapperNode/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/clusterConfigNodesWrapperNode/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/clusterConfigPlan/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#clusterConfigPlan] += Plan Partitions + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/clusterConfigPlan/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::clusterConfigPlan[] + +ifdef::model-descriptions[] +//tag::desc-clusterConfigPlan[] +An object containing Search index partitions and related information. +//end::desc-clusterConfigPlan[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*implVersion* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*planPIndexes* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-clusterConfigPlanWrapper, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:clusterConfigPlanWrapper[] + + +a¦ +*uuid* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*warnings* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-GetIndexResponsePlanWrng, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:GetIndexResponsePlanWrng[] + + +|=== + +//end::clusterConfigPlan[] + + + + +// markup not found, no include::{specDir}definitions/clusterConfigPlan/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/clusterConfigPlan/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/clusterConfigPlanWrapper/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#clusterConfigPlanWrapper] += Plan Partitions Wrapper + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/clusterConfigPlanWrapper/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::clusterConfigPlanWrapper[] + +ifdef::model-descriptions[] +//tag::desc-clusterConfigPlanWrapper[] +An object containing information about 1 or more Search index partitions. +//end::desc-clusterConfigPlanWrapper[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ + +_additional + +property_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-GetIndexResponsePIndex, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:GetIndexResponsePIndex[] + + +|=== + +//end::clusterConfigPlanWrapper[] + + + + +// markup not found, no include::{specDir}definitions/clusterConfigPlanWrapper/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/clusterConfigPlanWrapper/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#GetIndexResponsePIndex] += Plan Partition + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::GetIndexResponsePIndex[] + +ifdef::model-descriptions[] +//tag::desc-GetIndexResponsePIndex[] +An object containing information about a single Search index partition. +//end::desc-GetIndexResponsePIndex[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*indexName* + +_optional_ +a¦ + +[markdown] +-- +The name of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*indexParams* + +_optional_ +a¦ + +[markdown] +-- +The Search index's type identifier, type mappings, and analyzers. +For more information, see [Params Object](../search/search-index-params.html#params). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*indexType* + +_optional_ +a¦ + +[markdown] +-- +The type of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*indexUUID* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*name* + +_optional_ +a¦ + +[markdown] +-- +The name of the Search index partition. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*nodes* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapper, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:GetIndexResponsePIndexNodesWrapper[] + + +a¦ +*sourceName* + +_optional_ +a¦ + +[markdown] +-- +The name of the bucket where the Search index is stored. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceParams* + +_optional_ +a¦ + +[markdown] +-- +Advanced settings for Search index behavior. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*sourcePartitions* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceType* + +_optional_ +a¦ + +[markdown] +-- +The type of the bucket where the Search index is stored. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceUUID* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the bucket where the Search index is stored. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*uuid* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the Search index partition. +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::GetIndexResponsePIndex[] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndex/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#GetIndexResponsePIndexNodesWrapper] += Partition Nodes Wrapper + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::GetIndexResponsePIndexNodesWrapper[] + +ifdef::model-descriptions[] +//tag::desc-GetIndexResponsePIndexNodesWrapper[] +An object containing information about 1 or more Search index partition nodes. +//end::desc-GetIndexResponsePIndexNodesWrapper[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ + +_additional + +property_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-GetIndexResponsePIndexNodesWrapperNode, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:GetIndexResponsePIndexNodesWrapperNode[] + + +|=== + +//end::GetIndexResponsePIndexNodesWrapper[] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapper/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#GetIndexResponsePIndexNodesWrapperNode] += Partition Node + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::GetIndexResponsePIndexNodesWrapperNode[] + +ifdef::model-descriptions[] +//tag::desc-GetIndexResponsePIndexNodesWrapperNode[] +An object containing information about a single Search index partition node. +The name of the property is the node UUID. +//end::desc-GetIndexResponsePIndexNodesWrapperNode[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*canRead* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*canWrite* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +a¦ +*priority* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +|=== + +//end::GetIndexResponsePIndexNodesWrapperNode[] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePIndexNodesWrapperNode/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrng/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#GetIndexResponsePlanWrng] += Plan Warnings Wrapper + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrng/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::GetIndexResponsePlanWrng[] + +ifdef::model-descriptions[] +//tag::desc-GetIndexResponsePlanWrng[] +An object containing 0, 1, or more nested objects, each containing warnings that apply to a Search index. +//end::desc-GetIndexResponsePlanWrng[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ + +_additional + +property_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-GetIndexResponsePlanWrngIndex, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:GetIndexResponsePlanWrngIndex[] + + +|=== + +//end::GetIndexResponsePlanWrng[] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrng/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrng/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrngIndex/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#GetIndexResponsePlanWrngIndex] += Plan Warnings + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrngIndex/definition-begin.adoc[opts=optional] + + +.icon:brackets[fw] Array +{blank} + + + +[markdown] +-- +An array of warnings. +The name of the property is the name of the Search index. +-- + +[%hardbreaks] +{blank} + +.Schema +String + array + + +// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrngIndex/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/GetIndexResponsePlanWrngIndex/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#GetIndexesResponseIndexesWrapper] += Index Definitions Wrapper + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::GetIndexesResponseIndexesWrapper[] + +ifdef::model-descriptions[] +//tag::desc-GetIndexesResponseIndexesWrapper[] +An object containing 1 or more Search index definitions. +//end::desc-GetIndexesResponseIndexesWrapper[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ + +_additional + +property_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-IndexDefinition, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:IndexDefinition[] + + +|=== + +//end::GetIndexesResponseIndexesWrapper[] + + + + +// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/GetIndexesResponseIndexesWrapper/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/IndexDefinition/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#IndexDefinition] += Index Definition + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/IndexDefinition/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::IndexDefinition[] + +ifdef::model-descriptions[] +//tag::desc-IndexDefinition[] +The full Search index definition. +For a detailed list of all parameters, see [Search Index JSON Properties](../search/search-index-params.html). +//end::desc-IndexDefinition[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*name* + +_required_ +a¦ + +[markdown] +-- +The name of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*type* + +_required_ +a¦ + +[markdown] +-- +The type of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceName* + +_required_ +a¦ + +[markdown] +-- +The name of the bucket where the Search index is stored. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceUUID* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the bucket where the Search index is stored. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*sourceParams* + +_optional_ +a¦ + +[markdown] +-- +Advanced settings for Search index behavior. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*sourceType* + +_required_ +a¦ + +[markdown] +-- +The type of the bucket where the Search index is stored. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*params* + +_required_ +a¦ + +[markdown] +-- +The Search index's type identifier, type mappings, and analyzers. +For more information, see [Params Object](../search/search-index-params.html#params). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*planParams* + +_required_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-IndexDefinitionPlanParams, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:IndexDefinitionPlanParams[] + + +a¦ +*prevIndexUUID* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the previous index. +Intended for clients that want to check that they are not overwriting the Search index definition updates of concurrent clients. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*uuid* + +_optional_ +a¦ + +[markdown] +-- +The UUID of the Search index. +For more information, see [Initial Settings](../search/search-index-params.html#initial). +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::IndexDefinition[] + + + + +// markup not found, no include::{specDir}definitions/IndexDefinition/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/IndexDefinition/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#IndexDefinitionPlanParams] += Plan Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::IndexDefinitionPlanParams[] + +ifdef::model-descriptions[] +//tag::desc-IndexDefinitionPlanParams[] +The Search index's partitioning and replication settings. +For more information, see [Plan Params Object](../search/search-index-params.html#planParams). +//end::desc-IndexDefinitionPlanParams[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*hierarchyRules* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*maxPartitionsPerPIndex* + +_optional_ +a¦ + +[markdown] +-- +This setting is deprecated. +Use `indexPartitions` instead. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*indexPartitions* + +_optional_ +a¦ + +[markdown] +-- +The number of partitions to split the Search index into, across the nodes you have available in your database with the Search Service enabled. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*nodePlanParams* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*numReplicas* + +_optional_ +a¦ + +[markdown] +-- +The number of replicas the Search Service creates for the Search index to ensure high availability. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*planFrozen* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Boolean + + +|=== + +//end::IndexDefinitionPlanParams[] + + + + +// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/IndexDefinitionPlanParams/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/logInfo/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#logInfo] += Log Messages + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/logInfo/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::logInfo[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*events* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Object + array + +a¦ +*messages* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Object + array + +|=== + +//end::logInfo[] + + + + +// markup not found, no include::{specDir}definitions/logInfo/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/logInfo/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/runtimeInfo/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#runtimeInfo] += Runtime Information + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/runtimeInfo/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::runtimeInfo[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*arch* + +_optional_ +a¦ + +[markdown] +-- +The architecture of the node. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*go* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-runtimeInfoGo, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:runtimeInfoGo[] + + +a¦ +*numCPU* + +_optional_ +a¦ + +[markdown] +-- +The number of CPUs on the node. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*os* + +_optional_ +a¦ + +[markdown] +-- +The operating system of the node. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*versionData* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*versionMain* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::runtimeInfo[] + + + + +// markup not found, no include::{specDir}definitions/runtimeInfo/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/runtimeInfo/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/runtimeInfoGo/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#runtimeInfoGo] += Go Runtime Information + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/runtimeInfoGo/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::runtimeInfoGo[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*GOMAXPROCS* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*GOROOT* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*compiler* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*version* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::runtimeInfoGo[] + + + + +// markup not found, no include::{specDir}definitions/runtimeInfoGo/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/runtimeInfoGo/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/manageCluster/security-scheme-before.adoc[opts=optional] + + +[[security-manageCluster]] += Manage Cluster + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/manageCluster/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +You must have the **Full Admin** or **Cluster Admin** role, with permissions to manage the cluster. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/manageCluster/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/manageCluster/security-scheme-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}security/readClusterSettings/security-scheme-before.adoc[opts=optional] + + +[[security-readClusterSettings]] += Read Cluster Settings + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/readClusterSettings/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +You must have the **Full Admin** or **Cluster Admin** role, with permission to read cluster settings. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/readClusterSettings/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/readClusterSettings/security-scheme-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}security/readClusterLogs/security-scheme-before.adoc[opts=optional] + + +[[security-readClusterLogs]] += Read Cluster Logs + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/readClusterLogs/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +You must have the **Full Admin** or **Cluster Admin** role, with permission to read cluster logs. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/readClusterLogs/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/readClusterLogs/security-scheme-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}security/writeClusterSettings/security-scheme-before.adoc[opts=optional] + + +[[security-writeClusterSettings]] += Write Cluster Settings + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/writeClusterSettings/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +You must have the **Full Admin** or **Cluster Admin** role, with permission to write cluster settings. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/writeClusterSettings/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/writeClusterSettings/security-scheme-after.adoc[opts=optional] + + + + +include::{specDir}security/document-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] + + diff --git a/docs/modules/fts-rest-nodes/partials/header-attributes.adoc b/docs/modules/fts-rest-nodes/partials/header-attributes.adoc new file mode 100644 index 00000000..7985d13b --- /dev/null +++ b/docs/modules/fts-rest-nodes/partials/header-attributes.adoc @@ -0,0 +1,6 @@ +:page-meta-robots: noindex +:page-embargo: EMBARGOED +:page-partial: +:!example-caption: +:description: The Search Node Configuration REST API is provided by the Search Service. \ +This API enables you to manage and monitor your Search nodes. diff --git a/docs/modules/fts-rest-nodes/partials/overview/document-before.adoc b/docs/modules/fts-rest-nodes/partials/overview/document-before.adoc new file mode 100644 index 00000000..42c96154 --- /dev/null +++ b/docs/modules/fts-rest-nodes/partials/overview/document-before.adoc @@ -0,0 +1,86 @@ +// 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/fts-rest-nodes/partials/paths/getClusterConfig/http-response.adoc b/docs/modules/fts-rest-nodes/partials/paths/getClusterConfig/http-response.adoc new file mode 100644 index 00000000..0b8f4088 --- /dev/null +++ b/docs/modules/fts-rest-nodes/partials/paths/getClusterConfig/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$get-cluster-config.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-nodes/partials/paths/getLogs/http-response.adoc b/docs/modules/fts-rest-nodes/partials/paths/getLogs/http-response.adoc new file mode 100644 index 00000000..c5c42008 --- /dev/null +++ b/docs/modules/fts-rest-nodes/partials/paths/getLogs/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$get-logs.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-nodes/partials/paths/getRuntimeInfo/http-response.adoc b/docs/modules/fts-rest-nodes/partials/paths/getRuntimeInfo/http-response.adoc new file mode 100644 index 00000000..6e854227 --- /dev/null +++ b/docs/modules/fts-rest-nodes/partials/paths/getRuntimeInfo/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$get-runtime-info.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-nodes/partials/security/document-begin.adoc b/docs/modules/fts-rest-nodes/partials/security/document-begin.adoc new file mode 100644 index 00000000..753b6c55 --- /dev/null +++ b/docs/modules/fts-rest-nodes/partials/security/document-begin.adoc @@ -0,0 +1,2 @@ +The Search REST APIs support HTTP basic authentication. +Pass your credentials through HTTP headers. \ No newline at end of file diff --git a/docs/modules/fts-rest-nodes/partials/security/document-end.adoc b/docs/modules/fts-rest-nodes/partials/security/document-end.adoc new file mode 100644 index 00000000..5330f469 --- /dev/null +++ b/docs/modules/fts-rest-nodes/partials/security/document-end.adoc @@ -0,0 +1 @@ +For more information, see xref:learn:security/roles.adoc[]. \ No newline at end of file diff --git a/docs/modules/fts-rest-nodes/search-nodes.gradle b/docs/modules/fts-rest-nodes/search-nodes.gradle new file mode 100644 index 00000000..0c35536b --- /dev/null +++ b/docs/modules/fts-rest-nodes/search-nodes.gradle @@ -0,0 +1,23 @@ +apply plugin: 'org.openapi.generator' + +openApiGenerate { + generatorName = "asciidoc" + remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/morpheus/docs/spec/nodes/nodes.yaml" + outputDir = "${rootDir}/docs/modules/fts-rest-nodes/pages" + templateDir = "${rootDir}/templates" + gitRepoId = "cbft" + gitUserId = "couchbase" + additionalProperties = [ + specDir: "${rootDir}/docs/modules/fts-rest-nodes/partials/", + snippetDir: "${rootDir}/docs/modules/fts-rest-nodes/partials/paths/", + headerAttributes: "true", + useIntroduction: "true", + useTableTitles: "true", + skipExamples: "true", + legacyDiscriminatorBehavior: "true" + ] + globalProperties = [ + generateAliasAsModel: "true" + ] + generateAliasAsModel = true +} \ No newline at end of file diff --git a/docs/modules/fts-rest-query/examples/api-query-all.json b/docs/modules/fts-rest-query/examples/api-query-all.json new file mode 100644 index 00000000..9fc70cce --- /dev/null +++ b/docs/modules/fts-rest-query/examples/api-query-all.json @@ -0,0 +1,61 @@ +{ + "status": "ok", + "stats": { + "total": 3, + "successful": 3 + }, + "totalActiveQueryCount": 4, + "filteredActiveQueries": { + "queryCount": 4, + "queryMap": { + "b91d75480470f979f65f04e8f20a1f7b-17": { + "QueryContext": { + "query": { + "query": "good restaurants in france" + }, + "size": 10, + "from": 0, + "timeout": 120000, + "index": "DemoIndex1" + }, + "executionTime": "2.144802122s" + }, + "b91d75480470f979f65f04e8f20a1f7b-18": { + "QueryContext": { + "query": { + "query": "decent hotel with a pool in italy" + }, + "size": 10, + "from": 0, + "timeout": 120000, + "index": "DemoIndex2" + }, + "executionTime": "2.144712787s" + }, + "b91d75480470f979f65f04e8f20a1f7b-19": { + "QueryContext": { + "query": { + "query": "germany" + }, + "size": 10, + "from": 0, + "timeout": 120000, + "index": "DemoIndex2" + }, + "executionTime": "2.143957727s" + }, + "f76b2d51397feee28c1e757ed426ef93-3": { + "QueryContext": { + "query": { + "query": "mexican food in england" + }, + "size": 10, + "from": 0, + "timeout": 120000, + "index": "DemoIndex1" + }, + "executionTime": "2.14286421s" + } + } + } +} \ No newline at end of file diff --git a/docs/modules/fts-rest-query/examples/api-query-all.sh b/docs/modules/fts-rest-query/examples/api-query-all.sh new file mode 100644 index 00000000..b63ac1f0 --- /dev/null +++ b/docs/modules/fts-rest-query/examples/api-query-all.sh @@ -0,0 +1,3 @@ +curl -XGET -H "Content-Type: application/json" \ + -u $USER:$PASSWORD \ + "http://$HOST:8094/api/query" \ No newline at end of file diff --git a/docs/modules/fts-rest-query/examples/api-query-cancel.json b/docs/modules/fts-rest-query/examples/api-query-cancel.json new file mode 100644 index 00000000..2c8bc1af --- /dev/null +++ b/docs/modules/fts-rest-query/examples/api-query-cancel.json @@ -0,0 +1,4 @@ +{ + "status": "ok", + "msg": "query with ID '24' on node 'b91d75480470f979f65f04e8f20a1f7b' was aborted!" +} \ No newline at end of file diff --git a/docs/modules/fts-rest-query/examples/api-query-cancel.sh b/docs/modules/fts-rest-query/examples/api-query-cancel.sh new file mode 100644 index 00000000..d9e60060 --- /dev/null +++ b/docs/modules/fts-rest-query/examples/api-query-cancel.sh @@ -0,0 +1,3 @@ +curl -X POST -H "Content-Type: application/json" -u $USER:$PASSWORD \ + "http://$HOST:8094/api/query/24/cancel" -d \ + '{ "uuid": "b91d75480470f979f65f04e8f20a1f7b" }' \ No newline at end of file diff --git a/docs/modules/fts-rest-query/examples/api-query-filter.json b/docs/modules/fts-rest-query/examples/api-query-filter.json new file mode 100644 index 00000000..df72b7af --- /dev/null +++ b/docs/modules/fts-rest-query/examples/api-query-filter.json @@ -0,0 +1,26 @@ +{ + "status": "ok", + "stats": { + "total": 3, + "successful": 3 + }, + "totalActiveQueryCount": 3, + "filteredActiveQueries": { + "longerThan": "7s", + "queryCount": 1, + "queryMap": { + "b91d75480470f979f65f04e8f20a1f7b-21": { + "QueryContext": { + "query": { + "query": "decent hotel with a pool in italy" + }, + "size": 10, + "from": 0, + "timeout": 120000, + "index": "DemoIndex1" + }, + "executionTime": "10.541956741s" + } + } + } +} \ No newline at end of file diff --git a/docs/modules/fts-rest-query/examples/api-query-filter.sh b/docs/modules/fts-rest-query/examples/api-query-filter.sh new file mode 100644 index 00000000..8f9ac8b6 --- /dev/null +++ b/docs/modules/fts-rest-query/examples/api-query-filter.sh @@ -0,0 +1,3 @@ +curl -XGET -H "Content-Type: application/json" \ + -u $USER:$PASSWORD \ + "http://$HOST:8094/api/query?longerThan=7s" \ No newline at end of file diff --git a/docs/modules/fts-rest-query/examples/api-query-index.json b/docs/modules/fts-rest-query/examples/api-query-index.json new file mode 100644 index 00000000..2b1e8abe --- /dev/null +++ b/docs/modules/fts-rest-query/examples/api-query-index.json @@ -0,0 +1,39 @@ +{ + "status": "ok", + "stats": { + "total": 3, + "successful": 3 + }, + "totalActiveQueryCount": 4, + "filteredActiveQueries": { + "indexName": "DemoIndex1", + "longerThan": "1ms", + "queryCount": 2, + "queryMap": { + "b91d75480470f979f65f04e8f20a1f7b-16": { + "QueryContext": { + "query": { + "query": "good restaurants in france" + }, + "size": 10, + "from": 0, + "timeout": 120000, + "index": "DemoIndex1" + }, + "executionTime": "1.059754811s" + }, + "f76b2d51397feee28c1e757ed426ef93-2": { + "QueryContext": { + "query": { + "query": "mexican food in england" + }, + "size": 10, + "from": 0, + "timeout": 120000, + "index": "DemoIndex1" + }, + "executionTime": "1.058247896s" + } + } + } +} \ No newline at end of file diff --git a/docs/modules/fts-rest-query/examples/api-query-index.sh b/docs/modules/fts-rest-query/examples/api-query-index.sh new file mode 100644 index 00000000..d02f65cb --- /dev/null +++ b/docs/modules/fts-rest-query/examples/api-query-index.sh @@ -0,0 +1,3 @@ +curl -XGET -H "Content-Type: application/json" \ +-u $USER:$PASSWORD \ +"http://$HOST:8094/api/query/index/DemoIndex1?longerThan=1ms" \ No newline at end of file diff --git a/docs/modules/fts-rest-query/pages/index.adoc b/docs/modules/fts-rest-query/pages/index.adoc new file mode 100644 index 00000000..e501ec2f --- /dev/null +++ b/docs/modules/fts-rest-query/pages/index.adoc @@ -0,0 +1,1552 @@ += Couchbase Search Active Queries 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/cbft + +: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 Search Active Queries REST API is provided by the Search service. +This API enables you to get information about active Search queries. +-- + +[discrete#version] += Version information +[%hardbreaks] +__Version__ : 8.0 + +[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 Search Service. +-- + +[%hardbreaks] + +*Example:* `+++localhost+++` +// end + +a| *port* +a| [markdown] +-- +The Search Service REST port. Use `18094` for secure access. +-- + +[%hardbreaks] +*Values:* `8094`, `18094` +*Example:* `+++8094+++` +// 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: 1 + +: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] +xref:tag-Default[] +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Default] += Default +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:api-query[] +xref:api-query-cancel[] +xref:api-query-index[] + + +//tag::api-query[] + + +// markup not found, no include::{specDir}paths/api-query/operation-before.adoc[opts=optional] + + +[#api-query] += View Active Node Queries + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/api-query/operation-begin.adoc[opts=optional] + + +.... +GET /api/query +.... + + + +// markup not found, no include::{specDir}paths/api-query/operation-description-before.adoc[opts=optional] + + +[#api-query-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/api-query/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Gets the details of all the active queries in any Search node in a cluster. +-- + + +// markup not found, no include::{specDir}paths/api-query/operation-description-end.adoc[opts=optional] + + + +[#api-query-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/api-query/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/api-query/operation-parameters-before.adoc[opts=optional] + + +[#api-query-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/api-query/operation-parameters-begin.adoc[opts=optional] + + + +[#api-query-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *longerThan* + +_optional_ +a¦ + + +[markdown] +-- +Filters the queries running beyond the given span of time. + +The duration string is a signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as `20s`, `-1.5h` or `2h45m`. +Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. +-- + +[%hardbreaks] +{blank} + +a¦ String (duration) + + + +|=== + + + + + +// markup not found, no include::{specDir}paths/api-query/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/api-query/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/api-query/operation-responses-before.adoc[opts=optional] + + +[#api-query-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/api-query/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A list of all active Search queries across all nodes in the cluster. +-- +a| xref:ActiveResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/api-query/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/api-query/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/api-query/operation-security-before.adoc[opts=optional] + + +[#api-query-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/api-query/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-default[] + +|=== + + +// markup not found, no include::{specDir}paths/api-query/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/api-query/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}api-query/http-request.adoc[opts=optional] + + +include::{snippetDir}api-query/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/api-query/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/api-query/operation-after.adoc[opts=optional] + + +//end::api-query[] + + +//tag::api-query-cancel[] + + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-before.adoc[opts=optional] + + +[#api-query-cancel] += Cancel Active Queries + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-begin.adoc[opts=optional] + + +.... +POST /api/query/{queryID}/cancel +.... + + + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-description-before.adoc[opts=optional] + + +[#api-query-cancel-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Allows the user to cancel an active query that's running longer than expected. +Use the View Active Index Queries API or the View Active Node Queries API to get the parameters `queryID` and `uuid`, which are used to identify and cancel the query. +-- + + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-description-end.adoc[opts=optional] + + +[#api-query-cancel-consumes] +.Consumes +* application/json + +[#api-query-cancel-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-parameters-before.adoc[opts=optional] + + +[#api-query-cancel-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-parameters-begin.adoc[opts=optional] + + +[#api-query-cancel-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *queryID* + +_required_ +a¦ + + +[markdown] +-- +The ID of the active query. +This ID is used to identify the query that you want to cancel. +-- + +[%hardbreaks] +{blank} + +a¦ Integer + + + +|=== + + + + +[#api-query-cancel-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_optional_ +a¦ + + +[markdown] +-- +The body contains the UUID of the node where the query is running. This is optional and allows cancellation of queries on specific nodes. +-- + +[%hardbreaks] +{blank} + +a¦ xref:CancelRequest[] + + + +|=== + + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-responses-before.adoc[opts=optional] + + +[#api-query-cancel-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The query was successfully canceled. +-- +a| xref:CancelResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-security-before.adoc[opts=optional] + + +[#api-query-cancel-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-default[] + +|=== + + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}api-query-cancel/http-request.adoc[opts=optional] + + +include::{snippetDir}api-query-cancel/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/api-query-cancel/operation-after.adoc[opts=optional] + + +//end::api-query-cancel[] + + +//tag::api-query-index[] + + +// markup not found, no include::{specDir}paths/api-query-index/operation-before.adoc[opts=optional] + + +[#api-query-index] += View Active Index Queries + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/api-query-index/operation-begin.adoc[opts=optional] + + +.... +GET /api/query/index/{indexName} +.... + + + +// markup not found, no include::{specDir}paths/api-query-index/operation-description-before.adoc[opts=optional] + + +[#api-query-index-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/api-query-index/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Gets the details of all the active queries for any given Search index in the system. +-- + + +// markup not found, no include::{specDir}paths/api-query-index/operation-description-end.adoc[opts=optional] + + + +[#api-query-index-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/api-query-index/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/api-query-index/operation-parameters-before.adoc[opts=optional] + + +[#api-query-index-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/api-query-index/operation-parameters-begin.adoc[opts=optional] + + +[#api-query-index-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *indexName* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + +[#api-query-index-query] +.Query Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *longerThan* + +_optional_ +a¦ + + +[markdown] +-- +Filters the queries running beyond the given span of time. + +The duration string is a signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as `20s`, `-1.5h` or `2h45m`. +Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`. +-- + +[%hardbreaks] +{blank} + +a¦ String (duration) + + + +|=== + + + + + +// markup not found, no include::{specDir}paths/api-query-index/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/api-query-index/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/api-query-index/operation-responses-before.adoc[opts=optional] + + +[#api-query-index-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/api-query-index/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +A list of active queries for the specified Search index. +-- +a| xref:ActiveResponse[] + + + +|=== + + +// markup not found, no include::{specDir}paths/api-query-index/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/api-query-index/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/api-query-index/operation-security-before.adoc[opts=optional] + + +[#api-query-index-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/api-query-index/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-default[] + +|=== + + +// markup not found, no include::{specDir}paths/api-query-index/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/api-query-index/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}api-query-index/http-request.adoc[opts=optional] + + +include::{snippetDir}api-query-index/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/api-query-index/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/api-query-index/operation-after.adoc[opts=optional] + + +//end::api-query-index[] + + +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: 8 + +: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] +xref:ActiveResponse[] +xref:ActiveResponseFilter[] +xref:ActiveResponseFilterMap[] +xref:ActiveResponseFilterMapItem[] +xref:ActiveResponseFilterMapItemContext[] +xref:ActiveResponseStats[] +xref:CancelRequest[] +xref:CancelResponse[] +endif::[] + + + +// markup not found, no include::{specDir}definitions/ActiveResponse/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#ActiveResponse] += Active Response + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/ActiveResponse/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::ActiveResponse[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the request. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*stats* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-ActiveResponseStats, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:ActiveResponseStats[] + + +a¦ +*totalActiveQueryCount* + +_optional_ +a¦ + +[markdown] +-- +The total number of active queries. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*filteredActiveQueries* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-ActiveResponseFilter, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:ActiveResponseFilter[] + + +|=== + +//end::ActiveResponse[] + + + + +// markup not found, no include::{specDir}definitions/ActiveResponse/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/ActiveResponse/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/ActiveResponseFilter/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#ActiveResponseFilter] += Filtered Active Queries + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/ActiveResponseFilter/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::ActiveResponseFilter[] + +ifdef::model-descriptions[] +//tag::desc-ActiveResponseFilter[] +An object containing details of the filtered active queries. +//end::desc-ActiveResponseFilter[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*indexName* + +_optional_ +a¦ + +[markdown] +-- +The name of the Search index. +Only included if viewing active queries for a specific index. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*longerThan* + +_optional_ +a¦ + +[markdown] +-- +The duration used to filter the active queries. +Only included if the `longerThan` query parameter is used. +-- + +[%hardbreaks] +{blank} +a¦ String (duration) + + +a¦ +*queryCount* + +_optional_ +a¦ + +[markdown] +-- +The number of filtered active queries. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*queryMap* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-ActiveResponseFilterMap, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:ActiveResponseFilterMap[] + + +|=== + +//end::ActiveResponseFilter[] + + + + +// markup not found, no include::{specDir}definitions/ActiveResponseFilter/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/ActiveResponseFilter/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/ActiveResponseFilterMap/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#ActiveResponseFilterMap] += Query Map + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/ActiveResponseFilterMap/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::ActiveResponseFilterMap[] + +ifdef::model-descriptions[] +//tag::desc-ActiveResponseFilterMap[] +Contains 1 or more nested objects, each containing the details of a single active query. +//end::desc-ActiveResponseFilterMap[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ + +_additional + +property_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-ActiveResponseFilterMapItem, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:ActiveResponseFilterMapItem[] + + +|=== + +//end::ActiveResponseFilterMap[] + + + + +// markup not found, no include::{specDir}definitions/ActiveResponseFilterMap/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/ActiveResponseFilterMap/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItem/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#ActiveResponseFilterMapItem] += Query Map Item + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItem/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::ActiveResponseFilterMapItem[] + +ifdef::model-descriptions[] +//tag::desc-ActiveResponseFilterMapItem[] +The details of a single active query. +The name of the property is the UUID of the node on which the query is running, and the ID of the query on that node, separated by a hyphen. +//end::desc-ActiveResponseFilterMapItem[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*QueryContext* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-ActiveResponseFilterMapItemContext, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:ActiveResponseFilterMapItemContext[] + + +a¦ +*executionTime* + +_optional_ +a¦ + +[markdown] +-- +The time taken to execute the query. +-- + +[%hardbreaks] +{blank} +a¦ String (duration) + + +|=== + +//end::ActiveResponseFilterMapItem[] + + + + +// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItem/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItem/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItemContext/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#ActiveResponseFilterMapItemContext] += Query Context + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItemContext/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::ActiveResponseFilterMapItemContext[] + +ifdef::model-descriptions[] +//tag::desc-ActiveResponseFilterMapItemContext[] +The query context. +//end::desc-ActiveResponseFilterMapItemContext[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*query* + +_optional_ +a¦ + +[markdown] +-- +An object containing the Search query. +For more information, see [Search Request JSON Properties](../search/search-request-params.html). +-- + +[%hardbreaks] +{blank} +a¦ Object + + +a¦ +*size* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +*Example:* `10` +{blank} +a¦ Integer + + +a¦ +*from* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +*Example:* `0` +{blank} +a¦ Integer + + +a¦ +*timeout* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +*Example:* `120000` +{blank} +a¦ Integer + + +a¦ +*index* + +_optional_ +a¦ + +[markdown] +-- +The name of a Search index. +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::ActiveResponseFilterMapItemContext[] + + + + +// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItemContext/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/ActiveResponseFilterMapItemContext/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/ActiveResponseStats/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#ActiveResponseStats] += Stats + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/ActiveResponseStats/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::ActiveResponseStats[] + +ifdef::model-descriptions[] +//tag::desc-ActiveResponseStats[] +An object containing request statistics. +//end::desc-ActiveResponseStats[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*total* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +*Example:* `3` +{blank} +a¦ Integer + + +a¦ +*successful* + +_optional_ +a¦ + +[markdown] +-- +-- + +[%hardbreaks] +*Example:* `3` +{blank} +a¦ Integer + + +|=== + +//end::ActiveResponseStats[] + + + + +// markup not found, no include::{specDir}definitions/ActiveResponseStats/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/ActiveResponseStats/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/CancelRequest/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#CancelRequest] += Cancellation Request + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/CancelRequest/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::CancelRequest[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*uuid* + +_optional_ +a¦ + +[markdown] +-- +Represents the active query's coordinator node's UUID, where the query will be canceled. +This parameter allows the user to cancel a query anywhere in the system by specifying its coordinator node's UUID. +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::CancelRequest[] + + + + +// markup not found, no include::{specDir}definitions/CancelRequest/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/CancelRequest/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/CancelResponse/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#CancelResponse] += Cancellation Response + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/CancelResponse/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::CancelResponse[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*status* + +_optional_ +a¦ + +[markdown] +-- +The status of the request. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*msg* + +_optional_ +a¦ + +[markdown] +-- +The response message, giving details of the node UUID and query ID. +-- + +[%hardbreaks] +{blank} +a¦ String + + +|=== + +//end::CancelResponse[] + + + + +// markup not found, no include::{specDir}definitions/CancelResponse/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/CancelResponse/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/Default/security-scheme-before.adoc[opts=optional] + + +[[security-default]] += Default + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Default/security-scheme-begin.adoc[opts=optional] + + + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/Default/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/Default/security-scheme-after.adoc[opts=optional] + + + + +include::{specDir}security/document-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] + + diff --git a/docs/modules/fts-rest-query/partials/header-attributes.adoc b/docs/modules/fts-rest-query/partials/header-attributes.adoc new file mode 100644 index 00000000..e3cd6269 --- /dev/null +++ b/docs/modules/fts-rest-query/partials/header-attributes.adoc @@ -0,0 +1,6 @@ +:page-meta-robots: noindex +:page-embargo: EMBARGOED +:page-partial: +:!example-caption: +:description: The Search Active Queries REST API is provided by the Search Service. \ +This API enables you to get information about active Search queries. diff --git a/docs/modules/fts-rest-query/partials/overview/document-before.adoc b/docs/modules/fts-rest-query/partials/overview/document-before.adoc new file mode 100644 index 00000000..1fb78375 --- /dev/null +++ b/docs/modules/fts-rest-query/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/fts-rest-query/partials/overview/document-end.adoc b/docs/modules/fts-rest-query/partials/overview/document-end.adoc new file mode 100644 index 00000000..cf347cd1 --- /dev/null +++ b/docs/modules/fts-rest-query/partials/overview/document-end.adoc @@ -0,0 +1,8 @@ +[discrete] += Examples on this page + +In the HTTP request examples: + +* `$HOST` is the host name or IP address of a node running the Search Service. +* `$USER` is the user name of an authorized user -- see <>. +* `$PASSWORD` is the password to connect to Couchbase Server. \ No newline at end of file diff --git a/docs/modules/fts-rest-query/partials/paths/api-query-cancel/http-request.adoc b/docs/modules/fts-rest-query/partials/paths/api-query-cancel/http-request.adoc new file mode 100644 index 00000000..835d863d --- /dev/null +++ b/docs/modules/fts-rest-query/partials/paths/api-query-cancel/http-request.adoc @@ -0,0 +1,11 @@ += Example HTTP Request + +Request 4: Cancel a long running query with query ID `24` whose coordinator node has a uuid `b91d75480470f979f65f04e8f20a1f7b`. + +==== +.Curl request +[source,sh] +---- +include::example$api-query-cancel.sh[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-query/partials/paths/api-query-cancel/http-response.adoc b/docs/modules/fts-rest-query/partials/paths/api-query-cancel/http-response.adoc new file mode 100644 index 00000000..825a2b3a --- /dev/null +++ b/docs/modules/fts-rest-query/partials/paths/api-query-cancel/http-response.adoc @@ -0,0 +1,11 @@ += Example HTTP Response + +Result of <>. + +==== +.Response 200 +[source,json] +---- +include::example$api-query-cancel.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-query/partials/paths/api-query-index/http-request.adoc b/docs/modules/fts-rest-query/partials/paths/api-query-index/http-request.adoc new file mode 100644 index 00000000..b71727b0 --- /dev/null +++ b/docs/modules/fts-rest-query/partials/paths/api-query-index/http-request.adoc @@ -0,0 +1,12 @@ += Example HTTP Request + +Request 1: Find queries on the index `DemoIndex1` that have been running for longer than 1 ms. + +[#request-1] +==== +.Curl request +[source,sh] +---- +include::example$api-query-index.sh[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-query/partials/paths/api-query-index/http-response.adoc b/docs/modules/fts-rest-query/partials/paths/api-query-index/http-response.adoc new file mode 100644 index 00000000..fcd01344 --- /dev/null +++ b/docs/modules/fts-rest-query/partials/paths/api-query-index/http-response.adoc @@ -0,0 +1,11 @@ += Example HTTP Response + +Result of <>. + +==== +.Response 200 +[source,json] +---- +include::example$api-query-index.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-query/partials/paths/api-query/http-request.adoc b/docs/modules/fts-rest-query/partials/paths/api-query/http-request.adoc new file mode 100644 index 00000000..e1e1f956 --- /dev/null +++ b/docs/modules/fts-rest-query/partials/paths/api-query/http-request.adoc @@ -0,0 +1,23 @@ += Example HTTP Request + +Request 2: Find all active queries across the Search cluster. + +[#request-2] +==== +.Curl request +[source,sh] +---- +include::example$api-query-all.sh[] +---- +==== + +Request 3: Find all queries across the cluster that have been running for longer than 7s. + +[#request-3] +==== +.Curl request +[source,sh] +---- +include::example$api-query-filter.sh[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-query/partials/paths/api-query/http-response.adoc b/docs/modules/fts-rest-query/partials/paths/api-query/http-response.adoc new file mode 100644 index 00000000..dbad3452 --- /dev/null +++ b/docs/modules/fts-rest-query/partials/paths/api-query/http-response.adoc @@ -0,0 +1,21 @@ += Example HTTP Response + +Result of <>. + +==== +.Response 200 +[source,json] +---- +include::example$api-query-all.json[] +---- +==== + +Result of <>. + +==== +.Response 200 +[source,json] +---- +include::example$api-query-filter.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-query/partials/security/document-begin.adoc b/docs/modules/fts-rest-query/partials/security/document-begin.adoc new file mode 100644 index 00000000..753b6c55 --- /dev/null +++ b/docs/modules/fts-rest-query/partials/security/document-begin.adoc @@ -0,0 +1,2 @@ +The Search REST APIs support HTTP basic authentication. +Pass your credentials through HTTP headers. \ No newline at end of file diff --git a/docs/modules/fts-rest-query/partials/security/document-end.adoc b/docs/modules/fts-rest-query/partials/security/document-end.adoc new file mode 100644 index 00000000..5330f469 --- /dev/null +++ b/docs/modules/fts-rest-query/partials/security/document-end.adoc @@ -0,0 +1 @@ +For more information, see xref:learn:security/roles.adoc[]. \ No newline at end of file diff --git a/docs/modules/fts-rest-query/search-query.gradle b/docs/modules/fts-rest-query/search-query.gradle new file mode 100644 index 00000000..5b7e7c35 --- /dev/null +++ b/docs/modules/fts-rest-query/search-query.gradle @@ -0,0 +1,23 @@ +apply plugin: 'org.openapi.generator' + +openApiGenerate { + generatorName = "asciidoc" + remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/morpheus/docs/spec/query/query.yaml" + outputDir = "${rootDir}/docs/modules/fts-rest-query/pages" + templateDir = "${rootDir}/templates" + gitRepoId = "cbft" + gitUserId = "couchbase" + additionalProperties = [ + specDir: "${rootDir}/docs/modules/fts-rest-query/partials/", + snippetDir: "${rootDir}/docs/modules/fts-rest-query/partials/paths/", + headerAttributes: "true", + useIntroduction: "true", + useTableTitles: "true", + skipExamples: "true", + legacyDiscriminatorBehavior: "true" + ] + globalProperties = [ + generateAliasAsModel: "true" + ] + generateAliasAsModel = true +} \ No newline at end of file diff --git a/docs/modules/fts-rest-stats/examples/g-api-nsstats-200.json b/docs/modules/fts-rest-stats/examples/g-api-nsstats-200.json new file mode 100644 index 00000000..34b2a157 --- /dev/null +++ b/docs/modules/fts-rest-stats/examples/g-api-nsstats-200.json @@ -0,0 +1,164 @@ +{ + "avg_queries_latency": 9.38084, + "batch_bytes_added": 1065776, + "batch_bytes_removed": 1065776, + "curr_batches_blocked_by_herder": 0, + "num_batches_introduced": 20, + "num_bytes_ram_quota": 440320000, + "num_bytes_used_disk": 38324504, + "num_bytes_used_ram": 250174920, + "num_bytes_used_ram_c": 2354288, + "num_files_on_disk": 6, + "num_gocbcore_dcp_agents": 2, + "num_gocbcore_stats_agents": 4, + "num_knn_search_requests": 7, + "pct_cpu_gc": 0.0000521150454206345, + "pct_used_ram": 56.81661518895349, + "tot_batches_flushed_on_maxops": 8, + "tot_batches_flushed_on_timer": 12, + "tot_batches_merged": 2028, + "tot_batches_new": 20, + "tot_bleve_dest_closed": 0, + "tot_bleve_dest_opened": 2, + "tot_grpc_listeners_closed": 0, + "tot_grpc_listeners_opened": 1, + "tot_grpc_queryreject_on_memquota": 0, + "tot_grpcs_listeners_closed": 0, + "tot_grpcs_listeners_opened": 1, + "tot_http_limitlisteners_closed": 0, + "tot_http_limitlisteners_opened": 1, + "tot_https_limitlisteners_closed": 0, + "tot_https_limitlisteners_opened": 2, + "tot_queryreject_on_memquota": 0, + "tot_remote_grpc": 0, + "tot_remote_grpc_ssl": 0, + "tot_remote_grpc_tls": 0, + "tot_remote_http": 0, + "tot_remote_http2": 0, + "tot_remote_http_ssl": 0, + "tot_rollback_full": 0, + "tot_rollback_partial": 0, + "total_bytes_query_results": 62573, + "total_create_index_bad_request_error": 0, + "total_create_index_internal_server_error": 0, + "total_create_index_request": 1, + "total_create_index_request_ok": 1, + "total_delete_index_bad_request_error": 0, + "total_delete_index_internal_server_error": 0, + "total_delete_index_request": 0, + "total_delete_index_request_ok": 0, + "total_gc": 412, + "total_internal_queries": 0, + "total_queries": 8, + "total_queries_bad_request_error": 1, + "total_queries_consistency_error": 0, + "total_queries_error": 1, + "total_queries_max_result_window_exceeded_error": 0, + "total_queries_partial_results_error": 0, + "total_queries_rejected_by_herder": 0, + "total_queries_search_in_context_error": 0, + "total_queries_slow": 0, + "total_queries_timeout": 0, + "total_queries_validation_error": 0, + "total_request_time": 81994975, + "travel-sample:travel-sample.inventory.travel-test:avg_grpc_internal_queries_latency": 0, + "travel-sample:travel-sample.inventory.travel-test:avg_grpc_queries_latency": 0, + "travel-sample:travel-sample.inventory.travel-test:avg_internal_queries_latency": 0, + "travel-sample:travel-sample.inventory.travel-test:avg_queries_latency": 0, + "travel-sample:travel-sample.inventory.travel-test:doc_count": 917, + "travel-sample:travel-sample.inventory.travel-test:last_access_time": "2024-08-13T18:54:00.844+00:00", + "travel-sample:travel-sample.inventory.travel-test:num_bytes_read_at_query_time": 0, + "travel-sample:travel-sample.inventory.travel-test:num_bytes_used_disk": 36279386, + "travel-sample:travel-sample.inventory.travel-test:num_bytes_used_disk_by_root": 17119280, + "travel-sample:travel-sample.inventory.travel-test:num_bytes_used_disk_by_root_reclaimable": 0, + "travel-sample:travel-sample.inventory.travel-test:num_bytes_written_at_index_time": 0, + "travel-sample:travel-sample.inventory.travel-test:num_file_merge_ops": 0, + "travel-sample:travel-sample.inventory.travel-test:num_files_on_disk": 4, + "travel-sample:travel-sample.inventory.travel-test:num_mem_merge_ops": 0, + "travel-sample:travel-sample.inventory.travel-test:num_mutations_to_index": 0, + "travel-sample:travel-sample.inventory.travel-test:num_persister_nap_merger_break": 1, + "travel-sample:travel-sample.inventory.travel-test:num_persister_nap_pause_completed": 1, + "travel-sample:travel-sample.inventory.travel-test:num_pindexes_actual": 1, + "travel-sample:travel-sample.inventory.travel-test:num_pindexes_target": 1, + "travel-sample:travel-sample.inventory.travel-test:num_recs_to_persist": 0, + "travel-sample:travel-sample.inventory.travel-test:num_root_filesegments": 1, + "travel-sample:travel-sample.inventory.travel-test:num_root_memorysegments": 0, + "travel-sample:travel-sample.inventory.travel-test:timer_batch_store_count": 0, + "travel-sample:travel-sample.inventory.travel-test:timer_data_delete_count": 0, + "travel-sample:travel-sample.inventory.travel-test:timer_data_update_count": 0, + "travel-sample:travel-sample.inventory.travel-test:timer_opaque_get_count": 2048, + "travel-sample:travel-sample.inventory.travel-test:timer_opaque_set_count": 1024, + "travel-sample:travel-sample.inventory.travel-test:timer_rollback_count": 0, + "travel-sample:travel-sample.inventory.travel-test:timer_snapshot_start_count": 96, + "travel-sample:travel-sample.inventory.travel-test:tot_seq_received": 87974, + "travel-sample:travel-sample.inventory.travel-test:total_bytes_indexed": 8523422, + "travel-sample:travel-sample.inventory.travel-test:total_bytes_query_results": 126174, + "travel-sample:travel-sample.inventory.travel-test:total_compaction_written_bytes": 15644740, + "travel-sample:travel-sample.inventory.travel-test:total_grpc_internal_queries": 0, + "travel-sample:travel-sample.inventory.travel-test:total_grpc_queries": 0, + "travel-sample:travel-sample.inventory.travel-test:total_grpc_queries_error": 0, + "travel-sample:travel-sample.inventory.travel-test:total_grpc_queries_slow": 0, + "travel-sample:travel-sample.inventory.travel-test:total_grpc_queries_timeout": 0, + "travel-sample:travel-sample.inventory.travel-test:total_grpc_request_time": 0, + "travel-sample:travel-sample.inventory.travel-test:total_internal_queries": 0, + "travel-sample:travel-sample.inventory.travel-test:total_knn_searches": 0, + "travel-sample:travel-sample.inventory.travel-test:total_queries": 0, + "travel-sample:travel-sample.inventory.travel-test:total_queries_error": 0, + "travel-sample:travel-sample.inventory.travel-test:total_queries_slow": 0, + "travel-sample:travel-sample.inventory.travel-test:total_queries_timeout": 0, + "travel-sample:travel-sample.inventory.travel-test:total_request_time": 96821165, + "travel-sample:travel-sample.inventory.travel-test:total_term_searchers": 22, + "travel-sample:travel-sample.inventory.travel-test:total_term_searchers_finished": 22, + "vector-sample:vector-sample.color.color-test:avg_grpc_internal_queries_latency": 0, + "vector-sample:vector-sample.color.color-test:avg_grpc_queries_latency": 0, + "vector-sample:vector-sample.color.color-test:avg_internal_queries_latency": 0, + "vector-sample:vector-sample.color.color-test:avg_queries_latency": 9.38084, + "vector-sample:vector-sample.color.color-test:doc_count": 153, + "vector-sample:vector-sample.color.color-test:field:colorvect_l2:num_vectors": 153, + "vector-sample:vector-sample.color.color-test:field:embedding_vector_dot:num_vectors": 153, + "vector-sample:vector-sample.color.color-test:last_access_time": "2024-04-30T15:58:55.073+00:00", + "vector-sample:vector-sample.color.color-test:num_bytes_read_at_query_time": 14780, + "vector-sample:vector-sample.color.color-test:num_bytes_used_disk": 2045118, + "vector-sample:vector-sample.color.color-test:num_bytes_used_disk_by_root": 996542, + "vector-sample:vector-sample.color.color-test:num_bytes_used_disk_by_root_reclaimable": 0, + "vector-sample:vector-sample.color.color-test:num_bytes_written_at_index_time": 1003945, + "vector-sample:vector-sample.color.color-test:num_file_merge_ops": 0, + "vector-sample:vector-sample.color.color-test:num_files_on_disk": 2, + "vector-sample:vector-sample.color.color-test:num_mem_merge_ops": 1, + "vector-sample:vector-sample.color.color-test:num_mutations_to_index": 0, + "vector-sample:vector-sample.color.color-test:num_persister_nap_merger_break": 2, + "vector-sample:vector-sample.color.color-test:num_persister_nap_pause_completed": 2, + "vector-sample:vector-sample.color.color-test:num_pindexes_actual": 1, + "vector-sample:vector-sample.color.color-test:num_pindexes_target": 1, + "vector-sample:vector-sample.color.color-test:num_recs_to_persist": 0, + "vector-sample:vector-sample.color.color-test:num_root_filesegments": 1, + "vector-sample:vector-sample.color.color-test:num_root_memorysegments": 0, + "vector-sample:vector-sample.color.color-test:timer_batch_store_count": 0, + "vector-sample:vector-sample.color.color-test:timer_data_delete_count": 0, + "vector-sample:vector-sample.color.color-test:timer_data_update_count": 153, + "vector-sample:vector-sample.color.color-test:timer_opaque_get_count": 2048, + "vector-sample:vector-sample.color.color-test:timer_opaque_set_count": 2048, + "vector-sample:vector-sample.color.color-test:timer_rollback_count": 0, + "vector-sample:vector-sample.color.color-test:timer_snapshot_start_count": 141, + "vector-sample:vector-sample.color.color-test:tot_seq_received": 5273, + "vector-sample:vector-sample.color.color-test:total_bytes_indexed": 945671, + "vector-sample:vector-sample.color.color-test:total_bytes_query_results": 62573, + "vector-sample:vector-sample.color.color-test:total_compaction_written_bytes": 996542, + "vector-sample:vector-sample.color.color-test:total_compactions": 0, + "vector-sample:vector-sample.color.color-test:total_grpc_internal_queries": 0, + "vector-sample:vector-sample.color.color-test:total_grpc_queries": 0, + "vector-sample:vector-sample.color.color-test:total_grpc_queries_error": 0, + "vector-sample:vector-sample.color.color-test:total_grpc_queries_slow": 0, + "vector-sample:vector-sample.color.color-test:total_grpc_queries_timeout": 0, + "vector-sample:vector-sample.color.color-test:total_grpc_request_time": 0, + "vector-sample:vector-sample.color.color-test:total_internal_queries": 0, + "vector-sample:vector-sample.color.color-test:total_knn_searches": 7, + "vector-sample:vector-sample.color.color-test:total_queries": 8, + "vector-sample:vector-sample.color.color-test:total_queries_error": 1, + "vector-sample:vector-sample.color.color-test:total_queries_slow": 0, + "vector-sample:vector-sample.color.color-test:total_queries_timeout": 0, + "vector-sample:vector-sample.color.color-test:total_request_time": 81994975, + "vector-sample:vector-sample.color.color-test:total_term_searchers": 80, + "vector-sample:vector-sample.color.color-test:total_term_searchers_finished": 80, + "vector-sample:vector-sample.color.color-test:total_vectors": 306 +} \ No newline at end of file diff --git a/docs/modules/fts-rest-stats/examples/g-api-nsstats-403.json b/docs/modules/fts-rest-stats/examples/g-api-nsstats-403.json new file mode 100644 index 00000000..49bdc218 --- /dev/null +++ b/docs/modules/fts-rest-stats/examples/g-api-nsstats-403.json @@ -0,0 +1,6 @@ +{ + "message": "Forbidden. User needs one of the following permissions", + "permissions": [ + "cluster.fts!read" + ] +} \ No newline at end of file diff --git a/docs/modules/fts-rest-stats/examples/g-api-nsstats-index-name.json b/docs/modules/fts-rest-stats/examples/g-api-nsstats-index-name.json new file mode 100644 index 00000000..76a81a84 --- /dev/null +++ b/docs/modules/fts-rest-stats/examples/g-api-nsstats-index-name.json @@ -0,0 +1,57 @@ +{ + "avg_grpc_internal_queries_latency": 0, + "avg_grpc_queries_latency": 0, + "avg_internal_queries_latency": 0, + "avg_queries_latency": 1.523718, + "batch_merge_count": 0, + "doc_count": 15000, + "iterator_next_count": 0, + "iterator_seek_count": 0, + "last_access_time": "2023-09-20T03:05:55.440-07:00", + "num_bytes_live_data": 0, + "num_bytes_read_at_query_time": 4638582, + "num_bytes_used_disk": 28062406, + "num_bytes_used_disk_by_root": 23651161, + "num_bytes_used_disk_by_root_reclaimable": 0, + "num_bytes_written_at_index_time": 21208735, + "num_files_on_disk": 6, + "num_mutations_to_index": 0, + "num_persister_nap_merger_break": 40, + "num_persister_nap_pause_completed": 7, + "num_pindexes_actual": 1, + "num_pindexes_target": 1, + "num_recs_to_persist": 0, + "num_root_filesegments": 4, + "num_root_memorysegments": 0, + "reader_get_count": 0, + "reader_multi_get_count": 0, + "reader_prefix_iterator_count": 0, + "reader_range_iterator_count": 0, + "timer_batch_store_count": 0, + "timer_data_delete_count": 0, + "timer_data_update_count": 15000, + "timer_opaque_get_count": 2048, + "timer_opaque_set_count": 2048, + "timer_rollback_count": 0, + "timer_snapshot_start_count": 1024, + "tot_seq_received": 19096, + "total_bytes_indexed": 4866486, + "total_bytes_query_results": 1798, + "total_compaction_written_bytes": 87917849, + "total_compactions": 0, + "total_grpc_internal_queries": 0, + "total_grpc_queries": 0, + "total_grpc_queries_error": 0, + "total_grpc_queries_slow": 0, + "total_grpc_queries_timeout": 0, + "total_grpc_request_time": 0, + "total_internal_queries": 0, + "total_queries": 4, + "total_queries_error": 1, + "total_queries_slow": 0, + "total_queries_timeout": 0, + "total_request_time": 6276461, + "total_term_searchers": 7, + "total_term_searchers_finished": 7, + "writer_execute_batch_count": 0 +} \ No newline at end of file diff --git a/docs/modules/fts-rest-stats/pages/index.adoc b/docs/modules/fts-rest-stats/pages/index.adoc new file mode 100644 index 00000000..e3ba7624 --- /dev/null +++ b/docs/modules/fts-rest-stats/pages/index.adoc @@ -0,0 +1,2937 @@ += Couchbase Search Statistics 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/cbft + +: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 Search Statistics REST API is provided by the Search service. +This API enables you to get statistics for the Search Service and your Search indexes. +-- + +[discrete#version] += Version information +[%hardbreaks] +__Version__ : 8.0 + +[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 Search Service. +-- + +[%hardbreaks] + +*Example:* `+++localhost+++` +// end + +a| *port* +a| [markdown] +-- +The Search Service REST port. Use `18094` for secure access. +-- + +[%hardbreaks] +*Values:* `8094`, `18094` +*Example:* `+++8094+++` +// end + +|=== + + +// markup not found, no 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: 1 + +: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] +xref:tag-Default[] +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Default] += Default +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:g-api-nsstats[] +xref:g-api-nsstats-index-name[] + + +//tag::g-api-nsstats[] + + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-before.adoc[opts=optional] + + +[#g-api-nsstats] += Get Query, Mutation, and Partition Statistics for the Search Service + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-begin.adoc[opts=optional] + + +.... +GET /api/nsstats +.... + + + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-description-before.adoc[opts=optional] + + +[#g-api-nsstats-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Gets query, mutation, document, partition, and compaction statistics for the Search Service and any Search indexes. + +This endpoint returns statistics provided by the Cluster Manager. +For additional statistics, including detailed partition information, see [Get Indexing and Data Metrics for All Indexes](../fts-rest-indexing/index.html#g-api-stats). +-- + + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-description-end.adoc[opts=optional] + + + +[#g-api-nsstats-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-responses-before.adoc[opts=optional] + + +[#g-api-nsstats-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The Search Service returns statistics from the `nsstats` endpoint for the entire cluster, and for each Search index. For each Search index, the names of the statistics are prefixed with the bucket name and index name, in the form `BUCKET:INDEX:statistic_name`. +-- +a| xref:allStats[] + + +| 400 +a| [markdown] +-- +Object not found. The URI may be malformed. +-- +a| +| 401 +a| [markdown] +-- +Unauthorized. Failure to authenticate. +-- +a| +| 403 +a| [markdown] +-- +Forbidden. The user authenticates but does not have the appropriate permissions. +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-security-before.adoc[opts=optional] + + +[#g-api-nsstats-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-admin[] + +|=== + + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}g-api-nsstats/http-request.adoc[opts=optional] + + +include::{snippetDir}g-api-nsstats/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-nsstats/operation-after.adoc[opts=optional] + + +//end::g-api-nsstats[] + + +//tag::g-api-nsstats-index-name[] + + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-before.adoc[opts=optional] + + +[#g-api-nsstats-index-name] += Get Query, Mutation, and Partition Statistics for an Index + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-begin.adoc[opts=optional] + + +.... +GET /api/nsstats/index/{INDEX_NAME} +.... + + + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-description-before.adoc[opts=optional] + + +[#g-api-nsstats-index-name-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Gets query, mutation, document, partition, and compaction statistics for the Search index specified in the endpoint URL. + +This endpoint returns statistics provided by the Cluster Manager. +For additional statistics, including detailed partition information, see [Get Indexing and Data Metrics for an Index](../fts-rest-indexing/index.html#g-api-stats-index-name). +-- + + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-description-end.adoc[opts=optional] + + + +[#g-api-nsstats-index-name-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-parameters-before.adoc[opts=optional] + + +[#g-api-nsstats-index-name-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-parameters-begin.adoc[opts=optional] + + +[#g-api-nsstats-index-name-path] +.Path Parameters +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *INDEX_NAME* + +_required_ +a¦ + + +[markdown] +-- +The name of the Search index definition. +You must use the fully qualified name for the index, which includes the bucket and scope. + +To view the full, scoped name for an index for use with this endpoint: + +1. Go to the **Search** tab in the Couchbase Server Web Console. +2. Point to the **Index Name** for an index. +-- + +[%hardbreaks] +{blank} + +a¦ String + + + +|=== + + + + + + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-responses-before.adoc[opts=optional] + + +[#g-api-nsstats-index-name-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +The Search Service returns statistics from the `nsstats` endpoint for the specified index. Note that for a single index, the names of the statistics are not prefixed with the bucket name or index name. +-- +a| xref:indexStats[] + + + +|=== + + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-security-before.adoc[opts=optional] + + +[#g-api-nsstats-index-name-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-statistics[] + +|=== + + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-security-after.adoc[opts=optional] + + + +// markup not found, no include::{snippetDir}g-api-nsstats-index-name/http-request.adoc[opts=optional] + + +include::{snippetDir}g-api-nsstats-index-name/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/g-api-nsstats-index-name/operation-after.adoc[opts=optional] + + +//end::g-api-nsstats-index-name[] + + +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: 3 + +: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] +xref:allStats[] +xref:clusterStats[] +xref:indexStats[] +endif::[] + + + +// markup not found, no include::{specDir}definitions/allStats/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#allStats] += Service Statistics + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/allStats/definition-begin.adoc[opts=optional] + + +.icon:bars[fw] Composite Schema +{blank} + +//tag::allStats[] + + +[cols="25,55,20",separator=¦] +|=== +¦ All{nbsp}of{nbsp}... ¦ ¦ Schema + +a¦ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-clusterStats, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:clusterStats[] + + +a¦ _and_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-indexStats, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:indexStats[] + + +|=== + +//end::allStats[] + + +// markup not found, no include::{specDir}definitions/allStats/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/allStats/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/clusterStats/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#clusterStats] += Cluster Statistics + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/clusterStats/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::clusterStats[] + +ifdef::model-descriptions[] +//tag::desc-clusterStats[] +Statistics for the entire cluster. +//end::desc-clusterStats[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*avg_queries_latency* + +_optional_ +a¦ + +[markdown] +-- +The average latency of all Search queries run on the cluster, in milliseconds. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*batch_bytes_added* + +_optional_ +a¦ + +[markdown] +-- +The total number of bytes in batches that have not yet been added to the Search index. + +Batches are a data structure in the Search Service, used for processing data coming in from DCP and the Data Service to the documents in a Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*batch_bytes_removed* + +_optional_ +a¦ + +[markdown] +-- +The total number of bytes in batches that have been added to the Search index. + +Use together with `batch_bytes_added` to understand when indexing operations complete. + +Batches are a data structure in the Search Service, used for processing data coming in from DCP and the Data Service to the documents in a Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*curr_batches_blocked_by_herder* + +_optional_ +a¦ + +[markdown] +-- +The difference between the number of batches that have been indexed (`batch_bytes_removed`) and batches that have not yet been indexed (`batch_bytes_added`). + +The Search Service blocks batch indexing until there is sufficient memory available on a node. + +This statistic appears on the Server Web Console dashboard as **DCP Batches Blocked**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*num_batches_introduced* + +_optional_ +a¦ + +[markdown] +-- +The total number of batches introduced as part of indexing operations. + +Batches are a data structure in the Search Service, used for processing data coming in from DCP and the Data Service to the documents in a Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*num_bytes_ram_quota* + +_optional_ +a¦ + +[markdown] +-- +The total number of bytes set as the maximum usable memory for the Search Service on the cluster. + +This statistic appears on the Server Web Console dashboard as **RAM Quota for Search**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*num_bytes_used_disk* + +_optional_ +a¦ + +[markdown] +-- +The total number of bytes used on disk by Search indexes in the cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*num_bytes_used_ram* + +_optional_ +a¦ + +[markdown] +-- +The number of bytes used in memory by the Search Service. + +This statistic appears on the Server Web Console dashboard as **RAM Used by Search**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*num_bytes_used_ram_c* + +_optional_ +a¦ + +[markdown] +-- +The number of bytes used in memory by the Search Service's C language processes. + +This amount is included as part of the total number of bytes used in memory, given by the `num_bytes_used_ram` statistic. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*num_files_on_disk* + +_optional_ +a¦ + +[markdown] +-- +The total number of files on disk for all Search indexes. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*num_gocbcore_dcp_agents* + +_optional_ +a¦ + +[markdown] +-- +The total number of Go SDK DCP agents used by the Search Service to establish DCP communication with the Data Service. + +The number of Go SDK DCP agents should be less than or equal to the number of Search index partitions on a node. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*num_gocbcore_stats_agents* + +_optional_ +a¦ + +[markdown] +-- +The total number of Go SDK agent pairs, used to retrieve statistics from the Data Service, that are present on a node. + +Typically, the Search Service uses one agent pair for each bucket on a node. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*num_indexes* + +_optional_ +a¦ + +[markdown] +-- +The number of Search indexes in the cluster. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*num_knn_search_requests* + +_optional_ +a¦ + +[markdown] +-- +The total number of [Vector Search](https://docs.couchbase.com/server/8.0/vector-search/vector-search.html) requests made across all Search indexes in the cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*num_vector_indexes* + +_optional_ +a¦ + +[markdown] +-- +The number of Search indexes in the cluster that have vector/vector_base64 fields. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*pct_cpu_gc* + +_optional_ +a¦ + +[markdown] +-- +The percentage of CPU time spent by a Search index in garbage collection. +Garbage collection involves cleanup actions like removing unnecessary index entries. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*pct_used_ram* + +_optional_ +a¦ + +[markdown] +-- +The percentage of the available RAM quota used by the Search Service. + +This statistic appears on the Server Web Console dashboard as **Pct RAM Used by Search**. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*tot_batches_flushed_on_maxops* + +_optional_ +a¦ + +[markdown] +-- +The total number of batches executed due to the batch size being greater than the maximum number of operations per batch. + +Batches are a data structure in the Search Service, used for processing data coming in from DCP and the Data Service to the documents in a Search index. +A batch is executed when it's flushed to disk. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_batches_flushed_on_timer* + +_optional_ +a¦ + +[markdown] +-- +The total number of batches executed at regular intervals. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_batches_merged* + +_optional_ +a¦ + +[markdown] +-- +The number of batches that have been merged together before being sent to the disk write queue. + +Batches are a data structure in the Search Service, used for processing data coming in from DCP and the Data Service to the documents in a Search index. +A batch is executed when it's flushed to disk. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_batches_new* + +_optional_ +a¦ + +[markdown] +-- +The number of new batches that have been freshly introduced into the system. + +Batches are a data structure in the Search Service, used for processing data coming in from DCP and the Data Service to the documents in a Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_bleve_dest_closed* + +_optional_ +a¦ + +[markdown] +-- +The total number of times a Search index partition closed to new Search requests. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_bleve_dest_opened* + +_optional_ +a¦ + +[markdown] +-- +The total number of times Search index partitions were created or reopened for new Search requests, or for ingesting data coming in from DCP. + +Opening a Search index partition creates a file lock for concurrent access requests. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_grpc_listeners_closed* + +_optional_ +a¦ + +[markdown] +-- +The total number of gRPC listeners closed. + +gRPC listeners handle incoming connection requests to the Search Service. + +The Search Service uses gRPC to manage scatter-gather operations across nodes when there are multiple nodes running the Search Service in a cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_grpc_listeners_opened* + +_optional_ +a¦ + +[markdown] +-- +The total number of gRPC listeners opened. + +gRPC listeners handle incoming connection requests to the Search Service. + +The Search Service uses gRPC to manage scatter-gather operations across nodes when there are multiple nodes running the Search Service in a cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_grpc_queryreject_on_memquota* + +_optional_ +a¦ + +[markdown] +-- +The total number of gRPC queries rejected because of the available memory quota for the Search Service being less than the estimated memory required for merging search results from all partitions. + +For more information about how to set the Search Service's quota, see [ftsMemoryQuota](https://docs.couchbase.com/server/8.0/fts/fts-advanced-settings-ftsMemoryQuota.html). + +The Search Service uses gRPC to manage scatter-gather operations across nodes when there are multiple nodes running the Search Service in a cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_grpcs_listeners_closed* + +_optional_ +a¦ + +[markdown] +-- +The total number of gRPC SSL listeners closed. + +gRPC SSL listeners handle incoming SSL connection requests to the Search Service. + +The Search Service uses gRPC to manage scatter-gather operations across nodes when there are multiple nodes running the Search Service in a cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_grpcs_listeners_opened* + +_optional_ +a¦ + +[markdown] +-- +The total number of gRPC SSL listeners opened. + +gRPC SSL listeners handle incoming SSL connection requests to the Search Service. + +The Search Service uses gRPC to manage scatter-gather operations across nodes when there are multiple nodes running the Search Service in a cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_http_limitlisteners_closed* + +_optional_ +a¦ + +[markdown] +-- +The total number of HTTP limit listeners closed. + +HTTP limit listeners manage limits on incoming HTTP requests to the Search Service. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_http_limitlisteners_opened* + +_optional_ +a¦ + +[markdown] +-- +The total number of HTTP limit listeners opened. + +HTTP limit listeners manage limits on incoming HTTP requests to the Search Service. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_https_limitlisteners_closed* + +_optional_ +a¦ + +[markdown] +-- +The total number of HTTPS limit listeners closed. + +HTTPS limit listeners manage limits on incoming HTTPS requests to the Search Service. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_https_limitlisteners_opened* + +_optional_ +a¦ + +[markdown] +-- +The total number of HTTPS limit listeners opened. + +HTTPS limit listeners manage limits on incoming HTTPS requests to the Search Service. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_queryreject_on_memquota* + +_optional_ +a¦ + +[markdown] +-- +The total number of Search queries rejected because of the available memory quota for the Search Service being less than the estimated memory required for merging search results from all partitions. + +For more information about how to set the Search Service's quota, see [ftsMemoryQuota](https://docs.couchbase.com/server/8.0/fts/fts-advanced-settings-ftsMemoryQuota.html). +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_remote_grpc* + +_optional_ +a¦ + +[markdown] +-- +The total number of remote gRPC requests made to the Search Service. + +A request is remote if it comes from a different node in the cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_remote_grpc_ssl* + +_optional_ +a¦ + +[markdown] +-- +The total number of gRPC scatter-gather requests made to the Search Service over SSL. + +A request is remote if it comes from a different node in the cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_remote_grpc_tls* + +_optional_ +a¦ + +[markdown] +-- +This metric is deprecated. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_remote_http* + +_optional_ +a¦ + +[markdown] +-- +The total number of remote HTTP requests made to the Search Service. + +A request is remote if it comes from a different node in the cluster. + +Remote HTTP requests are deprecated. +Use gRPC requests, instead. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_remote_http2* + +_optional_ +a¦ + +[markdown] +-- +The total number of remote HTTPS requests made to the Search Service. + +A request is remote if it comes from a different node in the cluster. + +Remote HTTP requests are deprecated. +Use gRPC requests, instead. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_remote_http_ssl* + +_optional_ +a¦ + +[markdown] +-- +The total number of remote HTTP SSL requests made to the Search Service. + +A request is remote if it comes from a different node in the cluster. + +Remote HTTP requests are deprecated. +Use gRPC requests, instead. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_rollback_full* + +_optional_ +a¦ + +[markdown] +-- +The total number of full rollbacks that occurred on a Search index partition. + +The Search Service only maintains a small number of index snapshots at one time. + +If the Search Service loses connection to the Data Service, the Search Service compares rollback sequence numbers when the connection is re-established. +If the Search Service's index snapshots are too far ahead of the Data Service's rollback sequence number, the Search Service performs a full rollback operation on documents in the index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*tot_rollback_partial* + +_optional_ +a¦ + +[markdown] +-- +The total number of partial rollbacks that occurred on a Search index partition. + +The Search Service only maintains a small number of index snapshots at one time. + +If the Search Service loses connection to the Data Service, the Search Service compares rollback sequence numbers when the connection is re-established. +If the Search Service's index snapshots are too far ahead of the Data Service's rollback sequence number, the Search Service performs a partial rollback operation on documents in the index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_bytes_query_results* + +_optional_ +a¦ + +[markdown] +-- +The size of all results returned for Search queries. +This includes the size of all JSON sent. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_create_index_bad_request_error* + +_optional_ +a¦ + +[markdown] +-- +The total number of bad request errors returned for requests to create new Search indexes on the cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_create_index_internal_server_error* + +_optional_ +a¦ + +[markdown] +-- +The total number of internal server errors returned for requests to create new Search indexes on the cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_create_index_request* + +_optional_ +a¦ + +[markdown] +-- +The total number of requests received by the Search Service for creating new Search indexes. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_create_index_request_ok* + +_optional_ +a¦ + +[markdown] +-- +The total number of requests received by the Search Service for creating new Search indexes that were successful. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_delete_index_bad_request_error* + +_optional_ +a¦ + +[markdown] +-- +The total number of bad request errors returned for requests to delete Search indexes on the cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_delete_index_internal_server_error* + +_optional_ +a¦ + +[markdown] +-- +The total number of internal server errors returned for requests to delete Search indexes on the cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_delete_index_request* + +_optional_ +a¦ + +[markdown] +-- +The total number of requests received by the Search Service to delete Search indexes. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_delete_index_request_ok* + +_optional_ +a¦ + +[markdown] +-- +The total number of requests received by the Search Service to delete Search indexes that were successful. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_gc* + +_optional_ +a¦ + +[markdown] +-- +The total number of garbage collection events triggered by the Search Service. + +Garbage collection events include removing unnecessary index entries. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_internal_queries* + +_optional_ +a¦ + +[markdown] +-- +The number of internal queries from the coordinating node for a Search query to other nodes running the Search Service. + +The Search Service uses gRPC to manage scatter-gather operations across nodes when there are multiple nodes running the Search Service in a cluster. +The coordinating node is the Search node that receives the Search request and scatters it to all other Search index partitions on other nodes. +The coordinating node applies filters to the results from all Search index partitions and returns the final result set. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_queries* + +_optional_ +a¦ + +[markdown] +-- +The total number of Search queries per second across all Search indexes in the cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_queries_bad_request_error* + +_optional_ +a¦ + +[markdown] +-- +The total number of bad request errors returned for Search queries on the cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_queries_consistency_error* + +_optional_ +a¦ + +[markdown] +-- +The total number of Search queries that encountered consistency errors on the cluster. + +For more information about consistency in Search queries, see [Search Request JSON Properties](https://docs.couchbase.com/server/8.0/search/search-request-params.html#ctl). +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_queries_error* + +_optional_ +a¦ + +[markdown] +-- +The total number of Search queries that encountered an error on the cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_queries_max_result_window_exceeded_error* + +_optional_ +a¦ + +[markdown] +-- +The total number of Search queries that exceeded the [bleveMaxResultWindow](https://docs.couchbase.com/server/8.0/fts/fts-advanced-settings-bleveMaxResultWindow.html) setting. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_queries_partial_results_error* + +_optional_ +a¦ + +[markdown] +-- +The total number of Search queries that could only return partial results. + +A Search query can return partial results if it times out before all partitions can respond. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_queries_rejected_by_herder* + +_optional_ +a¦ + +[markdown] +-- +The total number of queries rejected by the Search Service when the memory used approaches or exceeds the quota set for a query. + +For more information about how to set the Search Service's memory quota, see [ftsMemoryQuota](https://docs.couchbase.com/server/8.0/fts/fts-advanced-settings-ftsMemoryQuota.html). + +This statistic appears on the Server Web Console dashboard as **Rejected Queries**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_queries_search_in_context_error* + +_optional_ +a¦ + +[markdown] +-- +The total number of Search queries that returned an error when running through the `SearchInContext` API. + +These errors are typically internal server errors. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_queries_slow* + +_optional_ +a¦ + +[markdown] +-- +The total number of Search queries that were added to the slow query log. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_queries_timeout* + +_optional_ +a¦ + +[markdown] +-- +The total number of Search queries that timed out. + +You can set the timeout for a query with the [ctl object](https://docs.couchbase.com/server/8.0/search/search-request-params.html#ctl). +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_queries_validation_error* + +_optional_ +a¦ + +[markdown] +-- +The total number of queries that encountered a validation error, when the query request included a `validate` property in the `ctl` object. + +For more information, see the [validate property](https://docs.couchbase.com/server/8.0/search/search-request-params.html#validate). +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*total_request_time* + +_optional_ +a¦ + +[markdown] +-- +The total time, in nanoseconds, spent processing Search queries across the cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +|=== + +//end::clusterStats[] + + + + +// markup not found, no include::{specDir}definitions/clusterStats/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/clusterStats/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/indexStats/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#indexStats] += Index Statistics + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/indexStats/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::indexStats[] + +ifdef::model-descriptions[] +//tag::desc-indexStats[] +Statistics for a single Search index. +//end::desc-indexStats[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*BUCKET:INDEX:avg_grpc_internal_queries_latency* + +_optional_ +a¦ + +[markdown] +-- +The average time taken for a Search query's scatter-gather requests between the coordinator and other nodes running the Search Service. + +The Search Service uses gRPC to manage scatter-gather operations across nodes when there are multiple nodes running the Search Service in a cluster. +The coordinator is the Search node that receives the Search request and scatters it to all other Search index partitions on other nodes. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:avg_grpc_queries_latency* + +_optional_ +a¦ + +[markdown] +-- +The average time taken for each Search query that uses gRPC, in milliseconds for the given Search index. + +The Search Service uses gRPC to manage scatter-gather operations across nodes when there are multiple nodes running the Search Service in a cluster. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:avg_internal_queries_latency* + +_optional_ +a¦ + +[markdown] +-- +The average latency, in milliseconds, for inter-node queries for the given Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:avg_queries_latency* + +_optional_ +a¦ + +[markdown] +-- +The average latency, in milliseconds, for all Search queries on the given Search index. + +This statistic appears on the Server Web Console dashboard as **Search Query Latency**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:doc_count* + +_optional_ +a¦ + +[markdown] +-- +The total number of documents in the given Search index. + +This statistic appears on the Server Web Console dashboard as **Search Docs**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:global_query_timer_count* + +_optional_ +a¦ + +[markdown] +-- +The number of Search query timer events received at the global query endpoint. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*BUCKET:INDEX:global_query_timer_mean_ns* + +_optional_ +a¦ + +[markdown] +-- +The mean runtime for Search queries received at the global query endpoint in nanoseconds. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*BUCKET:INDEX:global_query_timer_median_ns* + +_optional_ +a¦ + +[markdown] +-- +The median runtime for Search queries received at the global query endpoint in nanoseconds. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*BUCKET:INDEX:global_query_timer_p80_ns* + +_optional_ +a¦ + +[markdown] +-- +The 80th percentile runtime for Search queries received at the global query endpoint in nanoseconds. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*BUCKET:INDEX:global_query_timer_p99_ns* + +_optional_ +a¦ + +[markdown] +-- +The 99th percentile runtime for Search queries received at the global query endpoint in nanoseconds. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*BUCKET:INDEX:grpc_query_timer_count* + +_optional_ +a¦ + +[markdown] +-- +The number of Search query timer events received at the gRPC endpoint. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*BUCKET:INDEX:grpc_query_timer_mean_ns* + +_optional_ +a¦ + +[markdown] +-- +The mean runtime for Search queries received at the gRPC endpoint in nanoseconds. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*BUCKET:INDEX:grpc_query_timer_median_ns* + +_optional_ +a¦ + +[markdown] +-- +The median runtime for Search queries received at the gRPC endpoint in nanoseconds. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*BUCKET:INDEX:grpc_query_timer_p80_ns* + +_optional_ +a¦ + +[markdown] +-- +The 80th percentile runtime for Search queries received at the gRPC endpoint in nanoseconds. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*BUCKET:INDEX:grpc_query_timer_p99_ns* + +_optional_ +a¦ + +[markdown] +-- +The 99th percentile runtime for Search queries received at the gRPC endpoint in nanoseconds. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*BUCKET:INDEX:last_access_time* + +_optional_ +a¦ + +[markdown] +-- +The last date and time that a query ran against the given Search index. +-- + +[%hardbreaks] +{blank} +a¦ Date (date-time) + + +a¦ +*BUCKET:INDEX:num_bytes_read_at_query_time* + +_optional_ +a¦ + +[markdown] +-- +The total number of bytes read by all queries against the given Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:num_bytes_used_disk* + +_optional_ +a¦ + +[markdown] +-- +The total number of bytes used on disk by the given Search index. + +This statistic appears on the Server Web Console dashboard as **Search Disk Size**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:num_bytes_used_disk_by_root* + +_optional_ +a¦ + +[markdown] +-- +The total number of bytes used on disk by the root segment of the given Search index. + +The root segment includes all data for the Search index, excluding any segments that might be stale and will be removed by the persister or merger. +Segments are stale when they're replaced by a new merged segment created by the merger. +Stale segments are deleted when they're not used by any new queries. + +The `num_bytes_used_disk_by_root` value will be less than the `num_bytes_used_disk` value. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:num_bytes_used_disk_by_root_reclaimable* + +_optional_ +a¦ + +[markdown] +-- +The total number of bytes used on disk by the latest root index segment snapshot, which can potentially be reclaimed by a file merge operation. + +The root segment includes all data for the Search index, excluding any segments that might be stale and will be removed by the persister or merger. +Segments are stale when they're replaced by a new merged segment created by the merger. +Stale segments are deleted when they're not used by any new queries. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:num_bytes_written_at_index_time* + +_optional_ +a¦ + +[markdown] +-- +The total cumulative number of bytes written to disk as part of introducing segments, or files. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:num_file_merge_ops* + +_optional_ +a¦ + +[markdown] +-- +The number of merge operations completed by the merger routine, over persisted files. + +Each Search index partition has a merger and a persister. + +The persister reads in-memory segments from the disk write queue and flushes them to disk. +The merger consolidates flushed files from the persister and flushes the consolidated result to disk through the persister, while purging the smaller, older files. +The persister and merger interact to continuously flush and merge new in-memory segments to disk. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:num_files_on_disk* + +_optional_ +a¦ + +[markdown] +-- +The total number of files on disk for the given Search index. + +This statistic appears on the Server Web Console dashboard as **Search Disk Files**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:num_mem_merge_ops* + +_optional_ +a¦ + +[markdown] +-- +The number of merge operations completed by the merger routine, over in-memory segments. + +Each Search index partition has a merger and a persister. + +The persister reads in-memory segments from the disk write queue and flushes them to disk. +The merger consolidates flushed files from the persister and flushes the consolidated result to disk through the persister, while purging the smaller, older files. +The persister and merger interact to continuously flush and merge new in-memory segments to disk. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:num_mutations_to_index* + +_optional_ +a¦ + +[markdown] +-- +The DCP sequence numbers of changes that have not yet been indexed for the given Search index. + +This statistic appears on the Server Web Console dashboard as **Search Mutations Remaining**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:num_persister_nap_merger_break* + +_optional_ +a¦ + +[markdown] +-- +The number of times the persister was interrupted by the merger during a nap period. + +Each Search index partition has a merger and a persister. + +The persister reads in-memory segments from the disk write queue and flushes them to disk. +The merger consolidates flushed files from the persister and flushes the consolidated result to disk through the persister, while purging the smaller, older files. +The persister and merger interact to continuously flush and merge new in-memory segments to disk. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:num_persister_nap_pause_completed* + +_optional_ +a¦ + +[markdown] +-- +The number of times the persister completed its configured nap period before flushing content to disk, without being interrupted by the merger. + +Each Search index partition has a merger and a persister. + +The persister reads in-memory segments from the disk write queue and flushes them to disk. +The merger consolidates the flushed files from the persister and flushes the consolidated result to disk through the persister, while purging the smaller, older files. +The persister and merger interact to continuously flush and merge new in-memory segments to disk. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:num_pindexes_actual* + +_optional_ +a¦ + +[markdown] +-- +The total number of partitions currently in the given Search index. + +This statistic appears on the Server Web Console dashboard as **Search Partitions**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:num_pindexes_target* + +_optional_ +a¦ + +[markdown] +-- +The total number of planned or expected partitions for the given Search index. + +This statistic appears on the Server Web Console dashboard as **Search Partitions Expected**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:num_recs_to_persist* + +_optional_ +a¦ + +[markdown] +-- +The total number of entries, including terms, records, and dictionary rows, that have not yet been persisted to disk. + +This statistic appears on the Server Web Console dashboard as **Search Records to Persist**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:num_root_filesegments* + +_optional_ +a¦ + +[markdown] +-- +The total number of file segments in the root segment. + +The root segment includes all data for the Search index, excluding any segments that might be stale and will be removed by the persister or merger. + +This statistic appears on the Server Web Console dashboard as **Search Disk Segments**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:num_root_memorysegments* + +_optional_ +a¦ + +[markdown] +-- +The total number of memory segments in the root segment. + +The root segment includes all data for the Search index, excluding any segments that might be stale and will be removed by the persister or merger. + +This statistic appears on the Server Web Console dashboard as **Search Memory Segments**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:scoped_query_timer_count* + +_optional_ +a¦ + +[markdown] +-- +The number of Search query timer events received at the scoped query endpoint. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*BUCKET:INDEX:scoped_query_timer_mean_ns* + +_optional_ +a¦ + +[markdown] +-- +The mean runtime for Search queries received at the scoped query endpoint in nanoseconds. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*BUCKET:INDEX:scoped_query_timer_median_ns* + +_optional_ +a¦ + +[markdown] +-- +The median runtime for Search queries received at the scoped query endpoint in nanoseconds. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*BUCKET:INDEX:scoped_query_timer_p80_ns* + +_optional_ +a¦ + +[markdown] +-- +The 80th percentile runtime for Search queries received at the scoped query endpoint in nanoseconds. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*BUCKET:INDEX:scoped_query_timer_p99_ns* + +_optional_ +a¦ + +[markdown] +-- +The 99th percentile runtime for Search queries received at the scoped query endpoint in nanoseconds. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*BUCKET:INDEX:timer_batch_store_count* + +_optional_ +a¦ + +[markdown] +-- +The total number of times batches were executed against the given Search index. + +Batches are a data structure in the Search Service, used for processing data coming in from DCP and the Data Service to the documents in a Search index. +A batch is executed when it's flushed to disk. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:timer_data_delete_count* + +_optional_ +a¦ + +[markdown] +-- +The total number of delete operations received from DCP for the given Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:timer_data_update_count* + +_optional_ +a¦ + +[markdown] +-- +The total number of create or update operations received from DCP for the given Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:timer_opaque_get_count* + +_optional_ +a¦ + +[markdown] +-- +The total number of times the DCP consumer had to retrieve stored metadata to aid in reconnection for the given Search index. + +If the DCP connection closes, the Search Service can use this stored metadata to resume from the last stable point. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:timer_opaque_set_count* + +_optional_ +a¦ + +[markdown] +-- +The total number of times the DCP consumer updated stored metadata, based on changes to Snapshot markers or the failover log, for the given Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:timer_rollback_count* + +_optional_ +a¦ + +[markdown] +-- +The total number of DCP Rollback messages received for the given Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:timer_snapshot_start_count* + +_optional_ +a¦ + +[markdown] +-- +The total number of DCP Snapshot markers received for the given Search index. + +Snapshots contain a representation of document mutations on either a write queue or in storage. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:tot_seq_received* + +_optional_ +a¦ + +[markdown] +-- +This metric is no longer used and will soon be deprecated. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_bytes_indexed* + +_optional_ +a¦ + +[markdown] +-- +The rate, in bytes per second, of content indexed in the given Search index. + +This statistic appears on the Server Web Console dashboard as **Search Index Rate**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_bytes_query_results* + +_optional_ +a¦ + +[markdown] +-- +The size of results returned for Search queries on the given Search index. +This includes the size of all JSON sent. + +This statistic appears on the Server Web Console dashboard as **Search Result Rate**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_compaction_written_bytes* + +_optional_ +a¦ + +[markdown] +-- +The total number of bytes written to disk as a result of compaction operations on the given Search index. + +This statistic appears on the Server Web Console dashboard as **Search Compaction Rate**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_grpc_internal_queries* + +_optional_ +a¦ + +[markdown] +-- +The total number of internal gRPC requests from the coordinating node for a Search query to other nodes running the Search Service, for the given Search index. + +The Search Service uses gRPC to manage scatter-gather operations across nodes when there are multiple nodes running the Search Service in a cluster. +The coordinating node is the Search node that receives the Search request and scatters it to all other Search index partitions on other nodes. +The coordinating node applies filters to the results from all Search index partitions and returns the final result set. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_grpc_queries* + +_optional_ +a¦ + +[markdown] +-- +The total number of queries, using gRPC for streaming, for the given Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_grpc_queries_error* + +_optional_ +a¦ + +[markdown] +-- +The total number of queries that resulted in an error that used gRPC for streaming on the given Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_grpc_queries_slow* + +_optional_ +a¦ + +[markdown] +-- +The total number of queries added to the slow query log that used gRPC for streaming on the given Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_grpc_queries_timeout* + +_optional_ +a¦ + +[markdown] +-- +The total number of queries that timed out that used gRPC for streaming on the given Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_grpc_request_time* + +_optional_ +a¦ + +[markdown] +-- +The total time, in nanoseconds, for internal scatter-gather requests. + +The Search Service uses gRPC to manage scatter-gather operations across nodes when there are multiple nodes running the Search Service in a cluster. +The coordinating node is the Search node that receives the Search request and scatters it to all other Search index partitions on other nodes. +The coordinating node applies filters to the results from all Search index partitions and returns the final result set. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_internal_queries* + +_optional_ +a¦ + +[markdown] +-- +The number of internal queries from the coordinating node for a Search query to other nodes running the Search Service, for the given Search index. + +The Search Service uses gRPC to manage scatter-gather operations across nodes when there are multiple nodes running the Search Service in a cluster. +The coordinating node is the Search node that receives the Search request and scatters it to all other Search index partitions on other nodes. +The coordinating node applies filters to the results from all Search index partitions and returns the final result set. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_knn_searches* + +_optional_ +a¦ + +[markdown] +-- +The total number of [Vector Search](https://docs.couchbase.com/server/8.0/vector-search/vector-search.html) requests made to the given Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_queries* + +_optional_ +a¦ + +[markdown] +-- +The total number of Search queries per second on the given Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_queries_error* + +_optional_ +a¦ + +[markdown] +-- +The total number of Search queries on the given Search index that resulted in an error. + +This statistic appears on the Server Web Console dashboard as **Search Query Error Rate**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_queries_slow* + +_optional_ +a¦ + +[markdown] +-- +The total number of Search queries on the given Search index in the slow query log. + +Slow queries are any queries that take longer than 5 seconds to run. + +This statistic appears on the Server Web Console dashboard as **Search Slow Queries**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_queries_timeout* + +_optional_ +a¦ + +[markdown] +-- +The total number of Search queries on the given Search index that timed out. + +This statistic appears on the Server Web Console dashboard as **Search Query Timeout Rate**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_request_time* + +_optional_ +a¦ + +[markdown] +-- +The total time, in nanoseconds, spent processing Search query requests for the given Search index. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_term_searchers* + +_optional_ +a¦ + +[markdown] +-- +The total number of term searchers for the given Search index. + +Every Search query requires 1 or more term searchers. +More complex Search queries typically require more term searchers. + +Use this statistic to approximate how complex a query is. + +This statistic appears on the Server Web Console dashboard as **Term Searchers Start Rate**. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_term_searchers_finished* + +_optional_ +a¦ + +[markdown] +-- +The total number of term searchers on the given Search index that have finished serving a Search query. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*BUCKET:INDEX:total_vectors* + +_optional_ +a¦ + +[markdown] +-- +The total number of vectors inside the given Search index, across all indexed fields. + +If there are no vectors inside the Search index, the REST API does not return this statistic. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +|=== + +//end::indexStats[] + + + + +// markup not found, no include::{specDir}definitions/indexStats/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/indexStats/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/Admin/security-scheme-before.adoc[opts=optional] + + +[[security-admin]] += Admin + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Admin/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +You must have the **Full Admin**, **Cluster Admin**, or **Bucket Admin** role, with FTS Read permissions on the required bucket. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/Admin/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/Admin/security-scheme-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}security/Statistics/security-scheme-before.adoc[opts=optional] + + +[[security-statistics]] += Statistics + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Statistics/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +You must have the **Search Admin** role, with Stats Read permissions on the required bucket. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/Statistics/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/Statistics/security-scheme-after.adoc[opts=optional] + + + + +include::{specDir}security/document-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] + + diff --git a/docs/modules/fts-rest-stats/partials/header-attributes.adoc b/docs/modules/fts-rest-stats/partials/header-attributes.adoc new file mode 100644 index 00000000..37f11fa7 --- /dev/null +++ b/docs/modules/fts-rest-stats/partials/header-attributes.adoc @@ -0,0 +1,6 @@ +:page-meta-robots: noindex +:page-embargo: EMBARGOED +:page-partial: +:!example-caption: +:description: The Search Statistics REST API is provided by the Search Service. \ +This API enables you to get statistics for the Search Service and your Search indexes. diff --git a/docs/modules/fts-rest-stats/partials/overview/document-before.adoc b/docs/modules/fts-rest-stats/partials/overview/document-before.adoc new file mode 100644 index 00000000..1fb78375 --- /dev/null +++ b/docs/modules/fts-rest-stats/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/fts-rest-stats/partials/paths/g-api-nsstats-index-name/http-response.adoc b/docs/modules/fts-rest-stats/partials/paths/g-api-nsstats-index-name/http-response.adoc new file mode 100644 index 00000000..acbf5dff --- /dev/null +++ b/docs/modules/fts-rest-stats/partials/paths/g-api-nsstats-index-name/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$g-api-nsstats-index-name.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-stats/partials/paths/g-api-nsstats/http-response.adoc b/docs/modules/fts-rest-stats/partials/paths/g-api-nsstats/http-response.adoc new file mode 100644 index 00000000..24f10fe2 --- /dev/null +++ b/docs/modules/fts-rest-stats/partials/paths/g-api-nsstats/http-response.adoc @@ -0,0 +1,21 @@ += Example HTTP Response + +A successful response returns an object like the following, which contains statistics on 2 indexes, `travel-sample-index` and `color-test`. + +==== +.Response 200 +[source,json] +---- +include::example$g-api-nsstats-200.json[] +---- +==== + +If a user authenticates but does not have the appropriate permissions, the API returns a `403 Forbidden` response with an object similar to the following. + +==== +.Response 403 +[source,json] +---- +include::example$g-api-nsstats-403.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/fts-rest-stats/partials/security/document-begin.adoc b/docs/modules/fts-rest-stats/partials/security/document-begin.adoc new file mode 100644 index 00000000..753b6c55 --- /dev/null +++ b/docs/modules/fts-rest-stats/partials/security/document-begin.adoc @@ -0,0 +1,2 @@ +The Search REST APIs support HTTP basic authentication. +Pass your credentials through HTTP headers. \ No newline at end of file diff --git a/docs/modules/fts-rest-stats/partials/security/document-end.adoc b/docs/modules/fts-rest-stats/partials/security/document-end.adoc new file mode 100644 index 00000000..5330f469 --- /dev/null +++ b/docs/modules/fts-rest-stats/partials/security/document-end.adoc @@ -0,0 +1 @@ +For more information, see xref:learn:security/roles.adoc[]. \ No newline at end of file diff --git a/docs/modules/fts-rest-stats/search-stats.gradle b/docs/modules/fts-rest-stats/search-stats.gradle new file mode 100644 index 00000000..7e72a7ac --- /dev/null +++ b/docs/modules/fts-rest-stats/search-stats.gradle @@ -0,0 +1,23 @@ +apply plugin: 'org.openapi.generator' + +openApiGenerate { + generatorName = "asciidoc" + remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/morpheus/docs/spec/stats/stats.yaml" + outputDir = "${rootDir}/docs/modules/fts-rest-stats/pages" + templateDir = "${rootDir}/templates" + gitRepoId = "cbft" + gitUserId = "couchbase" + additionalProperties = [ + specDir: "${rootDir}/docs/modules/fts-rest-stats/partials/", + snippetDir: "${rootDir}/docs/modules/fts-rest-stats/partials/paths/", + headerAttributes: "true", + useIntroduction: "true", + useTableTitles: "true", + skipExamples: "true", + legacyDiscriminatorBehavior: "true" + ] + globalProperties = [ + generateAliasAsModel: "true" + ] + generateAliasAsModel = true +} \ No newline at end of file diff --git a/docs/modules/index-rest-settings/attachments/_index-settings.yaml b/docs/modules/index-rest-settings/attachments/_index-settings.yaml new file mode 100644 index 00000000..ea66cfa0 --- /dev/null +++ b/docs/modules/index-rest-settings/attachments/_index-settings.yaml @@ -0,0 +1,722 @@ +openapi: 3.0.3 +info: + title: Index Settings REST API + version: '8.0' + description: |- + The Index Settings REST API is provided by the Index Service. + This API enables you to retrieve or set Index Service settings. + + Changes automatically propagate to all Index Service nodes, and will be remembered across node and cluster restarts. + + Unless otherwise noted, you should only change the Index Service settings when advised to do so by Couchbase Support. + +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 Index Service. + port: + default: "9102" + description: |- + The Index Service REST port. + Use `19102` for secure access. + enum: + - "9102" + - "19102" + +paths: + /settings: + get: + operationId: get_settings + summary: Retrieve Index Settings + description: Returns Index Service settings. + security: + - Default: [] + responses: + "200": + description: |- + Success. + Returns an object giving Index Service settings. + content: + application/json: + schema: + $ref: "#/components/schemas/Settings" + example: + $ref: "../examples/get_settings.json" + "404": + $ref: '#/components/responses/NotFound' + "401": + $ref: '#/components/responses/Unauthorized' + post: + operationId: post_settings + summary: Update Index Settings + description: Updates Index Service settings. + security: + - Default: [] + requestBody: + required: true + description: |- + An object specifying Index Service settings. + You only need to specify the settings you want to change; settings which are not specified are left unchanged. + content: + application/json: + schema: + $ref: "#/components/schemas/Settings" + responses: + "200": + description: |- + Success. + Returns `OK` and no object. + "401": + $ref: '#/components/responses/Unauthorized' + "404": + $ref: '#/components/responses/NotFound' + +components: + schemas: + Settings: + type: object + properties: + indexer.rebalance.transferBatchSize: + type: integer + format: int32 + x-has-default: true + default: 3 + x-has-example: true + example: 7 + writeOnly: true + description: |- + Sets the batch size Couchbase Server uses when rebuilding index files during rebalance. + This setting has no effect on file-based rebalance. + + Couchbase Server breaks the rebuilding of indexes during a rebalance into batches to limit the performance impact. + This setting controls the maximum number of indexes that a rebalance rebuilds concurrently. + You must have the Full Admin or the Cluster Admin role to set this value. + + For an overview of rebalance as it affects the Index Service, including an overview of smart batching, see [Rebalance](/server/8.0/learn/clusters-and-availability/rebalance.html#rebalancing-the-index-service). + indexer.settings.allow_large_keys: + type: boolean + x-has-default: true + default: true + description: |- + Whether the size of index keys is unlimited. + + * If true, index keys may have unlimited size. + * If false, the maximum size for index keys and array index keys is specified by `indexer.settings.max_seckey_size` and `indexer.settings.max_array_seckey_size`. + + In Couchbase Server 6.5 and later, the Index Service does not need to restart when you update this setting. + indexer.settings.bufferPoolBlockSize: + type: integer + format: int32 + x-has-default: true + default: 16384 + description: Buffer pool block size. + indexer.settings.build.batch_size: + type: integer + format: int32 + x-has-default: true + default: 5 + description: Build batch size. + indexer.settings.compaction.abort_exceed_interval: + type: boolean + x-has-default: true + default: false + description: Whether to abort index compaction if it is still running after the end of the index compaction interval. + indexer.settings.compaction.check_period: + type: integer + format: int32 + x-has-default: true + default: 30 + description: An interval, specifying how frequently the Index Service checks whether the compaction threshold has been reached (seconds). + indexer.settings.compaction.compaction_mode: + type: string + x-has-default: true + default: circular + description: The compaction mode for indexes. + enum: + - standard + - circular + indexer.settings.compaction.days_of_week: + type: string + x-has-example: true + example: Saturday,Sunday + x-has-default: true + default: Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday + description: |- + The days of the week on which circular compaction is to run, if specified. + Individual values must be day-names, each specified with an initial capital, and otherwise lower-case. + Multiple values must be separated by a single comma, with no spaces. + indexer.settings.compaction.interval: + type: string + x-has-example: true + example: 01:00,05:59 + x-has-default: true + default: 00:00,00:00 + description: |- + A string in the form `fromHour:fromMinute,toHour:toMinute`, specifying the interval during which index compaction can run. + + * `fromHour` — + An integer between 0 and 23 inclusive, specifying the starting hour of the interval. + * `fromMinute` — + An integer between 0 and 59 inclusive, specifying the starting minute of the interval, within the specified starting hour. + * `toHour` — + An integer between 0 and 23 inclusive, specifying the concluding hour of the interval. + * `toMinute` — + An integer between 0 and 59 inclusive, specifying the concluding minute of the interval, within the specified concluding hour. + + The default value means any time. + indexer.settings.compaction.min_frag: + type: integer + format: int32 + x-has-default: true + default: 30 + minimum: 5 + description: The minimum fragmentation threshold to trigger compaction (percentage). + indexer.settings.compaction.min_size: + type: integer + format: int32 + x-has-default: true + default: 524288000 + description: Compaction minimum file size. + indexer.settings.compaction.plasma.manual: + type: boolean + x-has-default: true + default: false + description: For standard indexes using Plasma, whether compaction should be triggered manually. + indexer.settings.compaction.plasma.optional.decrement: + type: integer + format: int32 + x-has-default: true + default: 5 + description: For standard indexes using Plasma, the optional decrement. + indexer.settings.compaction.plasma.optional.min_frag: + type: integer + format: int32 + x-has-default: true + default: 20 + description: For standard indexes using Plasma, the minimum fragmentation threshold to trigger compaction (percentage). + indexer.settings.compaction.plasma.optional.quota: + type: integer + format: int32 + x-has-default: true + default: 25 + description: For standard indexes using Plasma, the optional quota. + indexer.settings.corrupt_index_num_backups: + type: integer + format: int32 + x-has-default: true + default: 1 + description: Corrupt index number of backups. + indexer.settings.cpuProfDir: + type: string + description: The name of the directory where local CPU usage profiling information is captured. + indexer.settings.cpuProfile: + type: boolean + x-has-default: true + default: false + description: Whether the Index Service should capture local CPU usage profiling information. + indexer.settings.defer_build: + type: boolean + x-has-default: true + default: false + description: |- + The default setting for the `defer_build` option for index creation. + + * If this setting is true, and you create an index without specifying `defer_build`, the index is not built immediately. + * If this setting false, and you create an index without specifying `defer_build`, the index is built immediately. + + You can override this setting by specifying the `defer_build` option when you create an index. + indexer.settings.eTagPeriod: + type: integer + format: int32 + x-has-default: true + default: 240 + description: The ETag (entity tag) period. + indexer.settings.enable_corrupt_index_backup: + type: boolean + x-has-default: true + default: false + description: Whether corrupt index backup is enabled. + indexer.settings.enable_page_bloom_filter: + type: boolean + x-has-default: true + default: true + description: |- + Whether Bloom filters are enabled for memory management. + + For details, see [Per Page Bloom Filters](/server/8.0/learn/services-and-indexes/indexes/storage-modes.html#per-page-bloom-filters). + indexer.settings.enable_shard_affinity: + type: boolean + x-has-default: true + default: false + description: |- + Selects the index rebalance method. + See [Index Rebalance Methods](/server/8.0/learn/clusters-and-availability/rebalance.html#index-rebalance-methods). + + * If false (the default), Index Service nodes rebuild indexes that are newly assigned to them during a rebalance. + + * If true, Couchbase Server moves a reassigned index's files between Index Service nodes. + + If set to true, when you create an index, you can use the `WITH` clause to specify which node should contain the index. + However, when you alter an index, you cannot use the `WITH` clause to specify which node should contain the index. + indexer.settings.fast_flush_mode: + type: boolean + x-has-default: true + default: true + description: Whether fast flush mode is enabled. + indexer.settings.gc_percent: + type: integer + format: int32 + x-has-default: true + default: 100 + description: Garbage collection percentage. + indexer.settings.inmemory_snapshot.fdb.interval: + type: integer + format: int32 + x-has-default: true + default: 200 + minimum: 1 + exclusiveMinimum: true + description: |- + For standard indexes using ForestDB, the in-memory snapshotting interval (ms). + This determines the earliest possibility of a scan seeing a given KV mutation. + indexer.settings.inmemory_snapshot.interval: + type: integer + format: int32 + x-has-default: true + default: 200 + minimum: 1 + exclusiveMinimum: true + description: |- + The in-memory snapshotting interval (ms). + This determines the earliest possibility of a scan seeing a given KV mutation. + indexer.settings.inmemory_snapshot.moi.interval: + type: integer + format: int32 + minimum: 1 + exclusiveMinimum: true + x-has-default: true + default: 10 + description: |- + For memory-optimized indexes, the in-memory snapshotting interval (ms). + This determines the earliest possibility of a scan seeing a given KV mutation. + indexer.settings.largeSnapshotThreshold: + type: integer + format: int32 + x-has-default: true + default: 200 + description: The large snapshot threshold. + indexer.settings.log_level: + type: string + x-has-default: true + default: info + description: Indexer logging level. + enum: + - silent + - fatal + - error + - warn + - info + - verbose + - timing + - debug + - trace + indexer.settings.maxNumPartitions: + type: integer + format: int32 + x-has-default: true + default: 64 + description: Maximum number of partitions. + indexer.settings.maxVbQueueLength: + type: integer + format: int32 + x-has-default: true + default: 0 + description: Maximum vBucket queue length. + indexer.settings.max_array_seckey_size: + type: integer + format: int32 + x-has-default: true + default: 10240 + description: |- + If `indexer.settings.allow_large_keys` is false, this setting specifies the maximum size for array index keys. + + In Couchbase Server 6.5 and later, the Index Service does not need to restart when you update this setting. + indexer.settings.max_cpu_percent: + type: integer + format: int32 + x-has-default: true + default: 0 + description: |- + The CPU capacity that the Index Service should use (percentage). + If set to `0`, the indexer will use all CPUs. + indexer.settings.max_seckey_size: + type: integer + format: int32 + x-has-default: true + default: 4608 + description: |- + If `indexer.settings.allow_large_keys` is false, this setting specifies the maximum size for index keys. + + In Couchbase Server 6.5 and later, the Index Service does not need to restart when you update this setting. + indexer.settings.max_writer_lock_prob: + type: integer + format: int32 + x-has-default: true + default: 20 + description: Maximum writer lock prob. + indexer.settings.memProfDir: + type: string + description: The name of the directory where local memory usage profiling information is captured. + indexer.settings.memProfile: + type: boolean + x-has-default: true + default: false + description: Whether the Index Service should capture local memory usage profiling information. + indexer.settings.memory_quota: + type: integer + format: int32 + x-has-default: true + default: 536870912 + description: How much RAM is allocated to the Index Service for the current node. + indexer.settings.minVbQueueLength: + type: integer + format: int32 + x-has-default: true + default: 30 + description: Minimum vBucket queue length. + indexer.settings.moi.debug: + type: boolean + x-has-default: true + default: false + description: Debug memory-optimized index storage. + indexer.settings.moi.persistence_threads: + type: integer + format: int32 + x-has-default: true + default: 4 + description: For memory-optimized index storage, the number of persistence threads. + indexer.settings.moi.recovery.max_rollbacks: + type: integer + format: int32 + x-has-default: true + default: 2 + description: For memory-optimized index storage, the maximum number of committed rollback points. + indexer.settings.moi.recovery_threads: + type: integer + format: int32 + x-has-default: true + default: 8 + description: For memory-optimized index storage, the number of recovery threads. + indexer.settings.num_replica: + type: integer + format: int32 + x-has-default: true + default: 0 + x-has-example: true + example: 2 + description: The default number of index replicas to be created by the Index Service whenever `CREATE INDEX` is invoked. + indexer.settings.percentage_memory_quota: + type: integer + format: int32 + x-has-default: true + default: 0 + description: Percentage memory quota. + indexer.settings.persisted_snapshot.fdb.interval: + type: integer + format: int32 + x-has-default: true + default: 5000 + minimum: 100 + description: |- + For standard indexes using ForestDB, the persisted snapshotting interval (ms). + This must be a multiple of the in-memory snapshot interval. + indexer.settings.persisted_snapshot.interval: + type: integer + format: int32 + x-has-default: true + default: 5000 + minimum: 100 + description: |- + The persisted snapshotting interval (ms). + This must be a multiple of the in-memory snapshot interval. + indexer.settings.persisted_snapshot.moi.interval: + type: integer + format: int32 + x-has-default: true + default: 600000 + minimum: 100 + description: |- + For memory-optimized indexes, the persisted snapshotting interval (ms). + This must be a multiple of the in-memory snapshot interval. + indexer.settings.persisted_snapshot_init_build.fdb.interval: + type: integer + format: int32 + x-has-default: true + default: 5000 + description: For standard indexes using ForestDB, the persisted snapshotting interval for the initial build (ms). + indexer.settings.persisted_snapshot_init_build.interval: + type: integer + format: int32 + x-has-default: true + default: 5000 + description: The persisted snapshotting interval for the initial build (ms). + indexer.settings.persisted_snapshot_init_build.moi.interval: + type: integer + format: int32 + x-has-default: true + default: 600000 + description: For memory-optimized indexes, the persisted snapshotting interval for the initial build (ms). + indexer.settings.plasma.recovery.max_rollbacks: + type: integer + format: int32 + x-has-default: true + default: 2 + description: For standard indexes using Plasma, the maximum number of committed rollback points. + indexer.settings.rebalance.blob_storage_bucket: + type: string + x-has-default: true + default: "" + description: Rebalance blob storage bucket. + indexer.settings.rebalance.blob_storage_prefix: + type: string + x-has-default: true + default: "" + description: Rebalance blob storage prefix. + indexer.settings.rebalance.blob_storage_region: + type: string + x-has-default: true + default: "" + description: Rebalance blob storage region. + indexer.settings.rebalance.blob_storage_scheme: + type: string + x-has-default: true + default: "" + description: Rebalance blob storage scheme. + indexer.settings.rebalance.redistribute_indexes: + type: boolean + x-has-default: true + default: false + description: |- + Whether to redistribute indexes on rebalance. + + * When true, Couchbase Server redistributes indexes when rebalance occurs, in order to optimize performance. + + * When false (the default), such redistribution does not occur. + + For details, see [Rebalance](/server/8.0/learn/clusters-and-availability/rebalance.html#rebalancing-the-index-service). + indexer.settings.recovery.max_rollbacks: + type: integer + format: int32 + x-has-default: true + default: 2 + description: The maximum number of committed rollback points. + indexer.settings.scan_getseqnos_retries: + type: integer + format: int32 + x-has-default: true + default: 30 + description: Scan get sequence numbers retries. + indexer.settings.scan_timeout: + type: integer + format: int32 + x-has-default: true + default: 120000 + description: |- + The default timeout for the indexer, in milliseconds. + This is distinct from the Query Service timeout. + The Index Service has its own timeout because index scans consume resources such as memory and CPU while holding snapshots and performing range scan. + + An index scan may time out if the Index Service timeout is lower than the Query Service timeout. + indexer.settings.send_buffer_size: + type: integer + format: int32 + x-has-default: true + default: 1024 + description: Send buffer size. + indexer.settings.serverless.indexLimit: + type: integer + format: int32 + x-has-default: true + default: 201 + description: Serverless index limit. + indexer.settings.sliceBufSize: + type: integer + format: int32 + x-has-default: true + default: 1600 + description: Slice buffer size. + indexer.settings.smallSnapshotThreshold: + type: integer + format: int32 + x-has-default: true + default: 30 + description: Small snapshot threshold. + indexer.settings.snapshotListeners: + type: integer + format: int32 + x-has-default: true + default: 4 + description: Snapshot listeners. + indexer.settings.snapshotRequestWorkers: + type: integer + format: int32 + x-has-default: true + default: 4 + description: Snapshot request workers. + indexer.settings.statsLogDumpInterval: + type: integer + format: int32 + x-has-default: true + default: 60 + description: Statistics log dump interval. + indexer.settings.storage_mode: + $ref: "#/components/schemas/SettingsStorageMode" + indexer.settings.storage_mode.disable_upgrade: + type: boolean + x-has-default: true + default: false + description: Whether upgrade of the index storage mode is disabled. + indexer.settings.thresholds.mem_high: + type: integer + format: int32 + x-has-default: true + default: 70 + description: High memory threshold. + indexer.settings.thresholds.mem_low: + type: integer + format: int32 + x-has-default: true + default: 50 + description: Low memory threshold. + indexer.settings.thresholds.units_high: + type: integer + format: int32 + x-has-default: true + default: 60 + description: High units threshold. + indexer.settings.thresholds.units_low: + type: integer + format: int32 + x-has-default: true + default: 40 + description: Low units threshold. + indexer.settings.units_quota: + type: integer + format: int32 + x-has-default: true + default: 10000 + description: Units quota. + indexer.settings.wal_size: + type: integer + format: int32 + x-has-default: true + default: 4096 + description: Write-ahead log size. + projector.settings.log_level: + type: string + x-has-default: true + default: info + description: Projector logging level. + queryport.client.settings.backfillLimit: + type: integer + format: int32 + x-has-default: true + default: 5120 + description: |- + The maximum size of the backfill file (MB). + + * A value of `0` disables backfill. + * A value of `-1` means the size is unlimited. + + The maximum size is limited only by the available disk space. + queryport.client.settings.closeActiveConnections: + type: boolean + x-has-default: true + default: true + description: Whether to close active connections. + queryport.client.settings.minPoolSizeWM: + type: integer + format: int32 + x-has-default: true + default: 1000 + description: Minimum pool size. + queryport.client.settings.poolOverflow: + type: integer + format: int32 + x-has-default: true + default: 30 + description: Maximum number of connections in a pool. + queryport.client.settings.poolSize: + type: integer + format: int32 + x-has-default: true + default: 5000 + description: Number of simultaneous active connections in a pool. + queryport.client.settings.relConnBatchSize: + type: integer + format: int32 + x-has-default: true + default: 100 + description: Connection batch size. + SettingsStorageMode: + title: Storage Mode + description: The storage mode to be used for the Index Service on this node. + oneOf: + - $ref: "#/components/schemas/SettingsStorageModeEE" + - $ref: "#/components/schemas/SettingsStorageModeCE" + SettingsStorageModeEE: + title: Enterprise Edition + type: string + default: plasma + x-desc-edition: "{enterprise}" + description: |- + If you are using Enterprise Edition, the possible values are: + + * `plasma` (the default) — + Sets the index storage mode to use the Plasma storage engine, which can utilize both memory and persistent storage for index maintenance and index scans. + + * `memory_optimized` — + Sets the index storage mode to use memory optimized global secondary indexes, which can perform index maintenance and index scan faster at in-memory speeds. + + This setting can only be changed while there are no index nodes in the cluster. + To change from standard GSI to memory optimized GSI or vice versa, you need to remove all the Index Service nodes in the cluster. + enum: + - plasma + - memory_optimized + SettingsStorageModeCE: + title: Community Edition + type: string + default: forestdb + x-desc-edition: "{community}" + description: |- + If you are using Community Edition, the default (and only) value is `forestdb`. + enum: + - forestdb + + responses: + NotFound: + description: |- + Not found. + The URL may be specified incorrectly. + Unauthorized: + description: |- + Unauthorized. + Failure to authenticate. + + securitySchemes: + Default: + type: http + scheme: basic + description: |- + Users must have the Full Admin or Cluster Admin role, with Cluster Read and Bucket INDEX List privileges. diff --git a/docs/modules/index-rest-settings/examples/get_settings.json b/docs/modules/index-rest-settings/examples/get_settings.json new file mode 100644 index 00000000..0ddb0911 --- /dev/null +++ b/docs/modules/index-rest-settings/examples/get_settings.json @@ -0,0 +1,84 @@ +{ + "indexer.settings.allow_large_keys": true, + "indexer.settings.bufferPoolBlockSize": 16384, + "indexer.settings.build.batch_size": 5, + "indexer.settings.compaction.abort_exceed_interval": false, + "indexer.settings.compaction.check_period": 30, + "indexer.settings.compaction.compaction_mode": "circular", + "indexer.settings.compaction.days_of_week": "Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday", + "indexer.settings.compaction.interval": "00:00,00:00", + "indexer.settings.compaction.min_frag": 30, + "indexer.settings.compaction.min_size": 524288000, + "indexer.settings.compaction.plasma.manual": false, + "indexer.settings.compaction.plasma.optional.decrement": 5, + "indexer.settings.compaction.plasma.optional.min_frag": 20, + "indexer.settings.compaction.plasma.optional.quota": 25, + "indexer.settings.corrupt_index_num_backups": 1, + "indexer.settings.cpuProfDir": "", + "indexer.settings.cpuProfile": false, + "indexer.settings.defer_build": false, + "indexer.settings.eTagPeriod": 240, + "indexer.settings.enable_corrupt_index_backup": false, + "indexer.settings.enable_page_bloom_filter": true, + "indexer.settings.enable_shard_affinity": false, + "indexer.settings.fast_flush_mode": true, + "indexer.settings.gc_percent": 100, + "indexer.settings.inmemory_snapshot.fdb.interval": 200, + "indexer.settings.inmemory_snapshot.interval": 200, + "indexer.settings.inmemory_snapshot.moi.interval": 10, + "indexer.settings.largeSnapshotThreshold": 200, + "indexer.settings.log_level": "info", + "indexer.settings.maxNumPartitions": 64, + "indexer.settings.maxVbQueueLength": 0, + "indexer.settings.max_array_seckey_size": 10240, + "indexer.settings.max_cpu_percent": 0, + "indexer.settings.max_seckey_size": 4608, + "indexer.settings.max_writer_lock_prob": 20, + "indexer.settings.memProfDir": "", + "indexer.settings.memProfile": false, + "indexer.settings.memory_quota": 536870912, + "indexer.settings.minVbQueueLength": 30, + "indexer.settings.moi.debug": false, + "indexer.settings.moi.persistence_threads": 4, + "indexer.settings.moi.recovery.max_rollbacks": 2, + "indexer.settings.moi.recovery_threads": 8, + "indexer.settings.num_replica": 0, + "indexer.settings.percentage_memory_quota": 0, + "indexer.settings.persisted_snapshot.fdb.interval": 5000, + "indexer.settings.persisted_snapshot.interval": 5000, + "indexer.settings.persisted_snapshot.moi.interval": 600000, + "indexer.settings.persisted_snapshot_init_build.fdb.interval": 5000, + "indexer.settings.persisted_snapshot_init_build.interval": 5000, + "indexer.settings.persisted_snapshot_init_build.moi.interval": 600000, + "indexer.settings.plasma.recovery.max_rollbacks": 2, + "indexer.settings.rebalance.blob_storage_bucket": "", + "indexer.settings.rebalance.blob_storage_prefix": "", + "indexer.settings.rebalance.blob_storage_region": "", + "indexer.settings.rebalance.blob_storage_scheme": "", + "indexer.settings.rebalance.redistribute_indexes": false, + "indexer.settings.recovery.max_rollbacks": 2, + "indexer.settings.scan_getseqnos_retries": 30, + "indexer.settings.scan_timeout": 120000, + "indexer.settings.send_buffer_size": 1024, + "indexer.settings.serverless.indexLimit": 201, + "indexer.settings.sliceBufSize": 1600, + "indexer.settings.smallSnapshotThreshold": 30, + "indexer.settings.snapshotListeners": 4, + "indexer.settings.snapshotRequestWorkers": 4, + "indexer.settings.statsLogDumpInterval": 60, + "indexer.settings.storage_mode": "plasma", + "indexer.settings.storage_mode.disable_upgrade": false, + "indexer.settings.thresholds.mem_high": 70, + "indexer.settings.thresholds.mem_low": 50, + "indexer.settings.thresholds.units_high": 60, + "indexer.settings.thresholds.units_low": 40, + "indexer.settings.units_quota": 10000, + "indexer.settings.wal_size": 4096, + "projector.settings.log_level": "info", + "queryport.client.settings.backfillLimit": 5120, + "queryport.client.settings.closeActiveConnections": true, + "queryport.client.settings.minPoolSizeWM": 1000, + "queryport.client.settings.poolOverflow": 30, + "queryport.client.settings.poolSize": 5000, + "queryport.client.settings.relConnBatchSize": 100 +} \ No newline at end of file diff --git a/docs/modules/index-rest-settings/index-settings.gradle b/docs/modules/index-rest-settings/index-settings.gradle new file mode 100644 index 00000000..c8048405 --- /dev/null +++ b/docs/modules/index-rest-settings/index-settings.gradle @@ -0,0 +1,23 @@ +apply plugin: 'org.openapi.generator' + +openApiGenerate { + generatorName = "asciidoc" + inputSpec = file("attachments/_index-settings.yaml").getAbsolutePath().toString() + outputDir = "${rootDir}/docs/modules/index-rest-settings/pages" + templateDir = "${rootDir}/templates" + gitRepoId = "cb-swagger" + gitUserId = "couchbaselabs" + additionalProperties = [ + specDir: "${rootDir}/docs/modules/index-rest-settings/partials/", + snippetDir: "${rootDir}/docs/modules/index-rest-settings/partials/paths/", + headerAttributes: "true", + useIntroduction: "true", + useTableTitles: "true", + skipExamples: "true", + legacyDiscriminatorBehavior: "true" + ] + globalProperties = [ + generateAliasAsModel: "true" + ] + generateAliasAsModel = true +} \ No newline at end of file diff --git a/docs/modules/index-rest-settings/pages/index.adoc b/docs/modules/index-rest-settings/pages/index.adoc new file mode 100644 index 00000000..165c65ce --- /dev/null +++ b/docs/modules/index-rest-settings/pages/index.adoc @@ -0,0 +1,2169 @@ += Index Settings 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/couchbaselabs/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 Index Settings REST API is provided by the Index Service. +This API enables you to retrieve or set Index Service settings. + +Changes automatically propagate to all Index Service nodes, and will be remembered across node and cluster restarts. + +Unless otherwise noted, you should only change the Index Service settings when advised to do so by Couchbase Support. +-- + +[discrete#version] += Version information +[%hardbreaks] +__Version__ : 8.0 + +[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 Index Service. +-- + +[%hardbreaks] + +*Example:* `+++localhost+++` +// end + +a| *port* +a| [markdown] +-- +The Index Service REST port. Use `19102` for secure access. +-- + +[%hardbreaks] +*Values:* `9102`, `19102` +*Example:* `+++9102+++` +// 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: 1 + +: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] +xref:tag-Default[] +endif::[] + + +ifeval::[{count-apis} > 1] +[#tag-Default] += Default +:leveloffset: +1 + +ifeval::["" != ""] + +endif::[] +ifeval::["" == ""] +**{toc-title}** +endif::[] +endif::[] + +[%hardbreaks] +xref:get_settings[] +xref:post_settings[] + + +//tag::get_settings[] + + +// markup not found, no include::{specDir}paths/get_settings/operation-before.adoc[opts=optional] + + +[#get_settings] += Retrieve Index Settings + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/get_settings/operation-begin.adoc[opts=optional] + + +.... +GET /settings +.... + + + +// markup not found, no include::{specDir}paths/get_settings/operation-description-before.adoc[opts=optional] + + +[#get_settings-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/get_settings/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns Index Service settings. +-- + + +// markup not found, no include::{specDir}paths/get_settings/operation-description-end.adoc[opts=optional] + + + +[#get_settings-produces] +.Produces +* application/json + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/get_settings/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get_settings/operation-parameters-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/get_settings/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get_settings/operation-responses-before.adoc[opts=optional] + + +[#get_settings-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/get_settings/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. Returns an object giving Index Service settings. +-- +a| xref:Settings[] + + +| 404 +a| [markdown] +-- +Not found. The URL may be specified incorrectly. +-- +a| +| 401 +a| [markdown] +-- +Unauthorized. Failure to authenticate. +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/get_settings/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/get_settings/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get_settings/operation-security-before.adoc[opts=optional] + + +[#get_settings-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/get_settings/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-default[] + +|=== + + +// markup not found, no include::{specDir}paths/get_settings/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}get_settings/http-request.adoc[opts=optional] + + +include::{snippetDir}get_settings/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get_settings/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/get_settings/operation-after.adoc[opts=optional] + + +//end::get_settings[] + + +//tag::post_settings[] + + +// markup not found, no include::{specDir}paths/post_settings/operation-before.adoc[opts=optional] + + +[#post_settings] += Update Index Settings + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/post_settings/operation-begin.adoc[opts=optional] + + +.... +POST /settings +.... + + + +// markup not found, no include::{specDir}paths/post_settings/operation-description-before.adoc[opts=optional] + + +[#post_settings-description] += Description + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/post_settings/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Updates Index Service settings. +-- + + +// markup not found, no include::{specDir}paths/post_settings/operation-description-end.adoc[opts=optional] + + +[#post_settings-consumes] +.Consumes +* application/json + + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/post_settings/operation-description-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/post_settings/operation-parameters-before.adoc[opts=optional] + + +[#post_settings-parameters] += Parameters + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/post_settings/operation-parameters-begin.adoc[opts=optional] + + + + + + +[#post_settings-body] +.Body Parameter +{blank} + +[cols="20,60,20",separator=¦] +|=== +¦ Name ¦ Description ¦ Schema + +a¦ *Body* + +_required_ +a¦ + + +[markdown] +-- +An object specifying Index Service settings. You only need to specify the settings you want to change; settings which are not specified are left unchanged. +-- + +[%hardbreaks] +{blank} + +a¦ xref:Settings[] + + + +|=== + + +// markup not found, no include::{specDir}paths/post_settings/operation-parameters-end.adoc[opts=optional] + +:leveloffset: -1 + + + + +// markup not found, no include::{specDir}paths/post_settings/operation-parameters-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/post_settings/operation-responses-before.adoc[opts=optional] + + +[#post_settings-responses] += Responses + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/post_settings/operation-responses-begin.adoc[opts=optional] + + +[cols="20,60,20"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| [markdown] +-- +Success. Returns `OK` and no object. +-- +a| +| 401 +a| [markdown] +-- +Unauthorized. Failure to authenticate. +-- +a| +| 404 +a| [markdown] +-- +Not found. The URL may be specified incorrectly. +-- +a| + +|=== + + +// markup not found, no include::{specDir}paths/post_settings/operation-responses-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}paths/post_settings/operation-responses-after.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/post_settings/operation-security-before.adoc[opts=optional] + + +[#post_settings-security] += Security + +:leveloffset: +1 + +// markup not found, no include::{specDir}paths/post_settings/operation-security-begin.adoc[opts=optional] + + +[cols="20,80"] +|=== +| Type | Name + +| http (basic) +| xref:security-default[] + +|=== + + +// markup not found, no include::{specDir}paths/post_settings/operation-security-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optional] + + + +include::{snippetDir}post_settings/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}post_settings/http-response.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/post_settings/operation-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}paths/post_settings/operation-after.adoc[opts=optional] + + +//end::post_settings[] + + +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 + + +: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] +xref:Settings[] +xref:SettingsStorageMode[] +ifdef::enum-definitions[] +xref:SettingsStorageModeCE[] +endif::enum-definitions[] +ifdef::enum-definitions[] +xref:SettingsStorageModeEE[] +endif::enum-definitions[] +endif::[] + + + +// markup not found, no include::{specDir}definitions/Settings/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#Settings] += Settings + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/Settings/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::Settings[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*indexer.rebalance.transferBatchSize* + +_optional_ +a¦ + +[markdown] +-- +Sets the batch size Couchbase Server uses when rebuilding index files during rebalance. +This setting has no effect on file-based rebalance. + +Couchbase Server breaks the rebuilding of indexes during a rebalance into batches to limit the performance impact. +This setting controls the maximum number of indexes that a rebalance rebuilds concurrently. +You must have the Full Admin or the Cluster Admin role to set this value. + +For an overview of rebalance as it affects the Index Service, including an overview of smart batching, see [Rebalance](/server/8.0/learn/clusters-and-availability/rebalance.html#rebalancing-the-index-service). +-- + +[%hardbreaks] +*Default:* `3` +*Example:* `7` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.allow_large_keys* + +_optional_ +a¦ + +[markdown] +-- +Whether the size of index keys is unlimited. + +* If true, index keys may have unlimited size. +* If false, the maximum size for index keys and array index keys is specified by `indexer.settings.max_seckey_size` and `indexer.settings.max_array_seckey_size`. + +In Couchbase Server 6.5 and later, the Index Service does not need to restart when you update this setting. +-- + +[%hardbreaks] +*Default:* `true` +{blank} +a¦ Boolean + + +a¦ +*indexer.settings.bufferPoolBlockSize* + +_optional_ +a¦ + +[markdown] +-- +Buffer pool block size. +-- + +[%hardbreaks] +*Default:* `16384` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.build.batch_size* + +_optional_ +a¦ + +[markdown] +-- +Build batch size. +-- + +[%hardbreaks] +*Default:* `5` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.compaction.abort_exceed_interval* + +_optional_ +a¦ + +[markdown] +-- +Whether to abort index compaction if it is still running after the end of the index compaction interval. +-- + +[%hardbreaks] +*Default:* `false` +{blank} +a¦ Boolean + + +a¦ +*indexer.settings.compaction.check_period* + +_optional_ +a¦ + +[markdown] +-- +An interval, specifying how frequently the Index Service checks whether the compaction threshold has been reached (seconds). +-- + +[%hardbreaks] +*Default:* `30` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.compaction.compaction_mode* + +_optional_ +a¦ + +[markdown] +-- +The compaction mode for indexes. +-- + +[%hardbreaks] +*Values:* `"standard"`, `"circular"` +*Default:* `+++"circular"+++` +{blank} +a¦ String + + +a¦ +*indexer.settings.compaction.days_of_week* + +_optional_ +a¦ + +[markdown] +-- +The days of the week on which circular compaction is to run, if specified. +Individual values must be day-names, each specified with an initial capital, and otherwise lower-case. +Multiple values must be separated by a single comma, with no spaces. +-- + +[%hardbreaks] +*Default:* `+++"Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday"+++` +*Example:* `+++"Saturday,Sunday"+++` +{blank} +a¦ String + + +a¦ +*indexer.settings.compaction.interval* + +_optional_ +a¦ + +[markdown] +-- +A string in the form `fromHour:fromMinute,toHour:toMinute`, specifying the interval during which index compaction can run. + +* `fromHour` — + An integer between 0 and 23 inclusive, specifying the starting hour of the interval. +* `fromMinute` — + An integer between 0 and 59 inclusive, specifying the starting minute of the interval, within the specified starting hour. +* `toHour` — + An integer between 0 and 23 inclusive, specifying the concluding hour of the interval. +* `toMinute` — + An integer between 0 and 59 inclusive, specifying the concluding minute of the interval, within the specified concluding hour. + +The default value means any time. +-- + +[%hardbreaks] +*Default:* `+++"00:00,00:00"+++` +*Example:* `+++"01:00,05:59"+++` +{blank} +a¦ String + + +a¦ +*indexer.settings.compaction.min_frag* + +_optional_ +a¦ + +[markdown] +-- +The minimum fragmentation threshold to trigger compaction (percentage). +-- + +[%hardbreaks] +*Default:* `30` +*Minimum:* `5` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.compaction.min_size* + +_optional_ +a¦ + +[markdown] +-- +Compaction minimum file size. +-- + +[%hardbreaks] +*Default:* `524288000` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.compaction.plasma.manual* + +_optional_ +a¦ + +[markdown] +-- +For standard indexes using Plasma, whether compaction should be triggered manually. +-- + +[%hardbreaks] +*Default:* `false` +{blank} +a¦ Boolean + + +a¦ +*indexer.settings.compaction.plasma.optional.decrement* + +_optional_ +a¦ + +[markdown] +-- +For standard indexes using Plasma, the optional decrement. +-- + +[%hardbreaks] +*Default:* `5` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.compaction.plasma.optional.min_frag* + +_optional_ +a¦ + +[markdown] +-- +For standard indexes using Plasma, the minimum fragmentation threshold to trigger compaction (percentage). +-- + +[%hardbreaks] +*Default:* `20` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.compaction.plasma.optional.quota* + +_optional_ +a¦ + +[markdown] +-- +For standard indexes using Plasma, the optional quota. +-- + +[%hardbreaks] +*Default:* `25` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.corrupt_index_num_backups* + +_optional_ +a¦ + +[markdown] +-- +Corrupt index number of backups. +-- + +[%hardbreaks] +*Default:* `1` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.cpuProfDir* + +_optional_ +a¦ + +[markdown] +-- +The name of the directory where local CPU usage profiling information is captured. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*indexer.settings.cpuProfile* + +_optional_ +a¦ + +[markdown] +-- +Whether the Index Service should capture local CPU usage profiling information. +-- + +[%hardbreaks] +*Default:* `false` +{blank} +a¦ Boolean + + +a¦ +*indexer.settings.defer_build* + +_optional_ +a¦ + +[markdown] +-- +The default setting for the `defer_build` option for index creation. + +* If this setting is true, and you create an index without specifying `defer_build`, the index is not built immediately. +* If this setting false, and you create an index without specifying `defer_build`, the index is built immediately. + +You can override this setting by specifying the `defer_build` option when you create an index. +-- + +[%hardbreaks] +*Default:* `false` +{blank} +a¦ Boolean + + +a¦ +*indexer.settings.eTagPeriod* + +_optional_ +a¦ + +[markdown] +-- +The ETag (entity tag) period. +-- + +[%hardbreaks] +*Default:* `240` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.enable_corrupt_index_backup* + +_optional_ +a¦ + +[markdown] +-- +Whether corrupt index backup is enabled. +-- + +[%hardbreaks] +*Default:* `false` +{blank} +a¦ Boolean + + +a¦ +*indexer.settings.enable_page_bloom_filter* + +_optional_ +a¦ + +[markdown] +-- +Whether Bloom filters are enabled for memory management. + +For details, see [Per Page Bloom Filters](/server/8.0/learn/services-and-indexes/indexes/storage-modes.html#per-page-bloom-filters). +-- + +[%hardbreaks] +*Default:* `true` +{blank} +a¦ Boolean + + +a¦ +*indexer.settings.enable_shard_affinity* + +_optional_ +a¦ + +[markdown] +-- +Selects the index rebalance method. +See [Index Rebalance Methods](/server/8.0/learn/clusters-and-availability/rebalance.html#index-rebalance-methods). + +* If false (the default), Index Service nodes rebuild indexes that are newly assigned to them during a rebalance. + +* If true, Couchbase Server moves a reassigned index's files between Index Service nodes. + +If set to true, when you create an index, you can use the `WITH` clause to specify which node should contain the index. +However, when you alter an index, you cannot use the `WITH` clause to specify which node should contain the index. +-- + +[%hardbreaks] +*Default:* `false` +{blank} +a¦ Boolean + + +a¦ +*indexer.settings.fast_flush_mode* + +_optional_ +a¦ + +[markdown] +-- +Whether fast flush mode is enabled. +-- + +[%hardbreaks] +*Default:* `true` +{blank} +a¦ Boolean + + +a¦ +*indexer.settings.gc_percent* + +_optional_ +a¦ + +[markdown] +-- +Garbage collection percentage. +-- + +[%hardbreaks] +*Default:* `100` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.inmemory_snapshot.fdb.interval* + +_optional_ +a¦ + +[markdown] +-- +For standard indexes using ForestDB, the in-memory snapshotting interval (ms). +This determines the earliest possibility of a scan seeing a given KV mutation. +-- + +[%hardbreaks] +*Default:* `200` +*Minimum:* `1` (exclusive) +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.inmemory_snapshot.interval* + +_optional_ +a¦ + +[markdown] +-- +The in-memory snapshotting interval (ms). +This determines the earliest possibility of a scan seeing a given KV mutation. +-- + +[%hardbreaks] +*Default:* `200` +*Minimum:* `1` (exclusive) +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.inmemory_snapshot.moi.interval* + +_optional_ +a¦ + +[markdown] +-- +For memory-optimized indexes, the in-memory snapshotting interval (ms). +This determines the earliest possibility of a scan seeing a given KV mutation. +-- + +[%hardbreaks] +*Default:* `10` +*Minimum:* `1` (exclusive) +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.largeSnapshotThreshold* + +_optional_ +a¦ + +[markdown] +-- +The large snapshot threshold. +-- + +[%hardbreaks] +*Default:* `200` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.log_level* + +_optional_ +a¦ + +[markdown] +-- +Indexer logging level. +-- + +[%hardbreaks] +*Values:* `"silent"`, `"fatal"`, `"error"`, `"warn"`, `"info"`, `"verbose"`, `"timing"`, `"debug"`, `"trace"` +*Default:* `+++"info"+++` +{blank} +a¦ String + + +a¦ +*indexer.settings.maxNumPartitions* + +_optional_ +a¦ + +[markdown] +-- +Maximum number of partitions. +-- + +[%hardbreaks] +*Default:* `64` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.maxVbQueueLength* + +_optional_ +a¦ + +[markdown] +-- +Maximum vBucket queue length. +-- + +[%hardbreaks] +*Default:* `0` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.max_array_seckey_size* + +_optional_ +a¦ + +[markdown] +-- +If `indexer.settings.allow_large_keys` is false, this setting specifies the maximum size for array index keys. + +In Couchbase Server 6.5 and later, the Index Service does not need to restart when you update this setting. +-- + +[%hardbreaks] +*Default:* `10240` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.max_cpu_percent* + +_optional_ +a¦ + +[markdown] +-- +The CPU capacity that the Index Service should use (percentage). +If set to `0`, the indexer will use all CPUs. +-- + +[%hardbreaks] +*Default:* `0` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.max_seckey_size* + +_optional_ +a¦ + +[markdown] +-- +If `indexer.settings.allow_large_keys` is false, this setting specifies the maximum size for index keys. + +In Couchbase Server 6.5 and later, the Index Service does not need to restart when you update this setting. +-- + +[%hardbreaks] +*Default:* `4608` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.max_writer_lock_prob* + +_optional_ +a¦ + +[markdown] +-- +Maximum writer lock prob. +-- + +[%hardbreaks] +*Default:* `20` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.memProfDir* + +_optional_ +a¦ + +[markdown] +-- +The name of the directory where local memory usage profiling information is captured. +-- + +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*indexer.settings.memProfile* + +_optional_ +a¦ + +[markdown] +-- +Whether the Index Service should capture local memory usage profiling information. +-- + +[%hardbreaks] +*Default:* `false` +{blank} +a¦ Boolean + + +a¦ +*indexer.settings.memory_quota* + +_optional_ +a¦ + +[markdown] +-- +How much RAM is allocated to the Index Service for the current node. +-- + +[%hardbreaks] +*Default:* `536870912` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.minVbQueueLength* + +_optional_ +a¦ + +[markdown] +-- +Minimum vBucket queue length. +-- + +[%hardbreaks] +*Default:* `30` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.moi.debug* + +_optional_ +a¦ + +[markdown] +-- +Debug memory-optimized index storage. +-- + +[%hardbreaks] +*Default:* `false` +{blank} +a¦ Boolean + + +a¦ +*indexer.settings.moi.persistence_threads* + +_optional_ +a¦ + +[markdown] +-- +For memory-optimized index storage, the number of persistence threads. +-- + +[%hardbreaks] +*Default:* `4` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.moi.recovery.max_rollbacks* + +_optional_ +a¦ + +[markdown] +-- +For memory-optimized index storage, the maximum number of committed rollback points. +-- + +[%hardbreaks] +*Default:* `2` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.moi.recovery_threads* + +_optional_ +a¦ + +[markdown] +-- +For memory-optimized index storage, the number of recovery threads. +-- + +[%hardbreaks] +*Default:* `8` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.num_replica* + +_optional_ +a¦ + +[markdown] +-- +The default number of index replicas to be created by the Index Service whenever `CREATE INDEX` is invoked. +-- + +[%hardbreaks] +*Default:* `0` +*Example:* `2` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.percentage_memory_quota* + +_optional_ +a¦ + +[markdown] +-- +Percentage memory quota. +-- + +[%hardbreaks] +*Default:* `0` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.persisted_snapshot.fdb.interval* + +_optional_ +a¦ + +[markdown] +-- +For standard indexes using ForestDB, the persisted snapshotting interval (ms). +This must be a multiple of the in-memory snapshot interval. +-- + +[%hardbreaks] +*Default:* `5000` +*Minimum:* `100` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.persisted_snapshot.interval* + +_optional_ +a¦ + +[markdown] +-- +The persisted snapshotting interval (ms). +This must be a multiple of the in-memory snapshot interval. +-- + +[%hardbreaks] +*Default:* `5000` +*Minimum:* `100` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.persisted_snapshot.moi.interval* + +_optional_ +a¦ + +[markdown] +-- +For memory-optimized indexes, the persisted snapshotting interval (ms). +This must be a multiple of the in-memory snapshot interval. +-- + +[%hardbreaks] +*Default:* `600000` +*Minimum:* `100` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.persisted_snapshot_init_build.fdb.interval* + +_optional_ +a¦ + +[markdown] +-- +For standard indexes using ForestDB, the persisted snapshotting interval for the initial build (ms). +-- + +[%hardbreaks] +*Default:* `5000` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.persisted_snapshot_init_build.interval* + +_optional_ +a¦ + +[markdown] +-- +The persisted snapshotting interval for the initial build (ms). +-- + +[%hardbreaks] +*Default:* `5000` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.persisted_snapshot_init_build.moi.interval* + +_optional_ +a¦ + +[markdown] +-- +For memory-optimized indexes, the persisted snapshotting interval for the initial build (ms). +-- + +[%hardbreaks] +*Default:* `600000` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.plasma.recovery.max_rollbacks* + +_optional_ +a¦ + +[markdown] +-- +For standard indexes using Plasma, the maximum number of committed rollback points. +-- + +[%hardbreaks] +*Default:* `2` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.rebalance.blob_storage_bucket* + +_optional_ +a¦ + +[markdown] +-- +Rebalance blob storage bucket. +-- + +[%hardbreaks] +*Default:* `+++""+++` +{blank} +a¦ String + + +a¦ +*indexer.settings.rebalance.blob_storage_prefix* + +_optional_ +a¦ + +[markdown] +-- +Rebalance blob storage prefix. +-- + +[%hardbreaks] +*Default:* `+++""+++` +{blank} +a¦ String + + +a¦ +*indexer.settings.rebalance.blob_storage_region* + +_optional_ +a¦ + +[markdown] +-- +Rebalance blob storage region. +-- + +[%hardbreaks] +*Default:* `+++""+++` +{blank} +a¦ String + + +a¦ +*indexer.settings.rebalance.blob_storage_scheme* + +_optional_ +a¦ + +[markdown] +-- +Rebalance blob storage scheme. +-- + +[%hardbreaks] +*Default:* `+++""+++` +{blank} +a¦ String + + +a¦ +*indexer.settings.rebalance.redistribute_indexes* + +_optional_ +a¦ + +[markdown] +-- +Whether to redistribute indexes on rebalance. + +* When true, Couchbase Server redistributes indexes when rebalance occurs, in order to optimize performance. + +* When false (the default), such redistribution does not occur. + +For details, see [Rebalance](/server/8.0/learn/clusters-and-availability/rebalance.html#rebalancing-the-index-service). +-- + +[%hardbreaks] +*Default:* `false` +{blank} +a¦ Boolean + + +a¦ +*indexer.settings.recovery.max_rollbacks* + +_optional_ +a¦ + +[markdown] +-- +The maximum number of committed rollback points. +-- + +[%hardbreaks] +*Default:* `2` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.scan_getseqnos_retries* + +_optional_ +a¦ + +[markdown] +-- +Scan get sequence numbers retries. +-- + +[%hardbreaks] +*Default:* `30` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.scan_timeout* + +_optional_ +a¦ + +[markdown] +-- +The default timeout for the indexer, in milliseconds. +This is distinct from the Query Service timeout. +The Index Service has its own timeout because index scans consume resources such as memory and CPU while holding snapshots and performing range scan. + +An index scan may time out if the Index Service timeout is lower than the Query Service timeout. +-- + +[%hardbreaks] +*Default:* `120000` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.send_buffer_size* + +_optional_ +a¦ + +[markdown] +-- +Send buffer size. +-- + +[%hardbreaks] +*Default:* `1024` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.serverless.indexLimit* + +_optional_ +a¦ + +[markdown] +-- +Serverless index limit. +-- + +[%hardbreaks] +*Default:* `201` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.sliceBufSize* + +_optional_ +a¦ + +[markdown] +-- +Slice buffer size. +-- + +[%hardbreaks] +*Default:* `1600` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.smallSnapshotThreshold* + +_optional_ +a¦ + +[markdown] +-- +Small snapshot threshold. +-- + +[%hardbreaks] +*Default:* `30` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.snapshotListeners* + +_optional_ +a¦ + +[markdown] +-- +Snapshot listeners. +-- + +[%hardbreaks] +*Default:* `4` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.snapshotRequestWorkers* + +_optional_ +a¦ + +[markdown] +-- +Snapshot request workers. +-- + +[%hardbreaks] +*Default:* `4` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.statsLogDumpInterval* + +_optional_ +a¦ + +[markdown] +-- +Statistics log dump interval. +-- + +[%hardbreaks] +*Default:* `60` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.storage_mode* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-SettingsStorageMode, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:SettingsStorageMode[] + + +a¦ +*indexer.settings.storage_mode.disable_upgrade* + +_optional_ +a¦ + +[markdown] +-- +Whether upgrade of the index storage mode is disabled. +-- + +[%hardbreaks] +*Default:* `false` +{blank} +a¦ Boolean + + +a¦ +*indexer.settings.thresholds.mem_high* + +_optional_ +a¦ + +[markdown] +-- +High memory threshold. +-- + +[%hardbreaks] +*Default:* `70` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.thresholds.mem_low* + +_optional_ +a¦ + +[markdown] +-- +Low memory threshold. +-- + +[%hardbreaks] +*Default:* `50` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.thresholds.units_high* + +_optional_ +a¦ + +[markdown] +-- +High units threshold. +-- + +[%hardbreaks] +*Default:* `60` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.thresholds.units_low* + +_optional_ +a¦ + +[markdown] +-- +Low units threshold. +-- + +[%hardbreaks] +*Default:* `40` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.units_quota* + +_optional_ +a¦ + +[markdown] +-- +Units quota. +-- + +[%hardbreaks] +*Default:* `10000` +{blank} +a¦ Integer (int32) + + +a¦ +*indexer.settings.wal_size* + +_optional_ +a¦ + +[markdown] +-- +Write-ahead log size. +-- + +[%hardbreaks] +*Default:* `4096` +{blank} +a¦ Integer (int32) + + +a¦ +*projector.settings.log_level* + +_optional_ +a¦ + +[markdown] +-- +Projector logging level. +-- + +[%hardbreaks] +*Default:* `+++"info"+++` +{blank} +a¦ String + + +a¦ +*queryport.client.settings.backfillLimit* + +_optional_ +a¦ + +[markdown] +-- +The maximum size of the backfill file (MB). + +* A value of `0` disables backfill. +* A value of `-1` means the size is unlimited. + +The maximum size is limited only by the available disk space. +-- + +[%hardbreaks] +*Default:* `5120` +{blank} +a¦ Integer (int32) + + +a¦ +*queryport.client.settings.closeActiveConnections* + +_optional_ +a¦ + +[markdown] +-- +Whether to close active connections. +-- + +[%hardbreaks] +*Default:* `true` +{blank} +a¦ Boolean + + +a¦ +*queryport.client.settings.minPoolSizeWM* + +_optional_ +a¦ + +[markdown] +-- +Minimum pool size. +-- + +[%hardbreaks] +*Default:* `1000` +{blank} +a¦ Integer (int32) + + +a¦ +*queryport.client.settings.poolOverflow* + +_optional_ +a¦ + +[markdown] +-- +Maximum number of connections in a pool. +-- + +[%hardbreaks] +*Default:* `30` +{blank} +a¦ Integer (int32) + + +a¦ +*queryport.client.settings.poolSize* + +_optional_ +a¦ + +[markdown] +-- +Number of simultaneous active connections in a pool. +-- + +[%hardbreaks] +*Default:* `5000` +{blank} +a¦ Integer (int32) + + +a¦ +*queryport.client.settings.relConnBatchSize* + +_optional_ +a¦ + +[markdown] +-- +Connection batch size. +-- + +[%hardbreaks] +*Default:* `100` +{blank} +a¦ Integer (int32) + + +|=== + +//end::Settings[] + + + + +// markup not found, no include::{specDir}definitions/Settings/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/Settings/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/SettingsStorageMode/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#SettingsStorageMode] += Storage Mode + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/SettingsStorageMode/definition-begin.adoc[opts=optional] + + +.icon:bars[fw] Composite Schema +{blank} + +//tag::SettingsStorageMode[] + +ifdef::model-descriptions[] +//tag::desc-SettingsStorageMode[] +The storage mode to be used for the Index Service on this node. +//end::desc-SettingsStorageMode[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ One{nbsp}of{nbsp}... ¦ ¦ Schema + +a¦ +a¦ [.edition]##{enterprise}## + +[markdown] +-- +include::index.adoc[tag=desc-SettingsStorageModeEE, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ +include::index.adoc[tag=type-SettingsStorageModeEE, opts=optional] + +a¦ _or_ +a¦ [.edition]##{community}## + +[markdown] +-- +include::index.adoc[tag=desc-SettingsStorageModeCE, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ +include::index.adoc[tag=type-SettingsStorageModeCE, opts=optional] + +|=== + +//end::SettingsStorageMode[] + + +// markup not found, no include::{specDir}definitions/SettingsStorageMode/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/SettingsStorageMode/definition-after.adoc[opts=optional] + + +ifdef::enum-definitions[] +[#SettingsStorageModeCE] += Community Edition + +.icon:menu[fw] Enumeration +{blank} + +//tag::desc-SettingsStorageModeCE[] +If you are using Community Edition, the default (and only) value is `forestdb`. +//end::desc-SettingsStorageModeCE[] + +.Schema +//tag::type-SettingsStorageModeCE[] +String + + +//end::type-SettingsStorageModeCE[] +endif::enum-definitions[] +ifdef::enum-definitions[] +[#SettingsStorageModeEE] += Enterprise Edition + +.icon:menu[fw] Enumeration +{blank} + +//tag::desc-SettingsStorageModeEE[] +If you are using Enterprise Edition, the possible values are: + +* `plasma` (the default) — + Sets the index storage mode to use the Plasma storage engine, which can utilize both memory and persistent storage for index maintenance and index scans. + +* `memory_optimized` — + Sets the index storage mode to use memory optimized global secondary indexes, which can perform index maintenance and index scan faster at in-memory speeds. + +This setting can only be changed while there are no index nodes in the cluster. +To change from standard GSI to memory optimized GSI or vice versa, you need to remove all the Index Service nodes in the cluster. +//end::desc-SettingsStorageModeEE[] + +.Schema +//tag::type-SettingsStorageModeEE[] +String + + +//end::type-SettingsStorageModeEE[] +endif::enum-definitions[] + + +// 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/Default/security-scheme-before.adoc[opts=optional] + + +[[security-default]] += Default + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Default/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +Users must have the Full Admin or Cluster Admin role, with Cluster Read and Bucket INDEX List privileges. +-- + +[%hardbreaks] +__Type__ : http + + +// markup not found, no include::{specDir}security/Default/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/Default/security-scheme-after.adoc[opts=optional] + + + + +include::{specDir}security/document-end.adoc[opts=optional] + +:leveloffset: -1 + + + +// markup not found, no include::{specDir}security/document-after.adoc[opts=optional] + + diff --git a/docs/modules/index-rest-settings/partials/header-attributes.adoc b/docs/modules/index-rest-settings/partials/header-attributes.adoc new file mode 100644 index 00000000..3df57645 --- /dev/null +++ b/docs/modules/index-rest-settings/partials/header-attributes.adoc @@ -0,0 +1,6 @@ +:page-meta-robots: noindex +:page-embargo: EMBARGOED +:page-partial: +:!example-caption: +:description: The Index Settings REST API is provided by the Index Service. \ +This API enables you to retrieve or set Index Service settings. \ No newline at end of file diff --git a/docs/modules/index-rest-settings/partials/overview/document-before.adoc b/docs/modules/index-rest-settings/partials/overview/document-before.adoc new file mode 100644 index 00000000..1fb78375 --- /dev/null +++ b/docs/modules/index-rest-settings/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/index-rest-settings/partials/overview/document-end.adoc b/docs/modules/index-rest-settings/partials/overview/document-end.adoc new file mode 100644 index 00000000..4bbd311a --- /dev/null +++ b/docs/modules/index-rest-settings/partials/overview/document-end.adoc @@ -0,0 +1,8 @@ +[discrete] += Examples on this page + +In the HTTP request examples: + +* `$HOST` is the host name or IP address of a node running the Index Service. +* `$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/index-rest-settings/partials/paths/get_settings/http-request.adoc b/docs/modules/index-rest-settings/partials/paths/get_settings/http-request.adoc new file mode 100644 index 00000000..0694d7f3 --- /dev/null +++ b/docs/modules/index-rest-settings/partials/paths/get_settings/http-request.adoc @@ -0,0 +1,12 @@ += Example HTTP Request + +==== +The example below retrieves the current index settings. + +.Curl request +[source,sh] +---- +curl -X GET http://$HOST:9102/settings \ + -u $USER:$PASSWORD +---- +==== \ No newline at end of file diff --git a/docs/modules/index-rest-settings/partials/paths/get_settings/http-response.adoc b/docs/modules/index-rest-settings/partials/paths/get_settings/http-response.adoc new file mode 100644 index 00000000..3c9a69fa --- /dev/null +++ b/docs/modules/index-rest-settings/partials/paths/get_settings/http-response.adoc @@ -0,0 +1,9 @@ += Example HTTP Response + +==== +.Response 200 +[source,json] +---- +include::example$get_settings.json[] +---- +==== \ No newline at end of file diff --git a/docs/modules/index-rest-settings/partials/paths/post_settings/http-request.adoc b/docs/modules/index-rest-settings/partials/paths/post_settings/http-request.adoc new file mode 100644 index 00000000..7a5fc4ea --- /dev/null +++ b/docs/modules/index-rest-settings/partials/paths/post_settings/http-request.adoc @@ -0,0 +1,46 @@ += Example HTTP Requests + +[#ex-defer-build] +.Defer Index Builds by Default +==== +This example specifies the default setting for deferred builds. + +.Curl request +[source,sh] +---- +curl -X POST http://$HOST:9102/settings \ + -u $USER:$PASSWORD \ + -H 'content-type: application/json' \ + -d '{"indexer.settings.defer_build": true}' +---- +==== + +[#ex-scan-timeout] +.Set the Indexer Scan Timeout +==== +This example sets the indexer scan timeout. + +.Curl request +[source,sh] +---- +curl -X POST http://$HOST:9102/settings \ + -u $USER:$PASSWORD \ + -H 'content-type: application/json' \ + -d '{"indexer.settings.scan_timeout": 15000}' +---- +==== + +[#ex-modify-index-batch-size] +.Modify Index Batch Size +==== +This example modifies the index batch size for rebalance. + +.Curl request +[source,sh] +---- +curl -X POST http://$HOST:9102/settings \ + -u $USER:$PASSWORD \ + -H 'content-type: application/json' \ + -d '{ "indexer.rebalance.transferBatchSize": 7 }' +---- +==== \ No newline at end of file diff --git a/docs/modules/index-rest-settings/partials/security/document-begin.adoc b/docs/modules/index-rest-settings/partials/security/document-begin.adoc new file mode 100644 index 00000000..cbf1b644 --- /dev/null +++ b/docs/modules/index-rest-settings/partials/security/document-begin.adoc @@ -0,0 +1,2 @@ +The Index Settings API supports admin credentials. +Pass your credentials through HTTP headers (HTTP basic authentication). \ No newline at end of file diff --git a/docs/modules/index-rest-settings/partials/security/document-end.adoc b/docs/modules/index-rest-settings/partials/security/document-end.adoc new file mode 100644 index 00000000..36d8ba1d --- /dev/null +++ b/docs/modules/index-rest-settings/partials/security/document-end.adoc @@ -0,0 +1 @@ +Refer to xref:learn:security/roles.adoc[Roles] for more details. \ No newline at end of file diff --git a/src/indexes/swagger/indexes.yaml b/docs/modules/index-rest-stats/attachments/_indexes.yaml similarity index 98% rename from src/indexes/swagger/indexes.yaml rename to docs/modules/index-rest-stats/attachments/_indexes.yaml index 679d860f..a4c2bce4 100644 --- a/src/indexes/swagger/indexes.yaml +++ b/docs/modules/index-rest-stats/attachments/_indexes.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Index Statistics REST API - version: capella + version: "8.0" description: |- The Index Statistics REST API is provided by the Index service. This API enables you to get Index service statistics. @@ -20,11 +20,11 @@ servers: - https host: default: localhost - description: The host name or IP address of a node running the Index service. + description: The host name or IP address of a node running the Index Service. port: default: "9102" description: |- - The Index service REST port. + The Index Service REST port. Use `19102` for secure access. enum: - "9102" @@ -163,6 +163,7 @@ components: NodeIdxNode: type: object title: Nodes + description: Node statistics. required: - indexer properties: @@ -217,12 +218,14 @@ components: PartIdxIndexes: type: object title: Indexes + description: Index statistics. additionalProperties: $ref: "#/components/schemas/PartIdxPartitionsIndex" PartIdxPartitions: type: object title: Partitions + description: Index partition statistics. additionalProperties: $ref: "#/components/schemas/PartIdxPartitionsIndex" diff --git a/src/indexes/indexes.gradle b/docs/modules/index-rest-stats/indexes.gradle similarity index 86% rename from src/indexes/indexes.gradle rename to docs/modules/index-rest-stats/indexes.gradle index 308f2481..1568e09a 100644 --- a/src/indexes/indexes.gradle +++ b/docs/modules/index-rest-stats/indexes.gradle @@ -2,11 +2,11 @@ apply plugin: 'org.openapi.generator' openApiGenerate { generatorName = "asciidoc" - inputSpec = file("swagger/indexes.yaml").getAbsolutePath().toString() + inputSpec = file("attachments/_indexes.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/index-rest-stats/pages" templateDir = "${rootDir}/templates" gitRepoId = "cb-swagger" - gitUserId = "couchbase" + gitUserId = "couchbaselabs" additionalProperties = [ specDir: "${rootDir}/docs/modules/index-rest-stats/partials/", snippetDir: "${rootDir}/docs/modules/index-rest-stats/partials/paths/", diff --git a/docs/modules/index-rest-stats/pages/index.adoc b/docs/modules/index-rest-stats/pages/index.adoc index 44b88d0c..90d883fd 100644 --- a/docs/modules/index-rest-stats/pages/index.adoc +++ b/docs/modules/index-rest-stats/pages/index.adoc @@ -8,7 +8,7 @@ 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 +DO NOT EDIT! See https://github.com/couchbaselabs/cb-swagger :leveloffset: 1 @@ -32,7 +32,7 @@ This API enables you to get Index service statistics. [discrete#version] = Version information [%hardbreaks] -__Version__ : capella +__Version__ : 8.0 [discrete#host] = Host information @@ -58,29 +58,29 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* a| [markdown] -- -The host name or IP address of a node running the Index service. +The host name or IP address of a node running the Index Service. -- [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* a| [markdown] -- -The Index service REST port. Use `19102` for secure access. +The Index Service REST port. Use `19102` for secure access. -- [%hardbreaks] *Values:* `9102`, `19102` -*Example:* `pass:c[9102]` +*Example:* `+++9102+++` // end |=== @@ -113,7 +113,7 @@ ifeval::[{count-apis} > 1] The operations are grouped in the following categories. [%hardbreaks] -<> +xref:tag-Default[] endif::[] @@ -131,11 +131,13 @@ endif::[] endif::[] [%hardbreaks] -<> -<> -<> +xref:get_index_stats[] +xref:get_keyspace_stats[] +xref:get_node_stats[] +//tag::get_index_stats[] + // markup not found, no include::{specDir}paths/get_index_stats/operation-before.adoc[opts=optional] @@ -173,6 +175,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 +203,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 +227,13 @@ For example, `` `bucket.1`.scope.collection ``. [%hardbreaks] {blank} -a| String +a¦ String -a| *index* + +a¦ *index* + _required_ -a| +a¦ [markdown] @@ -236,7 +244,7 @@ The name of an index. [%hardbreaks] {blank} -a| String +a¦ String @@ -246,13 +254,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 +272,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 +290,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 +309,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 +327,7 @@ Whether empty, null, or zero statistics should be omitted from the output. *Default:* `false` {blank} -a| Boolean +a¦ Boolean @@ -339,12 +347,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] @@ -366,7 +368,7 @@ a| [markdown] -- Success. Returns an object containing one nested `:` object. If the [partition](#get_index_stats-parameters) query parameter was set to `true`, the returned object also contains one or more `Partition-` objects — one for each index partition found on the specified node. -- -a| <> +a| xref:PartIdx[] | 404 @@ -405,7 +407,7 @@ a| | Type | Name | http (basic) -| <> +| xref:security-indexStatistics[] |=== @@ -434,6 +436,10 @@ include::{snippetDir}get_index_stats/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_index_stats/operation-after.adoc[opts=optional] +//end::get_index_stats[] + + +//tag::get_keyspace_stats[] // markup not found, no include::{specDir}paths/get_keyspace_stats/operation-before.adoc[opts=optional] @@ -472,6 +478,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 +506,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 +530,7 @@ For example, `` `bucket.1`.scope.collection ``. [%hardbreaks] {blank} -a| String +a¦ String @@ -528,13 +540,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 +558,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 +577,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 +595,7 @@ Whether empty, null, or zero statistics should be omitted from the output. *Default:* `false` {blank} -a| Boolean +a¦ Boolean @@ -603,12 +615,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] @@ -630,7 +636,7 @@ a| [markdown] -- Success. Returns an object containing one or more nested `:` objects — one for each index found within the specified bucket, scope, or collection. -- -a| <> +a| xref:PartIdxIndexes[] | 404 @@ -669,7 +675,7 @@ a| | Type | Name | http (basic) -| <> +| xref:security-indexStatistics[] |=== @@ -698,6 +704,10 @@ include::{snippetDir}get_keyspace_stats/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_keyspace_stats/operation-after.adoc[opts=optional] +//end::get_keyspace_stats[] + + +//tag::get_node_stats[] // markup not found, no include::{specDir}paths/get_node_stats/operation-before.adoc[opts=optional] @@ -736,6 +746,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 +775,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 +793,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 +812,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 +830,7 @@ Whether empty, null, or zero statistics should be omitted from the output. *Default:* `false` {blank} -a| Boolean +a¦ Boolean @@ -834,12 +850,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] @@ -861,7 +871,7 @@ a| [markdown] -- Success. Returns an object containing a nested `indexer` object, and usually one or more nested `:` objects — one for each index found on the specified node. -- -a| <> +a| xref:NodeIdx[] @@ -894,9 +904,9 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-indexStatistics[] | http (basic) -| <> +| xref:security-nodeStatistics[] |=== @@ -925,6 +935,8 @@ include::{snippetDir}get_node_stats/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_node_stats/operation-after.adoc[opts=optional] +//end::get_node_stats[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -961,13 +973,13 @@ ifdef::collapse-models[] [.two-columns] endif::collapse-models[] [%hardbreaks] -<> -<> -<> -<> -<> -<> -<> +xref:NodeIdx[] +xref:NodeIdxNode[] +xref:NodeIdxNodeIndexer[] +xref:PartIdx[] +xref:PartIdxIndexes[] +xref:PartIdxPartitions[] +xref:PartIdxPartitionsIndex[] endif::[] @@ -989,15 +1001,43 @@ endif::collapse-models[] .icon:bars[fw] Composite Schema {blank} -All of the following: +//tag::NodeIdx[] + -* <> +[cols="25,55,20",separator=¦] +|=== +¦ All{nbsp}of{nbsp}... ¦ ¦ Schema +a¦ +a¦ -* <> +[markdown] +-- +include::index.adoc[tag=desc-NodeIdxNode, opts=optional] +-- +[%hardbreaks] +{blank} +a¦ xref:NodeIdxNode[] +a¦ _and_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-PartIdxIndexes, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:PartIdxIndexes[] + + +|=== + +//end::NodeIdx[] + // markup not found, no include::{specDir}definitions/NodeIdx/definition-end.adoc[opts=optional] @@ -1028,15 +1068,20 @@ endif::collapse-models[] //tag::NodeIdxNode[] +ifdef::model-descriptions[] +//tag::desc-NodeIdxNode[] +Node statistics. +//end::desc-NodeIdxNode[] +endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *indexer* + _required_ -a| +a¦ [markdown] -- @@ -1045,7 +1090,7 @@ include::index.adoc[tag=desc-NodeIdxNodeIndexer, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ xref:NodeIdxNodeIndexer[] |=== @@ -1090,14 +1135,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 +1151,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 +1171,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| +a¦ [markdown] -- @@ -1144,13 +1189,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 +1205,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 +1221,7 @@ The total time the indexer has spent in GC pause since last startup (ns). [%hardbreaks] *Example:* `309778455` {blank} -a| Integer +a¦ Integer |=== @@ -1213,15 +1258,43 @@ endif::collapse-models[] .icon:bars[fw] Composite Schema {blank} -All of the following: +//tag::PartIdx[] -* <> +[cols="25,55,20",separator=¦] +|=== +¦ All{nbsp}of{nbsp}... ¦ ¦ Schema + +a¦ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-PartIdxIndexes, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:PartIdxIndexes[] + + +a¦ _and_ +a¦ -* <> +[markdown] +-- +include::index.adoc[tag=desc-PartIdxPartitions, opts=optional] +-- +[%hardbreaks] +{blank} +a¦ xref:PartIdxPartitions[] +|=== + +//end::PartIdx[] + // markup not found, no include::{specDir}definitions/PartIdx/definition-end.adoc[opts=optional] @@ -1252,15 +1325,21 @@ endif::collapse-models[] //tag::PartIdxIndexes[] +ifdef::model-descriptions[] +//tag::desc-PartIdxIndexes[] +Index statistics. +//end::desc-PartIdxIndexes[] +endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema + +a¦ -a| _additional + property_ -a| +a¦ [markdown] -- @@ -1269,7 +1348,7 @@ include::index.adoc[tag=desc-PartIdxPartitionsIndex, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ xref:PartIdxPartitionsIndex[] |=== @@ -1308,15 +1387,21 @@ endif::collapse-models[] //tag::PartIdxPartitions[] +ifdef::model-descriptions[] +//tag::desc-PartIdxPartitions[] +Index partition statistics. +//end::desc-PartIdxPartitions[] +endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema + +a¦ -a| _additional + property_ -a| +a¦ [markdown] -- @@ -1325,7 +1410,7 @@ include::index.adoc[tag=desc-PartIdxPartitionsIndex, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ xref:PartIdxPartitionsIndex[] |=== @@ -1370,14 +1455,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 +1473,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 +1488,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 +1503,13 @@ Average size of the keys. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *avg_scan_latency* + _optional_ -a| +a¦ [markdown] -- @@ -1433,13 +1518,13 @@ Average time to serve a scan request (nanoseconds). [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *cache_hit_percent* + _optional_ -a| +a¦ [markdown] -- @@ -1448,13 +1533,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 +1548,13 @@ Accesses to this index data from RAM. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *cache_misses* + _optional_ -a| +a¦ [markdown] -- @@ -1478,13 +1563,13 @@ Accesses to this index data from disk. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *data_size* + _optional_ -a| +a¦ [markdown] -- @@ -1494,13 +1579,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 +1595,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 +1612,13 @@ The number of documents currently indexed. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *frag_percent* + _optional_ -a| +a¦ [markdown] -- @@ -1545,13 +1630,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 +1650,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 +1666,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 +1685,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 +1700,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 +1715,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 +1730,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 +1745,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 +1760,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 +1775,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 +1790,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 +1805,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 +1820,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| +a¦ [markdown] -- @@ -1754,13 +1839,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| +a¦ [markdown] -- @@ -1770,13 +1855,13 @@ For memory-optimized index storage, this is `0`. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *resident_percent* + _optional_ -a| +a¦ [markdown] -- @@ -1786,13 +1871,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 +1886,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 +1901,7 @@ Total time spent by the indexer in scanning rows since last startup (nanoseconds [%hardbreaks] {blank} -a| Integer +a¦ Integer |=== @@ -1930,3 +2015,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/index-rest-stats/partials/security/document-begin.adoc b/docs/modules/index-rest-stats/partials/security/document-begin.adoc index 4a4c488e..1efdc4ec 100644 --- a/docs/modules/index-rest-stats/partials/security/document-begin.adoc +++ b/docs/modules/index-rest-stats/partials/security/document-begin.adoc @@ -1,2 +1,2 @@ The Index Statistics API supports admin credentials. -Credentials can be passed via HTTP headers (HTTP basic authentication). \ No newline at end of file +Pass your credentials through HTTP headers (HTTP basic authentication). \ No newline at end of file diff --git a/src/admin/admin.gradle b/docs/modules/n1ql-rest-admin/admin.gradle similarity index 83% rename from src/admin/admin.gradle rename to docs/modules/n1ql-rest-admin/admin.gradle index e124e252..4c571e99 100644 --- a/src/admin/admin.gradle +++ b/docs/modules/n1ql-rest-admin/admin.gradle @@ -2,10 +2,10 @@ apply plugin: 'org.openapi.generator' openApiGenerate { generatorName = "asciidoc" - inputSpec = file("swagger/admin.yaml").getAbsolutePath().toString() + remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/morpheus/docs/spec/admin/admin.yaml" outputDir = "${rootDir}/docs/modules/n1ql-rest-admin/pages" templateDir = "${rootDir}/templates" - gitRepoId = "cb-swagger" + gitRepoId = "query" gitUserId = "couchbase" additionalProperties = [ specDir: "${rootDir}/docs/modules/n1ql-rest-admin/partials/", diff --git a/docs/modules/n1ql-rest-admin/pages/index.adoc b/docs/modules/n1ql-rest-admin/pages/index.adoc index 2e2e8b0d..3dd804c9 100644 --- a/docs/modules/n1ql-rest-admin/pages/index.adoc +++ b/docs/modules/n1ql-rest-admin/pages/index.adoc @@ -8,7 +8,7 @@ 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 +DO NOT EDIT! See https://github.com/couchbase/query :leveloffset: 1 @@ -27,13 +27,12 @@ include::{specDir}overview/document-before.adoc[opts=optional] -- The Query Admin REST API is a secondary API provided by the Query service. This API enables you to retrieve statistics about the clusters and nodes running the Query service; view or specify node-level settings; and view or delete requests. - -- [discrete#version] = Version information [%hardbreaks] -__Version__ : capella +__Version__ : 8.0 [discrete#host] = Host information @@ -59,29 +58,29 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* a| [markdown] -- -The host name or IP address of a node running the Query service. +The host name or IP address of a node running the Query Service. -- [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* a| [markdown] -- -The Query service REST port. Use `18093` for secure access. +The Query Service REST port. Use `18093` for secure access. -- [%hardbreaks] *Values:* `8093`, `18093` -*Example:* `pass:c[8093]` +*Example:* `+++8093+++` // end |=== @@ -114,13 +113,13 @@ ifeval::[{count-apis} > 1] The operations are grouped in the following categories. [%hardbreaks] -<> -<> -<> -<> -<> -<> -<> +xref:tag-ActiveRequests[] +xref:tag-CompletedRequests[] +xref:tag-Configuration[] +xref:tag-Default[] +xref:tag-PreparedStatements[] +xref:tag-Settings[] +xref:tag-Statistics[] endif::[] @@ -138,11 +137,13 @@ endif::[] endif::[] [%hardbreaks] -<> -<> -<> -<> +xref:delete_active_request[] +xref:get_active_indexes[] +xref:get_active_request[] +xref:get_active_requests[] + +//tag::delete_active_request[] // markup not found, no include::{specDir}paths/delete_active_request/operation-before.adoc[opts=optional] @@ -176,12 +177,17 @@ DELETE /admin/active_requests/{request} [markdown] -- 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,26 +210,25 @@ 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] -- The name of a request. This is the `requestID` that was assigned automatically when the statement was created. - -- [%hardbreaks] {blank} -a| String +a¦ String @@ -244,12 +249,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] @@ -310,7 +309,7 @@ a| Object | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -339,6 +338,10 @@ include::{snippetDir}delete_active_request/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/delete_active_request/operation-after.adoc[opts=optional] +//end::delete_active_request[] + + +//tag::get_active_indexes[] // markup not found, no include::{specDir}paths/get_active_indexes/operation-before.adoc[opts=optional] @@ -375,12 +378,17 @@ Returns all active index requests. * Use [Retrieve an Active Request](#get_active_request) to get information about an active index request. * Use [Delete an Active Request](#delete_active_request) to terminate an active index request. - -- // markup not found, no include::{specDir}paths/get_active_indexes/operation-description-end.adoc[opts=optional] + + +[#get_active_indexes-produces] +.Produces +* application/json + :leveloffset: -1 @@ -398,12 +406,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] @@ -458,7 +460,7 @@ a| String | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -487,6 +489,10 @@ a| String // markup not found, no include::{specDir}paths/get_active_indexes/operation-after.adoc[opts=optional] +//end::get_active_indexes[] + + +//tag::get_active_request[] // markup not found, no include::{specDir}paths/get_active_request/operation-before.adoc[opts=optional] @@ -520,12 +526,17 @@ GET /admin/active_requests/{request} [markdown] -- 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,26 +559,25 @@ 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] -- The name of a request. This is the `requestID` that was assigned automatically when the statement was created. - -- [%hardbreaks] {blank} -a| String +a¦ String @@ -588,12 +598,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] @@ -615,7 +619,7 @@ a| [markdown] -- An object containing information about the specified active request. -- -a| <> +a| xref:Requests[] @@ -648,7 +652,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -677,6 +681,10 @@ include::{snippetDir}get_active_request/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_active_request/operation-after.adoc[opts=optional] +//end::get_active_request[] + + +//tag::get_active_requests[] // markup not found, no include::{specDir}paths/get_active_requests/operation-before.adoc[opts=optional] @@ -710,12 +718,17 @@ GET /admin/active_requests [markdown] -- 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 +746,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] @@ -760,7 +767,7 @@ a| [markdown] -- An array of objects, each of which contains information about one active request. -- -a| <> +a| xref:Requests[] array @@ -793,7 +800,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -822,6 +829,8 @@ include::{snippetDir}get_active_requests/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_active_requests/operation-after.adoc[opts=optional] +//end::get_active_requests[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -842,11 +851,13 @@ endif::[] endif::[] [%hardbreaks] -<> -<> -<> -<> +xref:delete_completed_request[] +xref:get_completed_indexes[] +xref:get_completed_request[] +xref:get_completed_requests[] + +//tag::delete_completed_request[] // markup not found, no include::{specDir}paths/delete_completed_request/operation-before.adoc[opts=optional] @@ -880,12 +891,17 @@ DELETE /admin/completed_requests/{request} [markdown] -- 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,26 +924,25 @@ 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] -- The name of a request. This is the `requestID` that was assigned automatically when the statement was created. - -- [%hardbreaks] {blank} -a| String +a¦ String @@ -948,12 +963,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] @@ -1014,7 +1023,7 @@ a| Object | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -1043,6 +1052,10 @@ include::{snippetDir}delete_completed_request/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/delete_completed_request/operation-after.adoc[opts=optional] +//end::delete_completed_request[] + + +//tag::get_completed_indexes[] // markup not found, no include::{specDir}paths/get_completed_indexes/operation-before.adoc[opts=optional] @@ -1079,12 +1092,17 @@ Returns all completed index requests. * Use [Retrieve a Completed Request](#get_completed_request) to get information about a completed index request. * Use [Delete a Completed Request](#delete_completed_request) to purge a completed index request. - -- // markup not found, no include::{specDir}paths/get_completed_indexes/operation-description-end.adoc[opts=optional] + + +[#get_completed_indexes-produces] +.Produces +* application/json + :leveloffset: -1 @@ -1102,12 +1120,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] @@ -1162,7 +1174,7 @@ a| String | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -1191,6 +1203,10 @@ a| String // markup not found, no include::{specDir}paths/get_completed_indexes/operation-after.adoc[opts=optional] +//end::get_completed_indexes[] + + +//tag::get_completed_request[] // markup not found, no include::{specDir}paths/get_completed_request/operation-before.adoc[opts=optional] @@ -1224,12 +1240,17 @@ GET /admin/completed_requests/{request} [markdown] -- 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,26 +1273,25 @@ 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] -- The name of a request. This is the `requestID` that was assigned automatically when the statement was created. - -- [%hardbreaks] {blank} -a| String +a¦ String @@ -1292,12 +1312,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] @@ -1319,7 +1333,7 @@ a| [markdown] -- An object containing information about the specified completed request. -- -a| <> +a| xref:Requests[] @@ -1352,7 +1366,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -1381,6 +1395,10 @@ include::{snippetDir}get_completed_request/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_completed_request/operation-after.adoc[opts=optional] +//end::get_completed_request[] + + +//tag::get_completed_requests[] // markup not found, no include::{specDir}paths/get_completed_requests/operation-before.adoc[opts=optional] @@ -1414,12 +1432,17 @@ GET /admin/completed_requests [markdown] -- 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 +1460,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] @@ -1464,7 +1481,7 @@ a| [markdown] -- An array of objects, each of which contains information about one completed request. -- -a| <> +a| xref:Requests[] array @@ -1497,7 +1514,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -1526,6 +1543,8 @@ include::{snippetDir}get_completed_requests/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_completed_requests/operation-after.adoc[opts=optional] +//end::get_completed_requests[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -1546,12 +1565,14 @@ endif::[] endif::[] [%hardbreaks] -<> -<> -<> -<> -<> +xref:get_cluster[] +xref:get_clusters[] +xref:get_config[] +xref:get_node[] +xref:get_nodes[] + +//tag::get_cluster[] // markup not found, no include::{specDir}paths/get_cluster/operation-before.adoc[opts=optional] @@ -1590,6 +1611,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 +1639,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 +1656,7 @@ The name of a cluster. [%hardbreaks] {blank} -a| String +a¦ String @@ -1650,12 +1677,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] @@ -1677,7 +1698,7 @@ a| [markdown] -- An object giving information about the specified cluster. -- -a| <> +a| xref:Clusters[] @@ -1710,7 +1731,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -1739,6 +1760,10 @@ a| <> // markup not found, no include::{specDir}paths/get_cluster/operation-after.adoc[opts=optional] +//end::get_cluster[] + + +//tag::get_clusters[] // markup not found, no include::{specDir}paths/get_clusters/operation-before.adoc[opts=optional] @@ -1777,6 +1802,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 +1825,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] @@ -1821,7 +1846,7 @@ a| [markdown] -- An array of objects, each of which gives information about one cluster. -- -a| <> +a| xref:Clusters[] array @@ -1854,7 +1879,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -1883,6 +1908,10 @@ a| <> // markup not found, no include::{specDir}paths/get_clusters/operation-after.adoc[opts=optional] +//end::get_clusters[] + + +//tag::get_config[] // markup not found, no include::{specDir}paths/get_config/operation-before.adoc[opts=optional] @@ -1921,6 +1950,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 +1973,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] @@ -1965,7 +1994,7 @@ a| [markdown] -- An object giving information about the specified node. -- -a| <> +a| xref:Nodes[] @@ -1998,7 +2027,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -2027,6 +2056,10 @@ a| <> // markup not found, no include::{specDir}paths/get_config/operation-after.adoc[opts=optional] +//end::get_config[] + + +//tag::get_node[] // markup not found, no include::{specDir}paths/get_node/operation-before.adoc[opts=optional] @@ -2065,6 +2098,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 +2126,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 +2143,13 @@ The name of a cluster. [%hardbreaks] {blank} -a| String +a¦ String -a| *node* + +a¦ *node* + _required_ -a| +a¦ [markdown] @@ -2121,7 +2160,7 @@ The name of a node. [%hardbreaks] {blank} -a| String +a¦ String @@ -2142,12 +2181,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] @@ -2169,7 +2202,7 @@ a| [markdown] -- An object giving information about the specified node. -- -a| <> +a| xref:Nodes[] @@ -2202,7 +2235,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -2231,6 +2264,10 @@ a| <> // markup not found, no include::{specDir}paths/get_node/operation-after.adoc[opts=optional] +//end::get_node[] + + +//tag::get_nodes[] // markup not found, no include::{specDir}paths/get_nodes/operation-before.adoc[opts=optional] @@ -2269,6 +2306,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 +2334,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 +2351,7 @@ The name of a cluster. [%hardbreaks] {blank} -a| String +a¦ String @@ -2329,12 +2372,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] @@ -2356,7 +2393,7 @@ a| [markdown] -- An array of objects, each of which gives information about one node. -- -a| <> +a| xref:Nodes[] array @@ -2389,7 +2426,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -2418,6 +2455,8 @@ a| <> // markup not found, no include::{specDir}paths/get_nodes/operation-after.adoc[opts=optional] +//end::get_nodes[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -2438,11 +2477,13 @@ endif::[] endif::[] [%hardbreaks] -<> -<> -<> +xref:get_gc[] +xref:get_ping[] +xref:post_gc[] +//tag::get_gc[] + // markup not found, no include::{specDir}paths/get_gc/operation-before.adoc[opts=optional] @@ -2474,17 +2515,20 @@ GET /admin/gc [markdown] -- -This endpoint is available in databases running Couchbase Server 7.6.0 and later. - Runs the garbage collector. A message is written to `query.log` whenever the garbage collector endpoint is invoked. - -- // markup not found, no include::{specDir}paths/get_gc/operation-description-end.adoc[opts=optional] + + +[#get_gc-produces] +.Produces +* application/json + :leveloffset: -1 @@ -2502,12 +2546,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] @@ -2529,13 +2567,13 @@ a| [markdown] -- Indicates that the garbage collector was invoked. -- -a| <> +a| xref:Garbage[] | 401 a| [markdown] -- -Error 10000: authentication failure. The invoking user is not a valid full-admin user. +Error 10000: authentication failure. The invoking user is not a valid full-admin user. -- a| Object @@ -2570,7 +2608,7 @@ a| Object | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -2599,6 +2637,10 @@ include::{snippetDir}get_gc/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_gc/operation-after.adoc[opts=optional] +//end::get_gc[] + + +//tag::get_ping[] // markup not found, no include::{specDir}paths/get_ping/operation-before.adoc[opts=optional] @@ -2637,6 +2679,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 @@ -2654,12 +2702,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] @@ -2724,6 +2766,10 @@ include::{snippetDir}get_ping/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_ping/operation-after.adoc[opts=optional] +//end::get_ping[] + + +//tag::post_gc[] // markup not found, no include::{specDir}paths/post_gc/operation-before.adoc[opts=optional] @@ -2756,17 +2802,20 @@ POST /admin/gc [markdown] -- -This endpoint is available in databases running Couchbase Server 7.6.0 and later. - -Runs the garbage collector and attempts to return freed memory to the OS. +Run the garbage collector and attempts to return freed memory to the OS. A message is written to `query.log` whenever the garbage collector endpoint is invoked. - -- // markup not found, no include::{specDir}paths/post_gc/operation-description-end.adoc[opts=optional] + + +[#post_gc-produces] +.Produces +* application/json + :leveloffset: -1 @@ -2784,12 +2833,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] @@ -2811,13 +2854,13 @@ a| [markdown] -- Indicates that the garbage collector was invoked. -- -a| <> +a| xref:Garbage[] | 401 a| [markdown] -- -Error 10000: authentication failure. The invoking user is not a valid full-admin user. +Error 10000: authentication failure. The invoking user is not a valid full-admin user. -- a| Object @@ -2852,7 +2895,7 @@ a| Object | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -2881,6 +2924,8 @@ include::{snippetDir}post_gc/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/post_gc/operation-after.adoc[opts=optional] +//end::post_gc[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -2901,12 +2946,14 @@ endif::[] endif::[] [%hardbreaks] -<> -<> -<> -<> +xref:delete_prepared[] +xref:get_prepared[] +xref:get_prepared_indexes[] +xref:get_prepareds[] +//tag::delete_prepared[] + // markup not found, no include::{specDir}paths/delete_prepared/operation-before.adoc[opts=optional] @@ -2939,12 +2986,17 @@ DELETE /admin/prepareds/{name} [markdown] -- 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 @@ -2967,26 +3019,25 @@ 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] -- The name of a prepared statement. This may be a UUID that was assigned automatically, or a name that was user-specified when the statement was created. - -- [%hardbreaks] {blank} -a| String +a¦ String @@ -3007,12 +3058,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] @@ -3073,7 +3118,7 @@ a| Object | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -3102,6 +3147,10 @@ include::{snippetDir}delete_prepared/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/delete_prepared/operation-after.adoc[opts=optional] +//end::delete_prepared[] + + +//tag::get_prepared[] // markup not found, no include::{specDir}paths/get_prepared/operation-before.adoc[opts=optional] @@ -3135,12 +3184,17 @@ GET /admin/prepareds/{name} [markdown] -- 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 @@ -3163,26 +3217,25 @@ 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] -- The name of a prepared statement. This may be a UUID that was assigned automatically, or a name that was user-specified when the statement was created. - -- [%hardbreaks] {blank} -a| String +a¦ String @@ -3203,12 +3256,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] @@ -3230,7 +3277,7 @@ a| [markdown] -- An object containing information about the specified prepared statement. -- -a| <> +a| xref:Statements[] @@ -3263,7 +3310,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -3292,6 +3339,10 @@ include::{snippetDir}get_prepared/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_prepared/operation-after.adoc[opts=optional] +//end::get_prepared[] + + +//tag::get_prepared_indexes[] // markup not found, no include::{specDir}paths/get_prepared_indexes/operation-before.adoc[opts=optional] @@ -3328,12 +3379,17 @@ Returns all prepared index statements. * Use [Retrieve a Prepared Statement](#get_prepared) to get information about a prepared index statement. * Use [Delete a Prepared Statement](#delete_prepared) to delete a prepared index statement. - -- // markup not found, no include::{specDir}paths/get_prepared_indexes/operation-description-end.adoc[opts=optional] + + +[#get_prepared_indexes-produces] +.Produces +* application/json + :leveloffset: -1 @@ -3351,12 +3407,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] @@ -3411,7 +3461,7 @@ a| String | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -3440,6 +3490,10 @@ a| String // markup not found, no include::{specDir}paths/get_prepared_indexes/operation-after.adoc[opts=optional] +//end::get_prepared_indexes[] + + +//tag::get_prepareds[] // markup not found, no include::{specDir}paths/get_prepareds/operation-before.adoc[opts=optional] @@ -3473,12 +3527,17 @@ GET /admin/prepareds [markdown] -- 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 @@ -3496,12 +3555,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] @@ -3523,7 +3576,7 @@ a| [markdown] -- An array of objects, each of which contains information about one prepared statement. -- -a| <> +a| xref:Statements[] array @@ -3556,7 +3609,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -3585,6 +3638,8 @@ include::{snippetDir}get_prepareds/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_prepareds/operation-after.adoc[opts=optional] +//end::get_prepareds[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -3605,10 +3660,12 @@ endif::[] endif::[] [%hardbreaks] -<> -<> +xref:get_settings[] +xref:post_settings[] +//tag::get_settings[] + // markup not found, no include::{specDir}paths/get_settings/operation-before.adoc[opts=optional] @@ -3641,12 +3698,17 @@ GET /admin/settings [markdown] -- 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 @@ -3664,12 +3726,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] @@ -3691,7 +3747,7 @@ a| [markdown] -- An object giving node-level query settings. -- -a| <> +a| xref:Settings[] @@ -3724,7 +3780,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -3753,6 +3809,10 @@ a| <> // markup not found, no include::{specDir}paths/get_settings/operation-after.adoc[opts=optional] +//end::get_settings[] + + +//tag::post_settings[] // markup not found, no include::{specDir}paths/post_settings/operation-before.adoc[opts=optional] @@ -3786,12 +3846,21 @@ POST /admin/settings [markdown] -- 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 @@ -3818,13 +3887,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] @@ -3835,7 +3904,7 @@ An object specifying node-level query settings. [%hardbreaks] {blank} -a| <> +a¦ xref:Settings[] @@ -3852,17 +3921,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] @@ -3884,7 +3942,7 @@ a| [markdown] -- An object giving node-level query settings, including the latest changes. -- -a| <> +a| xref:Settings[] @@ -3917,7 +3975,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -3946,6 +4004,8 @@ a| <> // markup not found, no include::{specDir}paths/post_settings/operation-after.adoc[opts=optional] +//end::post_settings[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -3966,11 +4026,13 @@ endif::[] endif::[] [%hardbreaks] -<> -<> -<> -<> +xref:get_debug_vars[] +xref:get_stat[] +xref:get_stats[] +xref:get_vitals[] + +//tag::get_debug_vars[] // markup not found, no include::{specDir}paths/get_debug_vars/operation-before.adoc[opts=optional] @@ -4009,6 +4071,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 @@ -4026,12 +4094,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] @@ -4096,6 +4158,10 @@ include::{snippetDir}get_debug_vars/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_debug_vars/operation-after.adoc[opts=optional] +//end::get_debug_vars[] + + +//tag::get_stat[] // markup not found, no include::{specDir}paths/get_stat/operation-before.adoc[opts=optional] @@ -4134,6 +4200,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 @@ -4156,13 +4228,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] @@ -4170,14 +4242,13 @@ a| The name of a statistic. Only top-level statistic names can be used. You cannot specify a metric. - -- [%hardbreaks] *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 @@ -4198,12 +4269,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] @@ -4223,9 +4288,9 @@ a| String | 200 a| [markdown] -- -An object containing all metrics for the specified statistic. Each statistic has a different set of metrics. +An object containing all metrics for the specified statistic. Each statistic has a different set of metrics. -- -a| <> +a| xref:Metrics[] @@ -4258,7 +4323,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -4287,6 +4352,10 @@ a| <> // markup not found, no include::{specDir}paths/get_stat/operation-after.adoc[opts=optional] +//end::get_stat[] + + +//tag::get_stats[] // markup not found, no include::{specDir}paths/get_stats/operation-before.adoc[opts=optional] @@ -4325,6 +4394,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 @@ -4342,12 +4417,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] @@ -4367,9 +4436,9 @@ Returns all statistics. | 200 a| [markdown] -- -An object containing all statistics. Each statistic consists of a top-level statistic name and a metric name. Each statistic has a different set of metrics. +An object containing all statistics. Each statistic consists of a top-level statistic name and a metric name. Each statistic has a different set of metrics. -- -a| <> +a| xref:Statistics[] @@ -4402,7 +4471,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -4431,6 +4500,10 @@ a| <> // markup not found, no include::{specDir}paths/get_stats/operation-after.adoc[opts=optional] +//end::get_stats[] + + +//tag::get_vitals[] // markup not found, no include::{specDir}paths/get_vitals/operation-before.adoc[opts=optional] @@ -4465,12 +4538,17 @@ GET /admin/vitals -- Returns data about the running state and health of the query engine. This information can be very useful to assess the current workload and performance characteristics of a query engine, and hence load-balance the requests being sent to various query engines. - -- // markup not found, no include::{specDir}paths/get_vitals/operation-description-end.adoc[opts=optional] + + +[#get_vitals-produces] +.Produces +* application/json + :leveloffset: -1 @@ -4488,12 +4566,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] @@ -4515,7 +4587,7 @@ a| [markdown] -- An object containing all vital statistics. -- -a| <> +a| xref:Vitals[] @@ -4548,7 +4620,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -4577,6 +4649,8 @@ include::{snippetDir}get_vitals/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_vitals/operation-after.adoc[opts=optional] +//end::get_vitals[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -4599,7 +4673,7 @@ endif::[] [#models] = Definitions -:count-models: 10 +:count-models: 12 :leveloffset: +1 @@ -4613,16 +4687,18 @@ ifdef::collapse-models[] [.two-columns] endif::collapse-models[] [%hardbreaks] -<> -<> -<> -<> -<> -<> -<> -<> -<> -<> +xref:Clusters[] +xref:Garbage[] +xref:Logging_Parameters[] +xref:Logging_Parameters_Plan[] +xref:Logging_Parameters_Plan_Pairs[] +xref:Metrics[] +xref:Nodes[] +xref:Requests[] +xref:Settings[] +xref:Statements[] +xref:Statistics[] +xref:Vitals[] endif::[] @@ -4647,14 +4723,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] -- @@ -4663,13 +4739,13 @@ The name of the cluster. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *datastore* + _optional_ -a| +a¦ [markdown] -- @@ -4678,13 +4754,13 @@ The URL of the datastore. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *configstore* + _optional_ -a| +a¦ [markdown] -- @@ -4693,13 +4769,13 @@ The URL of the configstore. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *accountstore* + _optional_ -a| +a¦ [markdown] -- @@ -4708,13 +4784,13 @@ The URL of the accountstore. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *version* + _optional_ -a| +a¦ [markdown] -- @@ -4722,7 +4798,7 @@ a| [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -4762,14 +4838,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] -- @@ -4778,30 +4854,29 @@ The amount of memory freed. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *released* + _optional_ -a| +a¦ [markdown] -- Only returned by the POST method. The amount of memory released to the OS. - -- [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *status* + _required_ -a| +a¦ [markdown] -- @@ -4810,7 +4885,7 @@ The status of the garbage collector. [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -4854,21 +4929,20 @@ ifdef::model-descriptions[] A nested object that sets the parameters for the completed requests catalog. All completed requests that match these parameters are tracked in the completed requests catalog. -Refer to [Configure the Completed Requests][sys-completed-config] for more information and examples. - -[sys-completed-config]: /cloud/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config +Refer to [Configure Completed Requests][sys-completed-config] for more information and examples. +[sys-completed-config]: ../n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config //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] -- @@ -4879,133 +4953,183 @@ 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] -- The IP address of the client. 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] -- ifdef::alt-markdown-links[] [client_context_id]: #client_context_id - endif::alt-markdown-links[] The opaque ID or context provided by the client. If specified, all completed requests with this client context ID are logged. +// tag::desc-more[] Refer to the [request-level][client_context_id] `client_context_id` parameter for more information. [client_context_id]: ../n1ql-rest-query/index.html#client_context_id - +// end::desc-more[] -- [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *error* + _optional_ -a| +a¦ [markdown] -- An error number. If specified, all completed queries returning this error number are logged. - -- [%hardbreaks] *Default:* `null` *Example:* `12003` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *tag* + _optional_ -a| +a¦ [markdown] -- -A unique string which tags a set of qualifiers. +ifdef::alt-markdown-links[] +[sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config -Refer to [Configure the Completed Requests][sys-completed-config] for more information. +endif::alt-markdown-links[] +A unique string which tags a set of qualifiers. -[sys-completed-config]: /cloud/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config +Refer to [Configure Completed Requests][sys-completed-config] for more information. +[sys-completed-config]: ../n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config -- [%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] -- A duration in milliseconds. If specified, all completed queries lasting longer than this threshold are logged. -This is another way of specifying the [node-level](#completed-threshold) `completed-threshold` setting. - +This is another way of specifying the `completed-threshold` setting. -- [%hardbreaks] *Default:* `1000` *Example:* `7000` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| +a¦ *user* + _optional_ -a| +a¦ [markdown] -- A user name, as given in the request credentials. If specified, all completed queries with this user name are logged. +-- + +[%hardbreaks] +*Default:* `+++""+++` +*Example:* `+++"marco"+++` +{blank} +a¦ String + + +a¦ +*statement* + +_optional_ +a¦ +[markdown] +-- +A LIKE search pattern to match against the query text. +If specified, all completed queries where the pattern is found are logged. -- [%hardbreaks] -*Default:* `pass:c[""]` -*Example:* `pass:c["marco"]` +*Default:* `+++""+++` +*Example:* `+++"%FIND USER%"+++` {blank} -a| String +a¦ String + + +a¦ +*plan* + +_optional_ +a¦ + +[markdown] +-- +include::index.adoc[tag=desc-Logging_Parameters_Plan, opts=optional] +-- + +[%hardbreaks] +{blank} +a¦ xref:Logging_Parameters_Plan[] + + +a¦ +*errors* + +_optional_ +a¦ + +[markdown] +-- +The number of errors. +If specified, all completed queries that return at least this many errors are logged. +Queries with fewer errors are not logged. +-- + +[%hardbreaks] +*Example:* `5` +{blank} +a¦ Integer (int32) |=== @@ -5025,109 +5149,251 @@ a| String -// markup not found, no include::{specDir}definitions/Metrics/definition-before.adoc[opts=optional] +// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan/definition-before.adoc[opts=optional] ifdef::collapse-models[] [discrete] endif::collapse-models[] -[#Metrics] -= Metrics +[#Logging_Parameters_Plan] += Plan Qualifier :leveloffset: +1 -// markup not found, no include::{specDir}definitions/Metrics/definition-begin.adoc[opts=optional] +// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan/definition-begin.adoc[opts=optional] -.icon:brackets-curly[fw] Object +.icon:bars[fw] Composite Schema {blank} -//tag::Metrics[] +//tag::Logging_Parameters_Plan[] +ifdef::model-descriptions[] +//tag::desc-Logging_Parameters_Plan[] +An object, or an array of objects, containing one or more field:value pairs to match against the query plan. +Each pair describes a field in the query plan and the value it must have. +All completed queries where the specified field:value pairs are found in the plan are logged. +//end::desc-Logging_Parameters_Plan[] +endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ One{nbsp}of{nbsp}... ¦ ¦ Schema -a| -*count* + -_optional_ -a| +a¦ +a¦ [markdown] -- -A single value that represents the current state. +include::index.adoc[tag=desc-Logging_Parameters_Plan_Pairs, opts=optional] -- [%hardbreaks] {blank} -a| Integer +a¦ xref:Logging_Parameters_Plan_Pairs[] -a| -*15m.rate* + -_optional_ -a| +a¦ _or_ +a¦ [markdown] -- -15-minute exponentially weighted moving average. +An array of objects, each containing one or more field:value pairs. -- [%hardbreaks] {blank} -a| Big Decimal +a¦ xref:Logging_Parameters_Plan_Pairs[] + array +|=== -a| -*1m.rate* + -_optional_ -a| +//end::Logging_Parameters_Plan[] -[markdown] --- -1-minute exponentially weighted moving average. --- -[%hardbreaks] -{blank} -a| Big Decimal +// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan/definition-end.adoc[opts=optional] -a| -*5m.rate* + -_optional_ -a| +:leveloffset: -1 -[markdown] --- -5-minute exponentially weighted moving average. --- +// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan/definition-after.adoc[opts=optional] -[%hardbreaks] -{blank} -a| Big Decimal -a| -*mean.rate* + -_optional_ -a| -[markdown] --- -Mean rate since the query service started. --- +// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan_Pairs/definition-before.adoc[opts=optional] -[%hardbreaks] -{blank} -a| Big Decimal +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#Logging_Parameters_Plan_Pairs] += Field:Value Pairs -a| +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan_Pairs/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::Logging_Parameters_Plan_Pairs[] + +ifdef::model-descriptions[] +//tag::desc-Logging_Parameters_Plan_Pairs[] +An object containing one or more field:value pairs. +//end::desc-Logging_Parameters_Plan_Pairs[] +endif::model-descriptions[] + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +** + +_additional + +property_ +a¦ + +[markdown] +-- +A field:value pair describing a field in the query plan, and the value that the field must have for the request to be logged. +The name of the property is the name of the field in the query plan. +The value may be a string, number, array, or any other JSON value. + +Within a single JSON object, if multiple field:value pairs are specified, then all pairs must be matched (using AND). +For example, `{"index": "ix1", "#operator": "IntersectScan"}` specifies that if the query plan has an `index` field with the value `"ix1"` AND has an `IntersectScan` operator, then the request should be logged. + +Within an array of JSON objects, each field:value pair must be unique, but fields can be repeated. +For example, `[{"index": "ix1"}, {"index": "ix2"}]` specifies that if the query plan has an `index` field with the value `"ix1"` AND another `index` field with the value `"ix2"`, then the request should be logged. +-- + +[%hardbreaks] +{blank} +a¦ Any Type + + +|=== + +//end::Logging_Parameters_Plan_Pairs[] + + + + +// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan_Pairs/definition-end.adoc[opts=optional] + + +:leveloffset: -1 + +// markup not found, no include::{specDir}definitions/Logging_Parameters_Plan_Pairs/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/Metrics/definition-before.adoc[opts=optional] + + +ifdef::collapse-models[] +[discrete] +endif::collapse-models[] +[#Metrics] += Metrics + +:leveloffset: +1 + +// markup not found, no include::{specDir}definitions/Metrics/definition-begin.adoc[opts=optional] + + +.icon:brackets-curly[fw] Object +{blank} + +//tag::Metrics[] + + +[cols="25,55,20",separator=¦] +|=== +¦ Property ¦ ¦ Schema + +a¦ +*count* + +_optional_ +a¦ + +[markdown] +-- +A single value that represents the current state. +-- + +[%hardbreaks] +{blank} +a¦ Integer + + +a¦ +*15m.rate* + +_optional_ +a¦ + +[markdown] +-- +15-minute exponentially weighted moving average. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*1m.rate* + +_optional_ +a¦ + +[markdown] +-- +1-minute exponentially weighted moving average. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*5m.rate* + +_optional_ +a¦ + +[markdown] +-- +5-minute exponentially weighted moving average. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ +*mean.rate* + +_optional_ +a¦ + +[markdown] +-- +Mean rate since the query service started. +-- + +[%hardbreaks] +{blank} +a¦ Big Decimal + + +a¦ *max* + _optional_ -a| +a¦ [markdown] -- @@ -5136,13 +5402,13 @@ The maximum value. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *mean* + _optional_ -a| +a¦ [markdown] -- @@ -5151,13 +5417,13 @@ The mean value. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *median* + _optional_ -a| +a¦ [markdown] -- @@ -5166,13 +5432,13 @@ The median value. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *min* + _optional_ -a| +a¦ [markdown] -- @@ -5181,13 +5447,13 @@ The minimum value. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *stddev* + _optional_ -a| +a¦ [markdown] -- @@ -5196,13 +5462,13 @@ The standard deviation. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *75%* + _optional_ -a| +a¦ [markdown] -- @@ -5211,13 +5477,13 @@ The 75th percentile. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *95%* + _optional_ -a| +a¦ [markdown] -- @@ -5226,13 +5492,13 @@ The 95th percentile. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *99%* + _optional_ -a| +a¦ [markdown] -- @@ -5241,13 +5507,13 @@ The 99th percentile. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *99.9%* + _optional_ -a| +a¦ [markdown] -- @@ -5256,7 +5522,7 @@ The 99.9th percentile. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal |=== @@ -5296,14 +5562,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] -- @@ -5312,13 +5578,13 @@ The name of the cluster. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *name* + _optional_ -a| +a¦ [markdown] -- @@ -5327,13 +5593,13 @@ The URL of the node, including port number. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *queryEndpoint* + _optional_ -a| +a¦ [markdown] -- @@ -5342,13 +5608,13 @@ The HTTP URL of the query endpoint. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *adminEndpoint* + _optional_ -a| +a¦ [markdown] -- @@ -5357,13 +5623,13 @@ The HTTP URL of the admin endpoint. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *querySecure* + _optional_ -a| +a¦ [markdown] -- @@ -5372,13 +5638,13 @@ The HTTPS URL of the query endpoint. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *adminSecure* + _optional_ -a| +a¦ [markdown] -- @@ -5387,13 +5653,13 @@ The HTTPS URL of the admin endpoint. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *options* + _optional_ -a| +a¦ [markdown] -- @@ -5401,7 +5667,7 @@ a| [%hardbreaks] {blank} -a| String +a¦ String |=== @@ -5441,55 +5707,73 @@ 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] -- ifdef::alt-markdown-links[] -[client_context_id]: #client_context_id - +[client_context_id]: query-settings.html#client_context_id endif::alt-markdown-links[] The opaque ID or context provided by the client. + +// tag::desc-more[] Refer to the [request-level][client_context_id] `client_context_id` parameter for more information. [client_context_id]: ../n1ql-rest-query/index.html#client_context_id +// end::desc-more[] +-- +[%hardbreaks] +{blank} +a¦ String + + +a¦ +*cpuTime* + +_optional_ +a¦ + +[markdown] +-- +The total sum of [execTime][exec_time] across all operators. + +[exec_time]: ../n1ql-rest-query/index.html#exec_time -- [%hardbreaks] +*Example:* `+++"90.734075ms"+++` {blank} -a| String +a¦ String (duration) -a| +a¦ *elapsedTime* + _optional_ -a| +a¦ [markdown] -- The time taken from when the request was acknowledged by the service to when the request was completed. It includes the time taken by the service to schedule the request. - -- [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *errorCount* + _optional_ -a| +a¦ [markdown] -- @@ -5498,30 +5782,47 @@ Total number of errors encountered while executing the query. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ +*ioTime* + +_optional_ +a¦ + +[markdown] +-- +The total sum of [servTime][serv_time] across all operators. + +[serv_time]: ../n1ql-rest-query/index.html#serv_time +-- + +[%hardbreaks] +*Example:* `+++"752.858519ms"+++` +{blank} +a¦ String (duration) + + +a¦ *memoryQuota* + _optional_ -a| +a¦ [markdown] -- The memory quota for the request, in MB. 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] -- @@ -5530,13 +5831,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] -- @@ -5544,19 +5845,18 @@ Count of documents processed at selective phases involved in the query execution For active requests, this property is dynamic, depending on the documents processed by various phases up to this moment in time. 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] -- @@ -5565,19 +5865,18 @@ Indicates the numbers of each kind of query operator involved in different phase For instance, a non-covering index path might involve one index scan and one fetch operator. A join would probably involve two or more fetches, one per keyspace. A union select would have twice as many operator counts, one per each branch of the union. - -- [%hardbreaks] *Example:* `{"authorize":1,"fetch":1,"indexScan":2}` {blank} -a| Object +a¦ Object -a| +a¦ *phaseTimes* + _optional_ -a| +a¦ [markdown] -- @@ -5585,19 +5884,18 @@ Cumulative execution times for various phases involved in the query execution, s For active requests, this property is dynamic, depending on the documents processed by various phases up to this moment in time. 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] -- @@ -5606,13 +5904,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] -- @@ -5621,13 +5919,13 @@ Unique request ID internally generated for the query. [%hardbreaks] {blank} -a| UUID (uuid) +a¦ UUID (uuid) -a| +a¦ *requestTime* + _optional_ -a| +a¦ [markdown] -- @@ -5636,13 +5934,13 @@ Timestamp when the query is received. [%hardbreaks] {blank} -a| Date (date-time) +a¦ Date (date-time) -a| +a¦ *resultCount* + _optional_ -a| +a¦ [markdown] -- @@ -5651,13 +5949,13 @@ Total number of documents returned in the query result. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *resultSize* + _optional_ -a| +a¦ [markdown] -- @@ -5666,13 +5964,13 @@ Total number of bytes returned in the query result. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *scanConsistency* + _optional_ -a| +a¦ [markdown] -- @@ -5681,13 +5979,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] -- @@ -5696,13 +5994,34 @@ Total amount of calendar time taken to complete the query. [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ +*sessionMemory* + +_optional_ +a¦ + +[markdown] +-- +The memory session size for the request, in bytes. + +Each request has a dedicated memory session. +When a query requires a document or value, memory is allocated from this session based on the size of the document or value. +Once the document or value is processed, the allocated memory is returned back to the session, enabling it to be reused by the request. + +This metric is available only when `node-quota` and `node-quota-val-percent` are configured for the node. +-- + +[%hardbreaks] +{blank} +a¦ Integer (bytes) + + +a¦ *state* + _optional_ -a| +a¦ [markdown] -- @@ -5712,18 +6031,17 @@ Note that the `completed` state means that the request was started and completed The request could have been successful, or completed with errors. To find requests that were successful, use this field in conjunction with the `errorCount` field: search for requests whose state is `completed` and whose error count is `0`. - -- [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *statement* + _optional_ -a| +a¦ [markdown] -- @@ -5732,13 +6050,13 @@ The query statement being executed. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *useCBO* + _optional_ -a| +a¦ [markdown] -- @@ -5747,30 +6065,29 @@ Whether the cost-based optimizer is enabled for the query. [%hardbreaks] {blank} -a| Boolean +a¦ Boolean -a| +a¦ *usedMemory* + _optional_ -a| +a¦ [markdown] -- The amount of document memory used to execute the request. This property is only returned if a memory quota is set for the query. - -- [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *userAgent* + _optional_ -a| +a¦ [markdown] -- @@ -5779,13 +6096,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] -- @@ -5794,8 +6111,43 @@ Username with whose privileges the query is run. [%hardbreaks] {blank} -a| String +a¦ String + + +a¦ +*waitTime* + +_optional_ +a¦ + +[markdown] +-- +The total sum of [kernTime][kern_time] across all operators. + +[kern_time]: ../n1ql-rest-query/index.html#kern_time +-- +[%hardbreaks] +*Example:* `+++"1.201307s"+++` +{blank} +a¦ String (duration) + + +a¦ +*~analysis* + +_optional_ +a¦ + +[markdown] +-- +An array of text phrases that provide a basic analysis of the request execution. +These phrases highlight notable aspects of the execution, such as high document counts during primary scans or warnings related to memory and resource usages. +-- + +[%hardbreaks] +*Example:* `["High IO time","High primary scan document count"]` +{blank} +a¦ String + array |=== @@ -5834,21 +6186,20 @@ 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] -- ifdef::alt-markdown-links[] [atrcollection_req]: #atrcollection_req - endif::alt-markdown-links[] Specifies the collection where [active transaction records][additional-storage-use] are stored. The collection must be present. @@ -5857,110 +6208,114 @@ If not specified, the active transaction record is stored in the default collect The value must be a string in the form `"bucket.scope.collection"` or `"namespace:bucket.scope.collection"`. If any part of the path contains a special character, that part of the path must be delimited in backticks ``. +[additional-storage-use]: /server/8.0/learn/data/transactions.html#active-transaction-record-entries + +// tag::desc-more[] The [request-level][atrcollection_req] `atrcollection` parameter specifies this property per request. If a request does not include this parameter, the node-level `atrcollection` setting will be used. -[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [atrcollection_req]: ../n1ql-rest-query/index.html#atrcollection_req - +// end::desc-more[] -- [%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] -- +ifdef::alt-markdown-links[] +[auto-prepare]: ../n1ql-language-reference/prepare.html#auto-prepare + +endif::alt-markdown-links[] Specifies whether the query engine should create a prepared statement every time a SQL++ request is submitted, whether the PREPARE statement is included or not. Refer to [Auto-Prepare][auto-prepare] for more information. -[auto-prepare]: /cloud/n1ql/n1ql-language-reference/prepare.html#auto-prepare - +[auto-prepare]: ../n1ql/n1ql-language-reference/prepare.html#auto-prepare -- [%hardbreaks] *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#cleanupclientattempts] +a¦ [#cleanupclientattempts] *cleanupclientattempts* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryCleanupClientAttempts]: #queryCleanupClientAttempts - endif::alt-markdown-links[] When enabled, the Query service preferentially aims to clean up just transactions that it has created, leaving transactions for the distributed cleanup process only when it is forced to. +// tag::desc-more[] The [cluster-level][queryCleanupClientAttempts] `queryCleanupClientAttempts` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [queryCleanupClientAttempts]: ../n1ql-rest-settings/index.html#queryCleanupClientAttempts - +// end::desc-more[] -- [%hardbreaks] *Default:* `true` *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#cleanuplostattempts] +a¦ [#cleanuplostattempts] *cleanuplostattempts* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryCleanupLostAttempts]: #queryCleanupLostAttempts - endif::alt-markdown-links[] When enabled, the Query service takes part in the distributed cleanup process, and cleans up expired transactions created by any client. +// tag::desc-more[] The [cluster-level][queryCleanupLostAttempts] `queryCleanupLostAttempts` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [queryCleanupLostAttempts]: ../n1ql-rest-settings/index.html#queryCleanupLostAttempts - +// end::desc-more[] -- [%hardbreaks] *Default:* `true` *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#cleanupwindow] +a¦ [#cleanupwindow] *cleanupwindow* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryCleanupWindow]: #queryCleanupWindow - endif::alt-markdown-links[] Specifies how frequently the Query service checks its subset of [active transaction records][additional-storage-use] for cleanup. Decreasing this setting causes expiration transactions to be found more swiftly, with the tradeoff of increasing the number of reads per second used for the scanning process. @@ -5976,98 +6331,106 @@ Valid units are: * `m` (minutes) * `h` (hours) +[additional-storage-use]: /server/8.0/learn/data/transactions.html#active-transaction-record-entries + +// tag::desc-more[] The [cluster-level][queryCleanupWindow] `queryCleanupWindow` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. -[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [queryCleanupWindow]: ../n1ql-rest-settings/index.html#queryCleanupWindow - +// end::desc-more[] -- [%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] -- +ifdef::alt-markdown-links[] +[sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config + +endif::alt-markdown-links[] include::index.adoc[tag=desc-Logging_Parameters, opts=optional] -- [%hardbreaks] {blank} -a| <> +a¦ xref:Logging_Parameters[] -a| [#completed-limit] +a¦ [#completed-limit] *completed-limit* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] +[sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config [queryCompletedLimit]: #queryCompletedLimit - endif::alt-markdown-links[] Sets the number of requests to be logged in the completed requests catalog. As new completed requests are added, old ones are removed. Increase this when the completed request keyspace is not big enough to track the slow requests, such as when you want a larger sample of slow requests. -Refer to [Configure the Completed Requests][sys-completed-config] for more information and examples. +Refer to [Configure Completed Requests][sys-completed-config] for more information and examples. +[sys-completed-config]: ../n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + +// tag::desc-more[] The [cluster-level][queryCompletedLimit] `queryCompletedLimit` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. -[sys-completed-config]: /cloud/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config [queryCompletedLimit]: ../n1ql-rest-settings/index.html#queryCompletedLimit - +// end::desc-more[] -- [%hardbreaks] *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| [.status]##Couchbase Server 7.6## +a¦ [markdown] -- ifdef::alt-markdown-links[] +[sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config [queryCompletedMaxPlanSize]: #queryCompletedMaxPlanSize - endif::alt-markdown-links[] -This property is available in databases running Couchbase Server 7.6.0 and later. - A plan size in bytes. Limits the size of query execution plans that can be logged in the completed requests catalog. Values larger than the maximum limit are silently treated as the maximum limit. Queries with plans larger than this are not logged. You must obtain execution plans for such queries via profiling or using the EXPLAIN statement. -Refer to [Configure the Completed Requests][sys-completed-config] for more information. +Refer to [Configure Completed Requests][sys-completed-config] for more information. + +[sys-completed-config]: ../n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config +// tag::desc-more[] The [cluster-level][queryCompletedMaxPlanSize] `queryCompletedMaxPlanSize` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. -[sys-completed-config]: /cloud/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config [queryCompletedMaxPlanSize]: ../n1ql-rest-settings/index.html#queryCompletedMaxPlanSize - +// end::desc-more[] -- [%hardbreaks] @@ -6075,20 +6438,48 @@ 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-stream-size] +*completed-stream-size* + +_optional_ +a¦ + +[markdown] +-- +ifdef::alt-markdown-links[] +[sys-history]: monitoring-n1ql-query.html#sys-history + +endif::alt-markdown-links[] +A file size in MiB. +When specified, completed requests are saved to the Couchbase Server `logs` directory. +Completed requests are saved to GZIP archives with the prefix `local_request_log`. +The value of this property determines the size of the data to retain, per node. + +Specify `0` (the default) to disable completed request streaming. + +Refer to [Stream Completed Requests][sys-history] for more information and examples. + +[sys-history]: ../n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-history +-- + +[%hardbreaks] +{blank} +a¦ Integer (int32) -a| [#completed-threshold] +a¦ [#completed-threshold] *completed-threshold* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] +[sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config [queryCompletedThreshold]: #queryCompletedThreshold - endif::alt-markdown-links[] A duration in milliseconds. All completed queries lasting longer than this threshold are logged in the completed requests catalog. @@ -6096,34 +6487,35 @@ All completed queries lasting longer than this threshold are logged in the compl Specify `0` to track all requests, independent of duration. Specify any negative number to track none. -Refer to [Configure the Completed Requests][sys-completed-config] for more information and examples. +Refer to [Configure Completed Requests][sys-completed-config] for more information and examples. +[sys-completed-config]: ../n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + +// tag::desc-more[] The [cluster-level][queryCompletedThreshold] `queryCompletedThreshold` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. -[sys-completed-config]: /cloud/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config [queryCompletedThreshold]: ../n1ql-rest-settings/index.html#queryCompletedThreshold - +// end::desc-more[] -- [%hardbreaks] *Default:* `1000` *Example:* `7000` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#controls-srv] +a¦ [#controls-srv] *controls* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [controls_req]: #controls_req - endif::alt-markdown-links[] Specifies if there should be a controls section returned with the request results. @@ -6131,24 +6523,25 @@ When set to `true`, the query response document includes a controls section with NOTE: If the request qualifies for caching, these values will also be cached in the `completed_requests` system keyspace. +// tag::desc-more[] The [request-level][controls_req] `controls` parameter specifies this property per request. If a request does not include this parameter, the node-level `controls` setting will be used. [controls_req]: ../n1ql-rest-query/index.html#controls_req - +// end::desc-more[] -- [%hardbreaks] *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#cpuprofile] +a¦ [#cpuprofile] *cpuprofile* + _optional_ -a| +a¦ [markdown] -- @@ -6159,59 +6552,56 @@ The output file includes a controls section and performance measurements, such a NOTE: If `cpuprofile` is left running too long, it can slow the system down as its file size increases. 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] -- Use debug mode. When set to `true`, extra logging is provided. - -- [%hardbreaks] *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#distribute] +a¦ [#distribute] *distribute* + _optional_ -a| +a¦ [markdown] -- This field is only available with the POST method. When specified alongside other settings, this field instructs the node that is processing the request to cascade those settings to all other query nodes. 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] -- @@ -6222,13 +6612,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] -- @@ -6239,20 +6629,19 @@ 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] -- ifdef::alt-markdown-links[] [queryLogLevel]: #queryLogLevel - endif::alt-markdown-links[] Log level used in the logger. @@ -6278,50 +6667,50 @@ Major items, like crashes. * `NONE` — Doesn't write anything. +// tag::desc-more[] The [cluster-level][queryLogLevel] `queryLogLevel` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [queryLogLevel]: ../n1ql-rest-settings/index.html#queryLogLevel - +// end::desc-more[] -- [%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] -- Max index API. 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] -- ifdef::alt-markdown-links[] +[max-parallelism]: ../n1ql-language-reference/index-partitioning.html#max-parallelism [queryMaxParallelism]: #queryMaxParallelism [max_parallelism_req]: #max_parallelism_req - endif::alt-markdown-links[] Specifies the maximum parallelism for queries on this node. @@ -6331,7 +6720,11 @@ Similarly, if the value is greater than the number of allowed cores, the maximum (The number of allowed cores is the same as the number of logical CPUs. In Community Edition, the number of allowed cores cannot be greater than 4. In Enterprise Edition, there is no limit to the number of allowed cores.) +Refer to [Max Parallelism][max-parallelism] for more information. +[max-parallelism]: ../n1ql/n1ql-language-reference/index-partitioning.html#max-parallelism + +// tag::desc-more[] The [cluster-level][queryMaxParallelism] `queryMaxParallelism` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -6340,25 +6733,22 @@ If a request includes this parameter, it will be capped by the node-level `max-p NOTE: To enable queries to run in parallel, you must specify the cluster-level `queryMaxParallelism` parameter, or specify the node-level `max-parallelism` parameter on all Query nodes. -Refer to [Max Parallelism][max-parallelism] for more information. - -[max-parallelism]: /cloud/n1ql/n1ql-language-reference/index-partitioning.html#max-parallelism [queryMaxParallelism]: ../n1ql-rest-settings/index.html#queryMaxParallelism [max_parallelism_req]: ../n1ql-rest-query/index.html#max_parallelism_req - +// end::desc-more[] -- [%hardbreaks] *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] -- @@ -6366,21 +6756,19 @@ ifdef::alt-markdown-links[] [queryMemoryQuota]: #queryMemoryQuota [memory_quota_req]: #memory_quota_req - endif::alt-markdown-links[] Specifies the maximum amount of memory a request may use on this node, in MB. -Note that the overall node memory quota is this setting multiplied by the [node-level](#servicers) `servicers` setting. Specify `0` (the default value) to disable. When disabled, there is no quota. -This parameter enforces a ceiling on the memory used for the tracked documents required for -processing a request. It does not take into account any other memory that might be used to -process a request, such as the stack, the operators, or some intermediate values. +This parameter enforces a ceiling on the memory used for the tracked documents required for processing a request. +It does not take into account any other memory that might be used to process a request, such as the stack, the operators, or some intermediate values. Within a transaction, this setting enforces the memory quota for the transaction by tracking the delta table and the transaction log (approximately). +// tag::desc-more[] The [cluster-level][queryMemoryQuota] `queryMemoryQuota` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -6389,20 +6777,20 @@ If a request includes this parameter, it will be capped by the node-level `memor [queryMemoryQuota]: ../n1ql-rest-settings/index.html#queryMemoryQuota [memory_quota_req]: ../n1ql-rest-query/index.html#memory_quota_req - +// end::desc-more[] -- [%hardbreaks] *Default:* `0` *Example:* `4` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#memprofile] +a¦ [#memprofile] *memprofile* + _optional_ -a| +a¦ [markdown] -- @@ -6411,120 +6799,120 @@ Filename to write the diagnostic memory usage log. NOTE: If `memprofile` is left running too long, it can slow the system down as its file size increases. 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] -- Mutex profile. 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] -- ifdef::alt-markdown-links[] -[queryN1qlFeatCtrl]: #queryN1qlFeatCtrl - +[queryN1QLFeatCtrl]: #queryN1QLFeatCtrl endif::alt-markdown-links[] SQL++ feature control. This setting is provided for technical support only. -The value may be an integer. -On databases running Couchbase Server 7.6 or later, it may also be a string representing a hexadecimal number. +The value may be an integer, or a string representing a hexadecimal number. -The [cluster-level][queryN1qlFeatCtrl] `queryN1qlFeatCtrl` setting specifies this property for the whole cluster. +// tag::desc-more[] +The [cluster-level][queryN1QLFeatCtrl] `queryN1QLFeatCtrl` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. -[queryN1qlFeatCtrl]: ../n1ql-rest-settings/index.html#queryN1qlFeatCtrl - +[queryN1QLFeatCtrl]: ../n1ql-rest-settings/index.html#queryN1QLFeatCtrl +// end::desc-more[] -- [%hardbreaks] *Default:* `76` *Example:* `16460` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#node-quota] +a¦ [#node-quota] *node-quota* + _optional_ -a| [.status]##Couchbase Server 7.6## +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryNodeQuota]: #queryNodeQuota - endif::alt-markdown-links[] -This property is available in databases running Couchbase Server 7.6.0 and later. - -Sets the soft memory limit for this node, in MB. +Sets the soft memory limit for the Query service on this node, in MB. The garbage collector tries to keep below this target. It is not a hard, absolute limit, and memory usage may exceed this value. -When set to `0` (the default), there is no soft memory limit. +When set to `0` (the default), the Query service sets a default soft memory limit for the node. +To do this, the Query service calculates the difference between the total system RAM and 90% of the total system RAM: + +`Total System RAM - (0.9 * Total System RAM)` + +- If the difference is greater than 8 GiB, the default soft memory limit is set to the total system RAM minus 8 GiB. +- If the difference is 8 GiB or less, the default soft memory limit is set to 90% of the total system RAM. + +// tag::desc-more[] The [cluster-level][queryNodeQuota] `queryNodeQuota` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [queryNodeQuota]: ../n1ql-rest-settings/index.html#queryNodeQuota - +// end::desc-more[] -- [%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| [.status]##Couchbase Server 7.6## +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryNodeQuotaValPercent]: #queryNodeQuotaValPercent - endif::alt-markdown-links[] -This property is available in databases running Couchbase Server 7.6.0 and later. - The percentage of the `node-quota` that is dedicated to tracked value content memory across all active requests on this node. (The `memory-quota` setting specifies the maximum amount of document memory an individual request may use on this node.) +// tag::desc-more[] The [cluster-level][queryNodeQuotaValPercent] `queryNodeQuotaValPercent` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [queryNodeQuotaValPercent]: ../n1ql-rest-settings/index.html#queryNodeQuotaValPercent - +// end::desc-more[] -- [%hardbreaks] @@ -6532,23 +6920,20 @@ 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| [.status]##Couchbase Server 7.6## +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryNumCpus]: #queryNumCpus - endif::alt-markdown-links[] -This property is available in databases running Couchbase Server 7.6.0 and later. - The number of CPUs the Query service can use on this node. Note that this setting requires a restart of the Query service to take effect. @@ -6558,23 +6943,24 @@ The number of CPUs can never be greater than the number of logical CPUs. In Community Edition, the number of allowed CPUs cannot be greater than 4. In Enterprise Edition, there is no limit to the number of allowed CPUs. +// tag::desc-more[] The [cluster-level][queryNumCpus] `queryNumCpus` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [queryNumCpus]: ../n1ql-rest-settings/index.html#queryNumCpus - +// end::desc-more[] -- [%hardbreaks] *Default:* `0` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#numatrs-srv] +a¦ [#numatrs-srv] *numatrs* + _optional_ -a| +a¦ [markdown] -- @@ -6582,31 +6968,32 @@ ifdef::alt-markdown-links[] [queryNumAtrs]: #queryNumAtrs [numatrs_req]: #numatrs_req - endif::alt-markdown-links[] Specifies the total number of [active transaction records][additional-storage-use]. +[additional-storage-use]: /server/8.0/learn/data/transactions.html#active-transaction-record-entries + +// tag::desc-more[] The [cluster-level][queryNumAtrs] `queryNumAtrs` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. In addition, the [request-level][numatrs_req] `numatrs` parameter specifies this property per request. The minimum of that and the node-level `numatrs` setting is applied. -[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [queryNumAtrs]: ../n1ql-rest-settings/index.html#queryNumAtrs [numatrs_req]: ../n1ql-rest-query/index.html#numatrs_req - +// end::desc-more[] -- [%hardbreaks] {blank} -a| String +a¦ String -a| [#pipeline-batch-srv] +a¦ [#pipeline-batch-srv] *pipeline-batch* + _optional_ -a| +a¦ [markdown] -- @@ -6614,10 +7001,10 @@ ifdef::alt-markdown-links[] [queryPipelineBatch]: #queryPipelineBatch [pipeline_batch_req]: #pipeline_batch_req - endif::alt-markdown-links[] Controls the number of items execution operators can batch for Fetch from the KV. +// tag::desc-more[] The [cluster-level][queryPipelineBatch] `queryPipelineBatch` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -6626,20 +7013,20 @@ The minimum of that and the node-level `pipeline-batch` setting is applied. [queryPipelineBatch]: ../n1ql-rest-settings/index.html#queryPipelineBatch [pipeline_batch_req]: ../n1ql-rest-query/index.html#pipeline_batch_req - +// end::desc-more[] -- [%hardbreaks] *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] -- @@ -6647,10 +7034,10 @@ ifdef::alt-markdown-links[] [queryPipelineCap]: #queryPipelineCap [pipeline_cap_req]: #pipeline_cap_req - endif::alt-markdown-links[] Maximum number of items each execution operator can buffer between various operators. +// tag::desc-more[] The [cluster-level][queryPipelineCap] `queryPipelineCap` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -6659,102 +7046,101 @@ The minimum of that and the node-level `pipeline-cap` setting is applied. [queryPipelineCap]: ../n1ql-rest-settings/index.html#queryPipelineCap [pipeline_cap_req]: ../n1ql-rest-query/index.html#pipeline_cap_req - +// end::desc-more[] -- [%hardbreaks] *Default:* `512` *Example:* `1024` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#plus-servicers] +a¦ [#plus-servicers] *plus-servicers* + _optional_ -a| +a¦ [markdown] -- The number of service threads for transactions where the scan consistency is `request_plus` or `at_plus`. The default is 16 times the number of logical cores. - -- [%hardbreaks] *Example:* `16` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#prepared-limit] +a¦ [#prepared-limit] *prepared-limit* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [queryPreparedLimit]: #queryPreparedLimit - endif::alt-markdown-links[] Maximum number of prepared statements in the cache. When this cache reaches the limit, the least recently used prepared statements will be discarded as new prepared statements are created. +// tag::desc-more[] The [cluster-level][queryPreparedLimit] `queryPreparedLimit` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [queryPreparedLimit]: ../n1ql-rest-settings/index.html#queryPreparedLimit - +// end::desc-more[] -- [%hardbreaks] *Default:* `16384` *Example:* `65536` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#pretty-srv] +a¦ [#pretty-srv] *pretty* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [pretty_req]: #pretty_req - endif::alt-markdown-links[] Specifies whether query results are returned in pretty format. +// tag::desc-more[] The [request-level][pretty_req] `pretty` parameter specifies this property per request. If a request does not include this parameter, the node-level setting is used, which defaults to `false`. [pretty_req]: ../n1ql-rest-query/index.html#pretty_req - +// end::desc-more[] -- [%hardbreaks] *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#profile-srv] +a¦ [#profile-srv] *profile* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] +[monitor-profile-details]: monitoring-n1ql-query.html#monitor-profile-details [profile_req]: #profile_req - endif::alt-markdown-links[] Specifies if there should be a profile section returned with the request results. The valid values are: @@ -6771,26 +7157,28 @@ NOTE: If `profile` is not set as one of the above values, then the profile setti Refer to [Monitoring and Profiling Details][monitor-profile-details] for more information and examples. +[monitor-profile-details]: ../n1ql/n1ql-manage/monitoring-n1ql-query.html#monitor-profile-details + +// tag::desc-more[] The [request-level][profile_req] `profile` parameter specifies this property per request. If a request does not include this parameter, the node-level `profile` setting will be used. -[monitor-profile-details]: /cloud/n1ql/n1ql-manage/monitoring-n1ql-query.html#monitor-profile-details [profile_req]: ../n1ql-rest-query/index.html#profile_req - +// end::desc-more[] -- [%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] -- @@ -6801,13 +7189,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] -- @@ -6815,7 +7203,6 @@ ifdef::alt-markdown-links[] [queryScanCap]: #queryScanCap [scan_cap_req]: #scan_cap_req - endif::alt-markdown-links[] Maximum buffered channel size between the indexer client and the query service for index scans. This parameter controls when to use scan backfill. @@ -6823,6 +7210,7 @@ This parameter controls when to use scan backfill. Use `0` or a negative number to disable. Smaller values reduce GC, while larger values reduce indexer backfill. +// tag::desc-more[] The [cluster-level][queryScanCap] `queryScanCap` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -6831,41 +7219,38 @@ The minimum of that and the node-level `scan-cap` setting is applied. [queryScanCap]: ../n1ql-rest-settings/index.html#queryScanCap [scan_cap_req]: ../n1ql-rest-query/index.html#scan_cap_req - +// end::desc-more[] -- [%hardbreaks] *Default:* `512` *Example:* `1024` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#servicers] +a¦ [#servicers] *servicers* + _optional_ -a| +a¦ [markdown] -- The number of service threads for the query. The default is 4 times the number of cores on the query node. - -Note that the overall node memory quota is this setting multiplied by the [node-level](#memory-quota-srv) `memory-quota` setting. - -- [%hardbreaks] *Default:* `32` *Example:* `8` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#timeout-srv] +a¦ [#timeout-srv] *timeout* + _optional_ -a| +a¦ [markdown] -- @@ -6873,7 +7258,6 @@ ifdef::alt-markdown-links[] [queryTimeout]: #queryTimeout [timeout_req]: #timeout_req - endif::alt-markdown-links[] Maximum time to spend on the request before timing out (ns). @@ -6883,6 +7267,7 @@ It must not be delimited by quotes, and must not include a unit. Specify `0` (the default value) or a negative integer to disable. When disabled, no timeout is applied and the request runs for however long it takes. +// tag::desc-more[] The [cluster-level][queryTimeout] `queryTimeout` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -6891,20 +7276,20 @@ The minimum of that and the node-level `timeout` setting is applied. [queryTimeout]: ../n1ql-rest-settings/index.html#queryTimeout [timeout_req]: ../n1ql-rest-query/index.html#timeout_req - +// end::desc-more[] -- [%hardbreaks] *Default:* `0` *Example:* `500000000` {blank} -a| Long (int64) +a¦ Long (int64) -a| [#txtimeout-srv] +a¦ [#txtimeout-srv] *txtimeout* + _optional_ -a| +a¦ [markdown] -- @@ -6913,7 +7298,6 @@ ifdef::alt-markdown-links[] [queryTxTimeout]: #queryTxTimeout [txtimeout_req]: #txtimeout_req - endif::alt-markdown-links[] Maximum time to spend on a transaction before timing out (ns). This setting only applies to requests containing the `BEGIN TRANSACTION` statement, or to requests where the [tximplicit][tximplicit] parameter is set. @@ -6925,29 +7309,31 @@ It must not be delimited by quotes, and must not include a unit. Specify `0` (the default value) to disable. When disabled, no timeout is applied and the transaction runs for however long it takes. +[tximplicit]: ../n1ql-rest-query/index.html#tximplicit + +// tag::desc-more[] The [cluster-level][queryTxTimeout] `queryTxTimeout` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. In addition, the [request-level][txtimeout_req] `txtimeout` parameter specifies this property per request. The minimum of that and the node-level `txtimeout` setting is applied. -[tximplicit]: ../n1ql-rest-query/index.html#tximplicit [queryTxTimeout]: ../n1ql-rest-settings/index.html#queryTxTimeout [txtimeout_req]: ../n1ql-rest-query/index.html#txtimeout_req - +// end::desc-more[] -- [%hardbreaks] *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] -- @@ -6955,10 +7341,10 @@ ifdef::alt-markdown-links[] [queryUseCBO]: #queryUseCBO [use_cbo_req]: #use_cbo_req - endif::alt-markdown-links[] Specifies whether the cost-based optimizer is enabled. +// tag::desc-more[] The [cluster-level][queryUseCBO] `queryUseCBO` setting specifies this property for the whole cluster. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -6967,20 +7353,20 @@ If a request does not include this parameter, the node-level setting is used, wh [queryUseCBO]: ../n1ql-rest-settings/index.html#queryUseCBO [use_cbo_req]: ../n1ql-rest-query/index.html#use_cbo_req - +// end::desc-more[] -- [%hardbreaks] *Default:* `true` *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#use-replica-srv] +a¦ [#use-replica-srv] *use-replica* + _optional_ -a| [.status]##Couchbase Server 7.6## +a¦ [markdown] -- @@ -6988,7 +7374,6 @@ ifdef::alt-markdown-links[] [queryUseReplica]: #queryUseReplica [use_replica_req]: #use_replica_req - endif::alt-markdown-links[] Specifies whether a query can fetch data from a replica vBucket if active vBuckets are inaccessible. The possible values are: @@ -6999,32 +7384,33 @@ The possible values are: * `unset` — read from replica is enabled or disabled at request level. -The [cluster-level][queryUseReplica] `queryUseReplica` setting specifies the default for this property for the whole cluster. -When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. - -In addition, the [request-level][use_replica_req] `use_replica` parameter specifies this property per request. -If a request does not include this parameter, or if the request-level parameter is `unset`, the node-level setting is used. -If the request-level parameter and the node-level setting are both `unset`, read from replica is disabled for that request. - Do not enable read from replica when you require consistent results. Only SELECT queries that are not within a transaction can read from replica. -Reading from replica is only possible with databases running Couchbase Server 7.6.0 or later. +Reading from replica is only possible if the cluster uses Couchbase Server 7.6.0 or later. Note that KV range scans cannot currently be started on a replica vBucket. If a query uses sequential scan and a data node becomes unavailable, the query might return an error, even if read from replica is enabled for the request. +// tag::desc-more[] +The [cluster-level][queryUseReplica] `queryUseReplica` setting specifies the default for this property for the whole cluster. +When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. + +In addition, the [request-level][use_replica_req] `use_replica` parameter specifies this property per request. +If a request does not include this parameter, or if the request-level parameter is `unset`, the node-level setting is used. +If the request-level parameter and the node-level setting are both `unset`, read from replica is disabled for that request. + [queryUseReplica]: ../n1ql-rest-settings/index.html#queryUseReplica [use_replica_req]: ../n1ql-rest-query/index.html#use_replica_req - +// end::desc-more[] -- [%hardbreaks] *Values:* `"off"`, `"on"`, `"unset"` -*Default:* `pass:c["unset"]` -*Example:* `pass:c["on"]` +*Default:* `+++"unset"+++` +*Example:* `+++"on"+++` {blank} -a| String +a¦ String |=== @@ -7064,14 +7450,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] -- @@ -7080,97 +7466,92 @@ The full prepared statement in encoded format. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *featureControls* + _optional_ -a| +a¦ [markdown] -- This property is provided for technical support only. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - -- [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *indexApiVersion* + _optional_ -a| +a¦ [markdown] -- This property is provided for technical support only. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - -- [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *name* + _required_ -a| +a¦ [markdown] -- The name of the prepared statement. This may be a UUID that was assigned automatically, or a name that was user-specified when the statement was created. - -- [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *namespace* + _optional_ -a| +a¦ [markdown] -- The namespace in which the prepared statement is stored. Currently, only the `default` namespace is available. - -- [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *node* + _optional_ -a| +a¦ [markdown] -- The node on which the prepared statement is stored. - -- [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *statement* + _required_ -a| +a¦ [markdown] -- @@ -7179,13 +7560,13 @@ The text of the query. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *uses* + _required_ -a| +a¦ [markdown] -- @@ -7194,13 +7575,13 @@ The count of times the prepared statement has been executed. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *avgElapsedTime* + _optional_ -a| +a¦ [markdown] -- @@ -7209,18 +7590,17 @@ It includes the time taken by the service to schedule the request. This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - -- [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *avgServiceTime* + _optional_ -a| +a¦ [markdown] -- @@ -7228,36 +7608,34 @@ The mean amount of calendar time taken to complete the execution of the prepared This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - -- [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *lastUse* + _optional_ -a| +a¦ [markdown] -- Date and time of last use. 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] -- @@ -7266,18 +7644,17 @@ It includes the time taken by the service to schedule the request. This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - -- [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *maxServiceTime* + _optional_ -a| +a¦ [markdown] -- @@ -7285,18 +7662,17 @@ The maximum amount of calendar time taken to complete the execution of the prepa This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - -- [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *minElapsedTime* + _optional_ -a| +a¦ [markdown] -- @@ -7305,18 +7681,17 @@ It includes the time taken by the service to schedule the request. This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - -- [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *minServiceTime* + _optional_ -a| +a¦ [markdown] -- @@ -7324,12 +7699,11 @@ The minimum amount of calendar time taken to complete the execution of the prepa This property is only returned when the prepared statement has been executed. It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - -- [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) |=== @@ -7369,14 +7743,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] -- @@ -7385,13 +7759,13 @@ Total number of active requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *at_plus.count* + _optional_ -a| +a¦ [markdown] -- @@ -7400,31 +7774,30 @@ 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] -- The total number of audit records sent to the server. Some requests cause more than one audit record to be emitted. Records in the output queue that have not yet been sent to the server are not counted. - -- [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *audit_actions_failed.count* + _optional_ -a| +a¦ [markdown] -- @@ -7433,13 +7806,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] -- @@ -7448,13 +7821,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] -- @@ -7463,13 +7836,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] -- @@ -7478,13 +7851,13 @@ Total number of cancelled requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *deletes.count* + _optional_ -a| +a¦ [markdown] -- @@ -7493,13 +7866,13 @@ Total number of DELETE operations. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *errors.count* + _optional_ -a| +a¦ [markdown] -- @@ -7508,13 +7881,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] -- @@ -7523,13 +7896,13 @@ Total number of secondary index scans. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *inserts.count* + _optional_ -a| +a¦ [markdown] -- @@ -7538,13 +7911,13 @@ Total number of INSERT operations. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *invalid_requests.count* + _optional_ -a| +a¦ [markdown] -- @@ -7553,13 +7926,13 @@ Total number of requests for unsupported endpoints. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *mutations.count* + _optional_ -a| +a¦ [markdown] -- @@ -7568,13 +7941,13 @@ Total number of document mutations. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *prepared.count* + _optional_ -a| +a¦ [markdown] -- @@ -7583,13 +7956,13 @@ Total number of prepared statements executed. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *primary_scans.count* + _optional_ -a| +a¦ [markdown] -- @@ -7598,13 +7971,13 @@ Total number of primary index scans. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *queued_requests.count* + _optional_ -a| +a¦ [markdown] -- @@ -7613,13 +7986,13 @@ Total number of queued requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request_time.count* + _optional_ -a| +a¦ [markdown] -- @@ -7628,132 +8001,125 @@ 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] -- Number of query requests processed per second. 15-minute exponentially weighted moving average. - -- [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.1m.rate* + _optional_ -a| +a¦ [markdown] -- Number of query requests processed per second. 1-minute exponentially weighted moving average. - -- [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.5m.rate* + _optional_ -a| +a¦ [markdown] -- Number of query requests processed per second. 5-minute exponentially weighted moving average. - -- [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.75%* + _optional_ -a| +a¦ [markdown] -- End-to-end time to process a query (ns). The 75th percentile. - -- [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.95%* + _optional_ -a| +a¦ [markdown] -- End-to-end time to process a query (ns). The 95th percentile. - -- [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.99%* + _optional_ -a| +a¦ [markdown] -- End-to-end time to process a query (ns). The 99th percentile. - -- [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.99.9%* + _optional_ -a| +a¦ [markdown] -- End-to-end time to process a query (ns). The 99.9th percentile. - -- [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.count* + _optional_ -a| +a¦ [markdown] -- @@ -7762,115 +8128,109 @@ Total number of query requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request_timer.max* + _optional_ -a| +a¦ [markdown] -- End-to-end time to process a query (ns). The maximum value. - -- [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request_timer.mean* + _optional_ -a| +a¦ [markdown] -- End-to-end time to process a query (ns). The mean value. - -- [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.mean.rate* + _optional_ -a| +a¦ [markdown] -- Number of query requests processed per second. Mean rate since the query service started. - -- [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.median* + _optional_ -a| +a¦ [markdown] -- End-to-end time to process a query (ns). The median value. - -- [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request_timer.min* + _optional_ -a| +a¦ [markdown] -- End-to-end time to process a query (ns). The minimum value. - -- [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request_timer.stddev* + _optional_ -a| +a¦ [markdown] -- End-to-end time to process a query (ns). The standard deviation. - -- [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *requests.count* + _optional_ -a| +a¦ [markdown] -- @@ -7879,13 +8239,13 @@ Total number of query requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *requests_1000ms.count* + _optional_ -a| +a¦ [markdown] -- @@ -7894,13 +8254,13 @@ Number of queries that take longer than 1000ms. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *requests_250ms.count* + _optional_ -a| +a¦ [markdown] -- @@ -7909,13 +8269,13 @@ Number of queries that take longer than 250ms. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *requests_5000ms.count* + _optional_ -a| +a¦ [markdown] -- @@ -7924,13 +8284,13 @@ Number of queries that take longer than 5000ms. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *requests_500ms.count* + _optional_ -a| +a¦ [markdown] -- @@ -7939,13 +8299,13 @@ Number of queries that take longer than 500ms. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *result_count.count* + _optional_ -a| +a¦ [markdown] -- @@ -7954,13 +8314,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] -- @@ -7969,13 +8329,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] -- @@ -7984,13 +8344,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] -- @@ -7999,13 +8359,13 @@ Total number of SELECT requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *service_time.count* + _optional_ -a| +a¦ [markdown] -- @@ -8014,13 +8374,13 @@ Time to execute all queries (ns). [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *unbounded.count* + _optional_ -a| +a¦ [markdown] -- @@ -8029,13 +8389,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] -- @@ -8044,13 +8404,13 @@ Total number of UPDATE requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *warnings.count* + _optional_ -a| +a¦ [markdown] -- @@ -8059,7 +8419,7 @@ The total number of query warnings returned so far. [%hardbreaks] {blank} -a| Integer +a¦ Integer |=== @@ -8099,14 +8459,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] -- @@ -8115,13 +8475,13 @@ The number of reads and retries for each bucket. [%hardbreaks] {blank} -a| Object +a¦ Object -a| +a¦ *uptime* + _optional_ -a| +a¦ [markdown] -- @@ -8130,13 +8490,13 @@ The uptime of the query engine. [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *local.time* + _optional_ -a| +a¦ [markdown] -- @@ -8145,13 +8505,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] -- @@ -8160,13 +8520,13 @@ The version of the query engine. [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *total.threads* + _optional_ -a| +a¦ [markdown] -- @@ -8175,13 +8535,13 @@ The number of active threads used by the query engine. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *cores* + _optional_ -a| +a¦ [markdown] -- @@ -8190,13 +8550,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] -- @@ -8205,13 +8565,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] -- @@ -8220,13 +8580,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] -- @@ -8235,13 +8595,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] -- @@ -8250,13 +8610,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] -- @@ -8265,13 +8625,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] -- @@ -8280,30 +8640,29 @@ Amount of free memory on the host. [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *host.memory.quota* + _optional_ -a| +a¦ [markdown] -- The host memory quota. This reflects the node-quota setting. - -- [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *host.memory.total* + _optional_ -a| +a¦ [markdown] -- @@ -8312,13 +8671,13 @@ Total memory on the host. [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *host.memory.value_quota* + _optional_ -a| +a¦ [markdown] -- @@ -8327,13 +8686,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] -- @@ -8342,13 +8701,13 @@ A calculation for how busy the server is. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *loadfactor* + _optional_ -a| +a¦ [markdown] -- @@ -8357,64 +8716,61 @@ The moving 15 minute average of the load calculation. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *memory.usage* + _optional_ -a| +a¦ [markdown] -- The amount of memory allocated for heap objects (bytes). 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] -- The cumulative amount of memory allocated for heap objects (bytes). This increases as heap objects are allocated, but does not decrease when objects are freed. - -- [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *memory.system* + _optional_ -a| +a¦ [markdown] -- The total amount of memory obtained from the operating system (bytes). This measures the virtual address space reserved by the query engine for heaps, stacks, and other internal data structures. - -- [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *node* + _optional_ -a| +a¦ [markdown] -- @@ -8423,30 +8779,29 @@ 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] -- The total number of values allocated to contain documents or computations around documents. (This is only of relevance internally.) - -- [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *node.memory.usage* + _optional_ -a| +a¦ [markdown] -- @@ -8455,47 +8810,45 @@ The currently allocated document memory on the node. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *cpu.user.percent* + _optional_ -a| +a¦ [markdown] -- CPU usage. The percentage of time spent executing user code since the last time the statistics were checked. - -- [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *cpu.sys.percent* + _optional_ -a| +a¦ [markdown] -- CPU usage. The percentage of time spent executing system code since the last time the statistics were checked. - -- [%hardbreaks] {blank} -a| Long (int64) +a¦ Long (int64) -a| +a¦ *process.memory.usage* + _optional_ -a| +a¦ [markdown] -- @@ -8504,13 +8857,13 @@ Current process memory use. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *process.percore.cpupercent* + _optional_ -a| +a¦ [markdown] -- @@ -8519,13 +8872,13 @@ Average CPU usage per core. [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *process.rss* + _optional_ -a| +a¦ [markdown] -- @@ -8534,13 +8887,13 @@ Process RSS (bytes) [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *process.service.usage* + _optional_ -a| +a¦ [markdown] -- @@ -8549,13 +8902,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] -- @@ -8564,13 +8917,13 @@ Total number of completed requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request.active.count* + _optional_ -a| +a¦ [markdown] -- @@ -8579,64 +8932,61 @@ Total number of active requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request.per.sec.1min* + _optional_ -a| +a¦ [markdown] -- Number of query requests processed per second. 1-minute exponentially weighted moving average. - -- [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request.per.sec.5min* + _optional_ -a| +a¦ [markdown] -- Number of query requests processed per second. 5-minute exponentially weighted moving average. - -- [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request.per.sec.15min* + _optional_ -a| +a¦ [markdown] -- Number of query requests processed per second. 15-minute exponentially weighted moving average. - -- [%hardbreaks] {blank} -a| Big Decimal +a¦ Big Decimal -a| +a¦ *request.queued.count* + _optional_ -a| +a¦ [markdown] -- @@ -8645,13 +8995,13 @@ Number of queued requests. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request.quota.used.hwm* + _optional_ -a| +a¦ [markdown] -- @@ -8660,98 +9010,93 @@ High water mark for request quota use. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *request_time.mean* + _optional_ -a| +a¦ [markdown] -- End-to-end time to process a query. The mean value. - -- [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *request_time.median* + _optional_ -a| +a¦ [markdown] -- End-to-end time to process a query. The median value. - -- [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *request_time.80percentile* + _optional_ -a| +a¦ [markdown] -- End-to-end time to process a query. The 80th percentile. - -- [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *request_time.95percentile* + _optional_ -a| +a¦ [markdown] -- End-to-end time to process a query. The 95th percentile. - -- [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *request_time.99percentile* + _optional_ -a| +a¦ [markdown] -- End-to-end time to process a query. The 99th percentile. - -- [%hardbreaks] {blank} -a| String (duration) +a¦ String (duration) -a| +a¦ *request.prepared.percent* + _optional_ -a| +a¦ [markdown] -- @@ -8760,75 +9105,71 @@ Percentage of requests that are prepared statements. [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *servicers.paused.count* + _optional_ -a| +a¦ [markdown] -- Number of servicers temporarily paused due to memory pressure. (Applies to serverless environments only.) - -- [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *servicers.paused.total* + _optional_ -a| +a¦ [markdown] -- Number of times servicers have been temporarily paused. (Applies to serverless environments only.) - -- [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *temp.hwm* + _optional_ -a| +a¦ [markdown] -- High water mark for temp space use directly by query. -(Doesn't include use by the GSI and FTS clients.) - +(Doesn't include use by the GSI and Search clients.) -- [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *temp.usage* + _optional_ -a| +a¦ [markdown] -- Current Query temp space use. -(Doesn't include use by the GSI and FTS clients.) - +(Doesn't include use by the GSI and Search clients.) -- [%hardbreaks] {blank} -a| Integer +a¦ Integer |=== @@ -8885,7 +9226,6 @@ a| Integer -- The Admin API supports admin credentials. Credentials can be passed via HTTP headers (HTTP basic authentication). - -- [%hardbreaks] @@ -8910,3 +9250,4 @@ include::{specDir}security/document-end.adoc[opts=optional] include::{specDir}security/document-after.adoc[opts=optional] + diff --git a/src/functions/functions.gradle b/docs/modules/n1ql-rest-functions/functions.gradle similarity index 82% rename from src/functions/functions.gradle rename to docs/modules/n1ql-rest-functions/functions.gradle index 29ed41c8..a29e5999 100644 --- a/src/functions/functions.gradle +++ b/docs/modules/n1ql-rest-functions/functions.gradle @@ -2,10 +2,10 @@ apply plugin: 'org.openapi.generator' openApiGenerate { generatorName = "asciidoc" - inputSpec = file("swagger/functions.yaml").getAbsolutePath().toString() + remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/morpheus/docs/spec/functions/functions.yaml" outputDir = "${rootDir}/docs/modules/n1ql-rest-functions/pages" templateDir = "${rootDir}/templates" - gitRepoId = "cb-swagger" + gitRepoId = "query" gitUserId = "couchbase" additionalProperties = [ specDir: "${rootDir}/docs/modules/n1ql-rest-functions/partials/", diff --git a/docs/modules/n1ql-rest-functions/pages/index.adoc b/docs/modules/n1ql-rest-functions/pages/index.adoc index 7e953a7d..e8d305e3 100644 --- a/docs/modules/n1ql-rest-functions/pages/index.adoc +++ b/docs/modules/n1ql-rest-functions/pages/index.adoc @@ -8,7 +8,7 @@ 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 +DO NOT EDIT! See https://github.com/couchbase/query :leveloffset: 1 @@ -32,7 +32,7 @@ This API enables you to manage the JavaScript libraries and objects that are use [discrete#version] = Version information [%hardbreaks] -__Version__ : capella +__Version__ : 8.0 [discrete#host] = Host information @@ -58,29 +58,29 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* a| [markdown] -- -The host name or IP address of a node running the Query service. +The host name or IP address of a node running the Query Service. -- [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* a| [markdown] -- -The Query service REST port. Use `18093` for secure access. +The Query Service REST port. Use `18093` for secure access. -- [%hardbreaks] *Values:* `8093`, `18093` -*Example:* `pass:c[8093]` +*Example:* `+++8093+++` // end |=== @@ -113,7 +113,7 @@ ifeval::[{count-apis} > 1] The operations are grouped in the following categories. [%hardbreaks] -<> +xref:tag-Default[] endif::[] @@ -131,12 +131,14 @@ endif::[] endif::[] [%hardbreaks] -<> -<> -<> -<> +xref:delete_library[] +xref:get_collection[] +xref:get_library[] +xref:post_library[] +//tag::delete_library[] + // markup not found, no include::{specDir}paths/delete_library/operation-before.adoc[opts=optional] @@ -172,12 +174,14 @@ Deletes the specified library entirely. By default, this operation deletes a global library. For a scoped library, you must specify the bucket and scope. - -- include::{specDir}paths/delete_library/operation-description-end.adoc[opts=optional] + + + :leveloffset: -1 @@ -200,13 +204,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 +221,7 @@ The name of a library. [%hardbreaks] {blank} -a| String +a¦ String @@ -227,43 +231,43 @@ 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] -- -For scoped libraries only. The bucket in which the library is stored. - +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] -- -For scoped libraries only. The scope in which the library is stored. - +For scoped libraries only. +The scope in which the library is stored. -- [%hardbreaks] {blank} -a| String +a¦ String @@ -284,8 +288,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] @@ -310,13 +312,13 @@ a| | 400 a| [markdown] -- -Bad request. The path may not conform to the schema. +Bad request. The path may not conform to the schema. -- a| | 404 a| [markdown] -- -Not found. The library name in the path may be incorrect, or the bucket and scope may be specified incorrectly. +Not found. The library name in the path may be incorrect, or the bucket and scope may be specified incorrectly. -- a| @@ -349,9 +351,9 @@ a| | Type | Name | http (basic) -| <> +| xref:security-scope[] | http (basic) -| <> +| xref:security-global[] |=== @@ -380,6 +382,10 @@ include::{snippetDir}delete_library/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/delete_library/operation-after.adoc[opts=optional] +//end::delete_library[] + + +//tag::get_collection[] // markup not found, no include::{specDir}paths/get_collection/operation-before.adoc[opts=optional] @@ -414,13 +420,20 @@ GET /evaluator/v1/libraries -- Returns all libraries and functions. -By default, this operation returns all global libraries and functions, and all scoped libraries and functions. To return all the libraries and functions in a single scope, specify a bucket and scope. +By default, this operation returns all global libraries and functions, and all scoped libraries and functions. +To return all the libraries and functions in a single scope, specify a bucket and scope. -- // markup not found, no include::{specDir}paths/get_collection/operation-description-end.adoc[opts=optional] + + +[#get_collection-produces] +.Produces +* application/json + :leveloffset: -1 @@ -444,43 +457,43 @@ 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] -- -For scoped libraries only. The bucket from which to fetch libraries. - +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] -- -For scoped libraries only. The scope from which to fetch libraries. - +For scoped libraries only. +The scope from which to fetch libraries. -- [%hardbreaks] {blank} -a| String +a¦ String @@ -500,12 +513,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] @@ -527,13 +534,13 @@ a| [markdown] -- An array of objects, each giving information about a single library. -- -a| <> +a| xref:Libraries[] array | 400 a| [markdown] -- -Bad request. The path may not conform to the schema. +Bad request. The path may not conform to the schema. -- a| @@ -566,9 +573,9 @@ a| | Type | Name | http (basic) -| <> +| xref:security-scope[] | http (basic) -| <> +| xref:security-global[] |=== @@ -597,6 +604,10 @@ include::{snippetDir}get_collection/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_collection/operation-after.adoc[opts=optional] +//end::get_collection[] + + +//tag::get_library[] // markup not found, no include::{specDir}paths/get_library/operation-before.adoc[opts=optional] @@ -631,13 +642,20 @@ GET /evaluator/v1/libraries/{library} -- Returns a library with all its functions. -By default, this operation returns a global library. For a scoped library, you must specify the bucket and scope. +By default, this operation returns a global library. +For a scoped library, you must specify the bucket and scope. -- // markup not found, no include::{specDir}paths/get_library/operation-description-end.adoc[opts=optional] + + +[#get_library-produces] +.Produces +* application/json + :leveloffset: -1 @@ -660,13 +678,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 +695,7 @@ The name of a library. [%hardbreaks] {blank} -a| String +a¦ String @@ -687,43 +705,43 @@ 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] -- -For scoped libraries only. The bucket in which the library is stored. - +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] -- -For scoped libraries only. The scope in which the library is stored. - +For scoped libraries only. +The scope in which the library is stored. -- [%hardbreaks] {blank} -a| String +a¦ String @@ -743,12 +761,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] @@ -770,19 +782,19 @@ a| [markdown] -- An object with a single property, giving information about the specified library. -- -a| <> +a| xref:Functions[] | 400 a| [markdown] -- -Bad request. The path may not conform to the schema. +Bad request. The path may not conform to the schema. -- a| | 404 a| [markdown] -- -Not found. The library name in the path may be incorrect, or the bucket and scope may be specified incorrectly. +Not found. The library name in the path may be incorrect, or the bucket and scope may be specified incorrectly. -- a| @@ -815,9 +827,9 @@ a| | Type | Name | http (basic) -| <> +| xref:security-scope[] | http (basic) -| <> +| xref:security-global[] |=== @@ -846,6 +858,10 @@ include::{snippetDir}get_library/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_library/operation-after.adoc[opts=optional] +//end::get_library[] + + +//tag::post_library[] // markup not found, no include::{specDir}paths/post_library/operation-before.adoc[opts=optional] @@ -878,15 +894,23 @@ POST /evaluator/v1/libraries/{library} [markdown] -- -Creates the specified library and its associated functions. If the specified library exists, the existing library is overwritten. +Creates the specified library and its associated functions. +If the specified library exists, the existing library is overwritten. -By default, this operation creates or updates a global library. For a scoped library, you must specify the bucket and scope. +By default, this operation creates or updates a global library. +For a scoped library, you must specify the bucket and scope. -- include::{specDir}paths/post_library/operation-description-end.adoc[opts=optional] + +[#post_library-consumes] +.Consumes +* application/json + + :leveloffset: -1 @@ -909,13 +933,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 +950,7 @@ The name of a library. [%hardbreaks] {blank} -a| String +a¦ String @@ -936,43 +960,43 @@ 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] -- -For scoped libraries only. The bucket in which the library is stored. - +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] -- -For scoped libraries only. The scope in which the library is stored. - +For scoped libraries only. +The scope in which the library is stored. -- [%hardbreaks] {blank} -a| String +a¦ String @@ -984,13 +1008,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 +1025,7 @@ The JavaScript code for all functions in the library. [%hardbreaks] {blank} -a| String +a¦ String @@ -1019,12 +1043,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] @@ -1049,13 +1067,13 @@ a| | 400 a| [markdown] -- -Bad request. The body of the request may be incorrect, or the path may not conform to the schema. +Bad request. The body of the request may be incorrect, or the path may not conform to the schema. -- a| | 404 a| [markdown] -- -Not found. The library name in the path may be incorrect, or the bucket and scope may be specified incorrectly. +Not found. The library name in the path may be incorrect, or the bucket and scope may be specified incorrectly. -- a| @@ -1088,9 +1106,9 @@ a| | Type | Name | http (basic) -| <> +| xref:security-scope[] | http (basic) -| <> +| xref:security-global[] |=== @@ -1119,6 +1137,8 @@ include::{snippetDir}post_library/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/post_library/operation-after.adoc[opts=optional] +//end::post_library[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -1155,8 +1175,8 @@ ifdef::collapse-models[] [.two-columns] endif::collapse-models[] [%hardbreaks] -<> -<> +xref:Functions[] +xref:Libraries[] endif::[] @@ -1181,27 +1201,27 @@ 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] -- The JavaScript code for all functions in the library. 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 +1261,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,60 +1276,59 @@ The name of a library. -- [%hardbreaks] -*Example:* `pass:c["math"]` +*Example:* `+++"math"+++` {blank} -a| String +a¦ String -a| +a¦ *bucket* + _required_ -a| +a¦ [markdown] -- -For scoped libraries, the bucket in which the library is stored. For global libraries, this string is empty. - +For scoped libraries, the bucket in which the library is stored. +For global libraries, this string is empty. -- [%hardbreaks] -*Example:* `pass:c["travel-sample"]` +*Example:* `+++"travel-sample"+++` {blank} -a| String +a¦ String -a| +a¦ *scope* + _required_ -a| +a¦ [markdown] -- -For scoped libraries, the scope in which the library is stored. For global libraries, this string is empty. - +For scoped libraries, the scope in which the library is stored. +For global libraries, this string is empty. -- [%hardbreaks] -*Example:* `pass:c["inventory"]` +*Example:* `+++"inventory"+++` {blank} -a| String +a¦ String -a| +a¦ *code* + _required_ -a| +a¦ [markdown] -- 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 |=== @@ -1367,7 +1386,6 @@ include::{specDir}security/document-begin.adoc[opts=optional] To manage global libraries, users must have the *Manage Global External Functions* RBAC role. This role enables you to create, read, update, or delete any global library, but does not give you access to any scoped libraries. - -- [%hardbreaks] @@ -1401,7 +1419,6 @@ To manage scoped libraries, users must have the *Manage Scope External Functions This role enables you to create, read, update, or delete any library in the scope to which you have access, but does not give you access to any other scoped libraries. In addition, this role enables you to read any global library, but not to create, update, or delete them. - -- [%hardbreaks] @@ -1426,3 +1443,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-functions/partials/security/document-begin.adoc b/docs/modules/n1ql-rest-functions/partials/security/document-begin.adoc index ac6095d8..fca442a4 100644 --- a/docs/modules/n1ql-rest-functions/partials/security/document-begin.adoc +++ b/docs/modules/n1ql-rest-functions/partials/security/document-begin.adoc @@ -1,2 +1,2 @@ The Functions API supports admin credentials. -Credentials can be passed via HTTP headers (HTTP basic authentication). \ No newline at end of file +Pass your credentials through HTTP headers (HTTP basic authentication). \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/attachments/_overlay.json b/docs/modules/n1ql-rest-query/attachments/_overlay.json new file mode 100644 index 00000000..ea4b7092 --- /dev/null +++ b/docs/modules/n1ql-rest-query/attachments/_overlay.json @@ -0,0 +1,31 @@ +{ + "overlay": "1.0.0", + "info": { + "title": "Overlay for Query Service Schema", + "version": 1.0 + }, + "actions": [ + { + "description": "Update `creds` parameter for Query operations", + "target": "components.schemas.Request.properties", + "update": { + "creds": { + "x-desc-name": "creds", + "description": "In the Data API, this parameter is ignored and has no effect.\n\nIn the cbq shell, this parameter specifies credentials within a session.\nFor more information, see [Switch Between Credentials](../n1ql-intro/cbq.html#cbq-multiple-creds)." + } + } + }, + { + "description": "Remove `Credentials` schema", + "target": "components.schemas.Credentials", + "remove": true + }, + { + "description": "Remove badge from `use_fts` parameter", + "target": "components.schemas.Request.properties.use_fts", + "update": { + "x-desc-edition": false + } + } + ] +} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/exformdata.sh b/docs/modules/n1ql-rest-query/examples/exformdata.sh new file mode 100644 index 00000000..d850e646 --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/exformdata.sh @@ -0,0 +1,3 @@ +curl -v $BASEURL/_p/query/query/service \ + -d 'statement=SELECT name FROM `travel-sample`.inventory.hotel LIMIT 1' \ + -u $USER:$PASSWORD \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/exn1qlerror.json b/docs/modules/n1ql-rest-query/examples/exn1qlerror.json new file mode 100644 index 00000000..fe4d4b6e --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/exn1qlerror.json @@ -0,0 +1,18 @@ +{ + "requestID": "27087759-07af-431d-a3d7-29080f870e56", + "errors": [ + { + "code": 3000, + "msg": "syntax error - line 1, column 7, near 'SLECT', at: name" + } + ], + "status": "fatal", + "metrics": { + "elapsedTime": "1.478631ms", + "executionTime": "1.393274ms", + "resultCount": 0, + "resultSize": 0, + "serviceLoad": 12, + "errorCount": 1 + } +} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/exnamed.json b/docs/modules/n1ql-rest-query/examples/exnamed.json new file mode 100644 index 00000000..0389aef5 --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/exnamed.json @@ -0,0 +1,25 @@ +{ + "requestID": "81aceab8-7f7a-4d00-b741-00385740329a", + "signature": { + "airline": "json" + }, + "results": [ + { + "airline": "B6" + }, + { + "airline": "EK" + }, + { + "airline": "SV" + } + ], + "status": "success", + "metrics": { + "elapsedTime": "72.886709ms", + "executionTime": "72.765333ms", + "resultCount": 3, + "resultSize": 48, + "serviceLoad": 12 + } +} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/exnamed.sh b/docs/modules/n1ql-rest-query/examples/exnamed.sh new file mode 100644 index 00000000..35527eb3 --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/exnamed.sh @@ -0,0 +1,5 @@ +curl -v $BASEURL/_p/query/query/service \ + -d 'statement=SELECT airline FROM `travel-sample`.inventory.route + WHERE sourceairport = $aval AND distance > $dval + & $aval="LAX" & $dval=13000' \ + -u $USER:$PASSWORD \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/exnotfound.json b/docs/modules/n1ql-rest-query/examples/exnotfound.json new file mode 100644 index 00000000..882dd6f3 --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/exnotfound.json @@ -0,0 +1,18 @@ +{ + "requestID": "d30b805f-6c1e-44ec-9aec-35ff711a6e88", + "errors": [ + { + "code": 12003, + "msg": "Keyspace not found in CB datastore: default:travel-sample.inventory.motel" + } + ], + "status": "fatal", + "metrics": { + "elapsedTime": "3.096786ms", + "executionTime": "2.468282ms", + "resultCount": 0, + "resultSize": 0, + "serviceLoad": 12, + "errorCount": 1 + } +} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/exnumbered.json b/docs/modules/n1ql-rest-query/examples/exnumbered.json new file mode 100644 index 00000000..3cb9994e --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/exnumbered.json @@ -0,0 +1,25 @@ +{ + "requestID": "6e242629-ebf5-4a58-8db4-62d94974519f", + "signature": { + "airline": "json" + }, + "results": [ + { + "airline": "B6" + }, + { + "airline": "EK" + }, + { + "airline": "SV" + } + ], + "status": "success", + "metrics": { + "elapsedTime": "86.962678ms", + "executionTime": "84.35715ms", + "resultCount": 3, + "resultSize": 48, + "serviceLoad": 12 + } +} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/exnumbered.sh b/docs/modules/n1ql-rest-query/examples/exnumbered.sh new file mode 100644 index 00000000..c9888c99 --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/exnumbered.sh @@ -0,0 +1,5 @@ +curl -v $BASEURL/_p/query/query/service \ + -d 'statement=SELECT airline FROM `travel-sample`.inventory.route + WHERE sourceairport = $1 AND distance > $2 + & args=["LAX", 13000]' \ + -u $USER:$PASSWORD \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/expositional.json b/docs/modules/n1ql-rest-query/examples/expositional.json new file mode 100644 index 00000000..fc48bf3d --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/expositional.json @@ -0,0 +1,25 @@ +{ + "requestID": "6d77dc41-3cab-4e00-9c54-f60fcc2e0fab", + "signature": { + "airline": "json" + }, + "results": [ + { + "airline": "B6" + }, + { + "airline": "EK" + }, + { + "airline": "SV" + } + ], + "status": "success", + "metrics": { + "elapsedTime": "86.226474ms", + "executionTime": "86.072996ms", + "resultCount": 3, + "resultSize": 48, + "serviceLoad": 12 + } +} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/expositional.sh b/docs/modules/n1ql-rest-query/examples/expositional.sh new file mode 100644 index 00000000..4c73f573 --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/expositional.sh @@ -0,0 +1,5 @@ +curl -v $BASEURL/_p/query/query/service \ + -d 'statement=SELECT airline FROM `travel-sample`.inventory.route + WHERE sourceairport = ? AND distance > ? + & args=["LAX", 13000]' \ + -u $USER:$PASSWORD \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/exreadonly.sh b/docs/modules/n1ql-rest-query/examples/exreadonly.sh new file mode 100644 index 00000000..445658bf --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/exreadonly.sh @@ -0,0 +1,2 @@ +curl -v $BASEURL/_p/query/query/service?statement=SELECT%20name%20FROM%20%60travel-sample%60.inventory.hotel%20LIMIT%201%3B \ + -u $USER:$PASSWORD \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/exrequesterror.json b/docs/modules/n1ql-rest-query/examples/exrequesterror.json new file mode 100644 index 00000000..86072621 --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/exrequesterror.json @@ -0,0 +1,18 @@ +{ + "requestID": "424c0a6d-b851-4feb-892c-0d9a106f2e13", + "errors": [ + { + "code": 1050, + "msg": "No statement or prepared value" + } + ], + "status": "fatal", + "metrics": { + "elapsedTime": "1.124637ms", + "executionTime": "1.094663ms", + "resultCount": 0, + "resultSize": 0, + "serviceLoad": 0, + "errorCount": 1 + } +} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/exserviceerror.json b/docs/modules/n1ql-rest-query/examples/exserviceerror.json new file mode 100644 index 00000000..3048677a --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/exserviceerror.json @@ -0,0 +1,19 @@ +{ + "requestID": "5c0a6a81-2fc8-4a33-a035-ed7fb1512710", + "errors": [ + { + "code": "", + "msg": "Request queue full" + } + ], + "status": "errors", + "metrics": { + "elapsedTime": "134.7944us", + "executionTime": "130.5518us", + "resultCount": 0, + "resultSize": 0, + "mutationCount": 0, + "errorCount": 1, + "warningCount": 0 + } +} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/exsuccessful.json b/docs/modules/n1ql-rest-query/examples/exsuccessful.json new file mode 100644 index 00000000..d48a72aa --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/exsuccessful.json @@ -0,0 +1,19 @@ +{ + "requestID": "615e0b26-dd61-4a1a-bda9-22333193b982", + "signature": { + "name": "json" + }, + "results": [ + { + "name": "Medway Youth Hostel" + } + ], + "status": "success", + "metrics": { + "elapsedTime": "5.232754ms", + "executionTime": "5.160022ms", + "resultCount": 1, + "resultSize": 30, + "serviceLoad": 12 + } +} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/exsuccessful.sh b/docs/modules/n1ql-rest-query/examples/exsuccessful.sh new file mode 100644 index 00000000..35fc5cd1 --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/exsuccessful.sh @@ -0,0 +1,4 @@ +curl -v $BASEURL/_p/query/query/service \ + -H 'Content-Type: application/json' \ + -d '{ "statement": "SELECT name FROM `travel-sample`.inventory.hotel LIMIT 1;" }' \ + -u $USER:$PASSWORD \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/exwildcard.json b/docs/modules/n1ql-rest-query/examples/exwildcard.json new file mode 100644 index 00000000..49f72659 --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/exwildcard.json @@ -0,0 +1,22 @@ +{ + "requestID": "716f5e7b-557a-44a6-a372-9a98611c5b5e", + "signature": { + "id": "json" + }, + "results": [ + { + "id": "hotel_10025" + }, + { + "id": "hotel_10026" + } + ], + "status": "success", + "metrics": { + "elapsedTime": "64.11756ms", + "executionTime": "63.993854ms", + "resultCount": 2, + "resultSize": 40, + "serviceLoad": 12 + } +} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/examples/exwildcard.sh b/docs/modules/n1ql-rest-query/examples/exwildcard.sh new file mode 100644 index 00000000..669c1f0c --- /dev/null +++ b/docs/modules/n1ql-rest-query/examples/exwildcard.sh @@ -0,0 +1,6 @@ +curl -v $BASEURL/_p/query/query/service \ + -u $USER:$PASSWORD \ + -d 'statement=SELECT meta().id + FROM `travel-sample`.inventory.hotel + WHERE meta().id LIKE $pattern + & $pattern="hotel_1002%25"' \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/pages/index.adoc b/docs/modules/n1ql-rest-query/pages/index.adoc index 5cf73b93..8ba0703b 100644 --- a/docs/modules/n1ql-rest-query/pages/index.adoc +++ b/docs/modules/n1ql-rest-query/pages/index.adoc @@ -8,7 +8,7 @@ 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 +DO NOT EDIT! See https://github.com/couchbase/query :leveloffset: 1 @@ -27,13 +27,12 @@ include::{specDir}overview/document-before.adoc[opts=optional] -- The Query Service REST API is provided by the Query service. This API enables you to run SQL++ queries and set request-level parameters. - -- [discrete#version] = Version information [%hardbreaks] -__Version__ : capella +__Version__ : 8.0 [discrete#host] = Host information @@ -59,29 +58,29 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* a| [markdown] -- -The host name or IP address of a node running the Query service. +The host name or IP address of a node running the Query Service. -- [%hardbreaks] -*Example:* `pass:c[localhost]` +*Example:* `+++localhost+++` // end a| *port* a| [markdown] -- -The Query service REST port. Use `18093` for secure access. +The Query Service REST port. Use `18093` for secure access. -- [%hardbreaks] *Values:* `8093`, `18093` -*Example:* `pass:c[8093]` +*Example:* `+++8093+++` // end |=== @@ -114,7 +113,7 @@ ifeval::[{count-apis} > 1] The operations are grouped in the following categories. [%hardbreaks] -<> +xref:tag-Default[] endif::[] @@ -132,9 +131,11 @@ endif::[] endif::[] [%hardbreaks] -<> -<> +xref:get_service[] +xref:post_service[] + +//tag::get_service[] // markup not found, no include::{specDir}paths/get_service/operation-before.adoc[opts=optional] @@ -167,15 +168,21 @@ GET /query/service [markdown] -- -Enables you to execute a SQL++ statement. This method allows you to run queries and modifying statements, and specify query parameters. It does not allow you to run modifying statements. +Enables you to execute a SQL++ statement. +This method allows you to run SELECT queries, and specify query parameters. This endpoint is intended for situations where use of the `POST` method is restricted. - -- // markup not found, no include::{specDir}paths/get_service/operation-description-end.adoc[opts=optional] + + +[#get_service-produces] +.Produces +* application/json + :leveloffset: -1 @@ -199,13 +206,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 +224,7 @@ The format for URL-encoded parameters is consistent with the syntax for variable [%hardbreaks] {blank} -a| <> +a¦ xref:Request[] @@ -237,12 +244,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] @@ -264,69 +265,75 @@ a| [markdown] -- The operation was successful. -- -a| <> +a| xref:Response[] | 400 a| [markdown] -- -Bad Request. The request cannot be processed for one of the following reasons: the statement contains a SQL++ syntax error; the request has a missing or unrecognized HTTP parameter; the request is badly formatted — for example, the request body contains a JSON syntax error. +Bad Request. The request cannot be processed for one of the following reasons: the statement contains a SQL++ syntax error; the request has a missing or unrecognized HTTP parameter; the request is badly formatted — for example, the request body contains a JSON syntax error. -- -a| +a| xref:Response[] + + | 401 a| [markdown] -- -Unauthorized. The credentials provided with the request are missing or invalid. +Unauthorized. The credentials provided with the request are missing or invalid. -- a| | 403 a| [markdown] -- -Forbidden. There is a read-only violation. Either there was an attempt to create or update in a GET request or a POST request where `readonly` is set, or the client does not have the authorization to modify an object (index, keyspace or namespace) in the statement. +Forbidden. There is a read-only violation. Either there was an attempt to create or update in a GET request or a POST request where `readonly` is set, or the client does not have the authorization to modify an object (index, keyspace or namespace) in the statement. -- a| | 404 a| [markdown] -- -Not found. The statement in the request references an invalid namespace or keyspace. +Not found. The statement in the request references an invalid namespace or keyspace. -- -a| +a| xref:Response[] + + | 405 a| [markdown] -- -Method not allowed. The statement in the request references an invalid namespace or keyspace. +Method not allowed. The statement in the request references an invalid namespace or keyspace. -- a| | 409 a| [markdown] -- -Conflict. There is an attempt to create an object (keyspace or index) that already exists. +Conflict. There is an attempt to create an object (keyspace or index) that already exists. -- a| | 410 a| [markdown] -- -Gone. The server is shutting down gracefully. Previously made requests are being completed, but no new requests are being accepted. +Gone. The server is shutting down gracefully. Previously made requests are being completed, but no new requests are being accepted. -- a| | 413 a| [markdown] -- -Payload too large. The query is too large for the Query Service to process. +Payload too large. The query is too large for the Query Service to process. -- a| | 500 a| [markdown] -- -Internal server error. There was an unforeseen problem processing the request. +Internal server error. There was an unforeseen problem processing the request. -- a| | 503 a| [markdown] -- -Service unavailable. There is an issue (that is possibly temporary) preventing the request being processed; the request queue is full or the data store is not accessible. +Service unavailable. There is an issue (that is possibly temporary) preventing the request being processed; the request queue is full or the data store is not accessible. -- -a| +a| xref:Response[] + + |=== @@ -357,7 +364,9 @@ a| | Type | Name | http (basic) -| <> +| xref:security-header[] +| apiKey +| xref:security-parameter[] |=== @@ -386,6 +395,10 @@ include::{snippetDir}get_service/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_service/operation-after.adoc[opts=optional] +//end::get_service[] + + +//tag::post_service[] // markup not found, no include::{specDir}paths/post_service/operation-before.adoc[opts=optional] @@ -418,13 +431,23 @@ POST /query/service [markdown] -- -Enables you to execute a SQL++ statement. This method allows you to run queries and modifying statements, and specify query parameters. - +Enables you to execute a SQL++ statement. +This method allows you to run SELECT queries and other DML statements, and specify query parameters. -- // markup not found, no include::{specDir}paths/post_service/operation-description-end.adoc[opts=optional] + +[#post_service-consumes] +.Consumes +* application/json +* application/x-www-form-urlencoded + +[#post_service-produces] +.Produces +* application/json + :leveloffset: -1 @@ -451,13 +474,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] @@ -468,7 +491,7 @@ An object specifying one or more query parameters. [%hardbreaks] {blank} -a| <> +a¦ xref:Request[] @@ -485,17 +508,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] @@ -517,69 +529,75 @@ a| [markdown] -- The operation was successful. -- -a| <> +a| xref:Response[] | 400 a| [markdown] -- -Bad Request. The request cannot be processed for one of the following reasons: the statement contains a SQL++ syntax error; the request has a missing or unrecognized HTTP parameter; the request is badly formatted — for example, the request body contains a JSON syntax error. +Bad Request. The request cannot be processed for one of the following reasons: the statement contains a SQL++ syntax error; the request has a missing or unrecognized HTTP parameter; the request is badly formatted — for example, the request body contains a JSON syntax error. -- -a| +a| xref:Response[] + + | 401 a| [markdown] -- -Unauthorized. The credentials provided with the request are missing or invalid. +Unauthorized. The credentials provided with the request are missing or invalid. -- a| | 403 a| [markdown] -- -Forbidden. There is a read-only violation. Either there was an attempt to create or update in a GET request or a POST request where `readonly` is set, or the client does not have the authorization to modify an object (index, keyspace or namespace) in the statement. +Forbidden. There is a read-only violation. Either there was an attempt to create or update in a GET request or a POST request where `readonly` is set, or the client does not have the authorization to modify an object (index, keyspace or namespace) in the statement. -- a| | 404 a| [markdown] -- -Not found. The statement in the request references an invalid namespace or keyspace. +Not found. The statement in the request references an invalid namespace or keyspace. -- -a| +a| xref:Response[] + + | 405 a| [markdown] -- -Method not allowed. The statement in the request references an invalid namespace or keyspace. +Method not allowed. The statement in the request references an invalid namespace or keyspace. -- a| | 409 a| [markdown] -- -Conflict. There is an attempt to create an object (keyspace or index) that already exists. +Conflict. There is an attempt to create an object (keyspace or index) that already exists. -- a| | 410 a| [markdown] -- -Gone. The server is shutting down gracefully. Previously made requests are being completed, but no new requests are being accepted. +Gone. The server is shutting down gracefully. Previously made requests are being completed, but no new requests are being accepted. -- a| | 413 a| [markdown] -- -Payload too large. The query is too large for the Query Service to process. +Payload too large. The query is too large for the Query Service to process. -- a| | 500 a| [markdown] -- -Internal server error. There was an unforeseen problem processing the request. +Internal server error. There was an unforeseen problem processing the request. -- a| | 503 a| [markdown] -- -Service unavailable. There is an issue (that is possibly temporary) preventing the request being processed; the request queue is full or the data store is not accessible. +Service unavailable. There is an issue (that is possibly temporary) preventing the request being processed; the request queue is full or the data store is not accessible. -- -a| +a| xref:Response[] + + |=== @@ -610,7 +628,9 @@ a| | Type | Name | http (basic) -| <> +| xref:security-header[] +| apiKey +| xref:security-parameter[] |=== @@ -639,6 +659,8 @@ include::{snippetDir}post_service/http-request.adoc[opts=optional] // markup not found, no include::{specDir}paths/post_service/operation-after.adoc[opts=optional] +//end::post_service[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -675,14 +697,14 @@ ifdef::collapse-models[] [.two-columns] endif::collapse-models[] [%hardbreaks] -<> -<> -<> -<> -<> -<> -<> -<> +xref:Conditions[] +xref:Controls[] +xref:Execution_Timings[] +xref:Metrics[] +xref:Profile[] +xref:Request[] +xref:Response[] +xref:Statistics[] endif::[] @@ -712,63 +734,67 @@ 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] -- -A unique number that identifies the error or warning. The code ranges are partitioned by component. The codes can also include parts that indicate severity and transience. This property is always present in every condition returned in the Query REST API or captured in a log. - +A unique number that identifies the error or warning. +The code ranges are partitioned by component. +The codes can also include parts that indicate severity and transience. +This property is always present in every condition returned in the Query REST API or captured in a log. -- [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *msg* + _required_ -a| +a¦ [markdown] -- -A message describing the error or warning in detail. This property is always present in every condition returned in the Query REST API or captured in a log. - +A message describing the error or warning in detail. +This property is always present in every condition returned in the Query REST API or captured in a log. -- [%hardbreaks] {blank} -a| String +a¦ String -a| +a¦ *name* + _optional_ -a| +a¦ [markdown] -- -Unique name that has a 1:1 mapping to the code. Uniquely identifies the condition. This property is helpful for pattern matching and can have meaning, making it more memorable than the code. The name should be fully qualified. - +Unique name that has a 1:1 mapping to the code. +Uniquely identifies the condition. +This property is helpful for pattern matching and can have meaning, making it more memorable than the code. +The name should be fully qualified. -- [%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] -- @@ -778,28 +804,27 @@ One of the following SQL++ severity levels, listed in order of severity: 2. Error 3. Warn 4. Info - -- [%hardbreaks] {blank} -a| Integer +a¦ Integer -a| +a¦ *temp* + _optional_ -a| +a¦ [markdown] -- -Indicates if the condition is transient — for example, the queue is full. If the value is `false`, it tells clients and users that a retry without modification produces the same condition. - +Indicates if the condition is transient — for example, the queue is full. +If the value is `false`, it tells clients and users that a retry without modification produces the same condition. -- [%hardbreaks] {blank} -a| Boolean +a¦ Boolean |=== @@ -840,19 +865,19 @@ endif::collapse-models[] ifdef::model-descriptions[] //tag::desc-Controls[] -An object containing runtime information provided along with the request. Present only if `controls` was set to true in the [Request Parameters](#Request). - +An object containing runtime information provided along with the request. +Present only if `controls` was set to true in the request parameters. //end::desc-Controls[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *scan_consistency* + _optional_ -a| +a¦ [markdown] -- @@ -861,13 +886,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] -- @@ -876,29 +901,29 @@ Whether the cost-based optimizer was enabled for the query. [%hardbreaks] {blank} -a| Boolean +a¦ Boolean -a| +a¦ *memoryQuota* + _optional_ -a| +a¦ [markdown] -- -The memory quota for the request, in MB. This property is only returned if a memory quota was set for the query. - +The memory quota for the request, in MB. +This property is only returned if a memory quota was set for the query. -- [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) -a| +a¦ *stmtType* + _optional_ -a| +a¦ [markdown] -- @@ -906,9 +931,9 @@ The type of query statement. -- [%hardbreaks] -*Example:* `pass:c["SELECT"]` +*Example:* `+++"SELECT"+++` {blank} -a| String +a¦ String |=== @@ -949,21 +974,20 @@ endif::collapse-models[] ifdef::model-descriptions[] //tag::desc-Execution_Timings[] -Present only if `profile` was set to `"timings"` in the [Request Parameters](#Request). +Present only if `profile` was set to `"timings"` in the request parameters. The execution details for various phases involved in the query execution, such as kernel and service execution times, number of documents processed at each query operator in each phase, and number of phase switches. - //end::desc-Execution_Timings[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *#operator* + _required_ -a| +a¦ [markdown] -- @@ -971,15 +995,15 @@ Name of the operator. -- [%hardbreaks] -*Example:* `pass:c["Fetch"]` +*Example:* `+++"Fetch"+++` {blank} -a| String +a¦ String -a| +a¦ *#stats* + _required_ -a| +a¦ [markdown] -- @@ -988,13 +1012,13 @@ include::index.adoc[tag=desc-Statistics, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ xref:Statistics[] -a| +a¦ *~child* + _optional_ -a| +a¦ [markdown] -- @@ -1003,7 +1027,7 @@ Further nested operators, each with their own execution timings. [%hardbreaks] {blank} -a| Object +a¦ Object |=== @@ -1048,14 +1072,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] -- @@ -1064,13 +1088,13 @@ The total time taken for the request, that is the time from when the request was [%hardbreaks] {blank} -a| String +a¦ String (duration) -a| +a¦ *executionTime* + _required_ -a| +a¦ [markdown] -- @@ -1079,13 +1103,13 @@ The time taken for the execution of the request, that is the time from when quer [%hardbreaks] {blank} -a| String +a¦ String (duration) -a| +a¦ *resultCount* + _required_ -a| +a¦ [markdown] -- @@ -1094,13 +1118,13 @@ The total number of objects in the results. [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) -a| +a¦ *resultSize* + _required_ -a| +a¦ [markdown] -- @@ -1109,13 +1133,29 @@ The total number of bytes in the results. [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) -a| +a¦ +*naturalLanguageProcessingTime* + +_optional_ +a¦ + +[markdown] +-- +The total time spent processing a natural language request. +The cumulation of authentication, collecting schema, and time waiting for the response from the LLM, or wait time for the natural language request to be serviced. +-- + +[%hardbreaks] +{blank} +a¦ String (duration) + + +a¦ *mutationCount* + _optional_ -a| +a¦ [markdown] -- @@ -1124,47 +1164,47 @@ 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] -- -The number of objects that were sorted. Present only if the request includes `ORDER BY`. +The number of objects that were sorted. +Present only if the request includes `ORDER BY`. If a query includes ORDER BY, LIMIT, or OFFSET clauses, an application can use the `sortCount` value to give the overall number of results in a message such as `"page 1 of N"`. - -- [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) -a| +a¦ *usedMemory* + _optional_ -a| +a¦ [markdown] -- -The amount of document memory used to execute the request. This property is only returned if a memory quota was set for the query. - +The amount of document memory used to execute the request. +This property is only returned if a memory quota was set for the query. -- [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) -a| +a¦ *errorCount* + _optional_ -a| +a¦ [markdown] -- @@ -1173,13 +1213,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] -- @@ -1188,7 +1228,28 @@ The number of warnings that occurred during the request. [%hardbreaks] {blank} -a| Integer (unsigned) +a¦ Integer (unsigned) + + +a¦ +*sessionMemory* + +_optional_ +a¦ + +[markdown] +-- +The memory session size for the request, in bytes. + +Each request has a dedicated memory session. +When a query requires a document or value, memory is allocated from this session based on the size of the document or value. +Once the document or value is processed, the allocated memory is returned back to the session, enabling it to be reused by the request. + +This metric is available only when `node-quota` and `node-quota-val-percent` are configured for the node. +-- + +[%hardbreaks] +{blank} +a¦ Integer (bytes) |=== @@ -1229,19 +1290,19 @@ endif::collapse-models[] ifdef::model-descriptions[] //tag::desc-Profile[] -An object containing monitoring and profiling information about the request. Present only if `profile` was set to `"phases"` or `"timings"` in the [Request Parameters](#Request). - +An object containing monitoring and profiling information about the request. +Present only if `profile` was set to `"phases"` or `"timings"` in the request parameters. //end::desc-Profile[] endif::model-descriptions[] -[cols="25,55,20"] +[cols="25,55,20",separator=¦] |=== -| Property | | Schema +¦ Property ¦ ¦ Schema -a| +a¦ *requestTime* + _required_ -a| +a¦ [markdown] -- @@ -1250,13 +1311,13 @@ Timestamp when the query was received. [%hardbreaks] {blank} -a| Date (date-time) +a¦ Date (date-time) -a| +a¦ *servicingHost* + _required_ -a| +a¦ [markdown] -- @@ -1265,30 +1326,29 @@ 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] -- Count of documents processed at selective phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc. - -- [%hardbreaks] *Example:* `{"fetch":16,"indexScan":187}` {blank} -a| Object +a¦ Object -a| +a¦ *phaseOperators* + _required_ -a| +a¦ [markdown] -- @@ -1299,36 +1359,34 @@ A join would probably involve two or more fetches, one per keyspace. A union select would have twice as many operator counts, one per each branch of the union. This is in essence the count of all the operators in the `executionTimings` object. - -- [%hardbreaks] *Example:* `{"authorize":1,"fetch":1,"indexScan":2}` {blank} -a| Object +a¦ Object -a| +a¦ *phaseTimes* + _required_ -a| +a¦ [markdown] -- Cumulative execution times for various phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc. - -- [%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] -- @@ -1337,8 +1395,77 @@ include::index.adoc[tag=desc-Execution_Timings, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ xref:Execution_Timings[] + +a¦ +*ioTime* + +_optional_ +a¦ + +[markdown] +-- +The total sum of [servTime](#serv_time) across all operators. + +-- + +[%hardbreaks] +*Example:* `+++"752.858519ms"+++` +{blank} +a¦ String (duration) + + +a¦ +*waitTime* + +_optional_ +a¦ + +[markdown] +-- +The total sum of [kernTime](#kern_time) across all operators. + +-- + +[%hardbreaks] +*Example:* `+++"1.201307s"+++` +{blank} +a¦ String (duration) + + +a¦ +*cpuTime* + +_optional_ +a¦ + +[markdown] +-- +The total sum of [execTime](#exec_time) across all operators. + +-- + +[%hardbreaks] +*Example:* `+++"90.734075ms"+++` +{blank} +a¦ String (duration) + + +a¦ +*~analysis* + +_optional_ +a¦ + +[markdown] +-- +An array of text phrases that provide a basic analysis of the request execution. +These phrases highlight notable aspects of the execution, such as high document counts during primary scans or warnings related to memory and resource usages. + +-- + +[%hardbreaks] +*Example:* `["High IO time","High primary scan document count"]` +{blank} +a¦ String + array |=== @@ -1377,17 +1504,21 @@ 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] -- +ifdef::alt-markdown-links[] +[section_srh_tlm_n1b]: #section_srh_tlm_n1b + +endif::alt-markdown-links[] Supplies the values for positional parameters in the statement. Applicable if the statement or prepared statement contains 1 or more positional parameters. @@ -1395,27 +1526,25 @@ The value is an array of JSON values, one for each positional parameter in the s Refer to [Named Parameters and Positional Parameters][section_srh_tlm_n1b] for details. -[section_srh_tlm_n1b]: /cloud/n1ql/n1ql-manage/query-settings.html#section_srh_tlm_n1b - +[section_srh_tlm_n1b]: ../n1ql/n1ql-manage/query-settings.html#section_srh_tlm_n1b -- [%hardbreaks] *Example:* `["LAX",6]` {blank} -a| Any Type +a¦ Any Type array -a| [#atrcollection_req] +a¦ [#atrcollection_req] *atrcollection* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [atrcollection-srv]: #atrcollection-srv - endif::alt-markdown-links[] Specifies the collection where the [active transaction record][additional-storage-use] (ATR) is stored. The collection must be present. @@ -1424,43 +1553,52 @@ If not specified, the ATR is stored in the default collection in the default sco The value must be a string in the form `"bucket.scope.collection"` or `"namespace:bucket.scope.collection"`. If any part of the path contains a special character, that part of the path must be delimited in backticks ``. -[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries +[additional-storage-use]: /server/8.0/learn/data/transactions.html#active-transaction-record-entries + +// tag::desc-more[] +The [node-level][atrcollection-srv] `atrcollection` setting specifies the default for this parameter for a single node. +The request-level parameter overrides the node-level setting. +[atrcollection-srv]: ../n1ql-rest-admin/index.html#atrcollection-srv +// end::desc-more[] -- [%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] -- +ifdef::alt-markdown-links[] +[auto-execute]: ../n1ql-language-reference/prepare.html#auto-execute + +endif::alt-markdown-links[] Specifies that prepared statements should be executed automatically as soon as they are created. This saves you from having to make two separate requests in cases where you want to prepare a statement and execute it immediately. Refer to [Auto-Execute][auto-execute] for more information. -[auto-execute]: /cloud/n1ql/n1ql-language-reference/prepare.html#auto-execute - +[auto-execute]: ../n1ql/n1ql-language-reference/prepare.html#auto-execute -- [%hardbreaks] *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#client_context_id] +a¦ [#client_context_id] *client_context_id* + _optional_ -a| +a¦ [markdown] -- @@ -1469,46 +1607,43 @@ SQL++ is agnostic about the content of this parameter; it is just echoed in the * Maximum allowed size is 64 characters; all others will be cut. * If it contains an escape character `/` or quote `"`, it will be rejected as error code 1110. - -- [%hardbreaks] {blank} -a| String +a¦ String -a| [#compression] +a¦ [#compression] *compression* + _optional_ -a| +a¦ [markdown] -- Compression format to use for response data on the wire. 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] -- ifdef::alt-markdown-links[] [controls-srv]: #controls-srv - endif::alt-markdown-links[] Specifies if there should be a controls section returned with the request results. @@ -1516,24 +1651,48 @@ When set to `true`, the query response document includes a controls section with If the request qualifies for caching, these values will also be cached in the `completed_requests` system keyspace. +// tag::desc-more[] +The [node-level][controls-srv] `controls` setting specifies the default for this parameter for a single node. +The request-level parameter overrides the node-level setting. + +[controls-srv]: ../n1ql-rest-admin/index.html#controls-srv +// end::desc-more[] -- [%hardbreaks] *Example:* `true` {blank} -a| Boolean +a¦ Boolean + + +a¦ [#creds] +*creds* + +_optional_ +a¦ + +[markdown] +-- +In the Data API, this parameter is ignored and has no effect. + +In the cbq shell, this parameter specifies credentials within a session. +For more information, see [Switch Between Credentials](../n1ql-intro/cbq.html#cbq-multiple-creds). +-- + +[%hardbreaks] +{blank} +a¦ Any Type -a| [#durability_level] +a¦ [#durability_level] *durability_level* + _optional_ -a| +a¦ [markdown] -- The level of [durability][durability] for mutations produced by the request. -If the request contains a `BEGIN TRANSACTION` statement, or a DML statement with the [tximplicit](#tximplicit) parameter set to `true`, the durability level is specified for all mutations within that transaction. +If the request contains a `BEGIN TRANSACTION` statement, or a DML statement with the `tximplicit` parameter set to `true`, the durability level is specified for all mutations within that transaction. Durability is also supported for non-transactional DML statements. In this case, the `kvtimeout` parameter is used as the durability timeout. @@ -1541,79 +1700,75 @@ In this case, the `kvtimeout` parameter is used as the durability timeout. If not specified, the default durability level is `"majority"`. Set the durability level to `"none"` or `""` to specify no durability. -[durability]: /server/7.6/learn/data/durability.html - +[durability]: /server/8.0/learn/data/durability.html -- [%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] -- -In databases running Couchbase Server 6.5 and later, this parameter is ignored and has no effect. -It is included for compatibility with previous versions of Couchbase Server. - +In clusters running Couchbase Server 6.5 and later, this parameter is ignored and has no effect. +It is included for compatibility with previous versions. -- [%hardbreaks] {blank} -a| String +a¦ String -a| [#encoding] +a¦ [#encoding] *encoding* + _optional_ -a| +a¦ [markdown] -- Desired character encoding for the query results. 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] -- Desired format for the query results. 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] -- @@ -1635,20 +1790,19 @@ Valid units are: Specify a duration of `0` or a negative duration to disable. When disabled, no timeout is applied and the KV operation runs for however long it takes. - -- [%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] -- @@ -1656,24 +1810,37 @@ ifdef::alt-markdown-links[] [max-parallelism-srv]: #max-parallelism-srv [queryMaxParallelism]: #queryMaxParallelism - endif::alt-markdown-links[] Specifies the maximum parallelism for the query. The default value is the same as the number of partitions of the index selected for the query. +// tag::desc-more[] +The [node-level][max-parallelism-srv] `max-parallelism` setting specifies the ceiling for this parameter for a single node. +If the request-level parameter is zero or negative, the parallelism for the query is set to the node-level setting. +If the request-level parameter is greater than zero and less than the node-level setting, the request-level parameter overrides the node-level setting. +If the request-level parameter is greater than the node-level setting, the parallelism for the query is set to the node-level setting. + +In addition, the [cluster-level][queryMaxParallelism] `queryMaxParallelism` setting specifies the ceiling for this parameter for the whole cluster. +When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. + +To enable queries to run in parallel, you must specify the cluster-level `queryMaxParallelism` parameter, or specify the node-level `max-parallelism` parameter on all Query nodes. + +[max-parallelism-srv]: ../n1ql-rest-admin/index.html#max-parallelism-srv +[queryMaxParallelism]: ../n1ql-rest-settings/index.html#queryMaxParallelism +// end::desc-more[] -- [%hardbreaks] *Example:* `3` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#memory_quota_req] +a¦ [#memory_quota_req] *memory_quota* + _optional_ -a| +a¦ [markdown] -- @@ -1681,33 +1848,42 @@ ifdef::alt-markdown-links[] [memory-quota-srv]: #memory-quota-srv [queryMemoryQuota]: #queryMemoryQuota - endif::alt-markdown-links[] Specifies the maximum amount of memory the request may use, in MB. Specify `0` (the default value) to disable. When disabled, there is no quota. -This parameter enforces a ceiling on the memory used for the tracked documents required for -processing a request. It does not take into account any other memory that might be used to -process a request, such as the stack, the operators, or some intermediate values. +This parameter enforces a ceiling on the memory used for the tracked documents required for processing a request. +It does not take into account any other memory that might be used to process a request, such as the stack, the operators, or some intermediate values. Within a transaction, this setting enforces the memory quota for the transaction by tracking the delta table and the transaction log (approximately). +// tag::desc-more[] +The [node-level][memory-quota-srv] `memory-quota` setting specifies the ceiling for this parameter for a single node. +If the node-level setting is zero (the default), the request-level parameter overrides the node-level setting. +If the node-level setting is greater than zero, the request-level parameter is capped by the node-level setting. + +In addition, the [cluster-level][queryMemoryQuota] `queryMemoryQuota` setting specifies the ceiling for this parameter for the whole cluster. +When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. + +[memory-quota-srv]: ../n1ql-rest-admin/index.html#memory-quota-srv +[queryMemoryQuota]: ../n1ql-rest-settings/index.html#queryMemoryQuota +// end::desc-more[] -- [%hardbreaks] *Default:* `0` *Example:* `4` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#metrics] +a¦ [#metrics] *metrics* + _optional_ -a| +a¦ [markdown] -- @@ -1718,30 +1894,175 @@ 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] +-- +Specifies the namespace to use. +Currently, only the `default` namespace is available. +-- + +[%hardbreaks] +*Example:* `+++"default"+++` +{blank} +a¦ String + + +a¦ [#natural] +*natural* + +_optional_ +a¦ [.status]##Couchbase Server 8.0## [markdown] -- -Specifies the namespace to use. Currently, only the `default` namespace is available. +The prompt for a natural language request. +The Query Service uses the prompt to generate a SQL++ statement. + +If the generated statement is a SELECT statement, the generated statement is returned and executed automatically. +If the generated statement is not a SELECT statement, the generated statement is returned, but not executed. +In this case, you must verify the statement and execute it in a separate request. + +Natural language requests use the Couchbase Capella iQ service as a backend. +You must have a Couchbase Capella account to make a natural language request. + +This parameter is available in clusters running Couchbase Server 8.0 and later. + +To use this parameter, you must also specify the `natural_cred`, `natural_orgid`, and `natural_context` parameters. +If you don't specify all four parameters, the Query Service returns an error. -- [%hardbreaks] -*Example:* `pass:c["default"]` +*Example:* `+++"Show me count of airlines per country"+++` {blank} -a| String +a¦ String + + +a¦ [#natural_cred] +*natural_cred* + +_optional_ +a¦ [.status]##Couchbase Server 8.0## + +[markdown] +-- +The Couchbase Capella credentials for a natural language request, in the form `username:password`. +Be careful not to expose the credentials in log files or other output. + +Natural language requests use the Couchbase Capella iQ service as a backend. +You must have a Couchbase Capella account to make a natural language request. + +This parameter is available in clusters running Couchbase Server 8.0 and later. + +To use this parameter, you must also specify the `natural`, `natural_orgid`, and `natural_context` parameters. +If you don't specify all four parameters, the Query Service returns an error. +-- + +[%hardbreaks] +*Example:* `+++"username:password"+++` +{blank} +a¦ String (password) + + +a¦ [#natural_orgid] +*natural_orgid* + +_optional_ +a¦ [.status]##Couchbase Server 8.0## + +[markdown] +-- +The Couchbase Capella organization ID for a natural language request. + +Natural language requests use the Couchbase Capella iQ service as a backend. +You must have a Couchbase Capella account to make a natural language request. + +This parameter is available in clusters running Couchbase Server 8.0 and later. + +To use this parameter, you must also specify the `natural`, `natural_cred`, and `natural_context` parameters. +If you don't specify all four parameters, the Query Service returns an error. +-- + +[%hardbreaks] +{blank} +a¦ UUID (uuid) + + +a¦ [#natural_context] +*natural_context* + +_optional_ +a¦ [.status]##Couchbase Server 8.0## + +[markdown] +-- +A list of paths specifying keyspaces for a natural language request. +The Query Service infers the schema of each keyspace, in order to give more precise responses from the natural language request. + +The parameter may contain up to four paths, separated by commas. +Spaces are allowed. +Each path may be: + +* A full path, in the form `bucket.scope.collection` or `namespace:bucket.scope.collection`. + +* A path prefix, in the form `namespace:bucket` or `bucket`, to specify the default collection in the default scope. + +* A partial path, in the form `collection`. + In this case, you must specify the `query_context` parameter to provide the bucket and scope. + +Natural language requests use the Couchbase Capella iQ service as a backend. +You must have a Couchbase Capella account to make a natural language request. +This parameter is available in clusters running Couchbase Server 8.0 and later. -a| [#numatrs_req] +To use this parameter, you must also specify the `natural`, `natural_cred`, and `natural_orgid` parameters. +If you don't specify all four parameters, the Query Service returns an error. +-- + +[%hardbreaks] +*Example:* `+++"travel-sample, travel-sample.inventory.airline, airline"+++` +{blank} +a¦ String + + +a¦ [#natural_output] +*natural_output* + +_optional_ +a¦ [.status]##Couchbase Server 8.0## + +[markdown] +-- +Specifies the required output for a natural language request. + +* `sql` — + The output is a SQL++ statement. + +* `jsudf` — + The output is a `CREATE FUNCTION` statement which you can use to generate a SQL++ managed JavaScript user-defined function. + +* `ftssql` — + The output is a SQL++ statement which can use a Flex index, if available. + +Natural language requests use the Couchbase Capella iQ service as a backend. +You must have a Couchbase Capella account to make a natural language request. + +This parameter is available in clusters running Couchbase Server 8.0 and later. +-- + +[%hardbreaks] +*Values:* `"sql"`, `"jsudf"`, `"ftssql"` +*Default:* `+++"sql"+++` +{blank} +a¦ String + + +a¦ [#numatrs_req] *numatrs* + _optional_ -a| +a¦ [markdown] -- @@ -1749,26 +2070,35 @@ ifdef::alt-markdown-links[] [numatrs-srv]: #numatrs-srv [queryNumAtrs]: #queryNumAtrs - endif::alt-markdown-links[] Specifies the total number of [active transaction records][additional-storage-use]. Must be a positive integer. -[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries +[additional-storage-use]: /server/8.0/learn/data/transactions.html#active-transaction-record-entries + +// tag::desc-more[] +The [node-level][numatrs-srv] `numatrs` setting specifies the default for this parameter for a single node. +The request-level parameter overrides the node-level setting. +In addition, the [cluster-level][queryNumAtrs] `queryNumAtrs` setting specifies the default for this parameter for the whole cluster. +When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. + +[numatrs-srv]: ../n1ql-rest-admin/index.html#numatrs-srv +[queryNumAtrs]: ../n1ql-rest-settings/index.html#queryNumAtrs +// end::desc-more[] -- [%hardbreaks] *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] -- @@ -1776,22 +2106,31 @@ ifdef::alt-markdown-links[] [pipeline-batch-srv]: #pipeline-batch-srv [queryPipelineBatch]: #queryPipelineBatch - endif::alt-markdown-links[] Controls the number of items execution operators can batch for Fetch from the KV. +// tag::desc-more[] +The [node-level][pipeline-batch-srv] `pipeline-batch` setting specifies the default for this parameter for a single node. +The request-level parameter overrides the node-level setting, but only if it is lower than the node-level setting. + +In addition, the [cluster-level][queryPipelineBatch] `queryPipelineBatch` setting specifies the default for this parameter for the whole cluster. +When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. + +[pipeline-batch-srv]: ../n1ql-rest-admin/index.html#pipeline-batch-srv +[queryPipelineBatch]: ../n1ql-rest-settings/index.html#queryPipelineBatch +// end::desc-more[] -- [%hardbreaks] *Example:* `64` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#pipeline_cap_req] +a¦ [#pipeline_cap_req] *pipeline_cap* + _optional_ -a| +a¦ [markdown] -- @@ -1799,46 +2138,58 @@ ifdef::alt-markdown-links[] [pipeline-cap-srv]: #pipeline-cap-srv [queryPipelineCap]: #queryPipelineCap - endif::alt-markdown-links[] Maximum number of items each execution operator can buffer between various operators. +// tag::desc-more[] +The [node-level][pipeline-cap-srv] `pipeline-cap` setting specifies the default for this parameter for a single node. +The request-level parameter overrides the node-level setting, but only if it is lower than the node-level setting. + +In addition, the [cluster-level][queryPipelineCap] `queryPipelineCap` setting specifies the default for this parameter for the whole cluster. +When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. + +[pipeline-cap-srv]: ../n1ql-rest-admin/index.html#pipeline-cap-srv +[queryPipelineCap]: ../n1ql-rest-settings/index.html#queryPipelineCap +// end::desc-more[] -- [%hardbreaks] *Example:* `1024` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#prepared] +a¦ [#prepared] *prepared* + _optional_ -a| +a¦ [markdown] -- -_Required_ if `statement` not provided. +ifdef::alt-markdown-links[] +[execute]: ../n1ql-language-reference/execute.html + +endif::alt-markdown-links[] +_Required_ if `statement` or `natural` not provided. The name of the prepared SQL++ statement to be executed. Refer to [EXECUTE][execute] for examples. If both `prepared` and `statement` are present and non-empty, an error is returned. -[execute]: /cloud/n1ql/n1ql-language-reference/execute.html - +[execute]: ../n1ql/n1ql-language-reference/execute.html -- [%hardbreaks] -*Example:* `pass:c["a1355198-2576-4e3d-af04-5acc77d8a681"]` +*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] -- @@ -1850,49 +2201,52 @@ If the DML statement explicitly specifies the document expiration, the statement If `false`, document expiration is set to 0 when modified by a DML statement, unless the DML statement explicitly specifies the document expiration. Not supported for statements in a transaction. - -- [%hardbreaks] *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#pretty_req] +a¦ [#pretty_req] *pretty* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [pretty-srv]: #pretty-srv - endif::alt-markdown-links[] Specifies the query results returned in pretty format. +// tag::desc-more[] +The [node-level][pretty-srv] `pretty` setting specifies the default for this parameter for a single node. +The request-level parameter overrides the node-level setting. + +[pretty-srv]: ../n1ql-rest-admin/index.html#pretty-srv +// end::desc-more[] -- [%hardbreaks] *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#profile_req] +a¦ [#profile_req] *profile* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [profile-srv]: #profile-srv - endif::alt-markdown-links[] Specifies if there should be a profile section returned with the request results. The valid values are: @@ -1909,19 +2263,25 @@ This information will be included in the `system:active_requests` and `system:co If `profile` is not set as one of the above values, then the profile setting does not change. +// tag::desc-more[] +The [node-level][profile-srv] `profile` setting specifies the default for this parameter for a single node. +The request-level parameter overrides the node-level setting. + +[profile-srv]: ../n1ql-rest-admin/index.html#profile-srv +// end::desc-more[] -- [%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] -- @@ -1930,20 +2290,19 @@ Specifies the namespace, bucket, and scope used to resolve partial keyspace refe The query context may be a _full path_, containing namespace, bucket, and scope; or a _relative path_, containing just the bucket and scope. Currently, only the `default` namespace is available. If the namespace name is omitted, the default namespace in the current session is used. - -- [%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] -- @@ -1959,20 +2318,19 @@ If `readonly` is `true`, then the following statements are not allowed: * UPSERT When using GET requests, it's best to set `readonly` to `true`. - -- [%hardbreaks] *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#scan_cap_req] +a¦ [#scan_cap_req] *scan_cap* + _optional_ -a| +a¦ [markdown] -- @@ -1980,7 +2338,6 @@ ifdef::alt-markdown-links[] [scan-cap-srv]: #scan-cap-srv [queryScanCap]: #queryScanCap - endif::alt-markdown-links[] Maximum buffered channel size between the indexer client and the query service for index scans. This parameter controls when to use scan backfill. @@ -1988,21 +2345,35 @@ This parameter controls when to use scan backfill. Use `0` or a negative number to disable. Smaller values reduce GC, while larger values reduce indexer backfill. +// tag::desc-more[] +The [node-level][scan-cap-srv] `scan-cap` setting specifies the default for this parameter for a single node. +The request-level parameter overrides the node-level setting, but only if it is lower than the node-level setting. + +In addition, the [cluster-level][queryScanCap] `queryScanCap` setting specifies the default for this parameter for the whole cluster. +When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. + +[scan-cap-srv]: ../n1ql-rest-admin/index.html#scan-cap-srv +[queryScanCap]: ../n1ql-rest-settings/index.html#queryScanCap +// end::desc-more[] -- [%hardbreaks] *Example:* `1024` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#scan_consistency] +a¦ [#scan_consistency] *scan_consistency* + _optional_ -a| +a¦ [markdown] -- +ifdef::alt-markdown-links[] +[transactional-scan-consistency]: #transactional-scan-consistency + +endif::alt-markdown-links[] Specifies the consistency guarantee or constraint for index scanning. The valid values are: @@ -2031,25 +2402,24 @@ Values are case-insensitive. For multi-statement requests, the default behavior is RYOW within each request. If you want to disable RYOW within a request, add a separate `request_consistency` parameter that can be set to `not_bounded`. -If the request contains a `BEGIN TRANSACTION` statement, or a DML statement with the [tximplicit](#tximplicit) parameter set to `true`, then this parameter sets the transactional scan consistency. +If the request contains a `BEGIN TRANSACTION` statement, or a DML statement with the `tximplicit` parameter set to `true`, then this parameter sets the transactional scan consistency. Refer to [Transactional Scan Consistency][transactional-scan-consistency] for details. -[transactional-scan-consistency]: /cloud/n1ql/n1ql-manage/query-settings.html#transactional-scan-consistency - +[transactional-scan-consistency]: ../n1ql/n1ql-manage/query-settings.html#transactional-scan-consistency -- [%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] -- @@ -2070,19 +2440,18 @@ Scan vectors have two forms: Note that `scan_vector` can only be used if the query uses at most one keyspace; if it is used for a query referencing more than one keyspace, the query will fail with an error. 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] -- @@ -2092,18 +2461,17 @@ A map from keyspace names to scan vectors. See `scan_vector`. 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] -- @@ -2125,20 +2493,19 @@ Valid units are: * `h` (hours) 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] -- @@ -2149,37 +2516,36 @@ 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] -- If `true`, causes statement projection terms to be sorted alphabetically. If `false` (the default), statement projection terms are returned in the order specified by the query. - -- [%hardbreaks] *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#statement] +a¦ [#statement] *statement* + _optional_ -a| +a¦ [markdown] -- -_Required_ if `prepared` not provided. +_Required_ if `prepared` or `natural` not provided. Any valid SQL++ statement for a POST request, or a read-only SQL++ statement (SELECT, EXPLAIN) for a GET request. @@ -2192,19 +2558,18 @@ If it does, the Query Service responds with error 1040. To avoid this, either URL-encode the semicolon as `%3B`, or just omit the semicolon if possible. This restriction does not apply when specifying the request parameters in JSON format. - -- [%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] -- @@ -2212,7 +2577,6 @@ ifdef::alt-markdown-links[] [timeout-srv]: #timeout-srv [queryTimeout]: #queryTimeout - endif::alt-markdown-links[] Maximum time to spend on the request before timing out. @@ -2230,38 +2594,48 @@ Valid units are: Specify a duration of `0` or a negative duration to disable. When disabled, no timeout is applied and the request runs for however long it takes. -If [tximplicit](#tximplicit) or [txid](#txid) is set, this parameter is ignored. +If `tximplicit` or `txid` is set, this parameter is ignored. The request inherits the remaining time of the transaction as timeout. +// tag::desc-more[] +The [node-level][timeout-srv] `timeout` setting specifies the default for this parameter for a single node. +The request-level parameter overrides the node-level setting. +However, if the node-level setting is greater than 0, the timeout for the query is limited to the node-level setting. + +In addition, the [cluster-level][queryTimeout] `queryTimeout` setting specifies the default for this parameter for the whole cluster. +When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. + +[timeout-srv]: ../n1ql-rest-admin/index.html#timeout-srv +[queryTimeout]: ../n1ql-rest-settings/index.html#queryTimeout +// end::desc-more[] -- [%hardbreaks] -*Example:* `pass:c["30m"]` +*Example:* `+++"30m"+++` {blank} -a| String (duration) +a¦ String (duration) -a| [#txdata] +a¦ [#txdata] *txdata* + _optional_ -a| +a¦ [markdown] -- Transaction data. For internal use only. - -- [%hardbreaks] {blank} -a| Object +a¦ Object -a| [#txid] +a¦ [#txid] *txid* + _optional_ -a| +a¦ [markdown] -- @@ -2273,19 +2647,18 @@ For use with DML statements within a transaction, rollbacks, and commits. The transaction ID should be the same as the transaction ID generated by the `BEGIN TRANSACTION` statement. 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] -- @@ -2295,40 +2668,38 @@ When this parameter is true, the Query service starts a transaction and executes If execution is successful, the Query service commits the transaction; otherwise the transaction is rolled back. The statement may not be part of an ongoing transaction. -If the [txid](#txid) request-level parameter is set, the `tximplicit` parameter is ignored. - +If the `txid` request-level parameter is set, the `tximplicit` parameter is ignored. -- [%hardbreaks] *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#txstmtnum] +a¦ [#txstmtnum] *txstmtnum* + _optional_ -a| +a¦ [markdown] -- Transaction statement number. The transaction statement number must be a positive integer, and must be higher than any previous transaction statement numbers in the transaction. If the transaction statement number is lower than the transaction statement number for any previous statement, an error is generated. - -- [%hardbreaks] *Example:* `10` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#txtimeout_req] +a¦ [#txtimeout_req] *txtimeout* + _optional_ -a| +a¦ [markdown] -- @@ -2336,13 +2707,12 @@ ifdef::alt-markdown-links[] [txtimeout-srv]: #txtimeout-srv [queryTxTimeout]: #queryTxTimeout - endif::alt-markdown-links[] Maximum time to spend on a transaction before timing out. -Only applies to `BEGIN TRANSACTION` statements, or DML statements for which [tximplicit](#tximplicit) is set. +Only applies to `BEGIN TRANSACTION` statements, or DML statements for which `tximplicit` is set. For other statements, it is ignored. -Within a transaction, the request-level [timeout](#timeout_req) parameter is ignored. +Within a transaction, the request-level `timeout` parameter is ignored. The transaction timeout clock starts when the `BEGIN WORK` statement is successful. Once the transaction timeout is reached, no statement is allowed to continue in the transaction. @@ -2362,18 +2732,29 @@ When disabled, the request-level timeout is set to the default. The default is `"15s"` for cbq files or scripts, `"2m"` for interactive cbq sessions or redirected input. +// tag::desc-more[] +The [node-level][txtimeout-srv] `txtimeout` setting specifies the default for this parameter for a single node. +The request-level parameter overrides the node-level setting. +However, if the node-level setting is greater than 0, the transaction timeout for the query is limited to the node-level setting. + +In addition, the [cluster-level][queryTxTimeout] `queryTxTimeout` setting specifies the default for this parameter for the whole cluster. +When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. + +[txtimeout-srv]: ../n1ql-rest-admin/index.html#txtimeout-srv +[queryTxTimeout]: ../n1ql-rest-settings/index.html#queryTxTimeout +// end::desc-more[] -- [%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] -- @@ -2381,50 +2762,62 @@ ifdef::alt-markdown-links[] [use-cbo-srv]: #use-cbo-srv [queryUseCBO]: #queryUseCBO - endif::alt-markdown-links[] Specifies whether the cost-based optimizer is enabled. +// tag::desc-more[] +The [node-level][use-cbo-srv] `use-cbo` setting specifies the default for this parameter for a single node. +The request-level parameter overrides the node-level setting. + +In addition, the [cluster-level][queryUseCBO] `queryUseCBO` setting specifies the default for this parameter for the whole cluster. +When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. + +[use-cbo-srv]: ../n1ql-rest-admin/index.html#use-cbo-srv +[queryUseCBO]: ../n1ql-rest-settings/index.html#queryUseCBO +// end::desc-more[] -- [%hardbreaks] *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#use_fts] +a¦ [#use_fts] *use_fts* + _optional_ -a| +a¦ [markdown] -- -Specifies that the query should use a full-text index. +ifdef::alt-markdown-links[] +[flex-indexes]: ../n1ql-language-reference/flex-indexes.html + +endif::alt-markdown-links[] +Specifies that the query should use a Search index. If the query contains a `USING FTS` hint, that takes priority over this parameter. -If the query does not contain a `USING FTS` hint, and this parameter is set to true, all full-text indexes are considered for the query. -If a qualified full-text index is available, it is selected for the query. -If none of the available full-text indexes are qualified, the available GSI indexes are considered instead. +If the query does not contain a `USING FTS` hint, and this parameter is set to true, all Search indexes are considered for the query. +If a qualified Search index is available, it is selected for the query. +If none of the available Search indexes are qualified, the available GSI indexes are considered instead. Refer to [Flex Indexes][flex-indexes] for more information. -[flex-indexes]: /cloud/n1ql/n1ql-language-reference/flex-indexes.html - +[flex-indexes]: ../n1ql/n1ql-language-reference/flex-indexes.html -- [%hardbreaks] *Default:* `false` *Example:* `true` {blank} -a| Boolean +a¦ Boolean -a| [#use_replica_req] +a¦ [#use_replica_req] *use_replica* + _optional_ -a| [.status]##Couchbase Server 7.6## +a¦ [markdown] -- @@ -2432,7 +2825,6 @@ ifdef::alt-markdown-links[] [use-replica-srv]: #use-replica-srv [queryUseReplica]: #queryUseReplica - endif::alt-markdown-links[] Specifies whether a query can fetch data from a replica vBucket if active vBuckets are inaccessible. The possible values are: @@ -2447,49 +2839,69 @@ If the node-level setting is also `unset`, read from replica is disabled for thi Do not enable read from replica when you require consistent results. Only SELECT queries that are not within a transaction can read from replica. -Reading from replica is only possible with databases running Couchbase Server 7.6.0 or later. +Reading from replica is only possible if the cluster uses Couchbase Server 7.6.0 or later. Note that KV range scans cannot currently be started on a replica vBucket. If a query uses sequential scan and a data node becomes unavailable, the query might return an error, even if read from replica is enabled for the request. +// tag::desc-more[] +The [node-level][use-replica-srv] `use-replica` setting specifies the default for this property for a single node. +The request-level parameter usually overrides the node-level setting. +However, when the node-level setting is `off`, the request-level parameter cannot enable the property. + +In addition, the [cluster-level][queryUseReplica] `queryUseReplica` setting specifies the default for this property for the whole cluster. +When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. + +[use-replica-srv]: ../n1ql-rest-admin/index.html#use-replica-srv +[queryUseReplica]: ../n1ql-rest-settings/index.html#queryUseReplica +// end::desc-more[] -- [%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] +*<$identifier>* + _additional + property_ -a| +a¦ [markdown] -- +ifdef::alt-markdown-links[] +[section_srh_tlm_n1b]: #section_srh_tlm_n1b + +endif::alt-markdown-links[] Supplies the value for a named parameter in the statement. Applicable if the statement or prepared statement contains 1 or more named parameters. The name of this property consists of two parts: -1. The `$` character. - In databases running Couchbase Server 7.6.0 and later, this may be the `$` character or the `@` character. +1. The `$` character or the `@` character. 2. An identifier that specifies the name of the parameter. - This must start with an alpha character, followed by one or more alphanumeric characters. + This starts with an optional underscore (`_`), followed by an alpha character, followed by one or more alphanumeric characters, and ends with an optional underscore (`_`). + +If the named parameter contains sensitive information, start and end the name of the parameter (after the initial `$` or `@`) with an underscore (`_`). +This masks the parameter value in the active requests catalog, the completed requests catalog, the response `controls` section, the cbq shell file history, and the query logs. +When masked, a string parameter value is replaced by asterisks (`*`); other parameter values are replaced by `null`. +Parameter masking is available in clusters running Couchbase Server 7.6.8 and later. The value of the named parameter can be any JSON value. Refer to [Named Parameters and Positional Parameters][section_srh_tlm_n1b] for details. -[section_srh_tlm_n1b]: /cloud/n1ql/n1ql-manage/query-settings.html#section_srh_tlm_n1b - +[section_srh_tlm_n1b]: ../n1ql/n1ql-manage/query-settings.html#section_srh_tlm_n1b -- [%hardbreaks] +*Example:* `LAX` {blank} -a| Any Type +a¦ Any Type |=== @@ -2534,14 +2946,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] -- @@ -2550,61 +2962,77 @@ A unique identifier for the response. [%hardbreaks] {blank} -a| UUID (UUID) +a¦ UUID (UUID) -a| +a¦ *clientContextID* + _optional_ -a| +a¦ [markdown] -- -The client context ID of the request, if one was supplied — see `client_context_id` in [Request Parameters](#Request). +The client context ID of the request, if one was supplied — see `client_context_id` in the request parameters. -- [%hardbreaks] {blank} -a| String +a¦ String -a| -*signature* + +a¦ +*generated_statement* + _optional_ -a| +a¦ [.status]##Couchbase Server 8.0## [markdown] -- -The schema of the results. Present only when the query completes successfully. +The generated statement, if the request was a natural language prompt. +-- +[%hardbreaks] +*Example:* `+++"SELECT country, COUNT(*) AS `airline_count` FROM `travel-sample`.`inventory`.`airline` AS `a` GROUP BY country"+++` +{blank} +a¦ String + + +a¦ +*signature* + +_optional_ +a¦ + +[markdown] +-- +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] -- -An array of all the objects returned by the query. An object can be any JSON value. - +An array of all the objects returned by the query. +An object can be any JSON value. -- [%hardbreaks] {blank} -a| Any Type +a¦ Any Type array -a| +a¦ *status* + _optional_ -a| +a¦ [markdown] -- @@ -2614,45 +3042,45 @@ 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] -- -An array of 0 or more error objects. If an error occurred during processing of the request, it will be represented by an error object in this list. - +An array of 0 or more error objects. +If an error occurred during processing of the request, it will be represented by an error object in this list. -- [%hardbreaks] {blank} -a| <> +a¦ xref:Conditions[] array -a| +a¦ *warnings* + _optional_ -a| +a¦ [markdown] -- -An array of 0 or more warning objects. If a warning occurred during processing of the request, it is represented by a warning object in this list. - +An array of 0 or more warning objects. +If a warning occurred during processing of the request, it is represented by a warning object in this list. -- [%hardbreaks] {blank} -a| <> +a¦ xref:Conditions[] array -a| +a¦ *metrics* + _optional_ -a| +a¦ [markdown] -- @@ -2661,13 +3089,13 @@ include::index.adoc[tag=desc-Metrics, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ xref:Metrics[] -a| +a¦ *controls* + _optional_ -a| +a¦ [markdown] -- @@ -2676,13 +3104,13 @@ include::index.adoc[tag=desc-Controls, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ xref:Controls[] -a| +a¦ *profile* + _optional_ -a| +a¦ [markdown] -- @@ -2691,7 +3119,7 @@ include::index.adoc[tag=desc-Profile, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ xref:Profile[] |=== @@ -2736,14 +3164,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] -- @@ -2753,13 +3181,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] -- @@ -2769,13 +3197,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] -- @@ -2785,13 +3213,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¦ [#exec_time] *execTime* + _optional_ -a| +a¦ [markdown] -- @@ -2799,15 +3227,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¦ [#kern_time] *kernTime* + _optional_ -a| +a¦ [markdown] -- @@ -2815,15 +3243,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¦ [#serv_time] *servTime* + _optional_ -a| +a¦ [markdown] -- @@ -2832,13 +3260,12 @@ Time spent waiting for another service, such as index or data. For index scan, it is time spent waiting for GSI/indexer. 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) |=== @@ -2895,7 +3322,6 @@ include::{specDir}security/document-begin.adoc[opts=optional] -- Specify a user name and password via HTTP headers. This method can only be used to provide a single credential. - -- [%hardbreaks] @@ -2912,6 +3338,39 @@ __Type__ : http +// markup not found, no include::{specDir}security/Parameter/security-scheme-before.adoc[opts=optional] + + +[[security-parameter]] += Parameter + +:leveloffset: +1 + +// markup not found, no include::{specDir}security/Parameter/security-scheme-begin.adoc[opts=optional] + + +[markdown] +-- +Specify user names and passwords via the `creds` request parameter. +This is the only method that can provide multiple credentials for a request. +-- + +.API Key +[%hardbreaks] +__Key parameter__ : creds +__Key in__ : query + + +// markup not found, no include::{specDir}security/Parameter/security-scheme-end.adoc[opts=optional] + +:leveloffset: -1 + + +// markup not found, no include::{specDir}security/Parameter/security-scheme-after.adoc[opts=optional] + + + + include::{specDir}security/document-end.adoc[opts=optional] :leveloffset: -1 @@ -2920,3 +3379,4 @@ include::{specDir}security/document-end.adoc[opts=optional] include::{specDir}security/document-after.adoc[opts=optional] + diff --git a/docs/modules/n1ql-rest-query/query-service.gradle b/docs/modules/n1ql-rest-query/query-service.gradle new file mode 100644 index 00000000..bdae2ca8 --- /dev/null +++ b/docs/modules/n1ql-rest-query/query-service.gradle @@ -0,0 +1,49 @@ +plugins { + id("io.datapith.jayOverlay").version("0.1.11") +} + +apply plugin: 'org.openapi.generator' + +task bundleSpec(type: org.openapitools.generator.gradle.plugin.tasks.GenerateTask) { + generatorName = "openapi-yaml" + remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/morpheus/docs/spec/service/service.yaml" + outputDir = "${projectDir}/build/bundle" + globalProperties = [ + generateAliasAsModel: "true" + ] + additionalProperties = [ + outputFile: "service.yaml", + ] + generateAliasAsModel = true +} + +jayOverlay { + targetFile.set("${projectDir}/build/bundle/service.yaml") + overlayFile.set("${projectDir}/attachments/_overlay.json") + outputDir.set("${projectDir}/build/overlay") +} + +openApiGenerate { + generatorName = "asciidoc" + inputSpec = file("build/overlay/service.yaml").getAbsolutePath().toString() + outputDir = "${rootDir}/docs/modules/n1ql-rest-query/pages" + templateDir = "${rootDir}/templates" + gitRepoId = "query" + gitUserId = "couchbase" + additionalProperties = [ + specDir: "${rootDir}/docs/modules/n1ql-rest-query/partials/", + snippetDir: "${rootDir}/docs/modules/n1ql-rest-query/partials/paths/", + headerAttributes: "true", + useIntroduction: "true", + useTableTitles: "true", + skipExamples: "true", + legacyDiscriminatorBehavior: "true" + ] + globalProperties = [ + generateAliasAsModel: "true" + ] + generateAliasAsModel = true +} + +tasks.applyOverlay.dependsOn(bundleSpec) +tasks.openApiGenerate.dependsOn(applyOverlay) \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/pages/index.adoc b/docs/modules/n1ql-rest-settings/pages/index.adoc index 33cf3a2f..6cd96732 100644 --- a/docs/modules/n1ql-rest-settings/pages/index.adoc +++ b/docs/modules/n1ql-rest-settings/pages/index.adoc @@ -8,7 +8,7 @@ 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 +DO NOT EDIT! See https://github.com/couchbase/query :leveloffset: 1 @@ -32,7 +32,7 @@ This API enables you to view or specify cluster-level Query settings. [discrete#version] = Version information [%hardbreaks] -__Version__ : capella +__Version__ : 8.0 [discrete#host] = Host information @@ -58,18 +58,18 @@ The URL scheme. Use `https` for secure access. [%hardbreaks] *Values:* `http`, `https` -*Example:* `pass:c[http]` +*Example:* `+++http+++` // end a| *host* a| [markdown] -- -The host name or IP address of a node running the Query service. +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 |=== @@ -113,7 +113,7 @@ ifeval::[{count-apis} > 1] The operations are grouped in the following categories. [%hardbreaks] -<> +xref:tag-Default[] endif::[] @@ -131,12 +131,14 @@ endif::[] endif::[] [%hardbreaks] -<> -<> -<> -<> +xref:get_access[] +xref:get_settings[] +xref:post_access[] +xref:post_settings[] +//tag::get_access[] + // markup not found, no include::{specDir}paths/get_access/operation-before.adoc[opts=optional] @@ -174,6 +176,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 +199,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] @@ -218,7 +220,7 @@ a| [markdown] -- An object determining which URLs may be accessed by the `CURL()` function. -- -a| <> +a| xref:Access[] @@ -251,7 +253,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -280,6 +282,10 @@ include::{snippetDir}get_access/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_access/operation-after.adoc[opts=optional] +//end::get_access[] + + +//tag::get_settings[] // markup not found, no include::{specDir}paths/get_settings/operation-before.adoc[opts=optional] @@ -318,6 +324,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 +347,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] @@ -362,7 +368,7 @@ a| [markdown] -- An object giving cluster-level query settings. -- -a| <> +a| xref:Settings[] @@ -395,7 +401,7 @@ a| <> | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -424,6 +430,10 @@ include::{snippetDir}get_settings/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/get_settings/operation-after.adoc[opts=optional] +//end::get_settings[] + + +//tag::post_access[] // markup not found, no include::{specDir}paths/post_access/operation-before.adoc[opts=optional] @@ -462,6 +472,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 +508,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 +525,7 @@ An object determining which URLs may be accessed by the `CURL()` function. [%hardbreaks] {blank} -a| <> +a¦ xref:Access[] @@ -522,17 +542,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] @@ -554,7 +563,7 @@ a| [markdown] -- An object determining which URLs may be accessed by the `CURL()` function, including the latest changes. -- -a| <> +a| xref:Access[] | 400 @@ -595,7 +604,7 @@ a| Object | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -624,6 +633,10 @@ include::{snippetDir}post_access/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/post_access/operation-after.adoc[opts=optional] +//end::post_access[] + + +//tag::post_settings[] // markup not found, no include::{specDir}paths/post_settings/operation-before.adoc[opts=optional] @@ -662,6 +675,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 +711,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 +728,7 @@ An object specifying cluster-level query settings. [%hardbreaks] {blank} -a| <> +a¦ xref:Settings[] @@ -722,17 +745,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] @@ -754,7 +766,7 @@ a| [markdown] -- An object giving cluster-level query settings, including the latest changes. -- -a| <> +a| xref:Settings[] | 400 @@ -795,7 +807,7 @@ a| Object | Type | Name | http (basic) -| <> +| xref:security-default[] |=== @@ -824,6 +836,8 @@ include::{snippetDir}post_settings/http-response.adoc[opts=optional] // markup not found, no include::{specDir}paths/post_settings/operation-after.adoc[opts=optional] +//end::post_settings[] + ifeval::[{count-apis} > 1] :leveloffset: -1 @@ -860,8 +874,8 @@ ifdef::collapse-models[] [.two-columns] endif::collapse-models[] [%hardbreaks] -<> -<> +xref:Access[] +xref:Settings[] endif::[] @@ -891,14 +905,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] -- @@ -907,18 +921,17 @@ Defines whether the user has access to all URLs, or only URLs specified by the a This field set must be set to `false` to enable the `allowed_urls` and `disallowed_urls` fields. Setting this field to `true` enables access to all endpoints. - -- [%hardbreaks] {blank} -a| Boolean +a¦ Boolean -a| +a¦ *allowed_urls* + _optional_ -a| +a¦ [markdown] -- @@ -930,18 +943,17 @@ For example, if you wish to allow access to all Google APIs, add the URL `https: To allow complete access to `localhost`, use `http://localhost`. Note that each URL must include the port, protocol, and all other components of the URL. - -- [%hardbreaks] {blank} -a| String +a¦ String array -a| +a¦ *disallowed_urls* + _optional_ -a| +a¦ [markdown] -- @@ -952,12 +964,11 @@ The CURL() function will disallow any URL that starts with this value. If both `allowed_urls` and `disallowed_urls` fields are populated, the `disallowed_urls` field takes precedence over `allowed_urls`. Note that each URL must include the port, protocol, and all other components of the URL. - -- [%hardbreaks] {blank} -a| String +a¦ String array |=== @@ -997,77 +1008,76 @@ 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] -- ifdef::alt-markdown-links[] [cleanupclientattempts]: #cleanupclientattempts - endif::alt-markdown-links[] When enabled, the Query service preferentially aims to clean up just transactions that it has created, leaving transactions for the distributed cleanup process only when it is forced to. +// tag::desc-more[] The [node-level][cleanupclientattempts] `cleanupclientattempts` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [cleanupclientattempts]: ../n1ql-rest-admin/index.html#cleanupclientattempts - +// end::desc-more[] -- [%hardbreaks] *Default:* `true` *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#queryCleanupLostAttempts] +a¦ [#queryCleanupLostAttempts] *queryCleanupLostAttempts* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [cleanuplostattempts]: #cleanuplostattempts - endif::alt-markdown-links[] When enabled, the Query service takes part in the distributed cleanup process, and cleans up expired transactions created by any client. +// tag::desc-more[] The [node-level][cleanuplostattempts] `cleanuplostattempts` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [cleanuplostattempts]: ../n1ql-rest-admin/index.html#cleanuplostattempts - +// end::desc-more[] -- [%hardbreaks] *Default:* `true` *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#queryCleanupWindow] +a¦ [#queryCleanupWindow] *queryCleanupWindow* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [cleanupwindow]: #cleanupwindow - endif::alt-markdown-links[] Specifies how frequently the Query service checks its subset of [active transaction records][additional-storage-use] for cleanup. Decreasing this setting causes expiration transactions to be found more swiftly, with the tradeoff of increasing the number of reads per second used for the scanning process. @@ -1083,32 +1093,34 @@ Valid units are: * `m` (minutes) * `h` (hours) +[additional-storage-use]: /server/8.0/learn/data/transactions.html#active-transaction-record-entries + +// tag::desc-more[] The [node-level][cleanupwindow] `cleanupwindow` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. -[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [cleanupwindow]: ../n1ql-rest-admin/index.html#cleanupwindow - +// end::desc-more[] -- [%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] -- ifdef::alt-markdown-links[] +[sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config [completed-limit]: #completed-limit - endif::alt-markdown-links[] Sets the number of requests to be logged in the completed requests catalog. As new completed requests are added, old ones are removed. @@ -1117,35 +1129,35 @@ Increase this when the completed request keyspace is not big enough to track the Refer to [Configure the Completed Requests][sys-completed-config] for more information and examples. +[sys-completed-config]: ../n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + +// tag::desc-more[] The [node-level][completed-limit] `completed-limit` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. -[sys-completed-config]: /capella/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config [completed-limit]: ../n1ql-rest-admin/index.html#completed-limit - +// end::desc-more[] -- [%hardbreaks] *Default:* `4000` *Example:* `7000` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryCompletedMaxPlanSize] +a¦ [#queryCompletedMaxPlanSize] *queryCompletedMaxPlanSize* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] +[sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config [completed-max-plan-size]: #completed-max-plan-size - endif::alt-markdown-links[] -This property is available in databases running Couchbase Server 7.6.0 and later. - A plan size in bytes. Limits the size of query execution plans that can be logged in the completed requests catalog. Values larger than the maximum limit are silently treated as the maximum limit. @@ -1154,12 +1166,14 @@ You must obtain execution plans for such queries via profiling or using the EXPL Refer to [Configure the Completed Requests][sys-completed-config] for more information. +[sys-completed-config]: ../n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + +// tag::desc-more[] The [node-level][completed-max-plan-size] `completed-max-plan-size` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. -[sys-completed-config]: /capella/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config [completed-max-plan-size]: ../n1ql-rest-admin/index.html#completed-max-plan-size - +// end::desc-more[] -- [%hardbreaks] @@ -1167,20 +1181,20 @@ 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] -- ifdef::alt-markdown-links[] +[sys-completed-config]: monitoring-n1ql-query.html#sys-completed-config [completed-threshold]: #completed-threshold - endif::alt-markdown-links[] A duration in milliseconds. All completed queries lasting longer than this threshold are logged in the completed requests catalog. @@ -1190,32 +1204,33 @@ Specify any negative number to track none. Refer to [Configure the Completed Requests][sys-completed-config] for more information and examples. +[sys-completed-config]: ../n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config + +// tag::desc-more[] The [node-level][completed-threshold] `completed-threshold` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. -[sys-completed-config]: /capella/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config [completed-threshold]: ../n1ql-rest-admin/index.html#completed-threshold - +// end::desc-more[] -- [%hardbreaks] *Default:* `1000` *Example:* `7000` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryLogLevel] +a¦ [#queryLogLevel] *queryLogLevel* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [loglevel]: #loglevel - endif::alt-markdown-links[] Log level used in the logger. @@ -1241,33 +1256,34 @@ Major items, like crashes. * `NONE` — Doesn't write anything. +// tag::desc-more[] The [node-level][loglevel] `loglevel` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [loglevel]: ../n1ql-rest-admin/index.html#loglevel - +// end::desc-more[] -- [%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] -- ifdef::alt-markdown-links[] +[max-parallelism]: ../n1ql-language-reference/index-partitioning.html#max-parallelism [max-parallelism-srv]: #max-parallelism-srv [max_parallelism_req]: #max_parallelism_req - endif::alt-markdown-links[] Specifies the maximum parallelism for queries on all Query nodes in the cluster. @@ -1278,6 +1294,11 @@ Similarly, if the value is greater than the number of allowed cores, the maximum In Community Edition, the number of allowed cores cannot be greater than 4. In Enterprise Edition, there is no limit to the number of allowed cores.) +Refer to [Max Parallelism][max-parallelism] for more information. + +[max-parallelism]: ../n1ql/n1ql-language-reference/index-partitioning.html#max-parallelism + +// tag::desc-more[] The [node-level][max-parallelism-srv] `max-parallelism` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -1286,25 +1307,22 @@ If a request includes this parameter, it will be capped by the node-level `max-p NOTE: To enable queries to run in parallel, you must specify the cluster-level `queryMaxParallelism` parameter, or specify the node-level `max-parallelism` parameter on all Query nodes. -Refer to [Max Parallelism][max-parallelism] for more information. - -[max-parallelism]: /cloud/n1ql/n1ql-language-reference/index-partitioning.html#max-parallelism [max-parallelism-srv]: ../n1ql-rest-admin/index.html#max-parallelism-srv [max_parallelism_req]: ../n1ql-rest-query/index.html#max_parallelism_req - +// end::desc-more[] -- [%hardbreaks] *Default:* `1` *Example:* `0` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryMemoryQuota] +a¦ [#queryMemoryQuota] *queryMemoryQuota* + _optional_ -a| +a¦ [markdown] -- @@ -1312,17 +1330,16 @@ ifdef::alt-markdown-links[] [memory-quota-srv]: #memory-quota-srv [memory_quota_req]: #memory_quota_req - endif::alt-markdown-links[] Specifies the maximum amount of memory a request may use on any Query node in the cluster, in MB. -This parameter enforces a ceiling on the memory used for the tracked documents required for -processing a request. It does not take into account any other memory that might be used to -process a request, such as the stack, the operators, or some intermediate values. +This parameter enforces a ceiling on the memory used for the tracked documents required for processing a request. +It does not take into account any other memory that might be used to process a request, such as the stack, the operators, or some intermediate values. Within a transaction, this setting enforces the memory quota for the transaction by tracking the delta table and the transaction log (approximately). +// tag::desc-more[] The [node-level][memory-quota-srv] `memory-quota` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -1331,98 +1348,101 @@ If a request includes this parameter, it will be capped by the node-level `memor [memory-quota-srv]: ../n1ql-rest-admin/index.html#memory-quota-srv [memory_quota_req]: ../n1ql-rest-query/index.html#memory_quota_req - +// end::desc-more[] -- [%hardbreaks] *Default:* `0` *Example:* `4` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryN1qlFeatCtrl] -*queryN1qlFeatCtrl* + +a¦ [#queryN1QLFeatCtrl] +*queryN1QLFeatCtrl* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [n1ql-feat-ctrl]: #n1ql-feat-ctrl - endif::alt-markdown-links[] SQL++ feature control. This setting is provided for technical support only. +// tag::desc-more[] The [node-level][n1ql-feat-ctrl] `n1ql-feat-ctrl` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [n1ql-feat-ctrl]: ../n1ql-rest-admin/index.html#n1ql-feat-ctrl - +// end::desc-more[] -- [%hardbreaks] {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryNodeQuota] +a¦ [#queryNodeQuota] *queryNodeQuota* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [node-quota]: #node-quota - endif::alt-markdown-links[] -This property is available in databases running Couchbase Server 7.6.0 and later. - -Sets the soft memory limit for every Query node in the cluster, in MB. +Sets the soft memory limit for the Query service on every Query node in the cluster, in MB. The garbage collector tries to keep below this target. It is not a hard, absolute limit, and memory usage may exceed this value. -When set to `0` (the default), there is no soft memory limit. +When set to `0` (the default), the Query service sets a default soft memory limit for every node. +To do this, the Query service calculates the difference between the total system RAM and 90% of the total system RAM: +`Total System RAM - (0.9 * Total System RAM)` + +- If the difference is greater than 8 GiB, the default soft memory limit is set to the total system RAM minus 8 GiB. + +- If the difference is 8 GiB or less, the default soft memory limit is set to 90% of the total system RAM. + +// tag::desc-more[] The [node-level][node-quota] `node-quota` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [node-quota]: ../n1ql-rest-admin/index.html#node-quota - +// end::desc-more[] -- [%hardbreaks] *Default:* `0` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryNodeQuotaValPercent] +a¦ [#queryNodeQuotaValPercent] *queryNodeQuotaValPercent* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [node-quota-val-percent]: #node-quota-val-percent - endif::alt-markdown-links[] -This property is available in databases running Couchbase Server 7.6.0 and later. - The percentage of the `queryNodeQuota` that is dedicated to tracked value content memory across all active requests for every Query node in the cluster. (The `queryMemoryQuota` setting specifies the maximum amount of document memory an individual request may use on any Query node in the cluster.) +// tag::desc-more[] The [node-level][node-quota-val-percent] `node-quota-val-percent` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [node-quota-val-percent]: ../n1ql-rest-admin/index.html#node-quota-val-percent - +// end::desc-more[] -- [%hardbreaks] @@ -1430,13 +1450,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] -- @@ -1444,45 +1464,42 @@ ifdef::alt-markdown-links[] [numatrs-srv]: #numatrs-srv [numatrs_req]: #numatrs_req - endif::alt-markdown-links[] Specifies the total number of [active transaction records][additional-storage-use] for all Query nodes in the cluster. +[additional-storage-use]: /server/8.0/learn/data/transactions.html#active-transaction-record-entries + +// tag::desc-more[] The [node-level][numatrs-srv] `numatrs` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. In addition, there is a [request-level][numatrs_req] `numatrs` parameter. If a request includes this parameter, it will be capped by the node-level `numatrs` setting. -[additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries [numatrs-srv]: ../n1ql-rest-admin/index.html#numatrs-srv [numatrs_req]: ../n1ql-rest-query/index.html#numatrs_req - +// end::desc-more[] -- [%hardbreaks] *Default:* `1024` -*Minimum:* `0` -*Exclusive minimum:* `true` +*Minimum:* `0` (exclusive) *Example:* `512` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryNumCpus] +a¦ [#queryNumCpus] *queryNumCpus* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [num-cpus]: #num-cpus - endif::alt-markdown-links[] -This property is available in databases running Couchbase Server 7.6.0 and later. - The number of CPUs the Query service can use on any Query node in the cluster. Note that this setting requires a restart of the Query service to take effect. @@ -1492,23 +1509,24 @@ The number of CPUs can never be greater than the number of logical CPUs. In Community Edition, the number of allowed CPUs cannot be greater than 4. In Enterprise Edition, there is no limit to the number of allowed CPUs. +// tag::desc-more[] The [node-level][num-cpus] `num-cpus` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [num-cpus]: ../n1ql-rest-admin/index.html#num-cpus - +// end::desc-more[] -- [%hardbreaks] *Default:* `0` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryPipelineBatch] +a¦ [#queryPipelineBatch] *queryPipelineBatch* + _optional_ -a| +a¦ [markdown] -- @@ -1516,10 +1534,10 @@ ifdef::alt-markdown-links[] [pipeline-batch-srv]: #pipeline-batch-srv [pipeline_batch_req]: #pipeline_batch_req - endif::alt-markdown-links[] Controls the number of items execution operators can batch for Fetch from the KV. +// tag::desc-more[] The [node-level][pipeline-batch-srv] `pipeline-batch` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -1528,20 +1546,20 @@ The minimum of that and the node-level `pipeline-batch` setting is applied. [pipeline-batch-srv]: ../n1ql-rest-admin/index.html#pipeline-batch-srv [pipeline_batch_req]: ../n1ql-rest-query/index.html#pipeline_batch_req - +// end::desc-more[] -- [%hardbreaks] *Default:* `16` *Example:* `64` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryPipelineCap] +a¦ [#queryPipelineCap] *queryPipelineCap* + _optional_ -a| +a¦ [markdown] -- @@ -1549,10 +1567,10 @@ ifdef::alt-markdown-links[] [pipeline-cap-srv]: #pipeline-cap-srv [pipeline_cap_req]: #pipeline_cap_req - endif::alt-markdown-links[] Maximum number of items each execution operator can buffer between various operators. +// tag::desc-more[] The [node-level][pipeline-cap-srv] `pipeline-cap` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -1561,49 +1579,49 @@ The minimum of that and the node-level `pipeline-cap` setting is applied. [pipeline-cap-srv]: ../n1ql-rest-admin/index.html#pipeline-cap-srv [pipeline_cap_req]: ../n1ql-rest-query/index.html#pipeline_cap_req - +// end::desc-more[] -- [%hardbreaks] *Default:* `512` *Example:* `1024` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryPreparedLimit] +a¦ [#queryPreparedLimit] *queryPreparedLimit* + _optional_ -a| +a¦ [markdown] -- ifdef::alt-markdown-links[] [prepared-limit]: #prepared-limit - endif::alt-markdown-links[] Maximum number of prepared statements in the cache. When this cache reaches the limit, the least recently used prepared statements will be discarded as new prepared statements are created. +// tag::desc-more[] The [node-level][prepared-limit] `prepared-limit` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. [prepared-limit]: ../n1ql-rest-admin/index.html#prepared-limit - +// end::desc-more[] -- [%hardbreaks] *Default:* `16384` *Example:* `65536` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryScanCap] +a¦ [#queryScanCap] *queryScanCap* + _optional_ -a| +a¦ [markdown] -- @@ -1611,7 +1629,6 @@ ifdef::alt-markdown-links[] [scan-cap-srv]: #scan-cap-srv [scan_cap_req]: #scan_cap_req - endif::alt-markdown-links[] Maximum buffered channel size between the indexer client and the query service for index scans. This parameter controls when to use scan backfill. @@ -1619,6 +1636,7 @@ This parameter controls when to use scan backfill. Use `0` or a negative number to disable. Smaller values reduce GC, while larger values reduce indexer backfill. +// tag::desc-more[] The [node-level][scan-cap-srv] `scan-cap` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -1627,20 +1645,20 @@ The minimum of that and the node-level `scan-cap` setting is applied. [scan-cap-srv]: ../n1ql-rest-admin/index.html#scan-cap-srv [scan_cap_req]: ../n1ql-rest-query/index.html#scan_cap_req - +// end::desc-more[] -- [%hardbreaks] *Default:* `512` *Example:* `1024` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryTimeout] +a¦ [#queryTimeout] *queryTimeout* + _optional_ -a| +a¦ [markdown] -- @@ -1648,7 +1666,6 @@ ifdef::alt-markdown-links[] [timeout-srv]: #timeout-srv [timeout_req]: #timeout_req - endif::alt-markdown-links[] Maximum time to spend on the request before timing out (ns). @@ -1658,6 +1675,7 @@ It must not be delimited by quotes, and must not include a unit. Specify `0` (the default value) or a negative integer to disable. When disabled, no timeout is applied and the request runs for however long it takes. +// tag::desc-more[] The [node-level][timeout-srv] `timeout` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -1666,20 +1684,20 @@ The minimum of that and the node-level `timeout` setting is applied. [timeout-srv]: ../n1ql-rest-admin/index.html#timeout-srv [timeout_req]: ../n1ql-rest-query/index.html#timeout_req - +// end::desc-more[] -- [%hardbreaks] *Default:* `0` *Example:* `500000000` {blank} -a| Long (int64) +a¦ Long (int64) -a| [#queryTxTimeout] +a¦ [#queryTxTimeout] *queryTxTimeout* + _optional_ -a| +a¦ [markdown] -- @@ -1688,7 +1706,6 @@ ifdef::alt-markdown-links[] [txtimeout-srv]: #txtimeout-srv [txtimeout_req]: #txtimeout_req - endif::alt-markdown-links[] Maximum time to spend on a transaction before timing out. This setting only applies to requests containing the `BEGIN TRANSACTION` statement, or to requests where the [tximplicit][tximplicit] parameter is set. @@ -1708,74 +1725,75 @@ Valid units are: Specify `0ms` (the default value) to disable. When disabled, no timeout is applied and the transaction runs for however long it takes. +[tximplicit]: ../n1ql-rest-query/index.html#tximplicit + +// tag::desc-more[] The [node-level][txtimeout-srv] `txtimeout` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. In addition, there is a [request-level][txtimeout_req] `txtimeout` parameter. If a request includes this parameter, it will be capped by the node-level `txtimeout` setting. -[tximplicit]: ../n1ql-rest-query/index.html#tximplicit [txtimeout-srv]: ../n1ql-rest-admin/index.html#txtimeout-srv [txtimeout_req]: ../n1ql-rest-query/index.html#txtimeout_req - +// end::desc-more[] -- [%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] -- -The path to which the indexer writes temporary backfill files, to store any transient data during query processing. +The path to which the Index Service writes temporary backfill files, and the Query Service writes spill files, to store any transient data during query processing. The specified path must already exist. Only absolute paths are allowed. The default path is `var/lib/couchbase/tmp` within the Couchbase Server installation directory. - -- [%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] -- -The maximum size of temporary backfill files (MB). +In MiB, the maximum size of temporary backfill files for each indexer, and the maximum size of temporary files for spilled sorting and other operations. +In a cluster with both secondary indexing and full text search, the limit for disk space use is three times this setting. Setting the size to `0` disables backfill. Setting the size to `-1` means the size is unlimited. The maximum size is limited only by the available disk space. - -- [%hardbreaks] *Default:* `5120` *Example:* `2048` {blank} -a| Integer (int32) +a¦ Integer (int32) -a| [#queryUseCBO] +a¦ [#queryUseCBO] *queryUseCBO* + _optional_ -a| +a¦ [markdown] -- @@ -1783,10 +1801,10 @@ ifdef::alt-markdown-links[] [use-cbo-srv]: #use-cbo-srv [use_cbo_req]: #use_cbo_req - endif::alt-markdown-links[] Specifies whether the cost-based optimizer is enabled. +// tag::desc-more[] The [node-level][use-cbo-srv] `use-cbo` setting specifies this property for a single node. When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. @@ -1795,20 +1813,20 @@ If a request does not include this parameter, the node-level setting is used, wh [use-cbo-srv]: ../n1ql-rest-admin/index.html#use-cbo-srv [use_cbo_req]: ../n1ql-rest-query/index.html#use_cbo_req - +// end::desc-more[] -- [%hardbreaks] *Default:* `true` *Example:* `false` {blank} -a| Boolean +a¦ Boolean -a| [#queryUseReplica] +a¦ [#queryUseReplica] *queryUseReplica* + _optional_ -a| +a¦ [markdown] -- @@ -1816,7 +1834,6 @@ ifdef::alt-markdown-links[] [use-replica-srv]: #use-replica-srv [use_replica_req]: #use_replica_req - endif::alt-markdown-links[] Specifies whether a query can fetch data from a replica vBucket if active vBuckets are inaccessible. The possible values are: @@ -1827,38 +1844,39 @@ The possible values are: * `unset` — read from replica is enabled or disabled at request level. -The [node-level][use-replica-srv] `use-replica` setting specifies this property for a single node. -When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - -In addition, the [request-level][use_replica_req] `use_replica` parameter specifies this property per request. -If a request does not include this parameter, or if the request-level parameter is `unset`, the node-level setting is used. -If the request-level parameter and the node-level setting are both `unset`, read from replica is disabled for that request. - Do not enable read from replica when you require consistent results. Only SELECT queries that are not within a transaction can read from replica. -Reading from replica is only possible with databases running Couchbase Server 7.6.0 or later. +Reading from replica is only possible if the cluster uses Couchbase Server 7.6.0 or later. Note that KV range scans cannot currently be started on a replica vBucket. If a query uses sequential scan and a data node becomes unavailable, the query might return an error, even if read from replica is enabled for the request. +// tag::desc-more[] +The [node-level][use-replica-srv] `use-replica` setting specifies this property for a single node. +When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. + +In addition, the [request-level][use_replica_req] `use_replica` parameter specifies this property per request. +If a request does not include this parameter, or if the request-level parameter is `unset`, the node-level setting is used. +If the request-level parameter and the node-level setting are both `unset`, read from replica is disabled for that request. + [use-replica-srv]: ../n1ql-rest-admin/index.html#use-replica-srv [use_replica_req]: ../n1ql-rest-query/index.html#use_replica_req - +// end::desc-more[] -- [%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] -- @@ -1867,7 +1885,7 @@ include::index.adoc[tag=desc-Access, opts=optional] [%hardbreaks] {blank} -a| <> +a¦ xref:Access[] |=== @@ -1950,3 +1968,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/partials/security/document-begin.adoc b/docs/modules/n1ql-rest-settings/partials/security/document-begin.adoc index 00904b2f..28aa1905 100644 --- a/docs/modules/n1ql-rest-settings/partials/security/document-begin.adoc +++ b/docs/modules/n1ql-rest-settings/partials/security/document-begin.adoc @@ -1,2 +1,2 @@ The Query Settings REST API supports HTTP basic authentication. -Credentials can be passed via HTTP headers. \ No newline at end of file +Pass your credentials through HTTP headers. \ No newline at end of file diff --git a/src/query-settings/query-settings.gradle b/docs/modules/n1ql-rest-settings/query-settings.gradle similarity index 82% rename from src/query-settings/query-settings.gradle rename to docs/modules/n1ql-rest-settings/query-settings.gradle index 2bcf8ac5..a0bda8d3 100644 --- a/src/query-settings/query-settings.gradle +++ b/docs/modules/n1ql-rest-settings/query-settings.gradle @@ -2,10 +2,10 @@ apply plugin: 'org.openapi.generator' openApiGenerate { generatorName = "asciidoc" - inputSpec = file("swagger/query-settings.yaml").getAbsolutePath().toString() + remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/morpheus/docs/spec/settings/settings.yaml" outputDir = "${rootDir}/docs/modules/n1ql-rest-settings/pages" templateDir = "${rootDir}/templates" - gitRepoId = "cb-swagger" + gitRepoId = "query" gitUserId = "couchbase" additionalProperties = [ specDir: "${rootDir}/docs/modules/n1ql-rest-settings/partials/", diff --git a/src/ns_server/swagger/new_spec.yaml b/docs/modules/ns_server/attachments/_new_spec.yaml similarity index 100% rename from src/ns_server/swagger/new_spec.yaml rename to docs/modules/ns_server/attachments/_new_spec.yaml diff --git a/src/ns_server/swagger/ns_server.yaml b/docs/modules/ns_server/attachments/_ns_server.yaml similarity index 100% rename from src/ns_server/swagger/ns_server.yaml rename to docs/modules/ns_server/attachments/_ns_server.yaml diff --git a/docs/modules/ns_server/readme.adoc b/docs/modules/ns_server/readme.adoc new file mode 100644 index 00000000..d1e1d107 --- /dev/null +++ b/docs/modules/ns_server/readme.adoc @@ -0,0 +1,3 @@ += ns_server + +This spec does not yet have an OpenAPI Generator gradle build script. \ No newline at end of file diff --git a/src/view_engine/swagger/view_engine.yaml b/docs/modules/view_engine/attachments/_view_engine.yaml similarity index 100% rename from src/view_engine/swagger/view_engine.yaml rename to docs/modules/view_engine/attachments/_view_engine.yaml diff --git a/docs/modules/view_engine/readme.adoc b/docs/modules/view_engine/readme.adoc new file mode 100644 index 00000000..6a68590e --- /dev/null +++ b/docs/modules/view_engine/readme.adoc @@ -0,0 +1,3 @@ += view_engine + +This spec does not yet have an OpenAPI Generator gradle build script. \ No newline at end of file diff --git a/docs/preview/AV-91970-8-0-docs-uptake-capella.yml b/docs/preview/AV-91970-8-0-docs-uptake-capella.yml new file mode 100644 index 00000000..0bccc737 --- /dev/null +++ b/docs/preview/AV-91970-8-0-docs-uptake-capella.yml @@ -0,0 +1,5 @@ +sources: + docs-capella: + branches: main + docs-devex: + branches: merge-80-capella \ No newline at end of file diff --git a/docs/preview/HEAD.yml b/docs/preview/HEAD.yml new file mode 100644 index 00000000..b6de9dcb --- /dev/null +++ b/docs/preview/HEAD.yml @@ -0,0 +1,5 @@ +sources: + docs-capella: + branches: main + docs-devex: + branches: capella \ No newline at end of file diff --git a/licenses/BSL-Couchbase.txt b/licenses/BSL-Couchbase.txt new file mode 100644 index 00000000..69d1b389 --- /dev/null +++ b/licenses/BSL-Couchbase.txt @@ -0,0 +1,104 @@ +COUCHBASE BUSINESS SOURCE LICENSE AGREEMENT + +Business Source License 1.1 +Licensor: Couchbase, Inc. +Licensed Work: Couchbase Server Version 8.0 +The Licensed Work is © 2021-Present Couchbase, Inc. + +Additional Use Grant: You may make production use of the Licensed Work, provided +you comply with the following conditions: + +(i) You may not prepare a derivative work based upon the Licensed Work and +distribute or otherwise offer such derivative work, whether on a standalone +basis or in combination with other products, applications, or services +(including in any "as-a-service" offering, such as, by way of example, a +software-as-a-service, database-as-a-service, or infrastructure-as-a-service +offering, or any other offering based on a cloud computing or other type of +hosted distribution model (collectively, "Hosted Offerings")), for a fee or +otherwise on a commercial or other for-profit basis. + +(ii) You may not link the Licensed Work to, or otherwise include the Licensed +Work in or with, any product, application, or service (including in any Hosted +Offering) that is distributed or otherwise offered, whether on a standalone +basis or in combination with other products, applications, or services for a fee +or otherwise on a commercial or other for-profit basis. Condition (ii) shall not +limit the generality of condition (i) above. + + +Change Date: March 1, 2029 + +Change License: Apache License, Version 2.0 + + +Notice + +The Business Source License (this document, or the "License") is not an Open +Source license. However, the Licensed Work will eventually be made available +under an Open Source License, as stated in this License. License text copyright +© 2017 MariaDB Corporation Ab, All Rights Reserved. "Business Source License" is +a trademark of MariaDB Corporation Ab. + +Terms + +The Licensor hereby grants You the right to copy, modify, create derivative +works, redistribute, and make non-production use of the Licensed Work. The +Licensor may make an Additional Use Grant, above, permitting limited production +use. + +Effective on the Change Date, or the fourth anniversary of the first publicly +available distribution of a specific version of the Licensed Work under this +License, whichever comes first, the Licensor hereby grants you rights under the +terms of the Change License, and the rights granted in the paragraph above +terminate. + +If your use of the Licensed Work does not comply with the requirements currently +in effect as described in this License, you must purchase a commercial license +from the Licensor, its affiliated entities, or authorized resellers, or you must +refrain from using the Licensed Work. + +All copies of the original and modified Licensed Work, and derivative works of +the Licensed Work, are subject to this License. This License applies separately +for each version of the Licensed Work and the Change Date may vary for each +version of the Licensed Work released by Licensor. + +You must conspicuously display this License on each original or modified copy of +the Licensed Work. If you receive the Licensed Work in original or modified form +from a third party, the terms and conditions set forth in this License apply to +your use of that work. + +Any use of the Licensed Work in violation of this License will automatically +terminate your rights under this License for the current and all other versions +of the Licensed Work. + +This License does not grant you any right in any trademark or logo of Licensor +or its affiliates (provided that you may use a trademark or logo of Licensor as +expressly required by this License). + +TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN +"AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS +OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE. + +MariaDB hereby grants you permission to use this License's text to license your +works, and to refer to it using the trademark "Business Source License", as long +as you comply with the Covenants of Licensor below. + +Covenants of Licensor + +In consideration of the right to use this License's text and the "Business +Source License" name and trademark, Licensor covenants to MariaDB, and to all +other recipients of the licensed work to be provided by Licensor: + +1. To specify as the Change License the GPL Version 2.0 or any later version, or +a license that is compatible with GPL Version 2.0 or a later version, where +"compatible" means that software provided under the Change License can be +included in a program with software provided under GPL Version 2.0 or a later +version. Licensor may specify additional Change Licenses without limitation. + +2. To either: (a) specify an additional grant of rights to use that does not +impose any additional restriction on the right granted in this License, as the +Additional Use Grant; or (b) insert the text "None". + +3. To specify a Change Date. + +4. Not to modify this License in any other way. diff --git a/settings.gradle b/settings.gradle index 0783ca6c..e8149391 100644 --- a/settings.gradle +++ b/settings.gradle @@ -2,33 +2,57 @@ rootProject.name = 'cb-swagger' include 'admin', 'query-settings', 'query-service', + 'eventing', 'functions', 'indexes', + 'index-settings', 'analytics-admin', 'analytics-config', 'analytics-library', 'analytics-links', 'analytics-service', - 'analytics-settings' -project(':admin').projectDir = new File (settingsDir, 'src/admin') + 'analytics-settings', + 'search-index', + 'search-nodes', + 'search-advanced', + 'search-stats', + 'search-query', + 'search-manage' +project(':admin').projectDir = new File (settingsDir, 'docs/modules/n1ql-rest-admin') project(':admin').buildFileName = 'admin.gradle' -project(':query-settings').projectDir = new File (settingsDir, 'src/query-settings') +project(':query-settings').projectDir = new File (settingsDir, 'docs/modules/n1ql-rest-settings') project(':query-settings').buildFileName = 'query-settings.gradle' -project(':query-service').projectDir = new File (settingsDir, 'src/query-service') +project(':query-service').projectDir = new File (settingsDir, 'docs/modules/n1ql-rest-query') project(':query-service').buildFileName = 'query-service.gradle' -project(':functions').projectDir = new File (settingsDir, 'src/functions') +project(':eventing').projectDir = new File (settingsDir, 'docs/modules/eventing-rest-api') +project(':eventing').buildFileName = 'eventing.gradle' +project(':functions').projectDir = new File (settingsDir, 'docs/modules/n1ql-rest-functions') project(':functions').buildFileName = 'functions.gradle' -project(':indexes').projectDir = new File (settingsDir, 'src/indexes') +project(':indexes').projectDir = new File (settingsDir, 'docs/modules/index-rest-stats') project(':indexes').buildFileName = 'indexes.gradle' -project(':analytics-service').projectDir = new File (settingsDir, 'src/analytics-service') +project(':index-settings').projectDir = new File (settingsDir, 'docs/modules/index-rest-settings') +project(':index-settings').buildFileName = 'index-settings.gradle' +project(':analytics-service').projectDir = new File (settingsDir, 'docs/modules/analytics-rest-service') project(':analytics-service').buildFileName = 'analytics-service.gradle' -project(':analytics-config').projectDir = new File (settingsDir, 'src/analytics-config') +project(':analytics-config').projectDir = new File (settingsDir, 'docs/modules/analytics-rest-config') project(':analytics-config').buildFileName = 'analytics-config.gradle' -project(':analytics-settings').projectDir = new File (settingsDir, 'src/analytics-settings') +project(':analytics-settings').projectDir = new File (settingsDir, 'docs/modules/analytics-rest-settings') project(':analytics-settings').buildFileName = 'analytics-settings.gradle' -project(':analytics-admin').projectDir = new File (settingsDir, 'src/analytics-admin') +project(':analytics-admin').projectDir = new File (settingsDir, 'docs/modules/analytics-rest-admin') project(':analytics-admin').buildFileName = 'analytics-admin.gradle' -project(':analytics-links').projectDir = new File (settingsDir, 'src/analytics-links') +project(':analytics-links').projectDir = new File (settingsDir, 'docs/modules/analytics-rest-links') project(':analytics-links').buildFileName = 'analytics-links.gradle' -project(':analytics-library').projectDir = new File (settingsDir, 'src/analytics-library') +project(':analytics-library').projectDir = new File (settingsDir, 'docs/modules/analytics-rest-library') project(':analytics-library').buildFileName = 'analytics-library.gradle' +project(':search-index').projectDir = new File (settingsDir, 'docs/modules/fts-rest-indexing') +project(':search-index').buildFileName = 'search-index.gradle' +project(':search-nodes').projectDir = new File (settingsDir, 'docs/modules/fts-rest-nodes') +project(':search-nodes').buildFileName = 'search-nodes.gradle' +project(':search-advanced').projectDir = new File (settingsDir, 'docs/modules/fts-rest-advanced') +project(':search-advanced').buildFileName = 'search-advanced.gradle' +project(':search-stats').projectDir = new File (settingsDir, 'docs/modules/fts-rest-stats') +project(':search-stats').buildFileName = 'search-stats.gradle' +project(':search-query').projectDir = new File (settingsDir, 'docs/modules/fts-rest-query') +project(':search-query').buildFileName = 'search-query.gradle' +project(':search-manage').projectDir = new File (settingsDir, 'docs/modules/fts-rest-manage') +project(':search-manage').buildFileName = 'search-manage.gradle' diff --git a/src/admin/swagger/admin.yaml b/src/admin/swagger/admin.yaml deleted file mode 100644 index e09ecb9c..00000000 --- a/src/admin/swagger/admin.yaml +++ /dev/null @@ -1,2259 +0,0 @@ -openapi: 3.0.3 -info: - title: Query Admin REST API - version: capella - description: | - The Query Admin REST API is a secondary API provided by the Query service. - This API enables you to retrieve statistics about the clusters and nodes running the Query service; view or specify node-level settings; and view or delete requests. - -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 Query service. - port: - default: "8093" - description: |- - The Query service REST port. - Use `18093` for secure access. - enum: - - "8093" - - "18093" - -tags: - - name: configuration - description: Operations for cluster and node configuration. - - name: prepared statements - description: Operations for prepared statements. - - name: active requests - description: Operations for active requests. - - name: completed requests - description: Operations for completed requests. - - name: statistics - description: Operations for query statistics. - - name: settings - description: Operations for query settings. - - name: default - description: Other operations. - -# The output of this spec is used in more than one location, so Markdown cannot use relative links. -# Absolute links begin with /cloud -- this must be replaced for every branch. -# Relative links point to a location relative to the REST API reference page by default. -# The x-desc-refs attribute is used to override links when content is transcluded to other locations. - -# The AsciiDoc Markdown converter does not recognize HTML tags like . -# Use the x-desc-name vendor extension to specify the anchor for a property. - -paths: - /admin/clusters: - get: - operationId: get_clusters - summary: Read All Clusters - description: Returns information about all clusters. - tags: - - configuration - security: - - Default: [] - responses: - 200: - description: An array of objects, each of which gives information about one cluster. - content: - application/json: - schema: - type: array - items: - $ref: "#/components/schemas/Clusters" - - /admin/clusters/{cluster}: - get: - operationId: get_cluster - summary: Read a Cluster - parameters: - - $ref: "#/components/parameters/PathCluster" - description: Returns information about the specified cluster. - tags: - - configuration - security: - - Default: [] - responses: - 200: - description: An object giving information about the specified cluster. - content: - application/json: - schema: - $ref: "#/components/schemas/Clusters" - - /admin/clusters/{cluster}/nodes: - get: - operationId: get_nodes - summary: Read All Nodes - parameters: - - $ref: "#/components/parameters/PathCluster" - description: Returns information about all nodes in the specified cluster. - tags: - - configuration - security: - - Default: [] - responses: - 200: - description: An array of objects, each of which gives information about one node. - content: - application/json: - schema: - type: array - items: - $ref: "#/components/schemas/Nodes" - - /admin/clusters/{cluster}/nodes/{node}: - get: - operationId: get_node - summary: Read a Node - parameters: - - $ref: "#/components/parameters/PathCluster" - - $ref: "#/components/parameters/PathNode" - description: Returns information about the specified node in the specified cluster. - tags: - - configuration - security: - - Default: [] - responses: - 200: - description: An object giving information about the specified node. - content: - application/json: - schema: - $ref: "#/components/schemas/Nodes" - - /admin/config: - get: - operationId: get_config - summary: Read Configuration - description: Returns the configuration of the query service on the cluster. - tags: - - configuration - security: - - Default: [] - responses: - 200: - description: An object giving information about the specified node. - content: - application/json: - schema: - $ref: "#/components/schemas/Nodes" - - /admin/prepareds: - get: - operationId: get_prepareds - summary: Retrieve All Prepared Statements - description: | - Returns all prepared statements. - tags: - - prepared statements - security: - - Default: [] - responses: - 200: - description: An array of objects, each of which contains information about one prepared statement. - content: - application/json: - schema: - type: array - items: - $ref: "#/components/schemas/Statements" - - /admin/prepareds/{name}: - get: - operationId: get_prepared - summary: Retrieve a Prepared Statement - parameters: - - $ref: "#/components/parameters/PathName" - description: | - Returns the specified prepared statement. - tags: - - prepared statements - security: - - Default: [] - responses: - 200: - description: An object containing information about the specified prepared statement. - content: - application/json: - schema: - $ref: "#/components/schemas/Statements" - delete: - operationId: delete_prepared - summary: Delete a Prepared Statement - parameters: - - $ref: "#/components/parameters/PathName" - description: | - Deletes the specified prepared statement. - tags: - - prepared statements - security: - - Default: [] - responses: - 200: - description: The prepared statement was successfully deleted. - 500: - description: Returns an error message if the prepared statement could not be found. - content: - application/json: - schema: - type: object - - /admin/active_requests: - get: - operationId: get_active_requests - summary: Retrieve All Active Requests - description: | - Returns all active query requests. - tags: - - active requests - security: - - Default: [] - responses: - 200: - description: An array of objects, each of which contains information about one active request. - content: - application/json: - schema: - type: array - items: - $ref: "#/components/schemas/Requests" - - /admin/active_requests/{request}: - get: - operationId: get_active_request - summary: Retrieve an Active Request - parameters: - - $ref: "#/components/parameters/PathRequest" - description: | - Returns the specified active query request. - tags: - - active requests - security: - - Default: [] - responses: - 200: - description: An object containing information about the specified active request. - content: - application/json: - schema: - $ref: "#/components/schemas/Requests" - delete: - operationId: delete_active_request - summary: Delete an Active Request - parameters: - - $ref: "#/components/parameters/PathRequest" - description: | - Terminates the specified active query request. - tags: - - active requests - security: - - Default: [] - responses: - 200: - description: The active request was successfully terminated. - 500: - description: Returns an error message if the active request could not be found. - content: - application/json: - schema: - type: object - - /admin/completed_requests: - get: - operationId: get_completed_requests - summary: Retrieve All Completed Requests - description: | - Returns all completed requests. - tags: - - completed requests - security: - - Default: [] - responses: - 200: - description: An array of objects, each of which contains information about one completed request. - content: - application/json: - schema: - type: array - items: - $ref: "#/components/schemas/Requests" - - /admin/completed_requests/{request}: - get: - operationId: get_completed_request - summary: Retrieve a Completed Request - parameters: - - $ref: "#/components/parameters/PathRequest" - description: | - Returns the specified completed request. - tags: - - completed requests - security: - - Default: [] - responses: - 200: - description: An object containing information about the specified completed request. - content: - application/json: - schema: - $ref: "#/components/schemas/Requests" - delete: - operationId: delete_completed_request - summary: Delete a Completed Request - parameters: - - $ref: "#/components/parameters/PathRequest" - description: | - Purges the specified completed request. - tags: - - completed requests - security: - - Default: [] - responses: - 200: - description: The completed request was successfully purged. - 500: - description: Returns an error message if the completed request could not be found. - content: - application/json: - schema: - type: object - - /admin/indexes/prepareds: - get: - operationId: get_prepared_indexes - summary: Retrieve Prepared Index Statements - description: | - Returns all prepared index statements. - - * Use [Retrieve a Prepared Statement](#get_prepared) to get information about a prepared index statement. - * Use [Delete a Prepared Statement](#delete_prepared) to delete a prepared index statement. - tags: - - prepared statements - security: - - Default: [] - responses: - 200: - description: An array of strings, each of which is the name of a prepared index statement. - content: - application/json: - schema: - type: array - items: - type: string - description: | - The name of the prepared statement. - This may be a UUID that was assigned automatically, or a name that was user-specified when the statement was created. - - /admin/indexes/active_requests: - get: - operationId: get_active_indexes - summary: Retrieve Active Index Requests - description: | - Returns all active index requests. - - * Use [Retrieve an Active Request](#get_active_request) to get information about an active index request. - * Use [Delete an Active Request](#delete_active_request) to terminate an active index request. - tags: - - active requests - security: - - Default: [] - responses: - 200: - description: An array of strings, each of which is the requestID of an active index request. - content: - application/json: - schema: - type: array - items: - type: string - description: Unique request ID internally generated for the query. - - /admin/indexes/completed_requests: - get: - operationId: get_completed_indexes - summary: Retrieve Completed Index Requests - description: | - Returns all completed index requests. - - * Use [Retrieve a Completed Request](#get_completed_request) to get information about a completed index request. - * Use [Delete a Completed Request](#delete_completed_request) to purge a completed index request. - tags: - - completed requests - security: - - Default: [] - responses: - 200: - description: An array of strings, each of which is the requestID of a completed index request. - content: - application/json: - schema: - type: array - items: - type: string - description: Unique request ID internally generated for the query. - - /admin/ping: - get: - operationId: get_ping - summary: Ping - description: Returns a minimal response, indicating that the service is running and reachable. - tags: - - default - responses: - 200: - description: An empty object. - content: - application/json: - schema: - type: object - - /admin/gc: - get: - operationId: get_gc - summary: Run Garbage Collector - description: | - This endpoint is available in databases running Couchbase Server 7.6.0 and later. - - Runs the garbage collector. - - A message is written to `query.log` whenever the garbage collector endpoint is invoked. - tags: - - default - security: - - Default: [] - responses: - 200: - description: Indicates that the garbage collector was invoked. - content: - application/json: - schema: - $ref: "#/components/schemas/Garbage" - 401: - description: | - Error 10000: authentication failure. - The invoking user is not a valid full-admin user. - content: - application/json: - schema: - type: object - post: - operationId: post_gc - summary: Run Garbage Collector and Release Memory - description: | - This endpoint is available in databases running Couchbase Server 7.6.0 and later. - - Runs the garbage collector and attempts to return freed memory to the OS. - - A message is written to `query.log` whenever the garbage collector endpoint is invoked. - tags: - - default - security: - - Default: [] - responses: - 200: - description: Indicates that the garbage collector was invoked. - content: - application/json: - schema: - $ref: "#/components/schemas/Garbage" - 401: - description: | - Error 10000: authentication failure. - The invoking user is not a valid full-admin user. - content: - application/json: - schema: - type: object - - # /admin/ssl_cert: - # get: - # deprecated: true - - /admin/vitals: - get: - operationId: get_vitals - summary: Retrieve Vitals - description: | - Returns data about the running state and health of the query engine. - This information can be very useful to assess the current workload and performance characteristics of a query engine, and hence load-balance the requests being sent to various query engines. - tags: - - statistics - security: - - Default: [] - responses: - 200: - description: An object containing all vital statistics. - content: - application/json: - schema: - $ref: "#/components/schemas/Vitals" - - /admin/stats: - get: - operationId: get_stats - summary: Retrieve All Statistics - description: Returns all statistics. - tags: - - statistics - security: - - Default: [] - responses: - 200: - description: | - An object containing all statistics. - Each statistic consists of a top-level statistic name and a metric name. - Each statistic has a different set of metrics. - content: - application/json: - schema: - $ref: "#/components/schemas/Statistics" - - /admin/stats/{stat}: - get: - operationId: get_stat - summary: Retrieve a Statistic - parameters: - - $ref: "#/components/parameters/PathStat" - description: Returns the specified statistic. - tags: - - statistics - security: - - Default: [] - responses: - 200: - description: | - An object containing all metrics for the specified statistic. - Each statistic has a different set of metrics. - content: - application/json: - schema: - $ref: "#/components/schemas/Metrics" - - /debug/vars: - get: - operationId: get_debug_vars - summary: Get Debug Variables - description: Currently unused. - tags: - - statistics - responses: - 302: - description: Redirects to the [Retrieve All Statistics](#get_stats) endpoint. - content: - text/html: - schema: - type: string - format: text/html - - /admin/settings: - get: - operationId: get_settings - summary: Retrieve Node-Level Query Settings - description: | - Returns node-level query settings. - tags: - - settings - security: - - Default: [] - responses: - 200: - description: An object giving node-level query settings. - content: - application/json: - schema: - $ref: "#/components/schemas/Settings" - post: - operationId: post_settings - summary: Update Node-Level Query Settings - description: | - Updates node-level query settings. - tags: - - settings - security: - - Default: [] - requestBody: - description: An object specifying node-level query settings. - content: - application/json: - schema: - $ref: "#/components/schemas/Settings" - application/x-www-form-urlencoded: - schema: - $ref: "#/components/schemas/Settings" - responses: - 200: - description: An object giving node-level query settings, including the latest changes. - content: - application/json: - schema: - $ref: "#/components/schemas/Settings" - -components: - schemas: - Clusters: - type: object - title: Cluster Information - properties: - name: - type: string - description: The name of the cluster. - datastore: - type: string - description: The URL of the datastore. - configstore: - type: string - description: The URL of the configstore. - accountstore: - type: string - description: The URL of the accountstore. - version: - type: string - - Nodes: - type: object - title: Node Information - properties: - cluster: - type: string - description: The name of the cluster. - name: - type: string - description: The URL of the node, including port number. - queryEndpoint: - type: string - description: The HTTP URL of the query endpoint. - adminEndpoint: - type: string - description: The HTTP URL of the admin endpoint. - querySecure: - type: string - description: The HTTPS URL of the query endpoint. - adminSecure: - type: string - description: The HTTPS URL of the admin endpoint. - options: - type: string - - Requests: - type: object - title: Requests - properties: - clientContextID: - type: string - description: | - The opaque ID or context provided by the client. - Refer to the [request-level][client_context_id] `client_context_id` parameter for more information. - - [client_context_id]: ../n1ql-rest-query/index.html#client_context_id - x-desc-refs: | - [client_context_id]: #client_context_id - elapsedTime: - type: string - format: duration - description: | - The time taken from when the request was acknowledged by the service to when the request was completed. - It includes the time taken by the service to schedule the request. - errorCount: - type: integer - description: Total number of errors encountered while executing the query. - memoryQuota: - type: integer - description: | - The memory quota for the request, in MB. - This property is only returned if a memory quota is set for the query. - node: - type: string - description: IP address and port number of the node where the query is executed. - phaseCounts: - type: object - description: | - Count of documents processed at selective phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc. - - For active requests, this property is dynamic, depending on the documents processed by various phases up to this moment in time. - Polling the active requests again may return different values. - example: - { - "fetch": 16, - "indexScan": 187 - } - x-has-example: true - phaseOperators: - type: object - description: | - Indicates the numbers of each kind of query operator involved in different phases of the query processing. - - For instance, a non-covering index path might involve one index scan and one fetch operator. - A join would probably involve two or more fetches, one per keyspace. - A union select would have twice as many operator counts, one per each branch of the union. - example: - { - "authorize": 1, - "fetch": 1, - "indexScan": 2 - } - x-has-example: true - phaseTimes: - type: object - description: | - Cumulative execution times for various phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc. - - For active requests, this property is dynamic, depending on the documents processed by various phases up to this moment in time. - Polling the active requests again may return different values. - example: - { - "authorize": "823.631µs", - "fetch": "656.873µs", - "indexScan": "29.146543ms", - "instantiate": "236.221µs", - "parse": "826.382µs", - "plan": "11.831101ms", - "run": "16.892181ms" - } - x-has-example: true - remoteAddr: - type: string - description: IP address and port number of the client application, from where the query is received. - requestId: - type: string - format: uuid - description: Unique request ID internally generated for the query. - requestTime: - type: string - format: date-time - description: Timestamp when the query is received. - resultCount: - type: integer - description: Total number of documents returned in the query result. - resultSize: - type: integer - description: Total number of bytes returned in the query result. - scanConsistency: - type: string - description: The value of the query setting Scan Consistency used for the query. - serviceTime: - type: string - format: duration - description: Total amount of calendar time taken to complete the query. - state: - type: string - description: | - The state of the query execution, such as `completed`, `running`, `cancelled`. - - Note that the `completed` state means that the request was started and completed by the Query service, but it does not mean that it was necessarily successful. - The request could have been successful, or completed with errors. - - To find requests that were successful, use this field in conjunction with the `errorCount` field: search for requests whose state is `completed` and whose error count is `0`. - statement: - type: string - description: The query statement being executed. - useCBO: - type: boolean - description: Whether the cost-based optimizer is enabled for the query. - usedMemory: - type: integer - description: | - The amount of document memory used to execute the request. - This property is only returned if a memory quota is set for the query. - userAgent: - type: string - description: Name of the client application or program that issued the query. - users: - type: string - description: Username with whose privileges the query is run. - - Statements: - type: object - title: Prepared Statements - required: - - encoded_plan - - name - - statement - - uses - properties: - encoded_plan: - type: string - description: The full prepared statement in encoded format. - featureControls: - type: integer - description: | - This property is provided for technical support only. - It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - indexApiVersion: - type: integer - description: | - This property is provided for technical support only. - It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - name: - type: string - description: | - The name of the prepared statement. - This may be a UUID that was assigned automatically, or a name that was user-specified when the statement was created. - namespace: - type: string - description: | - The namespace in which the prepared statement is stored. - Currently, only the `default` namespace is available. - node: - type: string - description: | - The node on which the prepared statement is stored. - statement: - type: string - description: The text of the query. - uses: - type: integer - description: The count of times the prepared statement has been executed. - avgElapsedTime: - type: string - format: duration - description: | - The mean time taken from when the request to execute the prepared statement was acknowledged by the service, to when the request was completed. - It includes the time taken by the service to schedule the request. - - This property is only returned when the prepared statement has been executed. - It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - avgServiceTime: - type: string - format: duration - description: | - The mean amount of calendar time taken to complete the execution of the prepared statement. - - This property is only returned when the prepared statement has been executed. - It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - lastUse: - type: string - format: date-time - description: | - Date and time of last use. - - This property is only returned when the prepared statement has been executed. - maxElapsedTime: - type: string - format: duration - description: | - The maximum time taken from when the request to execute the prepared statement was acknowledged by the service, to when the request was completed. - It includes the time taken by the service to schedule the request. - - This property is only returned when the prepared statement has been executed. - It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - maxServiceTime: - type: string - format: duration - description: | - The maximum amount of calendar time taken to complete the execution of the prepared statement. - - This property is only returned when the prepared statement has been executed. - It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - minElapsedTime: - type: string - format: duration - description: | - The minimum time taken from when the request to execute the prepared statement was acknowledged by the service, to when the request was completed. - It includes the time taken by the service to schedule the request. - - This property is only returned when the prepared statement has been executed. - It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - minServiceTime: - type: string - format: duration - description: | - The minimum amount of calendar time taken to complete the execution of the prepared statement. - - This property is only returned when the prepared statement has been executed. - It is only returned when retrieving a specific prepared statement, not when retrieving all prepared statements. - - Vitals: - type: object - title: Vital Statistics - properties: - bucket.IO.stats: - type: object - description: The number of reads and retries for each bucket. - uptime: - type: string - format: duration - description: The uptime of the query engine. - local.time: - type: string - format: date-time - description: The local time of the query engine. - version: - type: string - description: The version of the query engine. - total.threads: - type: integer - description: The number of active threads used by the query engine. - cores: - type: integer - description: The maximum number of logical cores available to the query engine. - ffdc.total: - type: integer - description: The total number of times FFDC has been invoked since the last restart. - gc.num: - type: integer - format: int64 - description: The target heap size of the next garbage collection cycle. - gc.pause.time: - type: string - format: duration - description: The total time spent pausing for garbage collection since the query engine started (ns). - gc.pause.percent: - type: integer - format: int64 - description: The percentage of time spent pausing for garbage collection since the last time the statistics were checked. - healthy: - type: boolean - description: False when either the unbounded or plus request queues are full; true otherwise. - host.memory.free: - type: integer - format: int64 - description: Amount of free memory on the host. - host.memory.quota: - type: integer - format: int64 - description: | - The host memory quota. - This reflects the node-quota setting. - host.memory.total: - type: integer - format: int64 - description: Total memory on the host. - host.memory.value_quota: - type: integer - format: int64 - description: This the total document memory quota on the node. - load: - type: integer - description: A calculation for how busy the server is. - loadfactor: - type: integer - description: The moving 15 minute average of the load calculation. - memory.usage: - type: integer - format: int64 - description: | - The amount of memory allocated for heap objects (bytes). - This increases as heap objects are allocated, and decreases as objects are freed. - memory.total: - type: integer - format: int64 - description: | - The cumulative amount of memory allocated for heap objects (bytes). - This increases as heap objects are allocated, but does not decrease when objects are freed. - memory.system: - type: integer - format: int64 - description: | - The total amount of memory obtained from the operating system (bytes). - This measures the virtual address space reserved by the query engine for heaps, stacks, and other internal data structures. - node: - type: string - description: The name or IP address and port of the node. - node.allocated.values: - type: integer - description: | - The total number of values allocated to contain documents or computations around documents. - (This is only of relevance internally.) - node.memory.usage: - type: integer - description: The currently allocated document memory on the node. - cpu.user.percent: - type: integer - format: int64 - description: | - CPU usage. - The percentage of time spent executing user code since the last time the statistics were checked. - cpu.sys.percent: - type: integer - format: int64 - description: | - CPU usage. - The percentage of time spent executing system code since the last time the statistics were checked. - process.memory.usage: - type: integer - description: Current process memory use. - process.percore.cpupercent: - type: number - description: Average CPU usage per core. - process.rss: - type: integer - description: Process RSS (bytes) - process.service.usage: - type: integer - description: The number of active servicers for the dominant workload — unbound queue servicers or plus queue servicers. - request.completed.count: - type: integer - description: Total number of completed requests. - request.active.count: - type: integer - description: Total number of active requests. - request.per.sec.1min: - type: number - description: | - Number of query requests processed per second. - 1-minute exponentially weighted moving average. - request.per.sec.5min: - type: number - description: | - Number of query requests processed per second. - 5-minute exponentially weighted moving average. - request.per.sec.15min: - type: number - description: | - Number of query requests processed per second. - 15-minute exponentially weighted moving average. - request.queued.count: - type: integer - description: Number of queued requests. - request.quota.used.hwm: - type: integer - description: High water mark for request quota use. - request_time.mean: - type: string - format: duration - description: | - End-to-end time to process a query. - The mean value. - request_time.median: - type: string - format: duration - description: | - End-to-end time to process a query. - The median value. - request_time.80percentile: - type: string - format: duration - description: | - End-to-end time to process a query. - The 80th percentile. - request_time.95percentile: - type: string - format: duration - description: | - End-to-end time to process a query. - The 95th percentile. - request_time.99percentile: - type: string - format: duration - description: | - End-to-end time to process a query. - The 99th percentile. - request.prepared.percent: - type: integer - description: Percentage of requests that are prepared statements. - servicers.paused.count: - type: integer - description: | - Number of servicers temporarily paused due to memory pressure. - (Applies to serverless environments only.) - servicers.paused.total: - type: integer - description: | - Number of times servicers have been temporarily paused. - (Applies to serverless environments only.) - temp.hwm: - type: integer - description: | - High water mark for temp space use directly by query. - (Doesn't include use by the GSI and FTS clients.) - temp.usage: - type: integer - description: | - Current Query temp space use. - (Doesn't include use by the GSI and FTS clients.) - - Statistics: - type: object - title: Statistics - properties: - active_requests.count: - type: integer - description: Total number of active requests. - at_plus.count: - type: integer - description: Total number of query requests with `at_plus` index consistency. - audit_actions.count: - type: integer - description: | - The total number of audit records sent to the server. - Some requests cause more than one audit record to be emitted. - Records in the output queue that have not yet been sent to the server are not counted. - audit_actions_failed.count: - type: integer - description: The total number of audit records sent to the server that failed. - audit_requests_filtered.count: - type: integer - description: The number of potentially auditable requests that cause no audit action to be taken. - audit_requests_total.count: - type: integer - description: The total number of potentially auditable requests sent to the query engine. - cancelled.count: - type: integer - description: Total number of cancelled requests. - deletes.count: - type: integer - description: Total number of DELETE operations. - errors.count: - type: integer - description: The total number of query errors returned so far. - index_scans.count: - type: integer - description: Total number of secondary index scans. - inserts.count: - type: integer - description: Total number of INSERT operations. - invalid_requests.count: - type: integer - description: Total number of requests for unsupported endpoints. - mutations.count: - type: integer - description: Total number of document mutations. - prepared.count: - type: integer - description: Total number of prepared statements executed. - primary_scans.count: - type: integer - description: Total number of primary index scans. - queued_requests.count: - type: integer - description: Total number of queued requests. - request_time.count: - type: integer - description: Total end-to-end time to process all queries (ns). - request_timer.15m.rate: - type: number - description: | - Number of query requests processed per second. - 15-minute exponentially weighted moving average. - request_timer.1m.rate: - type: number - description: | - Number of query requests processed per second. - 1-minute exponentially weighted moving average. - request_timer.5m.rate: - type: number - description: | - Number of query requests processed per second. - 5-minute exponentially weighted moving average. - request_timer.75%: - type: number - description: | - End-to-end time to process a query (ns). - The 75th percentile. - request_timer.95%: - type: number - description: | - End-to-end time to process a query (ns). - The 95th percentile. - request_timer.99%: - type: number - description: | - End-to-end time to process a query (ns). - The 99th percentile. - request_timer.99.9%: - type: number - description: | - End-to-end time to process a query (ns). - The 99.9th percentile. - request_timer.count: - type: integer - description: Total number of query requests. - request_timer.max: - type: integer - description: | - End-to-end time to process a query (ns). - The maximum value. - request_timer.mean: - type: number - description: | - End-to-end time to process a query (ns). - The mean value. - request_timer.mean.rate: - type: number - description: | - Number of query requests processed per second. - Mean rate since the query service started. - request_timer.median: - type: number - description: | - End-to-end time to process a query (ns). - The median value. - request_timer.min: - type: integer - description: | - End-to-end time to process a query (ns). - The minimum value. - request_timer.stddev: - type: number - description: | - End-to-end time to process a query (ns). - The standard deviation. - requests.count: - type: integer - description: Total number of query requests. - requests_1000ms.count: - type: integer - description: Number of queries that take longer than 1000ms. - requests_250ms.count: - type: integer - description: Number of queries that take longer than 250ms. - requests_5000ms.count: - type: integer - description: Number of queries that take longer than 5000ms. - requests_500ms.count: - type: integer - description: Number of queries that take longer than 500ms. - result_count.count: - type: integer - description: Total number of results (documents) returned by the query engine. - result_size.count: - type: integer - description: Total size of data returned by the query engine (bytes). - scan_plus.count: - type: integer - description: Total number of query requests with `request_plus` index consistency. - selects.count: - type: integer - description: Total number of SELECT requests. - service_time.count: - type: integer - description: Time to execute all queries (ns). - unbounded.count: - type: integer - description: Total number of query requests with `not_bounded` index consistency. - updates.count: - type: integer - description: Total number of UPDATE requests. - warnings.count: - type: integer - description: The total number of query warnings returned so far. - - Metrics: - type: object - title: Metrics - properties: - count: - type: integer - description: A single value that represents the current state. - 15m.rate: - type: number - description: 15-minute exponentially weighted moving average. - 1m.rate: - type: number - description: 1-minute exponentially weighted moving average. - 5m.rate: - type: number - description: 5-minute exponentially weighted moving average. - mean.rate: - type: number - description: Mean rate since the query service started. - max: - type: integer - description: The maximum value. - mean: - type: number - description: The mean value. - median: - type: number - description: The median value. - min: - type: integer - description: The minimum value. - stddev: - type: number - description: The standard deviation. - 75%: - type: number - description: The 75th percentile. - 95%: - type: number - description: The 95th percentile. - 99%: - type: number - description: The 99th percentile. - 99.9%: - type: number - description: The 99.9th percentile. - - Settings: - type: object - title: Settings - properties: - atrcollection: - type: string - default: "" - example: default:`travel-sample`.transaction.test - x-has-default: true - x-has-example: true - x-desc-name: atrcollection-srv - description: | - Specifies the collection where [active transaction records][additional-storage-use] are stored. - The collection must be present. - If not specified, the active transaction record is stored in the default collection in the default scope in the bucket containing the first mutated document within the transaction. - - The value must be a string in the form `"bucket.scope.collection"` or `"namespace:bucket.scope.collection"`. - If any part of the path contains a special character, that part of the path must be delimited in backticks ``. - - The [request-level][atrcollection_req] `atrcollection` parameter specifies this property per request. - If a request does not include this parameter, the node-level `atrcollection` setting will be used. - - [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries - [atrcollection_req]: ../n1ql-rest-query/index.html#atrcollection_req - x-desc-refs: | - [atrcollection_req]: #atrcollection_req - auto-prepare: - type: boolean - default: false - example: true - x-has-default: true - x-has-example: true - x-desc-name: auto-prepare - description: | - Specifies whether the query engine should create a prepared statement every time a SQL++ request is submitted, whether the PREPARE statement is included or not. - - Refer to [Auto-Prepare][auto-prepare] for more information. - - [auto-prepare]: /cloud/n1ql/n1ql-language-reference/prepare.html#auto-prepare - - cleanupclientattempts: - type: boolean - default: true - example: false - x-has-default: true - x-has-example: true - x-desc-name: cleanupclientattempts - description: | - When enabled, the Query service preferentially aims to clean up just transactions that it has created, leaving transactions for the distributed cleanup process only when it is forced to. - - The [cluster-level][queryCleanupClientAttempts] `queryCleanupClientAttempts` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [queryCleanupClientAttempts]: ../n1ql-rest-settings/index.html#queryCleanupClientAttempts - x-desc-refs: | - [queryCleanupClientAttempts]: #queryCleanupClientAttempts - cleanuplostattempts: - type: boolean - default: true - example: false - x-has-default: true - x-has-example: true - x-desc-name: cleanuplostattempts - description: | - When enabled, the Query service takes part in the distributed cleanup process, and cleans up expired transactions created by any client. - - The [cluster-level][queryCleanupLostAttempts] `queryCleanupLostAttempts` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [queryCleanupLostAttempts]: ../n1ql-rest-settings/index.html#queryCleanupLostAttempts - x-desc-refs: | - [queryCleanupLostAttempts]: #queryCleanupLostAttempts - cleanupwindow: - type: string - format: duration - default: 60s - example: 30s - x-has-default: true - x-has-example: true - x-desc-name: cleanupwindow - description: | - Specifies how frequently the Query service checks its subset of [active transaction records][additional-storage-use] for cleanup. - Decreasing this setting causes expiration transactions to be found more swiftly, with the tradeoff of increasing the number of reads per second used for the scanning process. - - The value for this setting is a string. - Its format includes an amount and a mandatory unit, e.g. `10ms` (10 milliseconds) or `0.5s` (half a second). - Valid units are: - - * `ns` (nanoseconds) - * `us` (microseconds) - * `ms` (milliseconds) - * `s` (seconds) - * `m` (minutes) - * `h` (hours) - - The [cluster-level][queryCleanupWindow] `queryCleanupWindow` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries - [queryCleanupWindow]: ../n1ql-rest-settings/index.html#queryCleanupWindow - x-desc-refs: | - [queryCleanupWindow]: #queryCleanupWindow - completed: - type: object - title: Logging Parameters - default: {"aborted": null, "threshold": 1000} - example: {"user": "marco", "error": 12003} - x-desc-name: completed - description: | - A nested object that sets the parameters for the completed requests catalog. - All completed requests that match these parameters are tracked in the completed requests catalog. - - Refer to [Configure the Completed Requests][sys-completed-config] for more information and examples. - - [sys-completed-config]: /cloud/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config - properties: - aborted: - type: boolean - default: null - example: true - x-has-default: true - x-has-example: true - description: If true, all requests that generate a panic are logged. - client: - type: string - default: "" - example: "172.1.2.3" - x-has-default: true - x-has-example: true - description: | - The IP address of the client. - If specified, all completed requests from this IP address are logged. - context: - type: string - description: | - The opaque ID or context provided by the client. - If specified, all completed requests with this client context ID are logged. - - Refer to the [request-level][client_context_id] `client_context_id` parameter for more information. - - [client_context_id]: ../n1ql-rest-query/index.html#client_context_id - x-desc-refs: | - [client_context_id]: #client_context_id - error: - type: integer - format: int32 - default: null - example: 12003 - x-has-default: true - x-has-example: true - description: | - An error number. - If specified, all completed queries returning this error number are logged. - tag: - type: string - default: "" - example: "both_user_and_error" - x-has-default: true - x-has-example: true - description: | - A unique string which tags a set of qualifiers. - - Refer to [Configure the Completed Requests][sys-completed-config] for more information. - - [sys-completed-config]: /cloud/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config - threshold: - type: integer - format: int32 - default: 1000 - example: 7000 - x-has-default: true - x-has-example: true - description: | - A duration in milliseconds. - If specified, all completed queries lasting longer than this threshold are logged. - - This is another way of specifying the [node-level](#completed-threshold) `completed-threshold` setting. - user: - type: string - default: "" - example: "marco" - x-has-default: true - x-has-example: true - description: | - A user name, as given in the request credentials. - If specified, all completed queries with this user name are logged. - completed-limit: - type: integer - format: int32 - default: 4000 - example: 7000 - x-has-default: true - x-has-example: true - x-desc-name: completed-limit - description: | - Sets the number of requests to be logged in the completed requests catalog. - As new completed requests are added, old ones are removed. - - Increase this when the completed request keyspace is not big enough to track the slow requests, such as when you want a larger sample of slow requests. - - Refer to [Configure the Completed Requests][sys-completed-config] for more information and examples. - - The [cluster-level][queryCompletedLimit] `queryCompletedLimit` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [sys-completed-config]: /cloud/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config - [queryCompletedLimit]: ../n1ql-rest-settings/index.html#queryCompletedLimit - x-desc-refs: | - [queryCompletedLimit]: #queryCompletedLimit - completed-max-plan-size: - type: integer - format: int32 - default: 262144 - minimum: 0 - maximum: 20840448 - x-has-default: true - x-desc-name: completed-max-plan-size - x-desc-status: Couchbase Server 7.6 - description: | - This property is available in databases running Couchbase Server 7.6.0 and later. - - A plan size in bytes. - Limits the size of query execution plans that can be logged in the completed requests catalog. - Values larger than the maximum limit are silently treated as the maximum limit. - Queries with plans larger than this are not logged. - You must obtain execution plans for such queries via profiling or using the EXPLAIN statement. - - Refer to [Configure the Completed Requests][sys-completed-config] for more information. - - The [cluster-level][queryCompletedMaxPlanSize] `queryCompletedMaxPlanSize` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [sys-completed-config]: /cloud/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config - [queryCompletedMaxPlanSize]: ../n1ql-rest-settings/index.html#queryCompletedMaxPlanSize - x-desc-refs: | - [queryCompletedMaxPlanSize]: #queryCompletedMaxPlanSize - completed-threshold: - type: integer - format: int32 - default: 1000 - example: 7000 - x-has-default: true - x-has-example: true - x-desc-name: completed-threshold - description: | - A duration in milliseconds. - All completed queries lasting longer than this threshold are logged in the completed requests catalog. - - Specify `0` to track all requests, independent of duration. - Specify any negative number to track none. - - Refer to [Configure the Completed Requests][sys-completed-config] for more information and examples. - - The [cluster-level][queryCompletedThreshold] `queryCompletedThreshold` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [sys-completed-config]: /cloud/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config - [queryCompletedThreshold]: ../n1ql-rest-settings/index.html#queryCompletedThreshold - x-desc-refs: | - [queryCompletedThreshold]: #queryCompletedThreshold - controls: - type: boolean - default: false - example: true - x-has-default: true - x-has-example: true - x-desc-name: controls-srv - description: | - Specifies if there should be a controls section returned with the request results. - - When set to `true`, the query response document includes a controls section with runtime information provided along with the request, such as positional and named parameters or settings. - - NOTE: If the request qualifies for caching, these values will also be cached in the `completed_requests` system keyspace. - - The [request-level][controls_req] `controls` parameter specifies this property per request. - If a request does not include this parameter, the node-level `controls` setting will be used. - - [controls_req]: ../n1ql-rest-query/index.html#controls_req - x-desc-refs: | - [controls_req]: #controls_req - cpuprofile: - type: string - default: "" - example: /tmp/info.txt - x-has-default: true - x-has-example: true - x-desc-name: cpuprofile - description: | - The absolute path and filename to write the CPU profile to a local file. - - The output file includes a controls section and performance measurements, such as memory allocation and garbage collection, to pinpoint bottlenecks and ways to improve your code execution. - - NOTE: If `cpuprofile` is left running too long, it can slow the system down as its file size increases. - - To stop `cpuprofile`, run with the empty setting of `""`. - debug: - type: boolean - default: false - example: true - x-has-default: true - x-has-example: true - x-desc-name: debug - description: | - Use debug mode. - - When set to `true`, extra logging is provided. - distribute: - type: boolean - example: true - x-has-example: true - x-desc-name: distribute - description: | - This field is only available with the POST method. - When specified alongside other settings, this field instructs the node that is processing the request to cascade those settings to all other query nodes. - The actual value of this field is ignored. - functions-limit: - type: integer - format: int32 - default: 16384 - example: 7000 - x-has-default: true - x-has-example: true - x-desc-name: functions-limit - description: Maximum number of user-defined functions. - keep-alive-length: - type: integer - format: int32 - default: 16384 - example: 7000 - x-has-default: true - x-has-example: true - x-desc-name: keep-alive-length - description: Maximum size of buffered result. - loglevel: - type: string - default: INFO - enum: ["DEBUG","TRACE","INFO","WARN","ERROR","SEVERE","NONE"] - example: DEBUG - x-has-default: true - x-has-example: true - x-desc-name: loglevel - description: | - Log level used in the logger. - - All values, in descending order of data: - - * `DEBUG` — For developers. - Writes everything. - - * `TRACE` — For developers. - Less info than `DEBUG`. - - * `INFO` — For admin & customers. - Lists warnings & errors. - - * `WARN` — For admin. - Only abnormal items. - - * `ERROR` — For admin. - Only errors to be fixed. - - * `SEVERE` — For admin. - Major items, like crashes. - - * `NONE` — Doesn't write anything. - - The [cluster-level][queryLogLevel] `queryLogLevel` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [queryLogLevel]: ../n1ql-rest-settings/index.html#queryLogLevel - x-desc-refs: | - [queryLogLevel]: #queryLogLevel - max-index-api: - type: integer - format: int32 - x-desc-name: max-index-api - description: | - Max index API. - This setting is provided for technical support only. - max-parallelism: - type: integer - format: int32 - default: 1 - example: 0 - x-has-default: true - x-has-example: true - x-desc-name: max-parallelism-srv - description: | - Specifies the maximum parallelism for queries on this node. - - If the value is zero or negative, the maximum parallelism is restricted to the number of allowed cores. - Similarly, if the value is greater than the number of allowed cores, the maximum parallelism is restricted to the number of allowed cores. - - (The number of allowed cores is the same as the number of logical CPUs. - In Community Edition, the number of allowed cores cannot be greater than 4. - In Enterprise Edition, there is no limit to the number of allowed cores.) - - The [cluster-level][queryMaxParallelism] `queryMaxParallelism` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, there is a [request-level][max_parallelism_req] `max_parallelism` parameter. - If a request includes this parameter, it will be capped by the node-level `max-parallelism` setting. - - NOTE: To enable queries to run in parallel, you must specify the cluster-level `queryMaxParallelism` parameter, or specify the node-level `max-parallelism` parameter on all Query nodes. - - Refer to [Max Parallelism][max-parallelism] for more information. - - [max-parallelism]: /cloud/n1ql/n1ql-language-reference/index-partitioning.html#max-parallelism - [queryMaxParallelism]: ../n1ql-rest-settings/index.html#queryMaxParallelism - [max_parallelism_req]: ../n1ql-rest-query/index.html#max_parallelism_req - x-desc-refs: | - [queryMaxParallelism]: #queryMaxParallelism - [max_parallelism_req]: #max_parallelism_req - memory-quota: - type: integer - format: int32 - default: 0 - example: 4 - x-has-default: true - x-has-example: true - x-desc-name: memory-quota-srv - description: | - Specifies the maximum amount of memory a request may use on this node, in MB. - Note that the overall node memory quota is this setting multiplied by the [node-level](#servicers) `servicers` setting. - - Specify `0` (the default value) to disable. - When disabled, there is no quota. - - This parameter enforces a ceiling on the memory used for the tracked documents required for - processing a request. It does not take into account any other memory that might be used to - process a request, such as the stack, the operators, or some intermediate values. - - Within a transaction, this setting enforces the memory quota for the transaction by tracking the - delta table and the transaction log (approximately). - - The [cluster-level][queryMemoryQuota] `queryMemoryQuota` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, the [request-level][memory_quota_req] `memory_quota` parameter specifies this property per request. - If a request includes this parameter, it will be capped by the node-level `memory-quota` setting. - - [queryMemoryQuota]: ../n1ql-rest-settings/index.html#queryMemoryQuota - [memory_quota_req]: ../n1ql-rest-query/index.html#memory_quota_req - x-desc-refs: | - [queryMemoryQuota]: #queryMemoryQuota - [memory_quota_req]: #memory_quota_req - memprofile: - type: string - default: "" - example: /tmp/memory-usage.log - x-has-default: true - x-has-example: true - x-desc-name: memprofile - description: | - Filename to write the diagnostic memory usage log. - - NOTE: If `memprofile` is left running too long, it can slow the system down as its file size increases. - - To stop `memprofile`, run with the empty setting of `""`. - mutexprofile: - type: boolean - default: false - x-has-default: true - x-desc-name: mutexprofile - description: | - Mutex profile. - This setting is provided for technical support only. - n1ql-feat-ctrl: - type: integer - # type should be [string, integer] but swagger2markup cannot process - # fix with move to Redocly / openapi-generator - format: int32 - default: 76 - example: 16460 - x-example: "0x1" - x-has-default: true - x-has-example: true - x-desc-name: n1ql-feat-ctrl - description: | - SQL++ feature control. - This setting is provided for technical support only. - The value may be an integer. - On databases running Couchbase Server 7.6 or later, it may also be a string representing a hexadecimal number. - - The [cluster-level][queryN1qlFeatCtrl] `queryN1qlFeatCtrl` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [queryN1qlFeatCtrl]: ../n1ql-rest-settings/index.html#queryN1qlFeatCtrl - x-desc-refs: | - [queryN1qlFeatCtrl]: #queryN1qlFeatCtrl - node-quota: - type: integer - format: int32 - default: 0 - x-has-default: true - x-desc-name: node-quota - x-desc-status: Couchbase Server 7.6 - description: | - This property is available in databases running Couchbase Server 7.6.0 and later. - - Sets the soft memory limit for this node, in MB. - The garbage collector tries to keep below this target. - It is not a hard, absolute limit, and memory usage may exceed this value. - - When set to `0` (the default), there is no soft memory limit. - - The [cluster-level][queryNodeQuota] `queryNodeQuota` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [queryNodeQuota]: ../n1ql-rest-settings/index.html#queryNodeQuota - x-desc-refs: | - [queryNodeQuota]: #queryNodeQuota - node-quota-val-percent: - type: integer - format: int32 - default: 67 - minimum: 0 - maximum: 100 - x-has-default: true - x-desc-name: node-quota-val-percent - x-desc-status: Couchbase Server 7.6 - description: | - This property is available in databases running Couchbase Server 7.6.0 and later. - - The percentage of the `node-quota` that is dedicated to tracked value content memory across all active requests on this node. - (The `memory-quota` setting specifies the maximum amount of document memory an individual request may use on this node.) - - The [cluster-level][queryNodeQuotaValPercent] `queryNodeQuotaValPercent` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [queryNodeQuotaValPercent]: ../n1ql-rest-settings/index.html#queryNodeQuotaValPercent - x-desc-refs: | - [queryNodeQuotaValPercent]: #queryNodeQuotaValPercent - num-cpus: - type: integer - format: int32 - default: 0 - x-has-default: true - x-desc-name: num-cpus - x-desc-status: Couchbase Server 7.6 - description: | - This property is available in databases running Couchbase Server 7.6.0 and later. - - The number of CPUs the Query service can use on this node. - Note that this setting requires a restart of the Query service to take effect. - - When set to `0` (the default), the Query service can use all available CPUs, up to the limits described below. - - The number of CPUs can never be greater than the number of logical CPUs. - In Community Edition, the number of allowed CPUs cannot be greater than 4. - In Enterprise Edition, there is no limit to the number of allowed CPUs. - - The [cluster-level][queryNumCpus] `queryNumCpus` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [queryNumCpus]: ../n1ql-rest-settings/index.html#queryNumCpus - x-desc-refs: | - [queryNumCpus]: #queryNumCpus - numatrs: - type: string - x-desc-name: numatrs-srv - description: | - Specifies the total number of [active transaction records][additional-storage-use]. - - The [cluster-level][queryNumAtrs] `queryNumAtrs` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, the [request-level][numatrs_req] `numatrs` parameter specifies this property per request. - The minimum of that and the node-level `numatrs` setting is applied. - - [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries - [queryNumAtrs]: ../n1ql-rest-settings/index.html#queryNumAtrs - [numatrs_req]: ../n1ql-rest-query/index.html#numatrs_req - x-desc-refs: | - [queryNumAtrs]: #queryNumAtrs - [numatrs_req]: #numatrs_req - pipeline-batch: - type: integer - format: int32 - default: 16 - example: 64 - x-has-default: true - x-has-example: true - x-desc-name: pipeline-batch-srv - description: | - Controls the number of items execution operators can batch for Fetch from the KV. - - The [cluster-level][queryPipelineBatch] `queryPipelineBatch` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, the [request-level][pipeline_batch_req] `pipeline_batch` parameter specifies this property per request. - The minimum of that and the node-level `pipeline-batch` setting is applied. - - [queryPipelineBatch]: ../n1ql-rest-settings/index.html#queryPipelineBatch - [pipeline_batch_req]: ../n1ql-rest-query/index.html#pipeline_batch_req - x-desc-refs: | - [queryPipelineBatch]: #queryPipelineBatch - [pipeline_batch_req]: #pipeline_batch_req - pipeline-cap: - type: integer - format: int32 - default: 512 - example: 1024 - x-has-default: true - x-has-example: true - x-desc-name: pipeline-cap-srv - description: | - Maximum number of items each execution operator can buffer between various operators. - - The [cluster-level][queryPipelineCap] `queryPipelineCap` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, the [request-level][pipeline_cap_req] `pipeline_cap` parameter specifies this property per request. - The minimum of that and the node-level `pipeline-cap` setting is applied. - - [queryPipelineCap]: ../n1ql-rest-settings/index.html#queryPipelineCap - [pipeline_cap_req]: ../n1ql-rest-query/index.html#pipeline_cap_req - x-desc-refs: | - [queryPipelineCap]: #queryPipelineCap - [pipeline_cap_req]: #pipeline_cap_req - plus-servicers: - type: integer - format: int32 - example: 16 - x-has-example: true - x-desc-name: plus-servicers - description: | - The number of service threads for transactions where the scan consistency is `request_plus` or `at_plus`. - The default is 16 times the number of logical cores. - prepared-limit: - type: integer - format: int32 - default: 16384 - example: 65536 - x-has-default: true - x-has-example: true - x-desc-name: prepared-limit - description: | - Maximum number of prepared statements in the cache. - When this cache reaches the limit, the least recently used prepared statements will be discarded as new prepared statements are created. - - The [cluster-level][queryPreparedLimit] `queryPreparedLimit` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [queryPreparedLimit]: ../n1ql-rest-settings/index.html#queryPreparedLimit - x-desc-refs: | - [queryPreparedLimit]: #queryPreparedLimit - pretty: - type: boolean - default: false - example: true - x-has-default: true - x-has-example: true - x-desc-name: pretty-srv - description: | - Specifies whether query results are returned in pretty format. - - The [request-level][pretty_req] `pretty` parameter specifies this property per request. - If a request does not include this parameter, the node-level setting is used, which defaults to `false`. - - [pretty_req]: ../n1ql-rest-query/index.html#pretty_req - x-desc-refs: | - [pretty_req]: #pretty_req - profile: - type: string - default: "off" - example: "phases" - x-has-default: true - x-has-example: true - enum: ["off","phases","timings"] - x-desc-name: profile-srv - description: | - Specifies if there should be a profile section returned with the request results. - The valid values are: - - * `off` — No profiling information is added to the query response. - - * `phases` — The query response includes a profile section with stats and details about various phases of the query plan and execution. - Three phase times will be included in the `system:active_requests` and `system:completed_requests` monitoring keyspaces. - - * `timings` — Besides the phase times, the profile section of the query response document will include a full query plan with timing and information about the number of processed documents at each phase. - This information will be included in the `system:active_requests` and `system:completed_requests` keyspaces. - - NOTE: If `profile` is not set as one of the above values, then the profile setting does not change. - - Refer to [Monitoring and Profiling Details][monitor-profile-details] for more information and examples. - - The [request-level][profile_req] `profile` parameter specifies this property per request. - If a request does not include this parameter, the node-level `profile` setting will be used. - - [monitor-profile-details]: /cloud/n1ql/n1ql-manage/monitoring-n1ql-query.html#monitor-profile-details - [profile_req]: ../n1ql-rest-query/index.html#profile_req - x-desc-refs: | - [profile_req]: #profile_req - request-size-cap: - type: integer - format: int32 - default: 67108864 - example: 70000 - x-has-default: true - x-has-example: true - x-desc-name: request-size-cap - description: Maximum size of a request. - scan-cap: - type: integer - format: int32 - default: 512 - example: 1024 - x-has-default: true - x-has-example: true - x-desc-name: scan-cap-srv - description: | - Maximum buffered channel size between the indexer client and the query service for index scans. - This parameter controls when to use scan backfill. - - Use `0` or a negative number to disable. - Smaller values reduce GC, while larger values reduce indexer backfill. - - The [cluster-level][queryScanCap] `queryScanCap` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, the [request-level][scan_cap_req] `scan_cap` parameter specifies this property per request. - The minimum of that and the node-level `scan-cap` setting is applied. - - [queryScanCap]: ../n1ql-rest-settings/index.html#queryScanCap - [scan_cap_req]: ../n1ql-rest-query/index.html#scan_cap_req - x-desc-refs: | - [queryScanCap]: #queryScanCap - [scan_cap_req]: #scan_cap_req - servicers: - type: integer - format: int32 - default: 32 - example: 8 - x-has-default: true - x-has-example: true - x-desc-name: servicers - description: | - The number of service threads for the query. - The default is 4 times the number of cores on the query node. - - Note that the overall node memory quota is this setting multiplied by the [node-level](#memory-quota-srv) `memory-quota` setting. - timeout: - type: integer - format: int64 - default: 0 - example: 500000000 - x-has-default: true - x-has-example: true - x-desc-name: timeout-srv - description: | - Maximum time to spend on the request before timing out (ns). - - The value for this setting is an integer, representing a duration in nanoseconds. - It must not be delimited by quotes, and must not include a unit. - - Specify `0` (the default value) or a negative integer to disable. - When disabled, no timeout is applied and the request runs for however long it takes. - - The [cluster-level][queryTimeout] `queryTimeout` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, the [request-level][timeout_req] `timeout` parameter specifies this property per request. - The minimum of that and the node-level `timeout` setting is applied. - - [queryTimeout]: ../n1ql-rest-settings/index.html#queryTimeout - [timeout_req]: ../n1ql-rest-query/index.html#timeout_req - x-desc-refs: | - [queryTimeout]: #queryTimeout - [timeout_req]: #timeout_req - txtimeout: - type: integer - format: int64 - default: 0 - example: 500000000 - x-has-default: true - x-has-example: true - x-desc-name: txtimeout-srv - description: | - Maximum time to spend on a transaction before timing out (ns). - This setting only applies to requests containing the `BEGIN TRANSACTION` statement, or to requests where the [tximplicit][tximplicit] parameter is set. - For all other requests, it is ignored. - - The value for this setting is an integer, representing a duration in nanoseconds. - It must not be delimited by quotes, and must not include a unit. - - Specify `0` (the default value) to disable. - When disabled, no timeout is applied and the transaction runs for however long it takes. - - The [cluster-level][queryTxTimeout] `queryTxTimeout` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, the [request-level][txtimeout_req] `txtimeout` parameter specifies this property per request. - The minimum of that and the node-level `txtimeout` setting is applied. - - [tximplicit]: ../n1ql-rest-query/index.html#tximplicit - [queryTxTimeout]: ../n1ql-rest-settings/index.html#queryTxTimeout - [txtimeout_req]: ../n1ql-rest-query/index.html#txtimeout_req - x-desc-refs: | - [tximplicit]: #tximplicit - [queryTxTimeout]: #queryTxTimeout - [txtimeout_req]: #txtimeout_req - use-cbo: - type: boolean - default: true - example: false - x-has-default: true - x-has-example: true - x-desc-name: use-cbo-srv - description: | - Specifies whether the cost-based optimizer is enabled. - - The [cluster-level][queryUseCBO] `queryUseCBO` setting specifies this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, the [request-level][use_cbo_req] `use_cbo` parameter specifies this property per request. - If a request does not include this parameter, the node-level setting is used, which defaults to `true`. - - [queryUseCBO]: ../n1ql-rest-settings/index.html#queryUseCBO - [use_cbo_req]: ../n1ql-rest-query/index.html#use_cbo_req - x-desc-refs: | - [queryUseCBO]: #queryUseCBO - [use_cbo_req]: #use_cbo_req - use-replica: - type: string - default: unset - enum: ["off","on","unset"] - example: "on" - x-has-default: true - x-has-example: true - x-desc-name: use-replica-srv - x-desc-status: Couchbase Server 7.6 - description: | - Specifies whether a query can fetch data from a replica vBucket if active vBuckets are inaccessible. - The possible values are: - - * `off` — read from replica is disabled for all queries and cannot be overridden at request level. - - * `on` — read from replica is enabled for all queries, but can be disabled at request level. - - * `unset` — read from replica is enabled or disabled at request level. - - The [cluster-level][queryUseReplica] `queryUseReplica` setting specifies the default for this property for the whole cluster. - When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. - - In addition, the [request-level][use_replica_req] `use_replica` parameter specifies this property per request. - If a request does not include this parameter, or if the request-level parameter is `unset`, the node-level setting is used. - If the request-level parameter and the node-level setting are both `unset`, read from replica is disabled for that request. - - Do not enable read from replica when you require consistent results. - Only SELECT queries that are not within a transaction can read from replica. - - Reading from replica is only possible with databases running Couchbase Server 7.6.0 or later. - - Note that KV range scans cannot currently be started on a replica vBucket. - If a query uses sequential scan and a data node becomes unavailable, the query might return an error, even if read from replica is enabled for the request. - - [queryUseReplica]: ../n1ql-rest-settings/index.html#queryUseReplica - [use_replica_req]: ../n1ql-rest-query/index.html#use_replica_req - x-desc-refs: | - [queryUseReplica]: #queryUseReplica - [use_replica_req]: #use_replica_req - - Garbage: - type: object - title: Garbage Collection - properties: - freed: - type: integer - description: The amount of memory freed. - released: - type: integer - description: | - Only returned by the POST method. - The amount of memory released to the OS. - status: - type: string - description: The status of the garbage collector. - required: - - freed - - status - - parameters: - PathStat: - name: stat - in: path - required: true - schema: - type: string - enum: - - 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 - description: | - The name of a statistic. - Only top-level statistic names can be used. - You cannot specify a metric. - - PathName: - name: name - schema: - type: string - in: path - required: true - description: | - The name of a prepared statement. - This may be a UUID that was assigned automatically, or a name that was user-specified when the statement was created. - - PathRequest: - name: request - schema: - type: string - in: path - required: true - description: | - The name of a request. - This is the `requestID` that was assigned automatically when the statement was created. - - PathCluster: - name: cluster - schema: - type: string - in: path - required: true - description: The name of a cluster. - - PathNode: - name: node - schema: - type: string - in: path - required: true - description: The name of a node. - - securitySchemes: - Default: - type: http - scheme: basic - description: | - The Admin API supports admin credentials. - Credentials can be passed via HTTP headers (HTTP basic authentication). diff --git a/src/functions/swagger/functions.yaml b/src/functions/swagger/functions.yaml deleted file mode 100644 index 3ecf94d4..00000000 --- a/src/functions/swagger/functions.yaml +++ /dev/null @@ -1,264 +0,0 @@ -openapi: 3.0.3 -info: - title: Query Functions REST API - version: capella - description: |- - The Query Functions REST API is a secondary API provided by the Query service. - This API enables you to manage the JavaScript libraries and objects that are used to create SQL++ user-defined 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 Query service. - port: - default: "8093" - description: |- - The Query service REST port. - Use `18093` for secure access. - enum: - - "8093" - - "18093" - -paths: - /evaluator/v1/libraries: - get: - operationId: get_collection - summary: Read All Libraries - parameters: - - name: bucket - schema: - type: string - in: query - required: false - description: > - For scoped libraries only. - The bucket from which to fetch libraries. - - name: scope - schema: - type: string - in: query - required: false - description: > - For scoped libraries only. - The scope from which to fetch libraries. - description: > - Returns all libraries and functions. - - - By default, this operation returns all global libraries and functions, and all scoped libraries and functions. - To return all the libraries and functions in a single scope, specify a bucket and scope. - security: - - Global: [] - - Scope: [] - responses: - "200": - description: An array of objects, each giving information about a single library. - content: - application/json: - schema: - type: array - items: - $ref: "#/components/schemas/Libraries" - "400": - $ref: "#/components/responses/BadRequest" - - /evaluator/v1/libraries/{library}: - parameters: - - $ref: "#/components/parameters/PathLibrary" - - $ref: "#/components/parameters/QueryBucket" - - $ref: "#/components/parameters/QueryScope" - get: - operationId: get_library - summary: Read a Library - description: > - Returns a library with all its functions. - - - By default, this operation returns a global library. - For a scoped library, you must specify the bucket and scope. - security: - - Global: [] - - Scope: [] - responses: - "200": - description: An object with a single property, giving information about the specified library. - content: - application/json: - schema: - $ref: "#/components/schemas/Functions" - "400": - $ref: "#/components/responses/BadRequest" - "404": - $ref: "#/components/responses/LibraryNotFound" - post: - operationId: post_library - summary: Create or Update a Library - description: > - Creates the specified library and its associated functions. - If the specified library exists, the existing library is overwritten. - - - By default, this operation creates or updates a global library. - For a scoped library, you must specify the bucket and scope. - requestBody: - required: true - description: The JavaScript code for all functions in the library. - content: - application/json: - schema: - type: string - example: function f2c(f) { return (5/9)*(f-32); } - x-has-example: true - security: - - Global: [] - - Scope: [] - responses: - "200": - $ref: "#/components/responses/OK" - "400": - description: > - Bad request. - The body of the request may be incorrect, or the path may not conform to the schema. - "404": - $ref: "#/components/responses/LibraryNotFound" - delete: - operationId: delete_library - summary: Delete a Library - description: | - Deletes the specified library entirely. - - By default, this operation deletes a global library. - For a scoped library, you must specify the bucket and scope. - security: - - Global: [] - - Scope: [] - responses: - "200": - $ref: "#/components/responses/OK" - "400": - $ref: "#/components/responses/BadRequest" - "404": - $ref: "#/components/responses/LibraryNotFound" - -components: - parameters: - PathLibrary: - name: library - schema: - type: string - in: path - required: true - description: The name of a library. - - QueryBucket: &queryBucket - name: bucket - schema: - type: string - in: query - required: false - description: > - For scoped libraries only. - The bucket in which the library is stored. - - QueryScope: &queryScope - name: scope - schema: - type: string - in: query - required: false - description: > - For scoped libraries only. - The scope in which the library is stored. - - schemas: - Libraries: - type: object - title: Library - properties: - name: - type: string - description: The name of a library. - example: math - x-has-example: true - bucket: - type: string - description: > - For scoped libraries, the bucket in which the library is stored. - For global libraries, this string is empty. - example: travel-sample - x-has-example: true - scope: - type: string - description: > - For scoped libraries, the scope in which the library is stored. - For global libraries, this string is empty. - example: inventory - x-has-example: true - code: - type: string - description: > - The JavaScript code for all functions in the library. - example: function add(a, b) { return a + b; } - function mul(a, b) { return a * b; } - x-has-example: true - required: - - name - - bucket - - scope - - code - - Functions: - type: object - title: Functions - additionalProperties: - type: string - description: | - The JavaScript code for all functions in the library. - - The name of the property is the name of the library. - example: function add(a, b) { return a + b; } - function mul(a, b) { return a * b; } - x-has-example: true - - responses: - OK: - description: The operation was successful. - - LibraryNotFound: - description: > - Not found. - The library name in the path may be incorrect, or the bucket and scope may be specified incorrectly. - - BadRequest: - description: > - Bad request. - The path may not conform to the schema. - - securitySchemes: - Global: - type: http - scheme: basic - description: | - To manage global libraries, users must have the *Manage Global External Functions* RBAC role. - - This role enables you to create, read, update, or delete any global library, but does not give you access to any scoped libraries. - - Scope: - type: http - scheme: basic - description: | - To manage scoped libraries, users must have the *Manage Scope External Functions* RBAC role, with permissions on the specified bucket and scope. - - This role enables you to create, read, update, or delete any library in the scope to which you have access, but does not give you access to any other scoped libraries. - In addition, this role enables you to read any global library, but not to create, update, or delete them. diff --git a/src/ns_server/readme.adoc b/src/ns_server/readme.adoc deleted file mode 100644 index e6c7413b..00000000 --- a/src/ns_server/readme.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= ns_server - -This spec does not yet have a swagger2markup gradle build script. \ No newline at end of file diff --git a/src/query-service/swagger/query-service.yaml b/src/query-service/swagger/query-service.yaml deleted file mode 100644 index 429e5ba8..00000000 --- a/src/query-service/swagger/query-service.yaml +++ /dev/null @@ -1,1367 +0,0 @@ -openapi: 3.0.3 -info: - title: Query Service REST API - version: capella - description: | - The Query Service REST API is provided by the Query service. - This API enables you to run SQL++ queries and set request-level parameters. - -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 Query service. - port: - default: "8093" - description: |- - The Query service REST port. - Use `18093` for secure access. - enum: - - "8093" - - "18093" - -paths: - /query/service: - post: - operationId: post_service - summary: Query Service - description: > - Enables you to execute a SQL++ statement. - This method allows you to run queries and modifying statements, and specify query parameters. - requestBody: - required: true - description: An object specifying one or more query parameters. - content: - application/json: - schema: - $ref: "#/components/schemas/Request" - application/x-www-form-urlencoded: - schema: - $ref: "#/components/schemas/Request" - security: - - Header: [] -# - Parameter: [] - responses: - "200": - $ref: '#/components/responses/OK' - "400": - $ref: '#/components/responses/BadRequest' - "401": - $ref: '#/components/responses/Unauthorized' - "403": - $ref: '#/components/responses/Forbidden' - "404": - $ref: '#/components/responses/NotFound' - "405": - $ref: '#/components/responses/MethodNotAllowed' - "409": - $ref: '#/components/responses/Conflict' - "410": - $ref: '#/components/responses/Gone' - "413": - $ref: '#/components/responses/PayloadTooLarge' - "500": - $ref: '#/components/responses/InternalServerError' - "503": - $ref: '#/components/responses/ServiceUnavailable' - get: - operationId: get_service - summary: Read-Only Query Service - description: > - Enables you to execute a SQL++ statement. - This method allows you to run queries and modifying statements, and specify query parameters. - It does not allow you to run modifying statements. - - - This endpoint is intended for situations where use of the `POST` method is restricted. - parameters: - - name: body - in: query - required: true - style: form - explode: true - description: |- - Specify the parameters in the query URL in URL-encoded format. - The format for URL-encoded parameters is consistent with the syntax for variables according to RFC 6570. - schema: - $ref: "#/components/schemas/Request" - security: - - Header: [] -# - Parameter: [] - responses: - "200": - $ref: '#/components/responses/OK' - "400": - $ref: '#/components/responses/BadRequest' - "401": - $ref: '#/components/responses/Unauthorized' - "403": - $ref: '#/components/responses/Forbidden' - "404": - $ref: '#/components/responses/NotFound' - "405": - $ref: '#/components/responses/MethodNotAllowed' - "409": - $ref: '#/components/responses/Conflict' - "410": - $ref: '#/components/responses/Gone' - "413": - $ref: '#/components/responses/PayloadTooLarge' - "500": - $ref: '#/components/responses/InternalServerError' - "503": - $ref: '#/components/responses/ServiceUnavailable' - -# The output of this spec is used in more than one location, so Markdown cannot use relative links. -# Absolute links begin with /cloud -- this must be replaced for every branch. -# Relative links point to a location relative to the REST API reference page by default. -# The x-desc-refs attribute is used to override links when content is transcluded to other locations. - -# The AsciiDoc Markdown converter does not recognize HTML tags like . -# Use the x-desc-name vendor extension to specify the anchor for a property. - -components: - responses: - OK: - description: The operation was successful. - content: - application/json: - schema: - $ref: "#/components/schemas/Response" - - BadRequest: - description: |- - Bad Request. - The request cannot be processed for one of the following reasons: - - the statement contains a SQL++ syntax error; - - the request has a missing or unrecognized HTTP parameter; - - the request is badly formatted — for example, the request body contains a JSON syntax error. - - Unauthorized: - description: > - Unauthorized. - The credentials provided with the request are missing or invalid. - - Forbidden: - description: > - Forbidden. - There is a read-only violation. - Either there was an attempt to create or update in a GET request or a POST request where `readonly` is set, or the client does not have the authorization to modify an object (index, keyspace or namespace) in the statement. - - NotFound: - description: > - Not found. - The statement in the request references an invalid namespace or keyspace. - - MethodNotAllowed: - description: > - Method not allowed. - The statement in the request references an invalid namespace or keyspace. - - Conflict: - description: > - Conflict. - There is an attempt to create an object (keyspace or index) that already exists. - - Gone: - description: > - Gone. - The server is shutting down gracefully. - Previously made requests are being completed, but no new requests are being accepted. - - InternalServerError: - description: > - Internal server error. - There was an unforeseen problem processing the request. - - PayloadTooLarge: - description: > - Payload too large. - The query is too large for the Query Service to process. - - ServiceUnavailable: - description: > - Service unavailable. - There is an issue (that is possibly temporary) preventing the request being processed; the request queue is full or the data store is not accessible. - - schemas: - Request: - type: object - title: Request Parameters - properties: - args: - type: array - items: {} - x-desc-name: args - description: | - Supplies the values for positional parameters in the statement. - Applicable if the statement or prepared statement contains 1 or more positional parameters. - - The value is an array of JSON values, one for each positional parameter in the statement. - - Refer to [Named Parameters and Positional Parameters][section_srh_tlm_n1b] for details. - - [section_srh_tlm_n1b]: /cloud/n1ql/n1ql-manage/query-settings.html#section_srh_tlm_n1b - x-has-example: true - example: - - LAX - - 6 - atrcollection: - type: string - x-desc-name: atrcollection_req - description: | - Specifies the collection where the [active transaction record][additional-storage-use] (ATR) is stored. - The collection must be present. - If not specified, the ATR is stored in the default collection in the default scope in the bucket containing the first mutated document within the transaction. - - The value must be a string in the form `"bucket.scope.collection"` or `"namespace:bucket.scope.collection"`. - If any part of the path contains a special character, that part of the path must be delimited in backticks ``. - - [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries - -# The [node-level][atrcollection-srv] `atrcollection` setting specifies the default for this parameter for a single node. -# The request-level parameter overrides the node-level setting. - -# [atrcollection-srv]: ../n1ql-rest-admin/index.html#atrcollection-srv - x-desc-refs: | - [atrcollection-srv]: #atrcollection-srv - x-has-example: true - example: default:`travel-sample`.transaction.test - auto_execute: - type: boolean - x-desc-name: auto_execute - description: | - Specifies that prepared statements should be executed automatically as soon as they are created. - This saves you from having to make two separate requests in cases where you want to prepare a statement and execute it immediately. - - Refer to [Auto-Execute][auto-execute] for more information. - - [auto-execute]: /cloud/n1ql/n1ql-language-reference/prepare.html#auto-execute - x-has-default: true - x-has-example: true - default: false - example: true - client_context_id: - type: string - x-desc-name: client_context_id - description: | - A piece of data supplied by the client that is echoed in the response, if present. - SQL++ is agnostic about the content of this parameter; it is just echoed in the response. - - * Maximum allowed size is 64 characters; all others will be cut. - * If it contains an escape character `/` or quote `"`, it will be rejected as error code 1110. - compression: - type: string - x-desc-name: compression - description: | - Compression format to use for response data on the wire. - - Values are case-insensitive. - enum: ["ZIP", "RLE", "LZMA", "LZO", "NONE"] - x-has-default: true - x-has-example: true - default: NONE - example: zip - controls: - type: boolean - x-desc-name: controls_req - description: | - Specifies if there should be a controls section returned with the request results. - - When set to `true`, the query response document includes a controls section with runtime information provided along with the request, such as positional and named parameters or settings. - - If the request qualifies for caching, these values will also be cached in the `completed_requests` system keyspace. - -# The [node-level][controls-srv] `controls` setting specifies the default for this parameter for a single node. -# The request-level parameter overrides the node-level setting. - -# [controls-srv]: ../n1ql-rest-admin/index.html#controls-srv - x-desc-refs: | - [controls-srv]: #controls-srv - x-has-example: true - example: true -# creds: -# type: array -# items: -# $ref: "#/components/schemas/Credentials" -# x-desc-name: creds -# description: | -# Specifies the login credentials. -# The Query API supports two types of identity: local (or bucket) and admin. - -# The format is an identity and password. -# You can specify credentials for multiple identities. - -# If credentials are supplied in the request header, then HTTP Basic Authentication takes precedence and `creds` is ignored. -# x-has-example: true -# example: -# - user: local:bucket-name -# pass: password -# - user: admin:admin-name -# pass: password - durability_level: - type: string - x-desc-name: durability_level - description: | - The level of [durability][durability] for mutations produced by the request. - - If the request contains a `BEGIN TRANSACTION` statement, or a DML statement with the [tximplicit](#tximplicit) parameter set to `true`, the durability level is specified for all mutations within that transaction. - - Durability is also supported for non-transactional DML statements. - In this case, the `kvtimeout` parameter is used as the durability timeout. - - If not specified, the default durability level is `"majority"`. - Set the durability level to `"none"` or `""` to specify no durability. - - [durability]: /server/7.6/learn/data/durability.html - enum: - - "" - - none - - majority - - majorityAndPersistActive - - persistToMajority - x-has-default: true - x-has-example: true - default: majority - example: none - encoded_plan: - type: string - x-desc-name: encoded_plan - description: | - In databases running Couchbase Server 6.5 and later, this parameter is ignored and has no effect. - It is included for compatibility with previous versions of Couchbase Server. - encoding: - type: string - x-desc-name: encoding - description: | - Desired character encoding for the query results. - - Only possible value is `UTF-8` and is case-insensitive. - x-has-default: true - default: UTF-8 - format: - type: string - x-desc-name: format - description: | - Desired format for the query results. - - Values are case-insensitive. - enum: ["JSON", "XML", "CSV", "TSV"] - x-has-default: true - x-has-example: true - default: JSON - example: XML - kvtimeout: - type: string - x-desc-name: kvtimeout - description: | - The approximate time to wait for a KV get operation before timing out. - This applies to statements within a transaction, and to non-transactional statements, whether `durability_level` is set or not. - - If `use_replica` is enabled for a query, then this parameter also specifies the approximate time to wait before fetching data from a replica vBucket when the active vBucket is inaccessible. - - The value for this parameter is a string. - Its format includes an amount and a mandatory unit, e.g. `10ms` (10 milliseconds) or `0.5s` (half a second). - Valid units are: - - * `ns` (nanoseconds) - * `us` (microseconds) - * `ms` (milliseconds) - * `s` (seconds) - * `m` (minutes) - * `h` (hours) - - Specify a duration of `0` or a negative duration to disable. - When disabled, no timeout is applied and the KV operation runs for however long it takes. - x-has-default: true - x-has-example: true - default: 2.5s - example: 10ms - max_parallelism: - type: integer - format: int32 - x-desc-name: max_parallelism_req - description: | - Specifies the maximum parallelism for the query. - - The default value is the same as the number of partitions of the index selected for the query. - -# The [node-level][max-parallelism-srv] `max-parallelism` setting specifies the ceiling for this parameter for a single node. -# If the request-level parameter is zero or negative, the parallelism for the query is set to the node-level setting. -# If the request-level parameter is greater than zero and less than the node-level setting, the request-level parameter overrides the node-level setting. -# If the request-level parameter is greater than the node-level setting, the parallelism for the query is set to the node-level setting. - -# In addition, the [cluster-level][queryMaxParallelism] `queryMaxParallelism` setting specifies the ceiling for this parameter for the whole cluster. -# When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. - -# To enable queries to run in parallel, you must specify the cluster-level `queryMaxParallelism` parameter, or specify the node-level `max-parallelism` parameter on all Query nodes. - -# [max-parallelism-srv]: ../n1ql-rest-admin/index.html#max-parallelism-srv -# [queryMaxParallelism]: ../n1ql-rest-settings/index.html#queryMaxParallelism - x-desc-refs: | - [max-parallelism-srv]: #max-parallelism-srv - [queryMaxParallelism]: #queryMaxParallelism - x-has-example: true - example: 3 - memory_quota: - type: integer - format: int32 - x-desc-name: memory_quota_req - description: | - Specifies the maximum amount of memory the request may use, in MB. - - Specify `0` (the default value) to disable. - When disabled, there is no quota. - - This parameter enforces a ceiling on the memory used for the tracked documents required for - processing a request. It does not take into account any other memory that might be used to - process a request, such as the stack, the operators, or some intermediate values. - - Within a transaction, this setting enforces the memory quota for the transaction by tracking the - delta table and the transaction log (approximately). - -# The [node-level][memory-quota-srv] `memory-quota` setting specifies the ceiling for this parameter for a single node. -# If the node-level setting is zero (the default), the request-level parameter overrides the node-level setting. -# If the node-level setting is greater than zero, the request-level parameter is capped by the node-level setting. - -# In addition, the [cluster-level][queryMemoryQuota] `queryMemoryQuota` setting specifies the ceiling for this parameter for the whole cluster. -# When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. - -# [memory-quota-srv]: ../n1ql-rest-admin/index.html#memory-quota-srv -# [queryMemoryQuota]: ../n1ql-rest-settings/index.html#queryMemoryQuota - x-desc-refs: | - [memory-quota-srv]: #memory-quota-srv - [queryMemoryQuota]: #queryMemoryQuota - x-has-default: true - x-has-example: true - default: 0 - example: 4 - metrics: - type: boolean - x-desc-name: metrics - description: Specifies that metrics should be returned with query results. - x-has-default: true - x-has-example: true - default: true - example: false - namespace: - type: string - x-desc-name: namespace - description: > - Specifies the namespace to use. - Currently, only the `default` namespace is available. - x-has-example: true - example: default - numatrs: - type: integer - format: int32 - x-desc-name: numatrs_req - description: | - Specifies the total number of [active transaction records][additional-storage-use]. - Must be a positive integer. - - [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries - -# The [node-level][numatrs-srv] `numatrs` setting specifies the default for this parameter for a single node. -# The request-level parameter overrides the node-level setting. - -# In addition, the [cluster-level][queryNumAtrs] `queryNumAtrs` setting specifies the default for this parameter for the whole cluster. -# When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. - -# [numatrs-srv]: ../n1ql-rest-admin/index.html#numatrs-srv -# [queryNumAtrs]: ../n1ql-rest-settings/index.html#queryNumAtrs - x-desc-refs: | - [numatrs-srv]: #numatrs-srv - [queryNumAtrs]: #queryNumAtrs - x-has-default: true - x-has-example: true - default: 1024 - example: 512 - pipeline_batch: - type: integer - format: int32 - x-desc-name: pipeline_batch_req - description: | - Controls the number of items execution operators can batch for Fetch from the KV. - -# The [node-level][pipeline-batch-srv] `pipeline-batch` setting specifies the default for this parameter for a single node. -# The request-level parameter overrides the node-level setting, but only if it is lower than the node-level setting. - -# In addition, the [cluster-level][queryPipelineBatch] `queryPipelineBatch` setting specifies the default for this parameter for the whole cluster. -# When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. - -# [pipeline-batch-srv]: ../n1ql-rest-admin/index.html#pipeline-batch-srv -# [queryPipelineBatch]: ../n1ql-rest-settings/index.html#queryPipelineBatch - x-desc-refs: | - [pipeline-batch-srv]: #pipeline-batch-srv - [queryPipelineBatch]: #queryPipelineBatch - x-has-example: true - example: 64 - pipeline_cap: - type: integer - format: int32 - x-desc-name: pipeline_cap_req - description: | - Maximum number of items each execution operator can buffer between various operators. - -# The [node-level][pipeline-cap-srv] `pipeline-cap` setting specifies the default for this parameter for a single node. -# The request-level parameter overrides the node-level setting, but only if it is lower than the node-level setting. - -# In addition, the [cluster-level][queryPipelineCap] `queryPipelineCap` setting specifies the default for this parameter for the whole cluster. -# When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. - -# [pipeline-cap-srv]: ../n1ql-rest-admin/index.html#pipeline-cap-srv -# [queryPipelineCap]: ../n1ql-rest-settings/index.html#queryPipelineCap - x-desc-refs: | - [pipeline-cap-srv]: #pipeline-cap-srv - [queryPipelineCap]: #queryPipelineCap - x-has-example: true - example: 1024 - prepared: - type: string - x-desc-name: prepared - description: | - _Required_ if `statement` not provided. - - The name of the prepared SQL++ statement to be executed. - Refer to [EXECUTE][execute] for examples. - - If both `prepared` and `statement` are present and non-empty, an error is returned. - - [execute]: /cloud/n1ql/n1ql-language-reference/execute.html - x-has-example: true - example: a1355198-2576-4e3d-af04-5acc77d8a681 - x-example: "[127.0.0.1:8091]pricy_hotel" - preserve_expiry: - type: boolean - x-desc-name: preserve_expiry - description: | - Specifies whether documents should keep their current expiration setting when modified by a DML statement. - - If `true`, documents will keep any existing expiration setting when modified by a DML statement. - If the DML statement explicitly specifies the document expiration, the statement overrides this parameter, and the expiration is changed. - - If `false`, document expiration is set to 0 when modified by a DML statement, unless the DML statement explicitly specifies the document expiration. - - Not supported for statements in a transaction. - x-has-default: true - x-has-example: true - default: false - example: true - pretty: - type: boolean - x-desc-name: pretty_req - description: | - Specifies the query results returned in pretty format. - -# The [node-level][pretty-srv] `pretty` setting specifies the default for this parameter for a single node. -# The request-level parameter overrides the node-level setting. - -# [pretty-srv]: ../n1ql-rest-admin/index.html#pretty-srv - x-desc-refs: | - [pretty-srv]: #pretty-srv - x-has-example: true - example: false - profile: - type: string - x-desc-name: profile_req - description: | - Specifies if there should be a profile section returned with the request results. - The valid values are: - - * `off` — No profiling information is added to the query response. - - * `phases` — - The query response includes a profile section with stats and details about various phases of the query plan and execution. - Three phase times will be included in the `system:active_requests` and `system:completed_requests` monitoring keyspaces. - - * `timings` — - Besides the phase times, the profile section of the query response document will include a full query plan with timing and information about the number of processed documents at each phase. - This information will be included in the `system:active_requests` and `system:completed_requests` keyspaces. - - If `profile` is not set as one of the above values, then the profile setting does not change. - -# The [node-level][profile-srv] `profile` setting specifies the default for this parameter for a single node. -# The request-level parameter overrides the node-level setting. - -# [profile-srv]: ../n1ql-rest-admin/index.html#profile-srv - x-desc-refs: | - [profile-srv]: #profile-srv - enum: ["off", "phases", "timings"] - x-has-example: true - example: phases - query_context: - type: string - x-desc-name: query_context - description: | - Specifies the namespace, bucket, and scope used to resolve partial keyspace references within the request. - - The query context may be a _full path_, containing namespace, bucket, and scope; or a _relative path_, containing just the bucket and scope. - Currently, only the `default` namespace is available. - If the namespace name is omitted, the default namespace in the current session is used. - x-has-default: true - x-has-example: true - default: "default:" - example: default:travel-sample.inventory - readonly: - type: boolean - x-desc-name: readonly - description: | - Controls whether a query can change a resulting recordset. - - If `readonly` is `true`, then the following statements are not allowed: - - * CREATE INDEX - * DROP INDEX - * INSERT - * MERGE - * UPDATE - * UPSERT - - When using GET requests, it's best to set `readonly` to `true`. - x-has-default: true - x-has-example: true - default: false - example: true - scan_cap: - type: integer - format: int32 - x-desc-name: scan_cap_req - description: | - Maximum buffered channel size between the indexer client and the query service for index scans. - This parameter controls when to use scan backfill. - - Use `0` or a negative number to disable. - Smaller values reduce GC, while larger values reduce indexer backfill. - -# The [node-level][scan-cap-srv] `scan-cap` setting specifies the default for this parameter for a single node. -# The request-level parameter overrides the node-level setting, but only if it is lower than the node-level setting. - -# In addition, the [cluster-level][queryScanCap] `queryScanCap` setting specifies the default for this parameter for the whole cluster. -# When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. - -# [scan-cap-srv]: ../n1ql-rest-admin/index.html#scan-cap-srv -# [queryScanCap]: ../n1ql-rest-settings/index.html#queryScanCap - x-desc-refs: | - [scan-cap-srv]: #scan-cap-srv - [queryScanCap]: #queryScanCap - x-has-example: true - example: 1024 - scan_consistency: - type: string - x-desc-name: scan_consistency - description: | - Specifies the consistency guarantee or constraint for index scanning. - The valid values are: - - * `not_bounded` — - No timestamp vector is used in the index scan. - This is the fastest mode, because it avoids the costs of obtaining the vector and waiting for the index to catch up to the vector. - - * `at_plus` — - This implements bounded consistency. - The request includes a `scan_vector` parameter and value, which is used as a lower bound. - This can be used to implement read-your-own-writes (RYOW). - - * `request_plus` — - This implements strong consistency per request. - Before processing the request, a current vector is obtained. - The vector is used as a lower bound for the statements in the request. - If there are DML statements in the request, RYOW is also applied within the request. - (If `request_plus` is specified in a query that runs during a failover of an index node, the query waits until the rebalance operation completes and the index data has rebalanced before returning a result.) - - * `statement_plus` — - This implements strong consistency per statement. - Before processing each statement, a current vector is obtained and used as a lower bound for that statement. - - Values are case-insensitive. - - For multi-statement requests, the default behavior is RYOW within each request. - If you want to disable RYOW within a request, add a separate `request_consistency` parameter that can be set to `not_bounded`. - - If the request contains a `BEGIN TRANSACTION` statement, or a DML statement with the [tximplicit](#tximplicit) parameter set to `true`, then this parameter sets the transactional scan consistency. - Refer to [Transactional Scan Consistency][transactional-scan-consistency] for details. - - [transactional-scan-consistency]: /cloud/n1ql/n1ql-manage/query-settings.html#transactional-scan-consistency - enum: ["not_bounded", "at_plus", "request_plus", "statement_plus"] - x-has-default: true - x-has-example: true - default: not_bounded - example: at_plus - scan_vector: - type: object - x-type: array - x-desc-name: scan_vector - description: | - _Required_ if `scan_consistency` is `at_plus` and `scan_vectors` not provided. - - Specify the lower bound vector timestamp for one keyspace when using `at_plus` scan consistency. - - Scan vectors are built of two-element [`value`, `guard`] entries: - - * `value`: a vBucket's sequence number (a JSON number) - * `guard`: a vBucket's UUID (a string) - - Scan vectors have two forms: - - 1. Full: an array of [`value`, `guard`] entries, giving an entry for every vBucket in the system. - 2. Sparse: an object providing entries for specific vBuckets, mapping a vBucket number (a string) to each [`value`, `guard`] entry. - - Note that `scan_vector` can only be used if the query uses at most one keyspace; if it is used for a query referencing more than one keyspace, the query will fail with an error. - - For queries referencing multiple keyspaces, use `scan_vectors`. - x-has-example: true - example: - 5: - - 5409393 - - VB5ID - 19: - - 47574574 - - VB19ID - scan_vectors: - type: object - x-type: array - x-desc-name: scan_vectors - description: | - _Required_ if `scan_consistency` is `at_plus` and `scan_vector` not provided. - - A map from keyspace names to scan vectors. - See `scan_vector`. - - The scan vectors can be Full or Sparse. - scan_wait: - type: string - format: duration - x-desc-name: scan_wait - description: | - Can be supplied with `scan_consistency` values of `request_plus`, `statement_plus` and `at_plus`. - - Specifies the maximum time the client is willing to wait for an index to catch up to the vector timestamp in the request. - - Specifies how much time the client is willing to wait for the indexer to satisfy the required `scan_consistency` and `scan_vector` criteria. - After receiving the scan request, if the indexer is unable to catch up within the `scan_wait` time and initiate the scan, the indexer aborts with an error and the scan fails. - - Its format includes an amount and a mandatory unit, e.g. `10ms` (10 milliseconds) or `0.5s` (half a second). - Valid units are: - - * `ns` (nanoseconds) - * `us` (microseconds) - * `ms` (milliseconds) - * `s` (seconds) - * `m` (minutes) - * `h` (hours) - - Specify `0` or a negative integer to disable. - x-has-default: true - x-has-example: true - default: "" - example: 30m - signature: - type: boolean - x-desc-name: signature - description: Include a header for the results schema in the response. - x-has-default: true - x-has-example: true - default: true - example: false - sort_projection: - type: boolean - x-desc-name: sort_projection - description: | - If `true`, causes statement projection terms to be sorted alphabetically. - - If `false` (the default), statement projection terms are returned in the order specified by the query. - x-has-default: true - x-has-example: true - default: false - example: true - statement: - type: string - x-desc-name: statement - description: | - _Required_ if `prepared` not provided. - - Any valid SQL++ statement for a POST request, or a read-only SQL++ statement (SELECT, EXPLAIN) for a GET request. - - If both `prepared` and `statement` are present and non-empty, an error is returned. - - --- - - When specifying the request parameters as form data, the statement may not contain an unescaped semicolon (`;`). - If it does, the Query Service responds with error 1040. - To avoid this, either URL-encode the semicolon as `%3B`, or just omit the semicolon if possible. - - This restriction does not apply when specifying the request parameters in JSON format. - x-has-example: true - example: SELECT * FROM `travel-sample`.inventory.hotel LIMIT 1 - timeout: - type: string - format: duration - x-desc-name: timeout_req - description: | - Maximum time to spend on the request before timing out. - - The value for this parameter is a string. - Its format includes an amount and a mandatory unit, e.g. `10ms` (10 milliseconds) or `0.5s` (half a second). - Valid units are: - - * `ns` (nanoseconds) - * `us` (microseconds) - * `ms` (milliseconds) - * `s` (seconds) - * `m` (minutes) - * `h` (hours) - - Specify a duration of `0` or a negative duration to disable. - When disabled, no timeout is applied and the request runs for however long it takes. - - If [tximplicit](#tximplicit) or [txid](#txid) is set, this parameter is ignored. - The request inherits the remaining time of the transaction as timeout. - -# The [node-level][timeout-srv] `timeout` setting specifies the default for this parameter for a single node. -# The request-level parameter overrides the node-level setting. -# However, if the node-level setting is greater than 0, the timeout for the query is limited to the node-level setting. - -# In addition, the [cluster-level][queryTimeout] `queryTimeout` setting specifies the default for this parameter for the whole cluster. -# When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. - -# [timeout-srv]: ../n1ql-rest-admin/index.html#timeout-srv -# [queryTimeout]: ../n1ql-rest-settings/index.html#queryTimeout - x-desc-refs: | - [timeout-srv]: #timeout-srv - [queryTimeout]: #queryTimeout - x-has-example: true - example: 30m - txdata: - type: object - x-desc-name: txdata - description: | - Transaction data. - For internal use only. - txid: - type: string - format: UUID - x-desc-name: txid - description: | - _Required_ for statements within a transaction. - - Transaction ID. - Specifies the transaction to which a statement belongs. - For use with DML statements within a transaction, rollbacks, and commits. - - The transaction ID should be the same as the transaction ID generated by the `BEGIN TRANSACTION` statement. - The transaction must be active and non-expired. - x-has-example: true - example: d81d9b4a-b758-4f98-b007-87ba262d3a51 - tximplicit: - type: boolean - x-desc-name: tximplicit - description: | - Specifies that a DML statement is a singleton transaction. - - When this parameter is true, the Query service starts a transaction and executes the statement. - If execution is successful, the Query service commits the transaction; otherwise the transaction is rolled back. - - The statement may not be part of an ongoing transaction. - If the [txid](#txid) request-level parameter is set, the `tximplicit` parameter is ignored. - x-has-default: true - x-has-example: true - default: false - example: true - txstmtnum: - type: integer - format: int32 - x-desc-name: txstmtnum - description: | - Transaction statement number. - The transaction statement number must be a positive integer, and must be higher than any previous transaction statement numbers in the transaction. - If the transaction statement number is lower than the transaction statement number for any previous statement, an error is generated. - x-has-example: true - example: 10 - txtimeout: - type: string - format: duration - x-desc-name: txtimeout_req - description: | - Maximum time to spend on a transaction before timing out. - Only applies to `BEGIN TRANSACTION` statements, or DML statements for which [tximplicit](#tximplicit) is set. - For other statements, it is ignored. - - Within a transaction, the request-level [timeout](#timeout_req) parameter is ignored. - The transaction timeout clock starts when the `BEGIN WORK` statement is successful. - Once the transaction timeout is reached, no statement is allowed to continue in the transaction. - - The value for this parameter is a string. - Its format includes an amount and a mandatory unit, e.g. `10ms` (10 milliseconds) or `0.5s` (half a second). - Valid units are: - - * `ns` (nanoseconds) - * `us` (microseconds) - * `ms` (milliseconds) - * `s` (seconds) - * `m` (minutes) - * `h` (hours) - - Specify a duration of `0` to disable. - When disabled, the request-level timeout is set to the default. - - The default is `"15s"` for cbq files or scripts, `"2m"` for interactive cbq sessions or redirected input. - -# The [node-level][txtimeout-srv] `txtimeout` setting specifies the default for this parameter for a single node. -# The request-level parameter overrides the node-level setting. -# However, if the node-level setting is greater than 0, the transaction timeout for the query is limited to the node-level setting. - -# In addition, the [cluster-level][queryTxTimeout] `queryTxTimeout` setting specifies the default for this parameter for the whole cluster. -# When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. - -# [txtimeout-srv]: ../n1ql-rest-admin/index.html#txtimeout-srv -# [queryTxTimeout]: ../n1ql-rest-settings/index.html#queryTxTimeout - x-desc-refs: | - [txtimeout-srv]: #txtimeout-srv - [queryTxTimeout]: #queryTxTimeout - x-has-example: true - example: 30m - use_cbo: - type: boolean - x-desc-name: use_cbo_req - description: | - Specifies whether the cost-based optimizer is enabled. - -# The [node-level][use-cbo-srv] `use-cbo` setting specifies the default for this parameter for a single node. -# The request-level parameter overrides the node-level setting. - -# In addition, the [cluster-level][queryUseCBO] `queryUseCBO` setting specifies the default for this parameter for the whole cluster. -# When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. - -# [use-cbo-srv]: ../n1ql-rest-admin/index.html#use-cbo-srv -# [queryUseCBO]: ../n1ql-rest-settings/index.html#queryUseCBO - x-desc-refs: | - [use-cbo-srv]: #use-cbo-srv - [queryUseCBO]: #queryUseCBO - x-has-example: true - example: true - use_fts: - type: boolean - x-desc-name: use_fts - description: | - Specifies that the query should use a full-text index. - - If the query contains a `USING FTS` hint, that takes priority over this parameter. - - If the query does not contain a `USING FTS` hint, and this parameter is set to true, all full-text indexes are considered for the query. - If a qualified full-text index is available, it is selected for the query. - If none of the available full-text indexes are qualified, the available GSI indexes are considered instead. - - Refer to [Flex Indexes][flex-indexes] for more information. - - [flex-indexes]: /cloud/n1ql/n1ql-language-reference/flex-indexes.html - x-has-default: true - x-has-example: true - default: false - example: true - use_replica: - type: string - enum: ["off","on","unset"] - x-has-default: true - x-has-example: true - default: unset - example: on - x-desc-name: use_replica_req - x-desc-status: Couchbase Server 7.6 - description: | - Specifies whether a query can fetch data from a replica vBucket if active vBuckets are inaccessible. - The possible values are: - - * `off` — read from replica is disabled for this request. - - * `on` — read from replica is enabled for this request, unless it has been disabled for all requests at node level. - - * `unset` — read from replica is specified by the node-level setting. - If the node-level setting is also `unset`, read from replica is disabled for this request. - - Do not enable read from replica when you require consistent results. - Only SELECT queries that are not within a transaction can read from replica. - - Reading from replica is only possible with databases running Couchbase Server 7.6.0 or later. - - Note that KV range scans cannot currently be started on a replica vBucket. - If a query uses sequential scan and a data node becomes unavailable, the query might return an error, even if read from replica is enabled for the request. - -# The [node-level][use-replica-srv] `use-replica` setting specifies the default for this property for a single node. -# The request-level parameter usually overrides the node-level setting. -# However, when the node-level setting is `off`, the request-level parameter cannot enable the property. - -# In addition, the [cluster-level][queryUseReplica] `queryUseReplica` setting specifies the default for this property for the whole cluster. -# When you change the cluster-level setting, the node-level setting is overwritten for all nodes in the cluster. - -# [use-replica-srv]: ../n1ql-rest-admin/index.html#use-replica-srv -# [queryUseReplica]: ../n1ql-rest-settings/index.html#queryUseReplica - x-desc-refs: | - [use-replica-srv]: #use-replica-srv - [queryUseReplica]: #queryUseReplica - additionalProperties: - x-desc-name: identifier - description: | - Supplies the value for a named parameter in the statement. - Applicable if the statement or prepared statement contains 1 or more named parameters. - - The name of this property consists of two parts: - - 1. The `$` character. - In databases running Couchbase Server 7.6.0 and later, this may be the `$` character or the `@` character. - 2. An identifier that specifies the name of the parameter. - This must start with an alpha character, followed by one or more alphanumeric characters. - - The value of the named parameter can be any JSON value. - - Refer to [Named Parameters and Positional Parameters][section_srh_tlm_n1b] for details. - - [section_srh_tlm_n1b]: /cloud/n1ql/n1ql-manage/query-settings.html#section_srh_tlm_n1b - -# Credentials: -# type: object -# title: Credentials -# properties: -# user: -# type: string -# description: > -# An identity for authentication. -# Note that bucket names may be prefixed with `local:`, and admin names may be prefixed with `admin:`. -# pass: -# type: string -# description: A password for authentication. - - Response: - type: object - title: Response Body - description: The response body has the following structure. - properties: - requestID: - type: string - format: UUID - description: A unique identifier for the response. - clientContextID: - type: string - description: The client context ID of the request, if one was supplied — see `client_context_id` in [Request Parameters](#Request). - signature: - type: object - description: > - The schema of the results. - Present only when the query completes successfully. - x-has-example: true - example: - id: json - results: - type: array - items: {} - description: > - An array of all the objects returned by the query. - An object can be any JSON value. - status: - type: string - description: The status of the request. - enum: - - success - - running - - errors - - completed - - stopped - - timeout - - fatal - errors: - type: array - description: > - An array of 0 or more error objects. - If an error occurred during processing of the request, it will be represented by an error object in this list. - items: - $ref: "#/components/schemas/Conditions" - warnings: - type: array - description: > - An array of 0 or more warning objects. - If a warning occurred during processing of the request, it is represented by a warning object in this list. - items: - $ref: "#/components/schemas/Conditions" - metrics: - $ref: "#/components/schemas/Metrics" - controls: - $ref: "#/components/schemas/Controls" - profile: - $ref: "#/components/schemas/Profile" - - Conditions: - type: object - description: Errors and warnings have the following format. - required: - - code - - msg - properties: - code: - type: integer - description: > - A unique number that identifies the error or warning. - The code ranges are partitioned by component. - The codes can also include parts that indicate severity and transience. - This property is always present in every condition returned in the Query REST API or captured in a log. - msg: - type: string - description: > - A message describing the error or warning in detail. - This property is always present in every condition returned in the Query REST API or captured in a log. - name: - type: string - description: > - Unique name that has a 1:1 mapping to the code. - Uniquely identifies the condition. - This property is helpful for pattern matching and can have meaning, making it more memorable than the code. - The name should be fully qualified. - x-has-example: true - example: - indexing.scan.io_failure - x-example: - query.execute.index_not_found - sev: - type: integer - description: | - One of the following SQL++ severity levels, listed in order of severity: - - 1. Severe - 2. Error - 3. Warn - 4. Info - temp: - type: boolean - description: > - Indicates if the condition is transient — for example, the queue is full. - If the value is `false`, it tells clients and users that a retry without modification produces the same condition. - - Metrics: - type: object - description: An object containing metrics about the request. - required: - - elapsedTime - - executionTime - - resultCount - - resultSize - properties: - elapsedTime: - type: string - description: The total time taken for the request, that is the time from when the request was received until the results were returned. - executionTime: - type: string - description: The time taken for the execution of the request, that is the time from when query execution started until the results were returned. - resultCount: - type: integer - format: unsigned - description: The total number of objects in the results. - resultSize: - type: integer - format: unsigned - description: The total number of bytes in the results. - mutationCount: - type: integer - description: The number of mutations that were made during the request. - format: unsigned - sortCount: - type: integer - format: unsigned - description: > - The number of objects that were sorted. - Present only if the request includes `ORDER BY`. - - - If a query includes ORDER BY, LIMIT, or OFFSET clauses, an application can use the `sortCount` value to give the overall number of results in a message such as `"page 1 of N"`. - usedMemory: - type: integer - format: unsigned - description: > - The amount of document memory used to execute the request. - This property is only returned if a memory quota was set for the query. - errorCount: - type: integer - format: unsigned - description: The number of errors that occurred during the request. - warningCount: - type: integer - format: unsigned - description: The number of warnings that occurred during the request. - - Controls: - type: object - description: > - An object containing runtime information provided along with the request. - Present only if `controls` was set to true in the [Request Parameters](#Request). - properties: - scan_consistency: - type: string - description: The value of the query setting Scan Consistency used for the query. - use_cbo: - type: boolean - description: Whether the cost-based optimizer was enabled for the query. - memoryQuota: - type: integer - format: unsigned - description: > - The memory quota for the request, in MB. - This property is only returned if a memory quota was set for the query. - stmtType: - type: string - description: The type of query statement. - x-has-example: true - example: SELECT - - Profile: - type: object - description: > - An object containing monitoring and profiling information about the request. - Present only if `profile` was set to `"phases"` or `"timings"` in the [Request Parameters](#Request). - required: - - requestTime - - servicingHost - - phaseCounts - - phaseOperators - - phaseTimes - properties: - requestTime: - type: string - format: date-time - description: Timestamp when the query was received. - servicingHost: - type: string - description: IP address and port number of the node where the query was executed. - phaseCounts: - type: object - description: | - Count of documents processed at selective phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc. - x-has-example: true - example: - { - "fetch": 16, - "indexScan": 187 - } - phaseOperators: - type: object - description: | - Indicates the numbers of each kind of query operator involved in different phases of the query processing. - - For instance, a non-covering index path might involve one index scan and one fetch operator. - A join would probably involve two or more fetches, one per keyspace. - A union select would have twice as many operator counts, one per each branch of the union. - - This is in essence the count of all the operators in the `executionTimings` object. - x-has-example: true - example: - { - "authorize": 1, - "fetch": 1, - "indexScan": 2 - } - phaseTimes: - type: object - description: | - Cumulative execution times for various phases involved in the query execution, such as authorize, index scan, fetch, parse, plan, run, etc. - x-has-example: true - 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" - } - executionTimings: - type: object - title: Execution Timings - description: | - Present only if `profile` was set to `"timings"` in the [Request Parameters](#Request). - - The execution details for various phases involved in the query execution, such as kernel and service execution times, number of documents processed at each query operator in each phase, and number of phase switches. - required: - - '#operator' - - '#stats' - properties: - '#operator': - type: string - description: Name of the operator. - x-has-example: true - example: Fetch - '#stats': - type: object - title: Statistics - description: Statistics collected for the operator. - properties: - '#itemsIn': - type: integer - format: int32 - description: Number of input documents to the operator. - x-has-example: true - example: 187 - '#itemsOut': - type: integer - format: int32 - description: Number of output documents after the operator processing. - x-has-example: true - example: 16 - '#phaseSwitches': - type: integer - format: int32 - description: Number of switches between executing, waiting for services, or waiting for the goroutine scheduler. - x-has-example: true - example: 413 - execTime: - type: string - format: duration - description: Time spent executing the operator code inside SQL++ query engine. - x-has-example: true - example: "128.434µs" - kernTime: - type: string - format: duration - description: Time spent waiting to be scheduled for CPU time. - x-has-example: true - example: "15.027879ms" - servTime: - type: string - format: duration - description: | - Time spent waiting for another service, such as index or data. - - For index scan, it is time spent waiting for GSI/indexer. - - For fetch, it is time spent waiting on the KV store. - x-has-example: true - example: "1.590934ms" - '~child': - type: object - description: Further nested operators, each with their own execution timings. - - securitySchemes: - Header: - type: http - scheme: basic - description: | - Specify a user name and password via HTTP headers. - This method can only be used to provide a single credential. - -# Parameter: -# type: apiKey -# name: creds -# in: query -# description: > -# Specify user names and passwords via the `creds` request parameter. -# This is the only method that can provide multiple credentials for a request. diff --git a/src/query-settings/swagger/query-settings.yaml b/src/query-settings/swagger/query-settings.yaml deleted file mode 100644 index 3f956831..00000000 --- a/src/query-settings/swagger/query-settings.yaml +++ /dev/null @@ -1,773 +0,0 @@ -openapi: 3.0.3 -info: - title: Query Settings REST API - version: capella - description: |- - The Query Settings REST API is provided by the Query service. - This API enables you to view or specify cluster-level Query settings. - -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 Query service. - port: - default: "8091" - description: |- - The Cluster administration REST port. - Use `18091` for secure access. - - Note that the port numbers for this REST API are different to the port numbers used by the other Query REST APIs. - enum: - - "8091" - - "18091" - -paths: - /settings/querySettings: - get: - operationId: get_settings - summary: Retrieve Cluster-Level Query Settings - description: Returns all cluster-level query settings, including the CURL access settings. - security: - - Default: [] - responses: - 200: - description: An object giving cluster-level query settings. - content: - application/json: - schema: - $ref: "#/components/schemas/Settings" - post: - operationId: post_settings - summary: Update Cluster-Level Query Settings - description: Updates cluster-level query settings, including the CURL access settings. - security: - - Default: [] - requestBody: - description: An object specifying cluster-level query settings. - content: - application/json: - schema: - $ref: "#/components/schemas/Settings" - application/x-www-form-urlencoded: - schema: - $ref: "#/components/schemas/Settings" - responses: - 200: - description: An object giving cluster-level query settings, including the latest changes. - content: - application/json: - schema: - $ref: "#/components/schemas/Settings" - 400: - description: Returns an error message if a parameter or value is incorrect. - content: - application/json: - schema: - type: object - - /settings/querySettings/curlWhitelist: - get: - operationId: get_access - summary: Retrieve CURL Access List - description: Returns the cluster-level CURL access settings only. - security: - - Default: [] - responses: - 200: - description: An object determining which URLs may be accessed by the `CURL()` function. - content: - application/json: - schema: - $ref: "#/components/schemas/Access" - post: - operationId: post_access - summary: Update CURL Access List - description: Updates the cluster-level CURL access settings only. - security: - - Default: [] - requestBody: - description: An object determining which URLs may be accessed by the `CURL()` function. - content: - application/json: - schema: - $ref: "#/components/schemas/Access" - application/x-www-form-urlencoded: - schema: - $ref: "#/components/schemas/Access" - responses: - 200: - description: An object determining which URLs may be accessed by the `CURL()` function, including the latest changes. - content: - application/json: - schema: - $ref: "#/components/schemas/Access" - 400: - description: Returns an error message if a parameter or value is incorrect. - content: - application/json: - schema: - type: object - -# The output of this spec is used in more than one location, so Markdown cannot use relative links. -# Absolute links begin with /cloud -- this must be replaced for every branch. -# Relative links point to a location relative to the REST API reference page by default. -# The x-desc-refs attribute is used to override links when content is transcluded to other locations. - -# The AsciiDoc Markdown converter does not recognize HTML tags like . -# Use the x-desc-name vendor extension to specify the anchor for a property. - -components: - schemas: - Settings: - type: object - title: Settings - properties: - queryCleanupClientAttempts: - type: boolean - default: true - example: false - x-has-default: true - x-has-example: true - x-desc-name: queryCleanupClientAttempts - description: | - When enabled, the Query service preferentially aims to clean up just transactions that it has created, leaving transactions for the distributed cleanup process only when it is forced to. - - The [node-level][cleanupclientattempts] `cleanupclientattempts` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [cleanupclientattempts]: ../n1ql-rest-admin/index.html#cleanupclientattempts - x-desc-refs: | - [cleanupclientattempts]: #cleanupclientattempts - queryCleanupLostAttempts: - type: boolean - default: true - example: false - x-has-default: true - x-has-example: true - x-desc-name: queryCleanupLostAttempts - description: | - When enabled, the Query service takes part in the distributed cleanup process, and cleans up expired transactions created by any client. - - The [node-level][cleanuplostattempts] `cleanuplostattempts` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [cleanuplostattempts]: ../n1ql-rest-admin/index.html#cleanuplostattempts - x-desc-refs: | - [cleanuplostattempts]: #cleanuplostattempts - queryCleanupWindow: - type: string - format: duration - default: 60s - example: 30s - x-has-default: true - x-has-example: true - x-desc-name: queryCleanupWindow - description: | - Specifies how frequently the Query service checks its subset of [active transaction records][additional-storage-use] for cleanup. - Decreasing this setting causes expiration transactions to be found more swiftly, with the tradeoff of increasing the number of reads per second used for the scanning process. - - The value for this setting is a string. - Its format includes an amount and a mandatory unit, e.g. `10ms` (10 milliseconds) or `0.5s` (half a second). - Valid units are: - - * `ns` (nanoseconds) - * `us` (microseconds) - * `ms` (milliseconds) - * `s` (seconds) - * `m` (minutes) - * `h` (hours) - - The [node-level][cleanupwindow] `cleanupwindow` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries - [cleanupwindow]: ../n1ql-rest-admin/index.html#cleanupwindow - x-desc-refs: | - [cleanupwindow]: #cleanupwindow - queryCompletedLimit: - type: integer - format: int32 - default: 4000 - example: 7000 - x-has-default: true - x-has-example: true - x-desc-name: queryCompletedLimit - description: | - Sets the number of requests to be logged in the completed requests catalog. - As new completed requests are added, old ones are removed. - - Increase this when the completed request keyspace is not big enough to track the slow requests, such as when you want a larger sample of slow requests. - - Refer to [Configure the Completed Requests][sys-completed-config] for more information and examples. - - The [node-level][completed-limit] `completed-limit` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [sys-completed-config]: /capella/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config - [completed-limit]: ../n1ql-rest-admin/index.html#completed-limit - x-desc-refs: | - [completed-limit]: #completed-limit - queryCompletedMaxPlanSize: - type: integer - format: int32 - default: 262144 - minimum: 0 - maximum: 20840448 - x-has-default: true - x-desc-name: queryCompletedMaxPlanSize - description: | - This property is available in databases running Couchbase Server 7.6.0 and later. - - A plan size in bytes. - Limits the size of query execution plans that can be logged in the completed requests catalog. - Values larger than the maximum limit are silently treated as the maximum limit. - Queries with plans larger than this are not logged. - You must obtain execution plans for such queries via profiling or using the EXPLAIN statement. - - Refer to [Configure the Completed Requests][sys-completed-config] for more information. - - The [node-level][completed-max-plan-size] `completed-max-plan-size` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [sys-completed-config]: /capella/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config - [completed-max-plan-size]: ../n1ql-rest-admin/index.html#completed-max-plan-size - x-desc-refs: | - [completed-max-plan-size]: #completed-max-plan-size - queryCompletedThreshold: - type: integer - format: int32 - default: 1000 - example: 7000 - x-has-default: true - x-has-example: true - x-desc-name: queryCompletedThreshold - description: | - A duration in milliseconds. - All completed queries lasting longer than this threshold are logged in the completed requests catalog. - - Specify `0` to track all requests, independent of duration. - Specify any negative number to track none. - - Refer to [Configure the Completed Requests][sys-completed-config] for more information and examples. - - The [node-level][completed-threshold] `completed-threshold` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [sys-completed-config]: /capella/n1ql/n1ql-manage/monitoring-n1ql-query.html#sys-completed-config - [completed-threshold]: ../n1ql-rest-admin/index.html#completed-threshold - x-desc-refs: | - [completed-threshold]: #completed-threshold - queryLogLevel: - type: string - default: INFO - enum: ["DEBUG","TRACE","INFO","WARN","ERROR","SEVERE","NONE"] - example: DEBUG - x-has-default: true - x-has-example: true - x-desc-name: queryLogLevel - description: | - Log level used in the logger. - - All values, in descending order of data: - - * `DEBUG` — For developers. - Writes everything. - - * `TRACE` — For developers. - Less info than `DEBUG`. - - * `INFO` — For admin & customers. - Lists warnings & errors. - - * `WARN` — For admin. - Only abnormal items. - - * `ERROR` — For admin. - Only errors to be fixed. - - * `SEVERE` — For admin. - Major items, like crashes. - - * `NONE` — Doesn't write anything. - - The [node-level][loglevel] `loglevel` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [loglevel]: ../n1ql-rest-admin/index.html#loglevel - x-desc-refs: | - [loglevel]: #loglevel - queryMaxParallelism: - type: integer - format: int32 - default: 1 - example: 0 - x-has-default: true - x-has-example: true - x-desc-name: queryMaxParallelism - description: | - Specifies the maximum parallelism for queries on all Query nodes in the cluster. - - If the value is zero or negative, the maximum parallelism is restricted to the number of allowed cores. - Similarly, if the value is greater than the number of allowed cores, the maximum parallelism is restricted to the number of allowed cores. - - (The number of allowed cores is the same as the number of logical CPUs. - In Community Edition, the number of allowed cores cannot be greater than 4. - In Enterprise Edition, there is no limit to the number of allowed cores.) - - The [node-level][max-parallelism-srv] `max-parallelism` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, there is a [request-level][max_parallelism_req] `max_parallelism` parameter. - If a request includes this parameter, it will be capped by the node-level `max-parallelism` setting. - - NOTE: To enable queries to run in parallel, you must specify the cluster-level `queryMaxParallelism` parameter, or specify the node-level `max-parallelism` parameter on all Query nodes. - - Refer to [Max Parallelism][max-parallelism] for more information. - - [max-parallelism]: /cloud/n1ql/n1ql-language-reference/index-partitioning.html#max-parallelism - [max-parallelism-srv]: ../n1ql-rest-admin/index.html#max-parallelism-srv - [max_parallelism_req]: ../n1ql-rest-query/index.html#max_parallelism_req - x-desc-refs: | - [max-parallelism-srv]: #max-parallelism-srv - [max_parallelism_req]: #max_parallelism_req - queryMemoryQuota: - type: integer - format: int32 - default: 0 - example: 4 - x-has-default: true - x-has-example: true - x-desc-name: queryMemoryQuota - description: | - Specifies the maximum amount of memory a request may use on any Query node in the cluster, in MB. - - This parameter enforces a ceiling on the memory used for the tracked documents required for - processing a request. It does not take into account any other memory that might be used to - process a request, such as the stack, the operators, or some intermediate values. - - Within a transaction, this setting enforces the memory quota for the transaction by tracking the - delta table and the transaction log (approximately). - - The [node-level][memory-quota-srv] `memory-quota` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, there is a [request-level][memory_quota_req] `memory_quota` parameter. - If a request includes this parameter, it will be capped by the node-level `memory-quota` setting. - - [memory-quota-srv]: ../n1ql-rest-admin/index.html#memory-quota-srv - [memory_quota_req]: ../n1ql-rest-query/index.html#memory_quota_req - x-desc-refs: | - [memory-quota-srv]: #memory-quota-srv - [memory_quota_req]: #memory_quota_req - queryN1qlFeatCtrl: - type: integer - format: int32 - x-desc-name: queryN1qlFeatCtrl - description: | - SQL++ feature control. - This setting is provided for technical support only. - - The [node-level][n1ql-feat-ctrl] `n1ql-feat-ctrl` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [n1ql-feat-ctrl]: ../n1ql-rest-admin/index.html#n1ql-feat-ctrl - x-desc-refs: | - [n1ql-feat-ctrl]: #n1ql-feat-ctrl - queryNodeQuota: - type: integer - format: int32 - default: 0 - x-has-default: true - x-desc-name: queryNodeQuota - description: | - This property is available in databases running Couchbase Server 7.6.0 and later. - - Sets the soft memory limit for every Query node in the cluster, in MB. - The garbage collector tries to keep below this target. - It is not a hard, absolute limit, and memory usage may exceed this value. - - When set to `0` (the default), there is no soft memory limit. - - The [node-level][node-quota] `node-quota` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [node-quota]: ../n1ql-rest-admin/index.html#node-quota - x-desc-refs: | - [node-quota]: #node-quota - queryNodeQuotaValPercent: - type: integer - format: int32 - default: 67 - minimum: 0 - maximum: 100 - x-has-default: true - x-desc-name: queryNodeQuotaValPercent - description: | - This property is available in databases running Couchbase Server 7.6.0 and later. - - The percentage of the `queryNodeQuota` that is dedicated to tracked value content memory across all active requests for every Query node in the cluster. - (The `queryMemoryQuota` setting specifies the maximum amount of document memory an individual request may use on any Query node in the cluster.) - - The [node-level][node-quota-val-percent] `node-quota-val-percent` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [node-quota-val-percent]: ../n1ql-rest-admin/index.html#node-quota-val-percent - x-desc-refs: | - [node-quota-val-percent]: #node-quota-val-percent - queryNumAtrs: - type: integer - format: int32 - minimum: 0 - exclusiveMinimum: true - default: 1024 - example: 512 - x-has-default: true - x-has-example: true - x-desc-name: queryNumAtrs - description: | - Specifies the total number of [active transaction records][additional-storage-use] for all Query nodes in the cluster. - - The [node-level][numatrs-srv] `numatrs` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, there is a [request-level][numatrs_req] `numatrs` parameter. - If a request includes this parameter, it will be capped by the node-level `numatrs` setting. - - [additional-storage-use]: /server/7.6/learn/data/transactions.html#active-transaction-record-entries - [numatrs-srv]: ../n1ql-rest-admin/index.html#numatrs-srv - [numatrs_req]: ../n1ql-rest-query/index.html#numatrs_req - x-desc-refs: | - [numatrs-srv]: #numatrs-srv - [numatrs_req]: #numatrs_req - queryNumCpus: - type: integer - format: int32 - default: 0 - x-has-default: true - x-desc-name: queryNumCpus - description: | - This property is available in databases running Couchbase Server 7.6.0 and later. - - The number of CPUs the Query service can use on any Query node in the cluster. - Note that this setting requires a restart of the Query service to take effect. - - When set to `0` (the default), the Query service can use all available CPUs, up to the limits described below. - - The number of CPUs can never be greater than the number of logical CPUs. - In Community Edition, the number of allowed CPUs cannot be greater than 4. - In Enterprise Edition, there is no limit to the number of allowed CPUs. - - The [node-level][num-cpus] `num-cpus` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [num-cpus]: ../n1ql-rest-admin/index.html#num-cpus - x-desc-refs: | - [num-cpus]: #num-cpus - queryPipelineBatch: - type: integer - format: int32 - default: 16 - example: 64 - x-has-default: true - x-has-example: true - x-desc-name: queryPipelineBatch - description: | - Controls the number of items execution operators can batch for Fetch from the KV. - - The [node-level][pipeline-batch-srv] `pipeline-batch` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, the [request-level][pipeline_batch_req] `pipeline_batch` parameter specifies this property per request. - The minimum of that and the node-level `pipeline-batch` setting is applied. - - [pipeline-batch-srv]: ../n1ql-rest-admin/index.html#pipeline-batch-srv - [pipeline_batch_req]: ../n1ql-rest-query/index.html#pipeline_batch_req - x-desc-refs: | - [pipeline-batch-srv]: #pipeline-batch-srv - [pipeline_batch_req]: #pipeline_batch_req - queryPipelineCap: - type: integer - format: int32 - default: 512 - example: 1024 - x-has-default: true - x-has-example: true - x-desc-name: queryPipelineCap - description: | - Maximum number of items each execution operator can buffer between various operators. - - The [node-level][pipeline-cap-srv] `pipeline-cap` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, the [request-level][pipeline_cap_req] `pipeline_cap` parameter specifies this property per request. - The minimum of that and the node-level `pipeline-cap` setting is applied. - - [pipeline-cap-srv]: ../n1ql-rest-admin/index.html#pipeline-cap-srv - [pipeline_cap_req]: ../n1ql-rest-query/index.html#pipeline_cap_req - x-desc-refs: | - [pipeline-cap-srv]: #pipeline-cap-srv - [pipeline_cap_req]: #pipeline_cap_req - queryPreparedLimit: - type: integer - format: int32 - default: 16384 - example: 65536 - x-has-default: true - x-has-example: true - x-desc-name: queryPreparedLimit - description: | - Maximum number of prepared statements in the cache. - When this cache reaches the limit, the least recently used prepared statements will be discarded as new prepared statements are created. - - The [node-level][prepared-limit] `prepared-limit` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - [prepared-limit]: ../n1ql-rest-admin/index.html#prepared-limit - x-desc-refs: | - [prepared-limit]: #prepared-limit - queryScanCap: - type: integer - format: int32 - default: 512 - example: 1024 - x-has-default: true - x-has-example: true - x-desc-name: queryScanCap - description: | - Maximum buffered channel size between the indexer client and the query service for index scans. - This parameter controls when to use scan backfill. - - Use `0` or a negative number to disable. - Smaller values reduce GC, while larger values reduce indexer backfill. - - The [node-level][scan-cap-srv] `scan-cap` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, the [request-level][scan_cap_req] `scan_cap` parameter specifies this property per request. - The minimum of that and the node-level `scan-cap` setting is applied. - - [scan-cap-srv]: ../n1ql-rest-admin/index.html#scan-cap-srv - [scan_cap_req]: ../n1ql-rest-query/index.html#scan_cap_req - x-desc-refs: | - [scan-cap-srv]: #scan-cap-srv - [scan_cap_req]: #scan_cap_req - queryTimeout: - type: integer - format: int64 - default: 0 - example: 500000000 - x-has-default: true - x-has-example: true - x-desc-name: queryTimeout - description: | - Maximum time to spend on the request before timing out (ns). - - The value for this setting is an integer, representing a duration in nanoseconds. - It must not be delimited by quotes, and must not include a unit. - - Specify `0` (the default value) or a negative integer to disable. - When disabled, no timeout is applied and the request runs for however long it takes. - - The [node-level][timeout-srv] `timeout` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, the [request-level][timeout_req] `timeout` parameter specifies this property per request. - The minimum of that and the node-level `timeout` setting is applied. - - [timeout-srv]: ../n1ql-rest-admin/index.html#timeout-srv - [timeout_req]: ../n1ql-rest-query/index.html#timeout_req - x-desc-refs: | - [timeout-srv]: #timeout-srv - [timeout_req]: #timeout_req - queryTxTimeout: - type: string - format: duration - default: "0ms" - example: "0.5s" - x-has-default: true - x-has-example: true - x-desc-name: queryTxTimeout - description: | - Maximum time to spend on a transaction before timing out. - This setting only applies to requests containing the `BEGIN TRANSACTION` statement, or to requests where the [tximplicit][tximplicit] parameter is set. - For all other requests, it is ignored. - - The value for this setting is a string. - Its format includes an amount and a mandatory unit, e.g. `10ms` (10 milliseconds) or `0.5s` (half a second). - Valid units are: - - * `ns` (nanoseconds) - * `us` (microseconds) - * `ms` (milliseconds) - * `s` (seconds) - * `m` (minutes) - * `h` (hours) - - Specify `0ms` (the default value) to disable. - When disabled, no timeout is applied and the transaction runs for however long it takes. - - The [node-level][txtimeout-srv] `txtimeout` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, there is a [request-level][txtimeout_req] `txtimeout` parameter. - If a request includes this parameter, it will be capped by the node-level `txtimeout` setting. - - [tximplicit]: ../n1ql-rest-query/index.html#tximplicit - [txtimeout-srv]: ../n1ql-rest-admin/index.html#txtimeout-srv - [txtimeout_req]: ../n1ql-rest-query/index.html#txtimeout_req - x-desc-refs: | - [tximplicit]: #tximplicit - [txtimeout-srv]: #txtimeout-srv - [txtimeout_req]: #txtimeout_req - queryTmpSpaceDir: - type: string - example: "/opt/couchbase/var/lib/couchbase/tmp" - x-has-example: true - x-desc-name: queryTmpSpaceDir - description: | - The path to which the indexer writes temporary backfill files, to store any transient data during query processing. - - The specified path must already exist. - Only absolute paths are allowed. - - The default path is `var/lib/couchbase/tmp` within the Couchbase Server installation directory. - queryTmpSpaceSize: - type: integer - format: int32 - default: 5120 - example: 2048 - x-has-default: true - x-has-example: true - x-desc-name: queryTmpSpaceSize - description: | - The maximum size of temporary backfill files (MB). - - Setting the size to `0` disables backfill. - Setting the size to `-1` means the size is unlimited. - - The maximum size is limited only by the available disk space. - queryUseCBO: - type: boolean - default: true - example: false - x-has-default: true - x-has-example: true - x-desc-name: queryUseCBO - description: | - Specifies whether the cost-based optimizer is enabled. - - The [node-level][use-cbo-srv] `use-cbo` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, the [request-level][use_cbo_req] `use_cbo` parameter specifies this property per request. - If a request does not include this parameter, the node-level setting is used, which defaults to `true`. - - [use-cbo-srv]: ../n1ql-rest-admin/index.html#use-cbo-srv - [use_cbo_req]: ../n1ql-rest-query/index.html#use_cbo_req - x-desc-refs: | - [use-cbo-srv]: #use-cbo-srv - [use_cbo_req]: #use_cbo_req - queryUseReplica: - type: string - default: unset - enum: ["off","on","unset"] - example: "on" - x-has-default: true - x-has-example: true - x-desc-name: queryUseReplica - description: | - Specifies whether a query can fetch data from a replica vBucket if active vBuckets are inaccessible. - The possible values are: - - * `off` — read from replica is disabled for all queries and cannot be overridden at request level. - - * `on` — read from replica is enabled for all queries, but can be disabled at request level. - - * `unset` — read from replica is enabled or disabled at request level. - - The [node-level][use-replica-srv] `use-replica` setting specifies this property for a single node. - When you change the cluster-level setting, the node-level setting is over-written for all nodes in the cluster. - - In addition, the [request-level][use_replica_req] `use_replica` parameter specifies this property per request. - If a request does not include this parameter, or if the request-level parameter is `unset`, the node-level setting is used. - If the request-level parameter and the node-level setting are both `unset`, read from replica is disabled for that request. - - Do not enable read from replica when you require consistent results. - Only SELECT queries that are not within a transaction can read from replica. - - Reading from replica is only possible with databases running Couchbase Server 7.6.0 or later. - - Note that KV range scans cannot currently be started on a replica vBucket. - If a query uses sequential scan and a data node becomes unavailable, the query might return an error, even if read from replica is enabled for the request. - - [use-replica-srv]: ../n1ql-rest-admin/index.html#use-replica-srv - [use_replica_req]: ../n1ql-rest-query/index.html#use_replica_req - x-desc-refs: | - [use-replica-srv]: #use-replica-srv - [use_replica_req]: #use_replica_req - queryCurlWhitelist: - $ref: "#/components/schemas/Access" - - Access: - type: object - x-desc-name: queryCurlWhitelist - description: An object which determines which URLs may be accessed by the `CURL()` function. - required: - - all_access - properties: - all_access: - type: boolean - description: | - Defines whether the user has access to all URLs, or only URLs specified by the access list. - - This field set must be set to `false` to enable the `allowed_urls` and `disallowed_urls` fields. - - Setting this field to `true` enables access to all endpoints. - allowed_urls: - type: array - description: | - An array of strings, each of which is a URL to which you wish to grant access. - Each URL is a prefix match. - The CURL() function will allow any URL that starts with this value. - - For example, if you wish to allow access to all Google APIs, add the URL `https://maps.googleapis.com` to the array. - To allow complete access to `localhost`, use `http://localhost`. - - Note that each URL must include the port, protocol, and all other components of the URL. - default: [] - items: - type: string - disallowed_urls: - type: array - description: | - An array of strings, each of which is a URL that will be restricted for all roles. - Each URL is a prefix match. - The CURL() function will disallow any URL that starts with this value. - - If both `allowed_urls` and `disallowed_urls` fields are populated, the `disallowed_urls` field takes precedence over `allowed_urls`. - - Note that each URL must include the port, protocol, and all other components of the URL. - default: [] - items: - type: string - - securitySchemes: - Default: - type: http - scheme: basic - description: | - Users must have one of the following RBAC roles: - - * Full Admin - * Cluster Admin \ No newline at end of file diff --git a/src/view_engine/readme.adoc b/src/view_engine/readme.adoc deleted file mode 100644 index a285372f..00000000 --- a/src/view_engine/readme.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= view_engine - -This spec does not yet have a swagger2markup gradle build script. \ No newline at end of file diff --git a/templates/index.mustache b/templates/index.mustache index 03b00b9d..50122d05 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}} @@ -118,7 +118,7 @@ The operations are grouped in the following categories. [%hardbreaks] {{#apiInfo}} {{#apis}} -<> +xref:tag-{{baseName}}[] {{/apis}} {{/apiInfo}} endif::[] @@ -145,12 +145,14 @@ endif::[] {{! Table of contents for operations }} [%hardbreaks] {{#operation}} -<<{{operationIdOriginal}}>> +xref:{{operationIdOriginal}}[] {{/operation}} {{! Operation body }} {{#operation}} +//tag::{{operationIdOriginal}}[] + {{! include partial before operation }} {{#specinclude}}/paths/{{operationIdOriginal}}/operation-before.adoc{{/specinclude}} @@ -198,6 +200,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 +251,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}} @@ -335,7 +336,7 @@ a| {{#returnProperty}}{{>schemas}}{{/returnProperty}} {{! Iterate through operation security }} {{#authMethods}} | {{type}}{{#scheme}} ({{scheme}}){{/scheme}} -| <> +| xref:security-{{#lambda.camelcase}}{{name}}{{/lambda.camelcase}}[] {{/authMethods}} {{! If there is operation security: table footer }} @@ -365,6 +366,8 @@ a| {{#returnProperty}}{{>schemas}}{{/returnProperty}} {{! include partials after the operation }} {{#specinclude}}/paths/{{operationIdOriginal}}/operation-after.adoc{{/specinclude}} +//end::{{operationIdOriginal}}[] + {{/operation}} {{/operations}} @@ -458,3 +461,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..49114e8a 100644 --- a/templates/model.mustache +++ b/templates/model.mustache @@ -13,29 +13,30 @@ 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}} +{{#x-additionalPropertiesName}}*<{{this}}>* +{{/x-additionalPropertiesName}}{{/vendorExtensions}} _additional + property_ {{! ADDITIONAL PROPERTY DESCRIPTION }} -a| {{>property}} +a¦ {{>property}} {{! ADDITIONAL PROPERTY SCHEMA }} -a| {{>schemas}} +a¦ {{>schemas}} {{/additionalProperties}} |=== @@ -54,7 +55,7 @@ This schema has alternative properties, depending on the value of *{{discriminat a| `{{mappingName}}` a| {{{model.unescapedDescription}}} -a| <<{{modelName}}>> +a| xref:{{modelName}}[] {{/mappedModels}} |=== {{/discriminator}} diff --git a/templates/models.mustache b/templates/models.mustache index e7de79fa..3d0751be 100644 --- a/templates/models.mustache +++ b/templates/models.mustache @@ -32,7 +32,7 @@ endif::collapse-models[] {{#isEnum}} ifdef::enum-definitions[] {{/isEnum}} -<<{{name}}>> +xref:{{name}}[] {{#isEnum}} endif::enum-definitions[] {{/isEnum}} @@ -102,7 +102,7 @@ endif::collapse-models[] {{#items}} .Schema -{{>schemas}} array +{{>schema}} array {{/items}} {{/isArray}} {{/composedSchemas}} @@ -110,24 +110,63 @@ endif::collapse-models[] .icon:bars[fw] Composite Schema {blank} +{{! tag for partial}} +//tag::{{name}}[] + +{{! Create partial model description }} +{{#description}} +ifdef::model-descriptions[] +//tag::desc-{{name}}[] +{{{unescapedDescription}}} +//end::desc-{{name}}[] +endif::model-descriptions[] +{{/description}} + {{#oneOf}} -{{#-first}}One of the following: +{{#-first}} +[cols="25,55,20",separator=¦] +|=== +¦ One{nbsp}of{nbsp}... ¦ ¦ Schema {{/-first}} -* {{>schemas}} +a¦ {{^-first}}_or_{{/-first}} +a¦ {{>property}} +a¦ {{>schemas}} +{{#-last}} +|=== +{{/-last}} {{/oneOf}} {{#anyOf}} -{{#-first}}Any of the following: +{{#-first}} +[cols="25,55,20",separator=¦] +|=== +¦ Any{nbsp}of{nbsp}... ¦ ¦ Schema {{/-first}} -* {{>schemas}} +a¦ {{^-first}}_and{nbsp}/ or_{{/-first}} +a¦ {{>property}} +a¦ {{>schemas}} +{{#-last}} +|=== +{{/-last}} {{/anyOf}} {{#allOf}} -{{#-first}}All of the following: +{{#-first}} +[cols="25,55,20",separator=¦] +|=== +¦ All{nbsp}of{nbsp}... ¦ ¦ Schema {{/-first}} -* {{>schemas}} +a¦ {{^-first}}_and_{{/-first}} +a¦ {{>property}} +a¦ {{>schemas}} +{{#-last}} +|=== +{{/-last}} {{/allOf}} + +{{! end tag for partial}} +//end::{{name}}[] {{/composedSchemas}} {{! include partial after definition body }} diff --git a/templates/param.mustache b/templates/param.mustache index 9715261c..68e06af2 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,28 +25,20 @@ 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}} -*Minimum:* `{{{minimum}}}` +*Minimum:* `{{{minimum}}}`{{#exclusiveMinimum}} (exclusive){{/exclusiveMinimum}} {{/minimum}} {{! maximum value}} {{#maximum}} -*Maximum:* `{{{maximum}}}` +*Maximum:* `{{{maximum}}}`{{#exclusiveMaximum}} (exclusive){{/exclusiveMaximum}} {{/maximum}} -{{! exclusive minimum value}} -{{#exclusiveMinimum}} -*Exclusive minimum:* `{{{exclusiveMinimum}}}` -{{/exclusiveMinimum}} -{{! exclusive maximum value}} -{{#exclusiveMaximum}} -*Exclusive maximum:* `{{{exclusiveMaximum}}}` -{{/exclusiveMaximum}} {{! multiple of value}} {{#multipleOf}} *Multiple of:* `{{{multipleOf}}}` @@ -74,9 +66,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..173ebcef 100644 --- a/templates/property.mustache +++ b/templates/property.mustache @@ -15,11 +15,28 @@ endif::alt-markdown-links[] {{#description}} {{{unescapedDescription}}} {{/description}} +{{#vendorExtensions}} +{{#x-desc-more}} + +// tag::desc-more[] +{{{this}}} +// end::desc-more[] +{{/x-desc-more}} +{{/vendorExtensions}} {{! if ref is present, fetch remote description}} {{#ref}} include::index.adoc[tag=desc-{{dataType}}, opts=optional] {{/ref}} -- +{{#vendorExtensions}} +{{#x-enumDescriptions}} + +.Enum Descriptions +.... +{{{this}}} +.... +{{/x-enumDescriptions}} +{{/vendorExtensions}} [%hardbreaks] {{! enumerated values}} @@ -30,28 +47,20 @@ 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}} -*Minimum:* `{{{minimum}}}` +*Minimum:* `{{{minimum}}}`{{#exclusiveMinimum}} (exclusive){{/exclusiveMinimum}} {{/minimum}} {{! maximum value}} {{#maximum}} -*Maximum:* `{{{maximum}}}` +*Maximum:* `{{{maximum}}}`{{#exclusiveMaximum}} (exclusive){{/exclusiveMaximum}} {{/maximum}} -{{! exclusive minimum value}} -{{#exclusiveMinimum}} -*Exclusive minimum:* `{{{exclusiveMinimum}}}` -{{/exclusiveMinimum}} -{{! exclusive maximum value}} -{{#exclusiveMaximum}} -*Exclusive maximum:* `{{{exclusiveMaximum}}}` -{{/exclusiveMaximum}} {{! multiple of value}} {{#multipleOf}} *Multiple of:* `{{{multipleOf}}}` @@ -78,6 +87,7 @@ 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}} +{{! OpenAPI generator doesn't support externalDocs in schemas, so don't try }} {blank} \ No newline at end of file diff --git a/templates/schema.mustache b/templates/schema.mustache index 862d8123..c1c83eab 100644 --- a/templates/schema.mustache +++ b/templates/schema.mustache @@ -1,18 +1,18 @@ {{! If this has a reference, create a link to that object; }} {{#ref}} -<<{{dataType}}>> +xref:{{dataType}}[] {{/ref}} {{! ... if it has no reference, then: }} {{^ref}} {{! ... if it's a model, create a link to that object; }} {{#isModel}} -<<{{dataType}}>> +xref:{{dataType}}[] {{/isModel}} {{! ... if it's not a model, then: }} {{^isModel}} {{! ... if it's a map, create a link to that object; }} {{#isMap}} -<<{{dataType}}>> +xref:{{dataType}}[] {{/isMap}} {{! ... if it isn't a map, then: }} {{^isMap}}