Skip to content

docs: clarify %2f encoding requirement for scoped package paths #37

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
jonasagx wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −1
Open

docs: clarify %2f encoding requirement for scoped package paths #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 10 additions & 1 deletion docs/REGISTRY-API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,20 @@

This endpoint responds with the package metadata document, sometimes informally called a "packument" or "doc.json". The format of the response is described in detail in the [package metadata documentation](responses/package-metadata.md).

**Scoped packages:** The `{package}` path segment must be percent-encoded. The `/` separator between scope and name must be encoded as `%2f` (or `%2F`):

```
GET /@babel%2fcore
GET /@types%2fnode
```

A literal `/` in the path (e.g. `/@babel/core`) is treated as two separate path segments and will not resolve correctly. Registry implementations must not decode `%2f` to `/` before routing the request.

#### `GET·/{package}/{version}`

| Name | Value | Kind | Required? | Notes |
|------ |------- |------ |----------- |------- |
| package | String | **Path** | ✅ | the name of the package |
| package | String | **Path** | ✅ | the name of the package; scoped packages must use `%2f` for the `/` separator (e.g. `@babel%2fcore`) |
| version | String | **Path** | ✅ | a version number or `latest` |

#### `GET·/-/v1/search`
Expand Down