Skip to content

Ambiguity in the ImageCreate API when pulling a tag or digest #21793

Closed
@cowwoc

Description

@cowwoc

Is this a docs issue?

  • My issue is about the documentation content or website

Type of issue

Other

Description

There is a bit of an ambiguity in the way that https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Image/operation/ImageCreate is specified.

On the one hand, it says that fromImage may include a tag or a digest to pull. On the other hand, it says that if tag is empty then all tags for the given image will be pulled.

  • Is omitting the tag query parameter equivalent to sending the parameter with an empty value?
  • What happens if a user includes a tag or a digest in fromImage but tag is omitted? Will the specific tag or digest get pulled? Or will all the tags get pulled?
  • What happens if the user specifies one tag in fromImage but a different tag in the tag property?

Location

https://docs.docker.com/reference/api/engine/version/v1.47/#tag/Image/operation/ImageCreate

Suggestion

Please clarify the above scenarios in the API documentation

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions