Skip to content

[Meta issue] Improve error handling/documentation #566

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.

Sign up for GitHub

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

Jump to bottom
Closed
jharmn opened this issue Feb 16, 2016 · 2 comments
Closed

[Meta issue] Improve error handling/documentation #566

jharmn opened this issue Feb 16, 2016 · 2 comments
Labels
error desc Describing error responses beyond error codes and response schemas

Comments

@jharmn
Copy link
Contributor

jharmn commented Feb 16, 2016

This is a meta issue for tracking improvements for the structure of errors in OAS.

Please don't add comments to this issue--rather open new tickets, if they apply, and reference this as the parent.
This was referenced Feb 16, 2016
Closed
Closed
Closed
@webron webron mentioned this issue Feb 22, 2016
Closed
@fehguy
Copy link
Contributor

fehguy commented Apr 14, 2016

I'm removing the Meta Issue tag and linking to this issue:

#563

@fehguy fehguy removed the Meta Issue label Apr 14, 2016
This was referenced May 9, 2016
Closed
Closed
dimitarndimitrov added a commit to dimitarndimitrov/kafka-rest that referenced this issue Sep 6, 2021
@dimitarndimitrov
KREST-1673 Add error responses to the OpenAPI spec.
216f210 
This adds some common error responses to all endpoints in our
OpenAPI spec. Unfortunately OpenAPI does not provide a nice way
to handle these in a single place, so there's a lot of duplication.
- See OAI/OpenAPI-Specification#398,
OAI/OpenAPI-Specification#521,
OAI/OpenAPI-Specification#566.

The error responses also include some examples that will hopefully
be useful for users and developers. However the examples are by no
means exhaustive.
@dimitarndimitrov dimitarndimitrov mentioned this issue Sep 6, 2021
Merged
dimitarndimitrov added a commit to dimitarndimitrov/kafka-rest that referenced this issue Sep 6, 2021
@dimitarndimitrov
KREST-1673 Add error responses to the OpenAPI spec.
8da75bd 
This adds some common error responses to all endpoints in our
OpenAPI spec. Unfortunately OpenAPI does not provide a nice way
to handle these in a single place, so there's a lot of duplication.
- See OAI/OpenAPI-Specification#398,
OAI/OpenAPI-Specification#521,
OAI/OpenAPI-Specification#566.

The error responses also include some examples that will hopefully
be useful for users and developers. However the examples are by no
means exhaustive.
dimitarndimitrov added a commit to confluentinc/kafka-rest that referenced this issue Sep 8, 2021
@dimitarndimitrov
KREST-1673 Add error responses to the OpenAPI spec. (#890)
8650293 
This adds some common error responses to all endpoints in our
OpenAPI spec. Unfortunately OpenAPI does not provide a nice way
to handle these in a single place, so there's a lot of duplication.
- See OAI/OpenAPI-Specification#398,
OAI/OpenAPI-Specification#521,
OAI/OpenAPI-Specification#566.

The error responses also include some examples that will hopefully
be useful for users and developers. However the examples are by no
means exhaustive.
@handrews handrews added the error desc Describing error responses beyond error codes and response schemas label Jan 29, 2024
@handrews
Copy link
Member

We are no longer using meta-issues, the two remaining open issues can be tracked individually.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
error desc Describing error responses beyond error codes and response schemas
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@fehguy @jharmn @handrews