social.coves.aggregator.enable

coves.social

Documentation

Enable an aggregator for a community. Creates an authorization record in the community's repository. Requires moderator permissions.

main procedure

Enable an aggregator for a community. Creates an authorization record in the community's repository. Requires moderator permissions.

Input

Encodingapplication/json
aggregatorDid stringdid Required

DID of the aggregator to enable

community stringat-identifier Required

DID or handle of the community

config unknown Optional

Aggregator-specific configuration. Must conform to the aggregator's configSchema.

Output

Encodingapplication/json
cid stringcid Required

CID of the created authorization record

uri stringat-uri Required

AT-URI of the created authorization record

Errors

NotAuthorized Caller is not a moderator of this community
AggregatorNotFound Aggregator DID does not exist or has no service declaration
InvalidConfig Config does not match aggregator's configSchema
AlreadyEnabled Aggregator is already enabled for this community
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "community",
        "aggregatorDid"
      ],
      "properties": {
        "config": {
          "type": "unknown",
          "description": "Aggregator-specific configuration. Must conform to the aggregator's configSchema."
        },
        "community": {
          "type": "string",
          "format": "at-identifier",
          "description": "DID or handle of the community"
        },
        "aggregatorDid": {
          "type": "string",
          "format": "did",
          "description": "DID of the aggregator to enable"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "NotAuthorized",
      "description": "Caller is not a moderator of this community"
    },
    {
      "name": "AggregatorNotFound",
      "description": "Aggregator DID does not exist or has no service declaration"
    },
    {
      "name": "InvalidConfig",
      "description": "Config does not match aggregator's configSchema"
    },
    {
      "name": "AlreadyEnabled",
      "description": "Aggregator is already enabled for this community"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "cid",
        "authorization"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid",
          "description": "CID of the created authorization record"
        },
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the created authorization record"
        },
        "authorization": {
          "ref": "social.coves.aggregator.defs#authorizationView",
          "type": "ref",
          "description": "The created authorization details"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Enable an aggregator for a community. Creates an authorization record in the community's repository. Requires moderator permissions."
}

Lexicon Garden

@