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

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

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

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

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

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

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

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