Skip to content

Commit

Permalink
Add description to v1/markers (#1459)
Browse files Browse the repository at this point in the history
  • Loading branch information
MahanRahmati committed Jun 11, 2024
1 parent 58deaeb commit 662543d
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion content/en/methods/markers.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:**\
Expand Down Expand Up @@ -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:**\
Expand Down Expand Up @@ -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" >}}

0 comments on commit 662543d

Please sign in to comment.