Project

Profile

Help

Issue #6502

"error" field of a Task is under-documented

Added by lieter 6 months ago. Updated 6 months ago.

Status:
NEW
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
Estimated time:
Severity:
2. Medium
Version:
Platform Release:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
API Bindings
Sprint:
Quarter:

Description

In the documentation, the "error" field of a returned Task is typed as an "object" (https://docs.pulpproject.org/restapi.html#operation/tasks_read). While true, it is rather unhelpful :).

Looking at the code, it is a python exception pulled through pulpcore/exceptions/base.py's exception_to_dict. This would mean that the object has 2 fields: "description" and "traceback". It would be great if the Error object ended up in the OpenAPI definition.

History

#1 Updated by fao89 6 months ago

  • Triaged changed from No to Yes

Please register to edit this issue

Also available in: Atom PDF