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

Enums, Constants & Unions

Enums

EnumTest

Example enumeration for the SetOfEnumTestTypes type.

EnumEntryOne
EnumEntryTwo
EnumEntryThree

EnumPropertiesType

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`

EnumWithDescriptionExample

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.

EnumGroupsTest

EnumGroup1

Example enumeration for the SetOfEnumTestTypes type.

enumValue1: description of enumValue1
enumValue2: description of enumValue2. inline-code should be formatted as an inline code.
enumValue3: description of enumValue3
enumValue4: description of enumValue4
enumValue5: description of enumValue5
enumValue6: description of enumValue6
enumValue7: description of enumValue7

EnumGroup2

Example enumeration for the SetOfEnumTestTypes type.

enumValue8: description of enumValue8
enumValue9: description of enumValue9. inline-code should be formatted as an inline code.
enumValue10: description of enumValue10
enumValue11: description of enumValue11
enumValue12: description of enumValue12
enumValue13: description of enumValue13
enumValue14: description of enumValue14

Constants

ConstantLikeType

render an enum with one value as a constant.

constantExampleValue

ConstantLikeProperties

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

Unions

UnionLikeType

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

UnionLikeSubType1

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

UnionLikeSubType2 with Hidden Inherited Properties

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

`kind` String	`"subtype2"`
`bar` String
`name` String

UnionLikeWithEnumDescriptionPropertiesInSubtype

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

type

EnumWithDescriptionExample

Enum with agreed upon description annotation.

UnionLikeSubTypeWithEnumDescriptionProperties1

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

`type` String	`"enumValue1"` description 1
`foo` String
`name` String

UnionLikeSubTypeWithEnumDescriptionProperties2

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

`type` String	`"enumValue2"` description 2
`bar` String
`name` String

UnionLikeSubTypeWithEnumDescriptionProperties3

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