Issue #2807: The structure of pulp's task['progress_report'] is not documented - Pulp

Actions

Send by e-mail Copy link

Issue #2807

closed

The structure of pulp's task['progress_report'] is not documented

Added by rbosak over 7 years ago. Updated about 5 years ago.

Status:

CLOSED - CURRENTRELEASE

Priority:

Low

Assignee:

dkliban@redhat.com

Category:

Sprint/Milestone:

3.0.0

Start date:

Due date:

Estimated time:

Severity:

1. Low

Version:

Platform Release:

OS:

Triaged:

Yes

Groomed:

Sprint Candidate:

Tags:

Documentation

Sprint:

Quarter:

Description

The documentation http://docs.pulpproject.org/dev-guide/integration/rest-api/tasks.html
mentions that the progress_report field contains "arbitrary progress information, usually in the form of an object".

I assume that the structure of this object depends on the task type (and possibly something else). Is the structure for some cases agreed upon? If yes, can we document it?

Actions

Copy link

Updated by ttereshc over 7 years ago

Priority changed from Normal to Low
Triaged changed from No to Yes
Tags Documentation added

Actions

Copy link

Updated by bmbouter over 7 years ago

For Pulp2, the decision on the data that goes into that field is a plugin-by-plugin decision. So the contents that pulp_rpm and pulp_ostree decide to put in there may be different. There is some shared code to build these progress reports which some pluigns use; this causes them to use a consistent format. We could document that, but it would need to be in each plugin's documentation since it's a plugin-by-plugin issue.

Maybe this should be cloned to one or more content types that documentation should be provided for. If that would be productive, please let a comment saying so.

For Pulp3, this has been standardized as three models which will have consistent API representations. We don't have the API docs up yet, but here are the model docs for ProgressBar[0], ProgressReport[2], ProgressSpinner[3].

[0]: http://docs.pulpproject.org/en/3.0/nightly/contributing/platform_api/app/models.html#pulpcore.app.models.ProgressBar
[1]: http://docs.pulpproject.org/en/3.0/nightly/contributing/platform_api/app/models.html#pulpcore.app.models.ProgressReport
[2]: http://docs.pulpproject.org/en/3.0/nightly/contributing/platform_api/app/models.html#pulpcore.app.models.ProgressSpinner

Actions

Copy link