From 39be6879a9baff19f8bee16de6277b5f39e834f9 Mon Sep 17 00:00:00 2001 From: Gregory Newman-Smith Date: Mon, 1 Jul 2024 12:58:48 +0100 Subject: [PATCH] CBG-4055: update api docs for all_docs endpoint --- docs/api/components/parameters.yaml | 10 +++++----- docs/api/paths/public/keyspace-_changes.yaml | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api/components/parameters.yaml b/docs/api/components/parameters.yaml index aec05e9a72..26a6c2d490 100644 --- a/docs/api/components/parameters.yaml +++ b/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 @@ -134,21 +134,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 @@ -169,7 +169,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 diff --git a/docs/api/paths/public/keyspace-_changes.yaml b/docs/api/paths/public/keyspace-_changes.yaml index 9e450037ab..390e35460c 100644 --- a/docs/api/paths/public/keyspace-_changes.yaml +++ b/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