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

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

main

The primary record type for storing lexicon documentation with multilingual support.

lexicon
The NSID of the lexicon being documented. Must be a valid namespace identifier.
description
Localized descriptions for the lexicon as a whole. Each entry provides a description in a specific language.
definitions
Documentation for specific definitions within the lexicon, such as 'main', named types, or other schema components.
createdAt
The timestamp when this documentation record was created. Uses ISO 8601 datetime format.

#localizedString

A string value with an associated language code for internationalization support.

lang
ISO 639 language code identifying the language of the value (e.g., 'en', 'es', 'ja').
value
The localized string content. Maximum length is 10,000 characters.

#definitionDoc

Documentation for a specific definition within a lexicon schema.

name
The name of the definition being documented (e.g., 'main', 'replyRef'). Maximum length is 512 characters.
description
Localized descriptions explaining the purpose and usage of this definition.
properties
Documentation for individual properties within this definition.

#propertyDoc

Documentation for a specific property within a definition.

name
The name of the property being documented. Maximum length is 256 characters.
description
Localized descriptions explaining the purpose, format, and constraints of this property.

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.