@spailybot/moleculer-auto-openapi - v2.0.0
    Preparing search index...

    Interface FVOARuleMetaKeys

    These keys can be put to use within the rule set of the fastest validator schema, under the $$oa meta parameters.

    For object rules (rules extracted as a schema component), the summary key is emitted as the summary field on the $ref to the component, while title is emitted on the component schema itself (components.schemas[...].title).

    {
         $$strict: true,
         foo: {
             $$oa: {
                 in: 'body';
                 description: "rule description";
                 summary: "deprecated rule summary";
                 deprecated: true;
                 example: "foo"
             },
             type: "string"
         },
         //the rest of your schema
     }
    interface FVOARuleMetaKeys {
        $ref?: string;
        $schema?: string;
        additionalProperties?: boolean | SchemaObject | ReferenceObject;
        allOf?: (SchemaObject | ReferenceObject)[];
        allowEmptyValue?: boolean;
        allowReserved?: boolean;
        anyOf?: (SchemaObject | ReferenceObject)[];
        const?: any;
        contentMediaType?: string;
        default?: any;
        deprecated?: boolean;
        description?: string;
        discriminator?: DiscriminatorObject;
        enum?: any[];
        example?: any;
        examples?: { [media: string]: ReferenceObject | ExampleObject };
        exclusiveMaximum?: number | boolean;
        exclusiveMinimum?: number | boolean;
        explode?: boolean;
        externalDocs?: ExternalDocumentationObject;
        format?: string;
        in?: "query" | "body";
        maximum?: number;
        maxItems?: number;
        maxLength?: number;
        maxProperties?: number;
        minimum?: number;
        minItems?: number;
        minLength?: number;
        minProperties?: number;
        multipleOf?: number;
        not?: SchemaObject | ReferenceObject;
        oneOf?: (SchemaObject | ReferenceObject)[];
        optional?: boolean;
        pattern?: string;
        properties?: { [name: string]: SchemaObject | ReferenceObject };
        readOnly?: boolean;
        required?: boolean;
        style?: string;
        summary?: string;
        title?: string;
        uniqueItems?: boolean;
        writeOnly?: boolean;
        "x-fastest-optional"?: boolean;
        xml?: XMLObject;
        [key: string]: any;
    }

    Hierarchy

    Indexable

    • [key: string]: any
    Index
    $ref? $schema? additionalProperties? allOf? allowEmptyValue? allowReserved? anyOf? const? contentMediaType? default? deprecated? description? discriminator? enum? example? examples? exclusiveMaximum? exclusiveMinimum? explode? externalDocs? format? in? maximum? maxItems? maxLength? maxProperties? minimum? minItems? minLength? minProperties? multipleOf? not? oneOf? optional? pattern? properties? readOnly? required? style? summary? title? uniqueItems? writeOnly? x-fastest-optional? xml?
    $ref?: string
    $schema?: string
    additionalProperties?: boolean | SchemaObject | ReferenceObject
    allOf?: (SchemaObject | ReferenceObject)[]
    allowEmptyValue?: boolean
    allowReserved?: boolean
    anyOf?: (SchemaObject | ReferenceObject)[]
    const?: any
    contentMediaType?: string
    default?: any
    deprecated?: boolean
    description?: string
    discriminator?: DiscriminatorObject
    enum?: any[]
    example?: any
    examples?: { [media: string]: ReferenceObject | ExampleObject }
    exclusiveMaximum?: number | boolean
    exclusiveMinimum?: number | boolean
    explode?: boolean
    externalDocs?: ExternalDocumentationObject
    format?: string
    in?: "query" | "body"
    maximum?: number
    maxItems?: number
    maxLength?: number
    maxProperties?: number
    minimum?: number
    minItems?: number
    minLength?: number
    minProperties?: number
    multipleOf?: number
    not?: SchemaObject | ReferenceObject
    oneOf?: (SchemaObject | ReferenceObject)[]
    optional?: boolean
    pattern?: string
    properties?: { [name: string]: SchemaObject | ReferenceObject }
    readOnly?: boolean
    required?: boolean
    style?: string
    summary?: string
    title?: string
    uniqueItems?: boolean
    writeOnly?: boolean
    "x-fastest-optional"?: boolean
    xml?: XMLObject

    Settings
    Member Visibility

    On This Page
    Properties