{"typehub/typeapi":{"operations":[],"definitions":{"Argument":{"description":"Describes an argument passed to an operation.","type":"struct","properties":{"contentType":{"description":"The content type to use when the payload cannot be described by a TypeSchema.","type":"string"},"in":{"description":"Specifies where the argument value is located: path, query, header, or body. If set to path, the operation path must include a matching path variable.","type":"string"},"name":{"description":"Optional name of the parameter in the path, query, or header. If omitted, the key of the arguments map is used.","type":"string"},"schema":{"description":"TypeSchema describing the structure of the argument payload.","type":"reference","target":"typeschema:PropertyType"}}},"Operation":{"description":"Describes an API endpoint operation.","type":"struct","properties":{"arguments":{"description":"All arguments provided to this operation. Each argument maps to an HTTP request location (e.g., path, query, header, or body).","type":"map","schema":{"type":"reference","target":"Argument"}},"authorization":{"description":"Indicates whether this operation requires authorization. If set to false, the client will omit authorization headers. Defaults to true.","type":"boolean"},"description":{"description":"A short description of this operation. Used in generated code docstrings; plain text without line breaks is recommended.","type":"string"},"method":{"description":"The HTTP method associated with this operation (e.g., GET, POST, PUT, DELETE).","type":"string"},"path":{"description":"The HTTP path associated with this operation. May contain path variables (e.g., /my/path/:year) which map to operation arguments.","type":"string"},"return":{"description":"The return type of this operation, which defaults to an HTTP status code of 200.","type":"reference","target":"Response"},"security":{"description":"An array of OAuth scopes required to access this specific operation.","type":"array","schema":{"type":"string"}},"stability":{"description":"Indicates the stability level of this operation: 0 (Deprecated), 1 (Experimental), 2 (Stable), or 3 (Legacy). Defaults to 1 (Experimental).","type":"integer"},"throws":{"description":"All exceptional states that can occur if the operation fails. Each exception is assigned an HTTP error status code.","type":"array","schema":{"type":"reference","target":"Response"}}}},"Response":{"description":"Describes an HTTP response returned by an operation.","type":"struct","properties":{"code":{"description":"The HTTP status code associated with this response. Wildcard error status codes like 499, 599, or 999 can be used to catch all errors.","type":"integer"},"contentType":{"description":"The content type to use when the response body cannot be described by a TypeSchema.","type":"string"},"schema":{"description":"TypeSchema describing the structure of the response payload.","type":"reference","target":"typeschema:PropertyType"}}},"Security":{"description":"Describes the authentication mechanism used by the API.","type":"struct","base":true,"properties":{"type":{"description":"The global security type of the API. Must be one of: httpBasic, httpBearer, apiKey, or oauth2.","type":"string"}},"discriminator":"type","mapping":{"SecurityApiKey":"apiKey","SecurityHttpBasic":"httpBasic","SecurityHttpBearer":"httpBearer","SecurityOAuth":"oauth2"}},"SecurityApiKey":{"description":"Describes API key authentication passed via a header or query parameter.","type":"struct","parent":{"type":"reference","target":"Security"},"properties":{"in":{"description":"The location of the API key. Must be either \"header\" or \"query\".","type":"string"},"name":{"description":"The name of the header or query parameter (e.g., \"X-Api-Key\").","type":"string"}}},"SecurityHttpBasic":{"description":"Describes HTTP Basic authentication, requiring a base64-encoded username and password.","type":"struct","parent":{"type":"reference","target":"Security"}},"SecurityHttpBearer":{"description":"Describes HTTP Bearer authentication, typically using a bearer token (e.g., JWT).","type":"struct","parent":{"type":"reference","target":"Security"}},"SecurityOAuth":{"description":"Describes OAuth 2.0 authentication, defining endpoints and scopes required by the API.","type":"struct","parent":{"type":"reference","target":"Security"},"properties":{"authorizationUrl":{"description":"Optional OAuth2 authorization endpoint URL.","type":"string"},"scopes":{"description":"Optional OAuth2 scopes required by default.","type":"array","schema":{"type":"string"}},"tokenUrl":{"description":"The OAuth2 token endpoint URL.","type":"string"}}},"TypeAPI":{"description":"The root specification object of TypeAPI.","type":"struct","parent":{"type":"reference","target":"typeschema:TypeSchema"},"properties":{"baseUrl":{"description":"Optional base URL of the service. If specified, client SDKs do not require users to manually specify a base URL.","type":"string"},"operations":{"description":"A map of operations provided by the API. Keys should use dot-notation to group operations into logical units (e.g., product.getAll or enterprise.product.execute).","type":"map","schema":{"type":"reference","target":"Operation"}},"security":{"description":"Describes the default authorization mechanism used across the API.","type":"reference","target":"Security"}}},"typeschema: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":"typeschema:PropertyType"},"properties":{"type":{"type":"string","default":"any"}}},"typeschema:ArrayDefinitionType":{"description":"Represents an ordered list of elements where every item conforms to the same schema.","type":"struct","parent":{"type":"reference","target":"typeschema:CollectionDefinitionType"},"properties":{"type":{"type":"string","default":"array"}}},"typeschema:ArrayPropertyType":{"description":"Represents a property containing a list of items that share the same schema.","type":"struct","parent":{"type":"reference","target":"typeschema:CollectionPropertyType"},"properties":{"type":{"type":"string","default":"array"}}},"typeschema:BooleanPropertyType":{"description":"Represents a boolean true or false value.","type":"struct","parent":{"type":"reference","target":"typeschema:ScalarPropertyType"},"properties":{"default":{"description":"The default boolean value to use if the property is omitted.","type":"boolean"},"type":{"type":"string","default":"boolean"}}},"typeschema:CollectionDefinitionType":{"description":"The abstract base type for collection definitions that contain multiple elements of a uniform type.","type":"struct","parent":{"type":"reference","target":"typeschema:DefinitionType"},"base":true,"properties":{"schema":{"description":"The schema definition for the elements or values contained in this collection.","type":"reference","target":"typeschema:PropertyType"},"type":{"description":"The collection type identifier (e.g., 'map' or 'array').","type":"string"}},"discriminator":"type","mapping":{"typeschema:ArrayDefinitionType":"array","typeschema:MapDefinitionType":"map"}},"typeschema:CollectionPropertyType":{"description":"The abstract base type for properties that define inline collections (maps or arrays).","type":"struct","parent":{"type":"reference","target":"typeschema:PropertyType"},"base":true,"properties":{"schema":{"description":"The schema definition for the items contained within this collection property.","type":"reference","target":"typeschema:PropertyType"},"type":{"description":"The collection type identifier.","type":"string"}},"discriminator":"type","mapping":{"typeschema:ArrayPropertyType":"array","typeschema:MapPropertyType":"map"}},"typeschema: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":{"deprecated":{"description":"Indicates whether this type is deprecated and should not be used in new implementations.","type":"boolean"},"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"}},"discriminator":"type","mapping":{"typeschema:ArrayDefinitionType":"array","typeschema:MapDefinitionType":"map","typeschema:StructDefinitionType":"struct"}},"typeschema:GenericPropertyType":{"description":"Represents a generic placeholder type that is resolved at runtime or via template arguments.","type":"struct","parent":{"type":"reference","target":"typeschema:PropertyType"},"properties":{"name":{"description":"The generic parameter name (e.g., 'T'), which is bound via the template map in a reference.","type":"string"},"type":{"type":"string","default":"generic"}}},"typeschema:IntegerPropertyType":{"description":"Represents a whole number without fractional components.","type":"struct","parent":{"type":"reference","target":"typeschema:ScalarPropertyType"},"properties":{"default":{"description":"The default integer value to use if the property is omitted.","type":"integer"},"type":{"type":"string","default":"integer"}}},"typeschema: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":"typeschema:CollectionDefinitionType"},"properties":{"type":{"type":"string","default":"map"}}},"typeschema:MapPropertyType":{"description":"Represents a property containing a key-value map where all values share the same schema.","type":"struct","parent":{"type":"reference","target":"typeschema:CollectionPropertyType"},"properties":{"type":{"type":"string","default":"map"}}},"typeschema:NumberPropertyType":{"description":"Represents a numeric value, including floating-point and decimal numbers.","type":"struct","parent":{"type":"reference","target":"typeschema:ScalarPropertyType"},"properties":{"default":{"description":"The default number value to use if the property is omitted.","type":"number"},"type":{"type":"string","default":"number"}}},"typeschema:PropertyType":{"description":"The abstract base type for all property definitions within a struct or collection.","type":"struct","base":true,"properties":{"deprecated":{"description":"Indicates whether this property is deprecated and should no longer be used.","type":"boolean"},"description":{"description":"Documentation explaining the purpose and usage of this property.","type":"string"},"nullable":{"description":"Indicates whether this property accepts a null value.","type":"boolean"},"type":{"description":"The discriminator value used to identify the specific property type.","type":"string"}},"discriminator":"type","mapping":{"typeschema:AnyPropertyType":"any","typeschema:ArrayPropertyType":"array","typeschema:BooleanPropertyType":"boolean","typeschema:GenericPropertyType":"generic","typeschema:IntegerPropertyType":"integer","typeschema:MapPropertyType":"map","typeschema:NumberPropertyType":"number","typeschema:ReferencePropertyType":"reference","typeschema:StringPropertyType":"string"}},"typeschema:ReferencePropertyType":{"description":"Represents a reference to a type defined in the global definitions dictionary.","type":"struct","parent":{"type":"reference","target":"typeschema:PropertyType"},"properties":{"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"}},"type":{"type":"string","default":"reference"}}},"typeschema:ScalarPropertyType":{"description":"The abstract base type for simple scalar value properties (strings, integers, numbers, booleans).","type":"struct","parent":{"type":"reference","target":"typeschema:PropertyType"},"base":true,"properties":{"type":{"description":"The specific scalar type name.","type":"string"}},"discriminator":"type","mapping":{"typeschema:BooleanPropertyType":"boolean","typeschema:IntegerPropertyType":"integer","typeschema:NumberPropertyType":"number","typeschema:StringPropertyType":"string"}},"typeschema:StringPropertyType":{"description":"Represents a sequence of characters, with optional formatting rules.","type":"struct","parent":{"type":"reference","target":"typeschema:ScalarPropertyType"},"properties":{"default":{"description":"The default string value to use if the property is omitted.","type":"string"},"format":{"description":"Specifies a semantic format or hint for the string value (e.g., 'date-time', 'email', 'uri').","type":"string"},"type":{"type":"string","default":"string"}}},"typeschema: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":"typeschema:DefinitionType"},"properties":{"base":{"description":"When set to true, marks this struct as an abstract base type that cannot be instantiated directly.","type":"boolean"},"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"}},"parent":{"description":"A reference to another struct definition from which this struct inherits properties.","type":"reference","target":"typeschema:ReferencePropertyType"},"properties":{"description":"A map of property names to their respective schema definitions.","type":"map","schema":{"type":"reference","target":"typeschema:PropertyType"}},"type":{"type":"string","default":"struct"}}},"typeschema:TypeSchema":{"description":"The root document object containing namespace imports, type definitions, and the root entry point.","type":"struct","properties":{"definitions":{"description":"A dictionary mapping definition names to their respective schema definitions.","type":"map","schema":{"type":"reference","target":"typeschema:DefinitionType"}},"import":{"description":"Maps namespace aliases to external TypeSchema document locations.","type":"map","schema":{"type":"string"}},"root":{"description":"The name of the primary entry-point definition for this schema.","type":"string"}}}}}}