fluid-oas
    Preparing search index...

    Interface OpenApiString

    Representing a string from JSON schema.

    interface OpenApiString {
        addDefault(val: string): this;
        addDescription(description: string): this;
        addEnums(val: (null | string)[]): this;
        addExample(example: any): this;
        addExtensions(mappings: { [key: `x-${string}`]: OpenApiSchema }): this;
        addExternalDocs(docs: OpenApiDocumentation): this;
        addFormat(val: string): this;
        addMaxLength(max: number): this;
        addMinLength(min: number): this;
        addNullable(nullable: boolean): this;
        addPattern(pattern: RegExp): this;
        addReadOnly(readOnly: boolean): this;
        addWriteOnly(writeOnly: boolean): this;
        override(overrideVal: unknown): this;
        toJSON(): unknown;
    }

    Hierarchy

    • SchemaInterface<string>
      • OpenApiString
    Index

    Methods

    addDefault addDescription addEnums addExample addExtensions addExternalDocs addFormat addMaxLength addMinLength addNullable addPattern addReadOnly addWriteOnly override toJSON

    Methods

    • Adds a description to this OpenApiSchema

      Parameters

      • description: string

        Description

      Returns this

    • Parameters

      • val: (null | string)[]

      Returns this

    • Parameters

      • example: any

      Returns this

    • Extend the specification with an extension object schema.

      Parameters

      • mappings: { [key: `x-${string}`]: OpenApiSchema }

        key value mappings with names MUST beginning with "x-"

      Returns this

    • As of v3.1.0 this has been removed. Still available for v3.0.* OAS

      Parameters

      • nullable: boolean

      Returns this

    • Validates the string with a regular expresssion.

      Parameters

      • pattern: RegExp

        Regular expression to validate against.

      Returns this

    • Parameters

      • readOnly: boolean

      Returns this

    • Parameters

      • writeOnly: boolean

      Returns this

    • Overrides the toJSON method for a custom serialization.

      WARNING: overrideVal must be serializable and future changes are subject to breaking.

      Parameters

      • overrideVal: unknown

        Overrides the serialization of this object into this value.

      Returns this

    • Serializes the object into its equivalent OpenApi JSON value.

      Returns unknown

    Settings

    Member Visibility

    On This Page

    Methods