Skip to content

Commit 786f6e2

Browse files
committed
improve documentation for oweners template
1 parent d2d7f17 commit 786f6e2

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

docs/api/owner-details-template-resource.md

+12-14
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,8 @@ ms.reviewer:
1010

1111
# Owner URL template
1212

13-
It is possible for a client to build a URL that can be used by the user to see owner's page in their web
14-
browser. This is useful when a package source wants to show additional information about an owner that may not fit
15-
within the scope of what the NuGet client application shows.
13+
It is possible for a client to build a URL that can be used by the user to see owner's page in their web browser.
14+
This is useful when a package source wants to show additional information about an owner that may not fit within the scope of what the NuGet client application shows.
1615

1716
The resource used for building this URL is the `OwnerDetailsUriTemplate` resource found in the
1817
[service index](service-index.md).
@@ -27,20 +26,17 @@ OwnerDetailsUriTemplate/6.11.0 | The initial release
2726

2827
## URL template
2928

30-
The URL for the following API is the value of the `@id` property associated with one of the aforementioned
31-
resource `@type` values.
29+
The URL for the following API is the value of the `@id` property associated with one of the aforementioned resource `@type` values.
3230

3331
## HTTP methods
3432

35-
Although the client is not intended to make requests to the owner URL on behalf of the user, the web page
36-
should support the `GET` method to allow a clicked URL to be easily opened in a web browser.
33+
Although the client is not intended to make requests to the owner URL on behalf of the user, the web page should support the `GET` method to allow a clicked URL to be easily opened in a web browser.
3734

3835
## Construct the URL
3936

40-
Given a known owner ID, the client implementation can construct a URL used to access a web interface. The
41-
client implementation should display this constructed URL (or clickable link) to the user allowing them to open a web
42-
browser to the URL and to learn more about the owner. The contents of the owner page is determined by the
43-
server implementation.
37+
Given a known owner ID, the client implementation can construct a URL used to access a web interface.
38+
The client implementation should display this constructed URL (or clickable link) to the user allowing them to open a web browser to the URL and to learn more about the owner.
39+
The contents of the owner page is determined by the server implementation.
4440

4541
The URL must be an absolute URL and the scheme (protocol) must be HTTPS.
4642

@@ -52,16 +48,18 @@ Name | Type | Required | Notes
5248
----------- | ------- | -------- | -----
5349
`{owner}` | string | no | The owner ID to get details for
5450

55-
The server should accept `{owner}` value with any casing.
51+
The casing requirements of {owner} should be defined by the package source.
52+
The client should retain the casing of the username in whatever form it was found in other API responses or in the package repository signature.
53+
54+
NuGet.org treats owner usernames in a case insensitive manner but not all package source may have this flexibility.
5655

5756
For example, nuget.org's package details template looks like this:
5857

5958
```http
6059
https://www.nuget.org/profile/{owner}
6160
```
6261

63-
If the client implementation needs to display a link to the package details for NuGet.Versioning 4.3.0, it would
64-
produce the following URL and provide it to the user:
62+
If the client implementation needs to display a link to the package details for NuGet.Versioning 4.3.0, it would produce the following URL and provide it to the user:
6563

6664
```http
6765
https://www.nuget.org/profiles/nuget

0 commit comments

Comments
 (0)