From 8d4183727b98efb003f7ccdebe28824d97ca1daa Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Mon, 21 Oct 2024 17:35:36 +0100 Subject: [PATCH 1/4] Delete superseded REST API pages --- .../pages/rest-cluster-query-settings.adoc | 17 ----------------- modules/rest-api/pages/rest-index-stats.adoc | 6 ------ 2 files changed, 23 deletions(-) delete mode 100644 modules/rest-api/pages/rest-cluster-query-settings.adoc delete mode 100644 modules/rest-api/pages/rest-index-stats.adoc diff --git a/modules/rest-api/pages/rest-cluster-query-settings.adoc b/modules/rest-api/pages/rest-cluster-query-settings.adoc deleted file mode 100644 index b98242a05b..0000000000 --- a/modules/rest-api/pages/rest-cluster-query-settings.adoc +++ /dev/null @@ -1,17 +0,0 @@ -= Query Settings REST API - -//// -These partials are created automatically by Swagger2Markup. -Refer to https://github.com/couchbaselabs/cb-swagger -//// - -include::partial$query-settings/overview.adoc[tag=body] -include::partial$query-settings/paths.adoc[] -include::partial$query-settings/definitions.adoc[] -include::partial$query-settings/security.adoc[] - -== See Also - -* [[cleanupclientattempts]][[cleanuplostattempts]][[cleanupwindow]][[completed-limit]][[completed-max-plan-size]][[completed-threshold]][[loglevel]][[max-parallelism-srv]][[memory-quota-srv]][[node-quota]][[node-quota-val-percent]][[num-cpus]][[numatrs-srv]][[n1ql-feat-ctrl]][[pipeline-batch-srv]][[pipeline-cap-srv]][[prepared-limit]][[scan-cap-srv]][[timeout-srv]][[txtimeout-srv]][[use-cbo-srv]][[use-replica-srv]]For node-level settings, see the xref:n1ql-rest-admin:index.adoc#Settings[Query Admin REST API]. - -* [[max_parallelism_req]][[memory_quota_req]][[numatrs_req]][[pipeline_batch_req]][[pipeline_cap_req]][[scan_cap_req]][[timeout_req]][[tximplicit]][[txtimeout_req]][[use_cbo_req]][[use_replica_req]]For request-level parameters, see the xref:n1ql-rest-query:index.adoc#Request[Query Service REST API]. \ No newline at end of file diff --git a/modules/rest-api/pages/rest-index-stats.adoc b/modules/rest-api/pages/rest-index-stats.adoc deleted file mode 100644 index 963999de6c..0000000000 --- a/modules/rest-api/pages/rest-index-stats.adoc +++ /dev/null @@ -1,6 +0,0 @@ -= Index Statistics API - -include::partial$index-stats/overview.adoc[tag=body] -include::partial$index-stats/paths.adoc[] -include::partial$index-stats/definitions.adoc[] -include::partial$index-stats/security.adoc[] \ No newline at end of file From bf3dca4859414da03cb7bd0a286ee322414cca4d Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Mon, 21 Oct 2024 18:24:24 +0100 Subject: [PATCH 2/4] Update links --- .../manage/pages/manage-settings/general-settings.adoc | 2 +- modules/manage/pages/monitor/monitoring-indexes.adoc | 4 ++-- modules/rest-api/partials/rest-index-service-table.adoc | 6 +++--- modules/rest-api/partials/rest-query-service-table.adoc | 8 ++++---- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/modules/manage/pages/manage-settings/general-settings.adoc b/modules/manage/pages/manage-settings/general-settings.adoc index 9a4cc10478..59ed72ed30 100644 --- a/modules/manage/pages/manage-settings/general-settings.adoc +++ b/modules/manage/pages/manage-settings/general-settings.adoc @@ -795,7 +795,7 @@ If successful, the call returns a JSON document that confirms the modified setti include::rest-api:example$query-settings-post-access.jsonc[] ---- -For additional information, refer to xref:rest-api:rest-cluster-query-settings.adoc[Cluster Query Settings API]. +For additional information, refer to xref:n1ql-rest-settings:index.adoc[]. [#rebalance-settings-via-rest] === Rebalance Settings via REST diff --git a/modules/manage/pages/monitor/monitoring-indexes.adoc b/modules/manage/pages/monitor/monitoring-indexes.adoc index a44697f562..b028ffb65d 100644 --- a/modules/manage/pages/monitor/monitoring-indexes.adoc +++ b/modules/manage/pages/monitor/monitoring-indexes.adoc @@ -6,7 +6,7 @@ // Cross references :manage-indexes: xref:manage:manage-indexes/manage-indexes.adoc :index-stats: xref:manage:monitor/ui-monitoring-statistics.adoc#index_stats -:rest-index-stats: xref:rest-api:rest-index-stats.adoc +:rest-index-stats: xref:index-rest-stats:index.adoc :couchbase-cli-server-info: xref:cli:cbcli/couchbase-cli-server-info.adoc [abstract] @@ -143,7 +143,7 @@ Note that there is no CLI support for statistics for a specific index. == Monitor Indexes with the REST API You can monitor all Index-Service statistics, and statistics for a specific index, using the REST API. -Refer to {rest-index-stats}[Index Statistics API]. +Refer to {rest-index-stats}[]. [[related-links]] == Related Links diff --git a/modules/rest-api/partials/rest-index-service-table.adoc b/modules/rest-api/partials/rest-index-service-table.adoc index 90876bea91..6108cee288 100644 --- a/modules/rest-api/partials/rest-index-service-table.adoc +++ b/modules/rest-api/partials/rest-index-service-table.adoc @@ -12,14 +12,14 @@ | `GET` | `/api/v1/stats` -| xref:rest-api:rest-index-stats.adoc#_get_node_stats[Get Node Statistics] +| xref:index-rest-stats:index.adoc#get_node_stats[Get Node Statistics] | `GET` | `/api/v1/stats/{keyspace}` -| xref:rest-api:rest-index-stats.adoc#_get_keyspace_stats[Get Keyspace Statistics] +| xref:index-rest-stats:index.adoc#get_keyspace_stats[Get Keyspace Statistics] | `GET` | `/api/v1/stats/{keyspace}/{index}` -| xref:rest-api:rest-index-stats.adoc#_get_index_stats[Get Index Statistics] +| xref:index-rest-stats:index.adoc#get_index_stats[Get Index Statistics] |=== diff --git a/modules/rest-api/partials/rest-query-service-table.adoc b/modules/rest-api/partials/rest-query-service-table.adoc index 212d792f01..86eb3eb999 100644 --- a/modules/rest-api/partials/rest-query-service-table.adoc +++ b/modules/rest-api/partials/rest-query-service-table.adoc @@ -140,19 +140,19 @@ | `GET` | `/settings/querySettings` -| xref:rest-api:rest-cluster-query-settings.adoc#_get_settings[Retrieve Cluster-Level Query Settings] +| xref:n1ql-rest-settings:index.adoc#get_settings[Retrieve Cluster-Level Query Settings] | `POST` | `/settings/querySettings` -| xref:rest-api:rest-cluster-query-settings.adoc#_post_settings[Update Cluster-Level Query Settings] +| xref:n1ql-rest-settings:index.adoc#post_settings[Update Cluster-Level Query Settings] | `GET` | `/settings/querySettings/curlWhitelist` -| xref:rest-api:rest-cluster-query-settings.adoc#_get_access[Retrieve CURL Access List] +| xref:n1ql-rest-settings:index.adoc#get_access[Retrieve CURL Access List] | `POST` | `/settings/querySettings/curlWhitelist` -| xref:rest-api:rest-cluster-query-settings.adoc#_post_access[Update CURL Access List] +| xref:n1ql-rest-settings:index.adoc#post_access[Update CURL Access List] |=== // end::query-settings[] From 8e20f7d4eb29974c86f8ae4a561cff245f3e8f48 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Mon, 21 Oct 2024 18:24:35 +0100 Subject: [PATCH 3/4] Update links to Query Settings examples --- .../manage/pages/manage-settings/general-settings.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/modules/manage/pages/manage-settings/general-settings.adoc b/modules/manage/pages/manage-settings/general-settings.adoc index 59ed72ed30..93122eebb4 100644 --- a/modules/manage/pages/manage-settings/general-settings.adoc +++ b/modules/manage/pages/manage-settings/general-settings.adoc @@ -764,7 +764,7 @@ To set the directory for temporary backfill data, and establish its size-limit, [source,shell] ---- -include::rest-api:example$query-settings-post-settings.sh[tag=request] +include::n1ql-rest-settings:example$query-settings-post-settings.sh[tag=request] ---- This specifies that the directory for temporary backfill data should be `/tmp`; and that the maximum size should be 2048 megabytes. @@ -773,7 +773,7 @@ If successful, this call returns a JSON document featuring all the current query [source,json] ---- -include::rest-api:example$query-settings-post-settings.jsonc[tags=tmpSpace;ellipsis;access] +include::n1ql-rest-settings:example$query-settings-post-settings.jsonc[tags=tmpSpace;ellipsis;access] ---- The document's values indicate that the specified values for directory and size have been established; and that the current setting for access-control restricts access to all, with no exceptions. @@ -782,7 +782,7 @@ To specify particular URLs as allowed and disallowed, use the `/settings/querySe [source,shell] ---- -include::rest-api:example$query-settings-post-access.sh[tag=request] +include::n1ql-rest-settings:example$query-settings-post-access.sh[tag=request] ---- A JSON document is specified as the payload for the method. @@ -792,7 +792,7 @@ If successful, the call returns a JSON document that confirms the modified setti [source,json] ---- -include::rest-api:example$query-settings-post-access.jsonc[] +include::n1ql-rest-settings:example$query-settings-post-access.jsonc[] ---- For additional information, refer to xref:n1ql-rest-settings:index.adoc[]. From 3f99d23c42468bef7e05b9fe4d04bb49d0cd6b56 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Mon, 21 Oct 2024 18:24:47 +0100 Subject: [PATCH 4/4] Update nav --- modules/ROOT/nav.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 6e7379f216..98955f2f13 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -470,13 +470,13 @@ include::cli:partial$cbcli/nav.adoc[] ***** xref:n1ql:n1ql-rest-api/exauthhttp.adoc[] ***** xref:n1ql:n1ql-rest-api/exauthrequest.adoc[] *** xref:n1ql-rest-admin:index.adoc[] - *** xref:rest-api:rest-cluster-query-settings.adoc[Query Settings REST API] - *** xref:n1ql-rest-functions:index.adoc[Query Functions REST API] + *** xref:n1ql-rest-settings:index.adoc[] + *** xref:n1ql-rest-functions:index.adoc[] ** xref:rest-api:rest-index-service.adoc[Index Service API] *** xref:rest-api:get-settings-indexes.adoc[Retrieve GSI Settings] *** xref:rest-api:post-settings-indexes.adoc[Set GSI Settings] - *** xref:rest-api:rest-index-stats.adoc[Index Statistics API] + *** xref:index-rest-stats:index.adoc[Index Statistics API] *** xref:rest-api:rest-modify-index-batch-size.adoc[Modify Index Batch Size] ** xref:rest-api:backup-rest-api.adoc[Backup Service API]