Skip to content

Commit dbad3a1

Browse files
committed
DOC-12650: Convert N1QL REST API references to use OpenAPI generator (#3713)
* Delete old N1QL REST API pages * Update links * Update nav
1 parent 6ef444a commit dbad3a1

File tree

6 files changed

+37
-83
lines changed

6 files changed

+37
-83
lines changed

modules/ROOT/nav.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,7 @@ include::cli:partial$cbcli/nav.adoc[]
458458
**** xref:rest-api:rotate-data-key.adoc[Rotate the Data Key]
459459
460460
** xref:n1ql:n1ql-rest-api/intro.adoc[]
461-
*** xref:n1ql:n1ql-rest-api/index.adoc[]
461+
*** xref:n1ql-rest-query:index.adoc[]
462462
**** xref:n1ql:n1ql-rest-api/examplesrest.adoc[]
463463
***** xref:n1ql:n1ql-rest-api/exsuccessful.adoc[]
464464
***** xref:n1ql:n1ql-rest-api/expositional.adoc[]
@@ -470,9 +470,9 @@ include::cli:partial$cbcli/nav.adoc[]
470470
***** xref:n1ql:n1ql-rest-api/exunsupportedhttp.adoc[]
471471
***** xref:n1ql:n1ql-rest-api/exauthhttp.adoc[]
472472
***** xref:n1ql:n1ql-rest-api/exauthrequest.adoc[]
473-
*** xref:n1ql:n1ql-rest-api/admin.adoc[Query Admin REST API]
473+
*** xref:n1ql-rest-admin:index.adoc[]
474474
*** xref:rest-api:rest-cluster-query-settings.adoc[Query Settings REST API]
475-
*** xref:n1ql:n1ql-rest-api/functions.adoc[Query Functions REST API]
475+
*** xref:n1ql-rest-functions:index.adoc[Query Functions REST API]
476476
477477
** xref:rest-api:rest-index-service.adoc[Index Service API]
478478
*** xref:rest-api:get-settings-indexes.adoc[Retrieve GSI Settings]

modules/n1ql/pages/n1ql-rest-api/admin.adoc

Lines changed: 0 additions & 17 deletions
This file was deleted.

modules/n1ql/pages/n1ql-rest-api/functions.adoc

Lines changed: 0 additions & 12 deletions
This file was deleted.

modules/n1ql/pages/n1ql-rest-api/index.adoc

Lines changed: 0 additions & 17 deletions
This file was deleted.

modules/rest-api/pages/rest-cluster-query-settings.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ include::partial$query-settings/security.adoc[]
1212

1313
== See Also
1414

15-
* [[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].
15+
* [[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].
1616

17-
* [[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].
17+
* [[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].

modules/rest-api/partials/rest-query-service-table.adoc

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77

88
| `POST`
99
| `/query/service`
10-
| xref:n1ql:n1ql-rest-api/index.adoc#_post_service[Query Service]
10+
| xref:n1ql-rest-query:index.adoc#post_service[Query Service]
1111

1212
| `GET`
1313
| `/query/service`
14-
| xref:n1ql:n1ql-rest-api/index.adoc#_get_service[Read-Only Query Service]
14+
| xref:n1ql-rest-query:index.adoc#get_service[Read-Only Query Service]
1515

1616
|===
1717
// end::query-service[]
@@ -25,108 +25,108 @@
2525

2626
| `GET`
2727
| `/admin/clusters`
28-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_clusters[Read All Clusters]
28+
| xref:n1ql-rest-admin:index.adoc#get_clusters[Read All Clusters]
2929

3030
| `GET`
3131
| `/admin/clusters/{cluster}`
32-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_cluster[Read a Cluster]
32+
| xref:n1ql-rest-admin:index.adoc#get_cluster[Read a Cluster]
3333

3434
| `GET`
3535
| `/admin/clusters/{cluster}/nodes`
36-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_nodes[Read All Nodes]
36+
| xref:n1ql-rest-admin:index.adoc#get_nodes[Read All Nodes]
3737

3838
| `GET`
3939
| `/admin/clusters/{cluster}/nodes/{node}`
40-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_node[Read a Node]
40+
| xref:n1ql-rest-admin:index.adoc#get_node[Read a Node]
4141

4242
| `GET`
4343
| `/admin/config`
44-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_config[Read Configuration]
44+
| xref:n1ql-rest-admin:index.adoc#get_config[Read Configuration]
4545

4646
| `GET`
4747
| `/admin/prepareds`
48-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_prepareds[Retrieve All Prepared Statements]
48+
| xref:n1ql-rest-admin:index.adoc#get_prepareds[Retrieve All Prepared Statements]
4949

5050
| `GET`
5151
| `/admin/prepareds/{name}`
52-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_prepared[Retrieve a Prepared Statement]
52+
| xref:n1ql-rest-admin:index.adoc#get_prepared[Retrieve a Prepared Statement]
5353

5454
| `DELETE`
5555
| `/admin/prepareds/{name}`
56-
| xref:n1ql:n1ql-rest-api/admin.adoc#_delete_prepared[Delete a Prepared Statement]
56+
| xref:n1ql-rest-admin:index.adoc#delete_prepared[Delete a Prepared Statement]
5757

5858
| `GET`
5959
| `/admin/indexes/prepareds`
60-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_prepared_indexes[Retrieve Prepared Index Statements]
60+
| xref:n1ql-rest-admin:index.adoc#get_prepared_indexes[Retrieve Prepared Index Statements]
6161

6262
| `GET`
6363
| `/admin/active_requests`
64-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_active_requests[Retrieve All Active Requests]
64+
| xref:n1ql-rest-admin:index.adoc#get_active_requests[Retrieve All Active Requests]
6565

6666
| `GET`
6767
| `/admin/active_requests/{request}`
68-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_active_request[Retrieve an Active Request]
68+
| xref:n1ql-rest-admin:index.adoc#get_active_request[Retrieve an Active Request]
6969

7070
| `DELETE`
7171
| `/admin/active_requests/{request}`
72-
| xref:n1ql:n1ql-rest-api/admin.adoc#_delete_active_request[Delete an Active Request]
72+
| xref:n1ql-rest-admin:index.adoc#delete_active_request[Delete an Active Request]
7373

7474
| `GET`
7575
| `/admin/indexes/active_requests`
76-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_active_indexes[Retrieve Active Index Requests]
76+
| xref:n1ql-rest-admin:index.adoc#get_active_indexes[Retrieve Active Index Requests]
7777

7878
| `GET`
7979
| `/admin/completed_requests`
80-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_completed_requests[Retrieve All Completed Requests]
80+
| xref:n1ql-rest-admin:index.adoc#get_completed_requests[Retrieve All Completed Requests]
8181

8282
| `GET`
8383
| `/admin/completed_requests/{request}`
84-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_completed_request[Retrieve a Completed Request]
84+
| xref:n1ql-rest-admin:index.adoc#get_completed_request[Retrieve a Completed Request]
8585

8686
| `DELETE`
8787
| `/admin/completed_requests/{request}`
88-
| xref:n1ql:n1ql-rest-api/admin.adoc#_delete_completed_request[Delete a Completed Request]
88+
| xref:n1ql-rest-admin:index.adoc#delete_completed_request[Delete a Completed Request]
8989

9090
| `GET`
9191
| `/admin/indexes/completed_requests`
92-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_completed_indexes[Retrieve Completed Index Requests]
92+
| xref:n1ql-rest-admin:index.adoc#get_completed_indexes[Retrieve Completed Index Requests]
9393

9494
| `GET`
9595
| `/admin/vitals`
96-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_vitals[Retrieve Vitals]
96+
| xref:n1ql-rest-admin:index.adoc#get_vitals[Retrieve Vitals]
9797

9898
| `GET`
9999
| `/admin/stats`
100-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_stats[Retrieve All Statistics]
100+
| xref:n1ql-rest-admin:index.adoc#get_stats[Retrieve All Statistics]
101101

102102
| `GET`
103103
| `/admin/stats/{stats}`
104-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_stat[Retrieve a Statistic]
104+
| xref:n1ql-rest-admin:index.adoc#get_stat[Retrieve a Statistic]
105105

106106
// deprecated method
107107
// | `GET`
108108
// | `/debug/vars`
109-
// | xref:n1ql:n1ql-rest-api/admin.adoc#_get_debug_vars[Get Debug Variables]
109+
// | xref:n1ql-rest-admin:index.adoc#get_debug_vars[Get Debug Variables]
110110

111111
| `GET`
112112
| `/admin/settings`
113-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_settings[Retrieve Node-Level Query Settings]
113+
| xref:n1ql-rest-admin:index.adoc#get_settings[Retrieve Node-Level Query Settings]
114114

115115
| `POST`
116116
| `/admin/settings`
117-
| xref:n1ql:n1ql-rest-api/admin.adoc#_post_settings[Update Node-Level Query Settings]
117+
| xref:n1ql-rest-admin:index.adoc#post_settings[Update Node-Level Query Settings]
118118

119119
| `GET`
120120
| `/admin/ping`
121-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_ping[Ping]
121+
| xref:n1ql-rest-admin:index.adoc#get_ping[Ping]
122122

123123
| `GET`
124124
| `/admin/gc`
125-
| xref:n1ql:n1ql-rest-api/admin.adoc#_get_gc[Run Garbage Collector]
125+
| xref:n1ql-rest-admin:index.adoc#get_gc[Run Garbage Collector]
126126

127127
| `POST`
128128
| `/admin/gc`
129-
| xref:n1ql:n1ql-rest-api/admin.adoc#_post_gc[Run Garbage Collector and Release Memory]
129+
| xref:n1ql-rest-admin:index.adoc#post_gc[Run Garbage Collector and Release Memory]
130130

131131
|===
132132
// end::query-admin[]
@@ -166,19 +166,19 @@
166166

167167
| `GET`
168168
| `/evaluator/v1/libraries`
169-
| xref:n1ql:n1ql-rest-api/functions.adoc#_get_collection[Read All Libraries]
169+
| xref:n1ql-rest-functions:index.adoc#get_collection[Read All Libraries]
170170

171171
| `GET`
172172
| `/evaluator/v1/libraries/{library}`
173-
| xref:n1ql:n1ql-rest-api/functions.adoc#_get_library[Read a Library]
173+
| xref:n1ql-rest-functions:index.adoc#get_library[Read a Library]
174174

175175
| `POST`
176176
| `/evaluator/v1/libraries/{library}`
177-
| xref:n1ql:n1ql-rest-api/functions.adoc#_post_library[Create or Update a Library]
177+
| xref:n1ql-rest-functions:index.adoc#post_library[Create or Update a Library]
178178

179179
| `DELETE`
180180
| `/evaluator/v1/libraries/{library}`
181-
| xref:n1ql:n1ql-rest-api/functions.adoc#_delete_library[Delete a Library]
181+
| xref:n1ql-rest-functions:index.adoc#delete_library[Delete a Library]
182182

183183
|===
184184
// end::query-functions[]

0 commit comments

Comments
 (0)