Lexicon Garden

garden.lexicon.service

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').

Repository @lexicon.garden did:plc:akhgi4ekkeaupiqsis6g2gqg namespace authority
Details · record, key any
Kindrecord
Record keyany
Authoritylexicon.garden
Indexed
Compare Edit in builder → Fork →

Record

record · key any

Properties

description

string

Description of what this service provides.

  • maxLength: 1000

methods

array

Methods available on this service.

itemsref
Reference

serviceType

requiredstring

The type of service being declared.

  • maxLength: 100

urlTemplates

array

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

itemsref
Reference

#method

object

Properties

authMethods

array

Authentication methods supported by this method.

itemsstring
  • maxLength: 50
  • knownValues: none | atproto.admin | atproto.bearer | atproto.oauth | atproto.inter-service

deprecated

boolean

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

lexicon

requiredstring · at-uri

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

#urlTemplate

object

Properties

collections

array

NSIDs of collections this URL template applies to.

itemsstring · nsid

description

string

Description of what this URL template is for.

  • maxLength: 1000

url

requiredstring

URI template with placeholders for record data

  • maxLength: 2000

Publisher documentation

Declara métodos XRPC e templates de URL disponíveis em um serviço de documento DID. Use isso para documentar quais serviços sua identidade fornece.

main

O tipo de registro principal para declarar um serviço. O rkey deve ser o ID do fragmento de serviço sem o prefixo # (por exemplo, 'atproto_pds' para '#atproto_pds').

serviceType
O identificador de tipo para este serviço (por exemplo, 'AtprotoPersonalDataServer', 'AtprotoLabeler'). Deve corresponder ao tipo usado no documento DID.
description
Uma descrição legível por humanos do que este serviço fornece e seu propósito.
methods
Um array de métodos XRPC que este serviço suporta. Cada método referencia um esquema de lexicon que define a interface do método.
urlTemplates
Templates de URL para construir URLs web a partir de AT-URIs ou dados de registro. Útil para vincular a visualizações web de registros armazenados neste serviço.

#urlTemplate

Um template de URL para construir links web para registros ou recursos servidos por este serviço.

url
Um template de URI com marcadores de posição para dados de registro. Os marcadores seguem a sintaxe RFC 6570 (por exemplo, '{did}', '{rkey}').
description
Uma descrição legível por humanos do propósito deste template de URL e quando deve ser usado.
collections
NSIDs das coleções de registros às quais este template de URL se aplica. Quando um registro de uma dessas coleções é visualizado, este template pode ser usado para construir um link web.

#method

Uma declaração de um método XRPC disponível neste serviço.

lexicon
Um AT-URI apontando para o esquema de lexicon que define a interface deste método (entrada, saída e erros).
deprecated
Se este método está obsoleto e não deve mais ser usado. Os clientes devem evitar chamar métodos obsoletos.
authMethods
Métodos de autenticação suportados por este método. Valores conhecidos incluem 'none', 'atproto.admin', 'atproto.bearer', 'atproto.oauth' e 'atproto.inter-service'.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • at.inlay.endpoint

    record

    Endpoint record. Declares that a DID serves a given XRPC method. The rkey is the method NSID.