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

Document Problem responses in API docs #753

Open
matthew-white opened this issue Jan 28, 2023 · 0 comments
Open

Document Problem responses in API docs #753

matthew-white opened this issue Jan 28, 2023 · 0 comments
Labels
documentation API docs, readme, developer docs

Comments

@matthew-white
Copy link
Member

matthew-white commented Jan 28, 2023

Quoting @lognaturel in Slack:

We don’t currently document detailed error codes. It looks like the .1 variants are the only ones documented. Those codes can be really useful for clients and I’d like to use them in pyodk. … my understanding is that we could document 404.1, 404.2, etc separately with API Blueprint because there’s no semantics around HTTP error codes in the spec, the definitions are using standard data structures

The goals of this issue are:

  • Document all Problem codes.
  • For .1 variants only: Document the structure of the details property.

This won't fully document everything about Problem responses, but it would be a great first step.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation API docs, readme, developer docs
Projects
None yet
Development

No branches or pull requests

1 participant