fyi.opensocial.shareTab

lexicons.opensocial.fyi

Documentation

Share a tab you can see as a template, for whoever it's shared with to add: its page, its methods and the kinds of record it makes up, never anything written in it. Shared with the group, it's kept in the group's members space, for members to add to their channels. Shared with everyone as the group, it's published in the group's own repo, by whoever may publish for the group, for anyone with its link to add to their own group. Sharing the same tab again to the same place puts out a new version of the same template. To share it with everyone as yourself, see getTabBundle.

main procedure

Share a tab you can see as a template, for whoever it's shared with to add: its page, its methods and the kinds of record it makes up, never anything written in it. Shared with the group, it's kept in the group's members space, for members to add to their channels. Shared with everyone as the group, it's published in the group's own repo, by whoever may publish for the group, for anyone with its link to add to their own group. Sharing the same tab again to the same place puts out a new version of the same template. To share it with everyone as yourself, see getTabBundle.

Input

Encodingapplication/json
audience string Required

Who it's shared with: group, the group's members alone; everyone-as-group, anyone, from the group.

maxLength: 32 bytes
changes string Optional

What's new since it was last shared.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
description string Required

One line saying what it is.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
group stringdid Required

A decentralized identifier (DID).

name string Required

What it's called, where it's offered.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
tab string Required

The tab's namespace.

maxLength: 13 bytes

Output

Encodingapplication/json
number integer Required

Which version it is.

uri stringat-uri Required

The template, its fyi.opensocial.template: in the members space, or the group's repo.

Errors

InvalidTab
NotFound
Forbidden
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": "Share a tab you can see as a template, for whoever it's shared with to add: its page, its methods and the kinds of record it makes up, never anything written in it. Shared with the group, it's kept in the group's members space, for members to add to their channels. Shared with everyone as the group, it's published in the group's own repo, by whoever may publish for the group, for anyone with its link to add to their own group. Sharing the same tab again to the same place puts out a new version of the same template. To share it with everyone as yourself, see getTabBundle.",
  "errors": [
    {
      "name": "InvalidTab"
    },
    {
      "name": "NotFound"
    },
    {
      "name": "Forbidden"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "audience": {
          "description": "Who it's shared with: group, the group's members alone; everyone-as-group, anyone, from the group.",
          "knownValues": [
            "group",
            "everyone-as-group"
          ],
          "maxLength": 32,
          "type": "string"
        },
        "changes": {
          "description": "What's new since it was last shared.",
          "maxGraphemes": 300,
          "maxLength": 3000,
          "type": "string"
        },
        "description": {
          "description": "One line saying what it is.",
          "maxGraphemes": 300,
          "maxLength": 3000,
          "type": "string"
        },
        "group": {
          "format": "did",
          "type": "string"
        },
        "name": {
          "description": "What it's called, where it's offered.",
          "maxGraphemes": 64,
          "maxLength": 640,
          "type": "string"
        },
        "tab": {
          "description": "The tab's namespace.",
          "maxLength": 13,
          "type": "string"
        }
      },
      "required": [
        "group",
        "tab",
        "name",
        "description",
        "audience"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "number": {
          "description": "Which version it is.",
          "minimum": 1,
          "type": "integer"
        },
        "uri": {
          "description": "The template, its fyi.opensocial.template: in the members space, or the group's repo.",
          "format": "at-uri",
          "type": "string"
        },
        "version": {
          "description": "The version just put out, its fyi.opensocial.templateVersion.",
          "ref": "com.atproto.repo.strongRef",
          "type": "ref"
        }
      },
      "required": [
        "uri",
        "version",
        "number"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@