Project

Profile

Help

Story #3218

closed

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 6 years ago. Updated about 4 years 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
Quarter:

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


Related issues

Blocked by Pulp - Issue #3283: Descriptions for actions are based on docstringCLOSED - CURRENTRELEASEdaviddavisActions
Actions #1

Updated by dkliban@redhat.com over 6 years ago

  • Parent issue set to #3209
Actions #2

Updated by dkliban@redhat.com over 6 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)
Actions #3

Updated by daviddavis over 6 years ago

  • Groomed changed from No to Yes
Actions #4

Updated by mhrivnak over 6 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.

Actions #5

Updated by dkliban@redhat.com over 6 years ago

  • Sprint/Milestone set to 53
Actions #6

Updated by daviddavis over 6 years ago

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

Actions #7

Updated by daviddavis over 6 years ago

  • Description updated (diff)
Actions #8

Updated by daviddavis over 6 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to daviddavis
Actions #9

Updated by daviddavis over 6 years ago

  • Status changed from ASSIGNED to POST
Actions #10

Updated by daviddavis over 6 years ago

  • Tracker changed from Task to Story
Actions #11

Updated by daviddavis over 6 years ago

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

Added by daviddavis over 6 years ago

Revision 8600f53b | View on GitHub

Changed routes and added docs for added/removed content

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

Added by daviddavis over 6 years ago

Revision 8600f53b | View on GitHub

Changed routes and added docs for added/removed content

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

Actions #12

Updated by daviddavis over 6 years ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100
Actions #14

Updated by bmbouter about 6 years ago

  • Sprint set to Sprint 31
Actions #15

Updated by bmbouter about 6 years ago

  • Sprint/Milestone deleted (53)
Actions #16

Updated by dkliban@redhat.com about 6 years ago

  • Sprint/Milestone set to 3.0.0
Actions #17

Updated by bmbouter almost 5 years ago

  • Tags deleted (Pulp 3, Pulp 3 MVP)
Actions #18

Updated by bmbouter over 4 years ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Also available in: Atom PDF