Skip to content

Commit 24a65ff

Browse files
committed
update to match current implementation
1 parent 57bc0ad commit 24a65ff

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

accepted/2024/[TS]PMUI-Readme-rendering.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ When no README is available we will display a messsage in the README section.
3333

3434
##### README File Sources
3535

36-
* RawReadmeFileUrl in the [package metadata](https://learn.microsoft.com/en-us/nuget/api/registration-base-url-resource).
37-
* README direct download specified in the [package content](https://learn.microsoft.com/en-us/nuget/api/package-base-address-resource).
36+
* ReadmeFileUrl in the [package metadata](https://learn.microsoft.com/en-us/nuget/api/registration-base-url-resource).
37+
* README direct download specified in a new resource `ReadmeUriTemplate/6.12.0`.
3838
* Downloaded nupkg.
3939

4040
#### Nuget API
4141
##### RegistrationsBaseUrl/6.12.0
4242

43-
A new version of the [package metadata](https://learn.microsoft.com/en-us/nuget/api/registration-base-url-resource) resource type will be documented which will include the field **RawReadmeFileUrl**.
43+
A new version of the [package metadata](https://learn.microsoft.com/en-us/nuget/api/registration-base-url-resource) resource type will be documented which will include the field **ReadmeFileUrl**.
4444
This will be a link to download the README and will only be filled if a readme is available to download.
4545

4646
###### index.json
@@ -83,7 +83,7 @@ This will be a link to download the README and will only be filled if a readme i
8383
"licenseUrl": "https://dev.nugettest.org/packages/Newtonsoft.Json/13.0.3/license",
8484
"readmeUrl": "https://dev.nugettest.org/packages/Newtonsoft.Json/13.0.3#show-readme-container",
8585
//New field
86-
"rawReadmeUrl": "https://apidev.nugettest.org/v3/flatcontainer/newtonsoft.json/13.0.3/readme",
86+
"readmeFileUrl": "https://apidev.nugettest.org/v3/flatcontainer/newtonsoft.json/13.0.3/readme",
8787
"listed": true,
8888
"minClientVersion": "2.12",
8989
"packageContent": "https://apidev.nugettest.org/v3-flatcontainer/newtonsoft.json/13.0.3/newtonsoft.json.13.0.3.nupkg",
@@ -150,7 +150,7 @@ MarkdownPreviewControl = markdownPreview.VisualElement
150150
Create a new implementation of the `INuGetResource` interface, `ReadMeDownloadResource`.
151151
This will only be available for sources which have implemented the new `PackageBaseAddress` resource type.
152152

153-
Update `IPackageSearchMetadata` to include the `RawReadmeUrl` field.
153+
Update `IPackageSearchMetadata` to include the `ReadmeFileUrl` field.
154154
`LocalPackageSearchMetadata` will put the location of the readme on the disk in this field.
155155
When the field is deserialized the field will contain the value returned from the server if `RegistrationsBaseUrl/6.12.0` is implemented.
156156
If only `PackageBaseAddress/6.12.0` is implemented then NuGet.Protocol will populate it with the URL.

0 commit comments

Comments
 (0)