aiondemand/AIOD-rest-api

adopt rfc7807

Open

#85 opened on Jul 5, 2023

View on GitHubContributor guide
 (6 comments) (0 reactions) (0 assignees)Python (77 forks)auto 404
enhancementgood first issuepriority

Repository metrics

Stars
 (35 stars)
PR merge metrics
 (PR metrics pending)

Description

The default error handling of FastAPI is a bit weird. You get response bodies such as

{"detail": 
    [
        {"loc": ["body", "title"], "msg": "field required", "type": "value_error.missing"}
    ]
}

This is not conform https://datatracker.ietf.org/doc/html/rfc7807. We want to conform to an international standard. As far as I know, rfc7807 is the most used international standard for error handling.

TODOs:

  1. check if rfc7807 is the best international standard to comply to
  2. make sure errors are rfc7807 compliant
  3. maybe check all the errors that are thrown around, and improve on then, to improve the user /developers experience

Contributor guide

Research direction
Research RFC 7807 specification, then analyze current FastAPI error handlers and update them to return Problem Details JSON. Consider using a library like 'problem details' or implement custom exception handlers. Test all error responses.
Tech stack
pythonfastapi
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonHTTP APIFastAPI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70