Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CBG-4055: update api docs for all_docs endpoint #6929

Merged
merged 2 commits into from
Jul 8, 2024
Merged

CBG-4055: update api docs for all_docs endpoint #6929

merged 2 commits into from
Jul 8, 2024

Conversation

gregns1
Copy link
Contributor

@gregns1 gregns1 commented Jul 1, 2024

CBG-4055

  • Small PR to update the query parameter types for all_docs

Integration Tests

Copy link

github-actions bot commented Jul 1, 2024

Redocly previews

@torcolvin
Copy link
Collaborator

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.

@gregns1
Copy link
Contributor Author

gregns1 commented Jul 8, 2024

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 gregns1 assigned torcolvin and unassigned gregns1 Jul 8, 2024
@torcolvin torcolvin merged commit e012298 into main Jul 8, 2024
39 checks passed
@torcolvin torcolvin deleted the CBG-4055 branch July 8, 2024 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants