Task #2634: Add information about API error reporting to dev guide - Pulp

Send by e-mail

Task #2634

Add information about API error reporting to dev guide

Added by semyers over 2 years ago. Updated 6 months ago.

Status:

CLOSED - CURRENTRELEASE

Priority:

Normal

Assignee:

Category:

Sprint/Milestone:

3.0

Start date:

Due date:

% Done:

Platform Release:

Blocks Release:

Backwards Incompatible:

Groomed:

Sprint Candidate:

Tags:

Documentation

QA Contact:

Complexity:

Smash Test:

Verified:

Verification Required:

Sprint:

Description

Django Rest Framework has some helpful error handling features, effectively response middleware, that can be used within Pulp to help us implement a single mechanism for handling exceptions and returning meaningful errors to users when raising Exceptions, or when unhandled exceptions require a 500 response.

We should explore DRF's options for this and document a plan for handling exceptions in the API to prevent having multiple error-handling implementations in the project.