fyi.opensocial.getTemplateListing

lexicons.opensocial.fyi

Documentation

A template shared with everyone, for its own page: what it's called, who made it, what a tab of it does at its latest version, and every version. For anyone; never one shared within a group.

main query

A template shared with everyone, for its own page: what it's called, who made it, what a tab of it does at its latest version, and every version. For anyone; never one shared within a group.

Parameters

uri string at-uri Required

The template, its fyi.opensocial.template in whoever made it's repo.

Output

Encodingapplication/json
description string Required

No description available.

hidden boolean Optional

Labelled hidden, it or its latest version, by this host's moderators or a labeler it follows: left out of where people look for things to add. Tabs of it keep working.

keptBy integer Optional

How many groups on this host have a tab of it now, of any version. Groups elsewhere aren't counted.

kinds array Optional

The kinds of record it makes up, under the placeholder namespace each tab names for itself.

likes integer Optional

How many people like it, as this host has seen.

listed boolean Optional

Whoever made it asks for it to be listed: its listing says so.

maker ref#makerView Required

No description available.

name string Required

Its record key: lowercase letters, digits and dashes.

number integer Required

No description available.

scan ref#scanView Optional

What this host's scan of every version not taken back found, each thing found saying which version.

shown boolean Optional

Whether this host lists it where people look for things to add: listed, kept by enough of its groups for long enough, its latest version scanned with nothing found, and nothing labelling it hidden.

uri stringat-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

versions array Required

Every version, newest first.

Errors

NotFound
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
The template, its fyi.opensocial.template in whoever made it's repo.
View raw schema 
{
  "description": "A template shared with everyone, for its own page: what it's called, who made it, what a tab of it does at its latest version, and every version. For anyone; never one shared within a group.",
  "errors": [
    {
      "name": "NotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "description": {
          "type": "string"
        },
        "entry": {
          "description": "What a tab of its latest version does, its own kinds of record not yet named for any tab.",
          "ref": "fyi.opensocial.template#entry",
          "type": "ref"
        },
        "hidden": {
          "description": "Labelled hidden, it or its latest version, by this host's moderators or a labeler it follows: left out of where people look for things to add. Tabs of it keep working.",
          "type": "boolean"
        },
        "keptBy": {
          "description": "How many groups on this host have a tab of it now, of any version. Groups elsewhere aren't counted.",
          "minimum": 0,
          "type": "integer"
        },
        "kinds": {
          "description": "The kinds of record it makes up, under the placeholder namespace each tab names for itself.",
          "items": {
            "format": "nsid",
            "type": "string"
          },
          "type": "array"
        },
        "likes": {
          "description": "How many people like it, as this host has seen.",
          "minimum": 0,
          "type": "integer"
        },
        "listed": {
          "description": "Whoever made it asks for it to be listed: its listing says so.",
          "type": "boolean"
        },
        "maker": {
          "ref": "#makerView",
          "type": "ref"
        },
        "name": {
          "description": "Its record key: lowercase letters, digits and dashes.",
          "type": "string"
        },
        "number": {
          "minimum": 1,
          "type": "integer"
        },
        "scan": {
          "description": "What this host's scan of every version not taken back found, each thing found saying which version.",
          "ref": "#scanView",
          "type": "ref"
        },
        "shown": {
          "description": "Whether this host lists it where people look for things to add: listed, kept by enough of its groups for long enough, its latest version scanned with nothing found, and nothing labelling it hidden.",
          "type": "boolean"
        },
        "uri": {
          "format": "at-uri",
          "type": "string"
        },
        "version": {
          "description": "Its latest version, which a tab added from it names.",
          "ref": "com.atproto.repo.strongRef",
          "type": "ref"
        },
        "versions": {
          "description": "Every version, newest first.",
          "items": {
            "ref": "fyi.opensocial.listTemplates#versionView",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "uri",
        "name",
        "description",
        "maker",
        "version",
        "number",
        "entry",
        "versions"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "uri": {
        "description": "The template, its fyi.opensocial.template in whoever made it's repo.",
        "format": "at-uri",
        "type": "string"
      }
    },
    "required": [
      "uri"
    ],
    "type": "params"
  },
  "type": "query"
}
makerView object

No description available.

Properties

avatar string uri Optional

A valid URI.

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

group boolean Optional

Whether a group made it: one this host runs.

handle string handle Optional

An AT Protocol handle (e.g., alice.bsky.social).

View raw schema 
{
  "properties": {
    "avatar": {
      "format": "uri",
      "type": "string"
    },
    "did": {
      "format": "did",
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "group": {
      "description": "Whether a group made it: one this host runs.",
      "type": "boolean"
    },
    "handle": {
      "format": "handle",
      "type": "string"
    }
  },
  "required": [
    "did"
  ],
  "type": "object"
}
scanView object

What this host's scan of one version found: its own kinds of record against atproto's rules, what its pages try to load or run that its frame wouldn't let them, and its sizes against this host's limits. A scan, not a person's review.

Properties

found array of string Required

Each thing found, in a sentence.

ok boolean Required

Nothing was found.

View raw schema 
{
  "description": "What this host's scan of one version found: its own kinds of record against atproto's rules, what its pages try to load or run that its frame wouldn't let them, and its sizes against this host's limits. A scan, not a person's review.",
  "properties": {
    "found": {
      "description": "Each thing found, in a sentence.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "ok": {
      "description": "Nothing was found.",
      "type": "boolean"
    }
  },
  "required": [
    "ok",
    "found"
  ],
  "type": "object"
}

Lexicon Garden

@