types_src.yamlconfig.openapihandler

Interface: OpenapiHandler#

types/src.YamlConfig.OpenapiHandler

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

Hierarchy#

  • OpenapiHandler

Table of contents#

Properties#

Properties#

addLimitArgument#

Optional addLimitArgument: boolean

Auto-generate a 'limit' argument for all fields that return lists of objects, including ones produced by links

Defined in: packages/types/src/config.ts:629


baseUrl#

Optional baseUrl: string

Specifies the URL on which all paths will be based on. Overrides the server object in the OAS.

Defined in: packages/types/src/config.ts:611


customFetch#

Optional customFetch: any

W3 Compatible Fetch Implementation

Defined in: packages/types/src/config.ts:621


genericPayloadArgName#

Optional genericPayloadArgName: boolean

Set argument name for mutation payload to 'requestBody'. If false, name defaults to camelCased pathname

Defined in: packages/types/src/config.ts:633


includeHttpDetails#

Optional includeHttpDetails: boolean

Include HTTP Response details to the result object

Defined in: packages/types/src/config.ts:625


operationHeaders#

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

JSON object representing the Headers to add to the runtime of the API calls

Defined in: packages/types/src/config.ts:598


qs#

Optional qs: { [k: string]: any; }

JSON object representing the query search parameters to add to the API calls

Defined in: packages/types/src/config.ts:615


schemaHeaders#

Optional schemaHeaders: { [k: string]: any; }

If you are using a remote URL endpoint to fetch your schema, you can set headers for the HTTP request to fetch your schema.

Defined in: packages/types/src/config.ts:604


selectQueryOrMutationField#

Optional selectQueryOrMutationField: SelectQueryOrMutationFieldConfig[]

Allows to explicitly override the default operation (Query or Mutation) for any OAS operation

Defined in: packages/types/src/config.ts:637


source#

source: string

A pointer to your API source - could be a local file, remote file or url endpoint

Defined in: packages/types/src/config.ts:590


sourceFormat#

Optional sourceFormat: json | yaml

Format of the source file (Allowed values: json, yaml)

Defined in: packages/types/src/config.ts:594