Lexicon Garden

social.colibri.beta.community.applyLabel

Applies a label to a record in one of the community's spaces. This is how content is hidden, marked as a spoiler, or has its link previews suppressed. The record itself is untouched, since it lives in its author's own repo, but a `hidden` label stops this AppView serving the record: it is withheld from reads and from the events socket, and replies to it see a deletedMessageView in its place. Moderators holding `label.apply` and the record's own author still see it.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · procedure
Kindprocedure
Authoritycommunity.beta.colibri.social
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

reason

string

Human-readable reason for the label.

  • maxLength: 512

scope

array

Narrows the label to specific URIs inside the subject record. Absent means the whole record.

itemsstring · uri

A URI within the subject record.

space

requiredstring · space-ref

The space the labelled record lives in.

subject

requiredref

The record to label.

Reference

val

requiredstring

The label value. `hidden` withholds the record from reads. `spoiler` and `embeds-suppressed` are display hints.

  • maxLength: 128
  • knownValues: hidden | spoiler | embeds-suppressed

Output

application/json

label

requiredref

The applied label.

Reference

Errors

AuthRequired

The request is missing, malformed, or unverifiable service auth.

Forbidden

The caller lacks the label.apply permission.

CommunityNotFound

No community exists at the given DID.

SpaceNotFound

No space exists at the given reference.

InvalidRequest

The scope or val is not valid for the subject record.

CredentialsUnavailable

The AppView cannot act as the community because its stored credentials are missing or unusable.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • social.colibri.beta.label

    record

    A label applied to a record in the same space. Permissioned content cannot be taken down by anyone but its author, so moderation of content is advisory: a reader honours the labels published by the labelers its community names.

  • fyi.opensocial.applyLabel

    procedure

    Write a label record into the subject's space. Requires label, or takedown for !hide and !takedown.

  • social.colibri.beta.community.negateLabel

    procedure

    Retracts a label by writing a negating one. The original label record is left in place.

  • us.off-the-clock.community.label

    record

    A label an admin applies. uri targets a record (every version, or one with cid); cid alone targets a blob; subject targets an account.

  • app.userinput.hide

    record

    Hides a discussion or reply within a space. Only honored when authored by the space owner or a moderator. Lives in the moderator's repo.