social.coves.aggregator.enable
Enable an aggregator for a community. Creates an authorization record in the community's repository. Requires moderator permissions.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | aggregator.coves.social |
| Indexed |
Procedure
procedure · POSTInput
application/jsonDID of the aggregator to enable
DID or handle of the community
config
unknownAggregator-specific configuration. Must conform to the aggregator's configSchema.
Output
application/jsonThe created authorization details
CID of the created authorization record
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 matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
social.coves.aggregator.updateConfig
procedureUpdate 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.
-
social.coves.aggregator.disable
procedureDisable 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.