Project

Profile

Help

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:
Category:
-
Sprint/Milestone:
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


Checklist


Related issues

Blocked by Pulp - Issue #3283: Descriptions for actions are based on docstringCLOSED - CURRENTRELEASE<a title="Actions" class="icon-only icon-actions js-contextmenu" href="#">Actions</a>

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.

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

  • Sprint/Milestone set to 53

#6 Updated by daviddavis over 2 years ago

+1 to @mhrivnak's proposal of updating our docs. Added a checklist item to do so.

#7 Updated by daviddavis over 2 years ago

  • Description updated (diff)

#8 Updated by daviddavis over 2 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to daviddavis

#9 Updated by daviddavis over 2 years ago

  • Status changed from ASSIGNED to POST

#10 Updated by daviddavis over 2 years ago

  • Tracker changed from Task to Story

#11 Updated by daviddavis over 2 years ago

  • Blocked by Issue #3283: Descriptions for actions are based on docstring added

#12 Updated by daviddavis over 2 years ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100

#14 Updated by bmbouter over 2 years ago

  • Sprint set to Sprint 31

#15 Updated by bmbouter over 2 years ago

  • Sprint/Milestone deleted (53)

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

  • Sprint/Milestone set to 3.0.0

#17 Updated by gmaillogin over 1 year ago

Nice one. [[https://www.liteblueusps.online/]]

#18 Updated by bmbouter over 1 year ago

  • Tags deleted (Pulp 3, Pulp 3 MVP)

#19 Updated by mathlind over 1 year ago

Nice information check this once for various apps https://elegantdsl.com/liteblue-usps-gov-login/

#20 Updated by burrgio 11 months ago

Nice to see this post here and thanks for sharing this to us.
https://peryourhealth.fun
https://liteblue.mobi

#21 Updated by bmbouter 8 months ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

#22 Updated by stromen 4 months ago

Please register to edit this issue

Also available in: Atom PDF