![]() As a result, field names must be unique independent of case format (e.g. Code generators will respect casing for wire format, but may convert case formats to conform with language restrictions. A map from field names to type names.įield names must appear in either lowerCamelCase, or kebab-case, or snake_case. Overrides the default-package in NamedTypesDefinition.ĭefinition for an object complex data type. REQUIRED if default-package is not specified. CommonMark syntax MAY be used for rich text representation. Only conjure primitives, and wrappers around conjure primitives may declare safety, the safety of complex types is computed based on the type graph.ĭocumentation for the type. Allowed values are safe, unsafe, and do-not-log. The safety of the type in regards to logging in accordance with the SLS specification. ContainerTypeĬontainer types like optional, list, set and map can be referenced using their lowercase names, where variables like T, K and V can be substituted for a Conjure named type, a built-in or more container types:ĭefinition for an alias complex data type. Named types must be in PascalCase and be unique within a package. ConjureTypeĪ ConjureType is either a reference to an existing TypeName, a ContainerType or a BuiltIn. Package names should follow the Java style naming convention:. Package names are used by generator implementations to determine the output location and language-specific namespacing. MapĪ map between type names and type definitions.Ī map between type names and error definitions. The object specifies the types that are defined in the Conjure definition. ![]() References to types that are not defined within Conjure. Type aliases MUST be in PascalCase.įor example, one file called common.yml might define a Conjure type called ProductId: Namespace aliases MUST match ^*$Ī map between a type alias and its external definition. FieldĪ map between a namespace and a relative path to a Conjure definition file. ![]() The object specifies the types available in the Conjure definition. The types to be included in the definition.Ī map between a service name and its definition. ConjureSourceFileĮach source file must be a YAML object with the following allowed fields: Field In the following description, if a field is not explicitly REQUIRED or described with a MUST or SHALL, it can be considered OPTIONAL. Note: All field names in the specification are case sensitive. The Conjure compiler requires each file to conform to the ConjureSourceFile structure, specified below: ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |