fyi.opensocial.putSiteTab

lexicons.opensocial.fyi

Documentation

Give something in the group's spaces — a record, or a space — a tab on its site, or name its tab again if it has one. Allowed to whoever may write it as the group (a record: its space's credentialScopes) or configure it (a space), as well as group.configure.

main procedure

Give something in the group's spaces — a record, or a space — a tab on its site, or name its tab again if it has one. Allowed to whoever may write it as the group (a record: its space's credentialScopes) or configure it (a space), as well as group.configure.

Input

Encodingapplication/json
about string Required

What the tab is about: a record in one of the group's spaces, or one of its spaces, by URI.

maxLength: 512 bytes
channel string Optional

The channel to put a new tab in, by slug.

maxLength: 64 bytes
existing boolean Optional

Only name its tab again, if it has one; never add one.

group stringdid Required

The group DID. Every method is served by the group's host and authorized against that group's roles.

page string Optional

One of the site's files to show, as the site's tabs have it. Needs group.configure.

maxLength: 256 bytes
template string Optional

What it shows: a template the kit bundles, by name, or one the site already uses. Without, it is like the site's other tabs about this kind of thing, or shows the kit's template for it. A template not for this kind of thing needs group.configure.

maxLength: 512 bytes
title string Required

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes

Output

Encodingapplication/json
channel string Optional

Where its tab is; none, when it has none and existing asked not to add one.

slug string Optional

No description available.

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 
{
  "description": "Give something in the group's spaces — a record, or a space — a tab on its site, or name its tab again if it has one. Allowed to whoever may write it as the group (a record: its space's credentialScopes) or configure it (a space), as well as group.configure.",
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "about": {
          "description": "What the tab is about: a record in one of the group's spaces, or one of its spaces, by URI.",
          "maxLength": 512,
          "type": "string"
        },
        "channel": {
          "description": "The channel to put a new tab in, by slug.",
          "maxLength": 64,
          "type": "string"
        },
        "existing": {
          "description": "Only name its tab again, if it has one; never add one.",
          "type": "boolean"
        },
        "group": {
          "description": "The group DID. Every method is served by the group's host and authorized against that group's roles.",
          "format": "did",
          "type": "string"
        },
        "page": {
          "description": "One of the site's files to show, as the site's tabs have it. Needs group.configure.",
          "maxLength": 256,
          "type": "string"
        },
        "template": {
          "description": "What it shows: a template the kit bundles, by name, or one the site already uses. Without, it is like the site's other tabs about this kind of thing, or shows the kit's template for it. A template not for this kind of thing needs group.configure.",
          "maxLength": 512,
          "type": "string"
        },
        "title": {
          "maxGraphemes": 64,
          "maxLength": 640,
          "type": "string"
        }
      },
      "required": [
        "group",
        "about",
        "title"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "channel": {
          "description": "Where its tab is; none, when it has none and existing asked not to add one.",
          "type": "string"
        },
        "slug": {
          "type": "string"
        }
      },
      "required": [],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@