aws / aws/aws-cli

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

Open
#8,767 1 comment 0 reactions 0 assignees View on GitHub
bug documentation ecr p3
Dominant language
Python
Stars
17.3k
Forks
4.6k
Avg merge
1d 2h
Merged PRs (30d)
13

Description

### 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::repository/project-a/nginx-web-app",
"repositoryName": "project-a/nginx-web-app",
...
}
```
But the [CLI documentation](https://docs.aws.amazon.com/cli/latest/reference/ecr/create-repository.html#examples) 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

* https://github.com/aws/aws-cli/blob/9113e3c8fa97d3760f69320bacd63ec9063ae312/awscli/examples/ecr/create-repository.rst?plain=1#L13
* https://docs.aws.amazon.com/cli/latest/reference/ecr/create-repository.html#examples

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.