From dc87c0ae90d841d9d9db5cf17ed7072cb7a16035 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Wed, 12 Nov 2025 10:04:37 +0000 Subject: [PATCH 01/30] Bundle specs using Redocly --- docs/modules/n1ql-rest-admin/admin.gradle | 26 ++++++------- .../n1ql-rest-functions/functions.gradle | 37 ++++++------------ .../n1ql-rest-query/query-service.gradle | 38 ++++++------------- .../n1ql-rest-settings/query-settings.gradle | 31 ++++++--------- 4 files changed, 48 insertions(+), 84 deletions(-) diff --git a/docs/modules/n1ql-rest-admin/admin.gradle b/docs/modules/n1ql-rest-admin/admin.gradle index 29d90928..79bb7d4a 100644 --- a/docs/modules/n1ql-rest-admin/admin.gradle +++ b/docs/modules/n1ql-rest-admin/admin.gradle @@ -1,22 +1,20 @@ +plugins { + id "com.github.node-gradle.node" version "7.1.0" +} + apply plugin: 'org.openapi.generator' -tasks.register('getExamples') { - doLast { - ant.property(name: "srcUrl", - value: "https://raw.githubusercontent.com/couchbase/query/refs/heads/trinity/docs/spec/admin/examples") - ant.echo("Fetching from ${ant.srcUrl}") - ant.get(dest: "examples", ignoreerrors: "true") { - ant.url(url: "${ant.srcUrl}/get_debug_vars.html") - ant.url(url: "${ant.srcUrl}/get_gc.json") - ant.url(url: "${ant.srcUrl}/get_ping.json") - ant.url(url: "${ant.srcUrl}/post_gc.json") - } - } +task bundleSpec(type: NpxTask) { + command = '@redocly/cli' + args = [ + 'bundle', + 'https://raw.githubusercontent.com/couchbase/query/refs/heads/trinity/docs/spec/admin/admin.yaml', + '-o', 'build/bundle/admin.yaml'] } openApiGenerate { generatorName = "asciidoc" - remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/trinity/docs/spec/admin/admin.yaml" + inputSpec = file("build/bundle/admin.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/n1ql-rest-admin/pages" templateDir = "${rootDir}/templates" gitRepoId = "query" @@ -37,4 +35,4 @@ openApiGenerate { engine = "handlebars" } -tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file +tasks.openApiGenerate.dependsOn(bundleSpec) \ No newline at end of file diff --git a/docs/modules/n1ql-rest-functions/functions.gradle b/docs/modules/n1ql-rest-functions/functions.gradle index 8f448bac..124db98d 100644 --- a/docs/modules/n1ql-rest-functions/functions.gradle +++ b/docs/modules/n1ql-rest-functions/functions.gradle @@ -1,33 +1,20 @@ +plugins { + id "com.github.node-gradle.node" version "7.1.0" +} + apply plugin: 'org.openapi.generator' -tasks.register('getExamples') { - doLast { - ant.property(name: "srcUrl", - value: "https://raw.githubusercontent.com/couchbase/query/refs/heads/trinity/docs/spec/functions/examples") - ant.echo("Fetching from ${ant.srcUrl}") - ant.get(dest: "examples", ignoreerrors: "true") { - ant.url(url: "${ant.srcUrl}/delete_library_global.sh") - ant.url(url: "${ant.srcUrl}/delete_library_scope.sh") - ant.url(url: "${ant.srcUrl}/get_collection_all.sh") - ant.url(url: "${ant.srcUrl}/get_collection_all.json") - ant.url(url: "${ant.srcUrl}/get_collection_scope.sh") - ant.url(url: "${ant.srcUrl}/get_collection_scope.json") - ant.url(url: "${ant.srcUrl}/get_library_global.sh") - ant.url(url: "${ant.srcUrl}/get_library_global.json") - ant.url(url: "${ant.srcUrl}/get_library_scope.sh") - ant.url(url: "${ant.srcUrl}/get_library_scope.json") - ant.url(url: "${ant.srcUrl}/post_library_global_add.sh") - ant.url(url: "${ant.srcUrl}/post_library_global_create.sh") - ant.url(url: "${ant.srcUrl}/post_library_global_delete.sh") - ant.url(url: "${ant.srcUrl}/post_library_global_edit.sh") - ant.url(url: "${ant.srcUrl}/post_library_scope.sh") - } - } +task bundleSpec(type: NpxTask) { + command = '@redocly/cli' + args = [ + 'bundle', + 'https://raw.githubusercontent.com/couchbase/query/refs/heads/trinity/docs/spec/functions/functions.yaml', + '-o', 'build/bundle/functions.yaml'] } openApiGenerate { generatorName = "asciidoc" - remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/trinity/docs/spec/functions/functions.yaml" + inputSpec = file("build/bundle/functions.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/n1ql-rest-functions/pages" templateDir = "${rootDir}/templates" gitRepoId = "query" @@ -48,4 +35,4 @@ openApiGenerate { engine = "handlebars" } -tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file +tasks.openApiGenerate.dependsOn(bundleSpec) \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/query-service.gradle b/docs/modules/n1ql-rest-query/query-service.gradle index d6d3f2f3..8a6cb7d5 100644 --- a/docs/modules/n1ql-rest-query/query-service.gradle +++ b/docs/modules/n1ql-rest-query/query-service.gradle @@ -1,34 +1,20 @@ +plugins { + id "com.github.node-gradle.node" version "7.1.0" +} + apply plugin: 'org.openapi.generator' -tasks.register('getExamples') { - doLast { - ant.property(name: "srcUrl", - value: "https://raw.githubusercontent.com/couchbase/query/refs/heads/trinity/docs/spec/service/examples") - ant.echo("Fetching from ${ant.srcUrl}") - ant.get(dest: "examples", ignoreerrors: "true") { - ant.url(url: "${ant.srcUrl}/exformdata.sh") - ant.url(url: "${ant.srcUrl}/exn1qlerror.json") - ant.url(url: "${ant.srcUrl}/exnamed.json") - ant.url(url: "${ant.srcUrl}/exnamed.sh") - ant.url(url: "${ant.srcUrl}/exnotfound.json") - ant.url(url: "${ant.srcUrl}/exnumbered.json") - ant.url(url: "${ant.srcUrl}/exnumbered.sh") - ant.url(url: "${ant.srcUrl}/expositional.json") - ant.url(url: "${ant.srcUrl}/expositional.sh") - ant.url(url: "${ant.srcUrl}/exreadonly.sh") - ant.url(url: "${ant.srcUrl}/exrequesterror.json") - ant.url(url: "${ant.srcUrl}/exserviceerror.json") - ant.url(url: "${ant.srcUrl}/exsuccessful.json") - ant.url(url: "${ant.srcUrl}/exsuccessful.sh") - ant.url(url: "${ant.srcUrl}/exwildcard.json") - ant.url(url: "${ant.srcUrl}/exwildcard.sh") - } - } +task bundleSpec(type: NpxTask) { + command = '@redocly/cli' + args = [ + 'bundle', + 'https://raw.githubusercontent.com/couchbase/query/refs/heads/trinity/docs/spec/service/service.yaml', + '-o', 'build/bundle/service.yaml'] } openApiGenerate { generatorName = "asciidoc" - remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/trinity/docs/spec/service/service.yaml" + inputSpec = file("build/bundle/service.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/n1ql-rest-query/pages" templateDir = "${rootDir}/templates" gitRepoId = "query" @@ -49,4 +35,4 @@ openApiGenerate { engine = "handlebars" } -tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file +tasks.openApiGenerate.dependsOn(bundleSpec) \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/query-settings.gradle b/docs/modules/n1ql-rest-settings/query-settings.gradle index 20b09277..c918de2d 100644 --- a/docs/modules/n1ql-rest-settings/query-settings.gradle +++ b/docs/modules/n1ql-rest-settings/query-settings.gradle @@ -1,27 +1,20 @@ +plugins { + id "com.github.node-gradle.node" version "7.1.0" +} + apply plugin: 'org.openapi.generator' -tasks.register('getExamples') { - doLast { - ant.property(name: "srcUrl", - value: "https://raw.githubusercontent.com/couchbase/query/refs/heads/trinity/docs/spec/settings/examples") - ant.echo("Fetching from ${ant.srcUrl}") - ant.get(dest: "examples", ignoreerrors: "true") { - ant.url(url: "${ant.srcUrl}/query-settings-get-access.json") - ant.url(url: "${ant.srcUrl}/query-settings-get-access.sh") - ant.url(url: "${ant.srcUrl}/query-settings-get-settings.json") - ant.url(url: "${ant.srcUrl}/query-settings-get-settings.sh") - ant.url(url: "${ant.srcUrl}/query-settings-post-access.json") - ant.url(url: "${ant.srcUrl}/query-settings-post-access.sh") - ant.url(url: "${ant.srcUrl}/query-settings-post-settings.json") - ant.url(url: "${ant.srcUrl}/query-settings-post-settings.sh") - ant.url(url: "${ant.srcUrl}/query-settings-post-snippet.json") - } - } +task bundleSpec(type: NpxTask) { + command = '@redocly/cli' + args = [ + 'bundle', + 'https://raw.githubusercontent.com/couchbase/query/refs/heads/trinity/docs/spec/settings/settings.yaml', + '-o', 'build/bundle/settings.yaml'] } openApiGenerate { generatorName = "asciidoc" - remoteInputSpec = "https://raw.githubusercontent.com/couchbase/query/refs/heads/trinity/docs/spec/settings/settings.yaml" + inputSpec = file("build/bundle/settings.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/n1ql-rest-settings/pages" templateDir = "${rootDir}/templates" gitRepoId = "query" @@ -42,4 +35,4 @@ openApiGenerate { engine = "handlebars" } -tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file +tasks.openApiGenerate.dependsOn(bundleSpec) \ No newline at end of file From b8ff94fb679c58af3fe6b371a41dd170aadf2373 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Wed, 12 Nov 2025 10:06:18 +0000 Subject: [PATCH 02/30] Build inline examples --- templates/index.handlebars | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/templates/index.handlebars b/templates/index.handlebars index 4ca774b5..ff1df2a2 100644 --- a/templates/index.handlebars +++ b/templates/index.handlebars @@ -317,6 +317,42 @@ include::{specDir}paths/{{operationIdOriginal}}/operation-security-after.adoc[op include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] +{{#responses.content.application/json.example}} += Example HTTP Response +{{/responses.content.application/json.example}} +{{#responses}} +{{#content}} +{{#application/json}} +{{#examples}} +{{{this}}} + +.Response {{code}} +==== +{{#summary}} +.{{{summary}}} +{{/summary}} +[source,json] +---- +{{{value}}} +---- +==== +{{/examples}} +{{#example}} +{{#-first}} + +.Response {{code}} +==== +[source,json] +---- +{{{example}}} +---- +==== +{{/-first}} +{{/example}} +{{/application/json}} +{{/content}} +{{/responses}} + include::{snippetDir}{{operationIdOriginal}}/http-response.adoc[opts=optional] include::{specDir}paths/{{operationIdOriginal}}/operation-end.adoc[opts=optional] From a11f79db1498babb92962229b7e8bc2a8b18b30a Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Fri, 30 Jan 2026 17:03:38 +0000 Subject: [PATCH 03/30] Update README for this PoC --- README.adoc | 72 ++++++++++++++--------------------------------------- 1 file changed, 18 insertions(+), 54 deletions(-) diff --git a/README.adoc b/README.adoc index acfe366e..55cdf800 100644 --- a/README.adoc +++ b/README.adoc @@ -1,56 +1,20 @@ = Couchbase Swagger Project -This project uses the https://openapi-generator.tech/docs/plugins/#gradle[OpenAPI Generator Gradle Plugin] to convert the OpenAPI specifications for Couchbase Server Developer REST APIs into AsciiDoctor documentation. - -== Usage guide - -This repository handles several OpenAPI subprojects. -Each subproject is stored in its own subfolder within the `docs/modules` folder. - -=== Build Script - -Within each subproject there is a gradle build script with a `.gradle` extension. -The gradle build script specifies the locations of the OpenAPI source file, any additional AsciiDoc content, and the output AsciiDoc files. - -The `build.gradle` script in the root project folder calls the gradle build scripts from each subproject. - -Some subprojects are not currently ready to be built. -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 `attachments`. -(For some subprojects, the OpenAPI specification file may be stored remotely, i.e. alongside the development source files.) - -=== AsciiDoc Content - -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. - -=== Convert a single subproject - -[subs="normal"] ----- -./gradlew _project_:openApiGenerate --rerun-tasks ----- - -Where `_project_` is the subproject that you want to convert, for example, `admin`. - -=== Convert all projects - -[subs="normal"] ----- -./gradlew --rerun-tasks ----- - -== Acknowledgements - -This project is based on the https://openapi-generator.tech/[OpenAPI Generator] project. - -== Licensing - -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. +This proof-of-concept attempts to build inline examples into the AsciiDoc output using external example files referenced by the spec. + +The process needs to handle single examples using the `example` key and multiple examples using the `examples` key, in both the request body and the responses. + +* [x] The examples must be bundled into the spec. + OpenAPI Generator does not do this. + The Gradle build uses Redocly to bundle the examples. +* [x] OpenAPI continues to generate examples, even if inline examples are provided. + The generated examples are stored in a different part of OpenAPI Generator's internal representation of the spec. + Continue to set `skipExamples` to `true` so the generated examples are not included. +* [x] The inline examples are placed in the output in the same location where included example AsciiDoc file are placed by the OpenAPI Generator templates. +* [x] The OpenAPI Generator templates remove all line breaks and white space from the inline examples. + The external example files should use the `jsonc` extension, so that line breaks are preserved in the output doc. +* [x] Multiple examples using the `examples` key should use the `externalValue` to reference the external example files. + Otherwise, Redocly does not bundle the external example into the spec. +* [x] The templates cannot work with multiple examples, because Mustache has no way of parsing an object whose keys are not known. + To fix this issue, try migrating the templates to Handlebars. + This is beyond the scope of this proof-of-concept. \ No newline at end of file From 46f2c60658c40a9f62f2242565a2c501ff905608 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Fri, 30 Jan 2026 17:04:22 +0000 Subject: [PATCH 04/30] Update inline example code for handlebars --- templates/index.handlebars | 89 ++++++++++++++++++++++++++++---------- 1 file changed, 66 insertions(+), 23 deletions(-) diff --git a/templates/index.handlebars b/templates/index.handlebars index ff1df2a2..b4c6ffbf 100644 --- a/templates/index.handlebars +++ b/templates/index.handlebars @@ -315,43 +315,86 @@ include::{specDir}paths/{{operationIdOriginal}}/operation-security-after.adoc[op {{!~ Include partials for operation sample requests and responses }} {{!~ The partials should have a level 1 title; the level offset pushes the title down to the correct section level. }} +{{#each vendorExtensions.x-codeSamples ~}} +{{#if @first ~}} +[#{{operationIdOriginal}}-ex-req] += Example HTTP Request + +==== +{{/if ~}} +{{#with label~}} +[#{{operationIdOriginal}}-ex-req-{{#slugify}}{{this}}{{/slugify}}] +.{{{this}}} +{{~/with}} +[source,sh]{{!-- FIXME: {{#with lang}},{{#lower}}{{this}}{{/lower}}{{/with}} --}} +---- +{{{source}}} +---- +{{#if @last ~}} +==== +{{/if}} +{{/each}} + include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] -{{#responses.content.application/json.example}} -= Example HTTP Response -{{/responses.content.application/json.example}} -{{#responses}} -{{#content}} -{{#application/json}} -{{#examples}} -{{{this}}} +// FIXME: Response examples +{{#each responses ~}} +{{#with content.[application/json] ~}} +{{#with example ~}} -.Response {{code}} +.Response {{#if code}}{{code}}{{else}}(default){{/if}} ==== -{{#summary}} -.{{{summary}}} -{{/summary}} [source,json] ---- -{{{value}}} +{{#json pretty=true}}{{{this}}}{{/json}} ---- ==== -{{/examples}} -{{#example}} -{{#-first}} +{{else each examples ~}} +{{#if @first ~}} -.Response {{code}} +.Response {{#if code}}{{code}}{{else}}(default){{/if}} ==== +{{/if ~}} +{{#with summary~}} +.{{{this}}} +{{~/with}} [source,json] ---- -{{{example}}} +{{#with value}}{{#json pretty=true}}{{{this}}}{{/json}}{{/with}} ---- +{{#if @last ~}} ==== -{{/-first}} -{{/example}} -{{/application/json}} -{{/content}} -{{/responses}} +{{/if}} +{{/with}}{{! example }} +{{~else with content.[text/html] ~}} +{{#with example ~}} + +.Response {{code}} +==== +[source,html] +---- +{{{this}}} +---- +==== +{{else each examples ~}} +{{#if @first ~}} + +.Response {{code}} +==== +{{/if ~}} +{{#with summary~}} +.{{{this}}} +{{~/with}} +[source,html] +---- +{{#with value}}{{{this}}}{{/with}} +---- +{{#if @last ~}} +==== +{{/if}} +{{/with}}{{! example }} +{{~/with}}{{! content.[application/json] }} +{{~/each}}{{! responses }} include::{snippetDir}{{operationIdOriginal}}/http-response.adoc[opts=optional] From c867d682831d68571e797523afdcab2beb0ccf68 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Fri, 30 Jan 2026 17:06:11 +0000 Subject: [PATCH 05/30] Update FTS builds to bundle specs using Redocly --- .../fts-rest-advanced/search-advanced.gradle | 23 ++++----- .../fts-rest-indexing/search-index.gradle | 49 +++++-------------- .../fts-rest-manage/search-manage.gradle | 26 +++++----- .../fts-rest-nodes/search-nodes.gradle | 25 +++++----- .../fts-rest-query/search-query.gradle | 30 +++++------- .../fts-rest-stats/search-stats.gradle | 25 +++++----- 6 files changed, 72 insertions(+), 106 deletions(-) diff --git a/docs/modules/fts-rest-advanced/search-advanced.gradle b/docs/modules/fts-rest-advanced/search-advanced.gradle index 5abeae38..d72d1fb5 100644 --- a/docs/modules/fts-rest-advanced/search-advanced.gradle +++ b/docs/modules/fts-rest-advanced/search-advanced.gradle @@ -1,19 +1,20 @@ +plugins { + id "com.github.node-gradle.node" version "7.1.0" +} + apply plugin: 'org.openapi.generator' -tasks.register('getExamples') { - doLast { - ant.property(name: "srcUrl", - value: "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/advanced/examples") - ant.echo("Fetching from ${ant.srcUrl}") - ant.get(dest: "examples", ignoreerrors: "true") { - ant.url(url: "${ant.srcUrl}/get-partition.json") - } - } +task bundleSpec(type: NpxTask) { + command = '@redocly/cli' + args = [ + 'bundle', + 'https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/advanced/advanced.yaml', + '-o', 'build/bundle/advanced.yaml'] } openApiGenerate { generatorName = "asciidoc" - remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/advanced/advanced.yaml" + inputSpec = file("build/bundle/advanced.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/fts-rest-advanced/pages" templateDir = "${rootDir}/templates" gitRepoId = "cbft" @@ -34,4 +35,4 @@ openApiGenerate { engine = "handlebars" } -tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file +tasks.openApiGenerate.dependsOn(bundleSpec) \ 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 index 018fbdf3..b86768a0 100644 --- a/docs/modules/fts-rest-indexing/search-index.gradle +++ b/docs/modules/fts-rest-indexing/search-index.gradle @@ -1,45 +1,20 @@ +plugins { + id "com.github.node-gradle.node" version "7.1.0" +} + apply plugin: 'org.openapi.generator' -tasks.register('getExamples') { - doLast { - ant.property(name: "srcUrl", - value: "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/index/examples") - ant.echo("Fetching from ${ant.srcUrl}") - ant.get(dest: "examples", ignoreerrors: "true") { - ant.url(url: "${ant.srcUrl}/d-api-index-name-200.json") - ant.url(url: "${ant.srcUrl}/d-api-index-name-default.json") - ant.url(url: "${ant.srcUrl}/d-api-scoped-index-name-200.json") - ant.url(url: "${ant.srcUrl}/d-api-scoped-index-name-default.json") - ant.url(url: "${ant.srcUrl}/fts-sample-index-def-response.json") - ant.url(url: "${ant.srcUrl}/fts-sample-success-response-vector-search.json") - ant.url(url: "${ant.srcUrl}/fts-sample-success-response.json") - ant.url(url: "${ant.srcUrl}/g-api-index-name-count.json") - ant.url(url: "${ant.srcUrl}/g-api-index-name.json") - ant.url(url: "${ant.srcUrl}/g-api-index.json") - ant.url(url: "${ant.srcUrl}/g-api-scoped-indexes.json") - ant.url(url: "${ant.srcUrl}/g-api-scoped-status.json") - ant.url(url: "${ant.srcUrl}/g-api-stats-index-name-analyzeDoc-200.json") - ant.url(url: "${ant.srcUrl}/g-api-stats-index-name-analyzeDoc-body.json") - ant.url(url: "${ant.srcUrl}/g-api-stats-index-name.json") - ant.url(url: "${ant.srcUrl}/g-api-stats.json") - ant.url(url: "${ant.srcUrl}/p-api-index-name-200.json") - ant.url(url: "${ant.srcUrl}/p-api-index-name-default.json") - ant.url(url: "${ant.srcUrl}/p-api-index-name-query-hybrid.json") - ant.url(url: "${ant.srcUrl}/p-api-index-name-query-options.json") - ant.url(url: "${ant.srcUrl}/p-api-index-name-query-regular.json") - ant.url(url: "${ant.srcUrl}/p-api-pindex-lookup-200.json") - ant.url(url: "${ant.srcUrl}/p-api-pindex-lookup-body.json") - ant.url(url: "${ant.srcUrl}/p-api-scoped-index-name-200.json") - ant.url(url: "${ant.srcUrl}/p-api-scoped-index-name-default.json") - ant.url(url: "${ant.srcUrl}/p-api-scoped-query-default.json") - ant.url(url: "${ant.srcUrl}/response-200.json") - } - } +task bundleSpec(type: NpxTask) { + command = '@redocly/cli' + args = [ + 'bundle', + 'https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/index/index.yaml', + '-o', 'build/bundle/index.yaml'] } openApiGenerate { generatorName = "asciidoc" - remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/index/index.yaml" + inputSpec = file("build/bundle/index.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/fts-rest-indexing/pages" templateDir = "${rootDir}/templates" gitRepoId = "cbft" @@ -60,4 +35,4 @@ openApiGenerate { engine = "handlebars" } -tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file +tasks.openApiGenerate.dependsOn(bundleSpec) \ No newline at end of file diff --git a/docs/modules/fts-rest-manage/search-manage.gradle b/docs/modules/fts-rest-manage/search-manage.gradle index cdabd927..e93170ac 100644 --- a/docs/modules/fts-rest-manage/search-manage.gradle +++ b/docs/modules/fts-rest-manage/search-manage.gradle @@ -1,22 +1,20 @@ +plugins { + id "com.github.node-gradle.node" version "7.1.0" +} + apply plugin: 'org.openapi.generator' -tasks.register('getExamples') { - doLast { - ant.property(name: "srcUrl", - value: "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/manage/examples") - ant.echo("Fetching from ${ant.srcUrl}") - ant.get(dest: "examples", ignoreerrors: "true") { - ant.url(url: "${ant.srcUrl}/file-xfer-200.json") - ant.url(url: "${ant.srcUrl}/file-xfer-405.json") - ant.url(url: "${ant.srcUrl}/file-xfer-disable.sh") - ant.url(url: "${ant.srcUrl}/file-xfer-enable.sh") - } - } +task bundleSpec(type: NpxTask) { + command = '@redocly/cli' + args = [ + 'bundle', + 'https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/manage/manage.yaml', + '-o', 'build/bundle/manage.yaml'] } openApiGenerate { generatorName = "asciidoc" - remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/manage/manage.yaml" + inputSpec = file("build/bundle/manage.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/fts-rest-manage/pages" templateDir = "${rootDir}/templates" gitRepoId = "cbft" @@ -37,4 +35,4 @@ openApiGenerate { engine = "handlebars" } -tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file +tasks.openApiGenerate.dependsOn(bundleSpec) \ 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 index f4c6aa03..b586e22c 100644 --- a/docs/modules/fts-rest-nodes/search-nodes.gradle +++ b/docs/modules/fts-rest-nodes/search-nodes.gradle @@ -1,21 +1,20 @@ +plugins { + id "com.github.node-gradle.node" version "7.1.0" +} + apply plugin: 'org.openapi.generator' -tasks.register('getExamples') { - doLast { - ant.property(name: "srcUrl", - value: "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/nodes/examples") - ant.echo("Fetching from ${ant.srcUrl}") - ant.get(dest: "examples", ignoreerrors: "true") { - ant.url(url: "${ant.srcUrl}/get-cluster-config.json") - ant.url(url: "${ant.srcUrl}/get-logs.json") - ant.url(url: "${ant.srcUrl}/get-runtime-info.json") - } - } +task bundleSpec(type: NpxTask) { + command = '@redocly/cli' + args = [ + 'bundle', + 'https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/nodes/nodes.yaml', + '-o', 'build/bundle/nodes.yaml'] } openApiGenerate { generatorName = "asciidoc" - remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/nodes/nodes.yaml" + inputSpec = file("build/bundle/nodes.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/fts-rest-nodes/pages" templateDir = "${rootDir}/templates" gitRepoId = "cbft" @@ -36,4 +35,4 @@ openApiGenerate { engine = "handlebars" } -tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file +tasks.openApiGenerate.dependsOn(bundleSpec) \ 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 index bd0bdd76..44bca007 100644 --- a/docs/modules/fts-rest-query/search-query.gradle +++ b/docs/modules/fts-rest-query/search-query.gradle @@ -1,26 +1,20 @@ +plugins { + id "com.github.node-gradle.node" version "7.1.0" +} + apply plugin: 'org.openapi.generator' -tasks.register('getExamples') { - doLast { - ant.property(name: "srcUrl", - value: "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/query/examples") - ant.echo("Fetching from ${ant.srcUrl}") - ant.get(dest: "examples", ignoreerrors: "true") { - ant.url(url: "${ant.srcUrl}/api-query-all.json") - ant.url(url: "${ant.srcUrl}/api-query-all.sh") - ant.url(url: "${ant.srcUrl}/api-query-cancel.json") - ant.url(url: "${ant.srcUrl}/api-query-cancel.sh") - ant.url(url: "${ant.srcUrl}/api-query-filter.json") - ant.url(url: "${ant.srcUrl}/api-query-filter.sh") - ant.url(url: "${ant.srcUrl}/api-query-index.json") - ant.url(url: "${ant.srcUrl}/api-query-index.sh") - } - } +task bundleSpec(type: NpxTask) { + command = '@redocly/cli' + args = [ + 'bundle', + 'https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/query/query.yaml', + '-o', 'build/bundle/query.yaml'] } openApiGenerate { generatorName = "asciidoc" - remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/query/query.yaml" + inputSpec = file("build/bundle/query.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/fts-rest-query/pages" templateDir = "${rootDir}/templates" gitRepoId = "cbft" @@ -41,4 +35,4 @@ openApiGenerate { engine = "handlebars" } -tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file +tasks.openApiGenerate.dependsOn(bundleSpec) \ 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 index a8d2280c..cdebedda 100644 --- a/docs/modules/fts-rest-stats/search-stats.gradle +++ b/docs/modules/fts-rest-stats/search-stats.gradle @@ -1,21 +1,20 @@ +plugins { + id "com.github.node-gradle.node" version "7.1.0" +} + apply plugin: 'org.openapi.generator' -tasks.register('getExamples') { - doLast { - ant.property(name: "srcUrl", - value: "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/stats/examples") - ant.echo("Fetching from ${ant.srcUrl}") - ant.get(dest: "examples", ignoreerrors: "true") { - ant.url(url: "${ant.srcUrl}/g-api-nsstats-200.json") - ant.url(url: "${ant.srcUrl}/g-api-nsstats-403.json") - ant.url(url: "${ant.srcUrl}/g-api-nsstats-index-name.json") - } - } +task bundleSpec(type: NpxTask) { + command = '@redocly/cli' + args = [ + 'bundle', + 'https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/stats/stats.yaml', + '-o', 'build/bundle/stats.yaml'] } openApiGenerate { generatorName = "asciidoc" - remoteInputSpec = "https://raw.githubusercontent.com/couchbase/cbft/refs/heads/trinity/docs/spec/stats/stats.yaml" + inputSpec = file("build/bundle/stats.yaml").getAbsolutePath().toString() outputDir = "${rootDir}/docs/modules/fts-rest-stats/pages" templateDir = "${rootDir}/templates" gitRepoId = "cbft" @@ -36,4 +35,4 @@ openApiGenerate { engine = "handlebars" } -tasks.openApiGenerate.dependsOn(getExamples) \ No newline at end of file +tasks.openApiGenerate.dependsOn(bundleSpec) \ No newline at end of file From 11eb12afeb14fa337a90f293dd52a73b49c6306f Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Fri, 30 Jan 2026 17:10:20 +0000 Subject: [PATCH 06/30] =?UTF-8?q?Update=20FTS=20request=20example=20partia?= =?UTF-8?q?ls=20=E2=80=94=20they're=20just=20explanations=20now?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../paths/put_options/http-request.adoc | 24 ++----------------- .../paths/api-query-cancel/http-request.adoc | 12 +--------- .../paths/api-query-index/http-request.adoc | 13 +--------- .../paths/api-query/http-request.adoc | 24 ++----------------- 4 files changed, 6 insertions(+), 67 deletions(-) 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 index d8746c66..66497dbb 100644 --- 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 @@ -1,25 +1,5 @@ -= 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[] ----- -==== - +The <> request disables the creation of new partitions by means of file transfer. 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[] ----- -==== - +The <> request re-enables the creation of new partitions by means of file transfer. 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-query/partials/paths/api-query-cancel/http-request.adoc b/docs/modules/fts-rest-query/partials/paths/api-query-cancel/http-request.adoc index d322997c..c23a9b1f 100644 --- 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 @@ -1,11 +1 @@ -= 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 +This request cancels a long running query with query ID `24` whose coordinator node has a UUID `b91d75480470f979f65f04e8f20a1f7b`. \ 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 index 36020aef..f8a73b36 100644 --- 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 @@ -1,12 +1 @@ -= Example HTTP Request - -Request 1: Find queries on the index `DemoIndex1` that have been running for longer than 1{nbsp}ms. - -[#request-1] -==== -.curl request -[source,sh] ----- -include::example$api-query-index.sh[] ----- -==== \ No newline at end of file +This request finds queries on the index `DemoIndex1` that have been running for longer than 1{nbsp}ms. \ 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 index 3fec2028..1b369ca0 100644 --- 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 @@ -1,23 +1,3 @@ -= Example HTTP Request +The <> request finds all active queries across the Search cluster. -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 7{nbsp}s. - -[#request-3] -==== -.curl request -[source,sh] ----- -include::example$api-query-filter.sh[] ----- -==== \ No newline at end of file +The <> request finds all queries across the cluster that have been running for longer than 7{nbsp}s. \ No newline at end of file From 805c1498f913d063e403da38642ab55c2571648a Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Fri, 30 Jan 2026 17:14:55 +0000 Subject: [PATCH 07/30] Remove local FTS examples --- .../examples/get-partition.json | 18 -- .../examples/d-api-index-name-200.json | 4 - .../examples/d-api-index-name-default.json | 5 - .../examples/d-api-scoped-index-name-200.json | 4 - .../d-api-scoped-index-name-default.json | 5 - .../fts-sample-index-def-response.json | 167 ----------- ...sample-success-response-vector-search.json | 55 ---- .../examples/fts-sample-success-response.json | 261 ------------------ .../examples/g-api-index-name-count.json | 4 - .../examples/g-api-index-name.json | 43 --- .../examples/g-api-index.json | 26 -- .../examples/g-api-scoped-indexes.json | 118 -------- .../examples/g-api-scoped-status.json | 4 - ...g-api-stats-index-name-analyzeDoc-200.json | 118 -------- ...-api-stats-index-name-analyzeDoc-body.json | 4 - .../examples/g-api-stats-index-name.json | 159 ----------- .../examples/g-api-stats.json | 41 --- .../examples/p-api-index-name-200.json | 5 - .../examples/p-api-index-name-default.json | 5 - .../p-api-index-name-query-hybrid.json | 18 -- .../p-api-index-name-query-options.json | 29 -- .../p-api-index-name-query-regular.json | 12 - .../examples/p-api-pindex-lookup-200.json | 8 - .../examples/p-api-pindex-lookup-body.json | 3 - .../examples/p-api-scoped-index-name-200.json | 5 - .../p-api-scoped-index-name-default.json | 5 - .../examples/p-api-scoped-query-default.json | 49 ---- .../examples/response-200.json | 3 - .../examples/file-xfer-200.json | 3 - .../examples/file-xfer-405.json | 4 - .../examples/file-xfer-disable.sh | 4 - .../examples/file-xfer-enable.sh | 4 - .../examples/get-cluster-config.json | 93 ------- .../fts-rest-nodes/examples/get-logs.json | 4 - .../examples/get-runtime-info.json | 13 - .../examples/api-query-all.json | 61 ---- .../fts-rest-query/examples/api-query-all.sh | 3 - .../examples/api-query-cancel.json | 4 - .../examples/api-query-cancel.sh | 3 - .../examples/api-query-filter.json | 26 -- .../examples/api-query-filter.sh | 3 - .../examples/api-query-index.json | 39 --- .../examples/api-query-index.sh | 3 - .../examples/g-api-nsstats-200.json | 164 ----------- .../examples/g-api-nsstats-403.json | 6 - .../examples/g-api-nsstats-index-name.json | 57 ---- 46 files changed, 1672 deletions(-) delete mode 100644 docs/modules/fts-rest-advanced/examples/get-partition.json delete mode 100644 docs/modules/fts-rest-indexing/examples/d-api-index-name-200.json delete mode 100644 docs/modules/fts-rest-indexing/examples/d-api-index-name-default.json delete mode 100644 docs/modules/fts-rest-indexing/examples/d-api-scoped-index-name-200.json delete mode 100644 docs/modules/fts-rest-indexing/examples/d-api-scoped-index-name-default.json delete mode 100644 docs/modules/fts-rest-indexing/examples/fts-sample-index-def-response.json delete mode 100644 docs/modules/fts-rest-indexing/examples/fts-sample-success-response-vector-search.json delete mode 100644 docs/modules/fts-rest-indexing/examples/fts-sample-success-response.json delete mode 100644 docs/modules/fts-rest-indexing/examples/g-api-index-name-count.json delete mode 100644 docs/modules/fts-rest-indexing/examples/g-api-index-name.json delete mode 100644 docs/modules/fts-rest-indexing/examples/g-api-index.json delete mode 100644 docs/modules/fts-rest-indexing/examples/g-api-scoped-indexes.json delete mode 100644 docs/modules/fts-rest-indexing/examples/g-api-scoped-status.json delete mode 100644 docs/modules/fts-rest-indexing/examples/g-api-stats-index-name-analyzeDoc-200.json delete mode 100644 docs/modules/fts-rest-indexing/examples/g-api-stats-index-name-analyzeDoc-body.json delete mode 100644 docs/modules/fts-rest-indexing/examples/g-api-stats-index-name.json delete mode 100644 docs/modules/fts-rest-indexing/examples/g-api-stats.json delete mode 100644 docs/modules/fts-rest-indexing/examples/p-api-index-name-200.json delete mode 100644 docs/modules/fts-rest-indexing/examples/p-api-index-name-default.json delete mode 100644 docs/modules/fts-rest-indexing/examples/p-api-index-name-query-hybrid.json delete mode 100644 docs/modules/fts-rest-indexing/examples/p-api-index-name-query-options.json delete mode 100644 docs/modules/fts-rest-indexing/examples/p-api-index-name-query-regular.json delete mode 100644 docs/modules/fts-rest-indexing/examples/p-api-pindex-lookup-200.json delete mode 100644 docs/modules/fts-rest-indexing/examples/p-api-pindex-lookup-body.json delete mode 100644 docs/modules/fts-rest-indexing/examples/p-api-scoped-index-name-200.json delete mode 100644 docs/modules/fts-rest-indexing/examples/p-api-scoped-index-name-default.json delete mode 100644 docs/modules/fts-rest-indexing/examples/p-api-scoped-query-default.json delete mode 100644 docs/modules/fts-rest-indexing/examples/response-200.json delete mode 100644 docs/modules/fts-rest-manage/examples/file-xfer-200.json delete mode 100644 docs/modules/fts-rest-manage/examples/file-xfer-405.json delete mode 100644 docs/modules/fts-rest-manage/examples/file-xfer-disable.sh delete mode 100644 docs/modules/fts-rest-manage/examples/file-xfer-enable.sh delete mode 100644 docs/modules/fts-rest-nodes/examples/get-cluster-config.json delete mode 100644 docs/modules/fts-rest-nodes/examples/get-logs.json delete mode 100644 docs/modules/fts-rest-nodes/examples/get-runtime-info.json delete mode 100644 docs/modules/fts-rest-query/examples/api-query-all.json delete mode 100644 docs/modules/fts-rest-query/examples/api-query-all.sh delete mode 100644 docs/modules/fts-rest-query/examples/api-query-cancel.json delete mode 100644 docs/modules/fts-rest-query/examples/api-query-cancel.sh delete mode 100644 docs/modules/fts-rest-query/examples/api-query-filter.json delete mode 100644 docs/modules/fts-rest-query/examples/api-query-filter.sh delete mode 100644 docs/modules/fts-rest-query/examples/api-query-index.json delete mode 100644 docs/modules/fts-rest-query/examples/api-query-index.sh delete mode 100644 docs/modules/fts-rest-stats/examples/g-api-nsstats-200.json delete mode 100644 docs/modules/fts-rest-stats/examples/g-api-nsstats-403.json delete mode 100644 docs/modules/fts-rest-stats/examples/g-api-nsstats-index-name.json diff --git a/docs/modules/fts-rest-advanced/examples/get-partition.json b/docs/modules/fts-rest-advanced/examples/get-partition.json deleted file mode 100644 index 0a8048ed..00000000 --- a/docs/modules/fts-rest-advanced/examples/get-partition.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "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-indexing/examples/d-api-index-name-200.json b/docs/modules/fts-rest-indexing/examples/d-api-index-name-200.json deleted file mode 100644 index a6baa02d..00000000 --- a/docs/modules/fts-rest-indexing/examples/d-api-index-name-200.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "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 deleted file mode 100644 index 9a10b7f9..00000000 --- a/docs/modules/fts-rest-indexing/examples/d-api-index-name-default.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "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 deleted file mode 100644 index 052dc44f..00000000 --- a/docs/modules/fts-rest-indexing/examples/d-api-scoped-index-name-200.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "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 deleted file mode 100644 index 9a10b7f9..00000000 --- a/docs/modules/fts-rest-indexing/examples/d-api-scoped-index-name-default.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "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 deleted file mode 100644 index c6960632..00000000 --- a/docs/modules/fts-rest-indexing/examples/fts-sample-index-def-response.json +++ /dev/null @@ -1,167 +0,0 @@ -{ - "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 deleted file mode 100644 index 5b6f2205..00000000 --- a/docs/modules/fts-rest-indexing/examples/fts-sample-success-response-vector-search.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "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 deleted file mode 100644 index 63d06acc..00000000 --- a/docs/modules/fts-rest-indexing/examples/fts-sample-success-response.json +++ /dev/null @@ -1,261 +0,0 @@ -{ - "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 deleted file mode 100644 index 566913b7..00000000 --- a/docs/modules/fts-rest-indexing/examples/g-api-index-name-count.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "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 deleted file mode 100644 index c6aa52c9..00000000 --- a/docs/modules/fts-rest-indexing/examples/g-api-index-name.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "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 deleted file mode 100644 index fc2cdcbd..00000000 --- a/docs/modules/fts-rest-indexing/examples/g-api-index.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "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 deleted file mode 100644 index 49cb6e53..00000000 --- a/docs/modules/fts-rest-indexing/examples/g-api-scoped-indexes.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "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 deleted file mode 100644 index a02fe919..00000000 --- a/docs/modules/fts-rest-indexing/examples/g-api-scoped-status.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "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 deleted file mode 100644 index 43b9686f..00000000 --- a/docs/modules/fts-rest-indexing/examples/g-api-stats-index-name-analyzeDoc-200.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "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 deleted file mode 100644 index af6fff72..00000000 --- a/docs/modules/fts-rest-indexing/examples/g-api-stats-index-name-analyzeDoc-body.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "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 deleted file mode 100644 index b8bb7efb..00000000 --- a/docs/modules/fts-rest-indexing/examples/g-api-stats-index-name.json +++ /dev/null @@ -1,159 +0,0 @@ -{ - "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 deleted file mode 100644 index 0fd37071..00000000 --- a/docs/modules/fts-rest-indexing/examples/g-api-stats.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "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 deleted file mode 100644 index 203dee2d..00000000 --- a/docs/modules/fts-rest-indexing/examples/p-api-index-name-200.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "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 deleted file mode 100644 index 3df88f58..00000000 --- a/docs/modules/fts-rest-indexing/examples/p-api-index-name-default.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "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 deleted file mode 100644 index 6a484c1b..00000000 --- a/docs/modules/fts-rest-indexing/examples/p-api-index-name-query-hybrid.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "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 deleted file mode 100644 index 6804db50..00000000 --- a/docs/modules/fts-rest-indexing/examples/p-api-index-name-query-options.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "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 deleted file mode 100644 index 63931d17..00000000 --- a/docs/modules/fts-rest-indexing/examples/p-api-index-name-query-regular.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "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 deleted file mode 100644 index 3a1acdf1..00000000 --- a/docs/modules/fts-rest-indexing/examples/p-api-pindex-lookup-200.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "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 deleted file mode 100644 index 35a07516..00000000 --- a/docs/modules/fts-rest-indexing/examples/p-api-pindex-lookup-body.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "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 deleted file mode 100644 index 9885ab48..00000000 --- a/docs/modules/fts-rest-indexing/examples/p-api-scoped-index-name-200.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "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 deleted file mode 100644 index 2ede4758..00000000 --- a/docs/modules/fts-rest-indexing/examples/p-api-scoped-index-name-default.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "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 deleted file mode 100644 index 98bd2539..00000000 --- a/docs/modules/fts-rest-indexing/examples/p-api-scoped-query-default.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "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 deleted file mode 100644 index b523aff9..00000000 --- a/docs/modules/fts-rest-indexing/examples/response-200.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "status": "ok" -} \ 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 deleted file mode 100644 index b523aff9..00000000 --- a/docs/modules/fts-rest-manage/examples/file-xfer-200.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "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 deleted file mode 100644 index 6b2eef44..00000000 --- a/docs/modules/fts-rest-manage/examples/file-xfer-405.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "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 deleted file mode 100644 index 634b8132..00000000 --- a/docs/modules/fts-rest-manage/examples/file-xfer-disable.sh +++ /dev/null @@ -1,4 +0,0 @@ -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 deleted file mode 100644 index 027d4064..00000000 --- a/docs/modules/fts-rest-manage/examples/file-xfer-enable.sh +++ /dev/null @@ -1,4 +0,0 @@ -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-nodes/examples/get-cluster-config.json b/docs/modules/fts-rest-nodes/examples/get-cluster-config.json deleted file mode 100644 index f9dc868a..00000000 --- a/docs/modules/fts-rest-nodes/examples/get-cluster-config.json +++ /dev/null @@ -1,93 +0,0 @@ -{ - "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 deleted file mode 100644 index 88a3c95b..00000000 --- a/docs/modules/fts-rest-nodes/examples/get-logs.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "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 deleted file mode 100644 index 0a33f3ee..00000000 --- a/docs/modules/fts-rest-nodes/examples/get-runtime-info.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "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-query/examples/api-query-all.json b/docs/modules/fts-rest-query/examples/api-query-all.json deleted file mode 100644 index 9fc70cce..00000000 --- a/docs/modules/fts-rest-query/examples/api-query-all.json +++ /dev/null @@ -1,61 +0,0 @@ -{ - "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 deleted file mode 100644 index b63ac1f0..00000000 --- a/docs/modules/fts-rest-query/examples/api-query-all.sh +++ /dev/null @@ -1,3 +0,0 @@ -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 deleted file mode 100644 index 2c8bc1af..00000000 --- a/docs/modules/fts-rest-query/examples/api-query-cancel.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "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 deleted file mode 100644 index d9e60060..00000000 --- a/docs/modules/fts-rest-query/examples/api-query-cancel.sh +++ /dev/null @@ -1,3 +0,0 @@ -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 deleted file mode 100644 index df72b7af..00000000 --- a/docs/modules/fts-rest-query/examples/api-query-filter.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "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 deleted file mode 100644 index 8f9ac8b6..00000000 --- a/docs/modules/fts-rest-query/examples/api-query-filter.sh +++ /dev/null @@ -1,3 +0,0 @@ -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 deleted file mode 100644 index 2b1e8abe..00000000 --- a/docs/modules/fts-rest-query/examples/api-query-index.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "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 deleted file mode 100644 index d02f65cb..00000000 --- a/docs/modules/fts-rest-query/examples/api-query-index.sh +++ /dev/null @@ -1,3 +0,0 @@ -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-stats/examples/g-api-nsstats-200.json b/docs/modules/fts-rest-stats/examples/g-api-nsstats-200.json deleted file mode 100644 index 34b2a157..00000000 --- a/docs/modules/fts-rest-stats/examples/g-api-nsstats-200.json +++ /dev/null @@ -1,164 +0,0 @@ -{ - "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 deleted file mode 100644 index 49bdc218..00000000 --- a/docs/modules/fts-rest-stats/examples/g-api-nsstats-403.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "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 deleted file mode 100644 index 76a81a84..00000000 --- a/docs/modules/fts-rest-stats/examples/g-api-nsstats-index-name.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "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 From 586221332fe29e02668a2ae5522bb49e17dc5791 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Fri, 30 Jan 2026 17:18:50 +0000 Subject: [PATCH 08/30] Build output documentation --- .../analytics-rest-admin/pages/index.adoc | 40 + .../analytics-rest-config/pages/index.adoc | 20 + .../analytics-rest-library/pages/index.adoc | 15 + .../analytics-rest-links/pages/index.adoc | 45 + .../analytics-rest-service/pages/index.adoc | 20 + .../analytics-rest-settings/pages/index.adoc | 10 + .../eventing-rest-api/pages/index.adoc | 150 ++ .../fts-rest-advanced/pages/index.adoc | 49 + .../fts-rest-indexing/pages/index.adoc | 1246 +++++++++++++++++ docs/modules/fts-rest-manage/pages/index.adoc | 49 + docs/modules/fts-rest-nodes/pages/index.adoc | 193 +++ docs/modules/fts-rest-query/pages/index.adoc | 219 +++ docs/modules/fts-rest-stats/pages/index.adoc | 253 ++++ .../modules/index-rest-stats/pages/index.adoc | 15 + docs/modules/n1ql-rest-admin/pages/index.adoc | 158 +++ .../n1ql-rest-functions/pages/index.adoc | 69 + docs/modules/n1ql-rest-query/pages/index.adoc | 238 +++- .../n1ql-rest-settings/pages/index.adoc | 112 ++ 18 files changed, 2900 insertions(+), 1 deletion(-) diff --git a/docs/modules/analytics-rest-admin/pages/index.adoc b/docs/modules/analytics-rest-admin/pages/index.adoc index 8c0557c6..65c3a898 100644 --- a/docs/modules/analytics-rest-admin/pages/index.adoc +++ b/docs/modules/analytics-rest-admin/pages/index.adoc @@ -296,8 +296,13 @@ include::{specDir}paths/cancel_request/operation-security-end.adoc[opts=optional include::{specDir}paths/cancel_request/operation-security-after.adoc[opts=optional] + + include::{snippetDir}cancel_request/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}cancel_request/http-response.adoc[opts=optional] include::{specDir}paths/cancel_request/operation-end.adoc[opts=optional] @@ -432,8 +437,13 @@ include::{specDir}paths/cluster_status/operation-security-end.adoc[opts=optional include::{specDir}paths/cluster_status/operation-security-after.adoc[opts=optional] + + include::{snippetDir}cluster_status/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}cluster_status/http-response.adoc[opts=optional] include::{specDir}paths/cluster_status/operation-end.adoc[opts=optional] @@ -568,8 +578,13 @@ include::{specDir}paths/completed_requests/operation-security-end.adoc[opts=opti include::{specDir}paths/completed_requests/operation-security-after.adoc[opts=optional] + + include::{snippetDir}completed_requests/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}completed_requests/http-response.adoc[opts=optional] include::{specDir}paths/completed_requests/operation-end.adoc[opts=optional] @@ -704,8 +719,13 @@ include::{specDir}paths/ingestion_status/operation-security-end.adoc[opts=option include::{specDir}paths/ingestion_status/operation-security-after.adoc[opts=optional] + + include::{snippetDir}ingestion_status/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}ingestion_status/http-response.adoc[opts=optional] include::{specDir}paths/ingestion_status/operation-end.adoc[opts=optional] @@ -845,8 +865,13 @@ include::{specDir}paths/monitor_node/operation-security-end.adoc[opts=optional] include::{specDir}paths/monitor_node/operation-security-after.adoc[opts=optional] + + include::{snippetDir}monitor_node/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}monitor_node/http-response.adoc[opts=optional] include::{specDir}paths/monitor_node/operation-end.adoc[opts=optional] @@ -980,8 +1005,13 @@ include::{specDir}paths/restart_cluster/operation-security-end.adoc[opts=optiona include::{specDir}paths/restart_cluster/operation-security-after.adoc[opts=optional] + + include::{snippetDir}restart_cluster/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}restart_cluster/http-response.adoc[opts=optional] include::{specDir}paths/restart_cluster/operation-end.adoc[opts=optional] @@ -1115,8 +1145,13 @@ include::{specDir}paths/restart_node/operation-security-end.adoc[opts=optional] include::{specDir}paths/restart_node/operation-security-after.adoc[opts=optional] + + include::{snippetDir}restart_node/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}restart_node/http-response.adoc[opts=optional] include::{specDir}paths/restart_node/operation-end.adoc[opts=optional] @@ -1251,8 +1286,13 @@ include::{specDir}paths/return_active_requests/operation-security-end.adoc[opts= include::{specDir}paths/return_active_requests/operation-security-after.adoc[opts=optional] + + include::{snippetDir}return_active_requests/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}return_active_requests/http-response.adoc[opts=optional] include::{specDir}paths/return_active_requests/operation-end.adoc[opts=optional] diff --git a/docs/modules/analytics-rest-config/pages/index.adoc b/docs/modules/analytics-rest-config/pages/index.adoc index 407cb46e..bfc4cedd 100644 --- a/docs/modules/analytics-rest-config/pages/index.adoc +++ b/docs/modules/analytics-rest-config/pages/index.adoc @@ -243,8 +243,13 @@ include::{specDir}paths/get_node/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_node/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_node/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_node/http-response.adoc[opts=optional] include::{specDir}paths/get_node/operation-end.adoc[opts=optional] @@ -372,8 +377,13 @@ include::{specDir}paths/get_service/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_service/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_service/http-response.adoc[opts=optional] include::{specDir}paths/get_service/operation-end.adoc[opts=optional] @@ -553,8 +563,13 @@ include::{specDir}paths/put_node/operation-security-end.adoc[opts=optional] include::{specDir}paths/put_node/operation-security-after.adoc[opts=optional] + + include::{snippetDir}put_node/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}put_node/http-response.adoc[opts=optional] include::{specDir}paths/put_node/operation-end.adoc[opts=optional] @@ -732,8 +747,13 @@ include::{specDir}paths/put_service/operation-security-end.adoc[opts=optional] include::{specDir}paths/put_service/operation-security-after.adoc[opts=optional] + + include::{snippetDir}put_service/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}put_service/http-response.adoc[opts=optional] include::{specDir}paths/put_service/operation-end.adoc[opts=optional] diff --git a/docs/modules/analytics-rest-library/pages/index.adoc b/docs/modules/analytics-rest-library/pages/index.adoc index 6cca2c3c..7fc31824 100644 --- a/docs/modules/analytics-rest-library/pages/index.adoc +++ b/docs/modules/analytics-rest-library/pages/index.adoc @@ -296,8 +296,13 @@ include::{specDir}paths/delete_library/operation-security-end.adoc[opts=optional include::{specDir}paths/delete_library/operation-security-after.adoc[opts=optional] + + include::{snippetDir}delete_library/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}delete_library/http-response.adoc[opts=optional] include::{specDir}paths/delete_library/operation-end.adoc[opts=optional] @@ -433,8 +438,13 @@ include::{specDir}paths/get_collection/operation-security-end.adoc[opts=optional include::{specDir}paths/get_collection/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_collection/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_collection/http-response.adoc[opts=optional] include::{specDir}paths/get_collection/operation-end.adoc[opts=optional] @@ -654,8 +664,13 @@ include::{specDir}paths/post_library/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_library/operation-security-after.adoc[opts=optional] + + include::{snippetDir}post_library/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}post_library/http-response.adoc[opts=optional] include::{specDir}paths/post_library/operation-end.adoc[opts=optional] diff --git a/docs/modules/analytics-rest-links/pages/index.adoc b/docs/modules/analytics-rest-links/pages/index.adoc index e0691959..ea061ea0 100644 --- a/docs/modules/analytics-rest-links/pages/index.adoc +++ b/docs/modules/analytics-rest-links/pages/index.adoc @@ -301,8 +301,13 @@ include::{specDir}paths/delete_alt/operation-security-end.adoc[opts=optional] include::{specDir}paths/delete_alt/operation-security-after.adoc[opts=optional] + + include::{snippetDir}delete_alt/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}delete_alt/http-response.adoc[opts=optional] include::{specDir}paths/delete_alt/operation-end.adoc[opts=optional] @@ -755,8 +760,13 @@ include::{specDir}paths/post_alt/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_alt/operation-security-after.adoc[opts=optional] + + include::{snippetDir}post_alt/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}post_alt/http-response.adoc[opts=optional] include::{specDir}paths/post_alt/operation-end.adoc[opts=optional] @@ -1210,8 +1220,13 @@ include::{specDir}paths/put_alt/operation-security-end.adoc[opts=optional] include::{specDir}paths/put_alt/operation-security-after.adoc[opts=optional] + + include::{snippetDir}put_alt/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}put_alt/http-response.adoc[opts=optional] include::{specDir}paths/put_alt/operation-end.adoc[opts=optional] @@ -1434,8 +1449,13 @@ include::{specDir}paths/get_all/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_all/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_all/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_all/http-response.adoc[opts=optional] include::{specDir}paths/get_all/operation-end.adoc[opts=optional] @@ -1631,8 +1651,13 @@ include::{specDir}paths/get_scope/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_scope/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_scope/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_scope/http-response.adoc[opts=optional] include::{specDir}paths/get_scope/operation-end.adoc[opts=optional] @@ -1839,8 +1864,13 @@ include::{specDir}paths/delete_link/operation-security-end.adoc[opts=optional] include::{specDir}paths/delete_link/operation-security-after.adoc[opts=optional] + + include::{snippetDir}delete_link/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}delete_link/http-response.adoc[opts=optional] include::{specDir}paths/delete_link/operation-end.adoc[opts=optional] @@ -2047,8 +2077,13 @@ include::{specDir}paths/get_link/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_link/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_link/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_link/http-response.adoc[opts=optional] include::{specDir}paths/get_link/operation-end.adoc[opts=optional] @@ -2512,8 +2547,13 @@ include::{specDir}paths/post_link/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_link/operation-security-after.adoc[opts=optional] + + include::{snippetDir}post_link/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}post_link/http-response.adoc[opts=optional] include::{specDir}paths/post_link/operation-end.adoc[opts=optional] @@ -2978,8 +3018,13 @@ include::{specDir}paths/put_link/operation-security-end.adoc[opts=optional] include::{specDir}paths/put_link/operation-security-after.adoc[opts=optional] + + include::{snippetDir}put_link/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}put_link/http-response.adoc[opts=optional] include::{specDir}paths/put_link/operation-end.adoc[opts=optional] diff --git a/docs/modules/analytics-rest-service/pages/index.adoc b/docs/modules/analytics-rest-service/pages/index.adoc index 50ee357d..3a884e9a 100644 --- a/docs/modules/analytics-rest-service/pages/index.adoc +++ b/docs/modules/analytics-rest-service/pages/index.adoc @@ -286,8 +286,13 @@ include::{specDir}paths/get_query/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_query/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_query/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_query/http-response.adoc[opts=optional] include::{specDir}paths/get_query/operation-end.adoc[opts=optional] @@ -461,8 +466,13 @@ include::{specDir}paths/get_service/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_service/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_service/http-response.adoc[opts=optional] include::{specDir}paths/get_service/operation-end.adoc[opts=optional] @@ -619,8 +629,13 @@ include::{specDir}paths/post_query/operation-security-before.adoc[opts=optional] include::{specDir}paths/post_query/operation-security-after.adoc[opts=optional] + + include::{snippetDir}post_query/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}post_query/http-response.adoc[opts=optional] include::{specDir}paths/post_query/operation-end.adoc[opts=optional] @@ -796,8 +811,13 @@ include::{specDir}paths/post_service/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_service/operation-security-after.adoc[opts=optional] + + include::{snippetDir}post_service/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}post_service/http-response.adoc[opts=optional] include::{specDir}paths/post_service/operation-end.adoc[opts=optional] diff --git a/docs/modules/analytics-rest-settings/pages/index.adoc b/docs/modules/analytics-rest-settings/pages/index.adoc index fdaec42a..11e10611 100644 --- a/docs/modules/analytics-rest-settings/pages/index.adoc +++ b/docs/modules/analytics-rest-settings/pages/index.adoc @@ -242,8 +242,13 @@ include::{specDir}paths/get_settings/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_settings/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_settings/http-response.adoc[opts=optional] include::{specDir}paths/get_settings/operation-end.adoc[opts=optional] @@ -418,8 +423,13 @@ include::{specDir}paths/post_settings/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optional] + + include::{snippetDir}post_settings/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}post_settings/http-response.adoc[opts=optional] include::{specDir}paths/post_settings/operation-end.adoc[opts=optional] diff --git a/docs/modules/eventing-rest-api/pages/index.adoc b/docs/modules/eventing-rest-api/pages/index.adoc index ccbdd826..3bed83bc 100644 --- a/docs/modules/eventing-rest-api/pages/index.adoc +++ b/docs/modules/eventing-rest-api/pages/index.adoc @@ -309,8 +309,13 @@ include::{specDir}paths/basic_deploy/operation-security-end.adoc[opts=optional] include::{specDir}paths/basic_deploy/operation-security-after.adoc[opts=optional] + + include::{snippetDir}basic_deploy/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}basic_deploy/http-response.adoc[opts=optional] include::{specDir}paths/basic_deploy/operation-end.adoc[opts=optional] @@ -500,8 +505,13 @@ include::{specDir}paths/basic_pause/operation-security-end.adoc[opts=optional] include::{specDir}paths/basic_pause/operation-security-after.adoc[opts=optional] + + include::{snippetDir}basic_pause/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}basic_pause/http-response.adoc[opts=optional] include::{specDir}paths/basic_pause/operation-end.adoc[opts=optional] @@ -698,8 +708,13 @@ include::{specDir}paths/basic_resume/operation-security-end.adoc[opts=optional] include::{specDir}paths/basic_resume/operation-security-after.adoc[opts=optional] + + include::{snippetDir}basic_resume/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}basic_resume/http-response.adoc[opts=optional] include::{specDir}paths/basic_resume/operation-end.adoc[opts=optional] @@ -889,8 +904,13 @@ include::{specDir}paths/basic_undeploy/operation-security-end.adoc[opts=optional include::{specDir}paths/basic_undeploy/operation-security-after.adoc[opts=optional] + + include::{snippetDir}basic_undeploy/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}basic_undeploy/http-response.adoc[opts=optional] include::{specDir}paths/basic_undeploy/operation-end.adoc[opts=optional] @@ -1144,8 +1164,13 @@ include::{specDir}paths/adv_function_import/operation-security-end.adoc[opts=opt include::{specDir}paths/adv_function_import/operation-security-after.adoc[opts=optional] + + include::{snippetDir}adv_function_import/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}adv_function_import/http-response.adoc[opts=optional] include::{specDir}paths/adv_function_import/operation-end.adoc[opts=optional] @@ -1308,8 +1333,13 @@ include::{specDir}paths/adv_function_import_all/operation-security-end.adoc[opts include::{specDir}paths/adv_function_import_all/operation-security-after.adoc[opts=optional] + + include::{snippetDir}adv_function_import_all/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}adv_function_import_all/http-response.adoc[opts=optional] include::{specDir}paths/adv_function_import_all/operation-end.adoc[opts=optional] @@ -1512,8 +1542,13 @@ include::{specDir}paths/adv_function_view/operation-security-end.adoc[opts=optio include::{specDir}paths/adv_function_view/operation-security-after.adoc[opts=optional] + + include::{snippetDir}adv_function_view/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}adv_function_view/http-response.adoc[opts=optional] include::{specDir}paths/adv_function_view/operation-end.adoc[opts=optional] @@ -1646,8 +1681,13 @@ include::{specDir}paths/adv_function_view_all/operation-security-end.adoc[opts=o include::{specDir}paths/adv_function_view_all/operation-security-after.adoc[opts=optional] + + include::{snippetDir}adv_function_view_all/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}adv_function_view_all/http-response.adoc[opts=optional] include::{specDir}paths/adv_function_view_all/operation-end.adoc[opts=optional] @@ -1845,8 +1885,13 @@ include::{specDir}paths/adv_function_zap/operation-security-end.adoc[opts=option include::{specDir}paths/adv_function_zap/operation-security-after.adoc[opts=optional] + + include::{snippetDir}adv_function_zap/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}adv_function_zap/http-response.adoc[opts=optional] include::{specDir}paths/adv_function_zap/operation-end.adoc[opts=optional] @@ -1973,8 +2018,13 @@ include::{specDir}paths/adv_function_zap_all/operation-security-end.adoc[opts=op include::{specDir}paths/adv_function_zap_all/operation-security-after.adoc[opts=optional] + + include::{snippetDir}adv_function_zap_all/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}adv_function_zap_all/http-response.adoc[opts=optional] include::{specDir}paths/adv_function_zap_all/operation-end.adoc[opts=optional] @@ -2107,8 +2157,13 @@ include::{specDir}paths/adv_multiple_export/operation-security-end.adoc[opts=opt include::{specDir}paths/adv_multiple_export/operation-security-after.adoc[opts=optional] + + include::{snippetDir}adv_multiple_export/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}adv_multiple_export/http-response.adoc[opts=optional] include::{specDir}paths/adv_multiple_export/operation-end.adoc[opts=optional] @@ -2271,8 +2326,13 @@ include::{specDir}paths/adv_multiple_import/operation-security-end.adoc[opts=opt include::{specDir}paths/adv_multiple_import/operation-security-after.adoc[opts=optional] + + include::{snippetDir}adv_multiple_import/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}adv_multiple_import/http-response.adoc[opts=optional] include::{specDir}paths/adv_multiple_import/operation-end.adoc[opts=optional] @@ -2474,8 +2534,13 @@ include::{specDir}paths/adv_settings_get/operation-security-end.adoc[opts=option include::{specDir}paths/adv_settings_get/operation-security-after.adoc[opts=optional] + + include::{snippetDir}adv_settings_get/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}adv_settings_get/http-response.adoc[opts=optional] include::{specDir}paths/adv_settings_get/operation-end.adoc[opts=optional] @@ -2704,8 +2769,13 @@ include::{specDir}paths/adv_settings_update/operation-security-end.adoc[opts=opt include::{specDir}paths/adv_settings_update/operation-security-after.adoc[opts=optional] + + include::{snippetDir}adv_settings_update/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}adv_settings_update/http-response.adoc[opts=optional] include::{specDir}paths/adv_settings_update/operation-end.adoc[opts=optional] @@ -2907,8 +2977,13 @@ include::{specDir}paths/adv_structure_get/operation-security-end.adoc[opts=optio include::{specDir}paths/adv_structure_get/operation-security-after.adoc[opts=optional] + + include::{snippetDir}adv_structure_get/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}adv_structure_get/http-response.adoc[opts=optional] include::{specDir}paths/adv_structure_get/operation-end.adoc[opts=optional] @@ -3130,8 +3205,13 @@ include::{specDir}paths/adv_structure_update/operation-security-end.adoc[opts=op include::{specDir}paths/adv_structure_update/operation-security-after.adoc[opts=optional] + + include::{snippetDir}adv_structure_update/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}adv_structure_update/http-response.adoc[opts=optional] include::{specDir}paths/adv_structure_update/operation-end.adoc[opts=optional] @@ -3333,8 +3413,13 @@ include::{specDir}paths/adv_text_get/operation-security-end.adoc[opts=optional] include::{specDir}paths/adv_text_get/operation-security-after.adoc[opts=optional] + + include::{snippetDir}adv_text_get/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}adv_text_get/http-response.adoc[opts=optional] include::{specDir}paths/adv_text_get/operation-end.adoc[opts=optional] @@ -3556,8 +3641,13 @@ include::{specDir}paths/adv_text_update/operation-security-end.adoc[opts=optiona include::{specDir}paths/adv_text_update/operation-security-after.adoc[opts=optional] + + include::{snippetDir}adv_text_update/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}adv_text_update/http-response.adoc[opts=optional] include::{specDir}paths/adv_text_update/operation-end.adoc[opts=optional] @@ -3707,8 +3797,13 @@ include::{specDir}paths/config_get/operation-security-end.adoc[opts=optional] include::{specDir}paths/config_get/operation-security-after.adoc[opts=optional] + + include::{snippetDir}config_get/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}config_get/http-response.adoc[opts=optional] include::{specDir}paths/config_get/operation-end.adoc[opts=optional] @@ -3872,8 +3967,13 @@ include::{specDir}paths/config_update/operation-security-end.adoc[opts=optional] include::{specDir}paths/config_update/operation-security-after.adoc[opts=optional] + + include::{snippetDir}config_update/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}config_update/http-response.adoc[opts=optional] include::{specDir}paths/config_update/operation-end.adoc[opts=optional] @@ -4021,8 +4121,13 @@ include::{specDir}paths/list_all/operation-security-end.adoc[opts=optional] include::{specDir}paths/list_all/operation-security-after.adoc[opts=optional] + + include::{snippetDir}list_all/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}list_all/http-response.adoc[opts=optional] include::{specDir}paths/list_all/operation-end.adoc[opts=optional] @@ -4214,8 +4319,13 @@ include::{specDir}paths/list_query/operation-security-end.adoc[opts=optional] include::{specDir}paths/list_query/operation-security-after.adoc[opts=optional] + + include::{snippetDir}list_query/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}list_query/http-response.adoc[opts=optional] include::{specDir}paths/list_query/operation-end.adoc[opts=optional] @@ -4447,8 +4557,13 @@ include::{specDir}paths/log_view/operation-security-end.adoc[opts=optional] include::{specDir}paths/log_view/operation-security-after.adoc[opts=optional] + + include::{snippetDir}log_view/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}log_view/http-response.adoc[opts=optional] include::{specDir}paths/log_view/operation-end.adoc[opts=optional] @@ -4635,8 +4750,13 @@ include::{specDir}paths/stats_all/operation-security-end.adoc[opts=optional] include::{specDir}paths/stats_all/operation-security-after.adoc[opts=optional] + + include::{snippetDir}stats_all/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}stats_all/http-response.adoc[opts=optional] include::{specDir}paths/stats_all/operation-end.adoc[opts=optional] @@ -4823,8 +4943,13 @@ include::{specDir}paths/stats_execution/operation-security-end.adoc[opts=optiona include::{specDir}paths/stats_execution/operation-security-after.adoc[opts=optional] + + include::{snippetDir}stats_execution/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}stats_execution/http-response.adoc[opts=optional] include::{specDir}paths/stats_execution/operation-end.adoc[opts=optional] @@ -5011,8 +5136,13 @@ include::{specDir}paths/stats_failure/operation-security-end.adoc[opts=optional] include::{specDir}paths/stats_failure/operation-security-after.adoc[opts=optional] + + include::{snippetDir}stats_failure/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}stats_failure/http-response.adoc[opts=optional] include::{specDir}paths/stats_failure/operation-end.adoc[opts=optional] @@ -5199,8 +5329,13 @@ include::{specDir}paths/stats_latency/operation-security-end.adoc[opts=optional] include::{specDir}paths/stats_latency/operation-security-after.adoc[opts=optional] + + include::{snippetDir}stats_latency/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}stats_latency/http-response.adoc[opts=optional] include::{specDir}paths/stats_latency/operation-end.adoc[opts=optional] @@ -5386,8 +5521,13 @@ include::{specDir}paths/stats_reset/operation-security-end.adoc[opts=optional] include::{specDir}paths/stats_reset/operation-security-after.adoc[opts=optional] + + include::{snippetDir}stats_reset/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}stats_reset/http-response.adoc[opts=optional] include::{specDir}paths/stats_reset/operation-end.adoc[opts=optional] @@ -5536,8 +5676,13 @@ include::{specDir}paths/status_all/operation-security-end.adoc[opts=optional] include::{specDir}paths/status_all/operation-security-after.adoc[opts=optional] + + include::{snippetDir}status_all/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}status_all/http-response.adoc[opts=optional] include::{specDir}paths/status_all/operation-end.adoc[opts=optional] @@ -5735,8 +5880,13 @@ include::{specDir}paths/status_function/operation-security-end.adoc[opts=optiona include::{specDir}paths/status_function/operation-security-after.adoc[opts=optional] + + include::{snippetDir}status_function/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}status_function/http-response.adoc[opts=optional] include::{specDir}paths/status_function/operation-end.adoc[opts=optional] diff --git a/docs/modules/fts-rest-advanced/pages/index.adoc b/docs/modules/fts-rest-advanced/pages/index.adoc index b2910569..c1b62838 100644 --- a/docs/modules/fts-rest-advanced/pages/index.adoc +++ b/docs/modules/fts-rest-advanced/pages/index.adoc @@ -235,8 +235,37 @@ include::{specDir}paths/getPartition/operation-security-end.adoc[opts=optional] include::{specDir}paths/getPartition/operation-security-after.adoc[opts=optional] + + include::{snippetDir}getPartition/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "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" +} +---- +==== + + include::{snippetDir}getPartition/http-response.adoc[opts=optional] include::{specDir}paths/getPartition/operation-end.adoc[opts=optional] @@ -386,8 +415,13 @@ include::{specDir}paths/getPartitionName/operation-security-end.adoc[opts=option include::{specDir}paths/getPartitionName/operation-security-after.adoc[opts=optional] + + include::{snippetDir}getPartitionName/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}getPartitionName/http-response.adoc[opts=optional] include::{specDir}paths/getPartitionName/operation-end.adoc[opts=optional] @@ -562,8 +596,13 @@ include::{specDir}paths/getPartitionCount/operation-security-end.adoc[opts=optio include::{specDir}paths/getPartitionCount/operation-security-after.adoc[opts=optional] + + include::{snippetDir}getPartitionCount/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}getPartitionCount/http-response.adoc[opts=optional] include::{specDir}paths/getPartitionCount/operation-end.adoc[opts=optional] @@ -742,8 +781,13 @@ include::{specDir}paths/queryPartition/operation-security-end.adoc[opts=optional include::{specDir}paths/queryPartition/operation-security-after.adoc[opts=optional] + + include::{snippetDir}queryPartition/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}queryPartition/http-response.adoc[opts=optional] include::{specDir}paths/queryPartition/operation-end.adoc[opts=optional] @@ -917,8 +961,13 @@ include::{specDir}paths/setFtsMemoryQuota/operation-security-end.adoc[opts=optio include::{specDir}paths/setFtsMemoryQuota/operation-security-after.adoc[opts=optional] + + include::{snippetDir}setFtsMemoryQuota/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}setFtsMemoryQuota/http-response.adoc[opts=optional] include::{specDir}paths/setFtsMemoryQuota/operation-end.adoc[opts=optional] diff --git a/docs/modules/fts-rest-indexing/pages/index.adoc b/docs/modules/fts-rest-indexing/pages/index.adoc index 541c3ecc..88c0907a 100644 --- a/docs/modules/fts-rest-indexing/pages/index.adoc +++ b/docs/modules/fts-rest-indexing/pages/index.adoc @@ -288,8 +288,34 @@ include::{specDir}paths/d-api-index-name/operation-security-end.adoc[opts=option include::{specDir}paths/d-api-index-name/operation-security-after.adoc[opts=optional] + + include::{snippetDir}d-api-index-name/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "status" : "ok", + "uuid" : "123294e5a4efbe39" +} +---- +==== +.Response 0 +==== +[source,json] +---- +{ + "error" : "rest_auth: preparePerms, err: index not found", + "request" : "", + "status" : "fail" +} +---- +==== + + include::{snippetDir}d-api-index-name/http-response.adoc[opts=optional] include::{specDir}paths/d-api-index-name/operation-end.adoc[opts=optional] @@ -474,8 +500,34 @@ include::{specDir}paths/d-api-scoped-index-name/operation-security-end.adoc[opts include::{specDir}paths/d-api-scoped-index-name/operation-security-after.adoc[opts=optional] + + include::{snippetDir}d-api-scoped-index-name/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "status" : "ok", + "uuid" : "687be6a2ad647c34" +} +---- +==== +.Response 0 +==== +[source,json] +---- +{ + "error" : "rest_auth: preparePerms, err: index not found", + "request" : "", + "status" : "fail" +} +---- +==== + + include::{snippetDir}d-api-scoped-index-name/http-response.adoc[opts=optional] include::{specDir}paths/d-api-scoped-index-name/operation-end.adoc[opts=optional] @@ -596,8 +648,45 @@ include::{specDir}paths/g-api-index/operation-security-end.adoc[opts=optional] include::{specDir}paths/g-api-index/operation-security-after.adoc[opts=optional] + + include::{snippetDir}g-api-index/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "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" +} +---- +==== + + include::{snippetDir}g-api-index/http-response.adoc[opts=optional] include::{specDir}paths/g-api-index/operation-end.adoc[opts=optional] @@ -757,8 +846,60 @@ include::{specDir}paths/g-api-index-name/operation-security-end.adoc[opts=option include::{specDir}paths/g-api-index-name/operation-security-after.adoc[opts=optional] + + include::{snippetDir}g-api-index-name/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "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" : [ ] +} +---- +==== + + include::{snippetDir}g-api-index-name/http-response.adoc[opts=optional] include::{specDir}paths/g-api-index-name/operation-end.adoc[opts=optional] @@ -923,8 +1064,135 @@ include::{specDir}paths/g-api-scoped-index/operation-security-end.adoc[opts=opti include::{specDir}paths/g-api-scoped-index/operation-security-after.adoc[opts=optional] + + include::{snippetDir}g-api-scoped-index/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "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" + } +} +---- +==== + + include::{snippetDir}g-api-scoped-index/http-response.adoc[opts=optional] include::{specDir}paths/g-api-scoped-index/operation-end.adoc[opts=optional] @@ -1102,8 +1370,176 @@ include::{specDir}paths/g-api-scoped-index-name/operation-security-end.adoc[opts include::{specDir}paths/g-api-scoped-index-name/operation-security-after.adoc[opts=optional] + + include::{snippetDir}g-api-scoped-index-name/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "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" : [ ] +} +---- +==== + + include::{snippetDir}g-api-scoped-index-name/http-response.adoc[opts=optional] include::{specDir}paths/g-api-scoped-index-name/operation-end.adoc[opts=optional] @@ -1296,8 +1732,35 @@ include::{specDir}paths/p-api-index-name/operation-security-end.adoc[opts=option include::{specDir}paths/p-api-index-name/operation-security-after.adoc[opts=optional] + + include::{snippetDir}p-api-index-name/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "status" : "ok", + "name" : "travel-test", + "uuid" : "565ca041af3baf9d" +} +---- +==== +.Response 0 +==== +[source,json] +---- +{ + "error" : "rest_create_index: index type is required, indexName: travel-test", + "request" : "", + "status" : "fail" +} +---- +==== + + include::{snippetDir}p-api-index-name/http-response.adoc[opts=optional] include::{specDir}paths/p-api-index-name/operation-end.adoc[opts=optional] @@ -1508,8 +1971,35 @@ include::{specDir}paths/p-api-scoped-index-name/operation-security-end.adoc[opts include::{specDir}paths/p-api-scoped-index-name/operation-security-after.adoc[opts=optional] + + include::{snippetDir}p-api-scoped-index-name/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "status" : "ok", + "name" : "travel-sample.inventory.travel-test", + "uuid" : "654cb62baebf2d26" +} +---- +==== +.Response 0 +==== +[source,json] +---- +{ + "error" : "rest_create_index: index type is required, indexName: travel-test", + "request" : { }, + "status" : "fail" +} +---- +==== + + include::{snippetDir}p-api-scoped-index-name/http-response.adoc[opts=optional] include::{specDir}paths/p-api-scoped-index-name/operation-end.adoc[opts=optional] @@ -1708,8 +2198,22 @@ include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-end.adoc include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-after.adoc[opts=optional] + + include::{snippetDir}p-api-idx-name-ingestcontrol/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "status" : "ok" +} +---- +==== + + include::{snippetDir}p-api-idx-name-ingestcontrol/http-response.adoc[opts=optional] include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-end.adoc[opts=optional] @@ -1883,8 +2387,22 @@ include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-end. include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-after.adoc[opts=optional] + + include::{snippetDir}p-api-idx-name-planfreezecontrol/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "status" : "ok" +} +---- +==== + + include::{snippetDir}p-api-idx-name-planfreezecontrol/http-response.adoc[opts=optional] include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-end.adoc[opts=optional] @@ -2058,8 +2576,22 @@ include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-end.adoc[ include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-after.adoc[opts=optional] + + include::{snippetDir}p-api-idx-name-querycontrol/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "status" : "ok" +} +---- +==== + + include::{snippetDir}p-api-idx-name-querycontrol/http-response.adoc[opts=optional] include::{specDir}paths/p-api-idx-name-querycontrol/operation-end.adoc[opts=optional] @@ -2251,8 +2783,22 @@ include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-end.adoc[o include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-after.adoc[opts=optional] + + include::{snippetDir}p-api-scoped-ingestcontrol/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "status" : "ok" +} +---- +==== + + include::{snippetDir}p-api-scoped-ingestcontrol/http-response.adoc[opts=optional] include::{specDir}paths/p-api-scoped-ingestcontrol/operation-end.adoc[opts=optional] @@ -2444,8 +2990,22 @@ include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-end.ad include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-after.adoc[opts=optional] + + include::{snippetDir}p-api-scoped-planfreezecontrol/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "status" : "ok" +} +---- +==== + + include::{snippetDir}p-api-scoped-planfreezecontrol/http-response.adoc[opts=optional] include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-end.adoc[opts=optional] @@ -2637,8 +3197,22 @@ include::{specDir}paths/p-api-scoped-querycontrol/operation-security-end.adoc[op include::{specDir}paths/p-api-scoped-querycontrol/operation-security-after.adoc[opts=optional] + + include::{snippetDir}p-api-scoped-querycontrol/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "status" : "ok" +} +---- +==== + + include::{snippetDir}p-api-scoped-querycontrol/http-response.adoc[opts=optional] include::{specDir}paths/p-api-scoped-querycontrol/operation-end.adoc[opts=optional] @@ -2839,8 +3413,23 @@ include::{specDir}paths/g-api-scoped-status/operation-security-end.adoc[opts=opt include::{specDir}paths/g-api-scoped-status/operation-security-after.adoc[opts=optional] + + include::{snippetDir}g-api-scoped-status/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "status" : "ok", + "indexStatus" : "Ready" +} +---- +==== + + include::{snippetDir}g-api-scoped-status/http-response.adoc[opts=optional] include::{specDir}paths/g-api-scoped-status/operation-end.adoc[opts=optional] @@ -2964,8 +3553,60 @@ include::{specDir}paths/g-api-stats/operation-security-end.adoc[opts=optional] include::{specDir}paths/g-api-stats/operation-security-after.adoc[opts=optional] + + include::{snippetDir}g-api-stats/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "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 + } +} +---- +==== + + include::{snippetDir}g-api-stats/http-response.adoc[opts=optional] include::{specDir}paths/g-api-stats/operation-end.adoc[opts=optional] @@ -3128,8 +3769,178 @@ include::{specDir}paths/g-api-stats-index-name/operation-security-end.adoc[opts= include::{specDir}paths/g-api-stats-index-name/operation-security-after.adoc[opts=optional] + + include::{snippetDir}g-api-stats-index-name/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "feeds" : { }, + "pindexes" : { + "travel-sample.inventory.travel-test_3858c70e4d4d8df9_4c1c5584" : { + "pindexStoreStats" : { + "TimerBatchStore" : { + "count" : 0, + "min" : 0, + "max" : 0, + "mean" : 0, + "stddev" : 0, + "percentiles" : { + "99%" : 0, + "99.9%" : 0, + "median" : 0, + "75%" : 0, + "95%" : 0 + }, + "rates" : { + "mean" : 0, + "1-min" : 0, + "5-min" : 0, + "15-min" : 0 + } + }, + "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 + } + } + } +} +---- +==== + + include::{snippetDir}g-api-stats-index-name/http-response.adoc[opts=optional] include::{specDir}paths/g-api-stats-index-name/operation-end.adoc[opts=optional] @@ -3315,8 +4126,115 @@ include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-end 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] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "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 ] +} +---- +==== + + include::{snippetDir}g-api-stats-index-name-analyzeDoc/http-response.adoc[opts=optional] include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-end.adoc[opts=optional] @@ -3500,8 +4418,23 @@ include::{specDir}paths/g-api-index-name-count/operation-security-end.adoc[opts= include::{specDir}paths/g-api-index-name-count/operation-security-after.adoc[opts=optional] + + include::{snippetDir}g-api-index-name-count/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "status" : "ok", + "count" : 285 +} +---- +==== + + include::{snippetDir}g-api-index-name-count/http-response.adoc[opts=optional] include::{specDir}paths/g-api-index-name-count/operation-end.adoc[opts=optional] @@ -3688,8 +4621,13 @@ include::{specDir}paths/p-api-index-name-query/operation-security-end.adoc[opts= 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] +// FIXME: Response examples + + include::{snippetDir}p-api-index-name-query/http-response.adoc[opts=optional] include::{specDir}paths/p-api-index-name-query/operation-end.adoc[opts=optional] @@ -3893,8 +4831,27 @@ include::{specDir}paths/p-api-pindex-lookup/operation-security-end.adoc[opts=opt include::{specDir}paths/p-api-pindex-lookup/operation-security-after.adoc[opts=optional] + + include::{snippetDir}p-api-pindex-lookup/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "status" : "ok", + "pindexes" : { + "travel-sample.inventory.travel-test" : { + "id" : "travel-sample.inventory.travel-test_123294e5a4efbe39_4c1c5584" + } + } +} +---- +==== + + include::{snippetDir}p-api-pindex-lookup/http-response.adoc[opts=optional] include::{specDir}paths/p-api-pindex-lookup/operation-end.adoc[opts=optional] @@ -4106,8 +5063,297 @@ include::{specDir}paths/p-api-scoped-query/operation-security-end.adoc[opts=opti include::{specDir}paths/p-api-scoped-query/operation-security-after.adoc[opts=optional] + + include::{snippetDir}p-api-scoped-query/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +.Success Response for a Regular Query +[source,json] +---- +{ + "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'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. nice view of the city o…" ] + }, + "sort" : [ "􏿿􏿿􏿿", "􏿿􏿿􏿿", "_score", "hotel_7388" ] + }, "..." ], + "total_hits" : 27, + "cost" : 108906, + "max_score" : 0, + "took" : 14964461, + "facets" : null +} +---- + +.Success Response for a Hybrid Query +[source,json] +---- +{ + "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 +} +---- +==== + +.Response 0 +==== +[source,json] +---- +{ + "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" +} +---- +==== + + include::{snippetDir}p-api-scoped-query/http-response.adoc[opts=optional] include::{specDir}paths/p-api-scoped-query/operation-end.adoc[opts=optional] diff --git a/docs/modules/fts-rest-manage/pages/index.adoc b/docs/modules/fts-rest-manage/pages/index.adoc index 3213a196..e3e933db 100644 --- a/docs/modules/fts-rest-manage/pages/index.adoc +++ b/docs/modules/fts-rest-manage/pages/index.adoc @@ -294,8 +294,57 @@ include::{specDir}paths/put_options/operation-security-end.adoc[opts=optional] include::{specDir}paths/put_options/operation-security-after.adoc[opts=optional] +[#put_options-ex-req] += Example HTTP Request + +==== +[#put_options-ex-req-disable] +.Disable +[source,sh] +---- +curl -X PUT http://$HOST:8094/api/managerOptions \ +-u $USER:$PASSWORD \ +-H "Content-type:application/json" \ +-d '{"disableFileTransferRebalance": "true" }' +---- + +[#put_options-ex-req-enable] +.Enable +[source,sh] +---- +curl -X PUT http://$HOST:8094/api/managerOptions \ +-u $USER:$PASSWORD \ +-H "Content-type:application/json" \ +-d '{"disableFileTransferRebalance": "false" }' +---- +==== + + + include::{snippetDir}put_options/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "status" : "ok" +} +---- +==== +.Response 405 +==== +[source,json] +---- +{ + "error" : "Method not allowed for endpoint", + "status" : "fail" +} +---- +==== + + include::{snippetDir}put_options/http-response.adoc[opts=optional] include::{specDir}paths/put_options/operation-end.adoc[opts=optional] diff --git a/docs/modules/fts-rest-nodes/pages/index.adoc b/docs/modules/fts-rest-nodes/pages/index.adoc index bebd5558..399e9264 100644 --- a/docs/modules/fts-rest-nodes/pages/index.adoc +++ b/docs/modules/fts-rest-nodes/pages/index.adoc @@ -238,8 +238,112 @@ include::{specDir}paths/getClusterConfig/operation-security-end.adoc[opts=option include::{specDir}paths/getClusterConfig/operation-security-after.adoc[opts=optional] + + include::{snippetDir}getClusterConfig/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "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" +} +---- +==== + + include::{snippetDir}getClusterConfig/http-response.adoc[opts=optional] include::{specDir}paths/getClusterConfig/operation-end.adoc[opts=optional] @@ -356,8 +460,13 @@ include::{specDir}paths/managerKick/operation-security-end.adoc[opts=optional] include::{specDir}paths/managerKick/operation-security-after.adoc[opts=optional] + + include::{snippetDir}managerKick/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}managerKick/http-response.adoc[opts=optional] include::{specDir}paths/managerKick/operation-end.adoc[opts=optional] @@ -478,8 +587,13 @@ include::{specDir}paths/managerMeta/operation-security-end.adoc[opts=optional] include::{specDir}paths/managerMeta/operation-security-after.adoc[opts=optional] + + include::{snippetDir}managerMeta/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}managerMeta/http-response.adoc[opts=optional] include::{specDir}paths/managerMeta/operation-end.adoc[opts=optional] @@ -596,8 +710,13 @@ include::{specDir}paths/refreshClusterConfig/operation-security-end.adoc[opts=op include::{specDir}paths/refreshClusterConfig/operation-security-after.adoc[opts=optional] + + include::{snippetDir}refreshClusterConfig/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}refreshClusterConfig/http-response.adoc[opts=optional] include::{specDir}paths/refreshClusterConfig/operation-end.adoc[opts=optional] @@ -739,8 +858,13 @@ include::{specDir}paths/captureCpuProfile/operation-security-end.adoc[opts=optio include::{specDir}paths/captureCpuProfile/operation-security-after.adoc[opts=optional] + + include::{snippetDir}captureCpuProfile/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}captureCpuProfile/http-response.adoc[opts=optional] include::{specDir}paths/captureCpuProfile/operation-end.adoc[opts=optional] @@ -857,8 +981,13 @@ include::{specDir}paths/captureMemoryProfile/operation-security-end.adoc[opts=op include::{specDir}paths/captureMemoryProfile/operation-security-after.adoc[opts=optional] + + include::{snippetDir}captureMemoryProfile/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}captureMemoryProfile/http-response.adoc[opts=optional] include::{specDir}paths/captureMemoryProfile/operation-end.adoc[opts=optional] @@ -991,8 +1120,13 @@ include::{specDir}paths/getDiagnostics/operation-security-end.adoc[opts=optional include::{specDir}paths/getDiagnostics/operation-security-after.adoc[opts=optional] + + include::{snippetDir}getDiagnostics/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}getDiagnostics/http-response.adoc[opts=optional] include::{specDir}paths/getDiagnostics/operation-end.adoc[opts=optional] @@ -1113,8 +1247,23 @@ include::{specDir}paths/getLogs/operation-security-end.adoc[opts=optional] include::{specDir}paths/getLogs/operation-security-after.adoc[opts=optional] + + include::{snippetDir}getLogs/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "events" : [ ], + "messages" : [ ] +} +---- +==== + + include::{snippetDir}getLogs/http-response.adoc[opts=optional] include::{specDir}paths/getLogs/operation-end.adoc[opts=optional] @@ -1234,8 +1383,13 @@ include::{specDir}paths/getRuntimeArgs/operation-security-end.adoc[opts=optional include::{specDir}paths/getRuntimeArgs/operation-security-after.adoc[opts=optional] + + include::{snippetDir}getRuntimeArgs/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}getRuntimeArgs/http-response.adoc[opts=optional] include::{specDir}paths/getRuntimeArgs/operation-end.adoc[opts=optional] @@ -1356,8 +1510,32 @@ include::{specDir}paths/getRuntimeInfo/operation-security-end.adoc[opts=optional include::{specDir}paths/getRuntimeInfo/operation-security-after.adoc[opts=optional] + + include::{snippetDir}getRuntimeInfo/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "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" +} +---- +==== + + include::{snippetDir}getRuntimeInfo/http-response.adoc[opts=optional] include::{specDir}paths/getRuntimeInfo/operation-end.adoc[opts=optional] @@ -1494,8 +1672,13 @@ include::{specDir}paths/performGC/operation-security-end.adoc[opts=optional] include::{specDir}paths/performGC/operation-security-after.adoc[opts=optional] + + include::{snippetDir}performGC/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}performGC/http-response.adoc[opts=optional] include::{specDir}paths/performGC/operation-end.adoc[opts=optional] @@ -1636,8 +1819,13 @@ include::{specDir}paths/getMemoryStats/operation-security-end.adoc[opts=optional include::{specDir}paths/getMemoryStats/operation-security-after.adoc[opts=optional] + + include::{snippetDir}getMemoryStats/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}getMemoryStats/http-response.adoc[opts=optional] include::{specDir}paths/getMemoryStats/operation-end.adoc[opts=optional] @@ -1757,8 +1945,13 @@ include::{specDir}paths/getRuntimeStats/operation-security-end.adoc[opts=optiona include::{specDir}paths/getRuntimeStats/operation-security-after.adoc[opts=optional] + + include::{snippetDir}getRuntimeStats/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}getRuntimeStats/http-response.adoc[opts=optional] include::{specDir}paths/getRuntimeStats/operation-end.adoc[opts=optional] diff --git a/docs/modules/fts-rest-query/pages/index.adoc b/docs/modules/fts-rest-query/pages/index.adoc index b5a2abf6..b4c9f43a 100644 --- a/docs/modules/fts-rest-query/pages/index.adoc +++ b/docs/modules/fts-rest-query/pages/index.adoc @@ -270,8 +270,136 @@ include::{specDir}paths/api-query/operation-security-end.adoc[opts=optional] include::{specDir}paths/api-query/operation-security-after.adoc[opts=optional] +[#api-query-ex-req] += Example HTTP Request + +==== +[#api-query-ex-req-all] +.All +[source,sh] +---- +curl -XGET -H "Content-Type: application/json" \ + -u $USER:$PASSWORD \ + "http://$HOST:8094/api/query" +---- + +[#api-query-ex-req-filtered] +.Filtered +[source,sh] +---- +curl -XGET -H "Content-Type: application/json" \ + -u $USER:$PASSWORD \ + "http://$HOST:8094/api/query?longerThan=7s" +---- +==== + + + include::{snippetDir}api-query/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +.All active node queries +[source,json] +---- +{ + "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" + } + } + } +} +---- + +.All active node queries (filtered) +[source,json] +---- +{ + "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" + } + } + } +} +---- +==== + + + include::{snippetDir}api-query/http-response.adoc[opts=optional] include::{specDir}paths/api-query/operation-end.adoc[opts=optional] @@ -452,8 +580,36 @@ include::{specDir}paths/api-query-cancel/operation-security-end.adoc[opts=option include::{specDir}paths/api-query-cancel/operation-security-after.adoc[opts=optional] +[#api-query-cancel-ex-req] += Example HTTP Request + +==== + +[source,sh] +---- +curl -X POST -H "Content-Type: application/json" -u $USER:$PASSWORD \ + "http://$HOST:8094/api/query/24/cancel" -d \ + '{ "uuid": "b91d75480470f979f65f04e8f20a1f7b" }' +---- +==== + + + include::{snippetDir}api-query-cancel/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "status" : "ok", + "msg" : "query with ID '24' on node 'b91d75480470f979f65f04e8f20a1f7b' was aborted!" +} +---- +==== + + include::{snippetDir}api-query-cancel/http-response.adoc[opts=optional] include::{specDir}paths/api-query-cancel/operation-end.adoc[opts=optional] @@ -631,8 +787,71 @@ include::{specDir}paths/api-query-index/operation-security-end.adoc[opts=optiona include::{specDir}paths/api-query-index/operation-security-after.adoc[opts=optional] +[#api-query-index-ex-req] += Example HTTP Request + +==== + +[source,sh] +---- +curl -XGET -H "Content-Type: application/json" \ +-u $USER:$PASSWORD \ +"http://$HOST:8094/api/query/index/DemoIndex1?longerThan=1ms" +---- +==== + + + include::{snippetDir}api-query-index/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "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" + } + } + } +} +---- +==== + + include::{snippetDir}api-query-index/http-response.adoc[opts=optional] include::{specDir}paths/api-query-index/operation-end.adoc[opts=optional] diff --git a/docs/modules/fts-rest-stats/pages/index.adoc b/docs/modules/fts-rest-stats/pages/index.adoc index b04bf87e..7af1a7c6 100644 --- a/docs/modules/fts-rest-stats/pages/index.adoc +++ b/docs/modules/fts-rest-stats/pages/index.adoc @@ -257,8 +257,193 @@ include::{specDir}paths/g-api-nsstats/operation-security-end.adoc[opts=optional] include::{specDir}paths/g-api-nsstats/operation-security-after.adoc[opts=optional] + + include::{snippetDir}g-api-nsstats/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "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" : 5.21150454206345E-5, + "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 +} +---- +==== +.Response 403 +==== +[source,json] +---- +{ + "message" : "Forbidden. User needs one of the following permissions", + "permissions" : [ "cluster.fts!read" ] +} +---- +==== + + include::{snippetDir}g-api-nsstats/http-response.adoc[opts=optional] include::{specDir}paths/g-api-nsstats/operation-end.adoc[opts=optional] @@ -421,8 +606,76 @@ include::{specDir}paths/g-api-nsstats-index-name/operation-security-end.adoc[opt include::{specDir}paths/g-api-nsstats-index-name/operation-security-after.adoc[opts=optional] + + include::{snippetDir}g-api-nsstats-index-name/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "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 +} +---- +==== + + include::{snippetDir}g-api-nsstats-index-name/http-response.adoc[opts=optional] include::{specDir}paths/g-api-nsstats-index-name/operation-end.adoc[opts=optional] diff --git a/docs/modules/index-rest-stats/pages/index.adoc b/docs/modules/index-rest-stats/pages/index.adoc index 76d88d8d..66b405d3 100644 --- a/docs/modules/index-rest-stats/pages/index.adoc +++ b/docs/modules/index-rest-stats/pages/index.adoc @@ -351,8 +351,13 @@ include::{specDir}paths/get_index_stats/operation-security-end.adoc[opts=optiona include::{specDir}paths/get_index_stats/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_index_stats/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_index_stats/http-response.adoc[opts=optional] include::{specDir}paths/get_index_stats/operation-end.adoc[opts=optional] @@ -567,8 +572,13 @@ include::{specDir}paths/get_keyspace_stats/operation-security-end.adoc[opts=opti include::{specDir}paths/get_keyspace_stats/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_keyspace_stats/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_keyspace_stats/http-response.adoc[opts=optional] include::{specDir}paths/get_keyspace_stats/operation-end.adoc[opts=optional] @@ -753,8 +763,13 @@ include::{specDir}paths/get_node_stats/operation-security-end.adoc[opts=optional include::{specDir}paths/get_node_stats/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_node_stats/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_node_stats/http-response.adoc[opts=optional] include::{specDir}paths/get_node_stats/operation-end.adoc[opts=optional] diff --git a/docs/modules/n1ql-rest-admin/pages/index.adoc b/docs/modules/n1ql-rest-admin/pages/index.adoc index 95fa4173..c8cf2f25 100644 --- a/docs/modules/n1ql-rest-admin/pages/index.adoc +++ b/docs/modules/n1ql-rest-admin/pages/index.adoc @@ -281,8 +281,13 @@ include::{specDir}paths/delete_active_request/operation-security-end.adoc[opts=o include::{specDir}paths/delete_active_request/operation-security-after.adoc[opts=optional] + + include::{snippetDir}delete_active_request/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}delete_active_request/http-response.adoc[opts=optional] include::{specDir}paths/delete_active_request/operation-end.adoc[opts=optional] @@ -405,8 +410,13 @@ include::{specDir}paths/get_active_indexes/operation-security-end.adoc[opts=opti include::{specDir}paths/get_active_indexes/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_active_indexes/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_active_indexes/http-response.adoc[opts=optional] include::{specDir}paths/get_active_indexes/operation-end.adoc[opts=optional] @@ -561,8 +571,13 @@ include::{specDir}paths/get_active_request/operation-security-end.adoc[opts=opti include::{specDir}paths/get_active_request/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_active_request/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_active_request/http-response.adoc[opts=optional] include::{specDir}paths/get_active_request/operation-end.adoc[opts=optional] @@ -683,8 +698,13 @@ include::{specDir}paths/get_active_requests/operation-security-end.adoc[opts=opt include::{specDir}paths/get_active_requests/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_active_requests/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_active_requests/http-response.adoc[opts=optional] include::{specDir}paths/get_active_requests/operation-end.adoc[opts=optional] @@ -868,8 +888,13 @@ include::{specDir}paths/delete_completed_request/operation-security-end.adoc[opt include::{specDir}paths/delete_completed_request/operation-security-after.adoc[opts=optional] + + include::{snippetDir}delete_completed_request/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}delete_completed_request/http-response.adoc[opts=optional] include::{specDir}paths/delete_completed_request/operation-end.adoc[opts=optional] @@ -992,8 +1017,13 @@ include::{specDir}paths/get_completed_indexes/operation-security-end.adoc[opts=o include::{specDir}paths/get_completed_indexes/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_completed_indexes/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_completed_indexes/http-response.adoc[opts=optional] include::{specDir}paths/get_completed_indexes/operation-end.adoc[opts=optional] @@ -1148,8 +1178,13 @@ include::{specDir}paths/get_completed_request/operation-security-end.adoc[opts=o include::{specDir}paths/get_completed_request/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_completed_request/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_completed_request/http-response.adoc[opts=optional] include::{specDir}paths/get_completed_request/operation-end.adoc[opts=optional] @@ -1270,8 +1305,13 @@ include::{specDir}paths/get_completed_requests/operation-security-end.adoc[opts= include::{specDir}paths/get_completed_requests/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_completed_requests/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_completed_requests/http-response.adoc[opts=optional] include::{specDir}paths/get_completed_requests/operation-end.adoc[opts=optional] @@ -1449,8 +1489,13 @@ include::{specDir}paths/get_cluster/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_cluster/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_cluster/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_cluster/http-response.adoc[opts=optional] include::{specDir}paths/get_cluster/operation-end.adoc[opts=optional] @@ -1571,8 +1616,13 @@ include::{specDir}paths/get_clusters/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_clusters/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_clusters/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_clusters/http-response.adoc[opts=optional] include::{specDir}paths/get_clusters/operation-end.adoc[opts=optional] @@ -1693,8 +1743,13 @@ include::{specDir}paths/get_config/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_config/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_config/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_config/http-response.adoc[opts=optional] include::{specDir}paths/get_config/operation-end.adoc[opts=optional] @@ -1859,8 +1914,13 @@ include::{specDir}paths/get_node/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_node/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_node/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_node/http-response.adoc[opts=optional] include::{specDir}paths/get_node/operation-end.adoc[opts=optional] @@ -2014,8 +2074,13 @@ include::{specDir}paths/get_nodes/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_nodes/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_nodes/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_nodes/http-response.adoc[opts=optional] include::{specDir}paths/get_nodes/operation-end.adoc[opts=optional] @@ -2167,8 +2232,23 @@ include::{specDir}paths/get_gc/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_gc/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_gc/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "freed" : 123456, + "status" : "GC invoked" +} +---- +==== + + include::{snippetDir}get_gc/http-response.adoc[opts=optional] include::{specDir}paths/get_gc/operation-end.adoc[opts=optional] @@ -2270,8 +2350,13 @@ include::{specDir}paths/get_ping/operation-security-before.adoc[opts=optional] include::{specDir}paths/get_ping/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_ping/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_ping/http-response.adoc[opts=optional] include::{specDir}paths/get_ping/operation-end.adoc[opts=optional] @@ -2401,8 +2486,24 @@ include::{specDir}paths/post_gc/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_gc/operation-security-after.adoc[opts=optional] + + include::{snippetDir}post_gc/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "freed" : 109304, + "released" : 835584, + "status" : "GC invoked and memory released" +} +---- +==== + + include::{snippetDir}post_gc/http-response.adoc[opts=optional] include::{specDir}paths/post_gc/operation-end.adoc[opts=optional] @@ -2586,8 +2687,13 @@ include::{specDir}paths/delete_prepared/operation-security-end.adoc[opts=optiona include::{specDir}paths/delete_prepared/operation-security-after.adoc[opts=optional] + + include::{snippetDir}delete_prepared/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}delete_prepared/http-response.adoc[opts=optional] include::{specDir}paths/delete_prepared/operation-end.adoc[opts=optional] @@ -2742,8 +2848,13 @@ include::{specDir}paths/get_prepared/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_prepared/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_prepared/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_prepared/http-response.adoc[opts=optional] include::{specDir}paths/get_prepared/operation-end.adoc[opts=optional] @@ -2866,8 +2977,13 @@ include::{specDir}paths/get_prepared_indexes/operation-security-end.adoc[opts=op include::{specDir}paths/get_prepared_indexes/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_prepared_indexes/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_prepared_indexes/http-response.adoc[opts=optional] include::{specDir}paths/get_prepared_indexes/operation-end.adoc[opts=optional] @@ -2988,8 +3104,13 @@ include::{specDir}paths/get_prepareds/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_prepareds/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_prepareds/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_prepareds/http-response.adoc[opts=optional] include::{specDir}paths/get_prepareds/operation-end.adoc[opts=optional] @@ -3131,8 +3252,13 @@ include::{specDir}paths/get_settings/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_settings/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_settings/http-response.adoc[opts=optional] include::{specDir}paths/get_settings/operation-end.adoc[opts=optional] @@ -3291,8 +3417,13 @@ include::{specDir}paths/post_settings/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optional] + + include::{snippetDir}post_settings/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}post_settings/http-response.adoc[opts=optional] include::{specDir}paths/post_settings/operation-end.adoc[opts=optional] @@ -3417,8 +3548,20 @@ include::{specDir}paths/get_debug_vars/operation-security-before.adoc[opts=optio include::{specDir}paths/get_debug_vars/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_debug_vars/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 302 +==== +[source,html] +---- +Found. +---- +==== + + include::{snippetDir}get_debug_vars/http-response.adoc[opts=optional] include::{specDir}paths/get_debug_vars/operation-end.adoc[opts=optional] @@ -3575,8 +3718,13 @@ include::{specDir}paths/get_stat/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_stat/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_stat/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_stat/http-response.adoc[opts=optional] include::{specDir}paths/get_stat/operation-end.adoc[opts=optional] @@ -3697,8 +3845,13 @@ include::{specDir}paths/get_stats/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_stats/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_stats/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_stats/http-response.adoc[opts=optional] include::{specDir}paths/get_stats/operation-end.adoc[opts=optional] @@ -3820,8 +3973,13 @@ include::{specDir}paths/get_vitals/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_vitals/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_vitals/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}get_vitals/http-response.adoc[opts=optional] include::{specDir}paths/get_vitals/operation-end.adoc[opts=optional] diff --git a/docs/modules/n1ql-rest-functions/pages/index.adoc b/docs/modules/n1ql-rest-functions/pages/index.adoc index d984207e..dd7fa279 100644 --- a/docs/modules/n1ql-rest-functions/pages/index.adoc +++ b/docs/modules/n1ql-rest-functions/pages/index.adoc @@ -320,8 +320,13 @@ include::{specDir}paths/delete_library/operation-security-end.adoc[opts=optional include::{specDir}paths/delete_library/operation-security-after.adoc[opts=optional] + + include::{snippetDir}delete_library/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}delete_library/http-response.adoc[opts=optional] include::{specDir}paths/delete_library/operation-end.adoc[opts=optional] @@ -504,8 +509,43 @@ include::{specDir}paths/get_collection/operation-security-end.adoc[opts=optional include::{specDir}paths/get_collection/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_collection/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +.All Libraries +[source,json] +---- +[ { + "name" : "math", + "bucket" : "", + "scope" : "", + "code" : "function add(a, b) { return a + b; } function mul(a, b) { return a * b; }" +}, { + "name" : "science", + "bucket" : "travel-sample", + "scope" : "inventory", + "code" : "function f2c(f) { return (5/9)*(f-32); }" +} ] +---- + +.Scoped Libraries +[source,json] +---- +[ { + "name" : "science", + "bucket" : "travel-sample", + "scope" : "inventory", + "code" : "function f2c(f) { return (5/9)*(f-32); }" +} ] +---- +==== + + + include::{snippetDir}get_collection/http-response.adoc[opts=optional] include::{specDir}paths/get_collection/operation-end.adoc[opts=optional] @@ -716,8 +756,32 @@ include::{specDir}paths/get_library/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_library/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_library/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +.Global Library +[source,json] +---- +{ + "math" : "function add(a, b) { return a + b; } function mul(a, b) { return a * b; }" +} +---- + +.Scoped Library +[source,json] +---- +{ + "science" : "function f2c(f) { return (5/9)*(f-32); }" +} +---- +==== + + + include::{snippetDir}get_library/http-response.adoc[opts=optional] include::{specDir}paths/get_library/operation-end.adoc[opts=optional] @@ -949,8 +1013,13 @@ include::{specDir}paths/post_library/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_library/operation-security-after.adoc[opts=optional] + + include::{snippetDir}post_library/http-request.adoc[opts=optional] +// FIXME: Response examples + + include::{snippetDir}post_library/http-response.adoc[opts=optional] include::{specDir}paths/post_library/operation-end.adoc[opts=optional] diff --git a/docs/modules/n1ql-rest-query/pages/index.adoc b/docs/modules/n1ql-rest-query/pages/index.adoc index e4eacc79..2186eb62 100644 --- a/docs/modules/n1ql-rest-query/pages/index.adoc +++ b/docs/modules/n1ql-rest-query/pages/index.adoc @@ -349,8 +349,126 @@ include::{specDir}paths/get_service/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_service/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "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 + } +} +---- +==== +.Response 400 +==== +.SQL++ Error +[source,json] +---- +{ + "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 + } +} +---- + +.Request Error +[source,json] +---- +{ + "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 + } +} +---- +==== + +.Response 404 +==== +[source,json] +---- +{ + "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 + } +} +---- +==== +.Response 503 +==== +[source,json] +---- +{ + "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 + } +} +---- +==== + + include::{snippetDir}get_service/http-response.adoc[opts=optional] include::{specDir}paths/get_service/operation-end.adoc[opts=optional] @@ -588,8 +706,126 @@ include::{specDir}paths/post_service/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_service/operation-security-after.adoc[opts=optional] + + include::{snippetDir}post_service/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "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 + } +} +---- +==== +.Response 400 +==== +.SQL++ Error +[source,json] +---- +{ + "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 + } +} +---- + +.Request Error +[source,json] +---- +{ + "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 + } +} +---- +==== + +.Response 404 +==== +[source,json] +---- +{ + "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 + } +} +---- +==== +.Response 503 +==== +[source,json] +---- +{ + "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 + } +} +---- +==== + + include::{snippetDir}post_service/http-response.adoc[opts=optional] include::{specDir}paths/post_service/operation-end.adoc[opts=optional] @@ -2313,7 +2549,7 @@ When you change the cluster-level setting, the node-level setting is overwritten [%hardbreaks] *Values:* `"off"`, `"on"`, `"unset"` *Default:* `+++"unset"+++` -*Example:* `+++"true"+++` +*Example:* `+++"on"+++` {blank} a¦ String a¦ [#identifier] diff --git a/docs/modules/n1ql-rest-settings/pages/index.adoc b/docs/modules/n1ql-rest-settings/pages/index.adoc index c2536bd9..05bac6cf 100644 --- a/docs/modules/n1ql-rest-settings/pages/index.adoc +++ b/docs/modules/n1ql-rest-settings/pages/index.adoc @@ -235,8 +235,24 @@ include::{specDir}paths/get_access/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_access/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_access/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "all_access" : false, + "allowed_urls" : [ ], + "disallowed_urls" : [ ] +} +---- +==== + + include::{snippetDir}get_access/http-response.adoc[opts=optional] include::{specDir}paths/get_access/operation-end.adoc[opts=optional] @@ -357,8 +373,48 @@ include::{specDir}paths/get_settings/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional] + + include::{snippetDir}get_settings/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "queryTmpSpaceDir" : "/opt/couchbase/var/lib/couchbase/tmp", + "queryTmpSpaceSize" : 5120, + "queryPipelineBatch" : 16, + "queryPipelineCap" : 512, + "queryScanCap" : 512, + "queryTimeout" : 0, + "queryPreparedLimit" : 16384, + "queryCompletedLimit" : 4000, + "queryCompletedThreshold" : 1000, + "queryLogLevel" : "info", + "queryMaxParallelism" : 1, + "queryTxTimeout" : "0ms", + "queryMemoryQuota" : 0, + "queryUseCBO" : true, + "queryCleanupClientAttempts" : true, + "queryCleanupLostAttempts" : true, + "queryCleanupWindow" : "60s", + "queryNumAtrs" : 1024, + "queryNodeQuota" : 0, + "queryUseReplica" : "unset", + "queryNodeQuotaValPercent" : 67, + "queryNumCpus" : 0, + "queryCompletedMaxPlanSize" : 262144, + "queryN1QLFeatCtrl" : 76, + "queryCurlWhitelist" : { + "all_access" : false + } +} +---- +==== + + include::{snippetDir}get_settings/http-response.adoc[opts=optional] include::{specDir}paths/get_settings/operation-end.adoc[opts=optional] @@ -524,8 +580,24 @@ include::{specDir}paths/post_access/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_access/operation-security-after.adoc[opts=optional] + + include::{snippetDir}post_access/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "all_access" : false, + "allowed_urls" : [ "https://company1.com" ], + "disallowed_urls" : [ "https://company2.com" ] +} +---- +==== + + include::{snippetDir}post_access/http-response.adoc[opts=optional] include::{specDir}paths/post_access/operation-end.adoc[opts=optional] @@ -691,8 +763,48 @@ include::{specDir}paths/post_settings/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optional] + + include::{snippetDir}post_settings/http-request.adoc[opts=optional] +// FIXME: Response examples +.Response 200 +==== +[source,json] +---- +{ + "queryTmpSpaceDir" : "/tmp", + "queryTmpSpaceSize" : 2048, + "queryPipelineBatch" : 16, + "queryPipelineCap" : 512, + "queryScanCap" : 512, + "queryTimeout" : 0, + "queryPreparedLimit" : 16384, + "queryCompletedLimit" : 4000, + "queryCompletedThreshold" : 1000, + "queryLogLevel" : "info", + "queryMaxParallelism" : 1, + "queryTxTimeout" : "0ms", + "queryMemoryQuota" : 0, + "queryUseCBO" : true, + "queryCleanupClientAttempts" : true, + "queryCleanupLostAttempts" : true, + "queryCleanupWindow" : "60s", + "queryNumAtrs" : 1024, + "queryNodeQuota" : 0, + "queryUseReplica" : "unset", + "queryNodeQuotaValPercent" : 67, + "queryNumCpus" : 0, + "queryCompletedMaxPlanSize" : 262144, + "queryN1QLFeatCtrl" : 76, + "queryCurlWhitelist" : { + "all_access" : false + } +} +---- +==== + + include::{snippetDir}post_settings/http-response.adoc[opts=optional] include::{specDir}paths/post_settings/operation-end.adoc[opts=optional] From 8e8c4efb8e365b74a55c3a9ea265c1dc5883cc69 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Fri, 30 Jan 2026 17:49:56 +0000 Subject: [PATCH 09/30] Remove unnecessary FTS response example partials --- .../paths/getPartition/http-response.adoc | 9 ------- .../paths/d-api-index-name/http-response.adoc | 17 ------------- .../http-response.adoc | 17 ------------- .../g-api-index-name-count/http-response.adoc | 9 ------- .../paths/g-api-index-name/http-response.adoc | 9 ------- .../paths/g-api-index/http-response.adoc | 9 ------- .../http-response.adoc | 9 ------- .../g-api-scoped-indexes/http-response.adoc | 9 ------- .../g-api-scoped-status/http-response.adoc | 9 ------- .../g-api-stats-index-name/http-response.adoc | 9 ------- .../paths/g-api-stats/http-response.adoc | 9 ------- .../http-response.adoc | 9 ------- .../http-response.adoc | 9 ------- .../http-response.adoc | 9 ------- .../paths/p-api-index-name/http-response.adoc | 17 ------------- .../p-api-pindex-lookup/http-response.adoc | 9 ------- .../http-response.adoc | 17 ------------- .../http-response.adoc | 9 ------- .../http-response.adoc | 9 ------- .../p-api-scoped-query/http-response.adoc | 25 ------------------- .../http-response.adoc | 9 ------- .../paths/put_options/http-response.adoc | 17 ------------- .../paths/getClusterConfig/http-response.adoc | 9 ------- .../partials/paths/getLogs/http-response.adoc | 9 ------- .../paths/getRuntimeInfo/http-response.adoc | 9 ------- .../paths/api-query-cancel/http-response.adoc | 11 -------- .../paths/api-query-index/http-response.adoc | 11 -------- .../paths/api-query/http-response.adoc | 21 ---------------- .../http-response.adoc | 9 ------- 29 files changed, 333 deletions(-) delete mode 100644 docs/modules/fts-rest-advanced/partials/paths/getPartition/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/d-api-index-name/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/d-api-scoped-index-name/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/g-api-index-name-count/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/g-api-index-name/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/g-api-index/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-index-name/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-indexes/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-status/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/g-api-stats-index-name/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/g-api-stats/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-ingestcontrol/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-planfreezecontrol/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-querycontrol/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/p-api-index-name/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/p-api-pindex-lookup/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-index-name/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-ingestcontrol/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-planfreezecontrol/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-query/http-response.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-querycontrol/http-response.adoc delete mode 100644 docs/modules/fts-rest-manage/partials/paths/put_options/http-response.adoc delete mode 100644 docs/modules/fts-rest-nodes/partials/paths/getClusterConfig/http-response.adoc delete mode 100644 docs/modules/fts-rest-nodes/partials/paths/getLogs/http-response.adoc delete mode 100644 docs/modules/fts-rest-nodes/partials/paths/getRuntimeInfo/http-response.adoc delete mode 100644 docs/modules/fts-rest-query/partials/paths/api-query-cancel/http-response.adoc delete mode 100644 docs/modules/fts-rest-query/partials/paths/api-query-index/http-response.adoc delete mode 100644 docs/modules/fts-rest-query/partials/paths/api-query/http-response.adoc delete mode 100644 docs/modules/fts-rest-stats/partials/paths/g-api-nsstats-index-name/http-response.adoc 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 deleted file mode 100644 index a43e0469..00000000 --- a/docs/modules/fts-rest-advanced/partials/paths/getPartition/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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-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 deleted file mode 100644 index 08be0a1b..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/d-api-index-name/http-response.adoc +++ /dev/null @@ -1,17 +0,0 @@ -= 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-scoped-index-name/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/d-api-scoped-index-name/http-response.adoc deleted file mode 100644 index f759ea82..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/d-api-scoped-index-name/http-response.adoc +++ /dev/null @@ -1,17 +0,0 @@ -= 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 deleted file mode 100644 index cd70782e..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/g-api-index-name-count/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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 deleted file mode 100644 index 709a3e8d..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/g-api-index-name/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/g-api-index/http-response.adoc deleted file mode 100644 index 33a36899..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/g-api-index/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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-scoped-index-name/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-index-name/http-response.adoc deleted file mode 100644 index 4a1bb595..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-index-name/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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 deleted file mode 100644 index 72895fe8..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-indexes/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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 deleted file mode 100644 index 95f9ad34..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/g-api-scoped-status/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/g-api-stats-index-name/http-response.adoc deleted file mode 100644 index 0e51e503..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/g-api-stats-index-name/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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 deleted file mode 100644 index 5036eb30..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/g-api-stats/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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 deleted file mode 100644 index 4991e439..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-ingestcontrol/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-planfreezecontrol/http-response.adoc deleted file mode 100644 index 4991e439..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-planfreezecontrol/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-querycontrol/http-response.adoc deleted file mode 100644 index 4991e439..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/p-api-idx-name-querycontrol/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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-index-name/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name/http-response.adoc deleted file mode 100644 index 1dcc20a8..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/p-api-index-name/http-response.adoc +++ /dev/null @@ -1,17 +0,0 @@ -= 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-pindex-lookup/http-response.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-pindex-lookup/http-response.adoc deleted file mode 100644 index f64ec8fd..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/p-api-pindex-lookup/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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 deleted file mode 100644 index b99e49aa..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-index-name/http-response.adoc +++ /dev/null @@ -1,17 +0,0 @@ -= 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 deleted file mode 100644 index 4991e439..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-ingestcontrol/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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 deleted file mode 100644 index 4991e439..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-planfreezecontrol/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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 deleted file mode 100644 index a7d72313..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-query/http-response.adoc +++ /dev/null @@ -1,25 +0,0 @@ -= 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 deleted file mode 100644 index 4991e439..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/p-api-scoped-querycontrol/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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-manage/partials/paths/put_options/http-response.adoc b/docs/modules/fts-rest-manage/partials/paths/put_options/http-response.adoc deleted file mode 100644 index dc975839..00000000 --- a/docs/modules/fts-rest-manage/partials/paths/put_options/http-response.adoc +++ /dev/null @@ -1,17 +0,0 @@ -= 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-nodes/partials/paths/getClusterConfig/http-response.adoc b/docs/modules/fts-rest-nodes/partials/paths/getClusterConfig/http-response.adoc deleted file mode 100644 index 0b8f4088..00000000 --- a/docs/modules/fts-rest-nodes/partials/paths/getClusterConfig/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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 deleted file mode 100644 index c5c42008..00000000 --- a/docs/modules/fts-rest-nodes/partials/paths/getLogs/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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 deleted file mode 100644 index 6e854227..00000000 --- a/docs/modules/fts-rest-nodes/partials/paths/getRuntimeInfo/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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-query/partials/paths/api-query-cancel/http-response.adoc b/docs/modules/fts-rest-query/partials/paths/api-query-cancel/http-response.adoc deleted file mode 100644 index 825a2b3a..00000000 --- a/docs/modules/fts-rest-query/partials/paths/api-query-cancel/http-response.adoc +++ /dev/null @@ -1,11 +0,0 @@ -= 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-response.adoc b/docs/modules/fts-rest-query/partials/paths/api-query-index/http-response.adoc deleted file mode 100644 index fcd01344..00000000 --- a/docs/modules/fts-rest-query/partials/paths/api-query-index/http-response.adoc +++ /dev/null @@ -1,11 +0,0 @@ -= 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-response.adoc b/docs/modules/fts-rest-query/partials/paths/api-query/http-response.adoc deleted file mode 100644 index dbad3452..00000000 --- a/docs/modules/fts-rest-query/partials/paths/api-query/http-response.adoc +++ /dev/null @@ -1,21 +0,0 @@ -= 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-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 deleted file mode 100644 index acbf5dff..00000000 --- a/docs/modules/fts-rest-stats/partials/paths/g-api-nsstats-index-name/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= Example HTTP Response - -==== -.Response 200 -[source,json] ----- -include::example$g-api-nsstats-index-name.json[] ----- -==== \ No newline at end of file From 6c44799f61c752e73ca1739e5b0052625fd46e26 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Fri, 30 Jan 2026 17:50:25 +0000 Subject: [PATCH 10/30] Add ID to response examples --- templates/index.handlebars | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/templates/index.handlebars b/templates/index.handlebars index b4c6ffbf..0837fb86 100644 --- a/templates/index.handlebars +++ b/templates/index.handlebars @@ -342,6 +342,7 @@ include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] {{#with content.[application/json] ~}} {{#with example ~}} +[#{{operationIdOriginal}}-ex-response-{{code}}] .Response {{#if code}}{{code}}{{else}}(default){{/if}} ==== [source,json] @@ -352,10 +353,12 @@ include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] {{else each examples ~}} {{#if @first ~}} +[#{{operationIdOriginal}}-ex-response-{{code}}] .Response {{#if code}}{{code}}{{else}}(default){{/if}} ==== {{/if ~}} {{#with summary~}} +[#{{operationIdOriginal}}-ex-response-{{code}}-{{#slugify}}{{this}}{{/slugify}}] .{{{this}}} {{~/with}} [source,json] @@ -369,6 +372,7 @@ include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] {{~else with content.[text/html] ~}} {{#with example ~}} +[#{{operationIdOriginal}}-ex-response-{{code}}] .Response {{code}} ==== [source,html] @@ -379,10 +383,12 @@ include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] {{else each examples ~}} {{#if @first ~}} +[#{{operationIdOriginal}}-ex-response-{{code}}] .Response {{code}} ==== {{/if ~}} {{#with summary~}} +[#{{operationIdOriginal}}-ex-response-{{code}}-{{#slugify}}{{this}}{{/slugify}}] .{{{this}}} {{~/with}} [source,html] From 6fd0cece6fe3d14ceaae0b446b72547085ef31aa Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Fri, 30 Jan 2026 17:50:51 +0000 Subject: [PATCH 11/30] =?UTF-8?q?Update=20FTS=20response=20example=20parti?= =?UTF-8?q?als=20=E2=80=94=20they're=20just=20explanations=20now?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../paths/g-api-nsstats/http-response.adoc | 22 ++----------------- 1 file changed, 2 insertions(+), 20 deletions(-) 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 index 24f10fe2..6820ce68 100644 --- 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 @@ -1,21 +1,3 @@ -= Example HTTP Response +A successful response returns an object like <>, which contains statistics on 2 indexes, `travel-sample-index` and `color-test`. -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 +If a user authenticates but does not have the appropriate permissions, the API returns a `403 Forbidden` response with an object similar to <>. \ No newline at end of file From de88be2e05e602ecd7012607742a906d31ea22d6 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Fri, 30 Jan 2026 23:42:56 +0000 Subject: [PATCH 12/30] Handle request body examples --- templates/index.handlebars | 40 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/templates/index.handlebars b/templates/index.handlebars index 0837fb86..40007e1b 100644 --- a/templates/index.handlebars +++ b/templates/index.handlebars @@ -317,13 +317,13 @@ include::{specDir}paths/{{operationIdOriginal}}/operation-security-after.adoc[op {{#each vendorExtensions.x-codeSamples ~}} {{#if @first ~}} -[#{{operationIdOriginal}}-ex-req] +[#{{operationIdOriginal}}-ex-curl] = Example HTTP Request ==== {{/if ~}} {{#with label~}} -[#{{operationIdOriginal}}-ex-req-{{#slugify}}{{this}}{{/slugify}}] +[#{{operationIdOriginal}}-ex-curl-{{#slugify}}{{this}}{{/slugify}}] .{{{this}}} {{~/with}} [source,sh]{{!-- FIXME: {{#with lang}},{{#lower}}{{this}}{{/lower}}{{/with}} --}} @@ -335,6 +335,42 @@ include::{specDir}paths/{{operationIdOriginal}}/operation-security-after.adoc[op {{/if}} {{/each}} +include::{snippetDir}{{operationIdOriginal}}/curl-request.adoc[opts=optional] + +{{#with bodyParam ~}} +{{#with content.[application/json] ~}} +{{#with example ~}} +[#{{operationIdOriginal}}-ex-request] += Example Request Body + +==== +[source,json] +---- +{{#json pretty=true}}{{{this}}}{{/json}} +---- +==== +{{else each examples ~}} +{{#if @first ~}} +[#{{operationIdOriginal}}-ex-request] += Example Request Body + +==== +{{/if ~}} +{{#with summary~}} +[#{{operationIdOriginal}}-ex-request-{{#slugify}}{{this}}{{/slugify}}] +.{{{this}}} +{{~/with}} +[source,json] +---- +{{#with value}}{{#json pretty=true}}{{{this}}}{{/json}}{{/with}} +---- +{{#if @last ~}} +==== +{{/if}} +{{/with}}{{! example }} +{{~/with}}{{! content.[application/json] }} +{{~/with}}{{! bodyParam }} + include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] // FIXME: Response examples From 10f492f94bfa5fdceca22d6809b3ab226a9b6db4 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Fri, 30 Jan 2026 23:43:40 +0000 Subject: [PATCH 13/30] Remove unnecessary FTS request body partials --- .../g-api-stats-index-name-analyzeDoc/http-request.adoc | 9 --------- .../partials/paths/p-api-pindex-lookup/http-request.adoc | 8 -------- 2 files changed, 17 deletions(-) delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/g-api-stats-index-name-analyzeDoc/http-request.adoc delete mode 100644 docs/modules/fts-rest-indexing/partials/paths/p-api-pindex-lookup/http-request.adoc 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 deleted file mode 100644 index 87b5caad..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/g-api-stats-index-name-analyzeDoc/http-request.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= 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/p-api-pindex-lookup/http-request.adoc b/docs/modules/fts-rest-indexing/partials/paths/p-api-pindex-lookup/http-request.adoc deleted file mode 100644 index 3269fa47..00000000 --- a/docs/modules/fts-rest-indexing/partials/paths/p-api-pindex-lookup/http-request.adoc +++ /dev/null @@ -1,8 +0,0 @@ -= Example Request Body - -==== -[source,json] ----- -include::example$p-api-pindex-lookup-body.json[] ----- -==== \ No newline at end of file From 9bb60ae204f8bfd127a8c5def23580413535d184 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Fri, 30 Jan 2026 23:44:20 +0000 Subject: [PATCH 14/30] =?UTF-8?q?Update=20FTS=20request=20body=20partials?= =?UTF-8?q?=20=E2=80=94=20they're=20just=20explanations=20now?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../http-response.adoc | 14 ++------- .../p-api-index-name-query/http-request.adoc | 29 ++----------------- 2 files changed, 5 insertions(+), 38 deletions(-) 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 index d431e728..a35797dc 100644 --- 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 @@ -1,15 +1,5 @@ -= Example HTTP Response - -The following example shows the result of analyzing the document from the <> using a Search index with the following settings: +<> 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 +* An `ngram` token filter with a `min` of 2 and a `max` of 5 for the `name` field. \ 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 index dbe0d26c..e9f4e842 100644 --- 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 @@ -1,31 +1,8 @@ -= Example Request Body +The <> request body searches for the text `a sample query` in the documents included in the Search index. -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. +The <> request body uses from/size for results paging, with `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[] ----- -==== +The <> 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`. For more information about vector searches, see xref:vector-search:vector-search.adoc[]. \ No newline at end of file From a1675389a8807fb403f0aef59acf0381e7bb43bc Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Fri, 30 Jan 2026 23:53:06 +0000 Subject: [PATCH 15/30] Fix xref --- .../partials/paths/g-api-index/operation-description-end.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 index 6552a579..f4043ca6 100644 --- 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 @@ -1,2 +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 +Use <> instead. \ No newline at end of file From 82815c18b2bb3924a9c25139da6cd7a24036495b Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Sat, 31 Jan 2026 00:12:38 +0000 Subject: [PATCH 16/30] Rename all existing http-request partials to curl-request --- .../cancel_request/{http-request.adoc => curl-request.adoc} | 0 .../cluster_status/{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../ingestion_status/{http-request.adoc => curl-request.adoc} | 0 .../monitor_node/{http-request.adoc => curl-request.adoc} | 0 .../restart_cluster/{http-request.adoc => curl-request.adoc} | 0 .../restart_node/{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../paths/get_node/{http-request.adoc => curl-request.adoc} | 0 .../get_service/{http-request.adoc => curl-request.adoc} | 0 .../paths/put_node/{http-request.adoc => curl-request.adoc} | 0 .../put_service/{http-request.adoc => curl-request.adoc} | 0 .../delete_library/{http-request.adoc => curl-request.adoc} | 0 .../get_collection/{http-request.adoc => curl-request.adoc} | 0 .../post_library/{http-request.adoc => curl-request.adoc} | 0 .../delete_link/{http-request.adoc => curl-request.adoc} | 0 .../paths/get_all/{http-request.adoc => curl-request.adoc} | 0 .../paths/get_link/{http-request.adoc => curl-request.adoc} | 0 .../paths/get_scope/{http-request.adoc => curl-request.adoc} | 0 .../paths/post_link/{http-request.adoc => curl-request.adoc} | 0 .../paths/put_link/{http-request.adoc => curl-request.adoc} | 0 .../get_service/{http-request.adoc => curl-request.adoc} | 0 .../post_service/{http-request.adoc => curl-request.adoc} | 0 .../get_settings/{http-request.adoc => curl-request.adoc} | 0 .../post_settings/{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../adv_function_zap/{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../adv_settings_get/{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../adv_text_get/{http-request.adoc => curl-request.adoc} | 0 .../adv_text_update/{http-request.adoc => curl-request.adoc} | 0 .../basic_deploy/{http-request.adoc => curl-request.adoc} | 0 .../basic_pause/{http-request.adoc => curl-request.adoc} | 0 .../basic_resume/{http-request.adoc => curl-request.adoc} | 0 .../basic_undeploy/{http-request.adoc => curl-request.adoc} | 0 .../paths/config_get/{http-request.adoc => curl-request.adoc} | 0 .../config_update/{http-request.adoc => curl-request.adoc} | 0 .../paths/list_all/{http-request.adoc => curl-request.adoc} | 0 .../paths/list_query/{http-request.adoc => curl-request.adoc} | 0 .../paths/log_view/{http-request.adoc => curl-request.adoc} | 0 .../paths/stats_all/{http-request.adoc => curl-request.adoc} | 0 .../stats_execution/{http-request.adoc => curl-request.adoc} | 0 .../stats_failure/{http-request.adoc => curl-request.adoc} | 0 .../stats_latency/{http-request.adoc => curl-request.adoc} | 0 .../stats_reset/{http-request.adoc => curl-request.adoc} | 0 .../paths/status_all/{http-request.adoc => curl-request.adoc} | 0 .../status_function/{http-request.adoc => curl-request.adoc} | 0 .../put_options/{http-request.adoc => curl-request.adoc} | 4 ++-- .../api-query-cancel/{http-request.adoc => curl-request.adoc} | 0 .../api-query-index/{http-request.adoc => curl-request.adoc} | 0 .../fts-rest-query/partials/paths/api-query/curl-request.adoc | 3 +++ .../fts-rest-query/partials/paths/api-query/http-request.adoc | 3 --- .../get_index_stats/{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../get_node_stats/{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../delete_prepared/{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../{http-request.adoc => curl-request.adoc} | 0 .../get_prepared/{http-request.adoc => curl-request.adoc} | 0 .../get_prepareds/{http-request.adoc => curl-request.adoc} | 0 .../paths/get_vitals/{http-request.adoc => curl-request.adoc} | 0 .../delete_library/{http-request.adoc => curl-request.adoc} | 0 .../get_collection/{http-request.adoc => curl-request.adoc} | 0 .../get_library/{http-request.adoc => curl-request.adoc} | 0 .../post_library/{http-request.adoc => curl-request.adoc} | 0 .../get_service/{http-request.adoc => curl-request.adoc} | 0 .../post_service/{http-request.adoc => curl-request.adoc} | 0 .../paths/get_access/{http-request.adoc => curl-request.adoc} | 0 .../get_settings/{http-request.adoc => curl-request.adoc} | 0 .../post_access/{http-request.adoc => curl-request.adoc} | 0 .../post_settings/{http-request.adoc => curl-request.adoc} | 0 83 files changed, 5 insertions(+), 5 deletions(-) rename docs/modules/analytics-rest-admin/partials/paths/cancel_request/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-admin/partials/paths/cluster_status/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-admin/partials/paths/completed_requests/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-admin/partials/paths/ingestion_status/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-admin/partials/paths/monitor_node/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-admin/partials/paths/restart_cluster/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-admin/partials/paths/restart_node/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-admin/partials/paths/return_active_requests/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-config/partials/paths/get_node/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-config/partials/paths/get_service/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-config/partials/paths/put_node/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-config/partials/paths/put_service/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-library/partials/paths/delete_library/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-library/partials/paths/get_collection/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-library/partials/paths/post_library/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-links/partials/paths/delete_link/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-links/partials/paths/get_all/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-links/partials/paths/get_link/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-links/partials/paths/get_scope/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-links/partials/paths/post_link/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-links/partials/paths/put_link/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-service/partials/paths/get_service/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-service/partials/paths/post_service/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-settings/partials/paths/get_settings/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/analytics-rest-settings/partials/paths/post_settings/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/adv_function_import/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/adv_function_import_all/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/adv_function_view/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/adv_function_view_all/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/adv_function_zap/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/adv_function_zap_all/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/adv_multiple_export/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/adv_multiple_import/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/adv_settings_get/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/adv_settings_update/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/adv_structure_get/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/adv_structure_update/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/adv_text_get/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/adv_text_update/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/basic_deploy/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/basic_pause/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/basic_resume/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/basic_undeploy/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/config_get/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/config_update/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/list_all/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/list_query/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/log_view/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/stats_all/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/stats_execution/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/stats_failure/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/stats_latency/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/stats_reset/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/status_all/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/eventing-rest-api/partials/paths/status_function/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/fts-rest-manage/partials/paths/put_options/{http-request.adoc => curl-request.adoc} (62%) rename docs/modules/fts-rest-query/partials/paths/api-query-cancel/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/fts-rest-query/partials/paths/api-query-index/{http-request.adoc => curl-request.adoc} (100%) create mode 100644 docs/modules/fts-rest-query/partials/paths/api-query/curl-request.adoc delete mode 100644 docs/modules/fts-rest-query/partials/paths/api-query/http-request.adoc rename docs/modules/index-rest-stats/partials/paths/get_index_stats/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/index-rest-stats/partials/paths/get_keyspace_stats/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/index-rest-stats/partials/paths/get_node_stats/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-admin/partials/paths/delete_active_request/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-admin/partials/paths/delete_completed_request/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-admin/partials/paths/delete_prepared/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-admin/partials/paths/get_active_request/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-admin/partials/paths/get_active_requests/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-admin/partials/paths/get_completed_request/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-admin/partials/paths/get_completed_requests/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-admin/partials/paths/get_prepared/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-admin/partials/paths/get_prepareds/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-admin/partials/paths/get_vitals/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-functions/partials/paths/delete_library/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-functions/partials/paths/get_collection/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-functions/partials/paths/get_library/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-functions/partials/paths/post_library/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-query/partials/paths/get_service/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-query/partials/paths/post_service/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-settings/partials/paths/get_access/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-settings/partials/paths/get_settings/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-settings/partials/paths/post_access/{http-request.adoc => curl-request.adoc} (100%) rename docs/modules/n1ql-rest-settings/partials/paths/post_settings/{http-request.adoc => curl-request.adoc} (100%) diff --git a/docs/modules/analytics-rest-admin/partials/paths/cancel_request/http-request.adoc b/docs/modules/analytics-rest-admin/partials/paths/cancel_request/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-admin/partials/paths/cancel_request/http-request.adoc rename to docs/modules/analytics-rest-admin/partials/paths/cancel_request/curl-request.adoc diff --git a/docs/modules/analytics-rest-admin/partials/paths/cluster_status/http-request.adoc b/docs/modules/analytics-rest-admin/partials/paths/cluster_status/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-admin/partials/paths/cluster_status/http-request.adoc rename to docs/modules/analytics-rest-admin/partials/paths/cluster_status/curl-request.adoc diff --git a/docs/modules/analytics-rest-admin/partials/paths/completed_requests/http-request.adoc b/docs/modules/analytics-rest-admin/partials/paths/completed_requests/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-admin/partials/paths/completed_requests/http-request.adoc rename to docs/modules/analytics-rest-admin/partials/paths/completed_requests/curl-request.adoc diff --git a/docs/modules/analytics-rest-admin/partials/paths/ingestion_status/http-request.adoc b/docs/modules/analytics-rest-admin/partials/paths/ingestion_status/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-admin/partials/paths/ingestion_status/http-request.adoc rename to docs/modules/analytics-rest-admin/partials/paths/ingestion_status/curl-request.adoc diff --git a/docs/modules/analytics-rest-admin/partials/paths/monitor_node/http-request.adoc b/docs/modules/analytics-rest-admin/partials/paths/monitor_node/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-admin/partials/paths/monitor_node/http-request.adoc rename to docs/modules/analytics-rest-admin/partials/paths/monitor_node/curl-request.adoc diff --git a/docs/modules/analytics-rest-admin/partials/paths/restart_cluster/http-request.adoc b/docs/modules/analytics-rest-admin/partials/paths/restart_cluster/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-admin/partials/paths/restart_cluster/http-request.adoc rename to docs/modules/analytics-rest-admin/partials/paths/restart_cluster/curl-request.adoc diff --git a/docs/modules/analytics-rest-admin/partials/paths/restart_node/http-request.adoc b/docs/modules/analytics-rest-admin/partials/paths/restart_node/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-admin/partials/paths/restart_node/http-request.adoc rename to docs/modules/analytics-rest-admin/partials/paths/restart_node/curl-request.adoc diff --git a/docs/modules/analytics-rest-admin/partials/paths/return_active_requests/http-request.adoc b/docs/modules/analytics-rest-admin/partials/paths/return_active_requests/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-admin/partials/paths/return_active_requests/http-request.adoc rename to docs/modules/analytics-rest-admin/partials/paths/return_active_requests/curl-request.adoc diff --git a/docs/modules/analytics-rest-config/partials/paths/get_node/http-request.adoc b/docs/modules/analytics-rest-config/partials/paths/get_node/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-config/partials/paths/get_node/http-request.adoc rename to docs/modules/analytics-rest-config/partials/paths/get_node/curl-request.adoc diff --git a/docs/modules/analytics-rest-config/partials/paths/get_service/http-request.adoc b/docs/modules/analytics-rest-config/partials/paths/get_service/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-config/partials/paths/get_service/http-request.adoc rename to docs/modules/analytics-rest-config/partials/paths/get_service/curl-request.adoc diff --git a/docs/modules/analytics-rest-config/partials/paths/put_node/http-request.adoc b/docs/modules/analytics-rest-config/partials/paths/put_node/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-config/partials/paths/put_node/http-request.adoc rename to docs/modules/analytics-rest-config/partials/paths/put_node/curl-request.adoc diff --git a/docs/modules/analytics-rest-config/partials/paths/put_service/http-request.adoc b/docs/modules/analytics-rest-config/partials/paths/put_service/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-config/partials/paths/put_service/http-request.adoc rename to docs/modules/analytics-rest-config/partials/paths/put_service/curl-request.adoc diff --git a/docs/modules/analytics-rest-library/partials/paths/delete_library/http-request.adoc b/docs/modules/analytics-rest-library/partials/paths/delete_library/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-library/partials/paths/delete_library/http-request.adoc rename to docs/modules/analytics-rest-library/partials/paths/delete_library/curl-request.adoc diff --git a/docs/modules/analytics-rest-library/partials/paths/get_collection/http-request.adoc b/docs/modules/analytics-rest-library/partials/paths/get_collection/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-library/partials/paths/get_collection/http-request.adoc rename to docs/modules/analytics-rest-library/partials/paths/get_collection/curl-request.adoc diff --git a/docs/modules/analytics-rest-library/partials/paths/post_library/http-request.adoc b/docs/modules/analytics-rest-library/partials/paths/post_library/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-library/partials/paths/post_library/http-request.adoc rename to docs/modules/analytics-rest-library/partials/paths/post_library/curl-request.adoc diff --git a/docs/modules/analytics-rest-links/partials/paths/delete_link/http-request.adoc b/docs/modules/analytics-rest-links/partials/paths/delete_link/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-links/partials/paths/delete_link/http-request.adoc rename to docs/modules/analytics-rest-links/partials/paths/delete_link/curl-request.adoc diff --git a/docs/modules/analytics-rest-links/partials/paths/get_all/http-request.adoc b/docs/modules/analytics-rest-links/partials/paths/get_all/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-links/partials/paths/get_all/http-request.adoc rename to docs/modules/analytics-rest-links/partials/paths/get_all/curl-request.adoc diff --git a/docs/modules/analytics-rest-links/partials/paths/get_link/http-request.adoc b/docs/modules/analytics-rest-links/partials/paths/get_link/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-links/partials/paths/get_link/http-request.adoc rename to docs/modules/analytics-rest-links/partials/paths/get_link/curl-request.adoc diff --git a/docs/modules/analytics-rest-links/partials/paths/get_scope/http-request.adoc b/docs/modules/analytics-rest-links/partials/paths/get_scope/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-links/partials/paths/get_scope/http-request.adoc rename to docs/modules/analytics-rest-links/partials/paths/get_scope/curl-request.adoc diff --git a/docs/modules/analytics-rest-links/partials/paths/post_link/http-request.adoc b/docs/modules/analytics-rest-links/partials/paths/post_link/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-links/partials/paths/post_link/http-request.adoc rename to docs/modules/analytics-rest-links/partials/paths/post_link/curl-request.adoc diff --git a/docs/modules/analytics-rest-links/partials/paths/put_link/http-request.adoc b/docs/modules/analytics-rest-links/partials/paths/put_link/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-links/partials/paths/put_link/http-request.adoc rename to docs/modules/analytics-rest-links/partials/paths/put_link/curl-request.adoc diff --git a/docs/modules/analytics-rest-service/partials/paths/get_service/http-request.adoc b/docs/modules/analytics-rest-service/partials/paths/get_service/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-service/partials/paths/get_service/http-request.adoc rename to docs/modules/analytics-rest-service/partials/paths/get_service/curl-request.adoc diff --git a/docs/modules/analytics-rest-service/partials/paths/post_service/http-request.adoc b/docs/modules/analytics-rest-service/partials/paths/post_service/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-service/partials/paths/post_service/http-request.adoc rename to docs/modules/analytics-rest-service/partials/paths/post_service/curl-request.adoc diff --git a/docs/modules/analytics-rest-settings/partials/paths/get_settings/http-request.adoc b/docs/modules/analytics-rest-settings/partials/paths/get_settings/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-settings/partials/paths/get_settings/http-request.adoc rename to docs/modules/analytics-rest-settings/partials/paths/get_settings/curl-request.adoc diff --git a/docs/modules/analytics-rest-settings/partials/paths/post_settings/http-request.adoc b/docs/modules/analytics-rest-settings/partials/paths/post_settings/curl-request.adoc similarity index 100% rename from docs/modules/analytics-rest-settings/partials/paths/post_settings/http-request.adoc rename to docs/modules/analytics-rest-settings/partials/paths/post_settings/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/adv_function_import/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/adv_function_import/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/adv_function_import_all/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/adv_function_import_all/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/adv_function_view/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/adv_function_view/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/adv_function_view_all/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/adv_function_view_all/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/adv_function_zap/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/adv_function_zap/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/adv_function_zap_all/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/adv_function_zap_all/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/adv_multiple_export/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/adv_multiple_export/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/adv_multiple_import/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/adv_multiple_import/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/adv_settings_get/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/adv_settings_get/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/adv_settings_update/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/adv_settings_update/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/adv_structure_get/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/adv_structure_get/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/adv_structure_update/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/adv_structure_update/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/adv_text_get/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/adv_text_get/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/adv_text_update/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/adv_text_update/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/basic_deploy/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/basic_deploy/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/basic_pause/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/basic_pause/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/basic_resume/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/basic_resume/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/basic_undeploy/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/basic_undeploy/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/config_get/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/config_get/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/config_update/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/config_update/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/list_all/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/list_all/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/list_query/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/list_query/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/log_view/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/log_view/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/stats_all/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/stats_all/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/stats_execution/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/stats_execution/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/stats_failure/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/stats_failure/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/stats_latency/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/stats_latency/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/stats_reset/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/stats_reset/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/status_all/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/status_all/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/eventing-rest-api/partials/paths/status_function/http-request.adoc rename to docs/modules/eventing-rest-api/partials/paths/status_function/curl-request.adoc 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/curl-request.adoc similarity index 62% rename from docs/modules/fts-rest-manage/partials/paths/put_options/http-request.adoc rename to docs/modules/fts-rest-manage/partials/paths/put_options/curl-request.adoc index 66497dbb..d25f4e6d 100644 --- a/docs/modules/fts-rest-manage/partials/paths/put_options/http-request.adoc +++ b/docs/modules/fts-rest-manage/partials/paths/put_options/curl-request.adoc @@ -1,5 +1,5 @@ -The <> request disables the creation of new partitions by means of file transfer. +The <> request disables the creation of new partitions by means of file transfer. From this point, Search Service index partitions are built on the new nodes assigned to them during rebalance. -The <> request re-enables the creation of new partitions by means of file transfer. +The <> request re-enables the creation of new partitions by means of file transfer. 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-query/partials/paths/api-query-cancel/http-request.adoc b/docs/modules/fts-rest-query/partials/paths/api-query-cancel/curl-request.adoc similarity index 100% rename from docs/modules/fts-rest-query/partials/paths/api-query-cancel/http-request.adoc rename to docs/modules/fts-rest-query/partials/paths/api-query-cancel/curl-request.adoc 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/curl-request.adoc similarity index 100% rename from docs/modules/fts-rest-query/partials/paths/api-query-index/http-request.adoc rename to docs/modules/fts-rest-query/partials/paths/api-query-index/curl-request.adoc diff --git a/docs/modules/fts-rest-query/partials/paths/api-query/curl-request.adoc b/docs/modules/fts-rest-query/partials/paths/api-query/curl-request.adoc new file mode 100644 index 00000000..f889d601 --- /dev/null +++ b/docs/modules/fts-rest-query/partials/paths/api-query/curl-request.adoc @@ -0,0 +1,3 @@ +The <> request finds all active queries across the Search cluster. + +The <> request finds all queries across the cluster that have been running for longer than 7{nbsp}s. \ 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 deleted file mode 100644 index 1b369ca0..00000000 --- a/docs/modules/fts-rest-query/partials/paths/api-query/http-request.adoc +++ /dev/null @@ -1,3 +0,0 @@ -The <> request finds all active queries across the Search cluster. - -The <> request finds all queries across the cluster that have been running for longer than 7{nbsp}s. \ No newline at end of file diff --git a/docs/modules/index-rest-stats/partials/paths/get_index_stats/http-request.adoc b/docs/modules/index-rest-stats/partials/paths/get_index_stats/curl-request.adoc similarity index 100% rename from docs/modules/index-rest-stats/partials/paths/get_index_stats/http-request.adoc rename to docs/modules/index-rest-stats/partials/paths/get_index_stats/curl-request.adoc diff --git a/docs/modules/index-rest-stats/partials/paths/get_keyspace_stats/http-request.adoc b/docs/modules/index-rest-stats/partials/paths/get_keyspace_stats/curl-request.adoc similarity index 100% rename from docs/modules/index-rest-stats/partials/paths/get_keyspace_stats/http-request.adoc rename to docs/modules/index-rest-stats/partials/paths/get_keyspace_stats/curl-request.adoc diff --git a/docs/modules/index-rest-stats/partials/paths/get_node_stats/http-request.adoc b/docs/modules/index-rest-stats/partials/paths/get_node_stats/curl-request.adoc similarity index 100% rename from docs/modules/index-rest-stats/partials/paths/get_node_stats/http-request.adoc rename to docs/modules/index-rest-stats/partials/paths/get_node_stats/curl-request.adoc diff --git a/docs/modules/n1ql-rest-admin/partials/paths/delete_active_request/http-request.adoc b/docs/modules/n1ql-rest-admin/partials/paths/delete_active_request/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-admin/partials/paths/delete_active_request/http-request.adoc rename to docs/modules/n1ql-rest-admin/partials/paths/delete_active_request/curl-request.adoc diff --git a/docs/modules/n1ql-rest-admin/partials/paths/delete_completed_request/http-request.adoc b/docs/modules/n1ql-rest-admin/partials/paths/delete_completed_request/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-admin/partials/paths/delete_completed_request/http-request.adoc rename to docs/modules/n1ql-rest-admin/partials/paths/delete_completed_request/curl-request.adoc diff --git a/docs/modules/n1ql-rest-admin/partials/paths/delete_prepared/http-request.adoc b/docs/modules/n1ql-rest-admin/partials/paths/delete_prepared/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-admin/partials/paths/delete_prepared/http-request.adoc rename to docs/modules/n1ql-rest-admin/partials/paths/delete_prepared/curl-request.adoc diff --git a/docs/modules/n1ql-rest-admin/partials/paths/get_active_request/http-request.adoc b/docs/modules/n1ql-rest-admin/partials/paths/get_active_request/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-admin/partials/paths/get_active_request/http-request.adoc rename to docs/modules/n1ql-rest-admin/partials/paths/get_active_request/curl-request.adoc diff --git a/docs/modules/n1ql-rest-admin/partials/paths/get_active_requests/http-request.adoc b/docs/modules/n1ql-rest-admin/partials/paths/get_active_requests/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-admin/partials/paths/get_active_requests/http-request.adoc rename to docs/modules/n1ql-rest-admin/partials/paths/get_active_requests/curl-request.adoc diff --git a/docs/modules/n1ql-rest-admin/partials/paths/get_completed_request/http-request.adoc b/docs/modules/n1ql-rest-admin/partials/paths/get_completed_request/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-admin/partials/paths/get_completed_request/http-request.adoc rename to docs/modules/n1ql-rest-admin/partials/paths/get_completed_request/curl-request.adoc diff --git a/docs/modules/n1ql-rest-admin/partials/paths/get_completed_requests/http-request.adoc b/docs/modules/n1ql-rest-admin/partials/paths/get_completed_requests/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-admin/partials/paths/get_completed_requests/http-request.adoc rename to docs/modules/n1ql-rest-admin/partials/paths/get_completed_requests/curl-request.adoc diff --git a/docs/modules/n1ql-rest-admin/partials/paths/get_prepared/http-request.adoc b/docs/modules/n1ql-rest-admin/partials/paths/get_prepared/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-admin/partials/paths/get_prepared/http-request.adoc rename to docs/modules/n1ql-rest-admin/partials/paths/get_prepared/curl-request.adoc diff --git a/docs/modules/n1ql-rest-admin/partials/paths/get_prepareds/http-request.adoc b/docs/modules/n1ql-rest-admin/partials/paths/get_prepareds/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-admin/partials/paths/get_prepareds/http-request.adoc rename to docs/modules/n1ql-rest-admin/partials/paths/get_prepareds/curl-request.adoc diff --git a/docs/modules/n1ql-rest-admin/partials/paths/get_vitals/http-request.adoc b/docs/modules/n1ql-rest-admin/partials/paths/get_vitals/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-admin/partials/paths/get_vitals/http-request.adoc rename to docs/modules/n1ql-rest-admin/partials/paths/get_vitals/curl-request.adoc diff --git a/docs/modules/n1ql-rest-functions/partials/paths/delete_library/http-request.adoc b/docs/modules/n1ql-rest-functions/partials/paths/delete_library/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-functions/partials/paths/delete_library/http-request.adoc rename to docs/modules/n1ql-rest-functions/partials/paths/delete_library/curl-request.adoc diff --git a/docs/modules/n1ql-rest-functions/partials/paths/get_collection/http-request.adoc b/docs/modules/n1ql-rest-functions/partials/paths/get_collection/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-functions/partials/paths/get_collection/http-request.adoc rename to docs/modules/n1ql-rest-functions/partials/paths/get_collection/curl-request.adoc diff --git a/docs/modules/n1ql-rest-functions/partials/paths/get_library/http-request.adoc b/docs/modules/n1ql-rest-functions/partials/paths/get_library/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-functions/partials/paths/get_library/http-request.adoc rename to docs/modules/n1ql-rest-functions/partials/paths/get_library/curl-request.adoc diff --git a/docs/modules/n1ql-rest-functions/partials/paths/post_library/http-request.adoc b/docs/modules/n1ql-rest-functions/partials/paths/post_library/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-functions/partials/paths/post_library/http-request.adoc rename to docs/modules/n1ql-rest-functions/partials/paths/post_library/curl-request.adoc diff --git a/docs/modules/n1ql-rest-query/partials/paths/get_service/http-request.adoc b/docs/modules/n1ql-rest-query/partials/paths/get_service/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-query/partials/paths/get_service/http-request.adoc rename to docs/modules/n1ql-rest-query/partials/paths/get_service/curl-request.adoc diff --git a/docs/modules/n1ql-rest-query/partials/paths/post_service/http-request.adoc b/docs/modules/n1ql-rest-query/partials/paths/post_service/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-query/partials/paths/post_service/http-request.adoc rename to docs/modules/n1ql-rest-query/partials/paths/post_service/curl-request.adoc diff --git a/docs/modules/n1ql-rest-settings/partials/paths/get_access/http-request.adoc b/docs/modules/n1ql-rest-settings/partials/paths/get_access/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-settings/partials/paths/get_access/http-request.adoc rename to docs/modules/n1ql-rest-settings/partials/paths/get_access/curl-request.adoc diff --git a/docs/modules/n1ql-rest-settings/partials/paths/get_settings/http-request.adoc b/docs/modules/n1ql-rest-settings/partials/paths/get_settings/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-settings/partials/paths/get_settings/http-request.adoc rename to docs/modules/n1ql-rest-settings/partials/paths/get_settings/curl-request.adoc diff --git a/docs/modules/n1ql-rest-settings/partials/paths/post_access/http-request.adoc b/docs/modules/n1ql-rest-settings/partials/paths/post_access/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-settings/partials/paths/post_access/http-request.adoc rename to docs/modules/n1ql-rest-settings/partials/paths/post_access/curl-request.adoc diff --git a/docs/modules/n1ql-rest-settings/partials/paths/post_settings/http-request.adoc b/docs/modules/n1ql-rest-settings/partials/paths/post_settings/curl-request.adoc similarity index 100% rename from docs/modules/n1ql-rest-settings/partials/paths/post_settings/http-request.adoc rename to docs/modules/n1ql-rest-settings/partials/paths/post_settings/curl-request.adoc From 60c7686a88b4f064854854a3441e2ec89b2578dd Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Sat, 31 Jan 2026 00:44:20 +0000 Subject: [PATCH 17/30] Remove unnecessary Query response examples --- .../examples/get_debug_vars.html | 1 - .../n1ql-rest-admin/examples/get_gc.json | 4 --- .../n1ql-rest-admin/examples/post_gc.json | 5 ---- .../paths/get_debug_vars/http-response.adoc | 9 ------ .../partials/paths/get_gc/http-response.adoc | 9 ------ .../partials/paths/post_gc/http-response.adoc | 9 ------ .../examples/get_collection_all.json | 14 --------- .../examples/get_collection_scope.json | 8 ----- .../examples/get_library_global.json | 3 -- .../examples/get_library_scope.json | 3 -- .../paths/get_collection/http-response.adoc | 21 -------------- .../paths/get_library/http-response.adoc | 21 -------------- .../examples/query-settings-get-access.json | 5 ---- .../examples/query-settings-get-settings.json | 29 ------------------- .../examples/query-settings-post-access.json | 9 ------ .../query-settings-post-settings.json | 29 ------------------- .../paths/get_access/http-response.adoc | 9 ------ .../paths/get_settings/http-response.adoc | 9 ------ .../paths/post_access/http-response.adoc | 9 ------ .../paths/post_settings/http-response.adoc | 9 ------ 20 files changed, 215 deletions(-) delete mode 100644 docs/modules/n1ql-rest-admin/examples/get_debug_vars.html delete mode 100644 docs/modules/n1ql-rest-admin/examples/get_gc.json delete mode 100644 docs/modules/n1ql-rest-admin/examples/post_gc.json delete mode 100644 docs/modules/n1ql-rest-admin/partials/paths/get_debug_vars/http-response.adoc delete mode 100644 docs/modules/n1ql-rest-admin/partials/paths/get_gc/http-response.adoc delete mode 100644 docs/modules/n1ql-rest-admin/partials/paths/post_gc/http-response.adoc delete mode 100644 docs/modules/n1ql-rest-functions/examples/get_collection_all.json delete mode 100644 docs/modules/n1ql-rest-functions/examples/get_collection_scope.json delete mode 100644 docs/modules/n1ql-rest-functions/examples/get_library_global.json delete mode 100644 docs/modules/n1ql-rest-functions/examples/get_library_scope.json delete mode 100644 docs/modules/n1ql-rest-functions/partials/paths/get_collection/http-response.adoc delete mode 100644 docs/modules/n1ql-rest-functions/partials/paths/get_library/http-response.adoc delete mode 100644 docs/modules/n1ql-rest-settings/examples/query-settings-get-access.json delete mode 100644 docs/modules/n1ql-rest-settings/examples/query-settings-get-settings.json delete mode 100644 docs/modules/n1ql-rest-settings/examples/query-settings-post-access.json delete mode 100644 docs/modules/n1ql-rest-settings/examples/query-settings-post-settings.json delete mode 100644 docs/modules/n1ql-rest-settings/partials/paths/get_access/http-response.adoc delete mode 100644 docs/modules/n1ql-rest-settings/partials/paths/get_settings/http-response.adoc delete mode 100644 docs/modules/n1ql-rest-settings/partials/paths/post_access/http-response.adoc delete mode 100644 docs/modules/n1ql-rest-settings/partials/paths/post_settings/http-response.adoc diff --git a/docs/modules/n1ql-rest-admin/examples/get_debug_vars.html b/docs/modules/n1ql-rest-admin/examples/get_debug_vars.html deleted file mode 100644 index a0f72b8b..00000000 --- a/docs/modules/n1ql-rest-admin/examples/get_debug_vars.html +++ /dev/null @@ -1 +0,0 @@ -Found. \ No newline at end of file diff --git a/docs/modules/n1ql-rest-admin/examples/get_gc.json b/docs/modules/n1ql-rest-admin/examples/get_gc.json deleted file mode 100644 index 26fe942c..00000000 --- a/docs/modules/n1ql-rest-admin/examples/get_gc.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "freed": 123456, - "status": "GC invoked" -} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-admin/examples/post_gc.json b/docs/modules/n1ql-rest-admin/examples/post_gc.json deleted file mode 100644 index a8d427e0..00000000 --- a/docs/modules/n1ql-rest-admin/examples/post_gc.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "freed": 109304, - "released": 835584, - "status": "GC invoked and memory released" -} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-admin/partials/paths/get_debug_vars/http-response.adoc b/docs/modules/n1ql-rest-admin/partials/paths/get_debug_vars/http-response.adoc deleted file mode 100644 index e9eacbf5..00000000 --- a/docs/modules/n1ql-rest-admin/partials/paths/get_debug_vars/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= Example HTTP Response - -==== -.Response 302 -[source,html] ----- -include::example$get_debug_vars.html[] ----- -==== \ No newline at end of file diff --git a/docs/modules/n1ql-rest-admin/partials/paths/get_gc/http-response.adoc b/docs/modules/n1ql-rest-admin/partials/paths/get_gc/http-response.adoc deleted file mode 100644 index 1a05d3c4..00000000 --- a/docs/modules/n1ql-rest-admin/partials/paths/get_gc/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= Example HTTP Response - -==== -.Response 200 -[source,json] ----- -include::example$get_gc.json[] ----- -==== \ No newline at end of file diff --git a/docs/modules/n1ql-rest-admin/partials/paths/post_gc/http-response.adoc b/docs/modules/n1ql-rest-admin/partials/paths/post_gc/http-response.adoc deleted file mode 100644 index 3ee77daf..00000000 --- a/docs/modules/n1ql-rest-admin/partials/paths/post_gc/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= Example HTTP Response - -==== -.Response 200 -[source,json] ----- -include::example$post_gc.json[] ----- -==== \ No newline at end of file diff --git a/docs/modules/n1ql-rest-functions/examples/get_collection_all.json b/docs/modules/n1ql-rest-functions/examples/get_collection_all.json deleted file mode 100644 index 4a7b2aed..00000000 --- a/docs/modules/n1ql-rest-functions/examples/get_collection_all.json +++ /dev/null @@ -1,14 +0,0 @@ -[ - { - "name": "math", - "bucket": "", - "scope": "", - "code": "function add(a, b) { return a + b; } function mul(a, b) { return a * b; }" - }, - { - "name": "science", - "bucket": "travel-sample", - "scope": "inventory", - "code": "function f2c(f) { return (5/9)*(f-32); }" - } -] \ No newline at end of file diff --git a/docs/modules/n1ql-rest-functions/examples/get_collection_scope.json b/docs/modules/n1ql-rest-functions/examples/get_collection_scope.json deleted file mode 100644 index e7dc460f..00000000 --- a/docs/modules/n1ql-rest-functions/examples/get_collection_scope.json +++ /dev/null @@ -1,8 +0,0 @@ -[ - { - "name": "science", - "bucket": "travel-sample", - "scope": "inventory", - "code": "function f2c(f) { return (5/9)*(f-32); }" - } -] \ No newline at end of file diff --git a/docs/modules/n1ql-rest-functions/examples/get_library_global.json b/docs/modules/n1ql-rest-functions/examples/get_library_global.json deleted file mode 100644 index faa86b3c..00000000 --- a/docs/modules/n1ql-rest-functions/examples/get_library_global.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "math": "function add(a, b) { return a + b; } function mul(a, b) { return a * b; }" -} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-functions/examples/get_library_scope.json b/docs/modules/n1ql-rest-functions/examples/get_library_scope.json deleted file mode 100644 index 480b3486..00000000 --- a/docs/modules/n1ql-rest-functions/examples/get_library_scope.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "science": "function f2c(f) { return (5/9)*(f-32); }" -} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-functions/partials/paths/get_collection/http-response.adoc b/docs/modules/n1ql-rest-functions/partials/paths/get_collection/http-response.adoc deleted file mode 100644 index fb621d08..00000000 --- a/docs/modules/n1ql-rest-functions/partials/paths/get_collection/http-response.adoc +++ /dev/null @@ -1,21 +0,0 @@ -= Example HTTP Response - -==== -Result of <>. - -.Response 200 -[source,json] ----- -include::example$get_collection_all.json[] ----- -==== - -==== -Result of <>. - -.Response 200 -[source,json] ----- -include::example$get_collection_scope.json[] ----- -==== \ No newline at end of file diff --git a/docs/modules/n1ql-rest-functions/partials/paths/get_library/http-response.adoc b/docs/modules/n1ql-rest-functions/partials/paths/get_library/http-response.adoc deleted file mode 100644 index 3e61bd7f..00000000 --- a/docs/modules/n1ql-rest-functions/partials/paths/get_library/http-response.adoc +++ /dev/null @@ -1,21 +0,0 @@ -= Example HTTP Response - -==== -Result of <>. - -.Response 200 -[source,json] ----- -include::example$get_library_global.json[] ----- -==== - -==== -Result of <>. - -.Response 200 -[source,json] ----- -include::example$get_library_scope.json[] ----- -==== \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/examples/query-settings-get-access.json b/docs/modules/n1ql-rest-settings/examples/query-settings-get-access.json deleted file mode 100644 index 34c4dd0d..00000000 --- a/docs/modules/n1ql-rest-settings/examples/query-settings-get-access.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "all_access": false, - "allowed_urls": [], - "disallowed_urls": [] -} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/examples/query-settings-get-settings.json b/docs/modules/n1ql-rest-settings/examples/query-settings-get-settings.json deleted file mode 100644 index 46bd32e1..00000000 --- a/docs/modules/n1ql-rest-settings/examples/query-settings-get-settings.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "queryTmpSpaceDir": "/opt/couchbase/var/lib/couchbase/tmp", - "queryTmpSpaceSize": 5120, - "queryPipelineBatch": 16, - "queryPipelineCap": 512, - "queryScanCap": 512, - "queryTimeout": 0, - "queryPreparedLimit": 16384, - "queryCompletedLimit": 4000, - "queryCompletedThreshold": 1000, - "queryLogLevel": "info", - "queryMaxParallelism": 1, - "queryTxTimeout": "0ms", - "queryMemoryQuota": 0, - "queryUseCBO": true, - "queryCleanupClientAttempts": true, - "queryCleanupLostAttempts": true, - "queryCleanupWindow": "60s", - "queryNumAtrs": 1024, - "queryNodeQuota": 0, - "queryUseReplica": "unset", - "queryNodeQuotaValPercent": 67, - "queryNumCpus": 0, - "queryCompletedMaxPlanSize": 262144, - "queryN1QLFeatCtrl": 76, - "queryCurlWhitelist": { - "all_access": false - } -} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/examples/query-settings-post-access.json b/docs/modules/n1ql-rest-settings/examples/query-settings-post-access.json deleted file mode 100644 index 6e2229ec..00000000 --- a/docs/modules/n1ql-rest-settings/examples/query-settings-post-access.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "all_access": false, - "allowed_urls": [ - "https://company1.com" - ], - "disallowed_urls": [ - "https://company2.com" - ] -} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/examples/query-settings-post-settings.json b/docs/modules/n1ql-rest-settings/examples/query-settings-post-settings.json deleted file mode 100644 index 6d20cff9..00000000 --- a/docs/modules/n1ql-rest-settings/examples/query-settings-post-settings.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "queryTmpSpaceDir": "/tmp", - "queryTmpSpaceSize": 2048, - "queryPipelineBatch": 16, - "queryPipelineCap": 512, - "queryScanCap": 512, - "queryTimeout": 0, - "queryPreparedLimit": 16384, - "queryCompletedLimit": 4000, - "queryCompletedThreshold": 1000, - "queryLogLevel": "info", - "queryMaxParallelism": 1, - "queryTxTimeout": "0ms", - "queryMemoryQuota": 0, - "queryUseCBO": true, - "queryCleanupClientAttempts": true, - "queryCleanupLostAttempts": true, - "queryCleanupWindow": "60s", - "queryNumAtrs": 1024, - "queryNodeQuota": 0, - "queryUseReplica": "unset", - "queryNodeQuotaValPercent": 67, - "queryNumCpus": 0, - "queryCompletedMaxPlanSize": 262144, - "queryN1QLFeatCtrl": 76, - "queryCurlWhitelist": { - "all_access": false - } -} \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/partials/paths/get_access/http-response.adoc b/docs/modules/n1ql-rest-settings/partials/paths/get_access/http-response.adoc deleted file mode 100644 index 1192e767..00000000 --- a/docs/modules/n1ql-rest-settings/partials/paths/get_access/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= Example HTTP Response - -==== -.Response 200 -[source,json] ----- -include::example$query-settings-get-access.json[] ----- -==== \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/partials/paths/get_settings/http-response.adoc b/docs/modules/n1ql-rest-settings/partials/paths/get_settings/http-response.adoc deleted file mode 100644 index b9d7c4ac..00000000 --- a/docs/modules/n1ql-rest-settings/partials/paths/get_settings/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= Example HTTP Response - -==== -.Response 200 -[source,json] ----- -include::example$query-settings-get-settings.json[] ----- -==== \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/partials/paths/post_access/http-response.adoc b/docs/modules/n1ql-rest-settings/partials/paths/post_access/http-response.adoc deleted file mode 100644 index 1baebaba..00000000 --- a/docs/modules/n1ql-rest-settings/partials/paths/post_access/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= Example HTTP Response - -==== -.Response 200 -[source,json] ----- -include::example$query-settings-post-access.json[] ----- -==== \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/partials/paths/post_settings/http-response.adoc b/docs/modules/n1ql-rest-settings/partials/paths/post_settings/http-response.adoc deleted file mode 100644 index 14b0fe85..00000000 --- a/docs/modules/n1ql-rest-settings/partials/paths/post_settings/http-response.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= Example HTTP Response - -==== -.Response 200 -[source,json] ----- -include::example$query-settings-post-settings.json[] ----- -==== \ No newline at end of file From 37def762e3aef33de1d676422a8bbc29e2d70dc5 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Sat, 31 Jan 2026 00:55:08 +0000 Subject: [PATCH 18/30] Build output documentation --- .../analytics-rest-admin/pages/index.adoc | 32 +++ .../analytics-rest-config/pages/index.adoc | 16 ++ .../analytics-rest-library/pages/index.adoc | 12 + .../analytics-rest-links/pages/index.adoc | 36 +++ .../analytics-rest-service/pages/index.adoc | 16 ++ .../analytics-rest-settings/pages/index.adoc | 8 + .../eventing-rest-api/pages/index.adoc | 120 ++++++++++ .../fts-rest-advanced/pages/index.adoc | 21 ++ .../fts-rest-indexing/pages/index.adoc | 217 ++++++++++++++++++ docs/modules/fts-rest-manage/pages/index.adoc | 12 +- docs/modules/fts-rest-nodes/pages/index.adoc | 55 +++++ docs/modules/fts-rest-query/pages/index.adoc | 38 ++- docs/modules/fts-rest-stats/pages/index.adoc | 11 + .../modules/index-rest-stats/pages/index.adoc | 12 + docs/modules/n1ql-rest-admin/pages/index.adoc | 107 +++++++++ .../n1ql-rest-functions/pages/index.adoc | 22 ++ docs/modules/n1ql-rest-query/pages/index.adoc | 20 ++ .../n1ql-rest-settings/pages/index.adoc | 86 +++++++ 18 files changed, 833 insertions(+), 8 deletions(-) diff --git a/docs/modules/analytics-rest-admin/pages/index.adoc b/docs/modules/analytics-rest-admin/pages/index.adoc index 65c3a898..33c75e68 100644 --- a/docs/modules/analytics-rest-admin/pages/index.adoc +++ b/docs/modules/analytics-rest-admin/pages/index.adoc @@ -298,6 +298,10 @@ include::{specDir}paths/cancel_request/operation-security-after.adoc[opts=option +include::{snippetDir}cancel_request/curl-request.adoc[opts=optional] + + + include::{snippetDir}cancel_request/http-request.adoc[opts=optional] // FIXME: Response examples @@ -439,6 +443,10 @@ include::{specDir}paths/cluster_status/operation-security-after.adoc[opts=option +include::{snippetDir}cluster_status/curl-request.adoc[opts=optional] + + + include::{snippetDir}cluster_status/http-request.adoc[opts=optional] // FIXME: Response examples @@ -580,6 +588,10 @@ include::{specDir}paths/completed_requests/operation-security-after.adoc[opts=op +include::{snippetDir}completed_requests/curl-request.adoc[opts=optional] + + + include::{snippetDir}completed_requests/http-request.adoc[opts=optional] // FIXME: Response examples @@ -721,6 +733,10 @@ include::{specDir}paths/ingestion_status/operation-security-after.adoc[opts=opti +include::{snippetDir}ingestion_status/curl-request.adoc[opts=optional] + + + include::{snippetDir}ingestion_status/http-request.adoc[opts=optional] // FIXME: Response examples @@ -867,6 +883,10 @@ include::{specDir}paths/monitor_node/operation-security-after.adoc[opts=optional +include::{snippetDir}monitor_node/curl-request.adoc[opts=optional] + + + include::{snippetDir}monitor_node/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1007,6 +1027,10 @@ include::{specDir}paths/restart_cluster/operation-security-after.adoc[opts=optio +include::{snippetDir}restart_cluster/curl-request.adoc[opts=optional] + + + include::{snippetDir}restart_cluster/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1147,6 +1171,10 @@ include::{specDir}paths/restart_node/operation-security-after.adoc[opts=optional +include::{snippetDir}restart_node/curl-request.adoc[opts=optional] + + + include::{snippetDir}restart_node/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1288,6 +1316,10 @@ include::{specDir}paths/return_active_requests/operation-security-after.adoc[opt +include::{snippetDir}return_active_requests/curl-request.adoc[opts=optional] + + + include::{snippetDir}return_active_requests/http-request.adoc[opts=optional] // FIXME: Response examples diff --git a/docs/modules/analytics-rest-config/pages/index.adoc b/docs/modules/analytics-rest-config/pages/index.adoc index bfc4cedd..6b5a44e9 100644 --- a/docs/modules/analytics-rest-config/pages/index.adoc +++ b/docs/modules/analytics-rest-config/pages/index.adoc @@ -245,6 +245,10 @@ include::{specDir}paths/get_node/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_node/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_node/http-request.adoc[opts=optional] // FIXME: Response examples @@ -379,6 +383,10 @@ include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_service/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_service/http-request.adoc[opts=optional] // FIXME: Response examples @@ -565,6 +573,10 @@ include::{specDir}paths/put_node/operation-security-after.adoc[opts=optional] +include::{snippetDir}put_node/curl-request.adoc[opts=optional] + + + include::{snippetDir}put_node/http-request.adoc[opts=optional] // FIXME: Response examples @@ -749,6 +761,10 @@ include::{specDir}paths/put_service/operation-security-after.adoc[opts=optional] +include::{snippetDir}put_service/curl-request.adoc[opts=optional] + + + include::{snippetDir}put_service/http-request.adoc[opts=optional] // FIXME: Response examples diff --git a/docs/modules/analytics-rest-library/pages/index.adoc b/docs/modules/analytics-rest-library/pages/index.adoc index 7fc31824..5b41e366 100644 --- a/docs/modules/analytics-rest-library/pages/index.adoc +++ b/docs/modules/analytics-rest-library/pages/index.adoc @@ -298,6 +298,10 @@ include::{specDir}paths/delete_library/operation-security-after.adoc[opts=option +include::{snippetDir}delete_library/curl-request.adoc[opts=optional] + + + include::{snippetDir}delete_library/http-request.adoc[opts=optional] // FIXME: Response examples @@ -440,6 +444,10 @@ include::{specDir}paths/get_collection/operation-security-after.adoc[opts=option +include::{snippetDir}get_collection/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_collection/http-request.adoc[opts=optional] // FIXME: Response examples @@ -666,6 +674,10 @@ include::{specDir}paths/post_library/operation-security-after.adoc[opts=optional +include::{snippetDir}post_library/curl-request.adoc[opts=optional] + + + include::{snippetDir}post_library/http-request.adoc[opts=optional] // FIXME: Response examples diff --git a/docs/modules/analytics-rest-links/pages/index.adoc b/docs/modules/analytics-rest-links/pages/index.adoc index ea061ea0..878cfe5e 100644 --- a/docs/modules/analytics-rest-links/pages/index.adoc +++ b/docs/modules/analytics-rest-links/pages/index.adoc @@ -303,6 +303,10 @@ include::{specDir}paths/delete_alt/operation-security-after.adoc[opts=optional] +include::{snippetDir}delete_alt/curl-request.adoc[opts=optional] + + + include::{snippetDir}delete_alt/http-request.adoc[opts=optional] // FIXME: Response examples @@ -762,6 +766,10 @@ include::{specDir}paths/post_alt/operation-security-after.adoc[opts=optional] +include::{snippetDir}post_alt/curl-request.adoc[opts=optional] + + + include::{snippetDir}post_alt/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1222,6 +1230,10 @@ include::{specDir}paths/put_alt/operation-security-after.adoc[opts=optional] +include::{snippetDir}put_alt/curl-request.adoc[opts=optional] + + + include::{snippetDir}put_alt/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1451,6 +1463,10 @@ include::{specDir}paths/get_all/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_all/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_all/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1653,6 +1669,10 @@ include::{specDir}paths/get_scope/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_scope/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_scope/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1866,6 +1886,10 @@ include::{specDir}paths/delete_link/operation-security-after.adoc[opts=optional] +include::{snippetDir}delete_link/curl-request.adoc[opts=optional] + + + include::{snippetDir}delete_link/http-request.adoc[opts=optional] // FIXME: Response examples @@ -2079,6 +2103,10 @@ include::{specDir}paths/get_link/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_link/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_link/http-request.adoc[opts=optional] // FIXME: Response examples @@ -2549,6 +2577,10 @@ include::{specDir}paths/post_link/operation-security-after.adoc[opts=optional] +include::{snippetDir}post_link/curl-request.adoc[opts=optional] + + + include::{snippetDir}post_link/http-request.adoc[opts=optional] // FIXME: Response examples @@ -3020,6 +3052,10 @@ include::{specDir}paths/put_link/operation-security-after.adoc[opts=optional] +include::{snippetDir}put_link/curl-request.adoc[opts=optional] + + + include::{snippetDir}put_link/http-request.adoc[opts=optional] // FIXME: Response examples diff --git a/docs/modules/analytics-rest-service/pages/index.adoc b/docs/modules/analytics-rest-service/pages/index.adoc index 3a884e9a..7e8172b3 100644 --- a/docs/modules/analytics-rest-service/pages/index.adoc +++ b/docs/modules/analytics-rest-service/pages/index.adoc @@ -288,6 +288,10 @@ include::{specDir}paths/get_query/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_query/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_query/http-request.adoc[opts=optional] // FIXME: Response examples @@ -468,6 +472,10 @@ include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_service/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_service/http-request.adoc[opts=optional] // FIXME: Response examples @@ -631,6 +639,10 @@ include::{specDir}paths/post_query/operation-security-after.adoc[opts=optional] +include::{snippetDir}post_query/curl-request.adoc[opts=optional] + + + include::{snippetDir}post_query/http-request.adoc[opts=optional] // FIXME: Response examples @@ -813,6 +825,10 @@ include::{specDir}paths/post_service/operation-security-after.adoc[opts=optional +include::{snippetDir}post_service/curl-request.adoc[opts=optional] + + + include::{snippetDir}post_service/http-request.adoc[opts=optional] // FIXME: Response examples diff --git a/docs/modules/analytics-rest-settings/pages/index.adoc b/docs/modules/analytics-rest-settings/pages/index.adoc index 11e10611..6b6d237f 100644 --- a/docs/modules/analytics-rest-settings/pages/index.adoc +++ b/docs/modules/analytics-rest-settings/pages/index.adoc @@ -244,6 +244,10 @@ include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional +include::{snippetDir}get_settings/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_settings/http-request.adoc[opts=optional] // FIXME: Response examples @@ -425,6 +429,10 @@ include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optiona +include::{snippetDir}post_settings/curl-request.adoc[opts=optional] + + + include::{snippetDir}post_settings/http-request.adoc[opts=optional] // FIXME: Response examples diff --git a/docs/modules/eventing-rest-api/pages/index.adoc b/docs/modules/eventing-rest-api/pages/index.adoc index 3bed83bc..f1f03d07 100644 --- a/docs/modules/eventing-rest-api/pages/index.adoc +++ b/docs/modules/eventing-rest-api/pages/index.adoc @@ -311,6 +311,10 @@ include::{specDir}paths/basic_deploy/operation-security-after.adoc[opts=optional +include::{snippetDir}basic_deploy/curl-request.adoc[opts=optional] + + + include::{snippetDir}basic_deploy/http-request.adoc[opts=optional] // FIXME: Response examples @@ -507,6 +511,10 @@ include::{specDir}paths/basic_pause/operation-security-after.adoc[opts=optional] +include::{snippetDir}basic_pause/curl-request.adoc[opts=optional] + + + include::{snippetDir}basic_pause/http-request.adoc[opts=optional] // FIXME: Response examples @@ -710,6 +718,10 @@ include::{specDir}paths/basic_resume/operation-security-after.adoc[opts=optional +include::{snippetDir}basic_resume/curl-request.adoc[opts=optional] + + + include::{snippetDir}basic_resume/http-request.adoc[opts=optional] // FIXME: Response examples @@ -906,6 +918,10 @@ include::{specDir}paths/basic_undeploy/operation-security-after.adoc[opts=option +include::{snippetDir}basic_undeploy/curl-request.adoc[opts=optional] + + + include::{snippetDir}basic_undeploy/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1166,6 +1182,10 @@ include::{specDir}paths/adv_function_import/operation-security-after.adoc[opts=o +include::{snippetDir}adv_function_import/curl-request.adoc[opts=optional] + + + include::{snippetDir}adv_function_import/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1335,6 +1355,10 @@ include::{specDir}paths/adv_function_import_all/operation-security-after.adoc[op +include::{snippetDir}adv_function_import_all/curl-request.adoc[opts=optional] + + + include::{snippetDir}adv_function_import_all/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1544,6 +1568,10 @@ include::{specDir}paths/adv_function_view/operation-security-after.adoc[opts=opt +include::{snippetDir}adv_function_view/curl-request.adoc[opts=optional] + + + include::{snippetDir}adv_function_view/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1683,6 +1711,10 @@ include::{specDir}paths/adv_function_view_all/operation-security-after.adoc[opts +include::{snippetDir}adv_function_view_all/curl-request.adoc[opts=optional] + + + include::{snippetDir}adv_function_view_all/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1887,6 +1919,10 @@ include::{specDir}paths/adv_function_zap/operation-security-after.adoc[opts=opti +include::{snippetDir}adv_function_zap/curl-request.adoc[opts=optional] + + + include::{snippetDir}adv_function_zap/http-request.adoc[opts=optional] // FIXME: Response examples @@ -2020,6 +2056,10 @@ include::{specDir}paths/adv_function_zap_all/operation-security-after.adoc[opts= +include::{snippetDir}adv_function_zap_all/curl-request.adoc[opts=optional] + + + include::{snippetDir}adv_function_zap_all/http-request.adoc[opts=optional] // FIXME: Response examples @@ -2159,6 +2199,10 @@ include::{specDir}paths/adv_multiple_export/operation-security-after.adoc[opts=o +include::{snippetDir}adv_multiple_export/curl-request.adoc[opts=optional] + + + include::{snippetDir}adv_multiple_export/http-request.adoc[opts=optional] // FIXME: Response examples @@ -2328,6 +2372,10 @@ include::{specDir}paths/adv_multiple_import/operation-security-after.adoc[opts=o +include::{snippetDir}adv_multiple_import/curl-request.adoc[opts=optional] + + + include::{snippetDir}adv_multiple_import/http-request.adoc[opts=optional] // FIXME: Response examples @@ -2536,6 +2584,10 @@ include::{specDir}paths/adv_settings_get/operation-security-after.adoc[opts=opti +include::{snippetDir}adv_settings_get/curl-request.adoc[opts=optional] + + + include::{snippetDir}adv_settings_get/http-request.adoc[opts=optional] // FIXME: Response examples @@ -2771,6 +2823,10 @@ include::{specDir}paths/adv_settings_update/operation-security-after.adoc[opts=o +include::{snippetDir}adv_settings_update/curl-request.adoc[opts=optional] + + + include::{snippetDir}adv_settings_update/http-request.adoc[opts=optional] // FIXME: Response examples @@ -2979,6 +3035,10 @@ include::{specDir}paths/adv_structure_get/operation-security-after.adoc[opts=opt +include::{snippetDir}adv_structure_get/curl-request.adoc[opts=optional] + + + include::{snippetDir}adv_structure_get/http-request.adoc[opts=optional] // FIXME: Response examples @@ -3207,6 +3267,10 @@ include::{specDir}paths/adv_structure_update/operation-security-after.adoc[opts= +include::{snippetDir}adv_structure_update/curl-request.adoc[opts=optional] + + + include::{snippetDir}adv_structure_update/http-request.adoc[opts=optional] // FIXME: Response examples @@ -3415,6 +3479,10 @@ include::{specDir}paths/adv_text_get/operation-security-after.adoc[opts=optional +include::{snippetDir}adv_text_get/curl-request.adoc[opts=optional] + + + include::{snippetDir}adv_text_get/http-request.adoc[opts=optional] // FIXME: Response examples @@ -3643,6 +3711,10 @@ include::{specDir}paths/adv_text_update/operation-security-after.adoc[opts=optio +include::{snippetDir}adv_text_update/curl-request.adoc[opts=optional] + + + include::{snippetDir}adv_text_update/http-request.adoc[opts=optional] // FIXME: Response examples @@ -3799,6 +3871,10 @@ include::{specDir}paths/config_get/operation-security-after.adoc[opts=optional] +include::{snippetDir}config_get/curl-request.adoc[opts=optional] + + + include::{snippetDir}config_get/http-request.adoc[opts=optional] // FIXME: Response examples @@ -3969,6 +4045,10 @@ include::{specDir}paths/config_update/operation-security-after.adoc[opts=optiona +include::{snippetDir}config_update/curl-request.adoc[opts=optional] + + + include::{snippetDir}config_update/http-request.adoc[opts=optional] // FIXME: Response examples @@ -4123,6 +4203,10 @@ include::{specDir}paths/list_all/operation-security-after.adoc[opts=optional] +include::{snippetDir}list_all/curl-request.adoc[opts=optional] + + + include::{snippetDir}list_all/http-request.adoc[opts=optional] // FIXME: Response examples @@ -4321,6 +4405,10 @@ include::{specDir}paths/list_query/operation-security-after.adoc[opts=optional] +include::{snippetDir}list_query/curl-request.adoc[opts=optional] + + + include::{snippetDir}list_query/http-request.adoc[opts=optional] // FIXME: Response examples @@ -4559,6 +4647,10 @@ include::{specDir}paths/log_view/operation-security-after.adoc[opts=optional] +include::{snippetDir}log_view/curl-request.adoc[opts=optional] + + + include::{snippetDir}log_view/http-request.adoc[opts=optional] // FIXME: Response examples @@ -4752,6 +4844,10 @@ include::{specDir}paths/stats_all/operation-security-after.adoc[opts=optional] +include::{snippetDir}stats_all/curl-request.adoc[opts=optional] + + + include::{snippetDir}stats_all/http-request.adoc[opts=optional] // FIXME: Response examples @@ -4945,6 +5041,10 @@ include::{specDir}paths/stats_execution/operation-security-after.adoc[opts=optio +include::{snippetDir}stats_execution/curl-request.adoc[opts=optional] + + + include::{snippetDir}stats_execution/http-request.adoc[opts=optional] // FIXME: Response examples @@ -5138,6 +5238,10 @@ include::{specDir}paths/stats_failure/operation-security-after.adoc[opts=optiona +include::{snippetDir}stats_failure/curl-request.adoc[opts=optional] + + + include::{snippetDir}stats_failure/http-request.adoc[opts=optional] // FIXME: Response examples @@ -5331,6 +5435,10 @@ include::{specDir}paths/stats_latency/operation-security-after.adoc[opts=optiona +include::{snippetDir}stats_latency/curl-request.adoc[opts=optional] + + + include::{snippetDir}stats_latency/http-request.adoc[opts=optional] // FIXME: Response examples @@ -5523,6 +5631,10 @@ include::{specDir}paths/stats_reset/operation-security-after.adoc[opts=optional] +include::{snippetDir}stats_reset/curl-request.adoc[opts=optional] + + + include::{snippetDir}stats_reset/http-request.adoc[opts=optional] // FIXME: Response examples @@ -5678,6 +5790,10 @@ include::{specDir}paths/status_all/operation-security-after.adoc[opts=optional] +include::{snippetDir}status_all/curl-request.adoc[opts=optional] + + + include::{snippetDir}status_all/http-request.adoc[opts=optional] // FIXME: Response examples @@ -5882,6 +5998,10 @@ include::{specDir}paths/status_function/operation-security-after.adoc[opts=optio +include::{snippetDir}status_function/curl-request.adoc[opts=optional] + + + include::{snippetDir}status_function/http-request.adoc[opts=optional] // FIXME: Response examples diff --git a/docs/modules/fts-rest-advanced/pages/index.adoc b/docs/modules/fts-rest-advanced/pages/index.adoc index c1b62838..e7dca7fe 100644 --- a/docs/modules/fts-rest-advanced/pages/index.adoc +++ b/docs/modules/fts-rest-advanced/pages/index.adoc @@ -237,9 +237,14 @@ include::{specDir}paths/getPartition/operation-security-after.adoc[opts=optional +include::{snippetDir}getPartition/curl-request.adoc[opts=optional] + + + include::{snippetDir}getPartition/http-request.adoc[opts=optional] // FIXME: Response examples +[#getPartition-ex-response-200] .Response 200 ==== [source,json] @@ -417,6 +422,10 @@ include::{specDir}paths/getPartitionName/operation-security-after.adoc[opts=opti +include::{snippetDir}getPartitionName/curl-request.adoc[opts=optional] + + + include::{snippetDir}getPartitionName/http-request.adoc[opts=optional] // FIXME: Response examples @@ -598,6 +607,10 @@ include::{specDir}paths/getPartitionCount/operation-security-after.adoc[opts=opt +include::{snippetDir}getPartitionCount/curl-request.adoc[opts=optional] + + + include::{snippetDir}getPartitionCount/http-request.adoc[opts=optional] // FIXME: Response examples @@ -783,6 +796,10 @@ include::{specDir}paths/queryPartition/operation-security-after.adoc[opts=option +include::{snippetDir}queryPartition/curl-request.adoc[opts=optional] + + + include::{snippetDir}queryPartition/http-request.adoc[opts=optional] // FIXME: Response examples @@ -963,6 +980,10 @@ include::{specDir}paths/setFtsMemoryQuota/operation-security-after.adoc[opts=opt +include::{snippetDir}setFtsMemoryQuota/curl-request.adoc[opts=optional] + + + include::{snippetDir}setFtsMemoryQuota/http-request.adoc[opts=optional] // FIXME: Response examples diff --git a/docs/modules/fts-rest-indexing/pages/index.adoc b/docs/modules/fts-rest-indexing/pages/index.adoc index 88c0907a..25da503c 100644 --- a/docs/modules/fts-rest-indexing/pages/index.adoc +++ b/docs/modules/fts-rest-indexing/pages/index.adoc @@ -290,9 +290,14 @@ include::{specDir}paths/d-api-index-name/operation-security-after.adoc[opts=opti +include::{snippetDir}d-api-index-name/curl-request.adoc[opts=optional] + + + include::{snippetDir}d-api-index-name/http-request.adoc[opts=optional] // FIXME: Response examples +[#d-api-index-name-ex-response-200] .Response 200 ==== [source,json] @@ -303,6 +308,7 @@ include::{snippetDir}d-api-index-name/http-request.adoc[opts=optional] } ---- ==== +[#d-api-index-name-ex-response-0] .Response 0 ==== [source,json] @@ -502,9 +508,14 @@ include::{specDir}paths/d-api-scoped-index-name/operation-security-after.adoc[op +include::{snippetDir}d-api-scoped-index-name/curl-request.adoc[opts=optional] + + + include::{snippetDir}d-api-scoped-index-name/http-request.adoc[opts=optional] // FIXME: Response examples +[#d-api-scoped-index-name-ex-response-200] .Response 200 ==== [source,json] @@ -515,6 +526,7 @@ include::{snippetDir}d-api-scoped-index-name/http-request.adoc[opts=optional] } ---- ==== +[#d-api-scoped-index-name-ex-response-0] .Response 0 ==== [source,json] @@ -650,9 +662,14 @@ include::{specDir}paths/g-api-index/operation-security-after.adoc[opts=optional] +include::{snippetDir}g-api-index/curl-request.adoc[opts=optional] + + + include::{snippetDir}g-api-index/http-request.adoc[opts=optional] // FIXME: Response examples +[#g-api-index-ex-response-200] .Response 200 ==== [source,json] @@ -848,9 +865,14 @@ include::{specDir}paths/g-api-index-name/operation-security-after.adoc[opts=opti +include::{snippetDir}g-api-index-name/curl-request.adoc[opts=optional] + + + include::{snippetDir}g-api-index-name/http-request.adoc[opts=optional] // FIXME: Response examples +[#g-api-index-name-ex-response-200] .Response 200 ==== [source,json] @@ -1066,9 +1088,14 @@ include::{specDir}paths/g-api-scoped-index/operation-security-after.adoc[opts=op +include::{snippetDir}g-api-scoped-index/curl-request.adoc[opts=optional] + + + include::{snippetDir}g-api-scoped-index/http-request.adoc[opts=optional] // FIXME: Response examples +[#g-api-scoped-index-ex-response-200] .Response 200 ==== [source,json] @@ -1372,9 +1399,14 @@ include::{specDir}paths/g-api-scoped-index-name/operation-security-after.adoc[op +include::{snippetDir}g-api-scoped-index-name/curl-request.adoc[opts=optional] + + + include::{snippetDir}g-api-scoped-index-name/http-request.adoc[opts=optional] // FIXME: Response examples +[#g-api-scoped-index-name-ex-response-200] .Response 200 ==== [source,json] @@ -1734,9 +1766,14 @@ include::{specDir}paths/p-api-index-name/operation-security-after.adoc[opts=opti +include::{snippetDir}p-api-index-name/curl-request.adoc[opts=optional] + + + include::{snippetDir}p-api-index-name/http-request.adoc[opts=optional] // FIXME: Response examples +[#p-api-index-name-ex-response-200] .Response 200 ==== [source,json] @@ -1748,6 +1785,7 @@ include::{snippetDir}p-api-index-name/http-request.adoc[opts=optional] } ---- ==== +[#p-api-index-name-ex-response-0] .Response 0 ==== [source,json] @@ -1973,9 +2011,14 @@ include::{specDir}paths/p-api-scoped-index-name/operation-security-after.adoc[op +include::{snippetDir}p-api-scoped-index-name/curl-request.adoc[opts=optional] + + + include::{snippetDir}p-api-scoped-index-name/http-request.adoc[opts=optional] // FIXME: Response examples +[#p-api-scoped-index-name-ex-response-200] .Response 200 ==== [source,json] @@ -1987,6 +2030,7 @@ include::{snippetDir}p-api-scoped-index-name/http-request.adoc[opts=optional] } ---- ==== +[#p-api-scoped-index-name-ex-response-0] .Response 0 ==== [source,json] @@ -2200,9 +2244,14 @@ include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-after.ad +include::{snippetDir}p-api-idx-name-ingestcontrol/curl-request.adoc[opts=optional] + + + include::{snippetDir}p-api-idx-name-ingestcontrol/http-request.adoc[opts=optional] // FIXME: Response examples +[#p-api-idx-name-ingestcontrol-ex-response-200] .Response 200 ==== [source,json] @@ -2389,9 +2438,14 @@ include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-afte +include::{snippetDir}p-api-idx-name-planfreezecontrol/curl-request.adoc[opts=optional] + + + include::{snippetDir}p-api-idx-name-planfreezecontrol/http-request.adoc[opts=optional] // FIXME: Response examples +[#p-api-idx-name-planfreezecontrol-ex-response-200] .Response 200 ==== [source,json] @@ -2578,9 +2632,14 @@ include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-after.ado +include::{snippetDir}p-api-idx-name-querycontrol/curl-request.adoc[opts=optional] + + + include::{snippetDir}p-api-idx-name-querycontrol/http-request.adoc[opts=optional] // FIXME: Response examples +[#p-api-idx-name-querycontrol-ex-response-200] .Response 200 ==== [source,json] @@ -2785,9 +2844,14 @@ include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-after.adoc +include::{snippetDir}p-api-scoped-ingestcontrol/curl-request.adoc[opts=optional] + + + include::{snippetDir}p-api-scoped-ingestcontrol/http-request.adoc[opts=optional] // FIXME: Response examples +[#p-api-scoped-ingestcontrol-ex-response-200] .Response 200 ==== [source,json] @@ -2992,9 +3056,14 @@ include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-after. +include::{snippetDir}p-api-scoped-planfreezecontrol/curl-request.adoc[opts=optional] + + + include::{snippetDir}p-api-scoped-planfreezecontrol/http-request.adoc[opts=optional] // FIXME: Response examples +[#p-api-scoped-planfreezecontrol-ex-response-200] .Response 200 ==== [source,json] @@ -3199,9 +3268,14 @@ include::{specDir}paths/p-api-scoped-querycontrol/operation-security-after.adoc[ +include::{snippetDir}p-api-scoped-querycontrol/curl-request.adoc[opts=optional] + + + include::{snippetDir}p-api-scoped-querycontrol/http-request.adoc[opts=optional] // FIXME: Response examples +[#p-api-scoped-querycontrol-ex-response-200] .Response 200 ==== [source,json] @@ -3415,9 +3489,14 @@ include::{specDir}paths/g-api-scoped-status/operation-security-after.adoc[opts=o +include::{snippetDir}g-api-scoped-status/curl-request.adoc[opts=optional] + + + include::{snippetDir}g-api-scoped-status/http-request.adoc[opts=optional] // FIXME: Response examples +[#g-api-scoped-status-ex-response-200] .Response 200 ==== [source,json] @@ -3555,9 +3634,14 @@ include::{specDir}paths/g-api-stats/operation-security-after.adoc[opts=optional] +include::{snippetDir}g-api-stats/curl-request.adoc[opts=optional] + + + include::{snippetDir}g-api-stats/http-request.adoc[opts=optional] // FIXME: Response examples +[#g-api-stats-ex-response-200] .Response 200 ==== [source,json] @@ -3771,9 +3855,14 @@ include::{specDir}paths/g-api-stats-index-name/operation-security-after.adoc[opt +include::{snippetDir}g-api-stats-index-name/curl-request.adoc[opts=optional] + + + include::{snippetDir}g-api-stats-index-name/http-request.adoc[opts=optional] // FIXME: Response examples +[#g-api-stats-index-name-ex-response-200] .Response 200 ==== [source,json] @@ -4128,9 +4217,26 @@ include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-aft +include::{snippetDir}g-api-stats-index-name-analyzeDoc/curl-request.adoc[opts=optional] + +[#g-api-stats-index-name-analyzeDoc-ex-request] += Example Request Body + +==== +[source,json] +---- +{ + "name" : "hello world", + "title" : "couchbase blr" +} +---- +==== + + include::{snippetDir}g-api-stats-index-name-analyzeDoc/http-request.adoc[opts=optional] // FIXME: Response examples +[#g-api-stats-index-name-analyzeDoc-ex-response-200] .Response 200 ==== [source,json] @@ -4420,9 +4526,14 @@ include::{specDir}paths/g-api-index-name-count/operation-security-after.adoc[opt +include::{snippetDir}g-api-index-name-count/curl-request.adoc[opts=optional] + + + include::{snippetDir}g-api-index-name-count/http-request.adoc[opts=optional] // FIXME: Response examples +[#g-api-index-name-count-ex-response-200] .Response 200 ==== [source,json] @@ -4623,6 +4734,88 @@ include::{specDir}paths/p-api-index-name-query/operation-security-after.adoc[opt +include::{snippetDir}p-api-index-name-query/curl-request.adoc[opts=optional] + +[#p-api-index-name-query-ex-request] += Example Request Body + +==== +[#p-api-index-name-query-ex-request-regular-query] +.Regular Query +[source,json] +---- +{ + "query" : { + "query" : "a sample query", + "boost" : 1 + }, + "size" : 10, + "from" : 0, + "highlight" : null, + "fields" : null, + "facets" : null, + "explain" : false +} +---- + +[#p-api-index-name-query-ex-request-query-with-options] +.Query with Options +[source,json] +---- +{ + "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 +} +---- + +[#p-api-index-name-query-ex-request-hybrid-query] +.Hybrid Query +[source,json] +---- +{ + "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 +} +---- +==== + + + include::{snippetDir}p-api-index-name-query/http-request.adoc[opts=optional] // FIXME: Response examples @@ -4833,9 +5026,25 @@ include::{specDir}paths/p-api-pindex-lookup/operation-security-after.adoc[opts=o +include::{snippetDir}p-api-pindex-lookup/curl-request.adoc[opts=optional] + +[#p-api-pindex-lookup-ex-request] += Example Request Body + +==== +[source,json] +---- +{ + "docID" : "hotel_5848" +} +---- +==== + + include::{snippetDir}p-api-pindex-lookup/http-request.adoc[opts=optional] // FIXME: Response examples +[#p-api-pindex-lookup-ex-response-200] .Response 200 ==== [source,json] @@ -5065,11 +5274,17 @@ include::{specDir}paths/p-api-scoped-query/operation-security-after.adoc[opts=op +include::{snippetDir}p-api-scoped-query/curl-request.adoc[opts=optional] + + + include::{snippetDir}p-api-scoped-query/http-request.adoc[opts=optional] // FIXME: Response examples +[#p-api-scoped-query-ex-response-200] .Response 200 ==== +[#p-api-scoped-query-ex-response-200-success-response-for-a-regular-query] .Success Response for a Regular Query [source,json] ---- @@ -5260,6 +5475,7 @@ include::{snippetDir}p-api-scoped-query/http-request.adoc[opts=optional] } ---- +[#p-api-scoped-query-ex-response-200-success-response-for-a-hybrid-query] .Success Response for a Hybrid Query [source,json] ---- @@ -5306,6 +5522,7 @@ include::{snippetDir}p-api-scoped-query/http-request.adoc[opts=optional] ---- ==== +[#p-api-scoped-query-ex-response-0] .Response 0 ==== [source,json] diff --git a/docs/modules/fts-rest-manage/pages/index.adoc b/docs/modules/fts-rest-manage/pages/index.adoc index e3e933db..26d73b77 100644 --- a/docs/modules/fts-rest-manage/pages/index.adoc +++ b/docs/modules/fts-rest-manage/pages/index.adoc @@ -294,11 +294,11 @@ include::{specDir}paths/put_options/operation-security-end.adoc[opts=optional] include::{specDir}paths/put_options/operation-security-after.adoc[opts=optional] -[#put_options-ex-req] +[#put_options-ex-curl] = Example HTTP Request ==== -[#put_options-ex-req-disable] +[#put_options-ex-curl-disable] .Disable [source,sh] ---- @@ -308,7 +308,7 @@ curl -X PUT http://$HOST:8094/api/managerOptions \ -d '{"disableFileTransferRebalance": "true" }' ---- -[#put_options-ex-req-enable] +[#put_options-ex-curl-enable] .Enable [source,sh] ---- @@ -321,9 +321,14 @@ curl -X PUT http://$HOST:8094/api/managerOptions \ +include::{snippetDir}put_options/curl-request.adoc[opts=optional] + + + include::{snippetDir}put_options/http-request.adoc[opts=optional] // FIXME: Response examples +[#put_options-ex-response-200] .Response 200 ==== [source,json] @@ -333,6 +338,7 @@ include::{snippetDir}put_options/http-request.adoc[opts=optional] } ---- ==== +[#put_options-ex-response-405] .Response 405 ==== [source,json] diff --git a/docs/modules/fts-rest-nodes/pages/index.adoc b/docs/modules/fts-rest-nodes/pages/index.adoc index 399e9264..bf7a7be8 100644 --- a/docs/modules/fts-rest-nodes/pages/index.adoc +++ b/docs/modules/fts-rest-nodes/pages/index.adoc @@ -240,9 +240,14 @@ include::{specDir}paths/getClusterConfig/operation-security-after.adoc[opts=opti +include::{snippetDir}getClusterConfig/curl-request.adoc[opts=optional] + + + include::{snippetDir}getClusterConfig/http-request.adoc[opts=optional] // FIXME: Response examples +[#getClusterConfig-ex-response-200] .Response 200 ==== [source,json] @@ -462,6 +467,10 @@ include::{specDir}paths/managerKick/operation-security-after.adoc[opts=optional] +include::{snippetDir}managerKick/curl-request.adoc[opts=optional] + + + include::{snippetDir}managerKick/http-request.adoc[opts=optional] // FIXME: Response examples @@ -589,6 +598,10 @@ include::{specDir}paths/managerMeta/operation-security-after.adoc[opts=optional] +include::{snippetDir}managerMeta/curl-request.adoc[opts=optional] + + + include::{snippetDir}managerMeta/http-request.adoc[opts=optional] // FIXME: Response examples @@ -712,6 +725,10 @@ include::{specDir}paths/refreshClusterConfig/operation-security-after.adoc[opts= +include::{snippetDir}refreshClusterConfig/curl-request.adoc[opts=optional] + + + include::{snippetDir}refreshClusterConfig/http-request.adoc[opts=optional] // FIXME: Response examples @@ -860,6 +877,10 @@ include::{specDir}paths/captureCpuProfile/operation-security-after.adoc[opts=opt +include::{snippetDir}captureCpuProfile/curl-request.adoc[opts=optional] + + + include::{snippetDir}captureCpuProfile/http-request.adoc[opts=optional] // FIXME: Response examples @@ -983,6 +1004,10 @@ include::{specDir}paths/captureMemoryProfile/operation-security-after.adoc[opts= +include::{snippetDir}captureMemoryProfile/curl-request.adoc[opts=optional] + + + include::{snippetDir}captureMemoryProfile/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1122,6 +1147,10 @@ include::{specDir}paths/getDiagnostics/operation-security-after.adoc[opts=option +include::{snippetDir}getDiagnostics/curl-request.adoc[opts=optional] + + + include::{snippetDir}getDiagnostics/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1249,9 +1278,14 @@ include::{specDir}paths/getLogs/operation-security-after.adoc[opts=optional] +include::{snippetDir}getLogs/curl-request.adoc[opts=optional] + + + include::{snippetDir}getLogs/http-request.adoc[opts=optional] // FIXME: Response examples +[#getLogs-ex-response-200] .Response 200 ==== [source,json] @@ -1385,6 +1419,10 @@ include::{specDir}paths/getRuntimeArgs/operation-security-after.adoc[opts=option +include::{snippetDir}getRuntimeArgs/curl-request.adoc[opts=optional] + + + include::{snippetDir}getRuntimeArgs/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1512,9 +1550,14 @@ include::{specDir}paths/getRuntimeInfo/operation-security-after.adoc[opts=option +include::{snippetDir}getRuntimeInfo/curl-request.adoc[opts=optional] + + + include::{snippetDir}getRuntimeInfo/http-request.adoc[opts=optional] // FIXME: Response examples +[#getRuntimeInfo-ex-response-200] .Response 200 ==== [source,json] @@ -1674,6 +1717,10 @@ include::{specDir}paths/performGC/operation-security-after.adoc[opts=optional] +include::{snippetDir}performGC/curl-request.adoc[opts=optional] + + + include::{snippetDir}performGC/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1821,6 +1868,10 @@ include::{specDir}paths/getMemoryStats/operation-security-after.adoc[opts=option +include::{snippetDir}getMemoryStats/curl-request.adoc[opts=optional] + + + include::{snippetDir}getMemoryStats/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1947,6 +1998,10 @@ include::{specDir}paths/getRuntimeStats/operation-security-after.adoc[opts=optio +include::{snippetDir}getRuntimeStats/curl-request.adoc[opts=optional] + + + include::{snippetDir}getRuntimeStats/http-request.adoc[opts=optional] // FIXME: Response examples diff --git a/docs/modules/fts-rest-query/pages/index.adoc b/docs/modules/fts-rest-query/pages/index.adoc index b4c9f43a..a30c4b63 100644 --- a/docs/modules/fts-rest-query/pages/index.adoc +++ b/docs/modules/fts-rest-query/pages/index.adoc @@ -270,11 +270,11 @@ include::{specDir}paths/api-query/operation-security-end.adoc[opts=optional] include::{specDir}paths/api-query/operation-security-after.adoc[opts=optional] -[#api-query-ex-req] +[#api-query-ex-curl] = Example HTTP Request ==== -[#api-query-ex-req-all] +[#api-query-ex-curl-all] .All [source,sh] ---- @@ -283,7 +283,7 @@ curl -XGET -H "Content-Type: application/json" \ "http://$HOST:8094/api/query" ---- -[#api-query-ex-req-filtered] +[#api-query-ex-curl-filtered] .Filtered [source,sh] ---- @@ -295,11 +295,17 @@ curl -XGET -H "Content-Type: application/json" \ +include::{snippetDir}api-query/curl-request.adoc[opts=optional] + + + include::{snippetDir}api-query/http-request.adoc[opts=optional] // FIXME: Response examples +[#api-query-ex-response-200] .Response 200 ==== +[#api-query-ex-response-200-all-active-node-queries] .All active node queries [source,json] ---- @@ -366,6 +372,7 @@ include::{snippetDir}api-query/http-request.adoc[opts=optional] } ---- +[#api-query-ex-response-200-all-active-node-queries-filtered] .All active node queries (filtered) [source,json] ---- @@ -580,7 +587,7 @@ include::{specDir}paths/api-query-cancel/operation-security-end.adoc[opts=option include::{specDir}paths/api-query-cancel/operation-security-after.adoc[opts=optional] -[#api-query-cancel-ex-req] +[#api-query-cancel-ex-curl] = Example HTTP Request ==== @@ -595,9 +602,25 @@ curl -X POST -H "Content-Type: application/json" -u $USER:$PASSWORD \ +include::{snippetDir}api-query-cancel/curl-request.adoc[opts=optional] + +[#api-query-cancel-ex-request] += Example Request Body + +==== +[source,json] +---- +{ + "uuid" : "b91d75480470f979f65f04e8f20a1f7b" +} +---- +==== + + include::{snippetDir}api-query-cancel/http-request.adoc[opts=optional] // FIXME: Response examples +[#api-query-cancel-ex-response-200] .Response 200 ==== [source,json] @@ -787,7 +810,7 @@ include::{specDir}paths/api-query-index/operation-security-end.adoc[opts=optiona include::{specDir}paths/api-query-index/operation-security-after.adoc[opts=optional] -[#api-query-index-ex-req] +[#api-query-index-ex-curl] = Example HTTP Request ==== @@ -802,9 +825,14 @@ curl -XGET -H "Content-Type: application/json" \ +include::{snippetDir}api-query-index/curl-request.adoc[opts=optional] + + + include::{snippetDir}api-query-index/http-request.adoc[opts=optional] // FIXME: Response examples +[#api-query-index-ex-response-200] .Response 200 ==== [source,json] diff --git a/docs/modules/fts-rest-stats/pages/index.adoc b/docs/modules/fts-rest-stats/pages/index.adoc index 7af1a7c6..3ced25d9 100644 --- a/docs/modules/fts-rest-stats/pages/index.adoc +++ b/docs/modules/fts-rest-stats/pages/index.adoc @@ -259,9 +259,14 @@ include::{specDir}paths/g-api-nsstats/operation-security-after.adoc[opts=optiona +include::{snippetDir}g-api-nsstats/curl-request.adoc[opts=optional] + + + include::{snippetDir}g-api-nsstats/http-request.adoc[opts=optional] // FIXME: Response examples +[#g-api-nsstats-ex-response-200] .Response 200 ==== [source,json] @@ -432,6 +437,7 @@ include::{snippetDir}g-api-nsstats/http-request.adoc[opts=optional] } ---- ==== +[#g-api-nsstats-ex-response-403] .Response 403 ==== [source,json] @@ -608,9 +614,14 @@ include::{specDir}paths/g-api-nsstats-index-name/operation-security-after.adoc[o +include::{snippetDir}g-api-nsstats-index-name/curl-request.adoc[opts=optional] + + + include::{snippetDir}g-api-nsstats-index-name/http-request.adoc[opts=optional] // FIXME: Response examples +[#g-api-nsstats-index-name-ex-response-200] .Response 200 ==== [source,json] diff --git a/docs/modules/index-rest-stats/pages/index.adoc b/docs/modules/index-rest-stats/pages/index.adoc index 66b405d3..9a496c4e 100644 --- a/docs/modules/index-rest-stats/pages/index.adoc +++ b/docs/modules/index-rest-stats/pages/index.adoc @@ -353,6 +353,10 @@ include::{specDir}paths/get_index_stats/operation-security-after.adoc[opts=optio +include::{snippetDir}get_index_stats/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_index_stats/http-request.adoc[opts=optional] // FIXME: Response examples @@ -574,6 +578,10 @@ include::{specDir}paths/get_keyspace_stats/operation-security-after.adoc[opts=op +include::{snippetDir}get_keyspace_stats/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_keyspace_stats/http-request.adoc[opts=optional] // FIXME: Response examples @@ -765,6 +773,10 @@ include::{specDir}paths/get_node_stats/operation-security-after.adoc[opts=option +include::{snippetDir}get_node_stats/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_node_stats/http-request.adoc[opts=optional] // FIXME: Response examples diff --git a/docs/modules/n1ql-rest-admin/pages/index.adoc b/docs/modules/n1ql-rest-admin/pages/index.adoc index c8cf2f25..59297170 100644 --- a/docs/modules/n1ql-rest-admin/pages/index.adoc +++ b/docs/modules/n1ql-rest-admin/pages/index.adoc @@ -283,6 +283,10 @@ include::{specDir}paths/delete_active_request/operation-security-after.adoc[opts +include::{snippetDir}delete_active_request/curl-request.adoc[opts=optional] + + + include::{snippetDir}delete_active_request/http-request.adoc[opts=optional] // FIXME: Response examples @@ -412,6 +416,10 @@ include::{specDir}paths/get_active_indexes/operation-security-after.adoc[opts=op +include::{snippetDir}get_active_indexes/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_active_indexes/http-request.adoc[opts=optional] // FIXME: Response examples @@ -573,6 +581,10 @@ include::{specDir}paths/get_active_request/operation-security-after.adoc[opts=op +include::{snippetDir}get_active_request/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_active_request/http-request.adoc[opts=optional] // FIXME: Response examples @@ -700,6 +712,10 @@ include::{specDir}paths/get_active_requests/operation-security-after.adoc[opts=o +include::{snippetDir}get_active_requests/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_active_requests/http-request.adoc[opts=optional] // FIXME: Response examples @@ -890,6 +906,10 @@ include::{specDir}paths/delete_completed_request/operation-security-after.adoc[o +include::{snippetDir}delete_completed_request/curl-request.adoc[opts=optional] + + + include::{snippetDir}delete_completed_request/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1019,6 +1039,10 @@ include::{specDir}paths/get_completed_indexes/operation-security-after.adoc[opts +include::{snippetDir}get_completed_indexes/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_completed_indexes/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1180,6 +1204,10 @@ include::{specDir}paths/get_completed_request/operation-security-after.adoc[opts +include::{snippetDir}get_completed_request/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_completed_request/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1307,6 +1335,10 @@ include::{specDir}paths/get_completed_requests/operation-security-after.adoc[opt +include::{snippetDir}get_completed_requests/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_completed_requests/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1491,6 +1523,10 @@ include::{specDir}paths/get_cluster/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_cluster/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_cluster/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1618,6 +1654,10 @@ include::{specDir}paths/get_clusters/operation-security-after.adoc[opts=optional +include::{snippetDir}get_clusters/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_clusters/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1745,6 +1785,10 @@ include::{specDir}paths/get_config/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_config/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_config/http-request.adoc[opts=optional] // FIXME: Response examples @@ -1916,6 +1960,10 @@ include::{specDir}paths/get_node/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_node/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_node/http-request.adoc[opts=optional] // FIXME: Response examples @@ -2076,6 +2124,10 @@ include::{specDir}paths/get_nodes/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_nodes/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_nodes/http-request.adoc[opts=optional] // FIXME: Response examples @@ -2234,9 +2286,14 @@ include::{specDir}paths/get_gc/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_gc/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_gc/http-request.adoc[opts=optional] // FIXME: Response examples +[#get_gc-ex-response-200] .Response 200 ==== [source,json] @@ -2352,6 +2409,10 @@ include::{specDir}paths/get_ping/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_ping/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_ping/http-request.adoc[opts=optional] // FIXME: Response examples @@ -2488,9 +2549,14 @@ include::{specDir}paths/post_gc/operation-security-after.adoc[opts=optional] +include::{snippetDir}post_gc/curl-request.adoc[opts=optional] + + + include::{snippetDir}post_gc/http-request.adoc[opts=optional] // FIXME: Response examples +[#post_gc-ex-response-200] .Response 200 ==== [source,json] @@ -2689,6 +2755,10 @@ include::{specDir}paths/delete_prepared/operation-security-after.adoc[opts=optio +include::{snippetDir}delete_prepared/curl-request.adoc[opts=optional] + + + include::{snippetDir}delete_prepared/http-request.adoc[opts=optional] // FIXME: Response examples @@ -2850,6 +2920,10 @@ include::{specDir}paths/get_prepared/operation-security-after.adoc[opts=optional +include::{snippetDir}get_prepared/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_prepared/http-request.adoc[opts=optional] // FIXME: Response examples @@ -2979,6 +3053,10 @@ include::{specDir}paths/get_prepared_indexes/operation-security-after.adoc[opts= +include::{snippetDir}get_prepared_indexes/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_prepared_indexes/http-request.adoc[opts=optional] // FIXME: Response examples @@ -3106,6 +3184,10 @@ include::{specDir}paths/get_prepareds/operation-security-after.adoc[opts=optiona +include::{snippetDir}get_prepareds/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_prepareds/http-request.adoc[opts=optional] // FIXME: Response examples @@ -3254,6 +3336,10 @@ include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional +include::{snippetDir}get_settings/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_settings/http-request.adoc[opts=optional] // FIXME: Response examples @@ -3419,6 +3505,10 @@ include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optiona +include::{snippetDir}post_settings/curl-request.adoc[opts=optional] + + + include::{snippetDir}post_settings/http-request.adoc[opts=optional] // FIXME: Response examples @@ -3550,9 +3640,14 @@ include::{specDir}paths/get_debug_vars/operation-security-after.adoc[opts=option +include::{snippetDir}get_debug_vars/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_debug_vars/http-request.adoc[opts=optional] // FIXME: Response examples +[#get_debug_vars-ex-response-302] .Response 302 ==== [source,html] @@ -3720,6 +3815,10 @@ include::{specDir}paths/get_stat/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_stat/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_stat/http-request.adoc[opts=optional] // FIXME: Response examples @@ -3847,6 +3946,10 @@ include::{specDir}paths/get_stats/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_stats/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_stats/http-request.adoc[opts=optional] // FIXME: Response examples @@ -3975,6 +4078,10 @@ include::{specDir}paths/get_vitals/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_vitals/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_vitals/http-request.adoc[opts=optional] // FIXME: Response examples diff --git a/docs/modules/n1ql-rest-functions/pages/index.adoc b/docs/modules/n1ql-rest-functions/pages/index.adoc index dd7fa279..0ca37039 100644 --- a/docs/modules/n1ql-rest-functions/pages/index.adoc +++ b/docs/modules/n1ql-rest-functions/pages/index.adoc @@ -322,6 +322,10 @@ include::{specDir}paths/delete_library/operation-security-after.adoc[opts=option +include::{snippetDir}delete_library/curl-request.adoc[opts=optional] + + + include::{snippetDir}delete_library/http-request.adoc[opts=optional] // FIXME: Response examples @@ -511,11 +515,17 @@ include::{specDir}paths/get_collection/operation-security-after.adoc[opts=option +include::{snippetDir}get_collection/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_collection/http-request.adoc[opts=optional] // FIXME: Response examples +[#get_collection-ex-response-200] .Response 200 ==== +[#get_collection-ex-response-200-all-libraries] .All Libraries [source,json] ---- @@ -532,6 +542,7 @@ include::{snippetDir}get_collection/http-request.adoc[opts=optional] } ] ---- +[#get_collection-ex-response-200-scoped-libraries] .Scoped Libraries [source,json] ---- @@ -758,11 +769,17 @@ include::{specDir}paths/get_library/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_library/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_library/http-request.adoc[opts=optional] // FIXME: Response examples +[#get_library-ex-response-200] .Response 200 ==== +[#get_library-ex-response-200-global-library] .Global Library [source,json] ---- @@ -771,6 +788,7 @@ include::{snippetDir}get_library/http-request.adoc[opts=optional] } ---- +[#get_library-ex-response-200-scoped-library] .Scoped Library [source,json] ---- @@ -1015,6 +1033,10 @@ include::{specDir}paths/post_library/operation-security-after.adoc[opts=optional +include::{snippetDir}post_library/curl-request.adoc[opts=optional] + + + include::{snippetDir}post_library/http-request.adoc[opts=optional] // FIXME: Response examples diff --git a/docs/modules/n1ql-rest-query/pages/index.adoc b/docs/modules/n1ql-rest-query/pages/index.adoc index 2186eb62..5cdf6e6c 100644 --- a/docs/modules/n1ql-rest-query/pages/index.adoc +++ b/docs/modules/n1ql-rest-query/pages/index.adoc @@ -351,9 +351,14 @@ include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_service/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_service/http-request.adoc[opts=optional] // FIXME: Response examples +[#get_service-ex-response-200] .Response 200 ==== [source,json] @@ -377,8 +382,10 @@ include::{snippetDir}get_service/http-request.adoc[opts=optional] } ---- ==== +[#get_service-ex-response-400] .Response 400 ==== +[#get_service-ex-response-400-sql-error] .SQL++ Error [source,json] ---- @@ -400,6 +407,7 @@ include::{snippetDir}get_service/http-request.adoc[opts=optional] } ---- +[#get_service-ex-response-400-request-error] .Request Error [source,json] ---- @@ -422,6 +430,7 @@ include::{snippetDir}get_service/http-request.adoc[opts=optional] ---- ==== +[#get_service-ex-response-404] .Response 404 ==== [source,json] @@ -444,6 +453,7 @@ include::{snippetDir}get_service/http-request.adoc[opts=optional] } ---- ==== +[#get_service-ex-response-503] .Response 503 ==== [source,json] @@ -708,9 +718,14 @@ include::{specDir}paths/post_service/operation-security-after.adoc[opts=optional +include::{snippetDir}post_service/curl-request.adoc[opts=optional] + + + include::{snippetDir}post_service/http-request.adoc[opts=optional] // FIXME: Response examples +[#post_service-ex-response-200] .Response 200 ==== [source,json] @@ -734,8 +749,10 @@ include::{snippetDir}post_service/http-request.adoc[opts=optional] } ---- ==== +[#post_service-ex-response-400] .Response 400 ==== +[#post_service-ex-response-400-sql-error] .SQL++ Error [source,json] ---- @@ -757,6 +774,7 @@ include::{snippetDir}post_service/http-request.adoc[opts=optional] } ---- +[#post_service-ex-response-400-request-error] .Request Error [source,json] ---- @@ -779,6 +797,7 @@ include::{snippetDir}post_service/http-request.adoc[opts=optional] ---- ==== +[#post_service-ex-response-404] .Response 404 ==== [source,json] @@ -801,6 +820,7 @@ include::{snippetDir}post_service/http-request.adoc[opts=optional] } ---- ==== +[#post_service-ex-response-503] .Response 503 ==== [source,json] diff --git a/docs/modules/n1ql-rest-settings/pages/index.adoc b/docs/modules/n1ql-rest-settings/pages/index.adoc index 05bac6cf..48178325 100644 --- a/docs/modules/n1ql-rest-settings/pages/index.adoc +++ b/docs/modules/n1ql-rest-settings/pages/index.adoc @@ -237,9 +237,14 @@ include::{specDir}paths/get_access/operation-security-after.adoc[opts=optional] +include::{snippetDir}get_access/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_access/http-request.adoc[opts=optional] // FIXME: Response examples +[#get_access-ex-response-200] .Response 200 ==== [source,json] @@ -375,9 +380,14 @@ include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional +include::{snippetDir}get_settings/curl-request.adoc[opts=optional] + + + include::{snippetDir}get_settings/http-request.adoc[opts=optional] // FIXME: Response examples +[#get_settings-ex-response-200] .Response 200 ==== [source,json] @@ -582,9 +592,27 @@ include::{specDir}paths/post_access/operation-security-after.adoc[opts=optional] +include::{snippetDir}post_access/curl-request.adoc[opts=optional] + +[#post_access-ex-request] += Example Request Body + +==== +[source,json] +---- +{ + "all_access" : false, + "allowed_urls" : [ "https://company1.com" ], + "disallowed_urls" : [ "https://company2.com" ] +} +---- +==== + + include::{snippetDir}post_access/http-request.adoc[opts=optional] // FIXME: Response examples +[#post_access-ex-response-200] .Response 200 ==== [source,json] @@ -765,9 +793,67 @@ include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optiona +include::{snippetDir}post_settings/curl-request.adoc[opts=optional] + +[#post_settings-ex-request] += Example Request Body + +==== +[#post_settings-ex-request-partial-settings] +.Partial Settings +[source,json] +---- +{ + "queryTmpSpaceDir" : "/tmp", + "queryTmpSpaceSize" : 2048, + "queryCurlWhitelist" : { + "all_access" : false + } +} +---- + +[#post_settings-ex-request-all-settings] +.All Settings +[source,json] +---- +{ + "queryTmpSpaceDir" : "/tmp", + "queryTmpSpaceSize" : 2048, + "queryPipelineBatch" : 16, + "queryPipelineCap" : 512, + "queryScanCap" : 512, + "queryTimeout" : 0, + "queryPreparedLimit" : 16384, + "queryCompletedLimit" : 4000, + "queryCompletedThreshold" : 1000, + "queryLogLevel" : "info", + "queryMaxParallelism" : 1, + "queryTxTimeout" : "0ms", + "queryMemoryQuota" : 0, + "queryUseCBO" : true, + "queryCleanupClientAttempts" : true, + "queryCleanupLostAttempts" : true, + "queryCleanupWindow" : "60s", + "queryNumAtrs" : 1024, + "queryNodeQuota" : 0, + "queryUseReplica" : "unset", + "queryNodeQuotaValPercent" : 67, + "queryNumCpus" : 0, + "queryCompletedMaxPlanSize" : 262144, + "queryN1QLFeatCtrl" : 76, + "queryCurlWhitelist" : { + "all_access" : false + } +} +---- +==== + + + include::{snippetDir}post_settings/http-request.adoc[opts=optional] // FIXME: Response examples +[#post_settings-ex-response-200] .Response 200 ==== [source,json] From 589dd1b6c5f0e32f47687b44e8536285218c7cf4 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Mon, 2 Feb 2026 09:39:07 +0000 Subject: [PATCH 19/30] Remove example captions from Query APIS --- docs/modules/n1ql-rest-admin/partials/header-attributes.adoc | 3 ++- .../n1ql-rest-functions/partials/header-attributes.adoc | 3 ++- docs/modules/n1ql-rest-query/partials/header-attributes.adoc | 3 ++- .../modules/n1ql-rest-settings/partials/header-attributes.adoc | 3 ++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/modules/n1ql-rest-admin/partials/header-attributes.adoc b/docs/modules/n1ql-rest-admin/partials/header-attributes.adoc index 65ca2da5..1dcedcf3 100644 --- a/docs/modules/n1ql-rest-admin/partials/header-attributes.adoc +++ b/docs/modules/n1ql-rest-admin/partials/header-attributes.adoc @@ -1,2 +1,3 @@ :page-partial: -:page-aliases: n1ql:n1ql-rest-api/admin.adoc \ No newline at end of file +:page-aliases: n1ql:n1ql-rest-api/admin.adoc +:!example-caption: \ No newline at end of file diff --git a/docs/modules/n1ql-rest-functions/partials/header-attributes.adoc b/docs/modules/n1ql-rest-functions/partials/header-attributes.adoc index f8731623..8099a047 100644 --- a/docs/modules/n1ql-rest-functions/partials/header-attributes.adoc +++ b/docs/modules/n1ql-rest-functions/partials/header-attributes.adoc @@ -1,3 +1,4 @@ :page-partial: :page-edition: Enterprise Edition -:page-aliases: n1ql:n1ql-rest-api/functions.adoc \ No newline at end of file +:page-aliases: n1ql:n1ql-rest-api/functions.adoc +:!example-caption: \ No newline at end of file diff --git a/docs/modules/n1ql-rest-query/partials/header-attributes.adoc b/docs/modules/n1ql-rest-query/partials/header-attributes.adoc index cb26659f..1663571f 100644 --- a/docs/modules/n1ql-rest-query/partials/header-attributes.adoc +++ b/docs/modules/n1ql-rest-query/partials/header-attributes.adoc @@ -1,2 +1,3 @@ :page-partial: -:page-aliases: n1ql:n1ql-rest-api/index.adoc \ No newline at end of file +:page-aliases: n1ql:n1ql-rest-api/index.adoc +:!example-caption: \ No newline at end of file diff --git a/docs/modules/n1ql-rest-settings/partials/header-attributes.adoc b/docs/modules/n1ql-rest-settings/partials/header-attributes.adoc index 5c8cd6fc..ccd92adf 100644 --- a/docs/modules/n1ql-rest-settings/partials/header-attributes.adoc +++ b/docs/modules/n1ql-rest-settings/partials/header-attributes.adoc @@ -1,2 +1,3 @@ :page-partial: -:page-aliases: rest-api:rest-cluster-query-settings.adoc \ No newline at end of file +:page-aliases: rest-api:rest-cluster-query-settings.adoc +:!example-caption: \ No newline at end of file From 8fc35a46448b77818c34c91cee5e5957c718e551 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Mon, 2 Feb 2026 11:24:26 +0000 Subject: [PATCH 20/30] Output default for response code 0 --- templates/index.handlebars | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/templates/index.handlebars b/templates/index.handlebars index 40007e1b..3197b3fe 100644 --- a/templates/index.handlebars +++ b/templates/index.handlebars @@ -118,8 +118,10 @@ endif::[] ifeval::[{count-apis} > 0] [#tag-{{baseName}}] -= {{#with operations.operation.[0].tags.[0].name ~}} -{{#capitalize}}{{this}}{{/capitalize}}{{! FIXME: assumes first tag in first operation is the same as this API }} += {{#with operations.operation.[0].tags.[0].x-displayName ~}} +{{this}}{{! FIXME: assumes first tag in first operation is the same as this API }} +{{~ else with operations.operation.[0].tags.[0].name ~}} +{{#capitalize}}{{this}}{{/capitalize}} {{~ else ~}} {{baseName}} {{~/with}} @@ -244,7 +246,7 @@ include::{specDir}paths/{{operationIdOriginal}}/operation-responses-begin.adoc[o |=== | HTTP Code | Description | Schema {{/if}}{{! @first }} -| {{code}} +| {{#if isDefault}}Default{{else}}{{code}}{{/if}} a| [markdown] -- {{{message}}} @@ -379,7 +381,7 @@ include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] {{#with example ~}} [#{{operationIdOriginal}}-ex-response-{{code}}] -.Response {{#if code}}{{code}}{{else}}(default){{/if}} +.{{#if isDefault}}Default Response{{else}}Response {{code}}{{/if}} ==== [source,json] ---- @@ -390,7 +392,7 @@ include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] {{#if @first ~}} [#{{operationIdOriginal}}-ex-response-{{code}}] -.Response {{#if code}}{{code}}{{else}}(default){{/if}} +.{{#if isDefault}}Default Response{{else}}Response {{code}}{{/if}} ==== {{/if ~}} {{#with summary~}} @@ -409,7 +411,7 @@ include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] {{#with example ~}} [#{{operationIdOriginal}}-ex-response-{{code}}] -.Response {{code}} +.{{#if isDefault}}Default Response{{else}}Response {{code}}{{/if}} ==== [source,html] ---- @@ -420,7 +422,7 @@ include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] {{#if @first ~}} [#{{operationIdOriginal}}-ex-response-{{code}}] -.Response {{code}} +.{{#if isDefault}}Default Response{{else}}Response {{code}}{{/if}} ==== {{/if ~}} {{#with summary~}} From 58911cc90d4aeb312250efcdcbe21dfb1aa73a53 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Mon, 2 Feb 2026 11:25:19 +0000 Subject: [PATCH 21/30] Objects in body param --- templates/param.handlebars | 2 ++ templates/schema.handlebars | 4 +++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/templates/param.handlebars b/templates/param.handlebars index 601dc8b8..38f400b9 100644 --- a/templates/param.handlebars +++ b/templates/param.handlebars @@ -10,6 +10,8 @@ a¦ {{#with vendorExtensions.x-desc-edition}}[.edition]##{{this}}##{{#unless ven -- {{#with unescapedDescription ~}} {{{this}}} +{{~ else with description ~}} +{{{this}}} {{~/with ~}} {{~#if isEnumRef ~}} include::index.adoc[tag=desc-{{dataType}}, opts=optional]{{! if this is an enum reference, fetch remote description}} diff --git a/templates/schema.handlebars b/templates/schema.handlebars index 5da6dbcd..e5298268 100644 --- a/templates/schema.handlebars +++ b/templates/schema.handlebars @@ -1,9 +1,11 @@ {{#with ref ~}} xref:{{dataType}}[] -{{~else if isModel ~}} +{{~else if hasVars ~}} +{{#if isModel ~}} xref:{{dataType}}[] {{~else if isMap ~}} xref:{{dataType}}[] +{{~/if}}{{! hasVars ~}} {{~else if isAnyType ~}} Any Type {{~else ~}} From d92daf3481f1f5e2a1c7e47a8fc99486232899ee Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Mon, 2 Feb 2026 14:16:19 +0000 Subject: [PATCH 22/30] Title for Example HTTP Response --- templates/index.handlebars | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/templates/index.handlebars b/templates/index.handlebars index 3197b3fe..305da0c2 100644 --- a/templates/index.handlebars +++ b/templates/index.handlebars @@ -375,7 +375,21 @@ include::{snippetDir}{{operationIdOriginal}}/curl-request.adoc[opts=optional] include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::[" +{{~#each responses ~}} +{{#each content ~}} +{{#with example ~}} +yes +{{~else each examples ~}} +yes +{{~/with}} +{{~/each}} +{{~/each~}} +" != ""] +[#{{operationIdOriginal}}-ex-response] += Example HTTP Response +endif::[] + {{#each responses ~}} {{#with content.[application/json] ~}} {{#with example ~}} From 4fa920a6943a0727029d5be1204939f2f920762f Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Mon, 2 Feb 2026 18:03:27 +0000 Subject: [PATCH 23/30] Rationalize HTTP Request examples --- .../paths/put_options/curl-request.adoc | 4 +-- .../paths/api-query/curl-request.adoc | 4 +-- templates/index.handlebars | 25 +++++++++++++------ 3 files changed, 22 insertions(+), 11 deletions(-) diff --git a/docs/modules/fts-rest-manage/partials/paths/put_options/curl-request.adoc b/docs/modules/fts-rest-manage/partials/paths/put_options/curl-request.adoc index d25f4e6d..761d5ae2 100644 --- a/docs/modules/fts-rest-manage/partials/paths/put_options/curl-request.adoc +++ b/docs/modules/fts-rest-manage/partials/paths/put_options/curl-request.adoc @@ -1,5 +1,5 @@ -The <> request disables the creation of new partitions by means of file transfer. +The <> request disables the creation of new partitions by means of file transfer. From this point, Search Service index partitions are built on the new nodes assigned to them during rebalance. -The <> request re-enables the creation of new partitions by means of file transfer. +The <> request re-enables the creation of new partitions by means of file transfer. 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-query/partials/paths/api-query/curl-request.adoc b/docs/modules/fts-rest-query/partials/paths/api-query/curl-request.adoc index f889d601..3c115b93 100644 --- a/docs/modules/fts-rest-query/partials/paths/api-query/curl-request.adoc +++ b/docs/modules/fts-rest-query/partials/paths/api-query/curl-request.adoc @@ -1,3 +1,3 @@ -The <> request finds all active queries across the Search cluster. +The <> request finds all active queries across the Search cluster. -The <> request finds all queries across the cluster that have been running for longer than 7{nbsp}s. \ No newline at end of file +The <> request finds all queries across the cluster that have been running for longer than 7{nbsp}s. \ No newline at end of file diff --git a/templates/index.handlebars b/templates/index.handlebars index 305da0c2..401d962c 100644 --- a/templates/index.handlebars +++ b/templates/index.handlebars @@ -317,18 +317,29 @@ include::{specDir}paths/{{operationIdOriginal}}/operation-security-after.adoc[op {{!~ Include partials for operation sample requests and responses }} {{!~ The partials should have a level 1 title; the level offset pushes the title down to the correct section level. }} -{{#each vendorExtensions.x-codeSamples ~}} -{{#if @first ~}} +{{#if vendorExtensions.x-codeSamples ~}} [#{{operationIdOriginal}}-ex-curl] = Example HTTP Request +{{~/if}} +include::{snippetDir}{{operationIdOriginal}}/curl-request.adoc[opts=optional] + +{{#*inline "curlTitle" ~}} +[#{{operationIdOriginal}}-ex-curl-{{@index}}] +.{{#with label}}{{{this}}}{{else}}curl request {{@index}}{{/with}} +{{~/inline ~}} +{{#each vendorExtensions.x-codeSamples ~}} +{{#if @first ~}} ==== {{/if ~}} -{{#with label~}} -[#{{operationIdOriginal}}-ex-curl-{{#slugify}}{{this}}{{/slugify}}] -.{{{this}}} -{{~/with}} -[source,sh]{{!-- FIXME: {{#with lang}},{{#lower}}{{this}}{{/lower}}{{/with}} --}} +{{#if @last ~}} +{{#if @index ~}} +{{> curlTitle}}{{! show label if more than 1 example }} +{{/if}} +{{~else ~}} +{{> curlTitle}} +{{/if}} +[source,sh] ---- {{{source}}} ---- From 03dc395b339e36c8b72e5f2a434221b36a1ddc52 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Mon, 2 Feb 2026 18:05:23 +0000 Subject: [PATCH 24/30] Rationalize Request Body examples --- .../p-api-index-name-query/http-request.adoc | 6 +-- templates/index.handlebars | 48 +++++++------------ templates/request.handlebars | 6 +++ templates/requests.handlebars | 12 +++++ 4 files changed, 39 insertions(+), 33 deletions(-) create mode 100644 templates/request.handlebars create mode 100644 templates/requests.handlebars 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 index e9f4e842..a78fe71a 100644 --- 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 @@ -1,8 +1,8 @@ -The <> request body searches for the text `a sample query` in the documents included in the Search index. +The <> request body searches for the text `a sample query` in the documents included in the Search index. -The <> request body uses from/size for results paging, with `ctl` for a timeout and the `"at_plus"` consistency level. +The <> request body uses from/size for results paging, with `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`. -The <> 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`. +The <> 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`. For more information about vector searches, see xref:vector-search:vector-search.adoc[]. \ No newline at end of file diff --git a/templates/index.handlebars b/templates/index.handlebars index 401d962c..a6fbf9a9 100644 --- a/templates/index.handlebars +++ b/templates/index.handlebars @@ -348,44 +348,32 @@ include::{snippetDir}{{operationIdOriginal}}/curl-request.adoc[opts=optional] {{/if}} {{/each}} -include::{snippetDir}{{operationIdOriginal}}/curl-request.adoc[opts=optional] +{{#*inline "requestBodyHeading" ~}} +[#{{operationIdOriginal}}-ex-request] += Example Request Body +{{~/inline ~}} +{{#with bodyParam ~}} +{{#with content.[application/json] ~}} +{{#if example ~}} +{{> requestBodyHeading }} +{{~else if examples ~}} +{{> requestBodyHeading }} +{{~/if}} +{{~/with}}{{! content.[application/json] }} +{{~/with}}{{! bodyParam }} + +include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] {{#with bodyParam ~}} {{#with content.[application/json] ~}} {{#with example ~}} -[#{{operationIdOriginal}}-ex-request] -= Example Request Body - -==== -[source,json] ----- -{{#json pretty=true}}{{{this}}}{{/json}} ----- -==== +{{>request language="json" isJson=true}} {{else each examples ~}} -{{#if @first ~}} -[#{{operationIdOriginal}}-ex-request] -= Example Request Body - -==== -{{/if ~}} -{{#with summary~}} -[#{{operationIdOriginal}}-ex-request-{{#slugify}}{{this}}{{/slugify}}] -.{{{this}}} -{{~/with}} -[source,json] ----- -{{#with value}}{{#json pretty=true}}{{{this}}}{{/json}}{{/with}} ----- -{{#if @last ~}} -==== -{{/if}} -{{/with}}{{! example }} +{{>requests language="json" isJson=true}} +{{/with}} {{~/with}}{{! content.[application/json] }} {{~/with}}{{! bodyParam }} -include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] - ifeval::[" {{~#each responses ~}} {{#each content ~}} diff --git a/templates/request.handlebars b/templates/request.handlebars new file mode 100644 index 00000000..4df97e62 --- /dev/null +++ b/templates/request.handlebars @@ -0,0 +1,6 @@ +==== +[source,{{language}}] +---- +{{#if isJson}}{{#json pretty=true}}{{{this}}}{{/json}}{{/if}} +---- +==== \ No newline at end of file diff --git a/templates/requests.handlebars b/templates/requests.handlebars new file mode 100644 index 00000000..9a8be76b --- /dev/null +++ b/templates/requests.handlebars @@ -0,0 +1,12 @@ +{{#if @first ~}} +==== +{{/if ~}} +[#{{operationIdOriginal}}-ex-request-{{@index}}] +.{{#with summary}}{{{this}}}{{else}}Example {{@index}}{{/with}} +[source,{{language}}] +---- +{{#with value}}{{#if isJson}}{{#json pretty=true}}{{{this}}}{{/json}}{{else}}{{{this}}}{{/if}}{{/with}} +---- +{{#if @last ~}} +==== +{{/if}} \ No newline at end of file From 4fa2959251cce3e9d3e57c5589d68a2362193a7a Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Mon, 2 Feb 2026 18:05:40 +0000 Subject: [PATCH 25/30] Rationalize HTTP Response examples --- templates/index.handlebars | 64 +++++----------------------------- templates/response.handlebars | 9 +++++ templates/responses.handlebars | 15 ++++++++ 3 files changed, 32 insertions(+), 56 deletions(-) create mode 100644 templates/response.handlebars create mode 100644 templates/responses.handlebars diff --git a/templates/index.handlebars b/templates/index.handlebars index a6fbf9a9..a4cd1e50 100644 --- a/templates/index.handlebars +++ b/templates/index.handlebars @@ -389,72 +389,24 @@ yes = Example HTTP Response endif::[] +include::{snippetDir}{{operationIdOriginal}}/http-response.adoc[opts=optional] + {{#each responses ~}} {{#with content.[application/json] ~}} {{#with example ~}} - -[#{{operationIdOriginal}}-ex-response-{{code}}] -.{{#if isDefault}}Default Response{{else}}Response {{code}}{{/if}} -==== -[source,json] ----- -{{#json pretty=true}}{{{this}}}{{/json}} ----- -==== +{{>response language="json" isJson=true}} {{else each examples ~}} -{{#if @first ~}} - -[#{{operationIdOriginal}}-ex-response-{{code}}] -.{{#if isDefault}}Default Response{{else}}Response {{code}}{{/if}} -==== -{{/if ~}} -{{#with summary~}} -[#{{operationIdOriginal}}-ex-response-{{code}}-{{#slugify}}{{this}}{{/slugify}}] -.{{{this}}} -{{~/with}} -[source,json] ----- -{{#with value}}{{#json pretty=true}}{{{this}}}{{/json}}{{/with}} ----- -{{#if @last ~}} -==== -{{/if}} -{{/with}}{{! example }} +{{>responses language="json" isJson=true}} +{{/with}} {{~else with content.[text/html] ~}} {{#with example ~}} - -[#{{operationIdOriginal}}-ex-response-{{code}}] -.{{#if isDefault}}Default Response{{else}}Response {{code}}{{/if}} -==== -[source,html] ----- -{{{this}}} ----- -==== +{{> response language="html"}} {{else each examples ~}} -{{#if @first ~}} - -[#{{operationIdOriginal}}-ex-response-{{code}}] -.{{#if isDefault}}Default Response{{else}}Response {{code}}{{/if}} -==== -{{/if ~}} -{{#with summary~}} -[#{{operationIdOriginal}}-ex-response-{{code}}-{{#slugify}}{{this}}{{/slugify}}] -.{{{this}}} -{{~/with}} -[source,html] ----- -{{#with value}}{{{this}}}{{/with}} ----- -{{#if @last ~}} -==== -{{/if}} -{{/with}}{{! example }} +{{> responses language="html"}} +{{/with}} {{~/with}}{{! content.[application/json] }} {{~/each}}{{! responses }} -include::{snippetDir}{{operationIdOriginal}}/http-response.adoc[opts=optional] - include::{specDir}paths/{{operationIdOriginal}}/operation-end.adoc[opts=optional] :leveloffset: -1 diff --git a/templates/response.handlebars b/templates/response.handlebars new file mode 100644 index 00000000..08c91f77 --- /dev/null +++ b/templates/response.handlebars @@ -0,0 +1,9 @@ + +[#{{operationIdOriginal}}-ex-response-{{code}}] +.{{#if isDefault}}Default Response{{else}}Response {{code}}{{/if}} +==== +[source,{{language}}] +---- +{{#if isJson}}{{#json pretty=true}}{{{this}}}{{/json}}{{else}}{{{this}}}{{/if}} +---- +==== \ No newline at end of file diff --git a/templates/responses.handlebars b/templates/responses.handlebars new file mode 100644 index 00000000..8fa1936f --- /dev/null +++ b/templates/responses.handlebars @@ -0,0 +1,15 @@ +{{#if @first ~}} + +[#{{operationIdOriginal}}-ex-response-{{code}}] +.{{#if isDefault}}Default Response{{else}}Response {{code}}{{/if}} +==== +{{/if ~}} +[#{{operationIdOriginal}}-ex-response-{{code}}-{{@index}}] +.{{#with summary}}{{{this}}}{{else}}Example {{@index}}{{/with}} +[source,{{language}}] +---- +{{#with value}}{{#if isJson}}{{#json pretty=true}}{{{this}}}{{/json}}{{else}}{{{this}}}{{/if}}{{/with}} +---- +{{#if @last ~}} +==== +{{/if}} \ No newline at end of file From bca87aefb8a0c3934dfb3a0267e1ed7df90f942a Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Tue, 3 Feb 2026 00:07:31 +0000 Subject: [PATCH 26/30] Minor tweaks --- .../p-api-index-name-query/http-request.adoc | 6 +-- templates/index.handlebars | 43 +++++++++++-------- templates/requests.handlebars | 4 +- templates/responses.handlebars | 4 +- 4 files changed, 31 insertions(+), 26 deletions(-) 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 index a78fe71a..b2807d05 100644 --- 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 @@ -1,8 +1,8 @@ -The <> request body searches for the text `a sample query` in the documents included in the Search index. +The <> request searches for the text `a sample query` in the documents included in the Search index. -The <> request body uses from/size for results paging, with `ctl` for a timeout and the `"at_plus"` consistency level. +The <> request uses from/size for results paging, with `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`. -The <> 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`. +The <> request 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`. For more information about vector searches, see xref:vector-search:vector-search.adoc[]. \ No newline at end of file diff --git a/templates/index.handlebars b/templates/index.handlebars index a4cd1e50..cb5fcd90 100644 --- a/templates/index.handlebars +++ b/templates/index.handlebars @@ -320,7 +320,8 @@ include::{specDir}paths/{{operationIdOriginal}}/operation-security-after.adoc[op {{#if vendorExtensions.x-codeSamples ~}} [#{{operationIdOriginal}}-ex-curl] = Example HTTP Request -{{~/if}} +{{! example HTTP request heading}} +{{/if~}} include::{snippetDir}{{operationIdOriginal}}/curl-request.adoc[opts=optional] @@ -332,13 +333,9 @@ include::{snippetDir}{{operationIdOriginal}}/curl-request.adoc[opts=optional] {{#if @first ~}} ==== {{/if ~}} -{{#if @last ~}} -{{#if @index ~}} -{{> curlTitle}}{{! show label if more than 1 example }} -{{/if}} -{{~else ~}} -{{> curlTitle}} -{{/if}} +{{#if @last}}{{#if @index}}{{> curlTitle}} +{{/if}}{{else}}{{> curlTitle}} +{{/if ~}} [source,sh] ---- {{{source}}} @@ -346,7 +343,7 @@ include::{snippetDir}{{operationIdOriginal}}/curl-request.adoc[opts=optional] {{#if @last ~}} ==== {{/if}} -{{/each}} +{{/each ~}} {{#*inline "requestBodyHeading" ~}} [#{{operationIdOriginal}}-ex-request] @@ -354,9 +351,11 @@ include::{snippetDir}{{operationIdOriginal}}/curl-request.adoc[opts=optional] {{~/inline ~}} {{#with bodyParam ~}} {{#with content.[application/json] ~}} -{{#if example ~}} +{{#if example}} +{{! single request body example heading }} {{> requestBodyHeading }} -{{~else if examples ~}} +{{~else if examples}} +{{! multiple request body example heading }} {{> requestBodyHeading }} {{~/if}} {{~/with}}{{! content.[application/json] }} @@ -364,11 +363,13 @@ include::{snippetDir}{{operationIdOriginal}}/curl-request.adoc[opts=optional] include::{snippetDir}{{operationIdOriginal}}/http-request.adoc[opts=optional] -{{#with bodyParam ~}} +{{~#with bodyParam ~}} {{#with content.[application/json] ~}} -{{#with example ~}} +{{#with example}} +{{! single request body example }} {{>request language="json" isJson=true}} -{{else each examples ~}} +{{else each examples}} +{{! multiple request body examples }} {{>requests language="json" isJson=true}} {{/with}} {{~/with}}{{! content.[application/json] }} @@ -391,17 +392,21 @@ endif::[] include::{snippetDir}{{operationIdOriginal}}/http-response.adoc[opts=optional] -{{#each responses ~}} +{{~#each responses ~}} {{#with content.[application/json] ~}} -{{#with example ~}} +{{#with example}} +{{! single JSON response example }} {{>response language="json" isJson=true}} -{{else each examples ~}} +{{else each examples}} +{{! multiple JSON response examples }} {{>responses language="json" isJson=true}} {{/with}} {{~else with content.[text/html] ~}} -{{#with example ~}} +{{#with example}} +{{! single HTML response example }} {{> response language="html"}} -{{else each examples ~}} +{{else each examples}} +{{! multiple HTML response examples }} {{> responses language="html"}} {{/with}} {{~/with}}{{! content.[application/json] }} diff --git a/templates/requests.handlebars b/templates/requests.handlebars index 9a8be76b..a6f432b3 100644 --- a/templates/requests.handlebars +++ b/templates/requests.handlebars @@ -7,6 +7,6 @@ ---- {{#with value}}{{#if isJson}}{{#json pretty=true}}{{{this}}}{{/json}}{{else}}{{{this}}}{{/if}}{{/with}} ---- -{{#if @last ~}} +{{~#if @last}} ==== -{{/if}} \ No newline at end of file +{{~/if}} \ No newline at end of file diff --git a/templates/responses.handlebars b/templates/responses.handlebars index 8fa1936f..dd6236cf 100644 --- a/templates/responses.handlebars +++ b/templates/responses.handlebars @@ -10,6 +10,6 @@ ---- {{#with value}}{{#if isJson}}{{#json pretty=true}}{{{this}}}{{/json}}{{else}}{{{this}}}{{/if}}{{/with}} ---- -{{#if @last ~}} +{{~#if @last}} ==== -{{/if}} \ No newline at end of file +{{~/if}} \ No newline at end of file From 51ef609e5467f16c0e0fb6a662dc9f45b0ee08c7 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Tue, 3 Feb 2026 00:08:57 +0000 Subject: [PATCH 27/30] Revert "Objects in body param" --- templates/schema.handlebars | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/templates/schema.handlebars b/templates/schema.handlebars index e5298268..5da6dbcd 100644 --- a/templates/schema.handlebars +++ b/templates/schema.handlebars @@ -1,11 +1,9 @@ {{#with ref ~}} xref:{{dataType}}[] -{{~else if hasVars ~}} -{{#if isModel ~}} +{{~else if isModel ~}} xref:{{dataType}}[] {{~else if isMap ~}} xref:{{dataType}}[] -{{~/if}}{{! hasVars ~}} {{~else if isAnyType ~}} Any Type {{~else ~}} From e05e451263937638846dfebc236c56ca177c4265 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Tue, 3 Feb 2026 00:12:05 +0000 Subject: [PATCH 28/30] Revert "Update README for this PoC" This reverts commit a11f79db1498babb92962229b7e8bc2a8b18b30a. --- README.adoc | 72 +++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 54 insertions(+), 18 deletions(-) diff --git a/README.adoc b/README.adoc index 55cdf800..acfe366e 100644 --- a/README.adoc +++ b/README.adoc @@ -1,20 +1,56 @@ = Couchbase Swagger Project -This proof-of-concept attempts to build inline examples into the AsciiDoc output using external example files referenced by the spec. - -The process needs to handle single examples using the `example` key and multiple examples using the `examples` key, in both the request body and the responses. - -* [x] The examples must be bundled into the spec. - OpenAPI Generator does not do this. - The Gradle build uses Redocly to bundle the examples. -* [x] OpenAPI continues to generate examples, even if inline examples are provided. - The generated examples are stored in a different part of OpenAPI Generator's internal representation of the spec. - Continue to set `skipExamples` to `true` so the generated examples are not included. -* [x] The inline examples are placed in the output in the same location where included example AsciiDoc file are placed by the OpenAPI Generator templates. -* [x] The OpenAPI Generator templates remove all line breaks and white space from the inline examples. - The external example files should use the `jsonc` extension, so that line breaks are preserved in the output doc. -* [x] Multiple examples using the `examples` key should use the `externalValue` to reference the external example files. - Otherwise, Redocly does not bundle the external example into the spec. -* [x] The templates cannot work with multiple examples, because Mustache has no way of parsing an object whose keys are not known. - To fix this issue, try migrating the templates to Handlebars. - This is beyond the scope of this proof-of-concept. \ No newline at end of file +This project uses the https://openapi-generator.tech/docs/plugins/#gradle[OpenAPI Generator Gradle Plugin] to convert the OpenAPI specifications for Couchbase Server Developer REST APIs into AsciiDoctor documentation. + +== Usage guide + +This repository handles several OpenAPI subprojects. +Each subproject is stored in its own subfolder within the `docs/modules` folder. + +=== Build Script + +Within each subproject there is a gradle build script with a `.gradle` extension. +The gradle build script specifies the locations of the OpenAPI source file, any additional AsciiDoc content, and the output AsciiDoc files. + +The `build.gradle` script in the root project folder calls the gradle build scripts from each subproject. + +Some subprojects are not currently ready to be built. +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 `attachments`. +(For some subprojects, the OpenAPI specification file may be stored remotely, i.e. alongside the development source files.) + +=== AsciiDoc Content + +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. + +=== Convert a single subproject + +[subs="normal"] +---- +./gradlew _project_:openApiGenerate --rerun-tasks +---- + +Where `_project_` is the subproject that you want to convert, for example, `admin`. + +=== Convert all projects + +[subs="normal"] +---- +./gradlew --rerun-tasks +---- + +== Acknowledgements + +This project is based on the https://openapi-generator.tech/[OpenAPI Generator] project. + +== Licensing + +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. From 4abab7bdd9d457ed1adcbadbf41065ebedb3d85c Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Tue, 3 Feb 2026 00:12:46 +0000 Subject: [PATCH 29/30] Build output documentation --- .../analytics-rest-admin/pages/index.adoc | 64 ++-- .../analytics-rest-config/pages/index.adoc | 36 +- .../analytics-rest-library/pages/index.adoc | 24 +- .../analytics-rest-links/pages/index.adoc | 72 ++-- .../analytics-rest-service/pages/index.adoc | 36 +- .../analytics-rest-settings/pages/index.adoc | 16 +- .../eventing-rest-api/pages/index.adoc | 254 ++++++------- .../fts-rest-advanced/pages/index.adoc | 47 +-- .../fts-rest-indexing/pages/index.adoc | 348 +++++++++++------- docs/modules/fts-rest-manage/pages/index.adoc | 22 +- docs/modules/fts-rest-nodes/pages/index.adoc | 119 +++--- docs/modules/fts-rest-query/pages/index.adoc | 58 +-- docs/modules/fts-rest-stats/pages/index.adoc | 29 +- .../modules/index-rest-stats/pages/index.adoc | 24 +- docs/modules/n1ql-rest-admin/pages/index.adoc | 225 +++++------ .../n1ql-rest-functions/pages/index.adoc | 54 +-- docs/modules/n1ql-rest-query/pages/index.adoc | 52 ++- .../n1ql-rest-settings/pages/index.adoc | 64 ++-- 18 files changed, 857 insertions(+), 687 deletions(-) diff --git a/docs/modules/analytics-rest-admin/pages/index.adoc b/docs/modules/analytics-rest-admin/pages/index.adoc index 33c75e68..1099c2c2 100644 --- a/docs/modules/analytics-rest-admin/pages/index.adoc +++ b/docs/modules/analytics-rest-admin/pages/index.adoc @@ -296,16 +296,16 @@ include::{specDir}paths/cancel_request/operation-security-end.adoc[opts=optional include::{specDir}paths/cancel_request/operation-security-after.adoc[opts=optional] - - include::{snippetDir}cancel_request/curl-request.adoc[opts=optional] include::{snippetDir}cancel_request/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#cancel_request-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}cancel_request/http-response.adoc[opts=optional] @@ -441,16 +441,16 @@ include::{specDir}paths/cluster_status/operation-security-end.adoc[opts=optional include::{specDir}paths/cluster_status/operation-security-after.adoc[opts=optional] - - include::{snippetDir}cluster_status/curl-request.adoc[opts=optional] include::{snippetDir}cluster_status/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#cluster_status-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}cluster_status/http-response.adoc[opts=optional] @@ -586,16 +586,16 @@ include::{specDir}paths/completed_requests/operation-security-end.adoc[opts=opti include::{specDir}paths/completed_requests/operation-security-after.adoc[opts=optional] - - include::{snippetDir}completed_requests/curl-request.adoc[opts=optional] include::{snippetDir}completed_requests/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#completed_requests-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}completed_requests/http-response.adoc[opts=optional] @@ -731,16 +731,16 @@ include::{specDir}paths/ingestion_status/operation-security-end.adoc[opts=option include::{specDir}paths/ingestion_status/operation-security-after.adoc[opts=optional] - - include::{snippetDir}ingestion_status/curl-request.adoc[opts=optional] include::{snippetDir}ingestion_status/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#ingestion_status-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}ingestion_status/http-response.adoc[opts=optional] @@ -881,16 +881,16 @@ include::{specDir}paths/monitor_node/operation-security-end.adoc[opts=optional] include::{specDir}paths/monitor_node/operation-security-after.adoc[opts=optional] - - include::{snippetDir}monitor_node/curl-request.adoc[opts=optional] include::{snippetDir}monitor_node/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#monitor_node-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}monitor_node/http-response.adoc[opts=optional] @@ -1025,16 +1025,16 @@ include::{specDir}paths/restart_cluster/operation-security-end.adoc[opts=optiona include::{specDir}paths/restart_cluster/operation-security-after.adoc[opts=optional] - - include::{snippetDir}restart_cluster/curl-request.adoc[opts=optional] include::{snippetDir}restart_cluster/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#restart_cluster-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}restart_cluster/http-response.adoc[opts=optional] @@ -1169,16 +1169,16 @@ include::{specDir}paths/restart_node/operation-security-end.adoc[opts=optional] include::{specDir}paths/restart_node/operation-security-after.adoc[opts=optional] - - include::{snippetDir}restart_node/curl-request.adoc[opts=optional] include::{snippetDir}restart_node/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#restart_node-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}restart_node/http-response.adoc[opts=optional] @@ -1314,16 +1314,16 @@ include::{specDir}paths/return_active_requests/operation-security-end.adoc[opts= include::{specDir}paths/return_active_requests/operation-security-after.adoc[opts=optional] - - include::{snippetDir}return_active_requests/curl-request.adoc[opts=optional] include::{snippetDir}return_active_requests/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#return_active_requests-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}return_active_requests/http-response.adoc[opts=optional] diff --git a/docs/modules/analytics-rest-config/pages/index.adoc b/docs/modules/analytics-rest-config/pages/index.adoc index 6b5a44e9..5ea599a5 100644 --- a/docs/modules/analytics-rest-config/pages/index.adoc +++ b/docs/modules/analytics-rest-config/pages/index.adoc @@ -243,16 +243,16 @@ include::{specDir}paths/get_node/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_node/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_node/curl-request.adoc[opts=optional] include::{snippetDir}get_node/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_node-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_node/http-response.adoc[opts=optional] @@ -381,16 +381,16 @@ include::{specDir}paths/get_service/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_service/curl-request.adoc[opts=optional] include::{snippetDir}get_service/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_service-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_service/http-response.adoc[opts=optional] @@ -478,7 +478,7 @@ a¦ *Body* + optional a¦ [markdown] -- - +An object specifying one or more of the configurable node-level parameters on this node. -- [%hardbreaks] @@ -571,16 +571,16 @@ include::{specDir}paths/put_node/operation-security-end.adoc[opts=optional] include::{specDir}paths/put_node/operation-security-after.adoc[opts=optional] - - include::{snippetDir}put_node/curl-request.adoc[opts=optional] include::{snippetDir}put_node/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#put_node-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}put_node/http-response.adoc[opts=optional] @@ -666,7 +666,7 @@ a¦ *Body* + optional a¦ [markdown] -- - +An object specifying one or more of the configurable service-level parameters. -- [%hardbreaks] @@ -759,16 +759,16 @@ include::{specDir}paths/put_service/operation-security-end.adoc[opts=optional] include::{specDir}paths/put_service/operation-security-after.adoc[opts=optional] - - include::{snippetDir}put_service/curl-request.adoc[opts=optional] include::{snippetDir}put_service/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#put_service-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}put_service/http-response.adoc[opts=optional] diff --git a/docs/modules/analytics-rest-library/pages/index.adoc b/docs/modules/analytics-rest-library/pages/index.adoc index 5b41e366..3c53ecf7 100644 --- a/docs/modules/analytics-rest-library/pages/index.adoc +++ b/docs/modules/analytics-rest-library/pages/index.adoc @@ -296,16 +296,16 @@ include::{specDir}paths/delete_library/operation-security-end.adoc[opts=optional include::{specDir}paths/delete_library/operation-security-after.adoc[opts=optional] - - include::{snippetDir}delete_library/curl-request.adoc[opts=optional] include::{snippetDir}delete_library/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#delete_library-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}delete_library/http-response.adoc[opts=optional] @@ -442,16 +442,16 @@ include::{specDir}paths/get_collection/operation-security-end.adoc[opts=optional include::{specDir}paths/get_collection/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_collection/curl-request.adoc[opts=optional] include::{snippetDir}get_collection/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_collection-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_collection/http-response.adoc[opts=optional] @@ -672,16 +672,16 @@ include::{specDir}paths/post_library/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_library/operation-security-after.adoc[opts=optional] - - include::{snippetDir}post_library/curl-request.adoc[opts=optional] include::{snippetDir}post_library/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#post_library-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}post_library/http-response.adoc[opts=optional] diff --git a/docs/modules/analytics-rest-links/pages/index.adoc b/docs/modules/analytics-rest-links/pages/index.adoc index 878cfe5e..7e71abf8 100644 --- a/docs/modules/analytics-rest-links/pages/index.adoc +++ b/docs/modules/analytics-rest-links/pages/index.adoc @@ -301,16 +301,16 @@ include::{specDir}paths/delete_alt/operation-security-end.adoc[opts=optional] include::{specDir}paths/delete_alt/operation-security-after.adoc[opts=optional] - - include::{snippetDir}delete_alt/curl-request.adoc[opts=optional] include::{snippetDir}delete_alt/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#delete_alt-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}delete_alt/http-response.adoc[opts=optional] @@ -764,16 +764,16 @@ include::{specDir}paths/post_alt/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_alt/operation-security-after.adoc[opts=optional] - - include::{snippetDir}post_alt/curl-request.adoc[opts=optional] include::{snippetDir}post_alt/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#post_alt-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}post_alt/http-response.adoc[opts=optional] @@ -1228,16 +1228,16 @@ include::{specDir}paths/put_alt/operation-security-end.adoc[opts=optional] include::{specDir}paths/put_alt/operation-security-after.adoc[opts=optional] - - include::{snippetDir}put_alt/curl-request.adoc[opts=optional] include::{snippetDir}put_alt/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#put_alt-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}put_alt/http-response.adoc[opts=optional] @@ -1461,16 +1461,16 @@ include::{specDir}paths/get_all/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_all/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_all/curl-request.adoc[opts=optional] include::{snippetDir}get_all/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_all-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_all/http-response.adoc[opts=optional] @@ -1667,16 +1667,16 @@ include::{specDir}paths/get_scope/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_scope/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_scope/curl-request.adoc[opts=optional] include::{snippetDir}get_scope/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_scope-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_scope/http-response.adoc[opts=optional] @@ -1884,16 +1884,16 @@ include::{specDir}paths/delete_link/operation-security-end.adoc[opts=optional] include::{specDir}paths/delete_link/operation-security-after.adoc[opts=optional] - - include::{snippetDir}delete_link/curl-request.adoc[opts=optional] include::{snippetDir}delete_link/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#delete_link-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}delete_link/http-response.adoc[opts=optional] @@ -2101,16 +2101,16 @@ include::{specDir}paths/get_link/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_link/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_link/curl-request.adoc[opts=optional] include::{snippetDir}get_link/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_link-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_link/http-response.adoc[opts=optional] @@ -2575,16 +2575,16 @@ include::{specDir}paths/post_link/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_link/operation-security-after.adoc[opts=optional] - - include::{snippetDir}post_link/curl-request.adoc[opts=optional] include::{snippetDir}post_link/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#post_link-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}post_link/http-response.adoc[opts=optional] @@ -3050,16 +3050,16 @@ include::{specDir}paths/put_link/operation-security-end.adoc[opts=optional] include::{specDir}paths/put_link/operation-security-after.adoc[opts=optional] - - include::{snippetDir}put_link/curl-request.adoc[opts=optional] include::{snippetDir}put_link/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#put_link-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}put_link/http-response.adoc[opts=optional] diff --git a/docs/modules/analytics-rest-service/pages/index.adoc b/docs/modules/analytics-rest-service/pages/index.adoc index 7e8172b3..7421fcb6 100644 --- a/docs/modules/analytics-rest-service/pages/index.adoc +++ b/docs/modules/analytics-rest-service/pages/index.adoc @@ -286,16 +286,16 @@ include::{specDir}paths/get_query/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_query/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_query/curl-request.adoc[opts=optional] include::{snippetDir}get_query/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_query-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_query/http-response.adoc[opts=optional] @@ -470,16 +470,16 @@ include::{specDir}paths/get_service/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_service/curl-request.adoc[opts=optional] include::{snippetDir}get_service/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_service-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_service/http-response.adoc[opts=optional] @@ -560,7 +560,7 @@ a¦ *Body* + required a¦ [markdown] -- - +An object specifying one or more query parameters. -- [%hardbreaks] @@ -637,16 +637,16 @@ include::{specDir}paths/post_query/operation-security-before.adoc[opts=optional] include::{specDir}paths/post_query/operation-security-after.adoc[opts=optional] - - include::{snippetDir}post_query/curl-request.adoc[opts=optional] include::{snippetDir}post_query/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#post_query-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}post_query/http-response.adoc[opts=optional] @@ -728,7 +728,7 @@ a¦ *Body* + required a¦ [markdown] -- - +An object specifying one or more query parameters. -- [%hardbreaks] @@ -823,16 +823,16 @@ include::{specDir}paths/post_service/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_service/operation-security-after.adoc[opts=optional] - - include::{snippetDir}post_service/curl-request.adoc[opts=optional] include::{snippetDir}post_service/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#post_service-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}post_service/http-response.adoc[opts=optional] diff --git a/docs/modules/analytics-rest-settings/pages/index.adoc b/docs/modules/analytics-rest-settings/pages/index.adoc index 6b6d237f..e1312fc7 100644 --- a/docs/modules/analytics-rest-settings/pages/index.adoc +++ b/docs/modules/analytics-rest-settings/pages/index.adoc @@ -242,16 +242,16 @@ include::{specDir}paths/get_settings/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_settings/curl-request.adoc[opts=optional] include::{snippetDir}get_settings/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_settings-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_settings/http-response.adoc[opts=optional] @@ -427,16 +427,16 @@ include::{specDir}paths/post_settings/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optional] - - include::{snippetDir}post_settings/curl-request.adoc[opts=optional] include::{snippetDir}post_settings/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#post_settings-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}post_settings/http-response.adoc[opts=optional] diff --git a/docs/modules/eventing-rest-api/pages/index.adoc b/docs/modules/eventing-rest-api/pages/index.adoc index f1f03d07..e794ed74 100644 --- a/docs/modules/eventing-rest-api/pages/index.adoc +++ b/docs/modules/eventing-rest-api/pages/index.adoc @@ -309,16 +309,16 @@ include::{specDir}paths/basic_deploy/operation-security-end.adoc[opts=optional] include::{specDir}paths/basic_deploy/operation-security-after.adoc[opts=optional] - - include::{snippetDir}basic_deploy/curl-request.adoc[opts=optional] include::{snippetDir}basic_deploy/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#basic_deploy-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}basic_deploy/http-response.adoc[opts=optional] @@ -509,16 +509,16 @@ include::{specDir}paths/basic_pause/operation-security-end.adoc[opts=optional] include::{specDir}paths/basic_pause/operation-security-after.adoc[opts=optional] - - include::{snippetDir}basic_pause/curl-request.adoc[opts=optional] include::{snippetDir}basic_pause/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#basic_pause-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}basic_pause/http-response.adoc[opts=optional] @@ -716,16 +716,16 @@ include::{specDir}paths/basic_resume/operation-security-end.adoc[opts=optional] include::{specDir}paths/basic_resume/operation-security-after.adoc[opts=optional] - - include::{snippetDir}basic_resume/curl-request.adoc[opts=optional] include::{snippetDir}basic_resume/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#basic_resume-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}basic_resume/http-response.adoc[opts=optional] @@ -916,16 +916,16 @@ include::{specDir}paths/basic_undeploy/operation-security-end.adoc[opts=optional include::{specDir}paths/basic_undeploy/operation-security-after.adoc[opts=optional] - - include::{snippetDir}basic_undeploy/curl-request.adoc[opts=optional] include::{snippetDir}basic_undeploy/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#basic_undeploy-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}basic_undeploy/http-response.adoc[opts=optional] @@ -1090,7 +1090,7 @@ 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] @@ -1180,16 +1180,16 @@ include::{specDir}paths/adv_function_import/operation-security-end.adoc[opts=opt include::{specDir}paths/adv_function_import/operation-security-after.adoc[opts=optional] - - include::{snippetDir}adv_function_import/curl-request.adoc[opts=optional] include::{snippetDir}adv_function_import/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#adv_function_import-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}adv_function_import/http-response.adoc[opts=optional] @@ -1268,7 +1268,7 @@ 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] @@ -1353,16 +1353,16 @@ include::{specDir}paths/adv_function_import_all/operation-security-end.adoc[opts include::{specDir}paths/adv_function_import_all/operation-security-after.adoc[opts=optional] - - include::{snippetDir}adv_function_import_all/curl-request.adoc[opts=optional] include::{snippetDir}adv_function_import_all/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#adv_function_import_all-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}adv_function_import_all/http-response.adoc[opts=optional] @@ -1566,16 +1566,16 @@ include::{specDir}paths/adv_function_view/operation-security-end.adoc[opts=optio include::{specDir}paths/adv_function_view/operation-security-after.adoc[opts=optional] - - include::{snippetDir}adv_function_view/curl-request.adoc[opts=optional] include::{snippetDir}adv_function_view/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#adv_function_view-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}adv_function_view/http-response.adoc[opts=optional] @@ -1709,16 +1709,16 @@ include::{specDir}paths/adv_function_view_all/operation-security-end.adoc[opts=o include::{specDir}paths/adv_function_view_all/operation-security-after.adoc[opts=optional] - - include::{snippetDir}adv_function_view_all/curl-request.adoc[opts=optional] include::{snippetDir}adv_function_view_all/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#adv_function_view_all-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}adv_function_view_all/http-response.adoc[opts=optional] @@ -1917,16 +1917,16 @@ include::{specDir}paths/adv_function_zap/operation-security-end.adoc[opts=option include::{specDir}paths/adv_function_zap/operation-security-after.adoc[opts=optional] - - include::{snippetDir}adv_function_zap/curl-request.adoc[opts=optional] include::{snippetDir}adv_function_zap/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#adv_function_zap-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}adv_function_zap/http-response.adoc[opts=optional] @@ -2054,16 +2054,16 @@ include::{specDir}paths/adv_function_zap_all/operation-security-end.adoc[opts=op include::{specDir}paths/adv_function_zap_all/operation-security-after.adoc[opts=optional] - - include::{snippetDir}adv_function_zap_all/curl-request.adoc[opts=optional] include::{snippetDir}adv_function_zap_all/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#adv_function_zap_all-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}adv_function_zap_all/http-response.adoc[opts=optional] @@ -2197,16 +2197,16 @@ include::{specDir}paths/adv_multiple_export/operation-security-end.adoc[opts=opt include::{specDir}paths/adv_multiple_export/operation-security-after.adoc[opts=optional] - - include::{snippetDir}adv_multiple_export/curl-request.adoc[opts=optional] include::{snippetDir}adv_multiple_export/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#adv_multiple_export-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}adv_multiple_export/http-response.adoc[opts=optional] @@ -2285,7 +2285,7 @@ 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] @@ -2370,16 +2370,16 @@ include::{specDir}paths/adv_multiple_import/operation-security-end.adoc[opts=opt include::{specDir}paths/adv_multiple_import/operation-security-after.adoc[opts=optional] - - include::{snippetDir}adv_multiple_import/curl-request.adoc[opts=optional] include::{snippetDir}adv_multiple_import/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#adv_multiple_import-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}adv_multiple_import/http-response.adoc[opts=optional] @@ -2582,16 +2582,16 @@ include::{specDir}paths/adv_settings_get/operation-security-end.adoc[opts=option include::{specDir}paths/adv_settings_get/operation-security-after.adoc[opts=optional] - - include::{snippetDir}adv_settings_get/curl-request.adoc[opts=optional] include::{snippetDir}adv_settings_get/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#adv_settings_get-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}adv_settings_get/http-response.adoc[opts=optional] @@ -2731,7 +2731,7 @@ a¦ *Body* + required a¦ [markdown] -- - +An object providing settings for the specified function. -- [%hardbreaks] @@ -2821,16 +2821,16 @@ include::{specDir}paths/adv_settings_update/operation-security-end.adoc[opts=opt include::{specDir}paths/adv_settings_update/operation-security-after.adoc[opts=optional] - - include::{snippetDir}adv_settings_update/curl-request.adoc[opts=optional] include::{snippetDir}adv_settings_update/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#adv_settings_update-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}adv_settings_update/http-response.adoc[opts=optional] @@ -3033,16 +3033,16 @@ include::{specDir}paths/adv_structure_get/operation-security-end.adoc[opts=optio include::{specDir}paths/adv_structure_get/operation-security-after.adoc[opts=optional] - - include::{snippetDir}adv_structure_get/curl-request.adoc[opts=optional] include::{snippetDir}adv_structure_get/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#adv_structure_get-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}adv_structure_get/http-response.adoc[opts=optional] @@ -3175,7 +3175,7 @@ a¦ *Body* + required a¦ [markdown] -- - +An object providing the configuration for the specified function. -- [%hardbreaks] @@ -3265,16 +3265,16 @@ include::{specDir}paths/adv_structure_update/operation-security-end.adoc[opts=op include::{specDir}paths/adv_structure_update/operation-security-after.adoc[opts=optional] - - include::{snippetDir}adv_structure_update/curl-request.adoc[opts=optional] include::{snippetDir}adv_structure_update/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#adv_structure_update-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}adv_structure_update/http-response.adoc[opts=optional] @@ -3477,16 +3477,16 @@ include::{specDir}paths/adv_text_get/operation-security-end.adoc[opts=optional] include::{specDir}paths/adv_text_get/operation-security-after.adoc[opts=optional] - - include::{snippetDir}adv_text_get/curl-request.adoc[opts=optional] include::{snippetDir}adv_text_get/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#adv_text_get-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}adv_text_get/http-response.adoc[opts=optional] @@ -3620,7 +3620,7 @@ a¦ *Body* + required a¦ [markdown] -- - +A string providing the code for the specified function. -- [%hardbreaks] @@ -3709,16 +3709,16 @@ include::{specDir}paths/adv_text_update/operation-security-end.adoc[opts=optiona include::{specDir}paths/adv_text_update/operation-security-after.adoc[opts=optional] - - include::{snippetDir}adv_text_update/curl-request.adoc[opts=optional] include::{snippetDir}adv_text_update/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#adv_text_update-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}adv_text_update/http-response.adoc[opts=optional] @@ -3869,16 +3869,16 @@ include::{specDir}paths/config_get/operation-security-end.adoc[opts=optional] include::{specDir}paths/config_get/operation-security-after.adoc[opts=optional] - - include::{snippetDir}config_get/curl-request.adoc[opts=optional] include::{snippetDir}config_get/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#config_get-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}config_get/http-response.adoc[opts=optional] @@ -3958,7 +3958,7 @@ a¦ *Body* + required a¦ [markdown] -- - +An object providing the global configuration settings. -- [%hardbreaks] @@ -4043,16 +4043,16 @@ include::{specDir}paths/config_update/operation-security-end.adoc[opts=optional] include::{specDir}paths/config_update/operation-security-after.adoc[opts=optional] - - include::{snippetDir}config_update/curl-request.adoc[opts=optional] include::{snippetDir}config_update/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#config_update-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}config_update/http-response.adoc[opts=optional] @@ -4201,16 +4201,16 @@ include::{specDir}paths/list_all/operation-security-end.adoc[opts=optional] include::{specDir}paths/list_all/operation-security-after.adoc[opts=optional] - - include::{snippetDir}list_all/curl-request.adoc[opts=optional] include::{snippetDir}list_all/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#list_all-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}list_all/http-response.adoc[opts=optional] @@ -4403,16 +4403,16 @@ include::{specDir}paths/list_query/operation-security-end.adoc[opts=optional] include::{specDir}paths/list_query/operation-security-after.adoc[opts=optional] - - include::{snippetDir}list_query/curl-request.adoc[opts=optional] include::{snippetDir}list_query/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#list_query-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}list_query/http-response.adoc[opts=optional] @@ -4645,16 +4645,16 @@ include::{specDir}paths/log_view/operation-security-end.adoc[opts=optional] include::{specDir}paths/log_view/operation-security-after.adoc[opts=optional] - - include::{snippetDir}log_view/curl-request.adoc[opts=optional] include::{snippetDir}log_view/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#log_view-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}log_view/http-response.adoc[opts=optional] @@ -4842,16 +4842,16 @@ include::{specDir}paths/stats_all/operation-security-end.adoc[opts=optional] include::{specDir}paths/stats_all/operation-security-after.adoc[opts=optional] - - include::{snippetDir}stats_all/curl-request.adoc[opts=optional] include::{snippetDir}stats_all/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#stats_all-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}stats_all/http-response.adoc[opts=optional] @@ -5039,16 +5039,16 @@ include::{specDir}paths/stats_execution/operation-security-end.adoc[opts=optiona include::{specDir}paths/stats_execution/operation-security-after.adoc[opts=optional] - - include::{snippetDir}stats_execution/curl-request.adoc[opts=optional] include::{snippetDir}stats_execution/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#stats_execution-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}stats_execution/http-response.adoc[opts=optional] @@ -5236,16 +5236,16 @@ include::{specDir}paths/stats_failure/operation-security-end.adoc[opts=optional] include::{specDir}paths/stats_failure/operation-security-after.adoc[opts=optional] - - include::{snippetDir}stats_failure/curl-request.adoc[opts=optional] include::{snippetDir}stats_failure/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#stats_failure-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}stats_failure/http-response.adoc[opts=optional] @@ -5433,16 +5433,16 @@ include::{specDir}paths/stats_latency/operation-security-end.adoc[opts=optional] include::{specDir}paths/stats_latency/operation-security-after.adoc[opts=optional] - - include::{snippetDir}stats_latency/curl-request.adoc[opts=optional] include::{snippetDir}stats_latency/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#stats_latency-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}stats_latency/http-response.adoc[opts=optional] @@ -5629,16 +5629,16 @@ include::{specDir}paths/stats_reset/operation-security-end.adoc[opts=optional] include::{specDir}paths/stats_reset/operation-security-after.adoc[opts=optional] - - include::{snippetDir}stats_reset/curl-request.adoc[opts=optional] include::{snippetDir}stats_reset/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#stats_reset-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}stats_reset/http-response.adoc[opts=optional] @@ -5788,16 +5788,16 @@ include::{specDir}paths/status_all/operation-security-end.adoc[opts=optional] include::{specDir}paths/status_all/operation-security-after.adoc[opts=optional] - - include::{snippetDir}status_all/curl-request.adoc[opts=optional] include::{snippetDir}status_all/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#status_all-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}status_all/http-response.adoc[opts=optional] @@ -5996,16 +5996,16 @@ include::{specDir}paths/status_function/operation-security-end.adoc[opts=optiona include::{specDir}paths/status_function/operation-security-after.adoc[opts=optional] - - include::{snippetDir}status_function/curl-request.adoc[opts=optional] include::{snippetDir}status_function/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#status_function-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}status_function/http-response.adoc[opts=optional] diff --git a/docs/modules/fts-rest-advanced/pages/index.adoc b/docs/modules/fts-rest-advanced/pages/index.adoc index e7dca7fe..a0fbe4c3 100644 --- a/docs/modules/fts-rest-advanced/pages/index.adoc +++ b/docs/modules/fts-rest-advanced/pages/index.adoc @@ -235,15 +235,20 @@ include::{specDir}paths/getPartition/operation-security-end.adoc[opts=optional] include::{specDir}paths/getPartition/operation-security-after.adoc[opts=optional] - - include::{snippetDir}getPartition/curl-request.adoc[opts=optional] include::{snippetDir}getPartition/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#getPartition-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}getPartition/http-response.adoc[opts=optional] + + [#getPartition-ex-response-200] .Response 200 ==== @@ -271,8 +276,6 @@ include::{snippetDir}getPartition/http-request.adoc[opts=optional] ==== -include::{snippetDir}getPartition/http-response.adoc[opts=optional] - include::{specDir}paths/getPartition/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -420,16 +423,16 @@ include::{specDir}paths/getPartitionName/operation-security-end.adoc[opts=option include::{specDir}paths/getPartitionName/operation-security-after.adoc[opts=optional] - - include::{snippetDir}getPartitionName/curl-request.adoc[opts=optional] include::{snippetDir}getPartitionName/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#getPartitionName-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}getPartitionName/http-response.adoc[opts=optional] @@ -605,16 +608,16 @@ include::{specDir}paths/getPartitionCount/operation-security-end.adoc[opts=optio include::{specDir}paths/getPartitionCount/operation-security-after.adoc[opts=optional] - - include::{snippetDir}getPartitionCount/curl-request.adoc[opts=optional] include::{snippetDir}getPartitionCount/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#getPartitionCount-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}getPartitionCount/http-response.adoc[opts=optional] @@ -715,7 +718,7 @@ 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] @@ -794,16 +797,16 @@ include::{specDir}paths/queryPartition/operation-security-end.adoc[opts=optional include::{specDir}paths/queryPartition/operation-security-after.adoc[opts=optional] - - include::{snippetDir}queryPartition/curl-request.adoc[opts=optional] include::{snippetDir}queryPartition/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#queryPartition-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}queryPartition/http-response.adoc[opts=optional] @@ -978,16 +981,16 @@ include::{specDir}paths/setFtsMemoryQuota/operation-security-end.adoc[opts=optio include::{specDir}paths/setFtsMemoryQuota/operation-security-after.adoc[opts=optional] - - include::{snippetDir}setFtsMemoryQuota/curl-request.adoc[opts=optional] include::{snippetDir}setFtsMemoryQuota/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#setFtsMemoryQuota-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}setFtsMemoryQuota/http-response.adoc[opts=optional] diff --git a/docs/modules/fts-rest-indexing/pages/index.adoc b/docs/modules/fts-rest-indexing/pages/index.adoc index 25da503c..113402b1 100644 --- a/docs/modules/fts-rest-indexing/pages/index.adoc +++ b/docs/modules/fts-rest-indexing/pages/index.adoc @@ -244,7 +244,7 @@ The Search Service returns a response that includes the status `ok`. -- a| xref:DeleteIndexResponse[] -| 0 +| Default a| [markdown] -- The Search Service returns a non-200 HTTP error code when a request fails. @@ -288,15 +288,20 @@ include::{specDir}paths/d-api-index-name/operation-security-end.adoc[opts=option include::{specDir}paths/d-api-index-name/operation-security-after.adoc[opts=optional] - - include::{snippetDir}d-api-index-name/curl-request.adoc[opts=optional] include::{snippetDir}d-api-index-name/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yesyes" != ""] +[#d-api-index-name-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}d-api-index-name/http-response.adoc[opts=optional] + + [#d-api-index-name-ex-response-200] .Response 200 ==== @@ -308,8 +313,11 @@ include::{snippetDir}d-api-index-name/http-request.adoc[opts=optional] } ---- ==== + + + [#d-api-index-name-ex-response-0] -.Response 0 +.Default Response ==== [source,json] ---- @@ -322,8 +330,6 @@ include::{snippetDir}d-api-index-name/http-request.adoc[opts=optional] ==== -include::{snippetDir}d-api-index-name/http-response.adoc[opts=optional] - include::{specDir}paths/d-api-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -462,7 +468,7 @@ A JSON object indicating the status of the operation. -- a| xref:DeleteIndexResponse[] -| 0 +| Default a| [markdown] -- The Search Service returns a non-200 HTTP error code when a request fails. @@ -506,15 +512,20 @@ include::{specDir}paths/d-api-scoped-index-name/operation-security-end.adoc[opts include::{specDir}paths/d-api-scoped-index-name/operation-security-after.adoc[opts=optional] - - include::{snippetDir}d-api-scoped-index-name/curl-request.adoc[opts=optional] include::{snippetDir}d-api-scoped-index-name/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yesyes" != ""] +[#d-api-scoped-index-name-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}d-api-scoped-index-name/http-response.adoc[opts=optional] + + [#d-api-scoped-index-name-ex-response-200] .Response 200 ==== @@ -526,8 +537,11 @@ include::{snippetDir}d-api-scoped-index-name/http-request.adoc[opts=optional] } ---- ==== + + + [#d-api-scoped-index-name-ex-response-0] -.Response 0 +.Default Response ==== [source,json] ---- @@ -540,8 +554,6 @@ include::{snippetDir}d-api-scoped-index-name/http-request.adoc[opts=optional] ==== -include::{snippetDir}d-api-scoped-index-name/http-response.adoc[opts=optional] - include::{specDir}paths/d-api-scoped-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -660,15 +672,20 @@ include::{specDir}paths/g-api-index/operation-security-end.adoc[opts=optional] include::{specDir}paths/g-api-index/operation-security-after.adoc[opts=optional] - - include::{snippetDir}g-api-index/curl-request.adoc[opts=optional] include::{snippetDir}g-api-index/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#g-api-index-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}g-api-index/http-response.adoc[opts=optional] + + [#g-api-index-ex-response-200] .Response 200 ==== @@ -704,8 +721,6 @@ include::{snippetDir}g-api-index/http-request.adoc[opts=optional] ==== -include::{snippetDir}g-api-index/http-response.adoc[opts=optional] - include::{specDir}paths/g-api-index/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -863,15 +878,20 @@ include::{specDir}paths/g-api-index-name/operation-security-end.adoc[opts=option include::{specDir}paths/g-api-index-name/operation-security-after.adoc[opts=optional] - - include::{snippetDir}g-api-index-name/curl-request.adoc[opts=optional] include::{snippetDir}g-api-index-name/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#g-api-index-name-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}g-api-index-name/http-response.adoc[opts=optional] + + [#g-api-index-name-ex-response-200] .Response 200 ==== @@ -922,8 +942,6 @@ include::{snippetDir}g-api-index-name/http-request.adoc[opts=optional] ==== -include::{snippetDir}g-api-index-name/http-response.adoc[opts=optional] - include::{specDir}paths/g-api-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -1086,15 +1104,20 @@ include::{specDir}paths/g-api-scoped-index/operation-security-end.adoc[opts=opti include::{specDir}paths/g-api-scoped-index/operation-security-after.adoc[opts=optional] - - include::{snippetDir}g-api-scoped-index/curl-request.adoc[opts=optional] include::{snippetDir}g-api-scoped-index/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#g-api-scoped-index-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}g-api-scoped-index/http-response.adoc[opts=optional] + + [#g-api-scoped-index-ex-response-200] .Response 200 ==== @@ -1220,8 +1243,6 @@ include::{snippetDir}g-api-scoped-index/http-request.adoc[opts=optional] ==== -include::{snippetDir}g-api-scoped-index/http-response.adoc[opts=optional] - include::{specDir}paths/g-api-scoped-index/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -1397,15 +1418,20 @@ include::{specDir}paths/g-api-scoped-index-name/operation-security-end.adoc[opts include::{specDir}paths/g-api-scoped-index-name/operation-security-after.adoc[opts=optional] - - include::{snippetDir}g-api-scoped-index-name/curl-request.adoc[opts=optional] include::{snippetDir}g-api-scoped-index-name/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#g-api-scoped-index-name-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}g-api-scoped-index-name/http-response.adoc[opts=optional] + + [#g-api-scoped-index-name-ex-response-200] .Response 200 ==== @@ -1572,8 +1598,6 @@ include::{snippetDir}g-api-scoped-index-name/http-request.adoc[opts=optional] ==== -include::{snippetDir}g-api-scoped-index-name/http-response.adoc[opts=optional] - include::{specDir}paths/g-api-scoped-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -1678,7 +1702,7 @@ 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] @@ -1720,7 +1744,7 @@ A JSON object indicating the status of the operation. -- a| xref:PutIndexResponse[] -| 0 +| Default a| [markdown] -- The Search Service returns a non-200 HTTP error code when a request fails. @@ -1764,15 +1788,20 @@ include::{specDir}paths/p-api-index-name/operation-security-end.adoc[opts=option include::{specDir}paths/p-api-index-name/operation-security-after.adoc[opts=optional] - - include::{snippetDir}p-api-index-name/curl-request.adoc[opts=optional] include::{snippetDir}p-api-index-name/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yesyes" != ""] +[#p-api-index-name-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}p-api-index-name/http-response.adoc[opts=optional] + + [#p-api-index-name-ex-response-200] .Response 200 ==== @@ -1785,8 +1814,11 @@ include::{snippetDir}p-api-index-name/http-request.adoc[opts=optional] } ---- ==== + + + [#p-api-index-name-ex-response-0] -.Response 0 +.Default Response ==== [source,json] ---- @@ -1799,8 +1831,6 @@ include::{snippetDir}p-api-index-name/http-request.adoc[opts=optional] ==== -include::{snippetDir}p-api-index-name/http-response.adoc[opts=optional] - include::{specDir}paths/p-api-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -1923,7 +1953,7 @@ 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] @@ -1965,7 +1995,7 @@ A JSON object indicating the status of the operation. -- a| xref:PutIndexResponse[] -| 0 +| Default a| [markdown] -- The Search Service returns a non-200 HTTP error code when a request fails. @@ -2009,15 +2039,20 @@ include::{specDir}paths/p-api-scoped-index-name/operation-security-end.adoc[opts include::{specDir}paths/p-api-scoped-index-name/operation-security-after.adoc[opts=optional] - - include::{snippetDir}p-api-scoped-index-name/curl-request.adoc[opts=optional] include::{snippetDir}p-api-scoped-index-name/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yesyes" != ""] +[#p-api-scoped-index-name-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}p-api-scoped-index-name/http-response.adoc[opts=optional] + + [#p-api-scoped-index-name-ex-response-200] .Response 200 ==== @@ -2030,8 +2065,11 @@ include::{snippetDir}p-api-scoped-index-name/http-request.adoc[opts=optional] } ---- ==== + + + [#p-api-scoped-index-name-ex-response-0] -.Response 0 +.Default Response ==== [source,json] ---- @@ -2044,8 +2082,6 @@ include::{snippetDir}p-api-scoped-index-name/http-request.adoc[opts=optional] ==== -include::{snippetDir}p-api-scoped-index-name/http-response.adoc[opts=optional] - include::{specDir}paths/p-api-scoped-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -2242,15 +2278,20 @@ include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-end.adoc include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-security-after.adoc[opts=optional] - - include::{snippetDir}p-api-idx-name-ingestcontrol/curl-request.adoc[opts=optional] include::{snippetDir}p-api-idx-name-ingestcontrol/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#p-api-idx-name-ingestcontrol-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}p-api-idx-name-ingestcontrol/http-response.adoc[opts=optional] + + [#p-api-idx-name-ingestcontrol-ex-response-200] .Response 200 ==== @@ -2263,8 +2304,6 @@ include::{snippetDir}p-api-idx-name-ingestcontrol/http-request.adoc[opts=optiona ==== -include::{snippetDir}p-api-idx-name-ingestcontrol/http-response.adoc[opts=optional] - include::{specDir}paths/p-api-idx-name-ingestcontrol/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -2436,15 +2475,20 @@ include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-end. include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-security-after.adoc[opts=optional] - - include::{snippetDir}p-api-idx-name-planfreezecontrol/curl-request.adoc[opts=optional] include::{snippetDir}p-api-idx-name-planfreezecontrol/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#p-api-idx-name-planfreezecontrol-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}p-api-idx-name-planfreezecontrol/http-response.adoc[opts=optional] + + [#p-api-idx-name-planfreezecontrol-ex-response-200] .Response 200 ==== @@ -2457,8 +2501,6 @@ include::{snippetDir}p-api-idx-name-planfreezecontrol/http-request.adoc[opts=opt ==== -include::{snippetDir}p-api-idx-name-planfreezecontrol/http-response.adoc[opts=optional] - include::{specDir}paths/p-api-idx-name-planfreezecontrol/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -2630,15 +2672,20 @@ include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-end.adoc[ include::{specDir}paths/p-api-idx-name-querycontrol/operation-security-after.adoc[opts=optional] - - include::{snippetDir}p-api-idx-name-querycontrol/curl-request.adoc[opts=optional] include::{snippetDir}p-api-idx-name-querycontrol/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#p-api-idx-name-querycontrol-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}p-api-idx-name-querycontrol/http-response.adoc[opts=optional] + + [#p-api-idx-name-querycontrol-ex-response-200] .Response 200 ==== @@ -2651,8 +2698,6 @@ include::{snippetDir}p-api-idx-name-querycontrol/http-request.adoc[opts=optional ==== -include::{snippetDir}p-api-idx-name-querycontrol/http-response.adoc[opts=optional] - include::{specDir}paths/p-api-idx-name-querycontrol/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -2842,15 +2887,20 @@ include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-end.adoc[o include::{specDir}paths/p-api-scoped-ingestcontrol/operation-security-after.adoc[opts=optional] - - include::{snippetDir}p-api-scoped-ingestcontrol/curl-request.adoc[opts=optional] include::{snippetDir}p-api-scoped-ingestcontrol/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#p-api-scoped-ingestcontrol-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}p-api-scoped-ingestcontrol/http-response.adoc[opts=optional] + + [#p-api-scoped-ingestcontrol-ex-response-200] .Response 200 ==== @@ -2863,8 +2913,6 @@ include::{snippetDir}p-api-scoped-ingestcontrol/http-request.adoc[opts=optional] ==== -include::{snippetDir}p-api-scoped-ingestcontrol/http-response.adoc[opts=optional] - include::{specDir}paths/p-api-scoped-ingestcontrol/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -3054,15 +3102,20 @@ include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-end.ad include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-security-after.adoc[opts=optional] - - include::{snippetDir}p-api-scoped-planfreezecontrol/curl-request.adoc[opts=optional] include::{snippetDir}p-api-scoped-planfreezecontrol/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#p-api-scoped-planfreezecontrol-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}p-api-scoped-planfreezecontrol/http-response.adoc[opts=optional] + + [#p-api-scoped-planfreezecontrol-ex-response-200] .Response 200 ==== @@ -3075,8 +3128,6 @@ include::{snippetDir}p-api-scoped-planfreezecontrol/http-request.adoc[opts=optio ==== -include::{snippetDir}p-api-scoped-planfreezecontrol/http-response.adoc[opts=optional] - include::{specDir}paths/p-api-scoped-planfreezecontrol/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -3266,15 +3317,20 @@ include::{specDir}paths/p-api-scoped-querycontrol/operation-security-end.adoc[op include::{specDir}paths/p-api-scoped-querycontrol/operation-security-after.adoc[opts=optional] - - include::{snippetDir}p-api-scoped-querycontrol/curl-request.adoc[opts=optional] include::{snippetDir}p-api-scoped-querycontrol/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#p-api-scoped-querycontrol-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}p-api-scoped-querycontrol/http-response.adoc[opts=optional] + + [#p-api-scoped-querycontrol-ex-response-200] .Response 200 ==== @@ -3287,8 +3343,6 @@ include::{snippetDir}p-api-scoped-querycontrol/http-request.adoc[opts=optional] ==== -include::{snippetDir}p-api-scoped-querycontrol/http-response.adoc[opts=optional] - include::{specDir}paths/p-api-scoped-querycontrol/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -3487,15 +3541,20 @@ include::{specDir}paths/g-api-scoped-status/operation-security-end.adoc[opts=opt include::{specDir}paths/g-api-scoped-status/operation-security-after.adoc[opts=optional] - - include::{snippetDir}g-api-scoped-status/curl-request.adoc[opts=optional] include::{snippetDir}g-api-scoped-status/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#g-api-scoped-status-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}g-api-scoped-status/http-response.adoc[opts=optional] + + [#g-api-scoped-status-ex-response-200] .Response 200 ==== @@ -3509,8 +3568,6 @@ include::{snippetDir}g-api-scoped-status/http-request.adoc[opts=optional] ==== -include::{snippetDir}g-api-scoped-status/http-response.adoc[opts=optional] - include::{specDir}paths/g-api-scoped-status/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -3632,15 +3689,20 @@ include::{specDir}paths/g-api-stats/operation-security-end.adoc[opts=optional] include::{specDir}paths/g-api-stats/operation-security-after.adoc[opts=optional] - - include::{snippetDir}g-api-stats/curl-request.adoc[opts=optional] include::{snippetDir}g-api-stats/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#g-api-stats-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}g-api-stats/http-response.adoc[opts=optional] + + [#g-api-stats-ex-response-200] .Response 200 ==== @@ -3691,8 +3753,6 @@ include::{snippetDir}g-api-stats/http-request.adoc[opts=optional] ==== -include::{snippetDir}g-api-stats/http-response.adoc[opts=optional] - include::{specDir}paths/g-api-stats/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -3853,15 +3913,20 @@ include::{specDir}paths/g-api-stats-index-name/operation-security-end.adoc[opts= include::{specDir}paths/g-api-stats-index-name/operation-security-after.adoc[opts=optional] - - include::{snippetDir}g-api-stats-index-name/curl-request.adoc[opts=optional] include::{snippetDir}g-api-stats-index-name/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#g-api-stats-index-name-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}g-api-stats-index-name/http-response.adoc[opts=optional] + + [#g-api-stats-index-name-ex-response-200] .Response 200 ==== @@ -4030,8 +4095,6 @@ include::{snippetDir}g-api-stats-index-name/http-request.adoc[opts=optional] ==== -include::{snippetDir}g-api-stats-index-name/http-response.adoc[opts=optional] - include::{specDir}paths/g-api-stats-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -4136,7 +4199,7 @@ a¦ *Body* + required a¦ [markdown] -- - +Add any valid JSON document to the request body. -- [%hardbreaks] @@ -4215,13 +4278,15 @@ include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-end include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-security-after.adoc[opts=optional] +include::{snippetDir}g-api-stats-index-name-analyzeDoc/curl-request.adoc[opts=optional] -include::{snippetDir}g-api-stats-index-name-analyzeDoc/curl-request.adoc[opts=optional] [#g-api-stats-index-name-analyzeDoc-ex-request] = Example Request Body +include::{snippetDir}g-api-stats-index-name-analyzeDoc/http-request.adoc[opts=optional] + ==== [source,json] ---- @@ -4233,9 +4298,14 @@ include::{snippetDir}g-api-stats-index-name-analyzeDoc/curl-request.adoc[opts=op ==== -include::{snippetDir}g-api-stats-index-name-analyzeDoc/http-request.adoc[opts=optional] +ifeval::["yes" != ""] +[#g-api-stats-index-name-analyzeDoc-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}g-api-stats-index-name-analyzeDoc/http-response.adoc[opts=optional] + -// FIXME: Response examples [#g-api-stats-index-name-analyzeDoc-ex-response-200] .Response 200 ==== @@ -4341,8 +4411,6 @@ include::{snippetDir}g-api-stats-index-name-analyzeDoc/http-request.adoc[opts=op ==== -include::{snippetDir}g-api-stats-index-name-analyzeDoc/http-response.adoc[opts=optional] - include::{specDir}paths/g-api-stats-index-name-analyzeDoc/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -4524,15 +4592,20 @@ include::{specDir}paths/g-api-index-name-count/operation-security-end.adoc[opts= include::{specDir}paths/g-api-index-name-count/operation-security-after.adoc[opts=optional] - - include::{snippetDir}g-api-index-name-count/curl-request.adoc[opts=optional] include::{snippetDir}g-api-index-name-count/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#g-api-index-name-count-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}g-api-index-name-count/http-response.adoc[opts=optional] + + [#g-api-index-name-count-ex-response-200] .Response 200 ==== @@ -4546,8 +4619,6 @@ include::{snippetDir}g-api-index-name-count/http-request.adoc[opts=optional] ==== -include::{snippetDir}g-api-index-name-count/http-response.adoc[opts=optional] - include::{specDir}paths/g-api-index-name-count/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -4653,7 +4724,7 @@ 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] @@ -4732,15 +4803,17 @@ include::{specDir}paths/p-api-index-name-query/operation-security-end.adoc[opts= include::{specDir}paths/p-api-index-name-query/operation-security-after.adoc[opts=optional] +include::{snippetDir}p-api-index-name-query/curl-request.adoc[opts=optional] -include::{snippetDir}p-api-index-name-query/curl-request.adoc[opts=optional] [#p-api-index-name-query-ex-request] = Example Request Body +include::{snippetDir}p-api-index-name-query/http-request.adoc[opts=optional] + ==== -[#p-api-index-name-query-ex-request-regular-query] +[#p-api-index-name-query-ex-request-0] .Regular Query [source,json] ---- @@ -4758,7 +4831,8 @@ include::{snippetDir}p-api-index-name-query/curl-request.adoc[opts=optional] } ---- -[#p-api-index-name-query-ex-request-query-with-options] + +[#p-api-index-name-query-ex-request-1] .Query with Options [source,json] ---- @@ -4791,7 +4865,8 @@ include::{snippetDir}p-api-index-name-query/curl-request.adoc[opts=optional] } ---- -[#p-api-index-name-query-ex-request-hybrid-query] + +[#p-api-index-name-query-ex-request-2] .Hybrid Query [source,json] ---- @@ -4815,11 +4890,10 @@ include::{snippetDir}p-api-index-name-query/curl-request.adoc[opts=optional] ==== - -include::{snippetDir}p-api-index-name-query/http-request.adoc[opts=optional] - -// FIXME: Response examples - +ifeval::["" != ""] +[#p-api-index-name-query-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}p-api-index-name-query/http-response.adoc[opts=optional] @@ -4945,7 +5019,7 @@ 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] @@ -5024,13 +5098,15 @@ include::{specDir}paths/p-api-pindex-lookup/operation-security-end.adoc[opts=opt include::{specDir}paths/p-api-pindex-lookup/operation-security-after.adoc[opts=optional] +include::{snippetDir}p-api-pindex-lookup/curl-request.adoc[opts=optional] -include::{snippetDir}p-api-pindex-lookup/curl-request.adoc[opts=optional] [#p-api-pindex-lookup-ex-request] = Example Request Body +include::{snippetDir}p-api-pindex-lookup/http-request.adoc[opts=optional] + ==== [source,json] ---- @@ -5041,9 +5117,14 @@ include::{snippetDir}p-api-pindex-lookup/curl-request.adoc[opts=optional] ==== -include::{snippetDir}p-api-pindex-lookup/http-request.adoc[opts=optional] +ifeval::["yes" != ""] +[#p-api-pindex-lookup-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}p-api-pindex-lookup/http-response.adoc[opts=optional] + -// FIXME: Response examples [#p-api-pindex-lookup-ex-response-200] .Response 200 ==== @@ -5061,8 +5142,6 @@ include::{snippetDir}p-api-pindex-lookup/http-request.adoc[opts=optional] ==== -include::{snippetDir}p-api-pindex-lookup/http-response.adoc[opts=optional] - include::{specDir}paths/p-api-pindex-lookup/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -5186,7 +5265,7 @@ 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] @@ -5228,7 +5307,7 @@ The response object has a status section that must be checked for every request. -- a| xref:QueryResponse[] -| 0 +| Default a| [markdown] -- The Search Service returns a non-200 HTTP error code when a request fails. @@ -5272,19 +5351,23 @@ include::{specDir}paths/p-api-scoped-query/operation-security-end.adoc[opts=opti include::{specDir}paths/p-api-scoped-query/operation-security-after.adoc[opts=optional] - - include::{snippetDir}p-api-scoped-query/curl-request.adoc[opts=optional] include::{snippetDir}p-api-scoped-query/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yesyesyes" != ""] +[#p-api-scoped-query-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}p-api-scoped-query/http-response.adoc[opts=optional] + [#p-api-scoped-query-ex-response-200] .Response 200 ==== -[#p-api-scoped-query-ex-response-200-success-response-for-a-regular-query] +[#p-api-scoped-query-ex-response-200-0] .Success Response for a Regular Query [source,json] ---- @@ -5475,7 +5558,8 @@ include::{snippetDir}p-api-scoped-query/http-request.adoc[opts=optional] } ---- -[#p-api-scoped-query-ex-response-200-success-response-for-a-hybrid-query] + +[#p-api-scoped-query-ex-response-200-1] .Success Response for a Hybrid Query [source,json] ---- @@ -5522,8 +5606,10 @@ include::{snippetDir}p-api-scoped-query/http-request.adoc[opts=optional] ---- ==== + + [#p-api-scoped-query-ex-response-0] -.Response 0 +.Default Response ==== [source,json] ---- @@ -5571,8 +5657,6 @@ include::{snippetDir}p-api-scoped-query/http-request.adoc[opts=optional] ==== -include::{snippetDir}p-api-scoped-query/http-response.adoc[opts=optional] - include::{specDir}paths/p-api-scoped-query/operation-end.adoc[opts=optional] :leveloffset: -1 diff --git a/docs/modules/fts-rest-manage/pages/index.adoc b/docs/modules/fts-rest-manage/pages/index.adoc index 26d73b77..7efaf9c3 100644 --- a/docs/modules/fts-rest-manage/pages/index.adoc +++ b/docs/modules/fts-rest-manage/pages/index.adoc @@ -191,7 +191,7 @@ a¦ *Body* + optional a¦ [markdown] -- - +An object specifying Search manager options. -- [%hardbreaks] @@ -297,8 +297,10 @@ include::{specDir}paths/put_options/operation-security-after.adoc[opts=optional] [#put_options-ex-curl] = Example HTTP Request +include::{snippetDir}put_options/curl-request.adoc[opts=optional] + ==== -[#put_options-ex-curl-disable] +[#put_options-ex-curl-0] .Disable [source,sh] ---- @@ -308,7 +310,7 @@ curl -X PUT http://$HOST:8094/api/managerOptions \ -d '{"disableFileTransferRebalance": "true" }' ---- -[#put_options-ex-curl-enable] +[#put_options-ex-curl-1] .Enable [source,sh] ---- @@ -321,13 +323,16 @@ curl -X PUT http://$HOST:8094/api/managerOptions \ -include::{snippetDir}put_options/curl-request.adoc[opts=optional] +include::{snippetDir}put_options/http-request.adoc[opts=optional] +ifeval::["yesyes" != ""] +[#put_options-ex-response] += Example HTTP Response +endif::[] +include::{snippetDir}put_options/http-response.adoc[opts=optional] -include::{snippetDir}put_options/http-request.adoc[opts=optional] -// FIXME: Response examples [#put_options-ex-response-200] .Response 200 ==== @@ -338,6 +343,9 @@ include::{snippetDir}put_options/http-request.adoc[opts=optional] } ---- ==== + + + [#put_options-ex-response-405] .Response 405 ==== @@ -351,8 +359,6 @@ include::{snippetDir}put_options/http-request.adoc[opts=optional] ==== -include::{snippetDir}put_options/http-response.adoc[opts=optional] - include::{specDir}paths/put_options/operation-end.adoc[opts=optional] :leveloffset: -1 diff --git a/docs/modules/fts-rest-nodes/pages/index.adoc b/docs/modules/fts-rest-nodes/pages/index.adoc index bf7a7be8..98912015 100644 --- a/docs/modules/fts-rest-nodes/pages/index.adoc +++ b/docs/modules/fts-rest-nodes/pages/index.adoc @@ -238,15 +238,20 @@ include::{specDir}paths/getClusterConfig/operation-security-end.adoc[opts=option include::{specDir}paths/getClusterConfig/operation-security-after.adoc[opts=optional] - - include::{snippetDir}getClusterConfig/curl-request.adoc[opts=optional] include::{snippetDir}getClusterConfig/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#getClusterConfig-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}getClusterConfig/http-response.adoc[opts=optional] + + [#getClusterConfig-ex-response-200] .Response 200 ==== @@ -349,8 +354,6 @@ include::{snippetDir}getClusterConfig/http-request.adoc[opts=optional] ==== -include::{snippetDir}getClusterConfig/http-response.adoc[opts=optional] - include::{specDir}paths/getClusterConfig/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -465,16 +468,16 @@ include::{specDir}paths/managerKick/operation-security-end.adoc[opts=optional] include::{specDir}paths/managerKick/operation-security-after.adoc[opts=optional] - - include::{snippetDir}managerKick/curl-request.adoc[opts=optional] include::{snippetDir}managerKick/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#managerKick-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}managerKick/http-response.adoc[opts=optional] @@ -596,16 +599,16 @@ include::{specDir}paths/managerMeta/operation-security-end.adoc[opts=optional] include::{specDir}paths/managerMeta/operation-security-after.adoc[opts=optional] - - include::{snippetDir}managerMeta/curl-request.adoc[opts=optional] include::{snippetDir}managerMeta/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#managerMeta-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}managerMeta/http-response.adoc[opts=optional] @@ -723,16 +726,16 @@ include::{specDir}paths/refreshClusterConfig/operation-security-end.adoc[opts=op include::{specDir}paths/refreshClusterConfig/operation-security-after.adoc[opts=optional] - - include::{snippetDir}refreshClusterConfig/curl-request.adoc[opts=optional] include::{snippetDir}refreshClusterConfig/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#refreshClusterConfig-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}refreshClusterConfig/http-response.adoc[opts=optional] @@ -875,16 +878,16 @@ include::{specDir}paths/captureCpuProfile/operation-security-end.adoc[opts=optio include::{specDir}paths/captureCpuProfile/operation-security-after.adoc[opts=optional] - - include::{snippetDir}captureCpuProfile/curl-request.adoc[opts=optional] include::{snippetDir}captureCpuProfile/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#captureCpuProfile-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}captureCpuProfile/http-response.adoc[opts=optional] @@ -1002,16 +1005,16 @@ include::{specDir}paths/captureMemoryProfile/operation-security-end.adoc[opts=op include::{specDir}paths/captureMemoryProfile/operation-security-after.adoc[opts=optional] - - include::{snippetDir}captureMemoryProfile/curl-request.adoc[opts=optional] include::{snippetDir}captureMemoryProfile/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#captureMemoryProfile-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}captureMemoryProfile/http-response.adoc[opts=optional] @@ -1145,16 +1148,16 @@ include::{specDir}paths/getDiagnostics/operation-security-end.adoc[opts=optional include::{specDir}paths/getDiagnostics/operation-security-after.adoc[opts=optional] - - include::{snippetDir}getDiagnostics/curl-request.adoc[opts=optional] include::{snippetDir}getDiagnostics/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#getDiagnostics-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}getDiagnostics/http-response.adoc[opts=optional] @@ -1276,15 +1279,20 @@ include::{specDir}paths/getLogs/operation-security-end.adoc[opts=optional] include::{specDir}paths/getLogs/operation-security-after.adoc[opts=optional] - - include::{snippetDir}getLogs/curl-request.adoc[opts=optional] include::{snippetDir}getLogs/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#getLogs-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}getLogs/http-response.adoc[opts=optional] + + [#getLogs-ex-response-200] .Response 200 ==== @@ -1298,8 +1306,6 @@ include::{snippetDir}getLogs/http-request.adoc[opts=optional] ==== -include::{snippetDir}getLogs/http-response.adoc[opts=optional] - include::{specDir}paths/getLogs/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -1417,16 +1423,16 @@ include::{specDir}paths/getRuntimeArgs/operation-security-end.adoc[opts=optional include::{specDir}paths/getRuntimeArgs/operation-security-after.adoc[opts=optional] - - include::{snippetDir}getRuntimeArgs/curl-request.adoc[opts=optional] include::{snippetDir}getRuntimeArgs/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#getRuntimeArgs-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}getRuntimeArgs/http-response.adoc[opts=optional] @@ -1548,15 +1554,20 @@ include::{specDir}paths/getRuntimeInfo/operation-security-end.adoc[opts=optional include::{specDir}paths/getRuntimeInfo/operation-security-after.adoc[opts=optional] - - include::{snippetDir}getRuntimeInfo/curl-request.adoc[opts=optional] include::{snippetDir}getRuntimeInfo/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#getRuntimeInfo-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}getRuntimeInfo/http-response.adoc[opts=optional] + + [#getRuntimeInfo-ex-response-200] .Response 200 ==== @@ -1579,8 +1590,6 @@ include::{snippetDir}getRuntimeInfo/http-request.adoc[opts=optional] ==== -include::{snippetDir}getRuntimeInfo/http-response.adoc[opts=optional] - include::{specDir}paths/getRuntimeInfo/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -1715,16 +1724,16 @@ include::{specDir}paths/performGC/operation-security-end.adoc[opts=optional] include::{specDir}paths/performGC/operation-security-after.adoc[opts=optional] - - include::{snippetDir}performGC/curl-request.adoc[opts=optional] include::{snippetDir}performGC/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#performGC-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}performGC/http-response.adoc[opts=optional] @@ -1866,16 +1875,16 @@ include::{specDir}paths/getMemoryStats/operation-security-end.adoc[opts=optional include::{specDir}paths/getMemoryStats/operation-security-after.adoc[opts=optional] - - include::{snippetDir}getMemoryStats/curl-request.adoc[opts=optional] include::{snippetDir}getMemoryStats/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#getMemoryStats-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}getMemoryStats/http-response.adoc[opts=optional] @@ -1996,16 +2005,16 @@ include::{specDir}paths/getRuntimeStats/operation-security-end.adoc[opts=optiona include::{specDir}paths/getRuntimeStats/operation-security-after.adoc[opts=optional] - - include::{snippetDir}getRuntimeStats/curl-request.adoc[opts=optional] include::{snippetDir}getRuntimeStats/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#getRuntimeStats-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}getRuntimeStats/http-response.adoc[opts=optional] diff --git a/docs/modules/fts-rest-query/pages/index.adoc b/docs/modules/fts-rest-query/pages/index.adoc index a30c4b63..5cf280a7 100644 --- a/docs/modules/fts-rest-query/pages/index.adoc +++ b/docs/modules/fts-rest-query/pages/index.adoc @@ -273,8 +273,10 @@ include::{specDir}paths/api-query/operation-security-after.adoc[opts=optional] [#api-query-ex-curl] = Example HTTP Request +include::{snippetDir}api-query/curl-request.adoc[opts=optional] + ==== -[#api-query-ex-curl-all] +[#api-query-ex-curl-0] .All [source,sh] ---- @@ -283,7 +285,7 @@ curl -XGET -H "Content-Type: application/json" \ "http://$HOST:8094/api/query" ---- -[#api-query-ex-curl-filtered] +[#api-query-ex-curl-1] .Filtered [source,sh] ---- @@ -295,17 +297,19 @@ curl -XGET -H "Content-Type: application/json" \ -include::{snippetDir}api-query/curl-request.adoc[opts=optional] - +include::{snippetDir}api-query/http-request.adoc[opts=optional] +ifeval::["yesyes" != ""] +[#api-query-ex-response] += Example HTTP Response +endif::[] -include::{snippetDir}api-query/http-request.adoc[opts=optional] +include::{snippetDir}api-query/http-response.adoc[opts=optional] -// FIXME: Response examples [#api-query-ex-response-200] .Response 200 ==== -[#api-query-ex-response-200-all-active-node-queries] +[#api-query-ex-response-200-0] .All active node queries [source,json] ---- @@ -372,7 +376,8 @@ include::{snippetDir}api-query/http-request.adoc[opts=optional] } ---- -[#api-query-ex-response-200-all-active-node-queries-filtered] + +[#api-query-ex-response-200-1] .All active node queries (filtered) [source,json] ---- @@ -406,9 +411,6 @@ include::{snippetDir}api-query/http-request.adoc[opts=optional] ==== - -include::{snippetDir}api-query/http-response.adoc[opts=optional] - include::{specDir}paths/api-query/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -508,7 +510,7 @@ 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] @@ -590,8 +592,9 @@ include::{specDir}paths/api-query-cancel/operation-security-after.adoc[opts=opti [#api-query-cancel-ex-curl] = Example HTTP Request -==== +include::{snippetDir}api-query-cancel/curl-request.adoc[opts=optional] +==== [source,sh] ---- curl -X POST -H "Content-Type: application/json" -u $USER:$PASSWORD \ @@ -602,11 +605,11 @@ curl -X POST -H "Content-Type: application/json" -u $USER:$PASSWORD \ -include::{snippetDir}api-query-cancel/curl-request.adoc[opts=optional] - [#api-query-cancel-ex-request] = Example Request Body +include::{snippetDir}api-query-cancel/http-request.adoc[opts=optional] + ==== [source,json] ---- @@ -617,9 +620,14 @@ include::{snippetDir}api-query-cancel/curl-request.adoc[opts=optional] ==== -include::{snippetDir}api-query-cancel/http-request.adoc[opts=optional] +ifeval::["yes" != ""] +[#api-query-cancel-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}api-query-cancel/http-response.adoc[opts=optional] + -// FIXME: Response examples [#api-query-cancel-ex-response-200] .Response 200 ==== @@ -633,8 +641,6 @@ include::{snippetDir}api-query-cancel/http-request.adoc[opts=optional] ==== -include::{snippetDir}api-query-cancel/http-response.adoc[opts=optional] - include::{specDir}paths/api-query-cancel/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -813,8 +819,9 @@ include::{specDir}paths/api-query-index/operation-security-after.adoc[opts=optio [#api-query-index-ex-curl] = Example HTTP Request -==== +include::{snippetDir}api-query-index/curl-request.adoc[opts=optional] +==== [source,sh] ---- curl -XGET -H "Content-Type: application/json" \ @@ -825,13 +832,16 @@ curl -XGET -H "Content-Type: application/json" \ -include::{snippetDir}api-query-index/curl-request.adoc[opts=optional] +include::{snippetDir}api-query-index/http-request.adoc[opts=optional] +ifeval::["yes" != ""] +[#api-query-index-ex-response] += Example HTTP Response +endif::[] +include::{snippetDir}api-query-index/http-response.adoc[opts=optional] -include::{snippetDir}api-query-index/http-request.adoc[opts=optional] -// FIXME: Response examples [#api-query-index-ex-response-200] .Response 200 ==== @@ -880,8 +890,6 @@ include::{snippetDir}api-query-index/http-request.adoc[opts=optional] ==== -include::{snippetDir}api-query-index/http-response.adoc[opts=optional] - include::{specDir}paths/api-query-index/operation-end.adoc[opts=optional] :leveloffset: -1 diff --git a/docs/modules/fts-rest-stats/pages/index.adoc b/docs/modules/fts-rest-stats/pages/index.adoc index 3ced25d9..d1b2b46a 100644 --- a/docs/modules/fts-rest-stats/pages/index.adoc +++ b/docs/modules/fts-rest-stats/pages/index.adoc @@ -257,15 +257,20 @@ include::{specDir}paths/g-api-nsstats/operation-security-end.adoc[opts=optional] include::{specDir}paths/g-api-nsstats/operation-security-after.adoc[opts=optional] - - include::{snippetDir}g-api-nsstats/curl-request.adoc[opts=optional] include::{snippetDir}g-api-nsstats/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yesyes" != ""] +[#g-api-nsstats-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}g-api-nsstats/http-response.adoc[opts=optional] + + [#g-api-nsstats-ex-response-200] .Response 200 ==== @@ -437,6 +442,9 @@ include::{snippetDir}g-api-nsstats/http-request.adoc[opts=optional] } ---- ==== + + + [#g-api-nsstats-ex-response-403] .Response 403 ==== @@ -450,8 +458,6 @@ include::{snippetDir}g-api-nsstats/http-request.adoc[opts=optional] ==== -include::{snippetDir}g-api-nsstats/http-response.adoc[opts=optional] - include::{specDir}paths/g-api-nsstats/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -612,15 +618,20 @@ include::{specDir}paths/g-api-nsstats-index-name/operation-security-end.adoc[opt include::{specDir}paths/g-api-nsstats-index-name/operation-security-after.adoc[opts=optional] - - include::{snippetDir}g-api-nsstats-index-name/curl-request.adoc[opts=optional] include::{snippetDir}g-api-nsstats-index-name/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#g-api-nsstats-index-name-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}g-api-nsstats-index-name/http-response.adoc[opts=optional] + + [#g-api-nsstats-index-name-ex-response-200] .Response 200 ==== @@ -687,8 +698,6 @@ include::{snippetDir}g-api-nsstats-index-name/http-request.adoc[opts=optional] ==== -include::{snippetDir}g-api-nsstats-index-name/http-response.adoc[opts=optional] - include::{specDir}paths/g-api-nsstats-index-name/operation-end.adoc[opts=optional] :leveloffset: -1 diff --git a/docs/modules/index-rest-stats/pages/index.adoc b/docs/modules/index-rest-stats/pages/index.adoc index 9a496c4e..571ca28a 100644 --- a/docs/modules/index-rest-stats/pages/index.adoc +++ b/docs/modules/index-rest-stats/pages/index.adoc @@ -351,16 +351,16 @@ include::{specDir}paths/get_index_stats/operation-security-end.adoc[opts=optiona include::{specDir}paths/get_index_stats/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_index_stats/curl-request.adoc[opts=optional] include::{snippetDir}get_index_stats/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_index_stats-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_index_stats/http-response.adoc[opts=optional] @@ -576,16 +576,16 @@ include::{specDir}paths/get_keyspace_stats/operation-security-end.adoc[opts=opti include::{specDir}paths/get_keyspace_stats/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_keyspace_stats/curl-request.adoc[opts=optional] include::{snippetDir}get_keyspace_stats/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_keyspace_stats-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_keyspace_stats/http-response.adoc[opts=optional] @@ -771,16 +771,16 @@ include::{specDir}paths/get_node_stats/operation-security-end.adoc[opts=optional include::{specDir}paths/get_node_stats/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_node_stats/curl-request.adoc[opts=optional] include::{snippetDir}get_node_stats/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_node_stats-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_node_stats/http-response.adoc[opts=optional] diff --git a/docs/modules/n1ql-rest-admin/pages/index.adoc b/docs/modules/n1ql-rest-admin/pages/index.adoc index 59297170..7533f6e5 100644 --- a/docs/modules/n1ql-rest-admin/pages/index.adoc +++ b/docs/modules/n1ql-rest-admin/pages/index.adoc @@ -281,16 +281,16 @@ include::{specDir}paths/delete_active_request/operation-security-end.adoc[opts=o include::{specDir}paths/delete_active_request/operation-security-after.adoc[opts=optional] - - include::{snippetDir}delete_active_request/curl-request.adoc[opts=optional] include::{snippetDir}delete_active_request/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#delete_active_request-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}delete_active_request/http-response.adoc[opts=optional] @@ -414,16 +414,16 @@ include::{specDir}paths/get_active_indexes/operation-security-end.adoc[opts=opti include::{specDir}paths/get_active_indexes/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_active_indexes/curl-request.adoc[opts=optional] include::{snippetDir}get_active_indexes/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_active_indexes-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_active_indexes/http-response.adoc[opts=optional] @@ -579,16 +579,16 @@ include::{specDir}paths/get_active_request/operation-security-end.adoc[opts=opti include::{specDir}paths/get_active_request/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_active_request/curl-request.adoc[opts=optional] include::{snippetDir}get_active_request/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_active_request-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_active_request/http-response.adoc[opts=optional] @@ -710,16 +710,16 @@ include::{specDir}paths/get_active_requests/operation-security-end.adoc[opts=opt include::{specDir}paths/get_active_requests/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_active_requests/curl-request.adoc[opts=optional] include::{snippetDir}get_active_requests/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_active_requests-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_active_requests/http-response.adoc[opts=optional] @@ -904,16 +904,16 @@ include::{specDir}paths/delete_completed_request/operation-security-end.adoc[opt include::{specDir}paths/delete_completed_request/operation-security-after.adoc[opts=optional] - - include::{snippetDir}delete_completed_request/curl-request.adoc[opts=optional] include::{snippetDir}delete_completed_request/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#delete_completed_request-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}delete_completed_request/http-response.adoc[opts=optional] @@ -1037,16 +1037,16 @@ include::{specDir}paths/get_completed_indexes/operation-security-end.adoc[opts=o include::{specDir}paths/get_completed_indexes/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_completed_indexes/curl-request.adoc[opts=optional] include::{snippetDir}get_completed_indexes/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_completed_indexes-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_completed_indexes/http-response.adoc[opts=optional] @@ -1202,16 +1202,16 @@ include::{specDir}paths/get_completed_request/operation-security-end.adoc[opts=o include::{specDir}paths/get_completed_request/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_completed_request/curl-request.adoc[opts=optional] include::{snippetDir}get_completed_request/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_completed_request-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_completed_request/http-response.adoc[opts=optional] @@ -1333,16 +1333,16 @@ include::{specDir}paths/get_completed_requests/operation-security-end.adoc[opts= include::{specDir}paths/get_completed_requests/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_completed_requests/curl-request.adoc[opts=optional] include::{snippetDir}get_completed_requests/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_completed_requests-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_completed_requests/http-response.adoc[opts=optional] @@ -1521,16 +1521,16 @@ include::{specDir}paths/get_cluster/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_cluster/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_cluster/curl-request.adoc[opts=optional] include::{snippetDir}get_cluster/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_cluster-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_cluster/http-response.adoc[opts=optional] @@ -1652,16 +1652,16 @@ include::{specDir}paths/get_clusters/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_clusters/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_clusters/curl-request.adoc[opts=optional] include::{snippetDir}get_clusters/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_clusters-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_clusters/http-response.adoc[opts=optional] @@ -1783,16 +1783,16 @@ include::{specDir}paths/get_config/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_config/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_config/curl-request.adoc[opts=optional] include::{snippetDir}get_config/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_config-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_config/http-response.adoc[opts=optional] @@ -1958,16 +1958,16 @@ include::{specDir}paths/get_node/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_node/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_node/curl-request.adoc[opts=optional] include::{snippetDir}get_node/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_node-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_node/http-response.adoc[opts=optional] @@ -2122,16 +2122,16 @@ include::{specDir}paths/get_nodes/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_nodes/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_nodes/curl-request.adoc[opts=optional] include::{snippetDir}get_nodes/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_nodes-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_nodes/http-response.adoc[opts=optional] @@ -2284,15 +2284,20 @@ include::{specDir}paths/get_gc/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_gc/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_gc/curl-request.adoc[opts=optional] include::{snippetDir}get_gc/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#get_gc-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}get_gc/http-response.adoc[opts=optional] + + [#get_gc-ex-response-200] .Response 200 ==== @@ -2306,8 +2311,6 @@ include::{snippetDir}get_gc/http-request.adoc[opts=optional] ==== -include::{snippetDir}get_gc/http-response.adoc[opts=optional] - include::{specDir}paths/get_gc/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -2407,16 +2410,16 @@ include::{specDir}paths/get_ping/operation-security-before.adoc[opts=optional] include::{specDir}paths/get_ping/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_ping/curl-request.adoc[opts=optional] include::{snippetDir}get_ping/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_ping-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_ping/http-response.adoc[opts=optional] @@ -2547,15 +2550,20 @@ include::{specDir}paths/post_gc/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_gc/operation-security-after.adoc[opts=optional] - - include::{snippetDir}post_gc/curl-request.adoc[opts=optional] include::{snippetDir}post_gc/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#post_gc-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}post_gc/http-response.adoc[opts=optional] + + [#post_gc-ex-response-200] .Response 200 ==== @@ -2570,8 +2578,6 @@ include::{snippetDir}post_gc/http-request.adoc[opts=optional] ==== -include::{snippetDir}post_gc/http-response.adoc[opts=optional] - include::{specDir}paths/post_gc/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -2753,16 +2759,16 @@ include::{specDir}paths/delete_prepared/operation-security-end.adoc[opts=optiona include::{specDir}paths/delete_prepared/operation-security-after.adoc[opts=optional] - - include::{snippetDir}delete_prepared/curl-request.adoc[opts=optional] include::{snippetDir}delete_prepared/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#delete_prepared-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}delete_prepared/http-response.adoc[opts=optional] @@ -2918,16 +2924,16 @@ include::{specDir}paths/get_prepared/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_prepared/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_prepared/curl-request.adoc[opts=optional] include::{snippetDir}get_prepared/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_prepared-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_prepared/http-response.adoc[opts=optional] @@ -3051,16 +3057,16 @@ include::{specDir}paths/get_prepared_indexes/operation-security-end.adoc[opts=op include::{specDir}paths/get_prepared_indexes/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_prepared_indexes/curl-request.adoc[opts=optional] include::{snippetDir}get_prepared_indexes/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_prepared_indexes-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_prepared_indexes/http-response.adoc[opts=optional] @@ -3182,16 +3188,16 @@ include::{specDir}paths/get_prepareds/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_prepareds/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_prepareds/curl-request.adoc[opts=optional] include::{snippetDir}get_prepareds/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_prepareds-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_prepareds/http-response.adoc[opts=optional] @@ -3334,16 +3340,16 @@ include::{specDir}paths/get_settings/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_settings/curl-request.adoc[opts=optional] include::{snippetDir}get_settings/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_settings-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_settings/http-response.adoc[opts=optional] @@ -3424,7 +3430,7 @@ a¦ *Body* + optional a¦ [markdown] -- - +An object specifying node-level query settings. -- [%hardbreaks] @@ -3503,16 +3509,16 @@ include::{specDir}paths/post_settings/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optional] - - include::{snippetDir}post_settings/curl-request.adoc[opts=optional] include::{snippetDir}post_settings/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#post_settings-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}post_settings/http-response.adoc[opts=optional] @@ -3638,15 +3644,20 @@ include::{specDir}paths/get_debug_vars/operation-security-before.adoc[opts=optio include::{specDir}paths/get_debug_vars/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_debug_vars/curl-request.adoc[opts=optional] include::{snippetDir}get_debug_vars/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#get_debug_vars-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}get_debug_vars/http-response.adoc[opts=optional] + + [#get_debug_vars-ex-response-302] .Response 302 ==== @@ -3657,8 +3668,6 @@ include::{snippetDir}get_debug_vars/http-request.adoc[opts=optional] ==== -include::{snippetDir}get_debug_vars/http-response.adoc[opts=optional] - include::{specDir}paths/get_debug_vars/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -3813,16 +3822,16 @@ include::{specDir}paths/get_stat/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_stat/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_stat/curl-request.adoc[opts=optional] include::{snippetDir}get_stat/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_stat-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_stat/http-response.adoc[opts=optional] @@ -3944,16 +3953,16 @@ include::{specDir}paths/get_stats/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_stats/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_stats/curl-request.adoc[opts=optional] include::{snippetDir}get_stats/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_stats-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_stats/http-response.adoc[opts=optional] @@ -4076,16 +4085,16 @@ include::{specDir}paths/get_vitals/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_vitals/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_vitals/curl-request.adoc[opts=optional] include::{snippetDir}get_vitals/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#get_vitals-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}get_vitals/http-response.adoc[opts=optional] diff --git a/docs/modules/n1ql-rest-functions/pages/index.adoc b/docs/modules/n1ql-rest-functions/pages/index.adoc index 0ca37039..488b72bc 100644 --- a/docs/modules/n1ql-rest-functions/pages/index.adoc +++ b/docs/modules/n1ql-rest-functions/pages/index.adoc @@ -320,16 +320,16 @@ include::{specDir}paths/delete_library/operation-security-end.adoc[opts=optional include::{specDir}paths/delete_library/operation-security-after.adoc[opts=optional] - - include::{snippetDir}delete_library/curl-request.adoc[opts=optional] include::{snippetDir}delete_library/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#delete_library-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}delete_library/http-response.adoc[opts=optional] @@ -513,19 +513,23 @@ include::{specDir}paths/get_collection/operation-security-end.adoc[opts=optional include::{specDir}paths/get_collection/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_collection/curl-request.adoc[opts=optional] include::{snippetDir}get_collection/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yesyes" != ""] +[#get_collection-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}get_collection/http-response.adoc[opts=optional] + [#get_collection-ex-response-200] .Response 200 ==== -[#get_collection-ex-response-200-all-libraries] +[#get_collection-ex-response-200-0] .All Libraries [source,json] ---- @@ -542,7 +546,8 @@ include::{snippetDir}get_collection/http-request.adoc[opts=optional] } ] ---- -[#get_collection-ex-response-200-scoped-libraries] + +[#get_collection-ex-response-200-1] .Scoped Libraries [source,json] ---- @@ -556,9 +561,6 @@ include::{snippetDir}get_collection/http-request.adoc[opts=optional] ==== - -include::{snippetDir}get_collection/http-response.adoc[opts=optional] - include::{specDir}paths/get_collection/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -767,19 +769,23 @@ include::{specDir}paths/get_library/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_library/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_library/curl-request.adoc[opts=optional] include::{snippetDir}get_library/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yesyes" != ""] +[#get_library-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}get_library/http-response.adoc[opts=optional] + [#get_library-ex-response-200] .Response 200 ==== -[#get_library-ex-response-200-global-library] +[#get_library-ex-response-200-0] .Global Library [source,json] ---- @@ -788,7 +794,8 @@ include::{snippetDir}get_library/http-request.adoc[opts=optional] } ---- -[#get_library-ex-response-200-scoped-library] + +[#get_library-ex-response-200-1] .Scoped Library [source,json] ---- @@ -799,9 +806,6 @@ include::{snippetDir}get_library/http-request.adoc[opts=optional] ==== - -include::{snippetDir}get_library/http-response.adoc[opts=optional] - include::{specDir}paths/get_library/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -935,7 +939,7 @@ a¦ *Body* + required a¦ [markdown] -- - +The JavaScript code for all functions in the library. -- [%hardbreaks] @@ -1031,16 +1035,16 @@ include::{specDir}paths/post_library/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_library/operation-security-after.adoc[opts=optional] - - include::{snippetDir}post_library/curl-request.adoc[opts=optional] include::{snippetDir}post_library/http-request.adoc[opts=optional] -// FIXME: Response examples - +ifeval::["" != ""] +[#post_library-ex-response] += Example HTTP Response +endif::[] include::{snippetDir}post_library/http-response.adoc[opts=optional] diff --git a/docs/modules/n1ql-rest-query/pages/index.adoc b/docs/modules/n1ql-rest-query/pages/index.adoc index 5cdf6e6c..1f0540d2 100644 --- a/docs/modules/n1ql-rest-query/pages/index.adoc +++ b/docs/modules/n1ql-rest-query/pages/index.adoc @@ -349,15 +349,20 @@ include::{specDir}paths/get_service/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_service/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_service/curl-request.adoc[opts=optional] include::{snippetDir}get_service/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yesyesyesyesyes" != ""] +[#get_service-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}get_service/http-response.adoc[opts=optional] + + [#get_service-ex-response-200] .Response 200 ==== @@ -382,10 +387,12 @@ include::{snippetDir}get_service/http-request.adoc[opts=optional] } ---- ==== + + [#get_service-ex-response-400] .Response 400 ==== -[#get_service-ex-response-400-sql-error] +[#get_service-ex-response-400-0] .SQL++ Error [source,json] ---- @@ -407,7 +414,8 @@ include::{snippetDir}get_service/http-request.adoc[opts=optional] } ---- -[#get_service-ex-response-400-request-error] + +[#get_service-ex-response-400-1] .Request Error [source,json] ---- @@ -430,6 +438,8 @@ include::{snippetDir}get_service/http-request.adoc[opts=optional] ---- ==== + + [#get_service-ex-response-404] .Response 404 ==== @@ -453,6 +463,9 @@ include::{snippetDir}get_service/http-request.adoc[opts=optional] } ---- ==== + + + [#get_service-ex-response-503] .Response 503 ==== @@ -479,8 +492,6 @@ include::{snippetDir}get_service/http-request.adoc[opts=optional] ==== -include::{snippetDir}get_service/http-response.adoc[opts=optional] - include::{specDir}paths/get_service/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -559,7 +570,7 @@ a¦ *Body* + required a¦ [markdown] -- - +An object specifying one or more query parameters. -- [%hardbreaks] @@ -716,15 +727,20 @@ include::{specDir}paths/post_service/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_service/operation-security-after.adoc[opts=optional] - - include::{snippetDir}post_service/curl-request.adoc[opts=optional] include::{snippetDir}post_service/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yesyesyesyesyes" != ""] +[#post_service-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}post_service/http-response.adoc[opts=optional] + + [#post_service-ex-response-200] .Response 200 ==== @@ -749,10 +765,12 @@ include::{snippetDir}post_service/http-request.adoc[opts=optional] } ---- ==== + + [#post_service-ex-response-400] .Response 400 ==== -[#post_service-ex-response-400-sql-error] +[#post_service-ex-response-400-0] .SQL++ Error [source,json] ---- @@ -774,7 +792,8 @@ include::{snippetDir}post_service/http-request.adoc[opts=optional] } ---- -[#post_service-ex-response-400-request-error] + +[#post_service-ex-response-400-1] .Request Error [source,json] ---- @@ -797,6 +816,8 @@ include::{snippetDir}post_service/http-request.adoc[opts=optional] ---- ==== + + [#post_service-ex-response-404] .Response 404 ==== @@ -820,6 +841,9 @@ include::{snippetDir}post_service/http-request.adoc[opts=optional] } ---- ==== + + + [#post_service-ex-response-503] .Response 503 ==== @@ -846,8 +870,6 @@ include::{snippetDir}post_service/http-request.adoc[opts=optional] ==== -include::{snippetDir}post_service/http-response.adoc[opts=optional] - include::{specDir}paths/post_service/operation-end.adoc[opts=optional] :leveloffset: -1 diff --git a/docs/modules/n1ql-rest-settings/pages/index.adoc b/docs/modules/n1ql-rest-settings/pages/index.adoc index 48178325..9746ea8f 100644 --- a/docs/modules/n1ql-rest-settings/pages/index.adoc +++ b/docs/modules/n1ql-rest-settings/pages/index.adoc @@ -235,15 +235,20 @@ include::{specDir}paths/get_access/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_access/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_access/curl-request.adoc[opts=optional] include::{snippetDir}get_access/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#get_access-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}get_access/http-response.adoc[opts=optional] + + [#get_access-ex-response-200] .Response 200 ==== @@ -258,8 +263,6 @@ include::{snippetDir}get_access/http-request.adoc[opts=optional] ==== -include::{snippetDir}get_access/http-response.adoc[opts=optional] - include::{specDir}paths/get_access/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -378,15 +381,20 @@ include::{specDir}paths/get_settings/operation-security-end.adoc[opts=optional] include::{specDir}paths/get_settings/operation-security-after.adoc[opts=optional] - - include::{snippetDir}get_settings/curl-request.adoc[opts=optional] include::{snippetDir}get_settings/http-request.adoc[opts=optional] -// FIXME: Response examples +ifeval::["yes" != ""] +[#get_settings-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}get_settings/http-response.adoc[opts=optional] + + [#get_settings-ex-response-200] .Response 200 ==== @@ -425,8 +433,6 @@ include::{snippetDir}get_settings/http-request.adoc[opts=optional] ==== -include::{snippetDir}get_settings/http-response.adoc[opts=optional] - include::{specDir}paths/get_settings/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -504,7 +510,7 @@ a¦ *Body* + optional a¦ [markdown] -- - +An object determining which URLs may be accessed by the `CURL()` function. -- [%hardbreaks] @@ -590,13 +596,15 @@ include::{specDir}paths/post_access/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_access/operation-security-after.adoc[opts=optional] +include::{snippetDir}post_access/curl-request.adoc[opts=optional] -include::{snippetDir}post_access/curl-request.adoc[opts=optional] [#post_access-ex-request] = Example Request Body +include::{snippetDir}post_access/http-request.adoc[opts=optional] + ==== [source,json] ---- @@ -609,9 +617,14 @@ include::{snippetDir}post_access/curl-request.adoc[opts=optional] ==== -include::{snippetDir}post_access/http-request.adoc[opts=optional] +ifeval::["yes" != ""] +[#post_access-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}post_access/http-response.adoc[opts=optional] + -// FIXME: Response examples [#post_access-ex-response-200] .Response 200 ==== @@ -626,8 +639,6 @@ include::{snippetDir}post_access/http-request.adoc[opts=optional] ==== -include::{snippetDir}post_access/http-response.adoc[opts=optional] - include::{specDir}paths/post_access/operation-end.adoc[opts=optional] :leveloffset: -1 @@ -705,7 +716,7 @@ a¦ *Body* + optional a¦ [markdown] -- - +An object specifying cluster-level query settings. -- [%hardbreaks] @@ -791,15 +802,17 @@ include::{specDir}paths/post_settings/operation-security-end.adoc[opts=optional] include::{specDir}paths/post_settings/operation-security-after.adoc[opts=optional] +include::{snippetDir}post_settings/curl-request.adoc[opts=optional] -include::{snippetDir}post_settings/curl-request.adoc[opts=optional] [#post_settings-ex-request] = Example Request Body +include::{snippetDir}post_settings/http-request.adoc[opts=optional] + ==== -[#post_settings-ex-request-partial-settings] +[#post_settings-ex-request-0] .Partial Settings [source,json] ---- @@ -812,7 +825,8 @@ include::{snippetDir}post_settings/curl-request.adoc[opts=optional] } ---- -[#post_settings-ex-request-all-settings] + +[#post_settings-ex-request-1] .All Settings [source,json] ---- @@ -849,10 +863,14 @@ include::{snippetDir}post_settings/curl-request.adoc[opts=optional] ==== +ifeval::["yes" != ""] +[#post_settings-ex-response] += Example HTTP Response +endif::[] + +include::{snippetDir}post_settings/http-response.adoc[opts=optional] -include::{snippetDir}post_settings/http-request.adoc[opts=optional] -// FIXME: Response examples [#post_settings-ex-response-200] .Response 200 ==== @@ -891,8 +909,6 @@ include::{snippetDir}post_settings/http-request.adoc[opts=optional] ==== -include::{snippetDir}post_settings/http-response.adoc[opts=optional] - include::{specDir}paths/post_settings/operation-end.adoc[opts=optional] :leveloffset: -1 From 2ef108bd1c8601a17fb43e85ff29f324f95cf080 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Tue, 3 Feb 2026 12:19:50 +0000 Subject: [PATCH 30/30] Remove remaining unnecessary Query examples --- .../paths/get_ping/http-response.adoc | 2 +- .../n1ql-rest-query/examples/exn1qlerror.json | 18 ------------- .../n1ql-rest-query/examples/exnamed.json | 25 ------------------- .../n1ql-rest-query/examples/exnamed.sh | 5 ---- .../n1ql-rest-query/examples/exnotfound.json | 18 ------------- .../n1ql-rest-query/examples/exnumbered.json | 25 ------------------- .../n1ql-rest-query/examples/exnumbered.sh | 5 ---- .../examples/expositional.json | 25 ------------------- .../n1ql-rest-query/examples/expositional.sh | 5 ---- .../examples/exrequesterror.json | 18 ------------- .../examples/exserviceerror.json | 19 -------------- .../examples/exsuccessful.json | 19 -------------- .../n1ql-rest-query/examples/exwildcard.json | 22 ---------------- .../n1ql-rest-query/examples/exwildcard.sh | 6 ----- 14 files changed, 1 insertion(+), 211 deletions(-) delete mode 100644 docs/modules/n1ql-rest-query/examples/exn1qlerror.json delete mode 100644 docs/modules/n1ql-rest-query/examples/exnamed.json delete mode 100644 docs/modules/n1ql-rest-query/examples/exnamed.sh delete mode 100644 docs/modules/n1ql-rest-query/examples/exnotfound.json delete mode 100644 docs/modules/n1ql-rest-query/examples/exnumbered.json delete mode 100644 docs/modules/n1ql-rest-query/examples/exnumbered.sh delete mode 100644 docs/modules/n1ql-rest-query/examples/expositional.json delete mode 100644 docs/modules/n1ql-rest-query/examples/expositional.sh delete mode 100644 docs/modules/n1ql-rest-query/examples/exrequesterror.json delete mode 100644 docs/modules/n1ql-rest-query/examples/exserviceerror.json delete mode 100644 docs/modules/n1ql-rest-query/examples/exsuccessful.json delete mode 100644 docs/modules/n1ql-rest-query/examples/exwildcard.json delete mode 100644 docs/modules/n1ql-rest-query/examples/exwildcard.sh diff --git a/docs/modules/n1ql-rest-admin/partials/paths/get_ping/http-response.adoc b/docs/modules/n1ql-rest-admin/partials/paths/get_ping/http-response.adoc index 9557eda8..b71e3de7 100644 --- a/docs/modules/n1ql-rest-admin/partials/paths/get_ping/http-response.adoc +++ b/docs/modules/n1ql-rest-admin/partials/paths/get_ping/http-response.adoc @@ -1,7 +1,7 @@ = Example HTTP Response -==== .Response 200 +==== [source,json] ---- include::example$get_ping.json[] diff --git a/docs/modules/n1ql-rest-query/examples/exn1qlerror.json b/docs/modules/n1ql-rest-query/examples/exn1qlerror.json deleted file mode 100644 index fe4d4b6e..00000000 --- a/docs/modules/n1ql-rest-query/examples/exn1qlerror.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "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 deleted file mode 100644 index 0389aef5..00000000 --- a/docs/modules/n1ql-rest-query/examples/exnamed.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "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 deleted file mode 100644 index 59691044..00000000 --- a/docs/modules/n1ql-rest-query/examples/exnamed.sh +++ /dev/null @@ -1,5 +0,0 @@ -curl -v $BASEPATH/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 deleted file mode 100644 index 882dd6f3..00000000 --- a/docs/modules/n1ql-rest-query/examples/exnotfound.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "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 deleted file mode 100644 index 3cb9994e..00000000 --- a/docs/modules/n1ql-rest-query/examples/exnumbered.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "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 deleted file mode 100644 index 6d4accbf..00000000 --- a/docs/modules/n1ql-rest-query/examples/exnumbered.sh +++ /dev/null @@ -1,5 +0,0 @@ -curl -v $BASEPATH/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 deleted file mode 100644 index fc48bf3d..00000000 --- a/docs/modules/n1ql-rest-query/examples/expositional.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "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 deleted file mode 100644 index 6ad70589..00000000 --- a/docs/modules/n1ql-rest-query/examples/expositional.sh +++ /dev/null @@ -1,5 +0,0 @@ -curl -v $BASEPATH/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/exrequesterror.json b/docs/modules/n1ql-rest-query/examples/exrequesterror.json deleted file mode 100644 index 86072621..00000000 --- a/docs/modules/n1ql-rest-query/examples/exrequesterror.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "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 deleted file mode 100644 index 3048677a..00000000 --- a/docs/modules/n1ql-rest-query/examples/exserviceerror.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "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 deleted file mode 100644 index d48a72aa..00000000 --- a/docs/modules/n1ql-rest-query/examples/exsuccessful.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "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/exwildcard.json b/docs/modules/n1ql-rest-query/examples/exwildcard.json deleted file mode 100644 index 49f72659..00000000 --- a/docs/modules/n1ql-rest-query/examples/exwildcard.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "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 deleted file mode 100644 index f4e6bf2d..00000000 --- a/docs/modules/n1ql-rest-query/examples/exwildcard.sh +++ /dev/null @@ -1,6 +0,0 @@ -curl -v $BASEPATH/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