Your Apps in Action

Use this form to visualize JSON Schema for GraphQL Mesh config file.


{{repoTitle.MainEntity}}

.serve - ServeConfig
_

.serve.cors - CorsConfig
_

serve.cors.allowedHeaders allowedHeaders

# Values Actions
{{$index+1}}.
serve.cors.exposedHeaders exposedHeaders

# Values Actions
{{$index+1}}.
serve.handlers Express/Connect compatible handlers and middlewares extend GraphQL Mesh HTTP Server (Any of: WebhookHandler, ExpressHandler)

# Actions
{{$index+1}}.
.serve.upload - UploadOptions
_

.serve.sslCredentials - HTTPSConfig
_

.sdk - SDKConfig
_

.sdk.generateOperations - GenerateOperationsConfig
_

require require

# Values Actions
{{$index+1}}.
sources Defines the list of your external data sources for your API mesh

# name handler.graphql.endpoint handler.graphql.useGETForQueries handler.graphql.method handler.graphql.webSocketImpl handler.graphql.introspection handler.graphql.multipart handler.graphql.batch handler.graphql.subscriptionsProtocol handler.grpc.endpoint Actions
{{$index+1}}. {{row.name}} {{row.handler.graphql.endpoint}} {{row.handler.graphql.useGETForQueriesSelected.DisplayText}} {{row.handler.graphql.method}} {{row.handler.graphql.webSocketImpl}} {{row.handler.graphql.introspection}} {{row.handler.graphql.multipartSelected.DisplayText}} {{row.handler.graphql.batchSelected.DisplayText}} {{row.handler.graphql.subscriptionsProtocol}} {{row.handler.grpc.endpoint}}    
transforms Transform to apply to the unified mesh schema

# encapsulate.name encapsulate.applyTo.query encapsulate.applyTo.mutation encapsulate.applyTo.subscription mock.if mock.preserveResolvers namingConvention.typeNames namingConvention.fieldNames namingConvention.enumValues prefix.mode Actions
{{$index+1}}. {{row.encapsulate.name}} {{row.encapsulate.applyTo.querySelected.DisplayText}} {{row.encapsulate.applyTo.mutationSelected.DisplayText}} {{row.encapsulate.applyTo.subscriptionSelected.DisplayText}} {{row.mock.ifSelected.DisplayText}} {{row.mock.preserveResolversSelected.DisplayText}} {{row.namingConvention.typeNames}} {{row.namingConvention.fieldNames}} {{row.namingConvention.enumValues}} {{row.prefix.mode}}    
additionalResolvers Additional resolvers, or resolvers overrides you wish to add to the schema mesh (Any of: String, AdditionalStitchingResolverObject, AdditionalStitchingBatchResolverObject, AdditionalSubscriptionObject)

# Actions
{{$index+1}}.
.cache - Cache
_

.cache.file - FileCacheConfig
_

.cache.inmemoryLRU - InMemoryLRUConfig
_

.cache.localforage - LocalforageConfig
_

cache.localforage.driver Allowed values: WEBSQL, INDEXEDDB, LOCALSTORAGE

# Values Actions
{{$index+1}}.
.cache.redis - RedisConfig
_

liveQueryInvalidations Live Query Invalidations

# field Actions
{{$index+1}}. {{row.field}}    
documents Provide a query or queries for GraphQL Playground, validation and SDK Generation The value can be the file path, glob expression for the file paths or the SDL. (.js, .jsx, .graphql, .gql, .ts and .tsx files are supported. But TypeScript support is only available if `ts-node` is installed and `ts-node/register` is added under `require` parameter)

# Values Actions
{{$index+1}}.
{{repoTitle.MainEntity}}

.handler - Handler
_sources

.handler.graphql - GraphQLHandler
_sources

.handler.graphql.operationHeaders
_sources

.handler.grpc - GrpcHandler
_sources

.handler.grpc.credentialsSsl - GrpcCredentialsSsl
_sources

.handler.grpc.metaData
_sources

.handler.JsonSchema - JsonSchemaHandler
_sources

.handler.JsonSchema.operationHeaders
_sources

.handler.JsonSchema.schemaHeaders
_sources

handler.JsonSchema.operations Any of: JsonSchemaHTTPOperation, JsonSchemaPubSubOperation

# Actions
{{$index+1}}.
.handler.mongoose - MongooseHandler
_sources

handler.mongoose.models models

# name path options.name options.description options.inputType.name options.inputType.description Actions
{{$index+1}}. {{row.name}} {{row.path}} {{row.options.name}} {{row.options.description}} {{row.options.inputType.name}} {{row.options.inputType.description}}    
handler.mongoose.discriminators discriminators

# name path options.name options.description options.inputType.name options.inputType.description Actions
{{$index+1}}. {{row.name}} {{row.path}} {{row.options.name}} {{row.options.description}} {{row.options.inputType.name}} {{row.options.inputType.description}}    
.handler.mysql - MySQLHandler
_sources

handler.mysql.tables Use specific tables for your schema

# Values Actions
{{$index+1}}.
handler.mysql.tableFields Use specific fields of specific tables

# table Actions
{{$index+1}}. {{row.table}}    
.handler.neo4j - Neo4jHandler
_sources

.handler.odata - ODataHandler
_sources

.handler.odata.operationHeaders
_sources

.handler.odata.schemaHeaders
_sources

.handler.openapi - OpenapiHandler
_sources

.handler.openapi.operationHeaders
_sources

.handler.openapi.schemaHeaders
_sources

.handler.openapi.qs
_sources

handler.openapi.selectQueryOrMutationField Allows to explicitly override the default operation (Query or Mutation) for any OAS operation

# title path type method Actions
{{$index+1}}.
.handler.postgraphile - PostGraphileHandler
_sources

handler.postgraphile.schemaName An array of strings which specifies the PostgreSQL schemas that PostGraphile will use to create a GraphQL schema. The default schema is the public schema.

# Values Actions
{{$index+1}}.
handler.postgraphile.appendPlugins Extra Postgraphile Plugins to append

# Values Actions
{{$index+1}}.
handler.postgraphile.skipPlugins Postgraphile Plugins to skip (e.g. "graphile-build#NodePlugin")

# Values Actions
{{$index+1}}.
.handler.soap - SoapHandler
_sources

.handler.soap.basicAuth - SoapSecurityBasicAuthConfig
_sources

.handler.soap.securityCert - SoapSecurityCertificateConfig
_sources

.handler.soap.operationHeaders
_sources

.handler.thrift - ThriftHandler
_sources

.handler.thrift.operationHeaders
_sources

.handler.thrift.schemaHeaders
_sources

.handler.tuql - TuqlHandler
_sources

transforms List of transforms to apply to the current API source, before unifying it with the rest of the sources

# encapsulate.name encapsulate.applyTo.query encapsulate.applyTo.mutation encapsulate.applyTo.subscription mock.if mock.preserveResolvers namingConvention.typeNames namingConvention.fieldNames namingConvention.enumValues prefix.mode Actions
{{$index+1}}. {{row.encapsulate.name}} {{row.encapsulate.applyTo.querySelected.DisplayText}} {{row.encapsulate.applyTo.mutationSelected.DisplayText}} {{row.encapsulate.applyTo.subscriptionSelected.DisplayText}} {{row.mock.ifSelected.DisplayText}} {{row.mock.preserveResolversSelected.DisplayText}} {{row.namingConvention.typeNames}} {{row.namingConvention.fieldNames}} {{row.namingConvention.enumValues}} {{row.prefix.mode}}    
{{repoTitle.MainEntity}}

.options - ComposeWithMongooseOpts
_handler_mongoose_models

.options.fields - ComposeWithMongooseFieldsOpts
_handler_mongoose_models

options.fields.only only

# Values Actions
{{$index+1}}.
options.fields.remove remove

# Values Actions
{{$index+1}}.
options.fields.required required

# Values Actions
{{$index+1}}.
.options.inputType - ComposeMongooseInputType
_handler_mongoose_models

.options.inputType.fields - ComposeWithMongooseFieldsOpts
_handler_mongoose_models

options.inputType.fields.only only

# Values Actions
{{$index+1}}.
options.inputType.fields.remove remove

# Values Actions
{{$index+1}}.
options.inputType.fields.required required

# Values Actions
{{$index+1}}.
.options.inputType.resolvers - TypeConverterResolversOpts
_handler_mongoose_models

.options.resolvers - TypeConverterResolversOpts
_handler_mongoose_models

{{repoTitle.MainEntity}}

.options - ComposeWithMongooseOpts
_handler_mongoose_discriminators

.options.fields - ComposeWithMongooseFieldsOpts
_handler_mongoose_discriminators

options.fields.only only

# Values Actions
{{$index+1}}.
options.fields.remove remove

# Values Actions
{{$index+1}}.
options.fields.required required

# Values Actions
{{$index+1}}.
.options.inputType - ComposeMongooseInputType
_handler_mongoose_discriminators

.options.inputType.fields - ComposeWithMongooseFieldsOpts
_handler_mongoose_discriminators

options.inputType.fields.only only

# Values Actions
{{$index+1}}.
options.inputType.fields.remove remove

# Values Actions
{{$index+1}}.
options.inputType.fields.required required

# Values Actions
{{$index+1}}.
.options.inputType.resolvers - TypeConverterResolversOpts
_handler_mongoose_discriminators

.options.resolvers - TypeConverterResolversOpts
_handler_mongoose_discriminators

{{repoTitle.MainEntity}}

fields fields

# Values Actions
{{$index+1}}.
{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

cache Transformer to apply caching for your data sources

# field cacheKey invalidate.ttl Actions
{{$index+1}}. {{row.field}} {{row.cacheKey}} {{row.invalidate.ttl}}    
.encapsulate - EncapsulateTransformObject
_transforms

.encapsulate.applyTo - EncapsulateTransformApplyTo
_transforms

.extend - ExtendTransform
_transforms

.federation - FederationTransform
_transforms

federation.types types

# name config.extend Actions
{{$index+1}}. {{row.name}} {{row.config.extendSelected.DisplayText}}    
.mock - MockingConfig
_transforms

mock.mocks Mock configurations

# apply if faker custom length store.type store.key store.fieldName Actions
{{$index+1}}. {{row.apply}} {{row.ifSelected.DisplayText}} {{row.faker}} {{row.custom}} {{row.length}} {{row.store.type}} {{row.store.key}} {{row.store.fieldName}}    
.namingConvention - NamingConventionTransformConfig
_transforms

.prefix - PrefixTransformConfig
_transforms

prefix.ignore List of ignored types

# Values Actions
{{$index+1}}.
.replaceField - ReplaceFieldTransformConfig
_transforms

replaceField.replacements Array of rules to replace fields

# from.type from.field to.type to.field scope name Actions
{{$index+1}}. {{row.from.type}} {{row.from.field}} {{row.to.type}} {{row.to.field}} {{row.scope}} {{row.name}}    
.snapshot - SnapshotTransformConfig
_transforms

snapshot.apply Resolver to be applied For example; apply: - Query.* <- * will apply this extension to all fields of Query type - Mutation.someMutationButProbablyYouWontNeedIt

# Values Actions
{{$index+1}}.
.typeMerging - TypeMergingConfig
_transforms

typeMerging.types types

# typeName key.selectionSet canonical Actions
{{$index+1}}. {{row.typeName}} {{row.key.selectionSet}} {{row.canonicalSelected.DisplayText}}    
typeMerging.queryFields Denotes a root field used to query a merged type across services. The marked field's name is analogous to the fieldName setting in [merged type configuration](https://www.graphql-tools.com/docs/stitch-type-merging#basic-example), while the field's arguments and return type are used to infer merge configuration. Directive arguments tune the merge behavior

# queryFieldName keyField keyArg additionalArgs argsExpr Actions
{{$index+1}}. {{row.queryFieldName}} {{row.keyField}} {{row.keyArg}} {{row.additionalArgs}} {{row.argsExpr}}    
{{repoTitle.MainEntity}}

.invalidate - CacheInvalidateConfig
_cache

invalidate.effectingOperations Invalidate the cache when a specific operation is done without an error

# operation matchKey Actions
{{$index+1}}.
{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

.config - FederationObjectConfig
_federation_types

config.keyFields keyFields

# Values Actions
{{$index+1}}.
config.fields fields

# name config.external config.provides config.requires Actions
{{$index+1}}.
{{repoTitle.MainEntity}}

.config - FederationFieldConfig
_config_fields

{{repoTitle.MainEntity}}

.store - GetFromMockStoreConfig
_mock_mocks

updateStore Update the data on the mock store

# type key fieldName value Actions
{{$index+1}}.
{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

.key - KeyAnnotation
_typeMerging_types

fields fields

# Values Actions
{{$index+1}}.
{{repoTitle.MainEntity}}

key Advanced use only; Allows building a custom key just for the argument from the selectionSet included by the `@key` directive.

# Values Actions
{{$index+1}}.
{{repoTitle.MainEntity}}

invalidate invalidate

# Values Actions
{{$index+1}}.

{{message}}