Project

Profile

Help

Issue #6502

closed

"error" field of a Task is under-documented

Added by lieter about 4 years ago. Updated over 2 years ago.

Status:
CLOSED - DUPLICATE
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

Ticket moved to GitHub: "pulp/pulpcore/1882":https://github.com/pulp/pulpcore/issues/1882


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.

Actions #1

Updated by fao89 about 4 years ago

  • Triaged changed from No to Yes
Actions #2

Updated by pulpbot over 2 years ago

  • Description updated (diff)
  • Status changed from NEW to CLOSED - DUPLICATE

Also available in: Atom PDF