Skip to content

Commit d5a35a0

Browse files
author
Karan Nandwani
authored
Merge pull request NuGet#1309 from NuGet/master
master -> live
2 parents 046717a + 9e8f726 commit d5a35a0

File tree

8 files changed

+34
-15
lines changed

8 files changed

+34
-15
lines changed

docs/api/overview.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,17 +53,17 @@ Non-breaking protocol changes have been made to the API since it was first relea
5353

5454
The **service index** describes a variety of resources. The current set of supported resources are as follows:
5555

56-
Resource name | Required | Description
57-
---------------------------------------------------------------------- | -------- | -----------
56+
Resource name | Required | Description
57+
---------------------------------------------------------------------- | -------- | -----------
5858
[`PackagePublish`](package-publish-resource.md) | yes | Push and delete (or unlist) packages.
5959
[`SearchQueryService`](search-query-service-resource.md) | yes | Filter and search for packages by keyword.
6060
[`RegistrationsBaseUrl`](registration-base-url-resource.md) | yes | Get package metadata.
6161
[`PackageBaseAddress`](package-base-address-resource.md) | yes | Get package content (.nupkg).
6262
[`SearchAutocompleteService`](search-autocomplete-service-resource.md) | no | Discover package IDs and versions by substring.
6363
[`ReportAbuseUriTemplate`](report-abuse-resource.md) | no | Construct a URL to access a "report abuse" web page.
64-
[`RepositorySignatures`](repository-signatures-resource.md) | no | Get certificates used for repository signing.
65-
[`Catalog`](catalog-resource.md) | no | Full record of all package events.
66-
[`SymbolPackagePublish`](symbol-package-publish-resource.md) | no | Push symbol packages.
64+
[`RepositorySignatures`](repository-signatures-resource.md) | no | Get certificates used for repository signing.
65+
[`Catalog`](catalog-resource.md) | no | Full record of all package events.
66+
[`SymbolPackagePublish`](symbol-package-publish-resource.md) | no | Push symbol packages.
6767

6868
In general, all non-binary data returned by a API resource are serialized using JSON. The response schema
6969
returned by each resource in the service index is defined individually for that resource. For more information about
@@ -79,6 +79,26 @@ that the implementation does not understand should be ignored.
7979
> report abuse URL (tracked by [NuGet/Home#4924](https://github.com/NuGet/Home/issues/4924)). Other clients may opt
8080
> to simply not show a report abuse URL to the user.
8181
82+
### Undocumented resources on nuget.org
83+
84+
The V3 service index on nuget.org has some resources that are not documented above. There are a few reasons for not
85+
documenting a resource.
86+
87+
First, we don't document resources used as an implementation detail of nuget.org. The `SearchGalleryQueryService`
88+
falls into this category. [NuGetGallery](https://github.com/NuGet/NuGetGallery) uses this resource to delegate some V2
89+
(OData) queries to our search index instead of using the database. This resource was introduced for scalability reasons
90+
and is not intended for external use.
91+
92+
Second, we don't document resources that never shipped in an RTM version of the official client.
93+
`PackageDisplayMetadataUriTemplate` and `PackageVersionDisplayMetadataUriTemplate` fall into this category.
94+
95+
Thirdly, we don't document resources that are tightly coupled with the V2 protocol, which itself is intentionally
96+
undocumented. The `LegacyGallery` resource falls into this category. This resource allows a V3 service index to point to
97+
a corresponding V2 source URL. This resource supports the `nuget.exe list`.
98+
99+
If a resource is not documented here, we *strongly* recommend that you do not take a dependency on them. We may remove
100+
or change the behavior of these undocumented resources which could break your implementation in unexpected ways.
101+
82102
## Timestamps
83103

84104
All timestamps returned by the API are UTC or are otherwise specified using

docs/create-packages/Native-Packages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.topic: conceptual
99

1010
# Creating native packages
1111

12-
A native package contains native C++ code instead of managed code, allowing it to be used within C++ projects. (See [Native C++ Packages](../consume-packages/finding-and-choosing-packages.md#native-c-packages) in the Consume section.)
12+
A native package contains native binaries instead of managed assemblies, allowing it to be used within C++ (or similar) projects. (See [Native C++ Packages](../consume-packages/finding-and-choosing-packages.md#native-c-packages) in the Consume section.)
1313

1414
To be consumable in a C++ project, a package must target the `native` framework. At present there are not any version numbers associated with this framework as NuGet treats all C++ projects the same.
1515

docs/faqs/NuGet-FAQ.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -232,15 +232,13 @@ If that fails, try the [tips mentioned in this StackOverflow post](http://stacko
232232

233233
## What is the API endpoint for nuget.org?
234234

235-
To use nuget.org as a package repository with NuGet clients, you would need to use the following V3 API endpoint:
235+
To use nuget.org as a package repository with NuGet clients, you should use the following V3 API endpoint:
236236

237237
**`https://api.nuget.org/v3/index.json`**
238238

239-
Older clients can still use the v2 protocol to reach nuget.org. However, please note, NuGet clients 3.0 or later will have slower and less-reliable service using the v2 protocol:
239+
Older clients can still use the V2 protocol to reach nuget.org. However, please note, NuGet clients 3.0 or later will have slower and less-reliable service using the V2 protocol:
240240

241-
`https://www.nuget.org/api/v2/` (DEPRECATED!!!) **Note:** the "www." is important.
242-
243-
Additionally, *NuGet.exe List* only works with the v2 protocol.
241+
`https://www.nuget.org/api/v2` (DEPRECATED!!!) **Note:** use "www." for the best reliability.
244242

245243
## nuget.org account management
246244

docs/hosting-packages/Overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ For all such purposes, NuGet supports setting up private package sources in the
2020

2121
There are also several other NuGet hosting products that support remote private feeds, including the following:
2222

23-
- [Visual Studio Team Services Package Management](https://www.visualstudio.com/docs/package/nuget/publish), which is also available on Team Foundation Server 2017 and later.
23+
- [Azure Artifacts](https://www.visualstudio.com/docs/package/nuget/publish), which is also available on Team Foundation Server 2017 and later.
2424
- [MyGet](http://myget.org)
2525
- [ProGet](http://inedo.com/proget) from Inedo
2626
- [NuGet Server](http://nugetserver.net/), a community project from Inedo

docs/quickstart/create-and-publish-a-package-using-the-dotnet-cli.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,4 +104,5 @@ Once you have a `.nupkg` file, you publish it to nuget.org using the `dotnet nug
104104
- [Support multiple target frameworks](../create-packages/supporting-multiple-target-frameworks.md)
105105
- [Package versioning](../reference/package-versioning.md)
106106
- [Creating localized packages](../create-packages/creating-localized-packages.md)
107+
- [Creating symbol packages](../create-packages/symbol-packages-snupkg.md)
107108
- [Signing packages](../create-packages/Sign-a-package.md)

docs/tools/cli-ref-pack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ where `<nuspecPath>` and `<projectPath>` specify the `.nuspec` or project file,
3838
| IncludeReferencedProjects | Indicates that the built package should include referenced projects either as dependencies or as part of the package. If a referenced project has a corresponding `.nuspec` file that has the same name as the project, then that referenced project is added as a dependency. Otherwise, the referenced project is added as part of the package. |
3939
| MinClientVersion | Set the *minClientVersion* attribute for the created package. This value will override the value of the existing *minClientVersion* attribute (if any) in the `.nuspec` file. |
4040
| MSBuildPath | *(4.0+)* Specifies the path of MSBuild to use with the command, taking precedence over `-MSBuildVersion`. |
41-
| MSBuildVersion | *(3.2+)* Specifies the version of MSBuild to be used with this command. Supported values are 4, 12, 14, 15. By default the MSBuild in your path is picked, otherwise it defaults to the highest installed version of MSBuild. |
41+
| MSBuildVersion | *(3.2+)* Specifies the version of MSBuild to be used with this command. Supported values are 4, 12, 14, 15.1, 15.3, 15.4, 15.5, 15.6, 15.7, 15.8, 15.9. By default the MSBuild in your path is picked, otherwise it defaults to the highest installed version of MSBuild. |
4242
| NoDefaultExcludes | Prevents default exclusion of NuGet package files and files and folders starting with a dot, such as `.svn` and `.gitignore`. |
4343
| NoPackageAnalysis | Specifies that pack should not run package analysis after building the package. |
4444
| OutputDirectory | Specifies the folder in which the created package is stored. If no folder is specified, the current folder is used. |

docs/tools/cli-ref-restore.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ where `<projectPath>` specifies the location of a solution or a `packages.config
3434
| ForceEnglishOutput | *(3.5+)* Forces nuget.exe to run using an invariant, English-based culture. |
3535
| Help | Displays help information for the command. |
3636
| MSBuildPath | *(4.0+)* Specifies the path of MSBuild to use with the command, taking precedence over `-MSBuildVersion`. |
37-
| MSBuildVersion | *(3.2+)* Specifies the version of MSBuild to be used with this command. Supported values are 4, 12, 14, 15. By default the MSBuild in your path is picked, otherwise it defaults to the highest installed version of MSBuild. |
37+
| MSBuildVersion | *(3.2+)* Specifies the version of MSBuild to be used with this command. Supported values are 4, 12, 14, 15.1, 15.3, 15.4, 15.5, 15.6, 15.7, 15.8, 15.9. By default the MSBuild in your path is picked, otherwise it defaults to the highest installed version of MSBuild. |
3838
| NoCache | Prevents NuGet from using cached packages. See [Managing the global packages and cache folders](../consume-packages/managing-the-global-packages-and-cache-folders.md). |
3939
| NonInteractive | Suppresses prompts for user input or confirmations. |
4040
| OutputDirectory | Specifies the folder in which packages are installed. If no folder is specified, the current folder is used. Required when restoring with a `packages.config` file unless `PackagesDirectory` or `SolutionDirectory` is used.|

docs/tools/cli-ref-update.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ where `<configPath>` identifies either a `packages.config` or solution file that
3737
| Help | Displays help information for the command. |
3838
| Id | Specifies a list of package IDs to update. |
3939
| MSBuildPath | *(4.0+)* Specifies the path of MSBuild to use with the command, taking precedence over `-MSBuildVersion`. |
40-
| MSBuildVersion | *(3.2+)* Specifies the version of MSBuild to be used with this command. Supported values are 4, 12, 14, 15. By default the MSBuild in your path is picked, otherwise it defaults to the highest installed version of MSBuild. |
40+
| MSBuildVersion | *(3.2+)* Specifies the version of MSBuild to be used with this command. Supported values are 4, 12, 14, 15.1, 15.3, 15.4, 15.5, 15.6, 15.7, 15.8, 15.9. By default the MSBuild in your path is picked, otherwise it defaults to the highest installed version of MSBuild. |
4141
| NonInteractive | Suppresses prompts for user input or confirmations. |
4242
| PreRelease | Allows updating to prerelease versions. This flag is not required when updating prerelease packages that are already installed. |
4343
| RepositoryPath | Specifies the local folder where packages are installed. |

0 commit comments

Comments
 (0)