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

  • Returns boolean

  • Returns undefined | AdditionalProperties

  • Returns unknown

  • Returns string

  • Returns undefined | DiscriminatorObject

  • Returns undefined | Record<string, EncodingObject>

  • Returns unknown[]

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

  • Returns unknown

  • Returns undefined | number

  • Returns undefined | number

  • Returns undefined | string

  • Returns undefined | string

  • Returns string

  • Returns string

  • Returns undefined | XMLObject

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean