Add more HTTP Status Codes for improved Error Handling

camaraproject / QualityOnDemand

Repository to describe, develop, document and test the QualityOnDemand API family

https://wiki.camaraproject.org/x/zwOeAQ

Apache License 2.0

37 stars 60 forks source link

Add more HTTP Status Codes for improved Error Handling #305

Open maxl2287 opened 1 week ago

maxl2287 commented 1 week ago

Problem Description: The QoD APIs currently provide only a limited set of response codes (e.g. 400, 401, 403, and 409), making it difficult for users to understand what went wrong in more specific situations.

Possible Evolution: Add additional HTTP status codes such as:

405: Method Not Allowed
406: Not Acceptable
415: Unsupported Media Type
429: Too Many Requests

to improve user feedback and error handling.

RandyLevensalor commented 1 week ago

This looks like a good improvement to include these error codes and they align with commonalities.

https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#6-error-responses