Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add description to v1/markers #1459

Merged
merged 1 commit into from
Jun 11, 2024
Merged

Add description to v1/markers #1459

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Add description to v1/markers
  • Loading branch information
@MahanRahmati
MahanRahmati committed Jun 6, 2024
commit dd2557b2201e7e0caf79623487c977d20e382296
6 changes: 5 additions & 1 deletion content/en/methods/markers.md
View file
Open in desktop
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" >}}