Backfill in-progress. Some lexicons and records may be missing or incomplete.

garden.lexicon.service

lexicon.garden

Documentation

main record
2 examples

Declares XRPC methods available on a DID document service. The rkey is the service fragment ID without the # prefix (e.g., 'atproto_pds' for '#atproto_pds').

Record Key any Any valid record key

Properties

description string Optional

Description of what this service provides.

maxLength: 1000 bytes
methods array of ref #method Optional

Methods available on this service.

serviceType string Required

The type of service being declared.

maxLength: 100 bytes
urlTemplates array of ref #urlTemplate Optional

URL templates for constructing web URLs from AT-URIs or record data. Useful for linking to web views of records.

View raw schema 
{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "serviceType"
    ],
    "properties": {
      "methods": {
        "type": "array",
        "items": {
          "ref": "#method",
          "type": "ref"
        },
        "description": "Methods available on this service."
      },
      "description": {
        "type": "string",
        "maxLength": 1000,
        "description": "Description of what this service provides."
      },
      "serviceType": {
        "type": "string",
        "maxLength": 100,
        "description": "The type of service being declared."
      },
      "urlTemplates": {
        "type": "array",
        "items": {
          "ref": "#urlTemplate",
          "type": "ref"
        },
        "description": "URL templates for constructing web URLs from AT-URIs or record data. Useful for linking to web views of records."
      }
    }
  },
  "description": "Declares XRPC methods available on a DID document service. The rkey is the service fragment ID without the # prefix (e.g., 'atproto_pds' for '#atproto_pds')."
}
method object

Properties

authMethods array of string Optional

Authentication methods supported by this method.

deprecated boolean Optional

Whether this method is deprecated and should no longer be used.

lexicon string at-uri Required

AT-URI pointing to a lexicon schema that defines this method.

View raw schema 
{
  "type": "object",
  "required": [
    "lexicon"
  ],
  "properties": {
    "lexicon": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI pointing to a lexicon schema that defines this method."
    },
    "deprecated": {
      "type": "boolean",
      "description": "Whether this method is deprecated and should no longer be used."
    },
    "authMethods": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 50,
        "knownValues": [
          "none",
          "atproto.admin",
          "atproto.bearer",
          "atproto.oauth",
          "atproto.inter-service"
        ]
      },
      "description": "Authentication methods supported by this method."
    }
  }
}
urlTemplate object

Properties

collections array of stringnsid Optional

NSIDs of collections this URL template applies to.

description string Optional

Description of what this URL template is for.

maxLength: 1000 bytes
url string Required

URI template with placeholders for record data

maxLength: 2000 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "maxLength": 2000,
      "description": "URI template with placeholders for record data"
    },
    "collections": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "nsid"
      },
      "description": "NSIDs of collections this URL template applies to."
    },
    "description": {
      "type": "string",
      "maxLength": 1000,
      "description": "Description of what this URL template is for."
    }
  }
}

Lexicon Garden

@