diff --git a/.redocly.yaml b/.redocly.yaml index 6c7c3aab3f..4e30c99085 100644 --- a/.redocly.yaml +++ b/.redocly.yaml @@ -22,7 +22,6 @@ lint: rules: # disable unnecessary/invalid warnings operation-2xx-response: off # _blipsync 101 Upgrade ... - operation-operationId: off # Optional (mostly used for generating code) operation-summary: off # Optional field no-ambiguous-paths: off # /{db}/{doc} != /_debug/expvar no-identical-paths: off # /{db} != /{targetdb} diff --git a/docs/api/paths/admin/-.yaml b/docs/api/paths/admin/-.yaml index b61ce09c3d..92001949e2 100644 --- a/docs/api/paths/admin/-.yaml +++ b/docs/api/paths/admin/-.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get server information description: Returns information about the Sync Gateway node. @@ -18,6 +17,7 @@ get: $ref: ../../components/schemas.yaml#/NodeInfo tags: - Server + operationId: get_- head: responses: '200': @@ -26,3 +26,4 @@ head: - Server summary: Check if server online description: Check if the server is online by checking the status code of response. + operationId: head_- diff --git a/docs/api/paths/admin/_all_dbs.yaml b/docs/api/paths/admin/_all_dbs.yaml index e54cd5af3b..ad14504949 100644 --- a/docs/api/paths/admin/_all_dbs.yaml +++ b/docs/api/paths/admin/_all_dbs.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get a list of all the databases description: |- @@ -25,6 +24,7 @@ get: type: string tags: - Database Management + operationId: get__all_dbs head: summary: /_all_dbs description: |- @@ -36,3 +36,4 @@ head: description: OK tags: - Database Management + operationId: head__all_dbs diff --git a/docs/api/paths/admin/_config.yaml b/docs/api/paths/admin/_config.yaml index 8b71ceb7dd..28dd1a84aa 100644 --- a/docs/api/paths/admin/_config.yaml +++ b/docs/api/paths/admin/_config.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get server configuration description: |- @@ -33,6 +32,7 @@ get: $ref: ../../components/responses.yaml#/request-problem tags: - Server + operationId: get__config put: summary: Set runtime configuration description: |- @@ -57,3 +57,4 @@ put: $ref: ../../components/responses.yaml#/request-problem tags: - Server + operationId: put__config diff --git a/docs/api/paths/admin/_debug-fgprof.yaml b/docs/api/paths/admin/_debug-fgprof.yaml index df16139ef3..0bf3b03fd7 100644 --- a/docs/api/paths/admin/_debug-fgprof.yaml +++ b/docs/api/paths/admin/_debug-fgprof.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get fgprof profile description: |- @@ -25,6 +24,7 @@ get: type: string tags: - Profiling + operationId: get__debug-fgprof post: summary: Get fgprof profile description: |- @@ -44,3 +44,4 @@ post: type: string tags: - Profiling + operationId: post__debug-fgprof diff --git a/docs/api/paths/admin/_debug-pprof-block.yaml b/docs/api/paths/admin/_debug-pprof-block.yaml index 7aef6ba38b..6e49a85504 100644 --- a/docs/api/paths/admin/_debug-pprof-block.yaml +++ b/docs/api/paths/admin/_debug-pprof-block.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get block profile description: |- @@ -30,6 +29,7 @@ get: reason: Can only run one mutex profile at a time tags: - Profiling + operationId: get__debug-pprof-block post: summary: Get block profile description: |- @@ -54,3 +54,4 @@ post: reason: Can only run one mutex profile at a time tags: - Profiling + operationId: post__debug-pprof-block diff --git a/docs/api/paths/admin/_debug-pprof-cmdline.yaml b/docs/api/paths/admin/_debug-pprof-cmdline.yaml index 1cfd6fc76d..7711bb515f 100644 --- a/docs/api/paths/admin/_debug-pprof-cmdline.yaml +++ b/docs/api/paths/admin/_debug-pprof-cmdline.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get passed in command line parameters description: |- @@ -23,6 +22,7 @@ get: type: string tags: - Profiling + operationId: get__debug-pprof-cmdline post: summary: Get passed in command line parameters description: |- @@ -40,3 +40,4 @@ post: type: string tags: - Profiling + operationId: post__debug-pprof-cmdline diff --git a/docs/api/paths/admin/_debug-pprof-goroutine.yaml b/docs/api/paths/admin/_debug-pprof-goroutine.yaml index 74b552ca15..5b43e3df3a 100644 --- a/docs/api/paths/admin/_debug-pprof-goroutine.yaml +++ b/docs/api/paths/admin/_debug-pprof-goroutine.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get goroutine profile description: |- @@ -21,6 +20,7 @@ get: $ref: ../../components/responses.yaml#/pprof-binary tags: - Profiling + operationId: get__debug-pprof-goroutine post: summary: Get goroutine profile description: |- @@ -36,3 +36,4 @@ post: $ref: ../../components/responses.yaml#/pprof-binary tags: - Profiling + operationId: post__debug-pprof-goroutine diff --git a/docs/api/paths/admin/_debug-pprof-heap.yaml b/docs/api/paths/admin/_debug-pprof-heap.yaml index 43aa660486..b5edb719e9 100644 --- a/docs/api/paths/admin/_debug-pprof-heap.yaml +++ b/docs/api/paths/admin/_debug-pprof-heap.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get the heap pprof debug file description: |- @@ -19,6 +18,7 @@ get: $ref: ../../components/responses.yaml#/pprof-binary tags: - Profiling + operationId: get__debug-pprof-heap post: summary: Get the heap pprof debug file description: |- @@ -32,3 +32,4 @@ post: $ref: ../../components/responses.yaml#/pprof-binary tags: - Profiling + operationId: post__debug-pprof-heap diff --git a/docs/api/paths/admin/_debug-pprof-mutex.yaml b/docs/api/paths/admin/_debug-pprof-mutex.yaml index 5ace310643..4d11a525d6 100644 --- a/docs/api/paths/admin/_debug-pprof-mutex.yaml +++ b/docs/api/paths/admin/_debug-pprof-mutex.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get mutex profile description: |- @@ -30,6 +29,7 @@ get: reason: Can only run one mutex profile at a time tags: - Profiling + operationId: get__debug-pprof-mutex post: summary: Get mutex profile description: |- @@ -54,3 +54,4 @@ post: reason: Can only run one mutex profile at a time tags: - Profiling + operationId: post__debug-pprof-mutex diff --git a/docs/api/paths/admin/_debug-pprof-profile.yaml b/docs/api/paths/admin/_debug-pprof-profile.yaml index 22d72cde65..b27b7d28e7 100644 --- a/docs/api/paths/admin/_debug-pprof-profile.yaml +++ b/docs/api/paths/admin/_debug-pprof-profile.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get the profile pprof debug file description: |- @@ -19,6 +18,7 @@ get: $ref: ../../components/responses.yaml#/pprof-binary tags: - Profiling + operationId: get__debug-pprof-profile post: summary: Get the profile pprof debug file description: |- @@ -32,3 +32,4 @@ post: $ref: ../../components/responses.yaml#/pprof-binary tags: - Profiling + operationId: post__debug-pprof-profile diff --git a/docs/api/paths/admin/_debug-pprof-symbol.yaml b/docs/api/paths/admin/_debug-pprof-symbol.yaml index 52a95f7f53..bb141b1176 100644 --- a/docs/api/paths/admin/_debug-pprof-symbol.yaml +++ b/docs/api/paths/admin/_debug-pprof-symbol.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get symbol pprof debug information description: |- @@ -21,6 +20,7 @@ get: type: string tags: - Profiling + operationId: get__debug-pprof-symbol post: summary: Get symbol pprof debug information description: |- @@ -36,3 +36,4 @@ post: type: string tags: - Profiling + operationId: post__debug-pprof-symbol diff --git a/docs/api/paths/admin/_debug-pprof-threadcreate.yaml b/docs/api/paths/admin/_debug-pprof-threadcreate.yaml index e88d85519b..2a0ce8f95e 100644 --- a/docs/api/paths/admin/_debug-pprof-threadcreate.yaml +++ b/docs/api/paths/admin/_debug-pprof-threadcreate.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get the threadcreate pprof debug file description: |- @@ -17,6 +16,7 @@ get: $ref: ../../components/responses.yaml#/pprof-binary tags: - Profiling + operationId: get__debug-pprof-threadcreate post: summary: Get the threadcreate pprof debug file description: |- @@ -28,3 +28,4 @@ post: $ref: ../../components/responses.yaml#/pprof-binary tags: - Profiling + operationId: post__debug-pprof-threadcreate diff --git a/docs/api/paths/admin/_debug-pprof-trace.yaml b/docs/api/paths/admin/_debug-pprof-trace.yaml index e14517ee14..239a56dc42 100644 --- a/docs/api/paths/admin/_debug-pprof-trace.yaml +++ b/docs/api/paths/admin/_debug-pprof-trace.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get trace profile description: |- @@ -25,6 +24,7 @@ get: $ref: ../../components/responses.yaml#/pprof-binary tags: - Profiling + operationId: get__debug-pprof-trace post: summary: Get trace profile description: |- @@ -44,3 +44,4 @@ post: $ref: ../../components/responses.yaml#/pprof-binary tags: - Profiling + operationId: post__debug-pprof-trace diff --git a/docs/api/paths/admin/_expvar.yaml b/docs/api/paths/admin/_expvar.yaml index 3095b5e001..c3e53f154c 100644 --- a/docs/api/paths/admin/_expvar.yaml +++ b/docs/api/paths/admin/_expvar.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get all Sync Gateway statistics description: |- @@ -27,3 +26,4 @@ get: $ref: ../../components/schemas.yaml#/ExpVars tags: - Metrics + operationId: get__expvar diff --git a/docs/api/paths/admin/_heap.yaml b/docs/api/paths/admin/_heap.yaml index 08d0f4f0eb..853d0c5344 100644 --- a/docs/api/paths/admin/_heap.yaml +++ b/docs/api/paths/admin/_heap.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - post: summary: Dump heap profile description: |- @@ -23,3 +22,4 @@ post: $ref: ../../components/responses.yaml#/request-problem tags: - Profiling + operationId: post__heap diff --git a/docs/api/paths/admin/_logging.yaml b/docs/api/paths/admin/_logging.yaml index 7f69bb4072..45cb311956 100644 --- a/docs/api/paths/admin/_logging.yaml +++ b/docs/api/paths/admin/_logging.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get console logging settings description: |- @@ -25,6 +24,7 @@ get: deprecated: true tags: - Server + operationId: get__logging put: summary: Set console logging settings description: |- @@ -51,6 +51,7 @@ put: deprecated: true tags: - Server + operationId: put__logging post: summary: Update console logging settings description: |- @@ -77,3 +78,4 @@ post: deprecated: true tags: - Server + operationId: post__logging diff --git a/docs/api/paths/admin/_post_upgrade.yaml b/docs/api/paths/admin/_post_upgrade.yaml index e8c5013bbc..cb803eec47 100644 --- a/docs/api/paths/admin/_post_upgrade.yaml +++ b/docs/api/paths/admin/_post_upgrade.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - post: summary: Run the post upgrade process on all databases description: |- @@ -56,3 +55,4 @@ post: - post_upgrade_results tags: - Server + operationId: post__post_upgrade diff --git a/docs/api/paths/admin/_profile-profilename.yaml b/docs/api/paths/admin/_profile-profilename.yaml index c9e647d534..a2a9faa349 100644 --- a/docs/api/paths/admin/_profile-profilename.yaml +++ b/docs/api/paths/admin/_profile-profilename.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - name: profilename in: path @@ -38,3 +37,4 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Profiling + operationId: post__profile-profilename diff --git a/docs/api/paths/admin/_profile.yaml b/docs/api/paths/admin/_profile.yaml index a77a8ea0ad..18a6d45b29 100644 --- a/docs/api/paths/admin/_profile.yaml +++ b/docs/api/paths/admin/_profile.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - post: summary: Start or Stop continuous CPU profiling description: |- @@ -27,3 +26,4 @@ post: $ref: ../../components/responses.yaml#/request-problem tags: - Profiling + operationId: post__profile diff --git a/docs/api/paths/admin/_sgcollect_info.yaml b/docs/api/paths/admin/_sgcollect_info.yaml index b5dddc3115..0f451e2c64 100644 --- a/docs/api/paths/admin/_sgcollect_info.yaml +++ b/docs/api/paths/admin/_sgcollect_info.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get the status of the Sync Gateway Collect Info description: |- @@ -32,6 +31,7 @@ get: - status tags: - Server + operationId: get__sgcollect_info post: summary: Start Sync Gateway Collect Info description: |- @@ -107,6 +107,7 @@ post: $ref: ../../components/schemas.yaml#/HTTP-Error tags: - Server + operationId: post__sgcollect_info delete: summary: Cancel the Sync Gateway Collect Info job description: |- @@ -131,3 +132,4 @@ delete: $ref: ../../components/responses.yaml#/request-problem tags: - Server + operationId: delete__sgcollect_info diff --git a/docs/api/paths/admin/_stats.yaml b/docs/api/paths/admin/_stats.yaml index 0e056a9274..e62ce9507d 100644 --- a/docs/api/paths/admin/_stats.yaml +++ b/docs/api/paths/admin/_stats.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get memory statistics description: |- @@ -29,3 +28,4 @@ get: additionalProperties: true tags: - Metrics + operationId: get__stats diff --git a/docs/api/paths/admin/_status.yaml b/docs/api/paths/admin/_status.yaml index 4c915ae34e..0acc69a7f6 100644 --- a/docs/api/paths/admin/_status.yaml +++ b/docs/api/paths/admin/_status.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get the server status description: |- @@ -25,3 +24,4 @@ get: $ref: ../../components/responses.yaml#/request-problem tags: - Server + operationId: get__status diff --git a/docs/api/paths/admin/db-.yaml b/docs/api/paths/admin/db-.yaml index 5aaa07e28f..d74cada125 100644 --- a/docs/api/paths/admin/db-.yaml +++ b/docs/api/paths/admin/db-.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -95,6 +94,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Database Management + operationId: get_db- delete: summary: Remove a database description: |- @@ -123,6 +123,7 @@ delete: $ref: ../../components/schemas.yaml#/HTTP-Error tags: - Database Management + operationId: delete_db- head: summary: Check if database exists description: |- @@ -138,6 +139,7 @@ head: $ref: ../../components/responses.yaml#/Not-found tags: - Database Management + operationId: head_db- put: summary: Create a new Sync Gateway database description: |- @@ -191,3 +193,4 @@ put: $ref: ../../components/schemas.yaml#/HTTP-Error tags: - Database Management + operationId: put_db- diff --git a/docs/api/paths/admin/db-_blipsync.yaml b/docs/api/paths/admin/db-_blipsync.yaml index 1afd4a6ca7..498e39c4d9 100644 --- a/docs/api/paths/admin/db-_blipsync.yaml +++ b/docs/api/paths/admin/db-_blipsync.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -42,3 +41,4 @@ get: reason: Can't upgrade this request to websocket connection tags: - Replication + operationId: get_db-_blipsync diff --git a/docs/api/paths/admin/db-_compact.yaml b/docs/api/paths/admin/db-_compact.yaml index 389ff3ba61..49c2b54543 100644 --- a/docs/api/paths/admin/db-_compact.yaml +++ b/docs/api/paths/admin/db-_compact.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db post: @@ -64,6 +63,7 @@ post: $ref: ../../components/schemas.yaml#/HTTP-Error tags: - Database Management + operationId: post_db-_compact get: summary: Get the status of the most recent compact operation description: |- @@ -87,3 +87,4 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Database Management + operationId: get_db-_compact diff --git a/docs/api/paths/admin/db-_config.yaml b/docs/api/paths/admin/db-_config.yaml index 44e8b238f7..556ce0501a 100644 --- a/docs/api/paths/admin/db-_config.yaml +++ b/docs/api/paths/admin/db-_config.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get database configuration description: |- @@ -45,6 +44,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Database Configuration + operationId: get_db-_config put: summary: Replace database configuration description: |- @@ -76,6 +76,7 @@ put: $ref: ../../components/responses.yaml#/DB-config-precondition-failed tags: - Database Configuration + operationId: put_db-_config post: summary: Update database configuration description: |- @@ -106,5 +107,6 @@ post: $ref: ../../components/responses.yaml#/DB-config-precondition-failed tags: - Database Configuration + operationId: post_db-_config parameters: - $ref: ../../components/parameters.yaml#/db diff --git a/docs/api/paths/admin/db-_design-ddoc-_view-view.yaml b/docs/api/paths/admin/db-_design-ddoc-_view-view.yaml index 496d14db75..252cfc975a 100644 --- a/docs/api/paths/admin/db-_design-ddoc-_view-view.yaml +++ b/docs/api/paths/admin/db-_design-ddoc-_view-view.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db - $ref: ../../components/parameters.yaml#/ddoc @@ -78,3 +77,4 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Unsupported + operationId: get_db-_design-ddoc-_view-view diff --git a/docs/api/paths/admin/db-_design-ddoc.yaml b/docs/api/paths/admin/db-_design-ddoc.yaml index df01291256..8317e6d7af 100644 --- a/docs/api/paths/admin/db-_design-ddoc.yaml +++ b/docs/api/paths/admin/db-_design-ddoc.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db - $ref: ../../components/parameters.yaml#/ddoc @@ -33,6 +32,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Unsupported + operationId: get_db-_design-ddoc put: summary: Update views of a design document | Unsupported description: |- @@ -57,6 +57,7 @@ put: $ref: ../../components/responses.yaml#/Not-found tags: - Unsupported + operationId: put_db-_design-ddoc delete: summary: Delete a design document | Unsupported description: |- @@ -76,6 +77,7 @@ delete: $ref: ../../components/responses.yaml#/Not-found tags: - Unsupported + operationId: delete_db-_design-ddoc head: responses: '200': @@ -96,3 +98,4 @@ head: * Sync Gateway Application * Sync Gateway Application Read Only summary: Check if view of design document exists | Unsupported + operationId: head_db-_design-ddoc diff --git a/docs/api/paths/admin/db-_dump-view.yaml b/docs/api/paths/admin/db-_dump-view.yaml index e67b73b425..f0ca8522b3 100644 --- a/docs/api/paths/admin/db-_dump-view.yaml +++ b/docs/api/paths/admin/db-_dump-view.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db - $ref: ../../components/parameters.yaml#/view @@ -37,3 +36,4 @@ get: $ref: ../../components/schemas.yaml#/HTTP-Error tags: - Unsupported + operationId: get_db-_dump-view diff --git a/docs/api/paths/admin/db-_ensure_full_commit.yaml b/docs/api/paths/admin/db-_ensure_full_commit.yaml index 3e0bb22d2c..8ca0d2f188 100644 --- a/docs/api/paths/admin/db-_ensure_full_commit.yaml +++ b/docs/api/paths/admin/db-_ensure_full_commit.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db post: @@ -35,3 +34,4 @@ post: default: true tags: - Database Management + operationId: post_db-_ensure_full_commit diff --git a/docs/api/paths/admin/db-_facebook.yaml b/docs/api/paths/admin/db-_facebook.yaml index 98447a2523..592be49aa4 100644 --- a/docs/api/paths/admin/db-_facebook.yaml +++ b/docs/api/paths/admin/db-_facebook.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db post: @@ -68,3 +67,4 @@ post: deprecated: true tags: - Authentication + operationId: post_db-_facebook diff --git a/docs/api/paths/admin/db-_flush.yaml b/docs/api/paths/admin/db-_flush.yaml index 34d7c42848..33bdbc13de 100644 --- a/docs/api/paths/admin/db-_flush.yaml +++ b/docs/api/paths/admin/db-_flush.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db post: @@ -33,3 +32,4 @@ post: $ref: ../../components/schemas.yaml#/HTTP-Error tags: - Unsupported + operationId: post_db-_flush diff --git a/docs/api/paths/admin/db-_google.yaml b/docs/api/paths/admin/db-_google.yaml index 2760aa3cbd..82560cab8e 100644 --- a/docs/api/paths/admin/db-_google.yaml +++ b/docs/api/paths/admin/db-_google.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db post: @@ -59,3 +58,4 @@ post: deprecated: true tags: - Authentication + operationId: post_db-_google diff --git a/docs/api/paths/admin/db-_offline.yaml b/docs/api/paths/admin/db-_offline.yaml index 666e792593..8d1ba1c086 100644 --- a/docs/api/paths/admin/db-_offline.yaml +++ b/docs/api/paths/admin/db-_offline.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db post: @@ -39,3 +38,4 @@ post: $ref: ../../components/schemas.yaml#/HTTP-Error tags: - Database Management + operationId: post_db-_offline diff --git a/docs/api/paths/admin/db-_oidc.yaml b/docs/api/paths/admin/db-_oidc.yaml index d45cc58ab6..f6e9f9af92 100644 --- a/docs/api/paths/admin/db-_oidc.yaml +++ b/docs/api/paths/admin/db-_oidc.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -30,3 +29,4 @@ get: $ref: ../../components/responses.yaml#/OIDC-connection tags: - Authentication + operationId: get_db-_oidc diff --git a/docs/api/paths/admin/db-_oidc_callback.yaml b/docs/api/paths/admin/db-_oidc_callback.yaml index 53d5bfc2dc..f5b3d68508 100644 --- a/docs/api/paths/admin/db-_oidc_callback.yaml +++ b/docs/api/paths/admin/db-_oidc_callback.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -42,3 +41,4 @@ get: type: string tags: - Authentication + operationId: get_db-_oidc_callback diff --git a/docs/api/paths/admin/db-_oidc_challenge.yaml b/docs/api/paths/admin/db-_oidc_challenge.yaml index 0a26e5591b..fe98c61908 100644 --- a/docs/api/paths/admin/db-_oidc_challenge.yaml +++ b/docs/api/paths/admin/db-_oidc_challenge.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -30,3 +29,4 @@ get: description: Unable to connect and validate with the OpenID Connect provider requested tags: - Authentication + operationId: get_db-_oidc_challenge diff --git a/docs/api/paths/admin/db-_oidc_refresh.yaml b/docs/api/paths/admin/db-_oidc_refresh.yaml index 5d91258eb5..bf2aa93aa5 100644 --- a/docs/api/paths/admin/db-_oidc_refresh.yaml +++ b/docs/api/paths/admin/db-_oidc_refresh.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -30,3 +29,4 @@ get: $ref: ../../components/responses.yaml#/OIDC-connection tags: - Authentication + operationId: get_db-_oidc_refresh diff --git a/docs/api/paths/admin/db-_oidc_testing-.well-known-openid-configuration.yaml b/docs/api/paths/admin/db-_oidc_testing-.well-known-openid-configuration.yaml index c3ab0e7a83..a08dfa1ceb 100644 --- a/docs/api/paths/admin/db-_oidc_testing-.well-known-openid-configuration.yaml +++ b/docs/api/paths/admin/db-_oidc_testing-.well-known-openid-configuration.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -52,3 +51,4 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Authentication + operationId: get_db-_oidc_testing-.well-known-openid-configuration diff --git a/docs/api/paths/admin/db-_oidc_testing-authenticate.yaml b/docs/api/paths/admin/db-_oidc_testing-authenticate.yaml index f416f5625c..c55c42a658 100644 --- a/docs/api/paths/admin/db-_oidc_testing-authenticate.yaml +++ b/docs/api/paths/admin/db-_oidc_testing-authenticate.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -43,6 +42,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Authentication + operationId: get_db-_oidc_testing-authenticate post: summary: OpenID Connect mock login page handler description: 'Used to handle the login page displayed for the `GET /{db}/_oidc_testing/authorize` endpoint.' @@ -60,3 +60,4 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Authentication + operationId: post_db-_oidc_testing-authenticate diff --git a/docs/api/paths/admin/db-_oidc_testing-authorize.yaml b/docs/api/paths/admin/db-_oidc_testing-authorize.yaml index d3c18077df..ab1978e24f 100644 --- a/docs/api/paths/admin/db-_oidc_testing-authorize.yaml +++ b/docs/api/paths/admin/db-_oidc_testing-authorize.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -26,6 +25,7 @@ get: $ref: ../../components/responses.yaml#/OIDC-testing-internal-error tags: - Authentication + operationId: get_db-_oidc_testing-authorize post: summary: OpenID Connect mock login page description: Show a mock OpenID Connect login page for the client to log in to. @@ -44,3 +44,4 @@ post: $ref: ../../components/responses.yaml#/OIDC-testing-internal-error tags: - Authentication + operationId: post_db-_oidc_testing-authorize diff --git a/docs/api/paths/admin/db-_oidc_testing-certs.yaml b/docs/api/paths/admin/db-_oidc_testing-certs.yaml index c217d3dece..5b104952b1 100644 --- a/docs/api/paths/admin/db-_oidc_testing-certs.yaml +++ b/docs/api/paths/admin/db-_oidc_testing-certs.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -59,3 +58,4 @@ get: type: string tags: - Authentication + operationId: get_db-_oidc_testing-certs diff --git a/docs/api/paths/admin/db-_oidc_testing-token.yaml b/docs/api/paths/admin/db-_oidc_testing-token.yaml index 0c71818614..7b59d5c56d 100644 --- a/docs/api/paths/admin/db-_oidc_testing-token.yaml +++ b/docs/api/paths/admin/db-_oidc_testing-token.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db post: @@ -39,3 +38,4 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Authentication + operationId: post_db-_oidc_testing-token diff --git a/docs/api/paths/admin/db-_online.yaml b/docs/api/paths/admin/db-_online.yaml index ec09bd0ca8..02c43ccd77 100644 --- a/docs/api/paths/admin/db-_online.yaml +++ b/docs/api/paths/admin/db-_online.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db post: @@ -49,3 +48,4 @@ post: $ref: ../../components/schemas.yaml#/HTTP-Error tags: - Database Management + operationId: post_db-_online diff --git a/docs/api/paths/admin/db-_repair.yaml b/docs/api/paths/admin/db-_repair.yaml index 9745fb0840..664b1dcff5 100644 --- a/docs/api/paths/admin/db-_repair.yaml +++ b/docs/api/paths/admin/db-_repair.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db post: @@ -21,4 +20,4 @@ post: description: This endpoint is disabled tags: - Unsupported - + operationId: post_db-_repair diff --git a/docs/api/paths/admin/db-_replication-.yaml b/docs/api/paths/admin/db-_replication-.yaml index 8787dcde6e..31335b0ee5 100644 --- a/docs/api/paths/admin/db-_replication-.yaml +++ b/docs/api/paths/admin/db-_replication-.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -29,6 +28,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Replication + operationId: get_db-_replication- post: summary: Upsert a replication description: |- @@ -52,6 +52,7 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Replication + operationId: post_db-_replication- head: summary: /{db}/_replication/ responses: @@ -65,3 +66,4 @@ head: Required Sync Gateway RBAC roles: * Sync Gateway Replicator + operationId: head_db-_replication- diff --git a/docs/api/paths/admin/db-_replication-replicationid.yaml b/docs/api/paths/admin/db-_replication-replicationid.yaml index 28bed8dd25..783815ac6a 100644 --- a/docs/api/paths/admin/db-_replication-replicationid.yaml +++ b/docs/api/paths/admin/db-_replication-replicationid.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db - $ref: ../../components/parameters.yaml#/replicationid @@ -28,6 +27,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Replication + operationId: get_db-_replication-replicationid put: summary: Upsert a replication description: |- @@ -53,6 +53,7 @@ put: $ref: ../../components/responses.yaml#/Not-found tags: - Replication + operationId: put_db-_replication-replicationid delete: summary: Stop and delete a replication description: |- @@ -70,6 +71,7 @@ delete: $ref: ../../components/responses.yaml#/Not-found tags: - Replication + operationId: delete_db-_replication-replicationid head: responses: '200': @@ -85,3 +87,4 @@ head: Required Sync Gateway RBAC roles: * Sync Gateway Replicator + operationId: head_db-_replication-replicationid diff --git a/docs/api/paths/admin/db-_replicationStatus-.yaml b/docs/api/paths/admin/db-_replicationStatus-.yaml index 15505ff6da..ec6eb83787 100644 --- a/docs/api/paths/admin/db-_replicationStatus-.yaml +++ b/docs/api/paths/admin/db-_replicationStatus-.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -34,6 +33,7 @@ get: $ref: ../../components/responses.yaml#/request-problem tags: - Replication + operationId: get_db-_replicationStatus- head: summary: /{db}/_replicationStatus/ responses: @@ -47,3 +47,4 @@ head: Required Sync Gateway RBAC roles: * Sync Gateway Replicator + operationId: head_db-_replicationStatus- diff --git a/docs/api/paths/admin/db-_replicationStatus-replicationid.yaml b/docs/api/paths/admin/db-_replicationStatus-replicationid.yaml index 805b13c00d..e4ca31bd19 100644 --- a/docs/api/paths/admin/db-_replicationStatus-replicationid.yaml +++ b/docs/api/paths/admin/db-_replicationStatus-replicationid.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db - $ref: ../../components/parameters.yaml#/replicationid @@ -39,6 +38,7 @@ get: $ref: ../../components/schemas.yaml#/HTTP-Error tags: - Replication + operationId: get_db-_replicationStatus-replicationid put: summary: Control a replication state description: |- @@ -76,6 +76,7 @@ put: $ref: ../../components/responses.yaml#/Not-found tags: - Replication + operationId: put_db-_replicationStatus-replicationid head: responses: '200': @@ -98,3 +99,4 @@ head: Required Sync Gateway RBAC roles: * Sync Gateway Replicator + operationId: head_db-_replicationStatus-replicationid diff --git a/docs/api/paths/admin/db-_resync.yaml b/docs/api/paths/admin/db-_resync.yaml index 414305de56..3fc216d51b 100644 --- a/docs/api/paths/admin/db-_resync.yaml +++ b/docs/api/paths/admin/db-_resync.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -27,6 +26,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Database Management + operationId: get_db-_resync post: summary: Start or stop Resync description: | @@ -90,3 +90,4 @@ post: $ref: ../../components/schemas.yaml#/HTTP-Error tags: - Database Management + operationId: post_db-_resync diff --git a/docs/api/paths/admin/db-_role-.yaml b/docs/api/paths/admin/db-_role-.yaml index 63b1c167cc..c8b91079c8 100644 --- a/docs/api/paths/admin/db-_role-.yaml +++ b/docs/api/paths/admin/db-_role-.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -47,6 +46,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Database Security + operationId: get_db-_role- post: summary: Create a new role description: |- @@ -67,6 +67,7 @@ post: $ref: ../../components/responses.yaml#/Conflict tags: - Database Security + operationId: post_db-_role- head: summary: /{db}/_role/ responses: @@ -82,3 +83,4 @@ head: * Sync Gateway Architect * Sync Gateway Application * Sync Gateway Application Read Only + operationId: head_db-_role- diff --git a/docs/api/paths/admin/db-_role-name.yaml b/docs/api/paths/admin/db-_role-name.yaml index 31e94167ca..687537e65f 100644 --- a/docs/api/paths/admin/db-_role-name.yaml +++ b/docs/api/paths/admin/db-_role-name.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db - $ref: ../../components/parameters.yaml#/role-name @@ -26,6 +25,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Database Security + operationId: get_db-_role-name put: summary: Upsert a role description: |- @@ -46,6 +46,7 @@ put: $ref: ../../components/responses.yaml#/Not-found tags: - Database Security + operationId: put_db-_role-name delete: summary: Delete a role description: |- @@ -62,6 +63,7 @@ delete: $ref: ../../components/responses.yaml#/Not-found tags: - Database Security + operationId: delete_db-_role-name head: responses: '200': @@ -79,3 +81,4 @@ head: * Sync Gateway Application * Sync Gateway Application Read Only summary: Check if role exists + operationId: head_db-_role-name diff --git a/docs/api/paths/admin/db-_session-sessionid.yaml b/docs/api/paths/admin/db-_session-sessionid.yaml index 062445f518..10b5ca947c 100644 --- a/docs/api/paths/admin/db-_session-sessionid.yaml +++ b/docs/api/paths/admin/db-_session-sessionid.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db - $ref: ../../components/parameters.yaml#/sessionid @@ -26,6 +25,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Session + operationId: get_db-_session-sessionid delete: summary: Remove session description: |- @@ -42,3 +42,4 @@ delete: $ref: ../../components/responses.yaml#/Not-found tags: - Session + operationId: delete_db-_session-sessionid diff --git a/docs/api/paths/admin/db-_session.yaml b/docs/api/paths/admin/db-_session.yaml index 69c2eaf17a..722275371c 100644 --- a/docs/api/paths/admin/db-_session.yaml +++ b/docs/api/paths/admin/db-_session.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -18,6 +17,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Session + operationId: get_db-_session post: summary: Create a new user session description: |- @@ -71,6 +71,7 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Session + operationId: post_db-_session head: summary: /{db}/_session responses: @@ -80,3 +81,4 @@ head: $ref: ../../components/responses.yaml#/Not-found tags: - Session + operationId: head_db-_session diff --git a/docs/api/paths/admin/db-_user-.yaml b/docs/api/paths/admin/db-_user-.yaml index a94b23a243..3e4fa20f02 100644 --- a/docs/api/paths/admin/db-_user-.yaml +++ b/docs/api/paths/admin/db-_user-.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -38,6 +37,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Database Security + operationId: get_db-_user- post: summary: Create a new user description: |- @@ -58,6 +58,7 @@ post: $ref: ../../components/responses.yaml#/Conflict tags: - Database Security + operationId: post_db-_user- head: summary: /{db}/_user/ responses: @@ -73,3 +74,4 @@ head: * Sync Gateway Architect * Sync Gateway Application * Sync Gateway Application Read Only + operationId: head_db-_user- diff --git a/docs/api/paths/admin/db-_user-name-_session-sessionid.yaml b/docs/api/paths/admin/db-_user-name-_session-sessionid.yaml index e15c7e193c..334190b07c 100644 --- a/docs/api/paths/admin/db-_user-name-_session-sessionid.yaml +++ b/docs/api/paths/admin/db-_user-name-_session-sessionid.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db - $ref: ../../components/parameters.yaml#/user-name @@ -26,3 +25,4 @@ delete: $ref: ../../components/responses.yaml#/Not-found tags: - Session + operationId: delete_db-_user-name-_session-sessionid diff --git a/docs/api/paths/admin/db-_user-name-_session.yaml b/docs/api/paths/admin/db-_user-name-_session.yaml index 84d2c6a4ae..2ad331cbdf 100644 --- a/docs/api/paths/admin/db-_user-name-_session.yaml +++ b/docs/api/paths/admin/db-_user-name-_session.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db - $ref: ../../components/parameters.yaml#/user-name @@ -27,3 +26,4 @@ delete: $ref: ../../components/responses.yaml#/Not-found tags: - Session + operationId: delete_db-_user-name-_session diff --git a/docs/api/paths/admin/db-_user-name.yaml b/docs/api/paths/admin/db-_user-name.yaml index a1881b533a..6b782d3a89 100644 --- a/docs/api/paths/admin/db-_user-name.yaml +++ b/docs/api/paths/admin/db-_user-name.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db - $ref: ../../components/parameters.yaml#/user-name @@ -26,6 +25,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Database Security + operationId: get_db-_user-name put: summary: Upsert a user description: |- @@ -46,6 +46,7 @@ put: $ref: ../../components/responses.yaml#/Not-found tags: - Database Security + operationId: put_db-_user-name delete: summary: Delete a user description: |- @@ -62,6 +63,7 @@ delete: $ref: ../../components/responses.yaml#/Not-found tags: - Database Security + operationId: delete_db-_user-name head: responses: '200': @@ -79,3 +81,4 @@ head: * Sync Gateway Architect * Sync Gateway Application * Sync Gateway Application Read Only + operationId: head_db-_user-name diff --git a/docs/api/paths/admin/db-_view-view.yaml b/docs/api/paths/admin/db-_view-view.yaml index 2fe92c94ca..c9c168e864 100644 --- a/docs/api/paths/admin/db-_view-view.yaml +++ b/docs/api/paths/admin/db-_view-view.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db - $ref: ../../components/parameters.yaml#/view @@ -77,3 +76,4 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Unsupported + operationId: get_db-_view-view diff --git a/docs/api/paths/admin/keyspace-.yaml b/docs/api/paths/admin/keyspace-.yaml index c554e88ea8..a3853a77ff 100644 --- a/docs/api/paths/admin/keyspace-.yaml +++ b/docs/api/paths/admin/keyspace-.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace post: @@ -49,3 +48,4 @@ post: $ref: ../../components/responses.yaml#/Invalid-content-type tags: - Document + operationId: post_keyspace- diff --git a/docs/api/paths/admin/keyspace-_all_docs.yaml b/docs/api/paths/admin/keyspace-_all_docs.yaml index 77b95285d8..e7c44f1a5b 100644 --- a/docs/api/paths/admin/keyspace-_all_docs.yaml +++ b/docs/api/paths/admin/keyspace-_all_docs.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace get: @@ -36,6 +35,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Document + operationId: get_keyspace-_all_docs post: summary: Get all the documents in the database using a built-in view description: |- @@ -76,6 +76,7 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Document + operationId: post_keyspace-_all_docs head: summary: /{db}/_all_docs responses: @@ -102,3 +103,4 @@ head: * Sync Gateway Application * Sync Gateway Application Read Only + operationId: head_keyspace-_all_docs diff --git a/docs/api/paths/admin/keyspace-_bulk_docs.yaml b/docs/api/paths/admin/keyspace-_bulk_docs.yaml index 4c7200bce5..abadc50d6c 100644 --- a/docs/api/paths/admin/keyspace-_bulk_docs.yaml +++ b/docs/api/paths/admin/keyspace-_bulk_docs.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace post: @@ -107,3 +106,4 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Document + operationId: post_keyspace-_bulk_docs diff --git a/docs/api/paths/admin/keyspace-_bulk_get.yaml b/docs/api/paths/admin/keyspace-_bulk_get.yaml index 43e8a1e519..ad53207e90 100644 --- a/docs/api/paths/admin/keyspace-_bulk_get.yaml +++ b/docs/api/paths/admin/keyspace-_bulk_get.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace post: @@ -78,3 +77,4 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Document + operationId: post_keyspace-_bulk_get diff --git a/docs/api/paths/admin/keyspace-_changes.yaml b/docs/api/paths/admin/keyspace-_changes.yaml index 51c045c93a..2ddb95633a 100644 --- a/docs/api/paths/admin/keyspace-_changes.yaml +++ b/docs/api/paths/admin/keyspace-_changes.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace get: @@ -106,6 +105,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Database Management + operationId: get_keyspace-_changes post: summary: Get changes list description: |- @@ -165,6 +165,7 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Database Management + operationId: post_keyspace-_changes head: summary: /{db}/_changes responses: @@ -181,3 +182,4 @@ head: * Sync Gateway Application * Sync Gateway Application Read Only + operationId: head_keyspace-_changes diff --git a/docs/api/paths/admin/keyspace-_config-import_filter.yaml b/docs/api/paths/admin/keyspace-_config-import_filter.yaml index bd2a7948ff..dde6ec8c4e 100644 --- a/docs/api/paths/admin/keyspace-_config-import_filter.yaml +++ b/docs/api/paths/admin/keyspace-_config-import_filter.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace get: @@ -34,6 +33,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Database Configuration + operationId: get_keyspace-_config-import_filter put: summary: Set database import filter description: |- @@ -62,6 +62,7 @@ put: $ref: ../../components/responses.yaml#/DB-config-precondition-failed tags: - Database Configuration + operationId: put_keyspace-_config-import_filter delete: summary: Delete import filter description: |- @@ -81,3 +82,4 @@ delete: $ref: ../../components/responses.yaml#/DB-config-precondition-failed tags: - Database Configuration + operationId: delete_keyspace-_config-import_filter diff --git a/docs/api/paths/admin/keyspace-_config-sync.yaml b/docs/api/paths/admin/keyspace-_config-sync.yaml index d37d507451..bb67438873 100644 --- a/docs/api/paths/admin/keyspace-_config-sync.yaml +++ b/docs/api/paths/admin/keyspace-_config-sync.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace get: @@ -38,6 +37,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Database Configuration + operationId: get_keyspace-_config-sync put: summary: Set database sync function description: |- @@ -70,6 +70,7 @@ put: $ref: ../../components/responses.yaml#/DB-config-precondition-failed tags: - Database Configuration + operationId: put_keyspace-_config-sync delete: summary: Remove custom sync function description: |- @@ -96,3 +97,4 @@ delete: $ref: ../../components/responses.yaml#/DB-config-precondition-failed tags: - Database Configuration + operationId: delete_keyspace-_config-sync diff --git a/docs/api/paths/admin/keyspace-_dumpchannel-channel.yaml b/docs/api/paths/admin/keyspace-_dumpchannel-channel.yaml index e36b60fc11..8442d6a51c 100644 --- a/docs/api/paths/admin/keyspace-_dumpchannel-channel.yaml +++ b/docs/api/paths/admin/keyspace-_dumpchannel-channel.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace - name: channel @@ -42,3 +41,4 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Unsupported + operationId: get_keyspace-_dumpchannel-channel diff --git a/docs/api/paths/admin/keyspace-_local-docid.yaml b/docs/api/paths/admin/keyspace-_local-docid.yaml index a01efd2770..5866d75784 100644 --- a/docs/api/paths/admin/keyspace-_local-docid.yaml +++ b/docs/api/paths/admin/keyspace-_local-docid.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace - name: docid @@ -34,6 +33,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Document + operationId: get_keyspace-_local-docid put: summary: Upsert a local document description: |- @@ -70,6 +70,7 @@ put: description: A revision ID conflict would result from updating this document revision. tags: - Document + operationId: put_keyspace-_local-docid delete: summary: Delete a local document description: |- @@ -98,6 +99,7 @@ delete: description: A revision ID conflict would result from deleting this document revision. tags: - Document + operationId: delete_keyspace-_local-docid head: responses: '200': @@ -118,3 +120,4 @@ head: * Sync Gateway Application * Sync Gateway Application Read Only + operationId: head_keyspace-_local-docid diff --git a/docs/api/paths/admin/keyspace-_purge.yaml b/docs/api/paths/admin/keyspace-_purge.yaml index a6ff7efecd..2dc6ae7554 100644 --- a/docs/api/paths/admin/keyspace-_purge.yaml +++ b/docs/api/paths/admin/keyspace-_purge.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace post: @@ -93,3 +92,4 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Document + operationId: post_keyspace-_purge diff --git a/docs/api/paths/admin/keyspace-_raw-docid.yaml b/docs/api/paths/admin/keyspace-_raw-docid.yaml index 8a7a6e4b81..9f86ce4df0 100644 --- a/docs/api/paths/admin/keyspace-_raw-docid.yaml +++ b/docs/api/paths/admin/keyspace-_raw-docid.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace - $ref: ../../components/parameters.yaml#/docid @@ -112,6 +111,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Document + operationId: get_keyspace-_raw-docid head: summary: /{keyspace}/_raw/{docid} responses: @@ -128,3 +128,4 @@ head: * Sync Gateway Application * Sync Gateway Application Read Only + operationId: head_keyspace-_raw-docid diff --git a/docs/api/paths/admin/keyspace-_revs_diff.yaml b/docs/api/paths/admin/keyspace-_revs_diff.yaml index dad0e46101..f72b115e18 100644 --- a/docs/api/paths/admin/keyspace-_revs_diff.yaml +++ b/docs/api/paths/admin/keyspace-_revs_diff.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace post: @@ -53,3 +52,4 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Database Management + operationId: post_keyspace-_revs_diff diff --git a/docs/api/paths/admin/keyspace-_revtree-docid.yaml b/docs/api/paths/admin/keyspace-_revtree-docid.yaml index 63e16bf2ac..cde0604a66 100644 --- a/docs/api/paths/admin/keyspace-_revtree-docid.yaml +++ b/docs/api/paths/admin/keyspace-_revtree-docid.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace - $ref: ../../components/parameters.yaml#/docid @@ -37,3 +36,4 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Unsupported + operationId: get_keyspace-_revtree-docid diff --git a/docs/api/paths/admin/keyspace-docid-attach.yaml b/docs/api/paths/admin/keyspace-docid-attach.yaml index ed0aec7092..223392c09e 100644 --- a/docs/api/paths/admin/keyspace-docid-attach.yaml +++ b/docs/api/paths/admin/keyspace-docid-attach.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace - $ref: ../../components/parameters.yaml#/docid @@ -68,6 +67,7 @@ get: description: Requested range exceeds content length tags: - Document + operationId: get_keyspace-docid-attach put: summary: Create or update an attachment on a document description: |- @@ -122,6 +122,7 @@ put: $ref: ../../components/responses.yaml#/Conflict tags: - Document + operationId: put_keyspace-docid-attach head: responses: '200': @@ -149,6 +150,7 @@ head: * Sync Gateway Application Read Only parameters: - $ref: ../../components/parameters.yaml#/rev + operationId: head_keyspace-docid-attach delete: summary: Delete an attachment on a document description: |- @@ -184,3 +186,4 @@ delete: $ref: ../../components/responses.yaml#/Conflict tags: - Document + operationId: delete_keyspace-docid-attach diff --git a/docs/api/paths/admin/keyspace-docid.yaml b/docs/api/paths/admin/keyspace-docid.yaml index bf0474c29f..e8c0d26438 100644 --- a/docs/api/paths/admin/keyspace-docid.yaml +++ b/docs/api/paths/admin/keyspace-docid.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace - $ref: ../../components/parameters.yaml#/docid @@ -65,6 +64,7 @@ get: $ref: ../../components/schemas.yaml#/HTTP-Error tags: - Document + operationId: get_keyspace-docid put: summary: Upsert a document description: |- @@ -112,6 +112,7 @@ put: $ref: ../../components/responses.yaml#/Invalid-content-type tags: - Document + operationId: put_keyspace-docid delete: summary: Delete a document description: |- @@ -134,6 +135,7 @@ delete: $ref: ../../components/responses.yaml#/Not-found tags: - Document + operationId: delete_keyspace-docid head: responses: '200': @@ -161,3 +163,4 @@ head: * Sync Gateway Application * Sync Gateway Application Read Only + operationId: head_keyspace-docid diff --git a/docs/api/paths/metric/_expvar.yaml b/docs/api/paths/metric/_expvar.yaml index 9d92ce991a..b57d9adcfe 100644 --- a/docs/api/paths/metric/_expvar.yaml +++ b/docs/api/paths/metric/_expvar.yaml @@ -6,7 +6,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get all Sync Gateway statistics description: |- @@ -26,3 +25,4 @@ get: application/javascript: schema: $ref: ../../components/schemas.yaml#/ExpVars + operationId: get__expvar diff --git a/docs/api/paths/metric/_metrics.yaml b/docs/api/paths/metric/_metrics.yaml index ed7280d18b..b6ed6e7dbc 100644 --- a/docs/api/paths/metric/_metrics.yaml +++ b/docs/api/paths/metric/_metrics.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Debugging/monitoring runtime stats in Prometheus Exposition format description: |- @@ -25,3 +24,4 @@ get: type: string tags: - Prometheus + operationId: get__metrics diff --git a/docs/api/paths/public/-.yaml b/docs/api/paths/public/-.yaml index b61ce09c3d..92001949e2 100644 --- a/docs/api/paths/public/-.yaml +++ b/docs/api/paths/public/-.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - get: summary: Get server information description: Returns information about the Sync Gateway node. @@ -18,6 +17,7 @@ get: $ref: ../../components/schemas.yaml#/NodeInfo tags: - Server + operationId: get_- head: responses: '200': @@ -26,3 +26,4 @@ head: - Server summary: Check if server online description: Check if the server is online by checking the status code of response. + operationId: head_- diff --git a/docs/api/paths/public/db-.yaml b/docs/api/paths/public/db-.yaml index c6dc5aaa3f..fd20177c2e 100644 --- a/docs/api/paths/public/db-.yaml +++ b/docs/api/paths/public/db-.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -66,6 +65,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Database Management + operationId: get_db- head: summary: Check if database exists description: Check if a database exists by using the response status code. @@ -76,3 +76,4 @@ head: $ref: ../../components/responses.yaml#/Not-found tags: - Database Management + operationId: head_db- diff --git a/docs/api/paths/public/db-_blipsync.yaml b/docs/api/paths/public/db-_blipsync.yaml index b794d407da..cccb8d254c 100644 --- a/docs/api/paths/public/db-_blipsync.yaml +++ b/docs/api/paths/public/db-_blipsync.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -37,3 +36,4 @@ get: reason: Can't upgrade this request to websocket connection tags: - Replication + operationId: get_db-_blipsync diff --git a/docs/api/paths/public/db-_design-ddoc-_view-view.yaml b/docs/api/paths/public/db-_design-ddoc-_view-view.yaml index 3ecb483b86..5ba0f07505 100644 --- a/docs/api/paths/public/db-_design-ddoc-_view-view.yaml +++ b/docs/api/paths/public/db-_design-ddoc-_view-view.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db - $ref: ../../components/parameters.yaml#/ddoc @@ -73,3 +72,4 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Unsupported + operationId: get_db-_design-ddoc-_view-view diff --git a/docs/api/paths/public/db-_design-ddoc.yaml b/docs/api/paths/public/db-_design-ddoc.yaml index eac673e7cb..4a20b5608d 100644 --- a/docs/api/paths/public/db-_design-ddoc.yaml +++ b/docs/api/paths/public/db-_design-ddoc.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db - $ref: ../../components/parameters.yaml#/ddoc @@ -28,6 +27,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Unsupported + operationId: get_db-_design-ddoc put: summary: Update views of a design document | Unsupported description: |- @@ -48,6 +48,7 @@ put: $ref: ../../components/responses.yaml#/Not-found tags: - Unsupported + operationId: put_db-_design-ddoc delete: summary: Delete a design document | Unsupported description: |- @@ -63,6 +64,7 @@ delete: $ref: ../../components/responses.yaml#/Not-found tags: - Unsupported + operationId: delete_db-_design-ddoc head: responses: '200': @@ -78,3 +80,4 @@ head: Check if a design document can be queried. summary: Check if view of design document exists | Unsupported + operationId: head_db-_design-ddoc diff --git a/docs/api/paths/public/db-_ensure_full_commit.yaml b/docs/api/paths/public/db-_ensure_full_commit.yaml index 206ab43674..2f2e97e5aa 100644 --- a/docs/api/paths/public/db-_ensure_full_commit.yaml +++ b/docs/api/paths/public/db-_ensure_full_commit.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db post: @@ -29,3 +28,4 @@ post: default: true tags: - Database Management + operationId: post_db-_ensure_full_commit diff --git a/docs/api/paths/public/db-_facebook.yaml b/docs/api/paths/public/db-_facebook.yaml index 98447a2523..592be49aa4 100644 --- a/docs/api/paths/public/db-_facebook.yaml +++ b/docs/api/paths/public/db-_facebook.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db post: @@ -68,3 +67,4 @@ post: deprecated: true tags: - Authentication + operationId: post_db-_facebook diff --git a/docs/api/paths/public/db-_google.yaml b/docs/api/paths/public/db-_google.yaml index 2760aa3cbd..82560cab8e 100644 --- a/docs/api/paths/public/db-_google.yaml +++ b/docs/api/paths/public/db-_google.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db post: @@ -59,3 +58,4 @@ post: deprecated: true tags: - Authentication + operationId: post_db-_google diff --git a/docs/api/paths/public/db-_oidc.yaml b/docs/api/paths/public/db-_oidc.yaml index d45cc58ab6..f6e9f9af92 100644 --- a/docs/api/paths/public/db-_oidc.yaml +++ b/docs/api/paths/public/db-_oidc.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -30,3 +29,4 @@ get: $ref: ../../components/responses.yaml#/OIDC-connection tags: - Authentication + operationId: get_db-_oidc diff --git a/docs/api/paths/public/db-_oidc_callback.yaml b/docs/api/paths/public/db-_oidc_callback.yaml index 53d5bfc2dc..f5b3d68508 100644 --- a/docs/api/paths/public/db-_oidc_callback.yaml +++ b/docs/api/paths/public/db-_oidc_callback.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -42,3 +41,4 @@ get: type: string tags: - Authentication + operationId: get_db-_oidc_callback diff --git a/docs/api/paths/public/db-_oidc_challenge.yaml b/docs/api/paths/public/db-_oidc_challenge.yaml index 0a26e5591b..fe98c61908 100644 --- a/docs/api/paths/public/db-_oidc_challenge.yaml +++ b/docs/api/paths/public/db-_oidc_challenge.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -30,3 +29,4 @@ get: description: Unable to connect and validate with the OpenID Connect provider requested tags: - Authentication + operationId: get_db-_oidc_challenge diff --git a/docs/api/paths/public/db-_oidc_refresh.yaml b/docs/api/paths/public/db-_oidc_refresh.yaml index 5d91258eb5..bf2aa93aa5 100644 --- a/docs/api/paths/public/db-_oidc_refresh.yaml +++ b/docs/api/paths/public/db-_oidc_refresh.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -30,3 +29,4 @@ get: $ref: ../../components/responses.yaml#/OIDC-connection tags: - Authentication + operationId: get_db-_oidc_refresh diff --git a/docs/api/paths/public/db-_oidc_testing-.well-known-openid-configuration.yaml b/docs/api/paths/public/db-_oidc_testing-.well-known-openid-configuration.yaml index c3ab0e7a83..a08dfa1ceb 100644 --- a/docs/api/paths/public/db-_oidc_testing-.well-known-openid-configuration.yaml +++ b/docs/api/paths/public/db-_oidc_testing-.well-known-openid-configuration.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -52,3 +51,4 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Authentication + operationId: get_db-_oidc_testing-.well-known-openid-configuration diff --git a/docs/api/paths/public/db-_oidc_testing-authenticate.yaml b/docs/api/paths/public/db-_oidc_testing-authenticate.yaml index f416f5625c..c55c42a658 100644 --- a/docs/api/paths/public/db-_oidc_testing-authenticate.yaml +++ b/docs/api/paths/public/db-_oidc_testing-authenticate.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -43,6 +42,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Authentication + operationId: get_db-_oidc_testing-authenticate post: summary: OpenID Connect mock login page handler description: 'Used to handle the login page displayed for the `GET /{db}/_oidc_testing/authorize` endpoint.' @@ -60,3 +60,4 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Authentication + operationId: post_db-_oidc_testing-authenticate diff --git a/docs/api/paths/public/db-_oidc_testing-authorize.yaml b/docs/api/paths/public/db-_oidc_testing-authorize.yaml index d3c18077df..ab1978e24f 100644 --- a/docs/api/paths/public/db-_oidc_testing-authorize.yaml +++ b/docs/api/paths/public/db-_oidc_testing-authorize.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -26,6 +25,7 @@ get: $ref: ../../components/responses.yaml#/OIDC-testing-internal-error tags: - Authentication + operationId: get_db-_oidc_testing-authorize post: summary: OpenID Connect mock login page description: Show a mock OpenID Connect login page for the client to log in to. @@ -44,3 +44,4 @@ post: $ref: ../../components/responses.yaml#/OIDC-testing-internal-error tags: - Authentication + operationId: post_db-_oidc_testing-authorize diff --git a/docs/api/paths/public/db-_oidc_testing-certs.yaml b/docs/api/paths/public/db-_oidc_testing-certs.yaml index c217d3dece..5b104952b1 100644 --- a/docs/api/paths/public/db-_oidc_testing-certs.yaml +++ b/docs/api/paths/public/db-_oidc_testing-certs.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -59,3 +58,4 @@ get: type: string tags: - Authentication + operationId: get_db-_oidc_testing-certs diff --git a/docs/api/paths/public/db-_oidc_testing-token.yaml b/docs/api/paths/public/db-_oidc_testing-token.yaml index 0c71818614..7b59d5c56d 100644 --- a/docs/api/paths/public/db-_oidc_testing-token.yaml +++ b/docs/api/paths/public/db-_oidc_testing-token.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db post: @@ -39,3 +38,4 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Authentication + operationId: post_db-_oidc_testing-token diff --git a/docs/api/paths/public/db-_session.yaml b/docs/api/paths/public/db-_session.yaml index b279a4ee8d..d8072e0b2d 100644 --- a/docs/api/paths/public/db-_session.yaml +++ b/docs/api/paths/public/db-_session.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/db get: @@ -18,6 +17,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Session + operationId: get_db-_session post: summary: Create a new user session description: |- @@ -97,6 +97,7 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Session + operationId: post_db-_session delete: summary: Log out description: |- @@ -111,8 +112,8 @@ delete: '404': $ref: ../../components/responses.yaml#/Not-found tags: - - Public only endpoints - Session + operationId: delete_db-_session head: summary: /{db}/_session responses: @@ -122,3 +123,4 @@ head: $ref: ../../components/responses.yaml#/Not-found tags: - Session + operationId: head_db-_session diff --git a/docs/api/paths/public/keyspace-.yaml b/docs/api/paths/public/keyspace-.yaml index c554e88ea8..a3853a77ff 100644 --- a/docs/api/paths/public/keyspace-.yaml +++ b/docs/api/paths/public/keyspace-.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace post: @@ -49,3 +48,4 @@ post: $ref: ../../components/responses.yaml#/Invalid-content-type tags: - Document + operationId: post_keyspace- diff --git a/docs/api/paths/public/keyspace-_all_docs.yaml b/docs/api/paths/public/keyspace-_all_docs.yaml index ed4d48c41c..5f2e91ce03 100644 --- a/docs/api/paths/public/keyspace-_all_docs.yaml +++ b/docs/api/paths/public/keyspace-_all_docs.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace get: @@ -30,6 +29,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Document + operationId: get_keyspace-_all_docs post: summary: Get all the documents in the database using a built-in view description: Get a built-in view of all the documents in the database. @@ -64,6 +64,7 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Document + operationId: post_keyspace-_all_docs head: summary: /{db}/_all_docs responses: @@ -86,3 +87,4 @@ head: - $ref: ../../components/parameters.yaml#/endkey - $ref: ../../components/parameters.yaml#/limit-result-rows description: '' + operationId: head_keyspace-_all_docs diff --git a/docs/api/paths/public/keyspace-_bulk_docs.yaml b/docs/api/paths/public/keyspace-_bulk_docs.yaml index d8c9958a91..cacf95ba15 100644 --- a/docs/api/paths/public/keyspace-_bulk_docs.yaml +++ b/docs/api/paths/public/keyspace-_bulk_docs.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace post: @@ -103,3 +102,4 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Document + operationId: post_keyspace-_bulk_docs diff --git a/docs/api/paths/public/keyspace-_bulk_get.yaml b/docs/api/paths/public/keyspace-_bulk_get.yaml index f7ed982c47..ff2e977daf 100644 --- a/docs/api/paths/public/keyspace-_bulk_get.yaml +++ b/docs/api/paths/public/keyspace-_bulk_get.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace post: @@ -73,3 +72,4 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Document + operationId: post_keyspace-_bulk_get diff --git a/docs/api/paths/public/keyspace-_changes.yaml b/docs/api/paths/public/keyspace-_changes.yaml index 1fa777fb23..9e450037ab 100644 --- a/docs/api/paths/public/keyspace-_changes.yaml +++ b/docs/api/paths/public/keyspace-_changes.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace get: @@ -101,6 +100,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Database Management + operationId: get_keyspace-_changes post: summary: Get changes list description: |- @@ -155,6 +155,7 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Database Management + operationId: post_keyspace-_changes head: summary: /{db}/_changes responses: @@ -167,3 +168,4 @@ head: tags: - Database Management description: '' + operationId: head_keyspace-_changes diff --git a/docs/api/paths/public/keyspace-_local-docid.yaml b/docs/api/paths/public/keyspace-_local-docid.yaml index f108e0f9a8..5917b03ac6 100644 --- a/docs/api/paths/public/keyspace-_local-docid.yaml +++ b/docs/api/paths/public/keyspace-_local-docid.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace - name: docid @@ -29,6 +28,7 @@ get: $ref: ../../components/responses.yaml#/Not-found tags: - Document + operationId: get_keyspace-_local-docid put: summary: Upsert a local document description: |- @@ -60,6 +60,7 @@ put: description: A revision ID conflict would result from updating this document revision. tags: - Document + operationId: put_keyspace-_local-docid delete: summary: Delete a local document description: |- @@ -84,6 +85,7 @@ delete: description: A revision ID conflict would result from deleting this document revision. tags: - Document + operationId: delete_keyspace-_local-docid head: responses: '200': @@ -99,3 +101,4 @@ head: This request checks if a local document exists. Local document IDs begin with `_local/`. Local documents are not replicated or indexed, don't support attachments, and don't save revision histories. In practice they are almost only used by Couchbase Lite's replicator, as a place to store replication checkpoint data. + operationId: head_keyspace-_local-docid diff --git a/docs/api/paths/public/keyspace-_revs_diff.yaml b/docs/api/paths/public/keyspace-_revs_diff.yaml index 7f04b6b8e0..50febacb3f 100644 --- a/docs/api/paths/public/keyspace-_revs_diff.yaml +++ b/docs/api/paths/public/keyspace-_revs_diff.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace post: @@ -48,3 +47,4 @@ post: $ref: ../../components/responses.yaml#/Not-found tags: - Database Management + operationId: post_keyspace-_revs_diff diff --git a/docs/api/paths/public/keyspace-docid-attach.yaml b/docs/api/paths/public/keyspace-docid-attach.yaml index 8a3b27da50..6676d0f906 100644 --- a/docs/api/paths/public/keyspace-docid-attach.yaml +++ b/docs/api/paths/public/keyspace-docid-attach.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace - $ref: ../../components/parameters.yaml#/docid @@ -63,6 +62,7 @@ get: description: Requested range exceeds content length tags: - Document Attachment + operationId: get_keyspace-docid-attach put: summary: Create or update an attachment on a document description: |- @@ -113,6 +113,7 @@ put: $ref: ../../components/responses.yaml#/Conflict tags: - Document Attachment + operationId: put_keyspace-docid-attach head: responses: '200': @@ -134,6 +135,7 @@ head: description: This request check if the attachment exists on the specified document. parameters: - $ref: ../../components/parameters.yaml#/rev + operationId: head_keyspace-docid-attach delete: summary: Delete an attachment on a document description: |- @@ -169,3 +171,4 @@ delete: $ref: ../../components/responses.yaml#/Conflict tags: - Document Attachment + operationId: delete_keyspace-docid-attach diff --git a/docs/api/paths/public/keyspace-docid.yaml b/docs/api/paths/public/keyspace-docid.yaml index b45b4e1e77..6ad314512f 100644 --- a/docs/api/paths/public/keyspace-docid.yaml +++ b/docs/api/paths/public/keyspace-docid.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - $ref: ../../components/parameters.yaml#/keyspace - $ref: ../../components/parameters.yaml#/docid @@ -59,6 +58,7 @@ get: $ref: ../../components/schemas.yaml#/HTTP-Error tags: - Document + operationId: get_keyspace-docid put: summary: Upsert a document description: |- @@ -102,6 +102,7 @@ put: $ref: ../../components/responses.yaml#/Invalid-content-type tags: - Document + operationId: put_keyspace-docid delete: summary: Delete a document description: |- @@ -120,6 +121,7 @@ delete: $ref: ../../components/responses.yaml#/Not-found tags: - Document + operationId: delete_keyspace-docid head: responses: '200': @@ -141,3 +143,4 @@ head: - $ref: ../../components/parameters.yaml#/includeAttachments - $ref: ../../components/parameters.yaml#/replicator2 description: Return a status code based on if the document exists or not. + operationId: head_keyspace-docid diff --git a/docs/api/paths/public/targetdb-.yaml b/docs/api/paths/public/targetdb-.yaml index f39200ffa9..7c2f98272b 100644 --- a/docs/api/paths/public/targetdb-.yaml +++ b/docs/api/paths/public/targetdb-.yaml @@ -5,7 +5,6 @@ # in that file, in accordance with the Business Source License, use of this # software will be governed by the Apache License, Version 2.0, included in # the file licenses/APL2.txt. - parameters: - name: targetdb in: path @@ -22,5 +21,5 @@ put: '412': description: Database exists tags: - - Public only endpoints - Database Management + operationId: put_targetdb- diff --git a/docs/api/public.yaml b/docs/api/public.yaml index 8fa68fdaf5..300b0daaef 100644 --- a/docs/api/public.yaml +++ b/docs/api/public.yaml @@ -85,8 +85,6 @@ paths: '/{db}/_blipsync': $ref: './paths/public/db-_blipsync.yaml' tags: - - name: Public only endpoints - description: Endpoints that are unique to the Public API (port 4984) - name: Server description: Manage server activities - name: Database Management