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

Please document that error 404 could also mean an empty list #213

Closed
cipherboy opened this issue Mar 16, 2024 · 0 comments · Fixed by #214
Closed

Please document that error 404 could also mean an empty list #213

cipherboy opened this issue Mar 16, 2024 · 0 comments · Fixed by #214
Labels
bug Something isn't working

Comments

@cipherboy
Copy link
Contributor

cipherboy commented Mar 16, 2024

As reported by @stormshield-gt on hashicorp/vault#25969:

When using a list endpoint, if there is no item to list, the API returns an error 404.

As explain here, this unusual behavior is kept for backward compatibility. The original rational can be found here #1365

This has been a painful point for users since a long time, as we can see by the number of related issues #20740 #13043 #24964 #1958 #5861 #8833 hvac/hvac#928

I think this will keep hurting users, again and again, if the behavior continues to be undocumented.

I suggest updating the documentation about the error codes returned by the API to mention that 404 could also mean an empty list.

@cipherboy cipherboy added the bug Something isn't working label Mar 16, 2024
cipherboy added a commit to cipherboy/openbao that referenced this issue Mar 16, 2024
Resolves: openbao#213

Signed-off-by: Alexander Scheel <alexander.m.scheel@gmail.com>
naphelps pushed a commit to cipherboy/openbao that referenced this issue Mar 18, 2024
Resolves: openbao#213

Signed-off-by: Alexander Scheel <alexander.m.scheel@gmail.com>
naphelps pushed a commit that referenced this issue Mar 18, 2024
Resolves: #213

Signed-off-by: Alexander Scheel <alexander.m.scheel@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant