1
0
mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00
Nik Clayton 49868155b9
feat: Document datetime and date formats (#1565)
Add a new document that precisely describes the string representation of
datetime and date types.

The previous description of them as "ISO 8601 Datetime" was very
imprecise, as ISO 8601 describes many different ways of representing a
datetime and date.

Specify the datetime format precisely as the ISO 8601 profile described
in RFC 3339, and the date format precisely as the "Complete date" format
from the W3C note on date and time formats.

Adjust all the references to ISO 8601 datetimes or dates to link back
to the definition.

Fixes #1420
2024-11-27 15:08:51 +00:00

1.1 KiB

title description menu aliases
Marker Represents the last read position within a user's timelines.
docs
parent
entities
/entities/marker
/entities/Marker
/api/entities/marker
/api/entities/Marker

Example

{
  "last_read_id": "103194548672408537",
  "version": 462,
  "updated_at": "2019-11-24T19:39:39.337Z"
}

Attributes

last_read_id

Description: The ID of the most recently viewed entity.
Type: String (cast from integer but not guaranteed to be a number)
3.0.0 - added

version

Description: An incrementing counter, used for locking to prevent write conflicts.
Type: Integer
Version history:
3.0.0 - added

updated_at

Description: The timestamp of when the marker was set.
Type: String (Datetime)
3.0.0 - added

See also

{{< page-relref ref="methods/markers" caption="markers API methods" >}}

{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/serializers/rest/marker_serializer.rb" caption="app/serializers/rest/marker_serializer.rb" >}}