CBG-4062: [3.1.9 Backport] update api docs for all_docs endpoint (#6929…

…) (#6945)

docs/api/components/parameters.yaml

@@ -25,7 +25,7 @@ Include-channels:
   in: query
   required: false
   schema:
-    type: string
+    type: boolean
   description: Include the channels each document is part of that the calling user also has access too.
 atts_since:
   name: atts_since
@@ -123,21 +123,21 @@ include-access:
   in: query
   required: false
   schema:
-    type: string
+    type: boolean
   description: Include what user/roles that each document grants access too.
 include-revs:
   name: revs
   in: query
   required: false
   schema:
-    type: string
+    type: boolean
   description: Include all the revisions for each document under the `_revisions` property.
 include-seqs:
   name: update_seq
   in: query
   required: false
   schema:
-    type: string
+    type: boolean
   description: Include the document sequence number `update_seq` property for each document.
 includeAttachments:
   name: attachments
@@ -158,7 +158,7 @@ include_docs:
   in: query
   required: false
   schema:
-    type: string
+    type: boolean
   description: Include the body associated with each document.
 include_runtime:
   name: include_runtime

docs/api/paths/admin/keyspace-_all_docs.yaml

@@ -10,7 +10,7 @@ parameters:
 get:
   summary: Gets all the documents in the database with the given parameters
   description: |-
-    Returns all documents in the databased based on the specified parameters.
+    Returns all documents in the database based on the specified parameters.
 
     Required Sync Gateway RBAC roles:
 
@@ -39,7 +39,7 @@ get:
 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.
+    Returns all documents in the database based on the specified parameters.
 
     Required Sync Gateway RBAC roles:
 

docs/api/paths/public/keyspace-_all_docs.yaml

@@ -9,7 +9,7 @@ parameters:
   - $ref: ../../components/parameters.yaml#/keyspace
 get:
   summary: Gets all the documents in the database with the given parameters
-  description: Returns all documents in the databased based on the specified parameters.
+  description: Returns all documents in the database based on the specified parameters.
   parameters:
     - $ref: ../../components/parameters.yaml#/include_docs
     - $ref: ../../components/parameters.yaml#/Include-channels
@@ -32,7 +32,7 @@ get:
   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.
+  description: Returns all documents in the database based on the specified parameters.
   parameters:
     - $ref: ../../components/parameters.yaml#/include_docs
     - $ref: ../../components/parameters.yaml#/Include-channels

docs/api/paths/public/keyspace-_changes.yaml

@@ -124,7 +124,7 @@ post:
               type: string
             include_docs:
               description: Include the body associated with each document.
-              type: string
+              type: boolean
             revocations:
               description: 'If true, revocation messages will be sent on the changes feed.'
               type: string