garden.lexicon.example

lexicon.garden

Documentation

An example value for a lexicon schema. Use this record type to provide sample data that demonstrates how to use it.

main record
1 example

The primary record type for storing lexicon examples.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

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

description string Optional

An optional human-readable description explaining what this example demonstrates or any relevant context.

lexicon string nsid Required

The NSID of the lexicon that this example demonstrates. Must be a valid namespace identifier.

value unknown Required

The example data itself. This should be a valid instance of the target lexicon schema, demonstrating correct usage and structure.

View raw schema
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "lexicon",
      "value",
      "createdAt"
    ],
    "properties": {
      "value": {
        "type": "unknown",
        "description": "The example itself."
      },
      "lexicon": {
        "type": "string",
        "format": "nsid",
        "description": "The NSID that the example is of."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "The user-supplied date and time the example was created."
      },
      "description": {
        "type": "string",
        "description": "A description of the example."
      }
    }
  },
  "description": "An example value for a lexicon schema"
}

Lexicon Garden

@