The Guild LogoThe Guild Monogram

Search docs

Search icon

Products by The Guild

Products

Hive logoHive blurred logo

Hive

Schema Registry for your GraphQL Workflows

Skip to main content

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.

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:713


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:695


customFetch#

Optional customFetch: any

W3 Compatible Fetch Implementation

Defined in#

packages/types/src/config.ts:705


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:717


includeHttpDetails#

Optional includeHttpDetails: boolean

Include HTTP Response details to the result object

Defined in#

packages/types/src/config.ts:709


operationHeaders#

Optional operationHeaders: Object

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

Index signature#

▪ [k: string]: any

Defined in#

packages/types/src/config.ts:682


qs#

Optional qs: Object

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

Index signature#

▪ [k: string]: any

Defined in#

packages/types/src/config.ts:699


schemaHeaders#

Optional schemaHeaders: Object

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

Index signature#

▪ [k: string]: any

Defined in#

packages/types/src/config.ts:688


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:721


source#

source: any

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

Defined in#

packages/types/src/config.ts:674


sourceFormat#

Optional sourceFormat: "json" | "yaml"

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

Defined in#

packages/types/src/config.ts:678