Project

Profile

Help

Issue #7196

closed

pulpcore.app.response.OperationPostponedResponse docstring is slightly wrong (no 'task' field in response)

Added by alikins almost 4 years ago. Updated almost 4 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
Start date:
Due date:
Estimated time:
Severity:
1. Low
Version:
Platform Release:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Easy Fix
Sprint:
Sprint 78
Quarter:

Description

The docstring is:

    An HTTP response class for returning 202 and a spawned task.

    This response object should be used by views that dispatch asynchronous tasks. The most common
    use case is for sync and publish operations. When JSON is requested, the response will look
    like the following::

        {
            "pulp_href": "https://example.com/pulp/api/v3/tasks/adlfk-bala-23k5l7-lslser",
            "task_id": "adlfk-bala-23k5l7-lslser"
        }

But the response is only the 'pulp_href':

{
    "task": "/pulp/api/v3/tasks/3f40df5c-985e-4817-a605-4e5fabb6ff7d/"
}

Also available in: Atom PDF