Interface OpenAPIHelperInterface

interface OpenAPIHelperInterface {
    allowsEmptyValue(): boolean;
    getAdditionalProperties?(): undefined | AdditionalProperties;
    getAlternatives(): OpenAPIHelperInterface[];
    getChildren(): Record<string, OpenAPIHelperInterface>;
    getDefaultValue(): unknown;
    getDescription(): string;
    getDiscriminator?(): undefined | DiscriminatorObject;
    getEncoding?(): undefined | Record<string, EncodingObject>;
    getEnum(): unknown[];
    getExamples?(): undefined | Record<string, ExampleObject | ReferenceObject>;
    getExampleValue(): unknown;
    getFirstItem(): undefined | OpenAPIHelperInterface;
    getMax(): undefined | number;
    getMin(): undefined | number;
    getRef?(): undefined | string;
    getStyle?(): undefined | string;
    getType(): string;
    getUnit(): string;
    getXml?(): undefined | XMLObject;
    hasAdditionalProperties?(): boolean;
    hasDefaultValue(): boolean;
    hasDiscriminator?(): boolean;
    hasEncoding?(): boolean;
    hasExamples?(): boolean;
    hasExampleValue(): boolean;
    hasMax(): boolean;
    hasMin(): boolean;
    hasRef?(): boolean;
    hasStyle?(): boolean;
    hasXml?(): boolean;
    isDeprecated(): boolean;
    isRequired(): boolean;
    isUnique(): boolean;
    isValid(): boolean;
}

Hierarchy

  • BaseHelperInterface
    • OpenAPIHelperInterface

Methods

allowsEmptyValue getAdditionalProperties? getAlternatives getChildren getDefaultValue getDescription getDiscriminator? getEncoding? getEnum getExamples? getExampleValue getFirstItem getMax getMin getRef? getStyle? getType getUnit getXml? hasAdditionalProperties? hasDefaultValue hasDiscriminator? hasEncoding? hasExamples? hasExampleValue hasMax hasMin hasRef? hasStyle? hasXml? isDeprecated isRequired isUnique isValid

Methods

allowsEmptyValue

  • allowsEmptyValue(): boolean

  • Returns boolean

OptionalgetAdditionalProperties

  • getAdditionalProperties(): undefined | AdditionalProperties

  • Returns undefined | AdditionalProperties

getAlternatives

getChildren

getDefaultValue

  • getDefaultValue(): unknown

  • Returns unknown

getDescription

  • getDescription(): string

  • Returns string

OptionalgetDiscriminator

  • getDiscriminator(): undefined | DiscriminatorObject

  • Returns undefined | DiscriminatorObject

OptionalgetEncoding

  • getEncoding(): undefined | Record<string, EncodingObject>

  • Returns undefined | Record<string, EncodingObject>

getEnum

  • getEnum(): unknown[]

  • Returns unknown[]

OptionalgetExamples

  • getExamples(): undefined | Record<string, ExampleObject | ReferenceObject>

  • Returns undefined | Record<string, ExampleObject | ReferenceObject>

getExampleValue

  • getExampleValue(): unknown

  • Returns unknown

getFirstItem

getMax

  • getMax(): undefined | number

  • Returns undefined | number

getMin

  • getMin(): undefined | number

  • Returns undefined | number

OptionalgetRef

  • getRef(): undefined | string

  • Returns undefined | string

OptionalgetStyle

  • getStyle(): undefined | string

  • Returns undefined | string

getType

  • getType(): string

  • Returns string

getUnit

  • getUnit(): string

  • Returns string

OptionalgetXml

  • getXml(): undefined | XMLObject

  • Returns undefined | XMLObject

OptionalhasAdditionalProperties

  • hasAdditionalProperties(): boolean

  • Returns boolean

hasDefaultValue

  • hasDefaultValue(): boolean

  • Returns boolean

OptionalhasDiscriminator

  • hasDiscriminator(): boolean

  • Returns boolean

OptionalhasEncoding

  • hasEncoding(): boolean

  • Returns boolean

OptionalhasExamples

  • hasExamples(): boolean

  • Returns boolean

hasExampleValue

  • hasExampleValue(): boolean

  • Returns boolean

hasMax

  • hasMax(): boolean

  • Returns boolean

hasMin

  • hasMin(): boolean

  • Returns boolean

OptionalhasRef

  • hasRef(): boolean

  • Returns boolean

OptionalhasStyle

  • hasStyle(): boolean

  • Returns boolean

OptionalhasXml

  • hasXml(): boolean

  • Returns boolean

isDeprecated

  • isDeprecated(): boolean

  • Returns boolean

isRequired

  • isRequired(): boolean

  • Returns boolean

isUnique

  • isUnique(): boolean

  • Returns boolean

isValid

  • isValid(): boolean

  • Returns boolean

Settings

Member Visibility

On This Page

Methods