From fc1508c0c285c76045d2e2b3702a14419b991b2b Mon Sep 17 00:00:00 2001 From: Tor Colvin Date: Thu, 27 Mar 2025 09:57:32 -0400 Subject: [PATCH 1/2] CBG-4503 use natural language for openapi --- docs/api/admin.yaml | 2 -- .../paths/admin/db-_ensure_full_commit.yaml | 2 +- docs/api/paths/admin/db-_replication-.yaml | 14 ---------- .../paths/admin/db-_replicationStatus-.yaml | 14 ---------- docs/api/paths/admin/db-_session.yaml | 10 ------- docs/api/paths/admin/db-_user-.yaml | 16 ----------- docs/api/paths/admin/keyspace-_all_docs.yaml | 27 ------------------- docs/api/paths/admin/keyspace-_changes.yaml | 17 ------------ docs/api/paths/admin/keyspace-_raw-docid.yaml | 2 +- docs/api/paths/common/_ping.yaml | 9 ------- .../paths/public/db-_ensure_full_commit.yaml | 2 +- docs/api/paths/public/db-_session.yaml | 10 ------- docs/api/paths/public/keyspace-_all_docs.yaml | 23 ---------------- docs/api/paths/public/keyspace-_changes.yaml | 13 --------- 14 files changed, 3 insertions(+), 158 deletions(-) diff --git a/docs/api/admin.yaml b/docs/api/admin.yaml index 338f76b780..322598c3bb 100644 --- a/docs/api/admin.yaml +++ b/docs/api/admin.yaml @@ -198,8 +198,6 @@ tags: description: Create and manage database users and roles - name: Session description: Manage user sessions - - name: OpenID Connect - description: Manage OpenID Connect - name: Document description: Create and manage documents and attachments - name: Replication diff --git a/docs/api/paths/admin/db-_ensure_full_commit.yaml b/docs/api/paths/admin/db-_ensure_full_commit.yaml index 8ca0d2f188..b30b116b97 100644 --- a/docs/api/paths/admin/db-_ensure_full_commit.yaml +++ b/docs/api/paths/admin/db-_ensure_full_commit.yaml @@ -8,7 +8,7 @@ parameters: - $ref: ../../components/parameters.yaml#/db post: - summary: '/{db}/_ensure_full_commit' + summary: 'Commits any recent changes to the specified database to disk' description: |- This endpoint is non-functional but is present for CouchDB compatibility. diff --git a/docs/api/paths/admin/db-_replication-.yaml b/docs/api/paths/admin/db-_replication-.yaml index 31335b0ee5..4654c52f77 100644 --- a/docs/api/paths/admin/db-_replication-.yaml +++ b/docs/api/paths/admin/db-_replication-.yaml @@ -53,17 +53,3 @@ post: tags: - Replication operationId: post_db-_replication- -head: - summary: /{db}/_replication/ - responses: - '200': - description: OK - '404': - description: Not Found - tags: - - Replication - description: |- - Required Sync Gateway RBAC roles: - - * Sync Gateway Replicator - operationId: head_db-_replication- diff --git a/docs/api/paths/admin/db-_replicationStatus-.yaml b/docs/api/paths/admin/db-_replicationStatus-.yaml index ec6eb83787..9bdeec808d 100644 --- a/docs/api/paths/admin/db-_replicationStatus-.yaml +++ b/docs/api/paths/admin/db-_replicationStatus-.yaml @@ -34,17 +34,3 @@ get: tags: - Replication operationId: get_db-_replicationStatus- -head: - summary: /{db}/_replicationStatus/ - responses: - '200': - description: OK - '400': - description: Bad Request - tags: - - Replication - description: |- - Required Sync Gateway RBAC roles: - - * Sync Gateway Replicator - operationId: head_db-_replicationStatus- diff --git a/docs/api/paths/admin/db-_session.yaml b/docs/api/paths/admin/db-_session.yaml index 68c440d07e..2eca1dc5c2 100644 --- a/docs/api/paths/admin/db-_session.yaml +++ b/docs/api/paths/admin/db-_session.yaml @@ -72,13 +72,3 @@ post: tags: - Session operationId: post_db-_session -head: - summary: /{db}/_session - responses: - '200': - description: OK - '404': - $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 3e4fa20f02..cae99130b2 100644 --- a/docs/api/paths/admin/db-_user-.yaml +++ b/docs/api/paths/admin/db-_user-.yaml @@ -59,19 +59,3 @@ post: tags: - Database Security operationId: post_db-_user- -head: - summary: /{db}/_user/ - responses: - '200': - description: OK - '404': - $ref: ../../components/responses.yaml#/Not-found - tags: - - Database Security - description: |- - Required Sync Gateway RBAC roles: - - * Sync Gateway Architect - * Sync Gateway Application - * Sync Gateway Application Read Only - operationId: head_db-_user- diff --git a/docs/api/paths/admin/keyspace-_all_docs.yaml b/docs/api/paths/admin/keyspace-_all_docs.yaml index b2b60afae9..bdbcbdc669 100644 --- a/docs/api/paths/admin/keyspace-_all_docs.yaml +++ b/docs/api/paths/admin/keyspace-_all_docs.yaml @@ -77,30 +77,3 @@ post: tags: - Document operationId: post_keyspace-_all_docs -head: - summary: /{db}/_all_docs - responses: - '200': - description: OK - '400': - $ref: ../../components/responses.yaml#/request-problem - '404': - $ref: ../../components/responses.yaml#/Not-found - tags: - - Document - parameters: - - $ref: ../../components/parameters.yaml#/include_docs - - $ref: ../../components/parameters.yaml#/Include-channels - - $ref: ../../components/parameters.yaml#/include-access - - $ref: ../../components/parameters.yaml#/include-revs - - $ref: ../../components/parameters.yaml#/include-seqs - - $ref: ../../components/parameters.yaml#/keys - - $ref: ../../components/parameters.yaml#/startkey - - $ref: ../../components/parameters.yaml#/endkey - - $ref: ../../components/parameters.yaml#/limit-result-rows - description: |- - Required Sync Gateway RBAC roles: - - * Sync Gateway Application - * Sync Gateway Application Read Only - operationId: head_keyspace-_all_docs diff --git a/docs/api/paths/admin/keyspace-_changes.yaml b/docs/api/paths/admin/keyspace-_changes.yaml index 1c3819be88..add2a59cb0 100644 --- a/docs/api/paths/admin/keyspace-_changes.yaml +++ b/docs/api/paths/admin/keyspace-_changes.yaml @@ -176,20 +176,3 @@ post: tags: - Database Management operationId: post_keyspace-_changes -head: - summary: /{db}/_changes - responses: - '200': - description: OK - '400': - description: Bad Request - '404': - description: Not Found - tags: - - Database Management - description: |- - Required Sync Gateway RBAC roles: - - * Sync Gateway Application - * Sync Gateway Application Read Only - operationId: head_keyspace-_changes diff --git a/docs/api/paths/admin/keyspace-_raw-docid.yaml b/docs/api/paths/admin/keyspace-_raw-docid.yaml index 9f86ce4df0..aa72e0d828 100644 --- a/docs/api/paths/admin/keyspace-_raw-docid.yaml +++ b/docs/api/paths/admin/keyspace-_raw-docid.yaml @@ -113,7 +113,7 @@ get: - Document operationId: get_keyspace-_raw-docid head: - summary: /{keyspace}/_raw/{docid} + summary: Check if a document exists responses: '200': description: Document exists diff --git a/docs/api/paths/common/_ping.yaml b/docs/api/paths/common/_ping.yaml index 13908ecedd..ad7be59bfc 100644 --- a/docs/api/paths/common/_ping.yaml +++ b/docs/api/paths/common/_ping.yaml @@ -19,12 +19,3 @@ get: tags: - Server operationId: get__ping -head: - responses: - '200': - description: Server is available - tags: - - Server - summary: Check if API is available - description: Returns OK status if API is available. - operationId: head__ping diff --git a/docs/api/paths/public/db-_ensure_full_commit.yaml b/docs/api/paths/public/db-_ensure_full_commit.yaml index 2f2e97e5aa..c4eae96c03 100644 --- a/docs/api/paths/public/db-_ensure_full_commit.yaml +++ b/docs/api/paths/public/db-_ensure_full_commit.yaml @@ -8,7 +8,7 @@ parameters: - $ref: ../../components/parameters.yaml#/db post: - summary: '/{db}/_ensure_full_commit' + summary: Commits any recent changes to the specified database to disk description: This endpoint is non-functional but is present for CouchDB compatibility. responses: '201': diff --git a/docs/api/paths/public/db-_session.yaml b/docs/api/paths/public/db-_session.yaml index d8072e0b2d..6b141277aa 100644 --- a/docs/api/paths/public/db-_session.yaml +++ b/docs/api/paths/public/db-_session.yaml @@ -114,13 +114,3 @@ delete: tags: - Session operationId: delete_db-_session -head: - summary: /{db}/_session - responses: - '200': - description: OK - '404': - $ref: ../../components/responses.yaml#/Not-found - tags: - - Session - operationId: head_db-_session diff --git a/docs/api/paths/public/keyspace-_all_docs.yaml b/docs/api/paths/public/keyspace-_all_docs.yaml index 9cefe219b6..996da9e110 100644 --- a/docs/api/paths/public/keyspace-_all_docs.yaml +++ b/docs/api/paths/public/keyspace-_all_docs.yaml @@ -65,26 +65,3 @@ post: tags: - Document operationId: post_keyspace-_all_docs -head: - summary: /{db}/_all_docs - responses: - '200': - description: OK - '400': - $ref: ../../components/responses.yaml#/request-problem - '404': - $ref: ../../components/responses.yaml#/Not-found - tags: - - Document - parameters: - - $ref: ../../components/parameters.yaml#/include_docs - - $ref: ../../components/parameters.yaml#/Include-channels - - $ref: ../../components/parameters.yaml#/include-access - - $ref: ../../components/parameters.yaml#/include-revs - - $ref: ../../components/parameters.yaml#/include-seqs - - $ref: ../../components/parameters.yaml#/keys - - $ref: ../../components/parameters.yaml#/startkey - - $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-_changes.yaml b/docs/api/paths/public/keyspace-_changes.yaml index 390e35460c..c4dd54a531 100644 --- a/docs/api/paths/public/keyspace-_changes.yaml +++ b/docs/api/paths/public/keyspace-_changes.yaml @@ -156,16 +156,3 @@ post: tags: - Database Management operationId: post_keyspace-_changes -head: - summary: /{db}/_changes - responses: - '200': - description: OK - '400': - description: Bad Request - '404': - description: Not Found - tags: - - Database Management - description: '' - operationId: head_keyspace-_changes From 740b46e84618dcebfb2dc4b5e6ae2cae1c8b7143 Mon Sep 17 00:00:00 2001 From: Tor Colvin Date: Thu, 27 Mar 2025 10:25:31 -0400 Subject: [PATCH 2/2] update with changes --- .../api/paths/admin/db-_ensure_full_commit.yaml | 2 +- docs/api/paths/admin/keyspace-_raw-docid.yaml | 17 ----------------- .../paths/public/db-_ensure_full_commit.yaml | 2 +- 3 files changed, 2 insertions(+), 19 deletions(-) diff --git a/docs/api/paths/admin/db-_ensure_full_commit.yaml b/docs/api/paths/admin/db-_ensure_full_commit.yaml index b30b116b97..7442564e16 100644 --- a/docs/api/paths/admin/db-_ensure_full_commit.yaml +++ b/docs/api/paths/admin/db-_ensure_full_commit.yaml @@ -8,7 +8,7 @@ parameters: - $ref: ../../components/parameters.yaml#/db post: - summary: 'Commits any recent changes to the specified database to disk' + summary: Ensure Full Commit description: |- This endpoint is non-functional but is present for CouchDB compatibility. diff --git a/docs/api/paths/admin/keyspace-_raw-docid.yaml b/docs/api/paths/admin/keyspace-_raw-docid.yaml index aa72e0d828..b7b9638aea 100644 --- a/docs/api/paths/admin/keyspace-_raw-docid.yaml +++ b/docs/api/paths/admin/keyspace-_raw-docid.yaml @@ -112,20 +112,3 @@ get: tags: - Document operationId: get_keyspace-_raw-docid -head: - summary: Check if a document exists - responses: - '200': - description: Document exists - '400': - $ref: ../../components/responses.yaml#/request-problem - '404': - $ref: ../../components/responses.yaml#/Not-found - tags: - - Document - description: |- - Required Sync Gateway RBAC roles: - - * Sync Gateway Application - * Sync Gateway Application Read Only - operationId: head_keyspace-_raw-docid diff --git a/docs/api/paths/public/db-_ensure_full_commit.yaml b/docs/api/paths/public/db-_ensure_full_commit.yaml index c4eae96c03..b9cbd730c3 100644 --- a/docs/api/paths/public/db-_ensure_full_commit.yaml +++ b/docs/api/paths/public/db-_ensure_full_commit.yaml @@ -8,7 +8,7 @@ parameters: - $ref: ../../components/parameters.yaml#/db post: - summary: Commits any recent changes to the specified database to disk + summary: Ensure Full Commit description: This endpoint is non-functional but is present for CouchDB compatibility. responses: '201':