Interface IValidateSwaggerDocumentOptions

Options for validateSwaggerDocument() function.

interface IValidateSwaggerDocumentOptions {
    allowDuplicateOperationIds?: Nilable<boolean>;
    allowNoOperationIds?: Nilable<boolean>;
    controllerMethods?: Nilable<IControllerMethodInfo[]>;
    documentation: Document<{}>;
}

Properties

allowDuplicateOperationIds? allowNoOperationIds? controllerMethods? documentation

Properties

Optional allowDuplicateOperationIds

allowDuplicateOperationIds?: Nilable<boolean>

Allow to reuse IDs for Swagger operations.

Default

false

Optional allowNoOperationIds

allowNoOperationIds?: Nilable<boolean>

Allow operations to have no IDs.

Default

false

Optional controllerMethods

controllerMethods?: Nilable<IControllerMethodInfo[]>

Controller methods.

documentation

documentation: Document<{}>

The document(ation).

Type declaration

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc