garden.lexicon.service

Declares XRPC methods and URL templates available on a DID document service. Use this to document what services your identity provides.

main

The primary record type for declaring a service. The rkey should be the service fragment ID without the # prefix (e.g., 'atproto_pds' for '#atproto_pds').

serviceType

The type identifier for this service (e.g., 'AtprotoPersonalDataServer', 'AtprotoLabeler'). This should match the type used in the DID document.

description

A human-readable description of what this service provides and its purpose.

methods

An array of XRPC methods that this service supports. Each method references a lexicon schema defining the method's interface.

urlTemplates

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

#urlTemplate

A URL template for constructing web links to records or resources served by this service.

url

A URI template with placeholders for record data. Placeholders follow RFC 6570 syntax (e.g., '{did}', '{rkey}').

description

A human-readable description of what this URL template is for and when it should be used.

collections

NSIDs of record collections that this URL template applies to. When a record from one of these collections is viewed, this template can be used to construct a web link.

#method

A declaration of an XRPC method available on this service.

lexicon

An AT-URI pointing to the lexicon schema that defines this method's interface (input, output, and errors).

deprecated

Whether this method is deprecated and should no longer be used. Clients should avoid calling deprecated methods.

authMethods

Authentication methods supported by this method. Known values include 'none', 'atproto.admin', 'atproto.bearer', 'atproto.oauth', and 'atproto.inter-service'.