fyi.opensocial.getTabBundle

lexicons.opensocial.fyi

Documentation

A tab you can see, as a template shared from it has it, for sharing it with everyone as yourself: its page, its methods and the kinds of record it makes up, the tab's namespace in them made the placeholder, and what a tab of it does. Its records are written in your own repo by you: a fyi.opensocial.templateVersion, each file a blob, and the fyi.opensocial.template listing it, at the record key given. Refused as shareTab refuses, and a new version whose kinds of record change in a way records already kept wouldn't fit.

main query

A tab you can see, as a template shared from it has it, for sharing it with everyone as yourself: its page, its methods and the kinds of record it makes up, the tab's namespace in them made the placeholder, and what a tab of it does. Its records are written in your own repo by you: a fyi.opensocial.templateVersion, each file a blob, and the fyi.opensocial.template listing it, at the record key given. Refused as shareTab refuses, and a new version whose kinds of record change in a way records already kept wouldn't fit.

Parameters

description string Required

One line saying what it is.

group string did Required

A decentralized identifier (DID).

name string Required

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

tab string Required

The tab's namespace.

Output

Encodingapplication/json
files array Required

The version's files, by path, as text.

number integer Required

Which version this is.

previous ref#previous Optional

The listing in your repo shared from this tab before, if there is one.

rkey string Required

The listing's record key in your repo: the one shared from this tab before, or a new one from its name.

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://api.bsky.social)
Parameters
One line saying what it is.
A decentralized identifier (DID).
What it's called, where it's offered.
The tab's namespace.
View raw schema 
{
  "description": "A tab you can see, as a template shared from it has it, for sharing it with everyone as yourself: its page, its methods and the kinds of record it makes up, the tab's namespace in them made the placeholder, and what a tab of it does. Its records are written in your own repo by you: a fyi.opensocial.templateVersion, each file a blob, and the fyi.opensocial.template listing it, at the record key given. Refused as shareTab refuses, and a new version whose kinds of record change in a way records already kept wouldn't fit.",
  "errors": [
    {
      "name": "InvalidTab"
    },
    {
      "name": "NotFound"
    },
    {
      "name": "Forbidden"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "entry": {
          "description": "What a tab of it does, for the version's entry.",
          "ref": "fyi.opensocial.template#entry",
          "type": "ref"
        },
        "files": {
          "description": "The version's files, by path, as text.",
          "items": {
            "ref": "#file",
            "type": "ref"
          },
          "type": "array"
        },
        "number": {
          "description": "Which version this is.",
          "minimum": 1,
          "type": "integer"
        },
        "previous": {
          "description": "The listing in your repo shared from this tab before, if there is one.",
          "ref": "#previous",
          "type": "ref"
        },
        "rkey": {
          "description": "The listing's record key in your repo: the one shared from this tab before, or a new one from its name.",
          "type": "string"
        }
      },
      "required": [
        "rkey",
        "number",
        "entry",
        "files"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "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"
    ],
    "type": "params"
  },
  "type": "query"
}
file object

No description available.

Properties

path string Required

Where it is in the template: template.html, methods/<name>.js, lexicons/<nsid>.json.

text string Required

No description available.

View raw schema 
{
  "properties": {
    "path": {
      "description": "Where it is in the template: template.html, methods/<name>.js, lexicons/<nsid>.json.",
      "type": "string"
    },
    "text": {
      "type": "string"
    }
  },
  "required": [
    "path",
    "text"
  ],
  "type": "object"
}
previous object

No description available.

Properties

number integer Required

No description available.

minimum: 1
uri string at-uri Required

The listing, its fyi.opensocial.template.

View raw schema 
{
  "properties": {
    "number": {
      "minimum": 1,
      "type": "integer"
    },
    "uri": {
      "description": "The listing, its fyi.opensocial.template.",
      "format": "at-uri",
      "type": "string"
    },
    "version": {
      "description": "Its latest version.",
      "ref": "com.atproto.repo.strongRef",
      "type": "ref"
    }
  },
  "required": [
    "uri",
    "version",
    "number"
  ],
  "type": "object"
}

Lexicon Garden

@