Example for garden.lexicon.documentation

Value

{
  "$type": "garden.lexicon.documentation",
  "lexicon": "garden.lexicon.service",
  "createdAt": "2026-01-29T18:00:00.000Z",
  "definitions": [
    {
      "name": "main",
      "properties": [
        {
          "name": "serviceType",
          "description": [
            {
              "lang": "en",
              "value": "The type identifier for this service (e.g., 'AtprotoPersonalDataServer')."
            },
            {
              "lang": "pt",
              "value": "O identificador de tipo para este servico (ex: 'AtprotoPersonalDataServer')."
            },
            {
              "lang": "ja",
              "value": "このサービスのタイプ識別子（例：'AtprotoPersonalDataServer'）。"
            }
          ]
        },
        {
          "name": "methods",
          "description": [
            {
              "lang": "en",
              "value": "XRPC methods available on this service, each referencing a lexicon schema."
            },
            {
              "lang": "pt",
              "value": "Metodos XRPC disponiveis neste servico, cada um referenciando um esquema de lexicon."
            },
            {
              "lang": "ja",
              "value": "このサービスで利用可能なXRPCメソッド。各メソッドはレキシコンスキーマを参照します。"
            }
          ]
        },
        {
          "name": "urlTemplates",
          "description": [
            {
              "lang": "en",
              "value": "URL templates for constructing web URLs from AT-URIs. Supports placeholders like {authority} and {rkey}."
            },
            {
              "lang": "pt",
              "value": "Modelos de URL para construir URLs web a partir de AT-URIs. Suporta marcadores como {authority} e {rkey}."
            },
            {
              "lang": "ja",
              "value": "AT-URIからWeb URLを構築するためのURLテンプレート。{authority}や{rkey}などのプレースホルダーをサポートします。"
            }
          ]
        }
      ],
      "description": [
        {
          "lang": "en",
          "value": "The main service record. The rkey should be the service fragment ID without the # prefix."
        },
        {
          "lang": "pt",
          "value": "O registro de servico principal. O rkey deve ser o ID do fragmento do servico sem o prefixo #."
        },
        {
          "lang": "ja",
          "value": "メインのサービスレコード。rkeyは#プレフィックスなしのサービスフラグメントIDである必要があります。"
        }
      ]
    },
    {
      "name": "urlTemplate",
      "description": [
        {
          "lang": "en",
          "value": "A URL template that maps AT-URIs to web URLs for specific collections."
        },
        {
          "lang": "pt",
          "value": "Um modelo de URL que mapeia AT-URIs para URLs web para colecoes especificas."
        },
        {
          "lang": "ja",
          "value": "特定のコレクションに対してAT-URIをWeb URLにマッピングするURLテンプレート。"
        }
      ]
    },
    {
      "name": "method",
      "description": [
        {
          "lang": "en",
          "value": "An XRPC method declaration with authentication requirements."
        },
        {
          "lang": "pt",
          "value": "Uma declaracao de metodo XRPC com requisitos de autenticacao."
        },
        {
          "lang": "ja",
          "value": "認証要件を含むXRPCメソッド宣言。"
        }
      ]
    }
  ],
  "description": [
    {
      "lang": "en",
      "value": "Declares services available on a DID document, including XRPC methods and URL templates for web views."
    },
    {
      "lang": "pt",
      "value": "Declara servicos disponiveis em um documento DID, incluindo metodos XRPC e modelos de URL para visualizacoes web."
    },
    {
      "lang": "ja",
      "value": "DIDドキュメントで利用可能なサービスを宣言します。XRPCメソッドとWebビュー用のURLテンプレートを含みます。"
    }
  ]
}