feat(eng-10907): updates api docs to populate generic upstreams#325
Merged
Merged
Conversation
apoclyps
added
enhancement
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the API documentation schemas to the latest version (1.985.3), addressing the previously missing Generic upstreams documentation. The changes are auto-generated from running npm run schemas:download and include several enhancements:
Changes:
- Added Generic format package upload and validation endpoints
- Added Generic upstream configuration support with required
upstream_prefixfield - Added bulk package operations endpoint for multi-package actions
- Various schema refinements including field nullability updates and new properties
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
src/content/schemas/api-schema-v2.json |
Version bump from 1.966.0 to 1.985.3 |
src/content/schemas/api-schema-v1.json |
Major schema updates including new Generic package endpoints, Generic upstream configs, bulk action endpoints, and various schema enhancements |
README.md |
Updated documentation command from npm run schema to npm run schema:download |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
apoclyps
force-pushed
the
kyleharrison/eng-10907/update-api-docs-for-generic
branch
from
5d369a8 to
b7ef3c5
Compare
nicholasmccrea
approved these changes
Feb 6, 2026
apoclyps
deleted the
kyleharrison/eng-10907/update-api-docs-for-generic
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What’s Changed
The API documentation stored in the repository has been updated to the latest version to contain the API changes for the Generic format + upstreams.
relates to:
Additional Notes
During review, it was discovered that the new Generic upstreams documentation was missing from
https://help.cloudsmith.io/reference/repos_upstream_generic_create
This was previously missing because the
npm run schemacommand had not been executed, which is required to regenerate and update the API documentation and for those changes to be committed to the repository.As a future follow up, we should verify if the API documentation differs are part of CI to catch issues like this before we release changes.