garden.lexicon.documentation Documentation (EN)

main record

1 example

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

Record Key nsid

Properties

createdAt string datetime Required

The timestamp when this documentation record was created. Uses ISO 8601 datetime format.

definitions array of ref #definitionDoc Optional

Documentation for specific definitions within the lexicon, such as 'main', named types, or other schema components.

description array of ref #localizedString Optional

Localized descriptions for the lexicon as a whole. Each entry provides a description in a specific language.

lexicon string nsid Required

The NSID of the lexicon being documented. Must be a valid namespace identifier.

View raw schema

{
  "description": "Auxiliary documentation for a lexicon schema, supporting localized descriptions for the lexicon and its properties.",
  "key": "nsid",
  "record": {
    "properties": {
      "createdAt": {
        "description": "Timestamp when this documentation was created.",
        "format": "datetime",
        "type": "string"
      },
      "definitions": {
        "description": "Documentation for specific definitions within the lexicon (e.g., main, replyRef).",
        "items": {
          "ref": "#definitionDoc",
          "type": "ref"
        },
        "type": "array"
      },
      "description": {
        "description": "Localized descriptions for the lexicon.",
        "items": {
          "ref": "#localizedString",
          "type": "ref"
        },
        "type": "array"
      },
      "lexicon": {
        "description": "The NSID of the lexicon being documented.",
        "format": "nsid",
        "type": "string"
      }
    },
    "required": [
      "lexicon",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

definitionDoc object

Documentation for a specific definition within a lexicon schema.

Properties

description array of ref#localizedString Optional

Localized descriptions explaining the purpose and usage of this definition.

name string Required

The name of the definition being documented (e.g., 'main', 'replyRef'). Maximum length is 512 characters.

maxLength: 512 bytes

properties array of ref#propertyDoc Optional

Documentation for individual properties within this definition.

View raw schema

{
  "description": "Documentation for a definition within a lexicon.",
  "properties": {
    "description": {
      "description": "Localized descriptions for this definition.",
      "items": {
        "ref": "#localizedString",
        "type": "ref"
      },
      "type": "array"
    },
    "name": {
      "description": "The name of the definition being documented (e.g., 'main', 'replyRef').",
      "maxLength": 512,
      "type": "string"
    },
    "properties": {
      "description": "Documentation for properties within this definition.",
      "items": {
        "ref": "#propertyDoc",
        "type": "ref"
      },
      "type": "array"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

localizedString object

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

Properties

lang string language Required

ISO 639 language code identifying the language of the value (e.g., 'en', 'es', 'ja').

value string Required

The localized string content. Maximum length is 10,000 characters.

maxLength: 10000 bytes

View raw schema

{
  "description": "A string with an associated language code.",
  "properties": {
    "lang": {
      "description": "ISO 639 language code (e.g., 'en', 'es', 'ja').",
      "format": "language",
      "type": "string"
    },
    "value": {
      "description": "The localized string value.",
      "maxLength": 10000,
      "type": "string"
    }
  },
  "required": [
    "lang",
    "value"
  ],
  "type": "object"
}

propertyDoc object

Documentation for a specific property within a definition.

Properties

description array of ref#localizedString Optional

Localized descriptions explaining the purpose, format, and constraints of this property.

name string Required

The name of the property being documented. Maximum length is 256 characters.

maxLength: 256 bytes

View raw schema

{
  "description": "Documentation for a specific property within a definition.",
  "properties": {
    "description": {
      "description": "Localized descriptions for this property.",
      "items": {
        "ref": "#localizedString",
        "type": "ref"
      },
      "type": "array"
    },
    "name": {
      "description": "The property name being documented.",
      "maxLength": 256,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}