sync_gateway icon indicating copy to clipboard operation
sync_gateway copied to clipboard

CBG-4055: update api docs for all_docs endpoint

Open gregns1 opened this issue 1 year ago • 2 comments

CBG-4055

  • Small PR to update the query parameter types for all_docs

Integration Tests

  • [ ] GSI=true,xattrs=true https://jenkins.sgwdev.com/job/SyncGateway-Integration/000/

gregns1 avatar Jul 01 '24 12:07 gregns1

This looks right but I was having a look at the rest of the API and I have some questions about potential clarifications.

I'd probably make the description for POST and GET match because the first thing I looked at was to see how they were different.

I didn't test the following behavior, but I think it For POST I don't think keys is actually required - I think you can POST with an empty body and it will return the full set of docs. I think you can also post keys: [] and it will return full set of docs.

There's a typo in this file: databased should be database.

torcolvin avatar Jul 01 '24 15:07 torcolvin

Updated description. Did testing, you cannot run POST with empty body, you also can't run {"keys": []} to return all docs. You get empty result here.

gregns1 avatar Jul 08 '24 11:07 gregns1