garden.lexicon.service

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "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').",
      "key": "any",
      "record": {
        "properties": {
          "description": {
            "description": "Description of what this service provides.",
            "maxLength": 1000,
            "type": "string"
          },
          "methods": {
            "description": "Methods available on this service.",
            "items": {
              "ref": "#method",
              "type": "ref"
            },
            "type": "array"
          },
          "serviceType": {
            "description": "The type of service being declared.",
            "maxLength": 100,
            "type": "string"
          },
          "urlTemplates": {
            "description": "URL templates for constructing web URLs from AT-URIs or record data. Useful for linking to web views of records.",
            "items": {
              "ref": "#urlTemplate",
              "type": "ref"
            },
            "type": "array"
          }
        },
        "required": [
          "serviceType"
        ],
        "type": "object"
      },
      "type": "record"
    },
    "method": {
      "properties": {
        "authMethods": {
          "description": "Authentication methods supported by this method.",
          "items": {
            "knownValues": [
              "none",
              "atproto.admin",
              "atproto.bearer",
              "atproto.oauth",
              "atproto.inter-service"
            ],
            "maxLength": 50,
            "type": "string"
          },
          "type": "array"
        },
        "deprecated": {
          "description": "Whether this method is deprecated and should no longer be used.",
          "type": "boolean"
        },
        "lexicon": {
          "description": "AT-URI pointing to a lexicon schema that defines this method.",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "lexicon"
      ],
      "type": "object"
    },
    "urlTemplate": {
      "properties": {
        "collections": {
          "description": "NSIDs of collections this URL template applies to.",
          "items": {
            "format": "nsid",
            "type": "string"
          },
          "type": "array"
        },
        "description": {
          "description": "Description of what this URL template is for.",
          "maxLength": 1000,
          "type": "string"
        },
        "url": {
          "description": "URI template with placeholders for record data",
          "maxLength": 2000,
          "type": "string"
        }
      },
      "required": [
        "url"
      ],
      "type": "object"
    }
  },
  "id": "garden.lexicon.service",
  "lexicon": 1
}