CBG-4369-add-api-docs

couchbase · Nov 21, 2024 · 9508e2c · 9508e2c
1 parent 8b8b03d
commit 9508e2c
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 0 deletions.
diff --git a/docs/api/components/parameters.yaml b/docs/api/components/parameters.yaml
@@ -385,6 +385,13 @@ show_exp:
   schema:
     type: boolean
   description: Whether to show the expiry property (`_exp`) in the response.
+show_cv:
+  name: show_cv
+  in: query
+  required: false
+  schema:
+    type: boolean
+  description: Output the current version of the version vector in the response as property `_cv`.
 startkey:
   name: startkey
   in: query

diff --git a/docs/api/components/responses.yaml b/docs/api/components/responses.yaml
@@ -138,6 +138,8 @@ all-docs:
                   properties:
                     rev:
                       type: string
+                    cv:
+                      type: string
             uniqueItems: true
           total_rows:
             type: number

diff --git a/docs/api/paths/admin/keyspace-_all_docs.yaml b/docs/api/paths/admin/keyspace-_all_docs.yaml
@@ -26,6 +26,7 @@ get:
     - $ref: ../../components/parameters.yaml#/startkey
     - $ref: ../../components/parameters.yaml#/endkey
     - $ref: ../../components/parameters.yaml#/limit-result-rows
+    - $ref: ../../components/parameters.yaml#/show_cv
   responses:
     '200':
       $ref: ../../components/responses.yaml#/all-docs

diff --git a/docs/api/paths/admin/keyspace-_bulk_get.yaml b/docs/api/paths/admin/keyspace-_bulk_get.yaml
@@ -45,6 +45,7 @@ post:
       description: If this header includes `gzip` then the the HTTP response will be compressed. This takes priority over `X-Accept-Part-Encoding`. Only part compression will be done if `X-Accept-Part-Encoding=gzip` and the `User-Agent` is below 1.2 due to clients not being able to handle full compression.
       schema:
         type: string
+    - $ref: ../../components/parameters.yaml#/show_cv
   requestBody:
     content:
       application/json:

diff --git a/docs/api/paths/admin/keyspace-docid.yaml b/docs/api/paths/admin/keyspace-docid.yaml
@@ -21,6 +21,7 @@ get:
     - $ref: ../../components/parameters.yaml#/rev
     - $ref: ../../components/parameters.yaml#/open_revs
     - $ref: ../../components/parameters.yaml#/show_exp
+    - $ref: ../../components/parameters.yaml#/show_cv
     - $ref: ../../components/parameters.yaml#/revs_from
     - $ref: ../../components/parameters.yaml#/atts_since
     - $ref: ../../components/parameters.yaml#/revs_limit
@@ -52,6 +53,7 @@ get:
               - Bob
             _id: AliceSettings
             _rev: 1-64d4a1f179db5c1848fe52967b47c166
+            _cv: 1@src
     '400':
       $ref: ../../components/responses.yaml#/invalid-doc-id
     '404':

diff --git a/docs/api/paths/public/keyspace-_all_docs.yaml b/docs/api/paths/public/keyspace-_all_docs.yaml
@@ -20,6 +20,7 @@ get:
     - $ref: ../../components/parameters.yaml#/startkey
     - $ref: ../../components/parameters.yaml#/endkey
     - $ref: ../../components/parameters.yaml#/limit-result-rows
+    - $ref: ../../components/parameters.yaml#/show_cv
   responses:
     '200':
       $ref: ../../components/responses.yaml#/all-docs

diff --git a/docs/api/paths/public/keyspace-_bulk_get.yaml b/docs/api/paths/public/keyspace-_bulk_get.yaml
@@ -40,6 +40,7 @@ post:
       description: If this header includes `gzip` then the the HTTP response will be compressed. This takes priority over `X-Accept-Part-Encoding`. Only part compression will be done if `X-Accept-Part-Encoding=gzip` and the `User-Agent` is below 1.2 due to clients not being able to handle full compression.
       schema:
         type: string
+    - $ref: ../../components/parameters.yaml#/show_cv
   requestBody:
     content:
       application/json:

diff --git a/docs/api/paths/public/keyspace-docid.yaml b/docs/api/paths/public/keyspace-docid.yaml
@@ -15,6 +15,7 @@ get:
     - $ref: ../../components/parameters.yaml#/rev
     - $ref: ../../components/parameters.yaml#/open_revs
     - $ref: ../../components/parameters.yaml#/show_exp
+    - $ref: ../../components/parameters.yaml#/show_cv
     - $ref: ../../components/parameters.yaml#/revs_from
     - $ref: ../../components/parameters.yaml#/atts_since
     - $ref: ../../components/parameters.yaml#/revs_limit
@@ -39,13 +40,17 @@ get:
               _rev:
                 description: The revision ID of the document.
                 type: string
+              _cv:
+                description: The current version of version vector of the document.
+                type: string
             additionalProperties: true
           example:
             FailedLoginAttempts: 5
             Friends:
               - Bob
             _id: AliceSettings
             _rev: 1-64d4a1f179db5c1848fe52967b47c166
+            _cv: 1@src
     '400':
       $ref: ../../components/responses.yaml#/invalid-doc-id
     '404':