garden.lexicon.documentation
Samples
6 randomly sampled records from the AT Protocol firehose
garden.lexicon.documentation (6 samples)
{
"$type": "garden.lexicon.documentation",
"lexicon": "garden.lexicon.service",
"createdAt": "2026-01-29T18:00:00.002Z",
"definitions": [
{
"name": "main",
"properties": [
{
"name": "serviceType",
"description": [
{
"lang": "en",
"value": "The type identifier for this service (e.g., 'AtprotoPersonalDataServer', 'AtprotoLabeler'). This should match the type used in the DID document."
},
{
"lang": "pt",
"value": "O identificador de tipo para este serviço (por exemplo, 'AtprotoPersonalDataServer', 'AtprotoLabeler'). Deve corresponder ao tipo usado no documento DID."
},
{
"lang": "ja",
"value": "このサービスの型識別子です（例：'AtprotoPersonalDataServer'、'AtprotoLabeler'）。DIDドキュメントで使用される型と一致する必要があります。"
},
{
"lang": "fr",
"value": "L'identifiant de type pour ce service (par exemple, 'AtprotoPersonalDataServer', 'AtprotoLabeler'). Doit correspondre au type utilisé dans le document DID."
}
]
},
{
"name": "description",
"description": [
{
"lang": "en",
"value": "A human-readable description of what this service provides and its purpose."
},
{
"lang": "pt",
"value": "Uma descrição legível por humanos do que este serviço fornece e seu propósito."
},
{
"lang": "ja",
"value": "このサービスが提供する内容とその目的の人間が読める説明です。"
},
{
"lang": "fr",
"value": "Une description lisible par l'homme de ce que ce service fournit et de son objectif."
}
]
},
{
"name": "methods",
"description": [
{
"lang": "en",
"value": "An array of XRPC methods that this service supports. Each method references a lexicon schema defining the method's interface."
},
{
"lang": "pt",
"value": "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."
},
{
"lang": "ja",
"value": "このサービスがサポートするXRPCメソッドの配列です。各メソッドは、メソッドのインターフェースを定義するレキシコンスキーマを参照します。"
},
{
"lang": "fr",
"value": "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."
}
]
},
{
"name": "urlTemplates",
"description": [
{
"lang": "en",
"value": "URL templates for constructing web URLs from AT-URIs or record data. Useful for linking to web views of records stored in this service."
},
{
"lang": "pt",
"value": "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."
},
{
"lang": "ja",
"value": "AT-URIまたはレコードデータからWeb URLを構築するためのURLテンプレートです。このサービスに保存されているレコードのWebビューにリンクするのに便利です。"
},
{
"lang": "fr",
"value": "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."
}
]
}
],
"description": [
{
"lang": "en",
"value": "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')."
},
{
"lang": "pt",
"value": "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')."
},
{
"lang": "ja",
"value": "サービスを宣言するための主要なレコードタイプです。rkeyは#プレフィックスなしのサービスフラグメントID（例：'#atproto_pds'に対して'atproto_pds'）である必要があります。"
},
{
"lang": "fr",
"value": "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')."
}
]
},
{
"name": "urlTemplate",
"properties": [
{
"name": "url",
"description": [
{
"lang": "en",
"value": "A URI template with placeholders for record data. Placeholders follow RFC 6570 syntax (e.g., '{did}', '{rkey}')."
},
{
"lang": "pt",
"value": "Um template de URI com marcadores de posição para dados de registro. Os marcadores seguem a sintaxe RFC 6570 (por exemplo, '{did}', '{rkey}')."
},
{
"lang": "ja",
"value": "レコードデータのプレースホルダを含むURIテンプレートです。プレースホルダはRFC 6570構文に従います（例：'{did}'、'{rkey}'）。"
},
{
"lang": "fr",
"value": "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}')."
}
]
},
{
"name": "description",
"description": [
{
"lang": "en",
"value": "A human-readable description of what this URL template is for and when it should be used."
},
{
"lang": "pt",
"value": "Uma descrição legível por humanos do propósito deste template de URL e quando deve ser usado."
},
{
"lang": "ja",
"value": "このURLテンプレートの目的と使用すべき場面についての人間が読める説明です。"
},
{
"lang": "fr",
"value": "Une description lisible par l'homme de l'objectif de ce modèle d'URL et de quand il doit être utilisé."
}
]
},
{
"name": "collections",
"description": [
{
"lang": "en",
"value": "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."
},
{
"lang": "pt",
"value": "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."
},
{
"lang": "ja",
"value": "このURLテンプレートが適用されるレコードコレクションのNSIDです。これらのコレクションのレコードが表示されるとき、このテンプレートを使用してWebリンクを構築できます。"
},
{
"lang": "fr",
"value": "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."
}
]
}
],
"description": [
{
"lang": "en",
"value": "A URL template for constructing web links to records or resources served by this service."
},
{
"lang": "pt",
"value": "Um template de URL para construir links web para registros ou recursos servidos por este serviço."
},
{
"lang": "ja",
"value": "このサービスが提供するレコードまたはリソースへのWebリンクを構築するためのURLテンプレートです。"
},
{
"lang": "fr",
"value": "Un modèle d'URL pour construire des liens web vers des enregistrements ou des ressources servis par ce service."
}
]
},
{
"name": "method",
"properties": [
{
"name": "lexicon",
"description": [
{
"lang": "en",
"value": "An AT-URI pointing to the lexicon schema that defines this method's interface (input, output, and errors)."
},
{
"lang": "pt",
"value": "Um AT-URI apontando para o esquema de lexicon que define a interface deste método (entrada, saída e erros)."
},
{
"lang": "ja",
"value": "このメソッドのインターフェース（入力、出力、エラー）を定義するレキシコンスキーマを指すAT-URIです。"
},
{
"lang": "fr",
"value": "Un AT-URI pointant vers le schéma de lexicon qui définit l'interface de cette méthode (entrée, sortie et erreurs)."
}
]
},
{
"name": "deprecated",
"description": [
{
"lang": "en",
"value": "Whether this method is deprecated and should no longer be used. Clients should avoid calling deprecated methods."
},
{
"lang": "pt",
"value": "Se este método está obsoleto e não deve mais ser usado. Os clientes devem evitar chamar métodos obsoletos."
},
{
"lang": "ja",
"value": "このメソッドが非推奨であり、使用すべきではないかどうか。クライアントは非推奨のメソッドの呼び出しを避けるべきです。"
},
{
"lang": "fr",
"value": "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."
}
]
},
{
"name": "authMethods",
"description": [
{
"lang": "en",
"value": "Authentication methods supported by this method. Known values include 'none', 'atproto.admin', 'atproto.bearer', 'atproto.oauth', and 'atproto.inter-service'."
},
{
"lang": "pt",
"value": "Métodos de autenticação suportados por este método. Valores conhecidos incluem 'none', 'atproto.admin', 'atproto.bearer', 'atproto.oauth' e 'atproto.inter-service'."
},
{
"lang": "ja",
"value": "このメソッドがサポートする認証方法です。既知の値には'none'、'atproto.admin'、'atproto.bearer'、'atproto.oauth'、'atproto.inter-service'が含まれます。"
},
{
"lang": "fr",
"value": "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'."
}
]
}
],
"description": [
{
"lang": "en",
"value": "A declaration of an XRPC method available on this service."
},
{
"lang": "pt",
"value": "Uma declaração de um método XRPC disponível neste serviço."
},
{
"lang": "ja",
"value": "このサービスで利用可能なXRPCメソッドの宣言です。"
},
{
"lang": "fr",
"value": "Une déclaration d'une méthode XRPC disponible sur ce service."
}
]
}
],
"description": [
{
"lang": "en",
"value": "Declares XRPC methods and URL templates available on a DID document service. Use this to document what services your identity provides."
},
{
"lang": "pt",
"value": "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."
},
{
"lang": "ja",
"value": "DIDドキュメントサービスで利用可能なXRPCメソッドとURLテンプレートを宣言します。これを使用して、IDが提供するサービスを文書化します。"
},
{
"lang": "fr",
"value": "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."
}
]
}did:plc:akhgi4ekkeaupiqsis6g2gqg | at://did:plc:akhgi4ekkeaupiqsis6g2gqg/garden.lexicon.documentation/garden.lexicon.service