fep/feps/fep-e232.md

authors, status, dateReceived

authors	status	dateReceived
silverpill <silverpill@firemail.cc>	DRAFT	2022-08-01

FEP-e232: Object Links

Summary

This document proposes a way to represent text-based links to [ActivityPub] objects which are similar to mentions. One example of such link is inline quote within the value of the content property, but this proposal is not limited to any particular use case.

Requirements

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC-2119].

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): the name SHOULD match the microsyntax used in object's content.

Example:

{
    "type": "Note",
    "content: "This is a quote:<br>RE: https://example.com/objects/123",
    "tag": [
        {
            "type": "Link",
            "mediaType": "application/activity+json",
            "href": "https://example.com/objects/123",
            "name": "RE: https://example.com/objects/123"
        }
    ]
}

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

References

• [ActivityPub] Christine Lemmer Webber, Jessica Tallon, ActivityPub, 2018
• [RFC-2119] S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, 1997
• [Activity Vocabulary], James M Snell, Evan Prodromou, Activity Vocabulary, 2017

Copyright

CC0 1.0 Universal (CC0 1.0) Public Domain Dedication

To the extent possible under law, the authors of this Fediverse Enhancement Proposal have waived all copyright and related or neighboring rights to this work.