Skip to content

docs: clarify staged publishing can create new packages #81

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.

Sign up for GitHub

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

Open
shmam wants to merge 2 commits into
base: main
Choose a base branch
from
+8 −3
Open

docs: clarify staged publishing can create new packages #81

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
240e88a
docs: clarify staged publishing can create new packages
shmam Sep 22, 2026
879a037
Revise staging endpoint summary and description
shmam Sep 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions api/registry.npmjs.com/stage.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,17 @@ paths:
description: |
Submit a package version to staging for maintainer review.

This endpoint supports both staging a new version of an existing package and
creating a brand-new package. When the package does not yet exist in the
registry, staging its first version creates the package with a standardized placeholder version.
The authenticated publisher must be allowed to create the package name (for example, hold the
relevant scope or organization permissions).

The request body must contain a publish-style packument payload, including version
metadata and package attachments. The staged item can then be reviewed, inspected,
approved, or deleted by authorized maintainers.

## Requirements
- Package MUST exist or be creatable by the authenticated publisher
- User MUST be authenticated with a valid npm token
- Request body MUST include required fields in `StagedPackumentRequest`
operationId: stagePackageVersion
Expand Down Expand Up @@ -323,7 +328,7 @@ paths:

This endpoint moves a version from staged review state to a published package
version. On success, the staged record will be processed and the package version will become
installable.
installable.

## Requirements
- `stage-id` MUST reference an existing staged package version
Expand Down Expand Up @@ -799,4 +804,4 @@ components:
internal_error:
summary: "Internal Server Error"
value:
message: "An error occurred while processing your request."
message: "An error occurred while processing your request."
Loading