1
0
mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00
documentation/content/en/entities/Admin_DomainAllow.md
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.3 KiB

title description menu aliases
Admin::DomainAllow Represents a domain allowed to federate.
docs
parent
entities
/entities/admin-domainallow
/entities/Admin-DomainAllow
/entities/admin_domainallow
/entities/Admin_DomainAllow
/api/entities/admin-domainallow
/api/entities/Admin-DomainAllow
/api/entities/admin_domainallow
/api/entities/Admin_DomainAllow

Example

{
	"id": "1",
	"domain": "mastodon.social",
	"created_at": "2022-09-14T21:23:02.755Z"
}

Attributes

id

Description: The ID of the DomainAllow in the database.
Type: String (cast from an integer, but not guaranteed to be a number)
Version history:
4.0.0 - added

domain

Description: The domain that is allowed to federate.
Type: String
Version history:
4.0.0 - added

created_at

Description: When the domain was allowed to federate.
Type: String (Datetime)
Version history:
4.0.0 - added

See also

{{< page-relref page="methods/admin/domain_allows" caption="admin/domain_allows API methods" >}}

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