Skip to content

Commit 6f107c4

Browse files
authored
CBG-4062: [3.1.9 Backport] update api docs for all_docs endpoint (#6929) (#6945)
1 parent cd8adf6 commit 6f107c4

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

docs/api/components/parameters.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Include-channels:
2525
in: query
2626
required: false
2727
schema:
28-
type: string
28+
type: boolean
2929
description: Include the channels each document is part of that the calling user also has access too.
3030
atts_since:
3131
name: atts_since
@@ -123,21 +123,21 @@ include-access:
123123
in: query
124124
required: false
125125
schema:
126-
type: string
126+
type: boolean
127127
description: Include what user/roles that each document grants access too.
128128
include-revs:
129129
name: revs
130130
in: query
131131
required: false
132132
schema:
133-
type: string
133+
type: boolean
134134
description: Include all the revisions for each document under the `_revisions` property.
135135
include-seqs:
136136
name: update_seq
137137
in: query
138138
required: false
139139
schema:
140-
type: string
140+
type: boolean
141141
description: Include the document sequence number `update_seq` property for each document.
142142
includeAttachments:
143143
name: attachments
@@ -158,7 +158,7 @@ include_docs:
158158
in: query
159159
required: false
160160
schema:
161-
type: string
161+
type: boolean
162162
description: Include the body associated with each document.
163163
include_runtime:
164164
name: include_runtime

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ parameters:
1010
get:
1111
summary: Gets all the documents in the database with the given parameters
1212
description: |-
13-
Returns all documents in the databased based on the specified parameters.
13+
Returns all documents in the database based on the specified parameters.
1414
1515
Required Sync Gateway RBAC roles:
1616
@@ -39,7 +39,7 @@ get:
3939
post:
4040
summary: Get all the documents in the database using a built-in view
4141
description: |-
42-
Get a built-in view of all the documents in the database.
42+
Returns all documents in the database based on the specified parameters.
4343
4444
Required Sync Gateway RBAC roles:
4545

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ parameters:
99
- $ref: ../../components/parameters.yaml#/keyspace
1010
get:
1111
summary: Gets all the documents in the database with the given parameters
12-
description: Returns all documents in the databased based on the specified parameters.
12+
description: Returns all documents in the database based on the specified parameters.
1313
parameters:
1414
- $ref: ../../components/parameters.yaml#/include_docs
1515
- $ref: ../../components/parameters.yaml#/Include-channels
@@ -32,7 +32,7 @@ get:
3232
operationId: get_keyspace-_all_docs
3333
post:
3434
summary: Get all the documents in the database using a built-in view
35-
description: Get a built-in view of all the documents in the database.
35+
description: Returns all documents in the database based on the specified parameters.
3636
parameters:
3737
- $ref: ../../components/parameters.yaml#/include_docs
3838
- $ref: ../../components/parameters.yaml#/Include-channels

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ post:
124124
type: string
125125
include_docs:
126126
description: Include the body associated with each document.
127-
type: string
127+
type: boolean
128128
revocations:
129129
description: 'If true, revocation messages will be sent on the changes feed.'
130130
type: string

0 commit comments

Comments
 (0)