Interface DiscriminatedListProperty

interface DiscriminatedListProperty {
    deprecationMessage: string;
    description: string;
    discriminator: string;
    draftMessage: string;
    format: "list";
    isDeprecated: boolean;
    isDraft: boolean;
    isUndocumented: boolean;
    itemFormat: "discriminated_object";
    jsonType: "array";
    name: string;
    propertyGroupKey: null | string;
    undocumentedMessage: string;
    variants: {
        description: string;
        properties: Property[];
    }[];
}

Hierarchy

  • BaseListProperty
    • DiscriminatedListProperty

Properties

deprecationMessage description discriminator draftMessage format isDeprecated isDraft isUndocumented itemFormat jsonType name propertyGroupKey undocumentedMessage variants

Properties

deprecationMessage

deprecationMessage: string

description

description: string

discriminator

discriminator: string

draftMessage

draftMessage: string

format

format: "list"

isDeprecated

isDeprecated: boolean

isDraft

isDraft: boolean

isUndocumented

isUndocumented: boolean

itemFormat

itemFormat: "discriminated_object"

jsonType

jsonType: "array"

name

name: string

propertyGroupKey

propertyGroupKey: null | string

undocumentedMessage

undocumentedMessage: string

variants

variants: {
    description: string;
    properties: Property[];
}[]

Settings

Member Visibility

On This Page

deprecationMessagedescriptiondiscriminatordraftMessageformatisDeprecatedisDraftisUndocumenteditemFormatjsonTypenamepropertyGroupKeyundocumentedMessagevariants