Skip to content

Commit

Permalink
Property "StructDefinitionType.parent" (reference) description has ch…
Browse files Browse the repository at this point in the history
…anged from "" to "Defines a parent type for this structure. Some programming languages like Go do not support the concept of an extends, in this case the code generator simply copies all properties into this structure."

Property "StructDefinitionType.properties" (map) description has changed from "" to "Contains a map of available properties for this struct."
Property "StructDefinitionType.mapping" (map) description has changed from "" to "In case a discriminator is configured it is required to configure a mapping. The mapping is a map where the key is the type name and the value the actual discriminator type value."
Property "MapDefinitionType.type" was removed
Property "ArrayDefinitionType.type" was removed
Property "StringPropertyType.type" was removed
Property "IntegerPropertyType.type" was removed
Property "NumberPropertyType.type" was removed
Property "BooleanPropertyType.type" was removed
Property "MapPropertyType.type" was removed
Property "ArrayPropertyType.type" was removed
Property "AnyPropertyType.type" was removed
Property "GenericPropertyType.type" was removed
Property "ReferencePropertyType.type" was removed
Property "ReferencePropertyType.template" (map) description has changed from "" to "A map where the key is the name of the generic and the value must point to a key under the definitions keyword. This can be used in case the target points to a type which contains generics, then it is possible to replace those generics with a concrete type."
  • Loading branch information
SDKgen-Bot committed Nov 17, 2024
1 parent 52a98d1 commit fa764ce
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions sdkgen.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"typehub/typeschema":{"operations":[],"definitions":{"AnyPropertyType":{"description":"Represents an any value which allows any kind of value","type":"struct","parent":{"type":"reference","target":"PropertyType"}},"ArrayDefinitionType":{"description":"Represents an array which contains a dynamic list of values of the same type","type":"struct","parent":{"type":"reference","target":"CollectionDefinitionType"}},"ArrayPropertyType":{"description":"Represents an array which contains a dynamic list of values of the same type","type":"struct","parent":{"type":"reference","target":"CollectionPropertyType"}},"BooleanPropertyType":{"description":"Represents a boolean value","type":"struct","parent":{"type":"reference","target":"ScalarPropertyType"}},"CollectionDefinitionType":{"description":"Base collection type","type":"struct","parent":{"type":"reference","target":"DefinitionType"},"base":true,"properties":{"schema":{"description":"","type":"reference","target":"PropertyType"},"type":{"description":"","type":"string"}},"discriminator":"type","mapping":{"ArrayDefinitionType":"array","MapDefinitionType":"map"}},"CollectionPropertyType":{"description":"Base collection property type","type":"struct","parent":{"type":"reference","target":"PropertyType"},"base":true,"properties":{"schema":{"description":"","type":"reference","target":"PropertyType"},"type":{"description":"","type":"string"}},"discriminator":"type","mapping":{"ArrayPropertyType":"array","MapPropertyType":"map"}},"DefinitionType":{"description":"Base definition type","type":"struct","base":true,"properties":{"deprecated":{"description":"","type":"boolean"},"description":{"description":"","type":"string"},"type":{"description":"","type":"string"}},"discriminator":"type","mapping":{"ArrayDefinitionType":"array","MapDefinitionType":"map","StructDefinitionType":"struct"}},"GenericPropertyType":{"description":"Represents a generic value which can be replaced with a dynamic type","type":"struct","parent":{"type":"reference","target":"PropertyType"},"properties":{"name":{"description":"The name of the generic, it is recommended to use common generic names like T or TValue. These generics can then be replaced on usage with a concrete type through the template property at a reference.","type":"string"}}},"IntegerPropertyType":{"description":"Represents an integer value","type":"struct","parent":{"type":"reference","target":"ScalarPropertyType"}},"MapDefinitionType":{"description":"Represents a map which contains a dynamic set of key value entries of the same type","type":"struct","parent":{"type":"reference","target":"CollectionDefinitionType"}},"MapPropertyType":{"description":"Represents a map which contains a dynamic set of key value entries of the same type","type":"struct","parent":{"type":"reference","target":"CollectionPropertyType"}},"NumberPropertyType":{"description":"Represents a float value","type":"struct","parent":{"type":"reference","target":"ScalarPropertyType"}},"PropertyType":{"description":"Base property type","type":"struct","base":true,"properties":{"deprecated":{"description":"","type":"boolean"},"description":{"description":"","type":"string"},"nullable":{"description":"","type":"boolean"},"type":{"description":"","type":"string"}},"discriminator":"type","mapping":{"AnyPropertyType":"any","ArrayPropertyType":"array","BooleanPropertyType":"boolean","GenericPropertyType":"generic","IntegerPropertyType":"integer","MapPropertyType":"map","NumberPropertyType":"number","ReferencePropertyType":"reference","StringPropertyType":"string"}},"ReferencePropertyType":{"description":"Represents a reference to a definition type","type":"struct","parent":{"type":"reference","target":"PropertyType"},"properties":{"target":{"description":"The target type, this must be a key which is available under the definitions keyword.","type":"string"},"template":{"description":"A map where the key is the name of the generic and the value must point to a key under the definitions keyword. This can be used in case the target points to a type which contains generics, then it is possible to replace those generics with a concrete type.","type":"map","schema":{"type":"string"}}}},"ScalarPropertyType":{"description":"Base scalar property type","type":"struct","parent":{"type":"reference","target":"PropertyType"},"base":true,"properties":{"type":{"description":"","type":"string"}},"discriminator":"type","mapping":{"BooleanPropertyType":"boolean","IntegerPropertyType":"integer","NumberPropertyType":"number","StringPropertyType":"string"}},"StringPropertyType":{"description":"Represents a string value","type":"struct","parent":{"type":"reference","target":"ScalarPropertyType"},"properties":{"format":{"description":"Optional describes the format of the string. Supported are the following types: date, date-time and time. A code generator may use a fitting data type to represent such a format, if not supported it should fall back to a string.","type":"string"}}},"StructDefinitionType":{"description":"A struct represents a class/structure with a fix set of defined properties.","type":"struct","parent":{"type":"reference","target":"DefinitionType"},"properties":{"base":{"description":"Indicates whether this is a base structure, default is false. If true the structure is used a base type, this means it is not possible to create an instance from this structure.","type":"boolean"},"discriminator":{"description":"Optional the property name of a discriminator property. This should be only used in case this is also a base structure.","type":"string"},"mapping":{"description":"In case a discriminator is configured it is required to configure a mapping. The mapping is a map where the key is the type name and the value the actual discriminator type value.","type":"map","schema":{"type":"string"}},"parent":{"description":"Defines a parent type for this structure. Some programming languages like Go do not support the concept of an extends, in this case the code generator simply copies all properties into this structure.","type":"reference","target":"ReferencePropertyType"},"properties":{"description":"Contains a map of available properties for this struct.","type":"map","schema":{"type":"reference","target":"PropertyType"}}}},"TypeSchema":{"description":"TypeSchema specification","type":"struct","properties":{"definitions":{"description":"","type":"map","schema":{"type":"reference","target":"DefinitionType"}},"import":{"description":"Through the import keyword it is possible to import other TypeSchema documents. It contains a map where the key is the namespace and the value points to a remote document. The value is a URL and a code generator should support at least the following schemes: file, http, https.","type":"map","schema":{"type":"string"}},"root":{"description":"Specifies the root type of your specification.","type":"string"}}}}}}

0 comments on commit fa764ce

Please sign in to comment.