diff options
| author | Evan Hanson <evhan@foldling.org> | 2019-04-21 10:17:28 +1200 |
|---|---|---|
| committer | Drew DeVault <sir@cmpwn.com> | 2019-04-20 18:21:41 -0400 |
| commit | 39c659844a5aa0bfa229e7ff3ceac7175bfe75c2 (patch) | |
| tree | ed8e4fbd60ba9ceac64240e18b4b96d808e41a14 /lists.sr.ht | |
| parent | 9441b7d1ced6494042931d14dc3cc3398c428824 (diff) | |
| download | sr.ht-docs-39c659844a5aa0bfa229e7ff3ceac7175bfe75c2.tar.gz | |
Fix user GET endpoint path in lists.sr.ht API docs
The user endpoint needs a "user" part, i.e. /api/user/<foo> rather than
just /api/<foo>. This fixes that endpoint's section header and the later
references to it.
Diffstat (limited to 'lists.sr.ht')
| -rw-r--r-- | lists.sr.ht/api.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/lists.sr.ht/api.md b/lists.sr.ht/api.md index 2f819f2..e47bb71 100644 --- a/lists.sr.ht/api.md +++ b/lists.sr.ht/api.md @@ -83,13 +83,13 @@ available for lists.sr.ht: **Note**: in all routes, `:username` may be substituted with an email address, and `:email-id` may be the email's either of the "id" or "message_id" values. -### GET /api/:username +### GET /api/user/:username Retrieves a user resource. ### GET /api/user -Equivalent to [/api/:username](#GET-apiusername), implies the authenticated +Equivalent to [/api/user/:username](#GET-apiusername), implies the authenticated user. ### GET /api/user/:username/emails @@ -98,9 +98,9 @@ List of [email resources](#email-resource) received from this user. **OAuth scope**: `emails:read` -### GET /api/user/emails +### GET /api/emails -Equivalent to [/api/:username/emails](#GET-apiusernameemails), implies the +Equivalent to [/api/user/:username/emails](#GET-apiusernameemails), implies the authenticated user. **OAuth scope**: `emails:read` @@ -149,7 +149,7 @@ List of [mailing list resources](#mailing-list-resource) owned by this user. ### GET /api/lists -Equivalent to [/api/:username/lists](#GET-apiusernamelists), implies the +Equivalent to [/api/user/:username/lists](#GET-apiusernamelists), implies the authenticated user. **OAuth scope**: `lists:read` @@ -181,7 +181,7 @@ Retrieves a [mailing list resource](#mailing-list-resource). ### GET /api/lists/:list-name -Equivalent to [/api/:username/lists/:list-name](#GET-apiusernamelistslist-name), +Equivalent to [/api/user/:username/lists/:list-name](#GET-apiusernamelistslist-name), implies the authenticated user. **OAuth scope**: `lists:read` @@ -213,7 +213,7 @@ List of [email resources](#email-resource) posted to this list. ### GET /api/lists/:list-name/posts Equivalent to -[/api/:username/lists/:list-name/posts](#GET-apiusernamelistslist-nameposts), +[/api/user/:username/lists/:list-name/posts](#GET-apiusernamelistslist-nameposts), implies the authenticated user. **OAuth scope**: `lists:read` |