diff options
| author | Drew DeVault <sir@cmpwn.com> | 2019-03-03 12:10:01 -0700 |
|---|---|---|
| committer | Drew DeVault <sir@cmpwn.com> | 2019-03-03 12:10:01 -0700 |
| commit | 531a4043a1634c976e68ee24a50aca24dc1675d3 (patch) | |
| tree | 1ab9e5b148ede218299a50c9140dd458f1a9f37e | |
| parent | cf44fa1ff7d1591819347d18a84da7251bf9e4f9 (diff) | |
| download | sr.ht-docs-531a4043a1634c976e68ee24a50aca24dc1675d3.tar.gz | |
Add links to resource schemas
| -rw-r--r-- | api-conventions.md | 8 | ||||
| -rw-r--r-- | paste.sr.ht/api.md | 12 |
2 files changed, 10 insertions, 10 deletions
diff --git a/api-conventions.md b/api-conventions.md index 04f3098..4a9a835 100644 --- a/api-conventions.md +++ b/api-conventions.md @@ -223,16 +223,16 @@ that occurred, e.g. `profile:update`. **Response** -The new subscription resource. +The new [subscription resource](#subscription-resource). ### GET /api/.../webhooks -List of subscription resources. +List of [subscription resources](#subscription-resource). ### GET /api/.../webhooks/:id -Retrieves a subscription resource. +Retrieves a [subscription resource](#subscription-resource). ### GET /api/.../webhooks/:id/deliveries -List of delivery resources for this subscription. +List of [delivery resources](#delivery-resource) for this subscription. diff --git a/paste.sr.ht/api.md b/paste.sr.ht/api.md index 8829df4..e13d932 100644 --- a/paste.sr.ht/api.md +++ b/paste.sr.ht/api.md @@ -44,13 +44,13 @@ available for paste.sr.ht: ### GET /api/pastes -List of paste resources. +List of [paste resources](#paste-resource). **OAuth scope**: `pastes:read` ### POST /api/pastes -Create a new paste; +Create a new paste resource. **OAuth scope**: `pastes:write` @@ -71,19 +71,19 @@ Create a new paste; **Response** -The new paste resource. +The new [paste resource](#paste-resource). ### GET /api/pastes/:sha **OAuth scope**: `pastes:read` -Retrieves a paste resource. +Retrieves a [paste resource](#paste-resource). ### GET /api/blobs/:sha **OAuth scope**: `pastes:read` -Retrieves a blob resource. +Retrieves a [blob resource](#blob-resource). ## Webhooks @@ -98,4 +98,4 @@ Issued when a new paste is created. Requires `paste:read` OAuth scope. **Request body** -Affected paste resource. +Affected [paste resource](#paste-resource). |