This is a global notification. You can write markdown here! Link to official website

Enums, Constants & Unions

Enums

Example enumeration for the SetOfEnumTestTypes type.

Test data for properties with enums that are of differing primitive types

`intWithEnumExample` Int	An int with enum values Can be `1`, `2`, or `3`
`floatWithEnumExample` Float	A float with enum values Can be `1.0`, `2.0`, or `3.0`Default: `1.0`
`enumOfStringExample` String	A string with enum values (undescribed) Can be `"dog"`, `"cat"`, or `"elephant"`Default: `dog`

Enum with agreed upon description annotation.

enumValue1: description 1
enumValue2: description 2
enumWithoutDescription
enumWithMarkdownDescription: inline-code should be formatted as an inline code. ObjectTestType should link to the header of the definition of ObjectTestType on this website - api-docs-smoke-test. Links should link to the header for the definition of Links on docs-smoke-test microsite.

render an enum with one value as a constant.

Has properties that are constant-like, that is, enums with only one value.

`stringConstantLike` String	`"constantStringValue"` a string contant-like property
`intConstantLike` Int	`256` an integer contant-like property
`floatConstantLike` Float	`3.14` a float contant-like property

A pattern of inheritance that is to be represented like a union, i.e. this parent type would not be shown with a property list on its own.

`kind` String
`nonDiscriminatorProperty` String

This specific instance of the union is rendered like a regular type with a property table

`kind` String	`"subtype1"`
`nonDiscriminatorProperty` String
`foo` String
`name` String

This specific instance of the union is rendered like a regular type with a property table

This pattern has sub-types whose properties are enumerations with descriptions.

type

Enum with agreed upon description annotation.

The discriminatorValue (value1) of this union like sub stype is defined in EnumWithDescriptionExample

The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample

The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample but without a description.

`type` String	`"enumWithoutDescription"` Enum with agreed upon description annotation.
`baz` String
`name` String