artifactregistry GetTag, GetDockerImage, ListDockerImages, ListRepositories Name/Parent format is undocumented

[StevenACoffman]

The only downside of the Google Artifact Registry RPC API is that there is no documentation (that I could find) or examples of what a valid format the Parent or Name argument that these calls take.

Most people expect to supply a Docker Registry URL like: docker://us-central1-docker.pkg.dev/gcp-project/myrepo/myapp:mytag@sha256:2dd6956aa4f462badb7aa445f73092b19e55e2be2c03bee4ec230700963b3f55

Instead, we have to construct a valid Name / Parent string in a different format for each of GetTagRequest, ListDockerImagesRequest and GetDockerImageRequest operations. GetTag response returns a Tag. ListDockerImages and GetDockerImage responses are composed of DockerImage objects.

• GetDockerImage RPC API requires you to pass in a Name in the format projects/%s/locations/%s/repositories/%s/packages/%s@%s. For example:

  projects/gcp-project/locations/us-central1/repositories/myrepo/packages/myapp@sha256:2dd6956aa4f462badb7aa445f73092b19e55e2be2c03bee4ec230700963b3f55
  

• ListDockerImages RPC API wants Parent in the format projects/%s/locations/%s/repositories/%s, for example:

  projects/gcp-project/locations/us-central1/repositories/myrepo
  

• GetTag RPC API wants Name in the format projects/%s/locations/%s/repositories/%s/packages/%s/tags/%s, for example:

  projects/gcp-project/locations/us-central1/repositories/myrepo/packages/myapp:mytag
  

• ListRepositories RPC API wants Parent in the format projects/%s/locations/%s, for example:

  projects/gcp-project/locations/us-central1
  

If you have a Docker URL with a Docker Tag without the Docker SHA256, you can use GetTag and from that response extract the Version. Then you can pass that Version SHA256 to GetDockerImage.

[codyoss]

Thanks for the feedback. This is currently a per-api problem that should be reported to individual services. I would request that you open a similar issue in the public Artifact Registry Issue Tracker. That being said I think there is also potentially more we can do here from the libraries perspective directly. This problem has been identified in the past and we are currently tracking the generic issue here. Please follow that issue for any updates. Thanks again for the feedback.

[StevenACoffman]

Thanks! Opened here:

https://issuetracker.google.com/issues/323771609