Docs
API
Interfaces
NewOpenapiHandler

Interface: NewOpenapiHandler

types/src.YamlConfig.NewOpenapiHandler

Handler for Swagger / OpenAPI 2/3 specification. Source could be a local json/swagger file, or a url to it.

Table of contents

Properties

Properties

baseUrl

Optional baseUrl: string

Defined in

packages/types/src/config.ts:822


fallbackFormat

Optional fallbackFormat: "json" | "yaml" | "js" | "ts"

Allowed values: json, yaml, js, ts

Defined in

packages/types/src/config.ts:821


ignoreErrorResponses

Optional ignoreErrorResponses: boolean

Defined in

packages/types/src/config.ts:834


noDeduplication

Optional noDeduplication: boolean

Defined in

packages/types/src/config.ts:837


oasFilePath

oasFilePath: string

Defined in

packages/types/src/config.ts:817


operationHeaders

Optional operationHeaders: string | { [k: string]: any; }

Any of: JSON, String

Defined in

packages/types/src/config.ts:829


queryParams

Optional queryParams: any

Defined in

packages/types/src/config.ts:836


schemaHeaders

Optional schemaHeaders: Object

Index signature

▪ [k: string]: any

Defined in

packages/types/src/config.ts:823


selectQueryOrMutationField

Optional selectQueryOrMutationField: OASSelectQueryOrMutationFieldConfig[]

Defined in

packages/types/src/config.ts:835