SmartBear Problem Details Registry

This registry acts as a well known location for problem detail types returned by various SmartBear APIs. It acts as a central registry to promote reuse and clarity of problem detail types conforming to RFC 9457 (formerly RFC7807).

• Already Exists →

  The request attempted to create a resource that already exists 🚩

• Missing Body Property →

  The request is missing an expected body property 🔍

• Missing Request Header →

  The request lacked an expected header 🔍

• Missing Request Parameter →

  The request is missing an query or path parameter 🔍

• Invalid Body Property Format →

  One or more of the body properties was malformed ⚠️

• Invalid Request Parameter Format →

  One or more of the query or path parameters was malformed ⚠️

• Invalid Request Header Format →

  One or more of the request headers was malformed ⚠️

• Invalid Body Property Value →

  One or more of the body property values are invalid ⚠️

• Invalid Request Parameter Value →

  One or more of the query or path parameter values are invalid ⚠️

• Validation Error →

  The request is invalid and deemed unprocessable ⚠️

• Business Rule Violation →

  The request is deemed invalid as it failed business rule checks 🏢

• License Expired →

  The client license has expired rendering the service unavailable 📝

• License Cancelled →

  The client license has been cancelled rendering the service unavailable 📝

The following types can also be leveraged for convenience, however the recommendation would be to utilize the IANA registry for generic/common types.

• Not Found →

  The requested resource could not be found 🔍

• Unauthorized →

  The client request missed or malformed its credentials 🔒

• Forbidden →

  The request is not authorized for the resource 🔒

• Bad Request →

  The client request is invalid or malformed ⚠️

• Invalid Parameters →

  One or more of the parameters was malformed ⚠️

• Service unavailable →

  The requested service is currently unavailable 🚧

• Server Error →

  The server encountered an unexpected error 💥

When necessary, a Problem Detail response MAY include additional detail on the problems that have occurred. The additional errors MUST be under the errors collection which itself follows the JSON Schema defined in our GitHub repo.