Skip to content

Commit e740e00

Browse files
committed
improve doc
1 parent 786f6e2 commit e740e00

File tree

1 file changed

+16
-21
lines changed

1 file changed

+16
-21
lines changed

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

+16-21
Original file line numberDiff line numberDiff line change
@@ -25,27 +25,6 @@ The following `@type` values are used:
2525
------------------------------- | -----
2626
PackageDetailsUriTemplate/5.1.0 | The initial release
2727

28-
## URL template
29-
30-
The URL for the following API is the value of the `@id` property associated with one of the aforementioned
31-
resource `@type` values.
32-
33-
## HTTP methods
34-
35-
Although the client is not intended to make requests to the package details 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.
37-
38-
## Construct the URL
39-
40-
Given a known package ID and version, 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 package. The contents of the package details page is determined by the
43-
server implementation.
44-
45-
The URL must be an absolute URL and the scheme (protocol) must be HTTPS.
46-
47-
The value of the `@id` in the service index is a URL string containing any of the following placeholder tokens:
48-
4928
### URL placeholders
5029

5130
Name | Type | Required | Notes
@@ -70,3 +49,19 @@ produce the following URL and provide it to the user:
7049
```http
7150
https://www.nuget.org/packages/NuGet.Versioning/4.3.0
7251
```
52+
53+
## Construct the URL
54+
55+
Given a known package ID and version, the client implementation can construct a URL used to access a web interface. The
56+
client implementation should display this constructed URL (or clickable link) to the user allowing them to open a web
57+
browser to the URL and to learn more about the package. The contents of the package details page is determined by the
58+
server implementation.
59+
60+
The URL must be an absolute URL and the scheme (protocol) must be HTTPS.
61+
62+
The value of the `@id` in the service index is a URL string containing any of the following placeholder tokens:
63+
64+
## HTTP methods
65+
66+
Although the client is not intended to make requests to the package details URL on behalf of the user, the web page
67+
should support the `GET` method to allow a clicked URL to be easily opened in a web browser.

0 commit comments

Comments
 (0)