FEP-268d: Search consent signals for objects
Summary
This FEP documents an extension property for [Activity Streams 2.0] to signal the consent for an object to be searched by a given actor.
History
This section is non-normative.
Fedibird introduced the searchableBy property in August 2022.
kmyblue implemented the searchableBy property in April 2023.
Mastodon began implementing the indexable property [FEP-5feb] in February 2023 and released it in September 2023.
Background
This section is non-normative.
[FEP-5feb] introduced the indexable property, which allows an Activity Streams actor to signal their preference for whether objects attributed to them should be made publicly available for search.
The indexable property is an actor-level property which takes a boolean value, allowing the actor to make all of their objects available for search by either anyone or no one at all. However, sometimes it is desirable to make a certain set of objects searchable/unsearchable or make an object searchable by a limited audience. The object-level searchableBy property documented in this FEP complements the indexable property with a more fine-grained audience targeting ability.
Requirements
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119].
Terms defined
searchableBy
- URI
http://fedibird.com/ns#searchableBy- Label
- searchable by
- Comment
- Identifies one or more entities that are allowed to search for the subject.
- Domain
Object- Range
Object|Link- Required
- No
- Is defined by
- FEP-268d
{
"@context": [
"https://w3id.org/fep/268d",
"https://www.w3.org/ns/activitystreams"
],
"id": "https://example.com/notes/1",
"attributedTo": "https://example.com/users/1",
"to": "https://www.w3.org/ns/activitystreams#Public",
"cc": "https://example.com/users/1/followers",
"type": "Note",
"content": "Hello, world!",
"searchableBy": "https://www.w3.org/ns/activitystreams#Public"
}
{
"@context": [
"https://w3id.org/fep/268d",
"https://www.w3.org/ns/activitystreams"
],
"id": "https://example.com/notes/42",
"attributedTo": "https://example.com/users/1",
"to": "https://alice.example/actor",
"cc": ["https://example.com/users/1/followers", "https://www.w3.org/ns/activitystreams#Public"],
"type": "Note",
"content": "@Alice Happy birthday!",
"tag": {
"type": "Mention",
"href": "https://alice.example/actor",
"name": "@Alice"
},
"searchableBy": ["https://alice.example/actor", "https://example.com/users/1/followers"]
}
{
"@context": [
"https://w3id.org/fep/268d",
"https://www.w3.org/ns/activitystreams"
],
"id": "https://example.com/notes/123",
"attributedTo": "https://example.com/users/1",
"to": "https://example.com/users/1/followers",
"cc": "https://www.w3.org/ns/activitystreams#Public",
"type": "Note",
"summary": "Note to self",
"searchableBy": "https://example.com/users/1"
}
{
"@context": [
"https://w3id.org/fep/268d",
"https://www.w3.org/ns/activitystreams"
],
"id": "https://example.com/users/1",
"type": "Person",
"searchableBy": "https://www.w3.org/ns/activitystreams#Public"
}