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

DIDドキュメントサービスで利用可能なXRPCメソッドとURLテンプレートを宣言します。これを使用して、IDが提供するサービスを文書化します。

main

サービスを宣言するための主要なレコードタイプです。rkeyは#プレフィックスなしのサービスフラグメントID（例：'#atproto_pds'に対して'atproto_pds'）である必要があります。

serviceType
このサービスの型識別子です（例：'AtprotoPersonalDataServer'、'AtprotoLabeler'）。DIDドキュメントで使用される型と一致する必要があります。
description
このサービスが提供する内容とその目的の人間が読める説明です。
methods
このサービスがサポートするXRPCメソッドの配列です。各メソッドは、メソッドのインターフェースを定義するレキシコンスキーマを参照します。
urlTemplates
AT-URIまたはレコードデータからWeb URLを構築するためのURLテンプレートです。このサービスに保存されているレコードのWebビューにリンクするのに便利です。

#urlTemplate

このサービスが提供するレコードまたはリソースへのWebリンクを構築するためのURLテンプレートです。

url
レコードデータのプレースホルダを含むURIテンプレートです。プレースホルダはRFC 6570構文に従います（例：'{did}'、'{rkey}'）。
description
このURLテンプレートの目的と使用すべき場面についての人間が読める説明です。
collections
このURLテンプレートが適用されるレコードコレクションのNSIDです。これらのコレクションのレコードが表示されるとき、このテンプレートを使用してWebリンクを構築できます。

#method

このサービスで利用可能なXRPCメソッドの宣言です。

lexicon
このメソッドのインターフェース（入力、出力、エラー）を定義するレキシコンスキーマを指すAT-URIです。
deprecated
このメソッドが非推奨であり、使用すべきではないかどうか。クライアントは非推奨のメソッドの呼び出しを避けるべきです。
authMethods
このメソッドがサポートする認証方法です。既知の値には'none'、'atproto.admin'、'atproto.bearer'、'atproto.oauth'、'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.