fyi.opensocial.getTemplate

lexicons.opensocial.fyi

Documentation

One of the templates shared within the group, for its members alone: its page and how a tab uses it, at the version given, or else its latest.

main query

One of the templates shared within the group, for its members alone: its page and how a tab uses it, at the version given, or else its latest.

Parameters

cid string cid Optional

That version's CID.

group string did Required

A decentralized identifier (DID).

uri string at-uri Required

The template, its fyi.opensocial.template.

version string at-uri Optional

One of its versions, its fyi.opensocial.templateVersion.

Output

Encodingapplication/json
html string Required

Its page.

Errors

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
That version's CID.
A decentralized identifier (DID).
The template, its fyi.opensocial.template.
One of its versions, its fyi.opensocial.templateVersion.
View raw schema 
{
  "description": "One of the templates shared within the group, for its members alone: its page and how a tab uses it, at the version given, or else its latest.",
  "errors": [
    {
      "name": "NotFound"
    },
    {
      "name": "Forbidden"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "entry": {
          "ref": "fyi.opensocial.template#entry",
          "type": "ref"
        },
        "html": {
          "description": "Its page.",
          "type": "string"
        },
        "version": {
          "ref": "com.atproto.repo.strongRef",
          "type": "ref"
        }
      },
      "required": [
        "html",
        "entry",
        "version"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "cid": {
        "description": "That version's CID.",
        "format": "cid",
        "type": "string"
      },
      "group": {
        "format": "did",
        "type": "string"
      },
      "uri": {
        "description": "The template, its fyi.opensocial.template.",
        "format": "at-uri",
        "type": "string"
      },
      "version": {
        "description": "One of its versions, its fyi.opensocial.templateVersion.",
        "format": "at-uri",
        "type": "string"
      }
    },
    "required": [
      "group",
      "uri"
    ],
    "type": "params"
  },
  "type": "query"
}

Lexicon Garden

@