Lexicon Garden

social.colibri.beta.role.putBadgeImage

Sets a role's badge to an uploaded image. The bytes are uploaded to the community's own repo, which is why this goes through the AppView: a space record must reference a blob living in the repo that holds the record. Replaces whatever badge was there before. Use social.colibri.beta.role.update with removeBadge to clear it.

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

Procedure

procedure · POST

Parameters

query string

community

requiredstring · did

The community the role belongs to.

role

requiredstring · record-key

The role's record key.

Input

image/*

Output

application/json

role

requiredref

The role with the new badge resolved.

Reference

Errors

AuthRequired

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

Forbidden

The caller lacks the role.manage permission.

CommunityNotFound

No community exists at the given DID.

RoleNotFound

No role exists at the given record key.

RoleProtected

The role is marked protected and cannot be modified.

RoleHierarchy

The role is at or above the caller's highest role position.

UnsupportedImage

The bytes are not one of the accepted image types.

ImageTooLarge

The image exceeds 256 KB.

CredentialsUnavailable

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

UpstreamFailure

A PDS or third-party call the AppView depends on failed.

Similar lexicons

semantic match

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