@omnigraph/json-schema#
Table of contents#
References#
Interfaces#
- JSONSchemaBaseOperationConfig
- JSONSchemaBaseOperationConfigWithJSONRequest
- JSONSchemaHTTPBaseOperationConfig
- JSONSchemaHTTPBinaryConfig
- JSONSchemaHTTPJSONOperationConfig
- JSONSchemaLoaderBundle
- JSONSchemaLoaderBundleOptions
- JSONSchemaLoaderBundleToGraphQLSchemaOptions
- JSONSchemaLoaderOptions
- JSONSchemaPubSubOperationConfig
Type aliases#
Functions#
- createBundle
- getDereferencedJSONSchemaFromOperations
- getGraphQLSchemaFromBundle
- getGraphQLSchemaFromDereferencedJSONSchema
- loadGraphQLSchemaFromJSONSchemas
References#
loadGraphQLSchemaFromJSONSchemas#
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:36
JSONSchemaOperationConfig#
Ƭ JSONSchemaOperationConfig: JSONSchemaHTTPJSONOperationConfig | JSONSchemaHTTPBinaryConfig | JSONSchemaPubSubOperationConfig
Defined in#
packages/loaders/json-schema/src/types.ts:60
Functions#
createBundle#
▸ createBundle(name, __namedParameters): Promise<JSONSchemaLoaderBundle>
Parameters#
| Name | Type |
|---|---|
name | string |
__namedParameters | JSONSchemaLoaderBundleOptions |
Returns#
Promise<JSONSchemaLoaderBundle>
Defined in#
packages/loaders/json-schema/src/bundle.ts:30
getDereferencedJSONSchemaFromOperations#
▸ getDereferencedJSONSchemaFromOperations(__namedParameters): Promise<JSONSchemaObject>
Parameters#
| Name | Type |
|---|---|
__namedParameters | Object |
__namedParameters.cwd | string |
__namedParameters.fetch | (input: RequestInfo, init?: RequestInit) => Promise<Response> |
__namedParameters.logger | Logger |
__namedParameters.operations | JSONSchemaOperationConfig[] |
__namedParameters.schemaHeaders? | Record<string, string> |
Returns#
Promise<JSONSchemaObject>
Defined in#
packages/loaders/json-schema/src/getDereferencedJSONSchemaFromOperations.ts:8
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>
Defined in#
packages/loaders/json-schema/src/bundle.ts:74
getGraphQLSchemaFromDereferencedJSONSchema#
▸ getGraphQLSchemaFromDereferencedJSONSchema(fullyDeferencedSchema, __namedParameters): Promise<GraphQLSchema>
Parameters#
| Name | Type |
|---|---|
fullyDeferencedSchema | JSONSchemaObject |
__namedParameters | AddExecutionLogicToComposerOptions & { generateInterfaceFromSharedFields?: boolean } |
Returns#
Promise<GraphQLSchema>
Defined in#
packages/loaders/json-schema/src/getGraphQLSchemaFromDereferencedJSONSchema.ts:7
loadGraphQLSchemaFromJSONSchemas#
▸ loadGraphQLSchemaFromJSONSchemas(name, options): Promise<GraphQLSchema>
Parameters#
| Name | Type |
|---|---|
name | string |
options | JSONSchemaLoaderOptions |
Returns#
Promise<GraphQLSchema>
Defined in#
packages/loaders/json-schema/src/loadGraphQLSchemaFromJSONSchemas.ts:6