1
0
mirror of https://codeberg.org/fediverse/fep.git synced 2026-08-05 19:55:46 +00:00

Clarify use of microsyntax

This commit is contained in:
silverpill
2022-08-02 11:25:40 +00:00
parent 3c35810e41
commit c7b1d5f75a
+5 -1
View File
@@ -15,12 +15,14 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S
## Object links
It is expected that software will allow users to define object links using some kind of microsyntax, similar to `@mention` and `#hashtag` microsyntaxes. The exact way of defining object links may vary depending on the use case and is out of scope of this document.
If object's content has links to other objects, that object MAY have the `tag` property, where each link is represented as a `Link` object, as suggested by [Activity Vocabulary]. The properties of this `Link` object are:
- `type` (REQUIRED): the type MUST be `Link`.
- `mediaType` (REQUIRED): the media type SHOULD be `application/activity+json`.
- `href` (REQUIRED): the href property MUST contain the URI of the referenced object.
- `name` (OPTIONAL): if link is a quote, its representation SHOULD have the `name` property whose value starts with `RE:`, followed by referenced object's URI.
- `name` (OPTIONAL): the `name` SHOULD match the microsyntax used in object's content.
Example:
@@ -39,6 +41,8 @@ Example:
}
```
Note that the `content` still includes the `RE: <url>` microsyntax but consuming implementations are not required to parse that in order to make the appropriate associations.
## Implementations
TBD