Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Error & Status Codes #3
Need to come up with the standard for returning error and status codes -- there is no plan so far. I'd like to see this span a standard error responses structure, as well as application of HTTP status codes.
HTTP Status Success
HTTP Status Redirection
HTTP Status User Error
HTTP Status Server Error
My goal is to have the OpenAPI provide guidance for practitioners beyond just basic 200, 404, and 500. Providing real examples of mature responses. So to answer you, I guess d) all the above. I wrote this as I was designing and deploying the demo. Which I was starting to make reflect in the OpenAPI for the spec, which will translate into the documentation that gets generated.
At first I'm just looking to suggest a handful of core reponse codes, with basic guidance in spec, but links to educate implementers about proper usage -- we'll see where goes from there.
@NeilMcKechnie precisely. As a developer, I really appreciate having this stuff well defined so when I have my blinders on I can just implement. The HTTP status code vocabulary is robust, and it just makes sense for us to provide guidance for developers to help them ensure their implementations are as communicative as possible.