graham/prop
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(api): point users at /users/settings for token creation

Browse source 
The settings UI is the preferred path for interactive token minting
now that it exists; POST /api/v1/auth/tokens stays for scripts/CLIs.
This commit is contained in:
Graham McIntire 2026-05-09 10:15:23 -05:00
parent 04f9ed5fe6
commit ff92979b50
No known key found for this signature in database
GPG key ID: F4ABF488E6029E59
1 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/api/README.md
View file

@ -10,8 +10,11 @@ approval, contact moderation) are deliberately excluded from this API.
* **Versioning:** path-based (`/api/v1`). Breaking changes will ship a
`/api/v2` rather than mutate `/api/v1`.
* **Auth:** opaque bearer tokens (`Authorization: Bearer mwp_...`).
Tokens are issued at `POST /api/v1/auth/tokens` and never leak the
user's password to API clients.
The easiest way to mint a token is from your
[account settings page](/users/settings#api-tokens) — log in, scroll
to **API tokens**, name it, and copy the value (shown once). You can
also mint one programmatically at `POST /api/v1/auth/tokens`. Either
way, your password is never sent to API clients.
* **Format:** `application/json` for requests and successful responses;
errors use [RFC 9457 problem+json](https://www.rfc-editor.org/rfc/rfc9457).
* **OpenAPI 3.1 spec:** [`openapi.yaml`](/docs/api/openapi.yaml).
@ -112,6 +115,10 @@ Defaults:
### `POST /auth/tokens` — issue an API token
Prefer the [account settings page](/users/settings#api-tokens) for
interactive use; this endpoint is here for scripts and CLI tools that
need to mint a token without leaving the terminal.
Request:
```json