This is a global notification. You can write markdown here! Link to official website
Long Page with Many Types
This is a replication of a very long page that contains many types. This page exists for testing optimizations.
Representations
List of Types
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
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 |
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
"enumValue1" description 1 | |
foo String | |
name String |
UnionLikeSubTypeWithEnumDescriptionProperties2
The discriminatorValue (value2) of this union like sub stype is defined in EnumWithDescriptionExample
"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.
"enumWithoutDescription" Enum with agreed upon description annotation. | |
baz String | |
name String |
AnyTestType
Tests acceptance of JSON blobs. Test Endpoint URN Test Overridden Endpoint URN
anyTypeExample Any | A test of type "any", i.e. any JSON allowed here. To be displayed as "any JSON". |
ObjectTestTypeDraft
A type to create an ObjectTestType. Used for testing the endpoint layout.
objectTypeProperty |
{"objectTypeProperty": {"arrayOfIntExample": [1, 2, 1, 3, 2, 3, 1],"arrayOfUniqueIntExample": [1, 3, 5, 7],"arrayOfTwonumbersExample": [3, 5],"arrayOfFloatExample": [0.82],"arrayOfNumberNoDefaultsExample": [10, 9, 8, 7, 6],"arrayOfStringExample": ["dog", "cat", "bird"],"arrayOfObjectType": [{"integerExample": 777,"integerExampleInt32": 1},{"integerExample": 30000,"integerExampleInt32": 22}]}}
ObjectTestType
A typical Object type with a non-scalar property.
version Int | |
objectTypeProperty |
{"version": 1,"objectTypeProperty": {"arrayOfIntExample": [2, 4, 2, 6, 4, 6, 2],"arrayOfUniqueIntExample": [2, 6, 10, 14],"arrayOfTwonumbersExample": [6, 10],"arrayOfFloatExample": [1.64],"arrayOfNumberNoDefaultsExample": [20, 18, 16, 14, 12],"arrayOfStringExample": ["dogdog", "catcat", "birdbird"],"arrayOfObjectType": [{"integerExample": 1554,"integerExampleInt32": 2},{"integerExample": 60000,"integerExampleInt32": 22}]}}
ArrayTestType
A type containing arrays of different kinds.
arrayOfIntExample Array of Integer | A property with an array of ints. JSON primitive is 1 |
arrayOfUniqueIntExample Array of Integer | A property with an array of ints in which items must be unique. JSON primitive is 1 UniqueItems |
arrayOfTwonumbersExample Array of Integer | MinItems: 2 MaxItems: 2 |
arrayOfFloatExample Array of Number | An array of float. JSON primitive is 1 MaxItems: 1 |
arrayOfNumberNoDefaultsExample Array of Number | An array of float. JSON primitive is |
arrayOfStringExample Array of String | An array of strings. JSON primitive is |
arrayOfObjectType Array of IntegerTestType | An array of IntegerTestType. JSON primitive is |
{"arrayOfIntExample": [2, 4, 2, 6, 4, 6, 2],"arrayOfUniqueIntExample": [2, 6, 10, 14],"arrayOfTwonumbersExample": [6, 10],"arrayOfFloatExample": [1.64],"arrayOfNumberNoDefaultsExample": [20, 18, 16, 14, 12],"arrayOfStringExample": ["dogdog", "catcat", "birdbird"],"arrayOfObjectType": [{"integerExample": 1554,"integerExampleInt32": 2},{"integerExample": 60000,"integerExampleInt32": 22}]}
DateTestType
Test data for the RAML date formats.
dateOnlyExample Date | to be shown as "Date" |
timeOnlyExample Time | to be shown as "Time" |
dateTimeOnlyExample DateTimeOnly | To be shown as "DateTimeOnly". We do not recommend this format. |
dateTimeExample DateTime | rfc3339 format explicitly set. To be shown as "DateTime" |
dateTimeExampleDefaultFormat DateTime | format not set, rfc3339 is default, so this is also shown as "DateTime" |
dateTimeExampleRfc DateTimeRfc2616 | To be shown as "DateTimeRfc2616". Not a recommended format. |
{"dateOnlyExample": "2015-05-23","timeOnlyExample": "12:30:00","dateTimeOnlyExample": "2015-07-04T21:00:00","dateTimeExample": "2016-02-28T16:41:41.090Z","dateTimeExampleDefaultFormat": "2016-02-28T16:41:41.090Z","dateTimeExampleRfc": "Sun, 28 Feb 2016 16:41:41 GMT"}
OptionalPropertyTestType
Example of optional/non-optional properties.
requiredTrueExample String | this should be required. |
requiredNotSetExample String | this should default to required = true. |
requiredFalseExample String |
RegexPropertyTestType
This is a type that can have arbitrary properties as long as they match a certain expression
/^[a-z]{2}-[A-Z]{2}?$/ Any string parameter matching this regular expression | Regular expression property with a string type. To be displayed as "Any (type) property matching this regular expression". The Slashes should appear in blue. |
This is a type that can have arbitrary properties as long as they match a certain expression
/^[a-z]{2}-[A-Z]{2}?$/ Any object parameter matching this regular expression | Regular expression property with an object type. To be displayed as "Any (type) property matching this regular expression". The Slashes should appear in blue. |
AnnotationsTestType
isBetaType BETAString | Beta property. If true, a "beta" flag should appear beside the type name. |
isOptionalBetaType BETAString | Beta property. If true, a "beta" flag should appear beside the type name. |
OutOfOrderPropertiesTestType
Tests out of order properties. By convention, id
, key
, version
, createdAt
,
createdBy
, lastModifiedAt
and lastModifiedBy
should display at the top (in that order).
custom
should display at the bottom. All other properties should render in the order they
appear.
Some types will not have all of the 'conventional' properties – i.e. cart doesn't have a key field.
In this case, ordering would go id
, version
... etc.
id String | Should display 1st (8th in RAML) |
version String | Should display 2nd (16th in RAML) |
key String | Should display 3rd (4th in RAML) |
createdAt DateTime | Should display 4th (15th in RAML) |
createdBy BETAObject | Should display 5th (2nd in RAML) |
lastModifiedAt DateTime | Should display 6th (12th in RAML) |
lastModifiedBy BETAObject | Should display 7th (10th in RAML) |
eigthProperty String | Should display 8th (1st in RAML) |
ninthProperty String | Should display 9th (3rd in RAML) |
tenthProperty String | Should display 10th (5th in RAML) |
eleventhPropery String | Should display 11th (7th in RAML) |
twelthProperty String | Should display 12th (9th in RAML) |
thirteenthProperty String | Should display 13th (11th in RAML) |
fourteenthProperty String | Should display 14th (13th in RAML) |
fifteenthProperty String | Should display 15th (14th in definition) |
custom String | Should display 16th (6th in RAML) |
{"eigthProperty": "Should display 8th (1st in RAML)","createdBy": {"firstName": "John","lastName": "Doe"},"ninthProperty": "Should display 9th (3rd in RAML)","key": "Should display 3rd (4th in RAML)","tenthProperty": "Should display 10th (5th in RAML)","custom": "Should display 16th (6th in RAML)","eleventhPropery": "Should display 11th (7th in RAML)","id": "Should display 1st (8th in RAML)","twelthProperty": "Should display 12th (9th in RAML)","lastModifiedBy": {"firstName": "Jane","lastName": "Doe"},"thirteenthProperty": "Should display 13th (11th in RAML)","lastModifiedAt": "2016-02-28T16:41:41.090Z","fourteenthProperty": "Should display 14th (13th in RAML)","fifteenthProperty": "Should display 15th (14th in definition)","createdAt": "2015-02-28T16:41:41.090Z","version": "Should display 2nd (16th in RAML)"}
LinkToTypeOnSameSite
LinkToTypeOnSameSite | A link pointing to a type the same microsite. |
LinkToTypeOnAnotherSite
LinkToTypeOnAnotherSite | A link pointing to a type in another microsite. |
LinkToTypeOnExternalSite
LinkToTypeOnExternalSite | A link pointing to a type in an external website. |
DescriptionsWithUrnLinks
This link - ObjectTestTypeDraft, [ObjectTestTypeDraft](ctp:test:type:ObjectTestTypeDraft)
, must be auto-generated.
version Int | This link - OutOfOrderPropertiesTestType, |
AnyTestType
Tests acceptance of JSON blobs. Test Endpoint URN Test Overridden Endpoint URN
anyTypeExample Any | A test of type "any", i.e. any JSON allowed here. To be displayed as "any JSON". |
ObjectTestTypeDraft
A type to create an ObjectTestType. Used for testing the endpoint layout.
objectTypeProperty |
{"objectTypeProperty": {"arrayOfIntExample": [1, 2, 1, 3, 2, 3, 1],"arrayOfUniqueIntExample": [1, 3, 5, 7],"arrayOfTwonumbersExample": [3, 5],"arrayOfFloatExample": [0.82],"arrayOfNumberNoDefaultsExample": [10, 9, 8, 7, 6],"arrayOfStringExample": ["dog", "cat", "bird"],"arrayOfObjectType": [{"integerExample": 777,"integerExampleInt32": 1},{"integerExample": 30000,"integerExampleInt32": 22}]}}
ObjectTestType
A typical Object type with a non-scalar property.
version Int | |
objectTypeProperty |
{"version": 1,"objectTypeProperty": {"arrayOfIntExample": [2, 4, 2, 6, 4, 6, 2],"arrayOfUniqueIntExample": [2, 6, 10, 14],"arrayOfTwonumbersExample": [6, 10],"arrayOfFloatExample": [1.64],"arrayOfNumberNoDefaultsExample": [20, 18, 16, 14, 12],"arrayOfStringExample": ["dogdog", "catcat", "birdbird"],"arrayOfObjectType": [{"integerExample": 1554,"integerExampleInt32": 2},{"integerExample": 60000,"integerExampleInt32": 22}]}}
ArrayTestType
A type containing arrays of different kinds.
arrayOfIntExample Array of Integer | A property with an array of ints. JSON primitive is 1 |
arrayOfUniqueIntExample Array of Integer | A property with an array of ints in which items must be unique. JSON primitive is 1 UniqueItems |
arrayOfTwonumbersExample Array of Integer | MinItems: 2 MaxItems: 2 |
arrayOfFloatExample Array of Number | An array of float. JSON primitive is 1 MaxItems: 1 |
arrayOfNumberNoDefaultsExample Array of Number | An array of float. JSON primitive is |
arrayOfStringExample Array of String | An array of strings. JSON primitive is |
arrayOfObjectType Array of IntegerTestType | An array of IntegerTestType. JSON primitive is |
{"arrayOfIntExample": [2, 4, 2, 6, 4, 6, 2],"arrayOfUniqueIntExample": [2, 6, 10, 14],"arrayOfTwonumbersExample": [6, 10],"arrayOfFloatExample": [1.64],"arrayOfNumberNoDefaultsExample": [20, 18, 16, 14, 12],"arrayOfStringExample": ["dogdog", "catcat", "birdbird"],"arrayOfObjectType": [{"integerExample": 1554,"integerExampleInt32": 2},{"integerExample": 60000,"integerExampleInt32": 22}]}
DateTestType
Test data for the RAML date formats.
dateOnlyExample Date | to be shown as "Date" |
timeOnlyExample Time | to be shown as "Time" |
dateTimeOnlyExample DateTimeOnly | To be shown as "DateTimeOnly". We do not recommend this format. |
dateTimeExample DateTime | rfc3339 format explicitly set. To be shown as "DateTime" |
dateTimeExampleDefaultFormat DateTime | format not set, rfc3339 is default, so this is also shown as "DateTime" |
dateTimeExampleRfc DateTimeRfc2616 | To be shown as "DateTimeRfc2616". Not a recommended format. |
{"dateOnlyExample": "2015-05-23","timeOnlyExample": "12:30:00","dateTimeOnlyExample": "2015-07-04T21:00:00","dateTimeExample": "2016-02-28T16:41:41.090Z","dateTimeExampleDefaultFormat": "2016-02-28T16:41:41.090Z","dateTimeExampleRfc": "Sun, 28 Feb 2016 16:41:41 GMT"}
OptionalPropertyTestType
Example of optional/non-optional properties.
requiredTrueExample String | this should be required. |
requiredNotSetExample String | this should default to required = true. |
requiredFalseExample String |
RegexPropertyTestType
This is a type that can have arbitrary properties as long as they match a certain expression
/^[a-z]{2}-[A-Z]{2}?$/ Any string parameter matching this regular expression | Regular expression property with a string type. To be displayed as "Any (type) property matching this regular expression". The Slashes should appear in blue. |
This is a type that can have arbitrary properties as long as they match a certain expression
/^[a-z]{2}-[A-Z]{2}?$/ Any object parameter matching this regular expression | Regular expression property with an object type. To be displayed as "Any (type) property matching this regular expression". The Slashes should appear in blue. |
AnnotationsTestType
isBetaType BETAString | Beta property. If true, a "beta" flag should appear beside the type name. |
isOptionalBetaType BETAString | Beta property. If true, a "beta" flag should appear beside the type name. |
OutOfOrderPropertiesTestType
Tests out of order properties. By convention, id
, key
, version
, createdAt
,
createdBy
, lastModifiedAt
and lastModifiedBy
should display at the top (in that order).
custom
should display at the bottom. All other properties should render in the order they
appear.
Some types will not have all of the 'conventional' properties – i.e. cart doesn't have a key field.
In this case, ordering would go id
, version
... etc.
id String | Should display 1st (8th in RAML) |
version String | Should display 2nd (16th in RAML) |
key String | Should display 3rd (4th in RAML) |
createdAt DateTime | Should display 4th (15th in RAML) |
createdBy BETAObject | Should display 5th (2nd in RAML) |
lastModifiedAt DateTime | Should display 6th (12th in RAML) |
lastModifiedBy BETAObject | Should display 7th (10th in RAML) |
eigthProperty String | Should display 8th (1st in RAML) |
ninthProperty String | Should display 9th (3rd in RAML) |
tenthProperty String | Should display 10th (5th in RAML) |
eleventhPropery String | Should display 11th (7th in RAML) |
twelthProperty< |