aws / aws-cli

Universal Command Line Interface for Amazon Web Services
Other
15.09k stars 4.01k forks source link

In `aws ecr create-repository` example the `repositoryName` is not consistent with parameter #8767

Open tim-finnigan opened 1 week ago

tim-finnigan commented 1 week ago

Describe the issue

https://github.com/aws/aws-cli/pull/6686 was originally made to address this but became stale.

If you run:

aws ecr create-repository \
        --repository-name project-a/nginx-web-app

Then the output looks like:

{
    "repository": {
        "repositoryArn": "arn:aws:ecr:us-west-2:<account-id>:repository/project-a/nginx-web-app",
        "repositoryName": "project-a/nginx-web-app",
         ...
}

But the CLI documentation shows sample-repo for repositoryName, when it should be project-a/nginx-web-app.

In the API documentation (https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_CreateRepository.html) there are references to both project-a/nginx-web-app and sample-repo as examples. These should just be consistently documented in the CLI examples.

Links