Lexicon Garden

fyi.opensocial.getSuggestedSite

What a new group's site might start with, from its name and what it's for: its channels, their tabs, and looks of its own to choose from. Host-level, for whoever is starting a group. Empty when the host can't say.

Repository @lexicons.opensocial.fyi did:plc:2gqnilpksz2e7faj3bwvo6qc namespace authority
Details · query
Kindquery
Authorityopensocial.fyi
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

description

string
  • maxLength: 300

joinPolicy

string

Who can join, as the group's profile will say it.

name

requiredstring
  • maxLength: 64

Output

application/json

channels

requiredarray

Beside its Welcome channel, which every site has.

itemsref
Reference

looks

requiredarray

Up to three, each in a different direction, best first. None when no look held up: the site starts with the host's.

itemsref
Reference

Errors

RateLimitExceeded

No description in schema.

#channel

object

Properties

about

requiredstring

What it's for, in a line.

name

requiredstring

tabs

requiredarray
itemsref
Reference

#look

object

Properties

name

requiredstring

The direction it's in: Night, Club colours.

theme

requiredref
Reference

#tab

object

Properties

template

requiredstring

A template the kit bundles, or one of the host's own kinds of tab.

title

requiredstring

Similar lexicons

semantic match

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

  • fyi.opensocial.getSite

    query

    The group's site record. A member gets the whole of it as they may see it: without the channels their roles keep them from, unless they may change the site, when it's every channel, to change and put back with putSite; and the channels for chosen people they're in. Anyone else gets its public part, only when the group's meta space is public. A group that has not published one gets the starter, with no uri.

  • fyi.opensocial.site

    record

    A group's site, in its members space: channels of tabs, shown one at a time, each a whole HTML document drawn in a sandboxed frame. Authored by the group DID; written through putSite by whoever holds group.configure. Anyone else is handed only its public part, by the host. A group without one is shown the starter.

  • fyi.opensocial.getSiteDraft

    query

    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.