social.coves.aggregator.enable

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

Repository @coves.social did:web:coves.social namespace authority
Details · procedure
Kindprocedure
Authorityaggregator.coves.social
Indexed

Procedure

procedure · POST

Input

application/json

aggregatorDid

requiredstring · did

DID of the aggregator to enable

community

requiredstring · at-identifier

DID or handle of the community

config

unknown

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

Output

application/json

authorization

requiredref

The created authorization details

cid

requiredstring · cid

CID of the created authorization record

uri

requiredstring · at-uri

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

Similar lexicons

semantic match

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

  • Update configuration for an enabled aggregator. Updates the authorization record's config field. Requires moderator permissions.

  • Authorization for an aggregator to post to a community with specific configuration. Published in the community's repository by moderators. The record key MUST be the authorized aggregator's DID, guaranteeing at most one authorization per (community, aggregator) pair. Similar to social.coves.actor.subscription.

  • Disable an aggregator for a community. Updates the authorization record to set enabled=false. Requires moderator permissions.

  • Get list of communities that have authorized a specific aggregator. Used by aggregators to query which communities they can post to. Authentication optional.

  • List all aggregators authorized for a specific community. Used by community settings UI to show enabled/disabled aggregators. Authentication optional.