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.
EnumEntryOneEnumEntryTwoEnumEntryThree
EnumPropertiesType
Test data for properties with enums that are of differing primitive types
intWithEnumExampleInt | An int with enum values Can be1, 2, or 3 |
floatWithEnumExampleFloat | A float with enum values Can be1.0, 2.0, or 3.0Default: 1.0 |
enumOfStringExampleString | A string with enum values (undescribed) Can be"dog", "cat", or "elephant"Default: dog |
EnumWithDescriptionExample
Enum with agreed upon description annotation.
enumValue1description 1
enumValue2description 2
enumValue3description 3
enumWithoutDescriptionenumWithMarkdownDescriptioninline-codeshould be formatted as an inline code. ObjectTestType should link to the header of the definition ofObjectTestTypeon this website -api-docs-smoke-test. Links should link to the header for the definition ofLinksondocs-smoke-testmicrosite.
EnumWithGroupsExample
Enum with agreed upon description annotation.
enumValue2description 2
enumValue7description 7
enumWithMarkdownDescriptioninline-codeshould be formatted as an inline code. ObjectTestType should link to the header of the definition ofObjectTestTypeon this website -api-docs-smoke-test. Links should link to the header for the definition ofLinksondocs-smoke-testmicrosite.enumValue10description 10
enumValue3description 3
enumValue5description 5
enumValue6description 6
enumValue9description 9
enumWithoutDescriptionenumValue1description 1
enumValue4description 4
enumValue8description 8
Group 1
Group 2
Group 3
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.
stringConstantLikeString | "constantStringValue"a string contant-like property |
intConstantLikeInt | 256an integer contant-like property |
floatConstantLikeFloat | 3.14a 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.
kindString | |
nonDiscriminatorPropertyString |
UnionLikeSubType1
This specific instance of the union is rendered like a regular type with a property table
kindString | "subtype1" |
nonDiscriminatorPropertyString | |
fooString | |
nameString |
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
typeString | "enumValue1"description 1 |
fooString | |
nameString |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
typeString | "enumValue2"description 2 |
barString | |
nameString |
UnionLikeSubTypeWithEnumDescriptionProperties3
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample but without a description.
typeString | "enumWithoutDescription"Enum with agreed upon description annotation. |
bazString | |
nameString |