From 93fe74e029b603297ec653b5ad9ba50e7b85fb4e Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Thu, 17 Oct 2024 16:41:17 +0100 Subject: [PATCH 1/3] Delete old N1QL REST API pages --- modules/n1ql/pages/n1ql-rest-api/admin.adoc | 17 ----------------- modules/n1ql/pages/n1ql-rest-api/functions.adoc | 12 ------------ modules/n1ql/pages/n1ql-rest-api/index.adoc | 17 ----------------- 3 files changed, 46 deletions(-) delete mode 100644 modules/n1ql/pages/n1ql-rest-api/admin.adoc delete mode 100644 modules/n1ql/pages/n1ql-rest-api/functions.adoc delete mode 100644 modules/n1ql/pages/n1ql-rest-api/index.adoc diff --git a/modules/n1ql/pages/n1ql-rest-api/admin.adoc b/modules/n1ql/pages/n1ql-rest-api/admin.adoc deleted file mode 100644 index b107c826f1..0000000000 --- a/modules/n1ql/pages/n1ql-rest-api/admin.adoc +++ /dev/null @@ -1,17 +0,0 @@ -= Query Admin REST API - -//// -These partials are created automatically by Swagger2Markup. -Refer to https://github.com/couchbaselabs/cb-swagger -//// - -include::partial$n1ql-rest-api/admin/overview.adoc[tag=body] -include::partial$n1ql-rest-api/admin/paths.adoc[] -include::partial$n1ql-rest-api/admin/definitions.adoc[] -include::partial$n1ql-rest-api/admin/security.adoc[] - -== See Also - -* [[queryCleanupClientAttempts]][[queryCleanupLostAttempts]][[queryCleanupWindow]][[queryCompletedLimit]][[queryCompletedMaxPlanSize]][[queryCompletedThreshold]][[queryLogLevel]][[queryMaxParallelism]][[queryMemoryQuota]][[queryNodeQuota]][[queryNodeQuotaValPercent]][[queryNumAtrs]][[queryNumCpus]][[queryN1qlFeatCtrl]][[queryPipelineBatch]][[queryPipelineCap]][[queryPreparedLimit]][[queryScanCap]][[queryTimeout]][[queryTxTimeout]][[queryUseCBO]][[queryUseReplica]]For cluster-level settings, see the xref:rest-api:rest-cluster-query-settings.adoc#_settings[Cluster Query Settings API]. - -* [[atrcollection_req]][[client_context_id]][[controls_req]][[max_parallelism_req]][[memory_quota_req]][[numatrs_req]][[pipeline_batch_req]][[pipeline_cap_req]][[pretty_req]][[profile_req]][[scan_cap_req]][[timeout_req]][[tximplicit]][[use_cbo_req]][[use_replica_req]]For request-level parameters, see the xref:n1ql:n1ql-rest-api/index.adoc#_request_parameters[Query Service REST API]. \ No newline at end of file diff --git a/modules/n1ql/pages/n1ql-rest-api/functions.adoc b/modules/n1ql/pages/n1ql-rest-api/functions.adoc deleted file mode 100644 index b3f49b3d57..0000000000 --- a/modules/n1ql/pages/n1ql-rest-api/functions.adoc +++ /dev/null @@ -1,12 +0,0 @@ -= Query Functions REST API -:page-edition: Enterprise Edition - -//// -These partials are created automatically by Swagger2Markup. -Refer to https://github.com/couchbaselabs/cb-swagger -//// - -include::partial$n1ql-rest-api/functions/overview.adoc[tag=body] -include::partial$n1ql-rest-api/functions/paths.adoc[] -include::partial$n1ql-rest-api/functions/definitions.adoc[] -include::partial$n1ql-rest-api/functions/security.adoc[] \ No newline at end of file diff --git a/modules/n1ql/pages/n1ql-rest-api/index.adoc b/modules/n1ql/pages/n1ql-rest-api/index.adoc deleted file mode 100644 index 18667a2857..0000000000 --- a/modules/n1ql/pages/n1ql-rest-api/index.adoc +++ /dev/null @@ -1,17 +0,0 @@ -= Query Service REST API - -//// -These partials are created automatically by Swagger2Markup. -Refer to https://github.com/couchbaselabs/cb-swagger -//// - -include::partial$n1ql-rest-api/query/overview.adoc[tag=body] -include::partial$n1ql-rest-api/query/paths.adoc[] -include::partial$n1ql-rest-api/query/definitions.adoc[] -include::partial$n1ql-rest-api/query/security.adoc[] - -== See Also - -* [[queryMaxParallelism]][[queryMemoryQuota]][[queryNumAtrs]][[queryPipelineBatch]][[queryPipelineCap]][[queryScanCap]][[queryTimeout]][[queryTxTimeout]][[queryUseCBO]][[queryUseReplica]]For cluster-level settings, see the xref:rest-api:rest-cluster-query-settings.adoc#_settings[Cluster Query Settings API]. - -* [[atrcollection-srv]][[controls-srv]][[max-parallelism-srv]][[memory-quota-srv]][[numatrs-srv]][[pipeline-batch-srv]][[pipeline-cap-srv]][[pretty-srv]][[profile-srv]][[scan-cap-srv]][[timeout-srv]][[txtimeout-srv]][[use-cbo-srv]][[use-replica-srv]]For node-level settings, see the xref:n1ql:n1ql-rest-api/admin.adoc#_settings[Admin REST API]. \ No newline at end of file From ba53baa1eb973329edd81cc61b96ae0df3081651 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Thu, 17 Oct 2024 16:41:29 +0100 Subject: [PATCH 2/3] Update links --- .../pages/rest-cluster-query-settings.adoc | 4 +- .../partials/rest-query-service-table.adoc | 64 +++++++++---------- 2 files changed, 34 insertions(+), 34 deletions(-) diff --git a/modules/rest-api/pages/rest-cluster-query-settings.adoc b/modules/rest-api/pages/rest-cluster-query-settings.adoc index 418290d279..b98242a05b 100644 --- a/modules/rest-api/pages/rest-cluster-query-settings.adoc +++ b/modules/rest-api/pages/rest-cluster-query-settings.adoc @@ -12,6 +12,6 @@ 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:n1ql-rest-api/admin.adoc#_settings[Admin REST API]. +* [[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:n1ql-rest-api/index.adoc#_request_parameters[Query Service REST API]. \ No newline at end of file +* [[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/partials/rest-query-service-table.adoc b/modules/rest-api/partials/rest-query-service-table.adoc index 6a9f46c0a7..212d792f01 100644 --- a/modules/rest-api/partials/rest-query-service-table.adoc +++ b/modules/rest-api/partials/rest-query-service-table.adoc @@ -7,11 +7,11 @@ | `POST` | `/query/service` -| xref:n1ql:n1ql-rest-api/index.adoc#_post_service[Query Service] +| xref:n1ql-rest-query:index.adoc#post_service[Query Service] | `GET` | `/query/service` -| xref:n1ql:n1ql-rest-api/index.adoc#_get_service[Read-Only Query Service] +| xref:n1ql-rest-query:index.adoc#get_service[Read-Only Query Service] |=== // end::query-service[] @@ -25,108 +25,108 @@ | `GET` | `/admin/clusters` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_clusters[Read All Clusters] +| xref:n1ql-rest-admin:index.adoc#get_clusters[Read All Clusters] | `GET` | `/admin/clusters/{cluster}` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_cluster[Read a Cluster] +| xref:n1ql-rest-admin:index.adoc#get_cluster[Read a Cluster] | `GET` | `/admin/clusters/{cluster}/nodes` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_nodes[Read All Nodes] +| xref:n1ql-rest-admin:index.adoc#get_nodes[Read All Nodes] | `GET` | `/admin/clusters/{cluster}/nodes/{node}` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_node[Read a Node] +| xref:n1ql-rest-admin:index.adoc#get_node[Read a Node] | `GET` | `/admin/config` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_config[Read Configuration] +| xref:n1ql-rest-admin:index.adoc#get_config[Read Configuration] | `GET` | `/admin/prepareds` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_prepareds[Retrieve All Prepared Statements] +| xref:n1ql-rest-admin:index.adoc#get_prepareds[Retrieve All Prepared Statements] | `GET` | `/admin/prepareds/{name}` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_prepared[Retrieve a Prepared Statement] +| xref:n1ql-rest-admin:index.adoc#get_prepared[Retrieve a Prepared Statement] | `DELETE` | `/admin/prepareds/{name}` -| xref:n1ql:n1ql-rest-api/admin.adoc#_delete_prepared[Delete a Prepared Statement] +| xref:n1ql-rest-admin:index.adoc#delete_prepared[Delete a Prepared Statement] | `GET` | `/admin/indexes/prepareds` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_prepared_indexes[Retrieve Prepared Index Statements] +| xref:n1ql-rest-admin:index.adoc#get_prepared_indexes[Retrieve Prepared Index Statements] | `GET` | `/admin/active_requests` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_active_requests[Retrieve All Active Requests] +| xref:n1ql-rest-admin:index.adoc#get_active_requests[Retrieve All Active Requests] | `GET` | `/admin/active_requests/{request}` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_active_request[Retrieve an Active Request] +| xref:n1ql-rest-admin:index.adoc#get_active_request[Retrieve an Active Request] | `DELETE` | `/admin/active_requests/{request}` -| xref:n1ql:n1ql-rest-api/admin.adoc#_delete_active_request[Delete an Active Request] +| xref:n1ql-rest-admin:index.adoc#delete_active_request[Delete an Active Request] | `GET` | `/admin/indexes/active_requests` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_active_indexes[Retrieve Active Index Requests] +| xref:n1ql-rest-admin:index.adoc#get_active_indexes[Retrieve Active Index Requests] | `GET` | `/admin/completed_requests` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_completed_requests[Retrieve All Completed Requests] +| xref:n1ql-rest-admin:index.adoc#get_completed_requests[Retrieve All Completed Requests] | `GET` | `/admin/completed_requests/{request}` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_completed_request[Retrieve a Completed Request] +| xref:n1ql-rest-admin:index.adoc#get_completed_request[Retrieve a Completed Request] | `DELETE` | `/admin/completed_requests/{request}` -| xref:n1ql:n1ql-rest-api/admin.adoc#_delete_completed_request[Delete a Completed Request] +| xref:n1ql-rest-admin:index.adoc#delete_completed_request[Delete a Completed Request] | `GET` | `/admin/indexes/completed_requests` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_completed_indexes[Retrieve Completed Index Requests] +| xref:n1ql-rest-admin:index.adoc#get_completed_indexes[Retrieve Completed Index Requests] | `GET` | `/admin/vitals` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_vitals[Retrieve Vitals] +| xref:n1ql-rest-admin:index.adoc#get_vitals[Retrieve Vitals] | `GET` | `/admin/stats` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_stats[Retrieve All Statistics] +| xref:n1ql-rest-admin:index.adoc#get_stats[Retrieve All Statistics] | `GET` | `/admin/stats/{stats}` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_stat[Retrieve a Statistic] +| xref:n1ql-rest-admin:index.adoc#get_stat[Retrieve a Statistic] // deprecated method // | `GET` // | `/debug/vars` -// | xref:n1ql:n1ql-rest-api/admin.adoc#_get_debug_vars[Get Debug Variables] +// | xref:n1ql-rest-admin:index.adoc#get_debug_vars[Get Debug Variables] | `GET` | `/admin/settings` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_settings[Retrieve Node-Level Query Settings] +| xref:n1ql-rest-admin:index.adoc#get_settings[Retrieve Node-Level Query Settings] | `POST` | `/admin/settings` -| xref:n1ql:n1ql-rest-api/admin.adoc#_post_settings[Update Node-Level Query Settings] +| xref:n1ql-rest-admin:index.adoc#post_settings[Update Node-Level Query Settings] | `GET` | `/admin/ping` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_ping[Ping] +| xref:n1ql-rest-admin:index.adoc#get_ping[Ping] | `GET` | `/admin/gc` -| xref:n1ql:n1ql-rest-api/admin.adoc#_get_gc[Run Garbage Collector] +| xref:n1ql-rest-admin:index.adoc#get_gc[Run Garbage Collector] | `POST` | `/admin/gc` -| xref:n1ql:n1ql-rest-api/admin.adoc#_post_gc[Run Garbage Collector and Release Memory] +| xref:n1ql-rest-admin:index.adoc#post_gc[Run Garbage Collector and Release Memory] |=== // end::query-admin[] @@ -166,19 +166,19 @@ | `GET` | `/evaluator/v1/libraries` -| xref:n1ql:n1ql-rest-api/functions.adoc#_get_collection[Read All Libraries] +| xref:n1ql-rest-functions:index.adoc#get_collection[Read All Libraries] | `GET` | `/evaluator/v1/libraries/{library}` -| xref:n1ql:n1ql-rest-api/functions.adoc#_get_library[Read a Library] +| xref:n1ql-rest-functions:index.adoc#get_library[Read a Library] | `POST` | `/evaluator/v1/libraries/{library}` -| xref:n1ql:n1ql-rest-api/functions.adoc#_post_library[Create or Update a Library] +| xref:n1ql-rest-functions:index.adoc#post_library[Create or Update a Library] | `DELETE` | `/evaluator/v1/libraries/{library}` -| xref:n1ql:n1ql-rest-api/functions.adoc#_delete_library[Delete a Library] +| xref:n1ql-rest-functions:index.adoc#delete_library[Delete a Library] |=== // end::query-functions[] From 0e2843e815b2ce4e1cbe17c44726cd318127cd52 Mon Sep 17 00:00:00 2001 From: Simon Dew Date: Thu, 17 Oct 2024 16:41:40 +0100 Subject: [PATCH 3/3] 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 25ce9e34c5..6e7379f216 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -457,7 +457,7 @@ include::cli:partial$cbcli/nav.adoc[] **** xref:rest-api:rotate-data-key.adoc[Rotate the Data Key] ** xref:n1ql:n1ql-rest-api/intro.adoc[] - *** xref:n1ql:n1ql-rest-api/index.adoc[] + *** xref:n1ql-rest-query:index.adoc[] **** xref:n1ql:n1ql-rest-api/examplesrest.adoc[] ***** xref:n1ql:n1ql-rest-api/exsuccessful.adoc[] ***** xref:n1ql:n1ql-rest-api/expositional.adoc[] @@ -469,9 +469,9 @@ include::cli:partial$cbcli/nav.adoc[] ***** xref:n1ql:n1ql-rest-api/exunsupportedhttp.adoc[] ***** xref:n1ql:n1ql-rest-api/exauthhttp.adoc[] ***** xref:n1ql:n1ql-rest-api/exauthrequest.adoc[] - *** xref:n1ql:n1ql-rest-api/admin.adoc[Query Admin REST API] + *** xref:n1ql-rest-admin:index.adoc[] *** xref:rest-api:rest-cluster-query-settings.adoc[Query Settings REST API] - *** xref:n1ql:n1ql-rest-api/functions.adoc[Query Functions REST API] + *** xref:n1ql-rest-functions:index.adoc[Query Functions REST API] ** xref:rest-api:rest-index-service.adoc[Index Service API] *** xref:rest-api:get-settings-indexes.adoc[Retrieve GSI Settings]