Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NuGet V3 API service index moving to 3.0.0! #5403

Closed
joelverhagen opened this issue Feb 5, 2018 · 11 comments
Closed

NuGet V3 API service index moving to 3.0.0! #5403

joelverhagen opened this issue Feb 5, 2018 · 11 comments

Comments

@joelverhagen
Copy link
Member

joelverhagen commented Feb 5, 2018

For over two years, the NuGet V3 API’s service index has had the schema version of 3.0.0-beta.1. During that period, there were no breaking changes made to the service index schema. Because of this, we will be changing the schema version declared in the document to be 3.0.0. The NuGet team has verified that the official NuGet client and client APIs (e.g. NuGet.Protocol package) properly handle this version change. To test your client implementation against the new version string, you can try NuGet’s staging environment service index: https://apiint.nugettest.org/v3/index.json.

The schema of the service index is defined here in our API documentation:
https://docs.microsoft.com/en-us/nuget/api/service-index

As mentioned in the document, non-breaking changes to the schema can be introduced and will be signaled by a minor version change in the existing document (no change of URL). For example, the version change could change to 3.1.0. These changes of course will be announced through this Announcements repository in advance.

Any future breaking changes will not be made to the existing V3 service index. They would be introduced in a different service index URL.

Third-party server implementations are encouraged to update their service indexes to move from 3.0.0-beta.1 to 3.0.0.

As always, the URL for nuget.org’s production V3 service index is here:
https://api.nuget.org/v3/index.json

@joelverhagen
Copy link
Member Author

joelverhagen commented Feb 5, 2018

Adding folks from the ecosystem for visibility:

@maartenba
Copy link
Contributor

Is there a date this will happen? We can align the change on our end.

@joelverhagen
Copy link
Member Author

@maartenba, we are planning on deploying this change on February 19, 2018, unless some red flags come up from the community (in this thread or elsewhere).

@maartenba
Copy link
Contributor

Splendid, thanks!

@joelverhagen
Copy link
Member Author

@maartenba , @loic-sharma just mentioned to me that February 19 is a holiday. Let's do it the next day, February 20 (a Tuesday).

@maartenba
Copy link
Contributor

Sounds good!

@joelverhagen
Copy link
Member Author

Due to how noisy this week has been for our operations, I would like to post-pone this deployment for next Monday (February 26, 2018).

/cc @maartenba

@maartenba
Copy link
Contributor

Too late :-D We went live with this Monday, so far all good.

@joelverhagen
Copy link
Member Author

Sorry about that, we've had a noisy week. This is a low priority change in the grand scheme of things so other things pushed it out of the way.

... thanks for being our canary? 🥇 😄

@maartenba
Copy link
Contributor

Tweet!

@joelverhagen
Copy link
Member Author

This is now deployed to PROD.

@joelverhagen joelverhagen removed their assignment Feb 27, 2018
@joelverhagen joelverhagen removed this from the S132 - 2018.02.26 milestone Feb 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants