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

Déclare les méthodes XRPC et les modèles d'URL disponibles sur un service de document DID. Utilisez ceci pour documenter les services que votre identité fournit.

main

Le type d'enregistrement principal pour déclarer un service. Le rkey doit être l'ID du fragment de service sans le préfixe # (par exemple, 'atproto_pds' pour '#atproto_pds').

serviceType
L'identifiant de type pour ce service (par exemple, 'AtprotoPersonalDataServer', 'AtprotoLabeler'). Doit correspondre au type utilisé dans le document DID.
description
Une description lisible par l'homme de ce que ce service fournit et de son objectif.
methods
Un tableau de méthodes XRPC que ce service prend en charge. Chaque méthode référence un schéma de lexicon définissant l'interface de la méthode.
urlTemplates
Modèles d'URL pour construire des URLs web à partir d'AT-URIs ou de données d'enregistrement. Utile pour créer des liens vers des vues web des enregistrements stockés dans ce service.

#urlTemplate

Un modèle d'URL pour construire des liens web vers des enregistrements ou des ressources servis par ce service.

url
Un modèle d'URI avec des espaces réservés pour les données d'enregistrement. Les espaces réservés suivent la syntaxe RFC 6570 (par exemple, '{did}', '{rkey}').
description
Une description lisible par l'homme de l'objectif de ce modèle d'URL et de quand il doit être utilisé.
collections
NSIDs des collections d'enregistrements auxquelles ce modèle d'URL s'applique. Lorsqu'un enregistrement de l'une de ces collections est consulté, ce modèle peut être utilisé pour construire un lien web.

#method

Une déclaration d'une méthode XRPC disponible sur ce service.

lexicon
Un AT-URI pointant vers le schéma de lexicon qui définit l'interface de cette méthode (entrée, sortie et erreurs).
deprecated
Si cette méthode est obsolète et ne doit plus être utilisée. Les clients doivent éviter d'appeler les méthodes obsolètes.
authMethods
Méthodes d'authentification prises en charge par cette méthode. Les valeurs connues incluent 'none', 'atproto.admin', 'atproto.bearer', 'atproto.oauth' et '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.