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

This is the first entry in the EnumTest enumeration.

EnumEntryTwo

This is the second entry in the EnumTest enumeration.

EnumEntryThree

This is the third entry in the EnumTest enumeration.

enum

This is an item called with a reserved word.

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.0Default: 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

enumValue3

description 3

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.

EnumWithGroupsExample

Enum with agreed upon description annotation.

Group 1

enumValue2

description 2

enumValue7

description 7

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.

Group 2

enumValue10

description 10

enumValue3

description 3

enumValue5

description 5

enumValue6

description 6

enumValue9

description 9

enumWithoutDescription

Group 3

enumValue1

description 1

enumValue4

description 4

enumValue8

description 8

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.

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