Registry API
Packages
Push, read, approve, yank, unyank and deprecate package versions.
Scoped (@scope/name) and unscoped names each have their own paths. Reads of public, approved packages work without a token; everything else needs one. Visibility is enforced on the server.
Approve changes a package version’s approval state; yank and deprecate are the publisher’s actions and leave the version in place. Each version also has an advisory review you can read here.
Operations
| Request | What it does |
|---|---|
| GET /api/packages | List and search packages |
| POST /api/packages | Push a package version |
| GET /api/packages/{name} | Get an unscoped package |
| GET /api/packages/{name}/{version} | Get one version of an unscoped package |
| GET /api/packages/{scope}/{name} | Get a scoped package |
| GET /api/packages/{scope}/{name}/{version} | Get one version of a scoped package |
| GET /api/packages/{name}/{version}/review | Read the advisory review of an unscoped version |
| GET /api/packages/{scope}/{name}/{version}/review | Read the advisory review of a scoped version |
| PATCH /api/packages/{name}/{version}/approve | Approve an unscoped version |
| PATCH /api/packages/{scope}/{name}/{version}/approve | Approve a scoped version |
| PATCH /api/packages/{name}/{version}/yank | Yank an unscoped version |
| PATCH /api/packages/{scope}/{name}/{version}/yank | Yank a scoped version |
| PATCH /api/packages/{name}/{version}/unyank | Undo a yank on an unscoped version |
| PATCH /api/packages/{scope}/{name}/{version}/unyank | Undo a yank on a scoped version |
| PATCH /api/packages/{name}/{version}/deprecate | Deprecate an unscoped version with a message |
| PATCH /api/packages/{scope}/{name}/{version}/deprecate | Deprecate a scoped version with a message |
Operations are exactly those in the committed OpenAPI document (packages/workloom-api/openapi.json), which matches the route definitions; this site checks its list against both. Paths are under the API host. Public, approved packages and profiles can be read without a token; everything else needs one.