garden.lexicon.documentation
Auxiliary documentation for a lexicon schema, supporting localized descriptions for the lexicon and its properties.
Details · record, key nsid
| Kind | record |
|---|---|
| Record key | nsid |
| Authority | lexicon.garden |
| Indexed |
Record
record · key nsidProperties
Timestamp when this documentation was created.
definitions
arrayDocumentation for specific definitions within the lexicon (e.g., main, replyRef).
description
arrayLocalized descriptions for the lexicon.
The NSID of the lexicon being documented.
#definitionDoc
objectDocumentation for a definition within a lexicon.
Properties
description
arrayLocalized descriptions for this definition.
The name of the definition being documented (e.g., 'main', 'replyRef').
maxLength: 512
properties
arrayDocumentation for properties within this definition.
#localizedString
objectA string with an associated language code.
#propertyDoc
objectDocumentation for a specific property within a definition.
Properties
description
arrayLocalized descriptions for this property.
The property name being documented.
maxLength: 256
Publisher documentation
Documentation auxiliaire pour un schéma de lexicon, prenant en charge les descriptions localisées pour le lexicon et ses propriétés.
main
Le type d'enregistrement principal pour stocker la documentation de lexicon avec prise en charge multilingue.
lexicon- Le NSID du lexicon documenté. Doit être un identifiant d'espace de noms valide.
description- Descriptions localisées pour le lexicon dans son ensemble. Chaque entrée fournit une description dans une langue spécifique.
definitions- Documentation pour des définitions spécifiques au sein du lexicon, telles que 'main', les types nommés ou d'autres composants du schéma.
createdAt- L'horodatage de création de cet enregistrement de documentation. Utilise le format de date et heure ISO 8601.
#localizedString
Une valeur de chaîne avec un code de langue associé pour la prise en charge de l'internationalisation.
lang- Code de langue ISO 639 identifiant la langue de la valeur (par exemple, 'en', 'es', 'ja').
value- Le contenu de la chaîne localisée. La longueur maximale est de 10 000 caractères.
#definitionDoc
Documentation pour une définition spécifique au sein d'un schéma de lexicon.
name- Le nom de la définition documentée (par exemple, 'main', 'replyRef'). La longueur maximale est de 512 caractères.
description- Descriptions localisées expliquant l'objectif et l'utilisation de cette définition.
properties- Documentation pour les propriétés individuelles au sein de cette définition.
#propertyDoc
Documentation pour une propriété spécifique au sein d'une définition.
name- Le nom de la propriété documentée. La longueur maximale est de 256 caractères.
description- Descriptions localisées expliquant l'objectif, le format et les contraintes de cette propriété.
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
garden.lexicon.example
recordAn example value for a lexicon schema
-
com.atproto.lexicon.schema
recordRepresentation 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
recordA 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.