Add doc for ReadmeUriTemplate #3382
Conversation
| # README Uri Template | ||
|
|
||
| It is possible for a client to build a URL that can be used to download a README for a specific package. | ||
| This will enable the clients to render the package's README without downloading the entire package. |
There was a problem hiding this comment.
isn't it also possible for the readme url to be provided in the package metadata (registration) blob? Or is that not yet implemented?
I think it should be made clear to server implementors that they implement one or the other, not both.
There was a problem hiding this comment.
Not implemented yet, we don't have any commitments from servers to implement that option.
There was a problem hiding this comment.
well, this makes me frustrated. Firstly, it imples that we talked to the dozens of 3rd party NuGet server implementors. Secondly, it means that the ReadmeFileUrl public APIs in NuGet.Protocol are now leaky abstractions, since NuGet will never expect it in a search or registration response, which some people consider an anti-pattern and tech debt.
Considering these public APIs are in the unshipped txt, are you able to delete these public APIs before this version of Nuget ships?
|
|
||
| @type value | Notes | ||
| --------------------------------- | ----- | ||
| ReadmeUriTemplate/6.13.0 | The initial release |
There was a problem hiding this comment.
There's a "server implementor guide" doc that has a chronological list of changes to the NuGet protocol, so it's easy for server implementors to check if they're "up to date" with all client features, and find what's new since the last time they checked. This should be documented on that page.
If you have any suggestions on how to make sure other people who make changes to the protocol know to update that page, without needing a human like me to remind them, please share your ideas.
There was a problem hiding this comment.
When do we decide to update that page? For instance, the report abuse resource wasn't added there.
There was a problem hiding this comment.
please add the report abuse resource as well
No description provided.