fyi.opensocial.getSiteDraft
The caller's draft of the group's site, if they have one, and whether the site's last publish can be undone. Only for whoever may change the site.
Details · query
| Kind | query |
|---|---|
| Authority | opensocial.fyi |
| Indexed |
Checks
Validunlimited-stringdefs.change.properties.channelNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.change.properties.howNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.change.properties.nameNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.change.properties.pathNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.change.properties.tabNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.change.properties.whatNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.draft.properties.byNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.draft.properties.descriptionNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.draft.properties.joinPolicyNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.draft.properties.nameNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.rule.properties.textNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.rule.properties.titleNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"change": {
"description": "One thing a draft changes, as a member would name it, and where it is.",
"properties": {
"channel": {
"description": "The channel it's in, by its address.",
"type": "string"
},
"how": {
"description": "Added or removed; otherwise changed.",
"knownValues": [
"added",
"removed"
],
"type": "string"
},
"name": {
"description": "As a member would say it: the tab's name, \"the colours and fonts\".",
"type": "string"
},
"path": {
"description": "A public page's path.",
"type": "string"
},
"tab": {
"description": "The tab, by its address.",
"type": "string"
},
"what": {
"description": "A tab (its page or settings), a tab's public page, a channel, the site design around the public pages, the colours and fonts, the public menu, or the group's own: its name, about, rules, pictures.",
"knownValues": [
"tab",
"public",
"channel",
"design",
"look",
"menu",
"group"
],
"type": "string"
}
},
"required": [
"what",
"name"
],
"type": "object"
},
"draft": {
"properties": {
"avatar": {
"description": "The group's picture, as the draft changes it.",
"format": "uri",
"type": "string"
},
"banner": {
"description": "Its banner, as the draft changes it.",
"format": "uri",
"type": "string"
},
"by": {
"description": "Who made the last change to it: an AI app's name.",
"type": "string"
},
"changed": {
"description": "What it changes from the live site, each thing once.",
"items": {
"ref": "#change",
"type": "ref"
},
"type": "array"
},
"createdAt": {
"format": "datetime",
"type": "string"
},
"description": {
"description": "What the group says about itself, as the draft changes it.",
"type": "string"
},
"joinPolicy": {
"description": "How people join, as the draft changes it.",
"type": "string"
},
"name": {
"description": "The group's name, as the draft changes it.",
"type": "string"
},
"note": {
"description": "What the AI app that made it says it does, in its own words.",
"maxGraphemes": 300,
"maxLength": 3000,
"type": "string"
},
"rules": {
"description": "The group's rules, as the draft has them.",
"items": {
"ref": "#rule",
"type": "ref"
},
"type": "array"
},
"updatedAt": {
"format": "datetime",
"type": "string"
},
"uri": {
"description": "The draft's site record, in the members space.",
"format": "at-uri",
"type": "string"
}
},
"required": [
"by",
"updatedAt",
"uri"
],
"type": "object"
},
"main": {
"description": "The caller's draft of the group's site, if they have one, and whether the site's last publish can be undone. Only for whoever may change the site.",
"errors": [
{
"name": "Forbidden"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"draft": {
"ref": "#draft",
"type": "ref"
},
"making": {
"description": "Whether the host is making the caller a draft now: a new group's front page.",
"type": "boolean"
},
"undo": {
"ref": "#undo",
"type": "ref"
}
},
"type": "object"
}
},
"parameters": {
"properties": {
"group": {
"format": "did",
"type": "string"
}
},
"required": [
"group"
],
"type": "params"
},
"type": "query"
},
"rule": {
"properties": {
"text": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"title"
],
"type": "object"
},
"undo": {
"properties": {
"mine": {
"type": "boolean"
},
"publishedAt": {
"format": "datetime",
"type": "string"
}
},
"required": [
"publishedAt",
"mine"
],
"type": "object"
}
},
"id": "fyi.opensocial.getSiteDraft",
"lexicon": 1
}