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.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | branding.stream.place |
| Indexed |
Checks
Validunlimited-stringdefs.change.properties.actionNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.change.properties.detailNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.change.properties.keyNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.main.output.schema.properties.warnings.itemsNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"change": {
"properties": {
"action": {
"knownValues": [
"added",
"changed",
"removed",
"unchanged"
],
"type": "string"
},
"detail": {
"description": "The new text value, or the image's type and size.",
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"key",
"action"
],
"type": "object"
},
"main": {
"description": "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.",
"errors": [
{
"description": "The caller is not an admin.",
"name": "Unauthorized"
},
{
"description": "The zip, its branding.yaml or one of its values is not acceptable; the message names the key.",
"name": "InvalidBundle"
}
],
"input": {
"encoding": "application/zip"
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"applied": {
"description": "False for a dry run.",
"type": "boolean"
},
"changes": {
"items": {
"ref": "#change",
"type": "ref"
},
"type": "array"
},
"warnings": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"applied",
"changes"
],
"type": "object"
}
},
"parameters": {
"properties": {
"broadcaster": {
"description": "DID of the broadcaster. Defaults to this node's.",
"format": "did",
"type": "string"
},
"dryRun": {
"default": false,
"description": "Report what would change without writing anything.",
"type": "boolean"
},
"merge": {
"default": false,
"description": "Keep keys the bundle does not mention instead of removing them.",
"type": "boolean"
}
},
"type": "params"
},
"type": "procedure"
}
},
"id": "place.stream.branding.importBundle",
"lexicon": 1
}