Story #3218: As an authenticated user, I can list repository version content, added content, removed content - Pulp

Send by e-mail

Story #3218

Story #3209: As a user, I have Repository Versions

As an authenticated user, I can list repository version content, added content, removed content

Added by dkliban@redhat.com over 2 years ago. Updated 4 months ago.

Status:

CLOSED - CURRENTRELEASE

Priority:

Normal

Assignee:

daviddavis

Category:

Sprint/Milestone:

3.0.0

Start date:

Due date:

% Done:

100%

Estimated time:

Platform Release:

Groomed:

Yes

Sprint Candidate:

Yes

Tags:

Sprint:

Sprint 31

Description

Three detail routes need to be added to the RepositoryVersion viewset.

/api/v3/repositories/<uuid>/versions/<id>/content/ - paginated list of all content in particular version

/api/v3/repositories/<uuid>/versions/<id>/added_content/ - paginated list of content added since the previous version

/api/v3/repositories/<uuid>/versions/<id>/removed_content/ - paginated list of content removed since the previous version

Hide closed

Checklist

Update docs to call out that that these fields change over time
Update add/remove routes to include 'content'

Related issues

Associated revisions

Revision 8600f53b View on GitHub
Added by daviddavis over 2 years ago

Changed routes and added docs for added/removed content

fixes #3218 https://pulp.plan.io/issues/3218

Revision 8600f53b View on GitHub
Added by daviddavis over 2 years ago

Changed routes and added docs for added/removed content

fixes #3218 https://pulp.plan.io/issues/3218

History

#1 Updated by dkliban@redhat.com over 2 years ago

Parent task set to #3209

#2 Updated by dkliban@redhat.com over 2 years ago

Subject changed from Add RepositoryVersion Model and Viewset to As an authenticated user, I can list repository version content, added content, removed content
Description updated (diff)

#3 Updated by daviddavis over 2 years ago

Groomed changed from No to Yes

#4 Updated by mhrivnak over 2 years ago

There's an important bit of nuance to the "added" and "removed" attributes that's worth capturing. They are derived attributes whose state depends on the state of previous versions. You could define them as:

"The set of content added/removed since the previous known version that has not been deleted."

The result is that deleting a version will cause the next version to inherit some or all of its changes. For example: If version 2 adds A, and version 3 adds B, then you delete version 2, the result is that version 3 will be shown as having added A and B.

Since they represent the differences between two versions, that makes them quite a bit different from the "content" attribute which is immutable and scoped to a single object. It would be a good idea to communicate this clearly in the API docs.

I wrestled with whether or not to even include the "added" and "removed" attributes directly on each version representation. Ultimately I kept them at least as a way to demonstrate how easy it is to get that information, but it might be worth considering if there is a more clear way to present it.