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[];
    getExampleValue(): unknown;
    getExamples?(): undefined | Record<string, ReferenceObject | ExampleObject>;
    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;
    hasExampleValue(): boolean;
    hasExamples?(): boolean;
    hasMax(): boolean;
    hasMin(): boolean;
    hasRef?(): boolean;
    hasStyle?(): boolean;
    hasXml?(): boolean;
    isDeprecated(): boolean;
    isRequired(): boolean;
    isUnique(): boolean;
    isValid(): boolean;
}

Hierarchy (view full)

Implemented by

Methods

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

Methods

allowsEmptyValue

Optional getAdditionalProperties

getAlternatives

getChildren

getDefaultValue

getDescription

Optional getDiscriminator

Optional getEncoding

getEnum

getExampleValue

Optional getExamples

getFirstItem

getMax

getMin

Optional getRef

Optional getStyle

getType

getUnit

Optional getXml

Optional hasAdditionalProperties

hasDefaultValue

Optional hasDiscriminator

Optional hasEncoding

hasExampleValue

Optional hasExamples

hasMax

hasMin

Optional hasRef

Optional hasStyle

Optional hasXml

isDeprecated

isRequired

isUnique

isValid

Settings

Member Visibility

Theme

On This Page

allowsEmptyValuegetAdditionalPropertiesgetAlternativesgetChildrengetDefaultValuegetDescriptiongetDiscriminatorgetEncodinggetEnumgetExampleValuegetExamplesgetFirstItemgetMaxgetMingetRefgetStylegetTypegetUnitgetXmlhasAdditionalPropertieshasDefaultValuehasDiscriminatorhasEncodinghasExampleValuehasExampleshasMaxhasMinhasRefhasStylehasXmlisDeprecatedisRequiredisUniqueisValid