You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/owner-details-template-resource.md
+12-14
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,8 @@ ms.reviewer:
10
10
11
11
# Owner URL template
12
12
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.
16
15
17
16
The resource used for building this URL is the `OwnerDetailsUriTemplate` resource found in the
18
17
[service index](service-index.md).
@@ -27,20 +26,17 @@ OwnerDetailsUriTemplate/6.11.0 | The initial release
27
26
28
27
## URL template
29
28
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.
32
30
33
31
## HTTP methods
34
32
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.
37
34
38
35
## Construct the URL
39
36
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.
44
40
45
41
The URL must be an absolute URL and the scheme (protocol) must be HTTPS.
46
42
@@ -52,16 +48,18 @@ Name | Type | Required | Notes
52
48
----------- | ------- | -------- | -----
53
49
`{owner}` | string | no | The owner ID to get details for
54
50
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.
56
55
57
56
For example, nuget.org's package details template looks like this:
58
57
59
58
```http
60
59
https://www.nuget.org/profile/{owner}
61
60
```
62
61
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:
0 commit comments