Lexicon Garden

place.stream.branding.importBundle

Apply a branding bundle (see exportBundle). By default the bundle replaces the node's branding: keys it does not mention are removed. Every value is validated like updateBlob. Requires admin authorization.

Repository @stream.place did:plc:rbvrr34edl5ddpuwcubjiost not from the namespace authority
Details · procedure
Kindprocedure
Authoritybranding.stream.place
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Parameters

query string

broadcaster

string · did

DID of the broadcaster. Defaults to this node's.

dryRun

boolean

Report what would change without writing anything.

  • default: false

merge

boolean

Keep keys the bundle does not mention instead of removing them.

  • default: false

Input

application/zip

Output

application/json

applied

requiredboolean

False for a dry run.

changes

requiredarray
itemsref
Reference

warnings

array
itemsstring

Errors

Unauthorized

The caller is not an admin.

InvalidBundle

The zip, its branding.yaml or one of its values is not acceptable; the message names the key.

#change

object

Properties

action

requiredstring
  • knownValues: added | changed | removed | unchanged

detail

string

The new text value, or the image's type and size.

key

requiredstring

Similar lexicons

semantic match

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

  • place.stream.branding.exportBundle

    query not from the namespace authority

    Download the node's branding as a bundle: a zip with branding.yaml (every set key; image keys name files in the zip) plus the image files. Re-import it on another node with place.stream.branding.importBundle. Requires admin authorization.

  • place.stream.branding.updateBlob

    procedure not from the namespace authority

    Update or create a branding asset blob. Requires admin authorization.