Add description to v1/markers (#1459)

This commit is contained in:
Mahan 2024-06-11 10:15:55 +00:00 committed by GitHub
parent 58deaeb0b5
commit 662543d692
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -24,6 +24,8 @@ aliases: [
GET /api/v1/markers HTTP/1.1
```
Get current positions in timelines.
**Returns:** Hash of timeline key and associated [Marker]({{< relref "entities/Marker" >}})\
**OAuth:** User token + `read:statuses`\
**Version history:**\
@ -79,6 +81,8 @@ Invalid or missing Authorization header.
POST /api/v1/markers HTTP/1.1
```
Save current position in timeline.
**Returns:** [Marker]({{< relref "entities/marker" >}})\
**OAuth:** User token + `write:statuses`\
**Version history:**\
@ -142,4 +146,4 @@ If object is stale while being updated, an error will occur.
{{< page-relref ref="methods/notifications#get" caption="GET /api/v1/notifications (with `min_id` or `since_id` parameter)" >}}
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/markers_controller.rb" caption="app/controllers/api/v1/markers_controller.rb" >}}
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/markers_controller.rb" caption="app/controllers/api/v1/markers_controller.rb" >}}