typeschema.json

{
  "definitions": {
    "DefinitionType": {
      "description": "The abstract base type for all schema definitions. It provides common metadata such as descriptions and deprecation status.",
      "type": "struct",
      "base": true,
      "properties": {
        "description": {
          "description": "A brief explanation of the purpose and usage of this definition.",
          "type": "string"
        },
        "type": {
          "description": "The discriminator value used to identify the specific definition type.",
          "type": "string"
        },
        "deprecated": {
          "description": "Indicates whether this type is deprecated and should not be used in new implementations.",
          "type": "boolean"
        }
      },
      "discriminator": "type",
      "mapping": {
        "StructDefinitionType": "struct",
        "MapDefinitionType": "map",
        "ArrayDefinitionType": "array"
      }
    },
    "StructDefinitionType": {
      "description": "Represents an object with a fixed set of properties (such as a class or record). Supports inheritance and explicit property typing.",
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "DefinitionType"
      },
      "properties": {
        "type": {
          "type": "string",
          "default": "struct"
        },
        "parent": {
          "description": "A reference to another struct definition from which this struct inherits properties.",
          "type": "reference",
          "target": "ReferencePropertyType"
        },
        "base": {
          "description": "When set to true, marks this struct as an abstract base type that cannot be instantiated directly.",
          "type": "boolean"
        },
        "properties": {
          "description": "A map of property names to their respective schema definitions.",
          "type": "map",
          "schema": {
            "type": "reference",
            "target": "PropertyType"
          }
        },
        "discriminator": {
          "description": "The property name used to determine the concrete subclass during deserialization.",
          "type": "string"
        },
        "mapping": {
          "description": "Maps discriminator field values to their corresponding definition names to support polymorphism.",
          "type": "map",
          "schema": {
            "type": "string"
          }
        }
      }
    },
    "CollectionDefinitionType": {
      "description": "The abstract base type for collection definitions that contain multiple elements of a uniform type.",
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "DefinitionType"
      },
      "base": true,
      "properties": {
        "type": {
          "description": "The collection type identifier (e.g., 'map' or 'array').",
          "type": "string"
        },
        "schema": {
          "description": "The schema definition for the elements or values contained in this collection.",
          "type": "reference",
          "target": "PropertyType"
        }
      },
      "discriminator": "type",
      "mapping": {
        "MapDefinitionType": "map",
        "ArrayDefinitionType": "array"
      }
    },
    "MapDefinitionType": {
      "description": "Represents a key-value map with dynamic key names where all values conform to the same schema.",
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "CollectionDefinitionType"
      },
      "properties": {
        "type": {
          "type": "string",
          "default": "map"
        }
      }
    },
    "ArrayDefinitionType": {
      "description": "Represents an ordered list of elements where every item conforms to the same schema.",
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "CollectionDefinitionType"
      },
      "properties": {
        "type": {
          "type": "string",
          "default": "array"
        }
      }
    },
    "PropertyType": {
      "description": "The abstract base type for all property definitions within a struct or collection.",
      "type": "struct",
      "base": true,
      "properties": {
        "description": {
          "description": "Documentation explaining the purpose and usage of this property.",
          "type": "string"
        },
        "type": {
          "description": "The discriminator value used to identify the specific property type.",
          "type": "string"
        },
        "deprecated": {
          "description": "Indicates whether this property is deprecated and should no longer be used.",
          "type": "boolean"
        },
        "nullable": {
          "description": "Indicates whether this property accepts a null value.",
          "type": "boolean"
        }
      },
      "discriminator": "type",
      "mapping": {
        "StringPropertyType": "string",
        "IntegerPropertyType": "integer",
        "NumberPropertyType": "number",
        "BooleanPropertyType": "boolean",
        "MapPropertyType": "map",
        "ArrayPropertyType": "array",
        "AnyPropertyType": "any",
        "GenericPropertyType": "generic",
        "ReferencePropertyType": "reference"
      }
    },
    "ScalarPropertyType": {
      "description": "The abstract base type for simple scalar value properties (strings, integers, numbers, booleans).",
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "PropertyType"
      },
      "base": true,
      "properties": {
        "type": {
          "description": "The specific scalar type name.",
          "type": "string"
        }
      },
      "discriminator": "type",
      "mapping": {
        "StringPropertyType": "string",
        "IntegerPropertyType": "integer",
        "NumberPropertyType": "number",
        "BooleanPropertyType": "boolean"
      }
    },
    "StringPropertyType": {
      "description": "Represents a sequence of characters, with optional formatting rules.",
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "ScalarPropertyType"
      },
      "properties": {
        "type": {
          "type": "string",
          "default": "string"
        },
        "format": {
          "description": "Specifies a semantic format or hint for the string value (e.g., 'date-time', 'email', 'uri').",
          "type": "string"
        },
        "default": {
          "description": "The default string value to use if the property is omitted.",
          "type": "string"
        }
      }
    },
    "IntegerPropertyType": {
      "description": "Represents a whole number without fractional components.",
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "ScalarPropertyType"
      },
      "properties": {
        "type": {
          "type": "string",
          "default": "integer"
        }
      }
    },
    "NumberPropertyType": {
      "description": "Represents a numeric value, including floating-point and decimal numbers.",
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "ScalarPropertyType"
      },
      "properties": {
        "type": {
          "type": "string",
          "default": "number"
        }
      }
    },
    "BooleanPropertyType": {
      "description": "Represents a boolean true or false value.",
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "ScalarPropertyType"
      },
      "properties": {
        "type": {
          "type": "string",
          "default": "boolean"
        }
      }
    },
    "CollectionPropertyType": {
      "description": "The abstract base type for properties that define inline collections (maps or arrays).",
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "PropertyType"
      },
      "base": true,
      "properties": {
        "type": {
          "description": "The collection type identifier.",
          "type": "string"
        },
        "schema": {
          "description": "The schema definition for the items contained within this collection property.",
          "type": "reference",
          "target": "PropertyType"
        }
      },
      "discriminator": "type",
      "mapping": {
        "MapPropertyType": "map",
        "ArrayPropertyType": "array"
      }
    },
    "MapPropertyType": {
      "description": "Represents a property containing a key-value map where all values share the same schema.",
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "CollectionPropertyType"
      },
      "properties": {
        "type": {
          "type": "string",
          "default": "map"
        }
      }
    },
    "ArrayPropertyType": {
      "description": "Represents a property containing a list of items that share the same schema.",
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "CollectionPropertyType"
      },
      "properties": {
        "type": {
          "type": "string",
          "default": "array"
        }
      }
    },
    "AnyPropertyType": {
      "description": "Represents a wildcard property that accepts any valid JSON value (object, array, string, number, boolean, or null).",
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "PropertyType"
      },
      "properties": {
        "type": {
          "type": "string",
          "default": "any"
        }
      }
    },
    "GenericPropertyType": {
      "description": "Represents a generic placeholder type that is resolved at runtime or via template arguments.",
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "PropertyType"
      },
      "properties": {
        "type": {
          "type": "string",
          "default": "generic"
        },
        "name": {
          "description": "The generic parameter name (e.g., 'T'), which is bound via the template map in a reference.",
          "type": "string"
        }
      }
    },
    "ReferencePropertyType": {
      "description": "Represents a reference to a type defined in the global definitions dictionary.",
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "PropertyType"
      },
      "properties": {
        "type": {
          "type": "string",
          "default": "reference"
        },
        "target": {
          "description": "The key of the target definition in the definitions map.",
          "type": "string"
        },
        "template": {
          "description": "Binds generic parameter names in the target definition to concrete definition names.",
          "type": "map",
          "schema": {
            "type": "string"
          }
        }
      }
    },
    "TypeSchema": {
      "description": "The root document object containing namespace imports, type definitions, and the root entry point.",
      "type": "struct",
      "properties": {
        "import": {
          "description": "Maps namespace aliases to external TypeSchema document locations.",
          "type": "map",
          "schema": {
            "type": "string"
          }
        },
        "definitions": {
          "description": "A dictionary mapping definition names to their respective schema definitions.",
          "type": "map",
          "schema": {
            "type": "reference",
            "target": "DefinitionType"
          }
        },
        "root": {
          "description": "The name of the primary entry-point definition for this schema.",
          "type": "string"
        }
      }
    }
  },
  "root": "TypeSchema"
}