Interface: OpenAPILoaderOptions

loaders/openapi/src.OpenAPILoaderOptions

Hierarchy#

• Partial<JSONSchemaLoaderOptions>

  ↳ OpenAPILoaderOptions

Table of contents#

Properties#

• allowLegacySDLEmptyFields
• allowLegacySDLImplementsInterfaces
• assumeValid
• assumeValidSDL
• baseUrl
• commentDescriptions
• cwd
• errorMessage
• experimentalFragmentVariables
• fallbackFormat
• fetch
• ignore
• ignoreErrorResponses
• logger
• noDeduplication
• noLocation
• oasFilePath
• operationHeaders
• operations
• pubsub
• queryParams
• queryStringOptions
• schemaHeaders
• selectQueryOrMutationField

Properties#

allowLegacySDLEmptyFields#

• Optional allowLegacySDLEmptyFields: boolean

Inherited from#

Partial.allowLegacySDLEmptyFields

Defined in#

node_modules/@graphql-tools/utils/typings/Interfaces.d.ts:18

allowLegacySDLImplementsInterfaces#

• Optional allowLegacySDLImplementsInterfaces: boolean

Inherited from#

Partial.allowLegacySDLImplementsInterfaces

Defined in#

node_modules/@graphql-tools/utils/typings/Interfaces.d.ts:19

assumeValid#

• Optional assumeValid: boolean

When building a schema from a GraphQL service's introspection result, it might be safe to assume the schema is valid. Set to true to assume the produced schema is valid.

Default: false

Inherited from#

Partial.assumeValid

Defined in#

node_modules/graphql/type/schema.d.ts:146

assumeValidSDL#

• Optional assumeValidSDL: boolean

Set to true to assume the SDL is valid.

Default: false

Inherited from#

Partial.assumeValidSDL

Defined in#

node_modules/graphql/utilities/buildASTSchema.d.ts:12

baseUrl#

• Optional baseUrl: string

Inherited from#

Partial.baseUrl

Defined in#

packages/loaders/json-schema/src/types.ts:10

commentDescriptions#

• Optional commentDescriptions: boolean

Set to true in order to convert all GraphQL comments (marked with # sign) to descriptions (""") GraphQL has built-in support for transforming descriptions to comments (with print), but not while parsing. Turning the flag on will support the other way as well (parse)

Inherited from#

Partial.commentDescriptions

Defined in#

node_modules/@graphql-tools/utils/typings/Interfaces.d.ts:26

cwd#

• Optional cwd: string

Inherited from#

Partial.cwd

Defined in#

node_modules/@graphql-tools/utils/typings/loaders.d.ts:10

errorMessage#

• Optional errorMessage: string

Inherited from#

Partial.errorMessage

Defined in#

packages/loaders/json-schema/src/types.ts:14

experimentalFragmentVariables#

• Optional experimentalFragmentVariables: boolean

Inherited from#

Partial.experimentalFragmentVariables

Defined in#

node_modules/@graphql-tools/utils/typings/Interfaces.d.ts:20

fallbackFormat#

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

Defined in#

packages/loaders/openapi/src/types.ts:7

fetch#

• Optional fetch: (input: URL | RequestInfo, init?: RequestInit) => Promise<Response>

Type declaration#

▸ (input, init?): Promise<Response>

Parameters#

Returns#

Promise<Response>

Inherited from#

Partial.fetch

Defined in#

packages/loaders/json-schema/src/types.ts:17

ignore#

• Optional ignore: string | string[]

Inherited from#

Partial.ignore

Defined in#

node_modules/@graphql-tools/utils/typings/loaders.d.ts:11

ignoreErrorResponses#

• Optional ignoreErrorResponses: boolean

Inherited from#

Partial.ignoreErrorResponses

Defined in#

packages/loaders/json-schema/src/types.ts:18

logger#

• Optional logger: Logger

Inherited from#

Partial.logger

Defined in#

packages/loaders/json-schema/src/types.ts:15

noDeduplication#

• Optional noDeduplication: boolean

Inherited from#

Partial.noDeduplication

Defined in#

packages/loaders/json-schema/src/types.ts:20

noLocation#

• Optional noLocation: boolean

Inherited from#

Partial.noLocation

Defined in#

node_modules/@graphql-tools/utils/typings/Interfaces.d.ts:17

oasFilePath#

• oasFilePath: string

Defined in#

packages/loaders/openapi/src/types.ts:5

operationHeaders#

• Optional operationHeaders: OperationHeadersConfiguration

Inherited from#

Partial.operationHeaders

Defined in#

packages/loaders/json-schema/src/types.ts:11

operations#

• Optional operations: JSONSchemaOperationConfig[]

Inherited from#

Partial.operations

Defined in#

packages/loaders/json-schema/src/types.ts:13

pubsub#

• Optional pubsub: MeshPubSub

Inherited from#

Partial.pubsub

Defined in#

packages/loaders/json-schema/src/types.ts:16

queryParams#

• Optional queryParams: Record<string, string>

Inherited from#

Partial.queryParams

Defined in#

packages/loaders/json-schema/src/types.ts:19

queryStringOptions#

• Optional queryStringOptions: IStringifyOptions

Inherited from#

Partial.queryStringOptions

Defined in#

packages/loaders/json-schema/src/types.ts:21

schemaHeaders#

• Optional schemaHeaders: Record<string, string>

Inherited from#

Partial.schemaHeaders

Defined in#

packages/loaders/json-schema/src/types.ts:12

selectQueryOrMutationField#

• Optional selectQueryOrMutationField: OpenAPILoaderSelectQueryOrMutationFieldConfig[]

Defined in#

packages/loaders/openapi/src/types.ts:6