Issue #3250: docker tag creation: inconsistent field names - Docker Support - Pulp

Agile board
Agile charts

Agile boards

Pulp 2 QE Agile Board
Pulp 2 QE Agile Board - Priority View
Pulp 3 QE Agile Board
Pulp 3 RPM Tests Agile Board
Sprint 112 Agile Board

Custom queries

[All Projects] All Test Trackers
2.21.4 - Next Bugfix Release
2.21.4 MODIFIED
2.21.5
3.14.3
Easy Fix
FIPS open
Functional Tests
Galaxy NG
Groomed
Issues for Triage
Katello Integration
Next Docs Day
POST/ASSIGNED - no Sprint - Pulp2
POST/ASSIGNED - no Sprint - Pulp3
Prioritized Bugs
Pulp 3 Docs issues
pulp-docker-no-target-release
Pulp2 issues available for next release
SELinux related
Sprint 111
Sprint 112
Sprint Candidates (also groomed)
Un-Triaged Bugs
Verification Required

Actions

Send by e-mail Copy link

Issue #3250

closed

docker tag creation: inconsistent field names

Added by mihai.ibanescu@gmail.com almost 7 years ago. Updated over 5 years ago.

Status:

CLOSED - CURRENTRELEASE

Priority:

Normal

Assignee:

Start date:

Due date:

Estimated time:

Severity:

3. High

Version - Docker:

Platform Release:

2.15.1

Target Release - Docker:

OS:

Triaged:

Yes

Groomed:

Sprint Candidate:

Tags:

Pulp 2

Sprint:

Quarter:

Description

As a user of the REST API uploading a unit, I expect to look at the model's field names to find out what I'm supposed to upload.

The Tag model has a 'manifest_digest' field.

However, the upload code expects a 'digest' field:

https://github.com/pulp/pulp_docker/blob/master/plugins/pulp_docker/plugins/importers/upload.py#L331

Consistency would be nice, if it's not too much to ask.

History
Notes
Property changes
Associated revisions

Actions

Copy link

Updated by mihai.ibanescu@gmail.com almost 7 years ago

Status changed from NEW to POST

PR: https://github.com/pulp/pulp_docker/pull/218

Actions

Copy link

Updated by ipanova@redhat.com almost 7 years ago

Even though it is and easy code change, it looks like a backwards incompatible change because of the change of the field name from 'digest' to 'manifest_digest' which leads to violation of semantic versioning. CLI should also be considered for consistency in this case.

$ pulp-admin -vv docker repo tag

Command: tag
Description: create or update a tag to point to a manifest

Available Arguments:

  --bg       - if specified, the client process will end immediately (the task
               will continue to run on the server)
  --repo-id  - (required) unique identifier; only alphanumeric, ., -, and _
               allowed
  -v         - display extra information about the upload process
  --tag-name - (required) name of the tag to create  or update
  --digest   - (required) digest of the image manifest or manifest list (e.g.
               sha256:3e006...)
The following options are required but were not specified:
  --repo-id
  --tag-name
  --digest

Actions

Copy link