Table of contents
References
Interfaces
- JSONSchemaLinkConfig
- JSONSchemaLoaderBundle
- JSONSchemaLoaderBundleOptions
- JSONSchemaLoaderBundleToGraphQLSchemaOptions
- JSONSchemaLoaderOptions
- JSONSchemaOperationResponseConfig
- TypeComposers
Type Aliases
- HTTPMethod
- JSONSchemaBaseOperationConfig
- JSONSchemaBaseOperationConfigWithJSONRequest
- JSONSchemaHTTPBaseOperationConfig
- JSONSchemaHTTPBinaryConfig
- JSONSchemaHTTPJSONOperationConfig
- JSONSchemaOperationConfig
- JSONSchemaPubSubOperationConfig
- OperationHeadersConfiguration
Variables
Functions
- createBundle
- getComposerFromJSONSchema
- getDereferencedJSONSchemaFromOperations
- getGraphQLSchemaFromBundle
- getGraphQLSchemaFromDereferencedJSONSchema
- getReferencedJSONSchemaFromOperations
- loadGraphQLSchemaFromJSONSchemas
References
src
Renames and re-exports loadGraphQLSchemaFromJSONSchemas
Type Aliases
HTTPMethod
Ƭ HTTPMethod: "GET"
| "HEAD"
| "POST"
| "PUT"
| "DELETE"
| "CONNECT"
| "OPTIONS"
| "TRACE"
| "PATCH"
Defined in
packages/loaders/json-schema/src/types.ts:60
JSONSchemaBaseOperationConfig
Ƭ JSONSchemaBaseOperationConfig: { argTypeMap?
: Record
<string
, string
| GraphQLInputType
> ; description?
: string
; field
: string
; type
: OperationTypeNode
} & { responseByStatusCode?
: Record
<string
, JSONSchemaOperationResponseConfig
> } | JSONSchemaOperationResponseConfig
Defined in
packages/loaders/json-schema/src/types.ts:40
JSONSchemaBaseOperationConfigWithJSONRequest
Ƭ JSONSchemaBaseOperationConfigWithJSONRequest: JSONSchemaBaseOperationConfig
& { requestBaseBody?
: any
; requestSample?
: any
; requestSchema?
: string
| JSONSchema
; requestTypeName?
: string
}
Defined in
packages/loaders/json-schema/src/types.ts:53
JSONSchemaHTTPBaseOperationConfig
Ƭ JSONSchemaHTTPBaseOperationConfig: JSONSchemaBaseOperationConfig
& { headers?
: Record
<string
, string
> ; method?
: HTTPMethod
; path
: string
}
Defined in
packages/loaders/json-schema/src/types.ts:62
JSONSchemaHTTPBinaryConfig
Ƭ JSONSchemaHTTPBinaryConfig: JSONSchemaHTTPBaseOperationConfig
& { binary
: true
; method?
: HTTPMethod
; path
: string
; requestTypeName?
: string
}
Defined in
packages/loaders/json-schema/src/types.ts:76
JSONSchemaHTTPJSONOperationConfig
Ƭ JSONSchemaHTTPJSONOperationConfig: JSONSchemaHTTPBaseOperationConfig
& JSONSchemaBaseOperationConfigWithJSONRequest
Defined in
packages/loaders/json-schema/src/types.ts:69
JSONSchemaOperationConfig
Ƭ JSONSchemaOperationConfig: JSONSchemaHTTPJSONOperationConfig
| JSONSchemaHTTPBinaryConfig
| JSONSchemaPubSubOperationConfig
Defined in
packages/loaders/json-schema/src/types.ts:83
JSONSchemaPubSubOperationConfig
Ƭ JSONSchemaPubSubOperationConfig: JSONSchemaBaseOperationConfigWithJSONRequest
& { pubsubTopic
: string
}
Defined in
packages/loaders/json-schema/src/types.ts:72
OperationHeadersConfiguration
Ƭ OperationHeadersConfiguration: Record
<string
, string
> | (data
: ResolverData
) => PromiseOrValue
<Record
<string
, string
>>
Defined in
packages/loaders/json-schema/src/types.ts:88
Variables
anySchema
• Const
anySchema: JSONSchemaObject
Defined in
packages/loaders/json-schema/src/getReferencedJSONSchemaFromOperations.ts:9
Functions
createBundle
▸ createBundle(name
, __namedParameters
): Promise
<JSONSchemaLoaderBundle
>
Parameters
Name | Type |
---|---|
name | string |
__namedParameters | JSONSchemaLoaderBundleOptions |
Returns
Promise
<JSONSchemaLoaderBundle
>
getComposerFromJSONSchema
▸ getComposerFromJSONSchema(schema
, logger
): Promise
<TypeComposers
>
Parameters
Name | Type |
---|---|
schema | JSONSchema |
logger | Logger |
Returns
Promise
<TypeComposers
>
getDereferencedJSONSchemaFromOperations
▸ getDereferencedJSONSchemaFromOperations(__namedParameters
): Promise
<JSONSchemaObject
>
Parameters
Name | Type |
---|---|
__namedParameters | Object |
__namedParameters.cwd | string |
__namedParameters.fetchFn | (input : URL | RequestInfo , init? : RequestInit ) => Promise <Response > |
__namedParameters.ignoreErrorResponses? | boolean |
__namedParameters.logger | Logger |
__namedParameters.noDeduplication? | boolean |
__namedParameters.operations | JSONSchemaOperationConfig [] |
__namedParameters.schemaHeaders? | Record <string , string > |
Returns
Promise
<JSONSchemaObject
>
getGraphQLSchemaFromBundle
▸ getGraphQLSchemaFromBundle(__namedParameters
, __namedParameters?
): Promise
<GraphQLSchema
>
Generates a local GraphQLSchema instance from previously generated JSON Schema bundle
Parameters
Name | Type |
---|---|
__namedParameters | JSONSchemaLoaderBundle |
__namedParameters | JSONSchemaLoaderBundleToGraphQLSchemaOptions |
Returns
Promise
<GraphQLSchema
>
getGraphQLSchemaFromDereferencedJSONSchema
▸ getGraphQLSchemaFromDereferencedJSONSchema(fullyDeferencedSchema
, __namedParameters
): Promise
<GraphQLSchema
>
Parameters
Name | Type |
---|---|
fullyDeferencedSchema | JSONSchemaObject |
__namedParameters | AddExecutionLogicToComposerOptions |
Returns
Promise
<GraphQLSchema
>
getReferencedJSONSchemaFromOperations
▸ getReferencedJSONSchemaFromOperations(__namedParameters
): Promise
<JSONSchemaObject
>
Parameters
Name | Type |
---|---|
__namedParameters | Object |
__namedParameters.cwd | string |
__namedParameters.fetchFn | (input : URL | RequestInfo , init? : RequestInit ) => Promise <Response > |
__namedParameters.ignoreErrorResponses? | boolean |
__namedParameters.logger? | Logger |
__namedParameters.operations | JSONSchemaOperationConfig [] |
__namedParameters.schemaHeaders? | Object |
Returns
Promise
<JSONSchemaObject
>
loadGraphQLSchemaFromJSONSchemas
▸ loadGraphQLSchemaFromJSONSchemas(name
, options
): Promise
<GraphQLSchema
>
Parameters
Name | Type |
---|---|
name | string |
options | JSONSchemaLoaderOptions |
Returns
Promise
<GraphQLSchema
>