diff options
author | Mark Mercado <mamercad@gmail.com> | 2021-01-24 18:40:29 +0100 |
---|---|---|
committer | Mark Mercado <mamercad@gmail.com> | 2021-01-24 18:40:29 +0100 |
commit | 5fe6e752555188adcbc4621f8f92a0e7090956b1 (patch) | |
tree | 9bc0d14dccb1db7f09d9b3bb46e21443f5b6a35b /docs | |
parent | Merge pull request #9149 from vladdoster/patch-1 (diff) | |
download | awx-5fe6e752555188adcbc4621f8f92a0e7090956b1.tar.xz awx-5fe6e752555188adcbc4621f8f92a0e7090956b1.zip |
Fixing a small typo
Diffstat (limited to 'docs')
-rw-r--r-- | docs/named_url.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/named_url.md b/docs/named_url.md index acd188133f..764b1f8af3 100644 --- a/docs/named_url.md +++ b/docs/named_url.md @@ -39,7 +39,7 @@ The third part of the format is `<organization.name>`, which indicates that fiel In the case where `organization` does not exist in the `related` field of label object detail, we append empty string `''` instead, which essentially does not alter the current identifier. So `Foo++` becomes final unique identifier and thus generate named URL to be `/api/v2/labels/Foo++/`. -An important aspect of generating unique identifiers for named URL is dealing with reserved characters. Because the identifier is part of a URL, the following reserved characters by URL standard should be escaped to its percentage encoding: `;/?:@=&[]`. For example, if an organization is named `;/?:@=&[]`, its unique identifier should be `%3B%2F%3F%3A%40%3D%26%5B%5D`. Another special reserved character is `+`, which is not reserved by URL standard but used by named URL to link different parts of an identifier. It is escaped by `[+]`. For example, if an organization is named `[+]`, tis unique identifier is `%5B[+]%5D`, where original `[` and `]` are percent encoded and `+` is converted to `[+]`. +An important aspect of generating unique identifiers for named URL is dealing with reserved characters. Because the identifier is part of a URL, the following reserved characters by URL standard should be escaped to its percentage encoding: `;/?:@=&[]`. For example, if an organization is named `;/?:@=&[]`, its unique identifier should be `%3B%2F%3F%3A%40%3D%26%5B%5D`. Another special reserved character is `+`, which is not reserved by URL standard but used by named URL to link different parts of an identifier. It is escaped by `[+]`. For example, if an organization is named `[+]`, its unique identifier is `%5B[+]%5D`, where original `[` and `]` are percent encoded and `+` is converted to `[+]`. `NAMED_URL_FORMATS` exclusively lists every resource that can have named URL; any resource not listed there has no named URL. `NAMED_URL_FORMATS` alone should be instructive enough for users to compose human-readable unique identifier and named URL themselves. For more convenience, every object of a resource that can have named URL will have a related field `named_url` that displays that object's named URL. Users can simply copy-paste that field for their custom usages. Also, users are expected to see indications in the help text of the API browser if a resource object has named URL. |