Lexicon Garden

garden.lexicon.documentation

Auxiliary documentation for a lexicon schema, supporting localized descriptions for the lexicon and its properties.

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

Record

record · key nsid

Properties

createdAt

requiredstring · datetime

Timestamp when this documentation was created.

definitions

array

Documentation for specific definitions within the lexicon (e.g., main, replyRef).

itemsref
Reference

description

array

Localized descriptions for the lexicon.

itemsref
Reference

lexicon

requiredstring · nsid

The NSID of the lexicon being documented.

#definitionDoc

object

Documentation for a definition within a lexicon.

Properties

description

array

Localized descriptions for this definition.

itemsref
Reference

name

requiredstring

The name of the definition being documented (e.g., 'main', 'replyRef').

  • maxLength: 512

properties

array

Documentation for properties within this definition.

itemsref
Reference

#localizedString

object

A string with an associated language code.

Properties

lang

requiredstring · language

ISO 639 language code (e.g., 'en', 'es', 'ja').

value

requiredstring

The localized string value.

  • maxLength: 10000

#propertyDoc

object

Documentation for a specific property within a definition.

Properties

description

array

Localized descriptions for this property.

itemsref
Reference

name

requiredstring

The property name being documented.

  • maxLength: 256

Publisher documentation

レキシコンスキーマの補助ドキュメントです。レキシコンとそのプロパティのローカライズされた説明をサポートします。

main

多言語サポートを備えたレキシコンドキュメントを保存するための主要なレコードタイプです。

lexicon
ドキュメント化されるレキシコンのNSIDです。有効な名前空間識別子である必要があります。
description
レキシコン全体のローカライズされた説明です。各エントリは特定の言語での説明を提供します。
definitions
「main」、名前付き型、またはその他のスキーマコンポーネントなど、レキシコン内の特定の定義に関するドキュメントです。
createdAt
このドキュメントレコードが作成されたタイムスタンプです。ISO 8601の日時形式を使用します。

#localizedString

国際化サポートのための言語コードが関連付けられた文字列値です。

lang
値の言語を識別するISO 639言語コードです（例：'en'、'es'、'ja'）。
value
ローカライズされた文字列の内容です。最大長は10,000文字です。

#definitionDoc

レキシコンスキーマ内の特定の定義に関するドキュメントです。

name
ドキュメント化される定義の名前です（例：'main'、'replyRef'）。最大長は512文字です。
description
この定義の目的と使用法を説明するローカライズされた説明です。
properties
この定義内の個々のプロパティに関するドキュメントです。

#propertyDoc

定義内の特定のプロパティに関するドキュメントです。

name
ドキュメント化されるプロパティの名前です。最大長は256文字です。
description
このプロパティの目的、形式、および制約を説明するローカライズされた説明です。

Similar lexicons

semantic match

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

  • garden.lexicon.example

    record

    An example value for a lexicon schema

  • com.atproto.lexicon.schema

    record

    Representation of Lexicon schemas themselves, when published as atproto records. Note that the schema language is not defined in Lexicon; this meta schema currently only includes a single version field ('lexicon'). See the atproto specifications for description of the other expected top-level fields ('id', 'defs', etc).

  • org.cairnsproto.draft.schema

    record

    A payload schema. Its identity is the sha256 of "cairns/schema/v1", a zero byte, and the DAG-CBOR of defs, so anyone who publishes the same definition publishes the same schema.