social.colibri.beta.category.update

Updates a category's name and the permissions its channels inherit.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · procedure
Kindprocedure
Authoritycategory.beta.colibri.social
Indexed

Procedure

procedure · POST

Input

application/json

Members allowed to post in the category's channels in addition to allowedRoles. Absent leaves the current value unchanged.

itemsstring · did

A member permitted to post.

Roles allowed to post in the category's channels. Absent leaves the current value unchanged.

itemsstring · record-key

A role permitted to post.

category

requiredstring · record-key

The category's record key.

community

requiredstring · did

The community the category belongs to.

name

string

The category's new name.

  • minLength: 1
  • maxLength: 32

ownerOnly

boolean

Whether only community admins may post in the category's channels. Absent leaves the current value unchanged.

Members that may read the category's channels in addition to visibleToRoles. Absent leaves the current value unchanged.

itemsstring · did

A member permitted to read.

Roles that may read the category's channels. Absent leaves the current value unchanged.

itemsstring · record-key

A role permitted to read.

Output

application/json

category

requiredref

The updated category.

Errors

AuthRequired

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

Forbidden

The caller lacks the category.update permission, or grants visibility to a role at or above their own highest position.

CommunityNotFound

No community exists at the given DID.

CategoryNotFound

No category exists at the given record key.

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.