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

Define whether error handling complies with RFC 7807. #551

Open
itziweb opened this issue Jul 1, 2024 · 1 comment
Open

Define whether error handling complies with RFC 7807. #551

itziweb opened this issue Jul 1, 2024 · 1 comment
Assignees
Labels
WT1 To be discussed at the next meeting
Milestone

Comments

@itziweb
Copy link

itziweb commented Jul 1, 2024

Is your feature request related to a problem? Please describe.

The current version of the error handling of the TOMP API seems to be oriented towards RFC 7807 in terms of style. However, it is not clear from the documentation if it is based on the standard or if this is more of a coincidence.

Urgency

Minor
The work on version 2.0 would be an opportunity to check this. Aligning with RFC 7807 could improve interoperability and adherence to established standards.

Additional context

RFC 7807 is a widely adopted standard for error handling in APIs. Including a reference to it or aligning with it more closely could benefit the API's usability.

Describe the solution you'd like

A clear review and alignment of TOMP-API error handling with RFC 7807, or documentation on why deviations are necessary.

Describe alternatives you've considered

Maintaining the current structure but adding a note in the documentation about the deviations from RFC 7807.

Possible Implementation

For 2.0 - review the current error handling structure, compare it with RFC 7807, and adjust the fields as necessary to ensure compliance or provide clear documentation on the chosen approach.

@edwinvandenbelt edwinvandenbelt added the WT1 To be discussed at the next meeting label Jul 3, 2024
@edwinvandenbelt edwinvandenbelt added this to the 1.6 milestone Jul 3, 2024
@edwinvandenbelt edwinvandenbelt self-assigned this Dec 19, 2024
@edwinvandenbelt edwinvandenbelt moved this to To do in WT1 Kanban Dec 19, 2024
@edwinvandenbelt
Copy link
Collaborator

Hey Roman, it is indeed RFC 7807 we're using. Although we added the errorcode-field. In v2.0 there will be an explicit reference to the RFC.

@edwinvandenbelt edwinvandenbelt modified the milestones: 1.6, 2.0 Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
WT1 To be discussed at the next meeting
Projects
Status: To do
Development

No branches or pull requests

2 participants