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

Documentação auxiliar para um esquema de lexicon, suportando descrições localizadas para o lexicon e suas propriedades.

main

O tipo de registro principal para armazenar documentação de lexicon com suporte multilíngue.

lexicon
O NSID do lexicon sendo documentado. Deve ser um identificador de namespace válido.
description
Descrições localizadas para o lexicon como um todo. Cada entrada fornece uma descrição em um idioma específico.
definitions
Documentação para definições específicas dentro do lexicon, como 'main', tipos nomeados ou outros componentes do esquema.
createdAt
O carimbo de data/hora de quando este registro de documentação foi criado. Usa o formato de data e hora ISO 8601.

#localizedString

Um valor de string com um código de idioma associado para suporte à internacionalização.

lang
Código de idioma ISO 639 que identifica o idioma do valor (por exemplo, 'en', 'es', 'ja').
value
O conteúdo da string localizada. O comprimento máximo é de 10.000 caracteres.

#definitionDoc

Documentação para uma definição específica dentro de um esquema de lexicon.

name
O nome da definição sendo documentada (por exemplo, 'main', 'replyRef'). O comprimento máximo é de 512 caracteres.
description
Descrições localizadas explicando o propósito e o uso desta definição.
properties
Documentação para propriedades individuais dentro desta definição.

#propertyDoc

Documentação para uma propriedade específica dentro de uma definição.

name
O nome da propriedade sendo documentada. O comprimento máximo é de 256 caracteres.
description
Descrições localizadas explicando o propósito, formato e restrições desta propriedade.

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.