garden.lexicon.documentation

{
  "id": "garden.lexicon.documentation",
  "defs": {
    "main": {
      "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."
    },
    "propertyDoc": {
      "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."
    },
    "definitionDoc": {
      "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": {
      "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."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}