Lexicon Garden

social.colibri.beta.community.deleteImage

Clears a community's picture or banner. Idempotent: clearing an image that was never set succeeds. The blob itself is left in the community's repo rather than deleted, so an older record revision still resolves.

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

Checks

Valid
  • unlimited-string defs.main.parameters.properties.kindNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Clears a community's picture or banner. Idempotent: clearing an image that was never set succeeds. The blob itself is left in the community's repo rather than deleted, so an older record revision still resolves.",
      "errors": [
        {
          "description": "The request is missing, malformed, or unverifiable service auth.",
          "name": "AuthRequired"
        },
        {
          "description": "The requesting user lacks the community.manage permission.",
          "name": "Forbidden"
        },
        {
          "description": "No community exists with that DID.",
          "name": "CommunityNotFound"
        },
        {
          "description": "The AppView's stored credentials for this community are missing or unusable.",
          "name": "CredentialsUnavailable"
        },
        {
          "description": "A PDS or third-party call the AppView depends on failed.",
          "name": "UpstreamFailure"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "community": {
              "description": "The community with the image cleared.",
              "ref": "social.colibri.beta.community.defs#communityView",
              "type": "ref"
            }
          },
          "required": [
            "community"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "community": {
            "description": "The community to clear the image on.",
            "format": "did",
            "type": "string"
          },
          "kind": {
            "description": "Which image to clear.",
            "knownValues": [
              "picture",
              "banner"
            ],
            "type": "string"
          }
        },
        "required": [
          "community",
          "kind"
        ],
        "type": "params"
      },
      "type": "procedure"
    }
  },
  "id": "social.colibri.beta.community.deleteImage",
  "lexicon": 1
}