schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
fossa-deps.schema.json
version
Version of the dependency. It informs FOSSA which version of the dependency to scan. If not provided, latest version will be used.
{"type": "string"}
fossa-deps.schema.json
arch
Architecture associated with this package
{"type": "string", "minLength": 1}
fossa-deps.schema.json
epoch
Epoch associated with version (if any).
{"type": "string", "minLength": 1}
fossa-deps.schema.json
osVersion
Version of the distribution OS.
{"type": "string", "minLength": 1}
fossa-deps.schema.json
name
Name of the dependency. This will be the name used in FOSSA's dashboard.
{"type": "string", "minLength": 1}
fossa-deps.schema.json
version
Version of the dependency. This will be the version used in FOSSA's dashboard.
{"type": "string", "minLength": 1}
fossa-deps.schema.json
license
License of the dependency. This string will be used to infer license type.
{"type": "string", "minLength": 1}
fossa-deps.schema.json
description
Description of the dependency (if any)
{"type": "string"}
fossa-deps.schema.json
homepage
Homepage of the dependency. This should be web address.
{"type": "string"}
fossa-deps.schema.json
name
Name of the dependency. This will be the name associated with this vendored dependency in FOSSA's dashboard
{"type": "string", "minLength": 1}
fossa-deps.schema.json
path
Path to directory, which will be archived and upload to provided endpoint for license scanning.
{"type": "string", "minLength": 1}
fossa-deps.schema.json
version
Version of the dependency. This will be the version associated with this vendored dependency in FOSSA's dashboard
{"type": "string"}
fossa-deps.schema.json
name
Name of the dependency. This will be the version used in FOSSA's dashboard.
{"type": "string", "minLength": 1}
fossa-deps.schema.json
url
Url of the dependency's source code. This will be the downloaded by FOSSA for scanning with the analysis.
{"type": "string", "minLength": 1}
fossa-deps.schema.json
version
Version of the dependency.
{"type": "string"}
fossa-deps.schema.json
description
Description of the dependency (if any)
{"type": "string"}
fossa-deps.schema.json
homepage
Homepage of the dependency. This should be web address.
{"type": "string"}
fossa-deps.schema.json
referenced-dependencies
Reference dependency to locate from registry and include it project's dependency and license scanning.
{"type": "array", "items": {}}
fossa-deps.schema.json
custom-dependencies
Custom dependency and their license for project
{"type": "array", "items": {}}
fossa-deps.schema.json
vendored-dependencies
Local dependencies upload to server for license scanning
{"type": "array", "items": {}}
fossa-deps.schema.json
remote-dependencies
Remote dependencies to license scanning
{"type": "array", "items": {}}
config-schema.json
namespace
The name of the Workers KV namespace to use for caching. Make sure you have configured the following namespace described in [here](https://developers.cloudflare.com/workers/wrangler/cli-wrangler/commands/#kv).
{"type": "string"}
config-schema.json
driver
Allowed values: WEBSQL, INDEXEDDB, LOCALSTORAGE
{"type": "array", "items": {"type": "string", "enum": ["WEBSQL", "INDEXEDDB", "LOCALSTORAGE"]}, "additionalItems": false}
config-schema.json
items
Allowed values: WEBSQL, INDEXEDDB, LOCALSTORAGE
{"type": "string", "enum": ["WEBSQL", "INDEXEDDB", "LOCALSTORAGE"]}
config-schema.json
fork
Spawn multiple server instances as node clusters (default: `1`) (Any of: Int, Boolean)
{"anyOf": [{"type": "integer"}, {"type": "boolean"}]}
config-schema.json
port
TCP Port to listen (default: `4000`) (Any of: Int, String)
{"anyOf": [{"type": "integer"}, {"type": "string"}]}
config-schema.json
hostname
The binding hostname (default: `localhost`)
{"type": "string"}
config-schema.json
cors
Configuration for CORS
{}
config-schema.json
staticFiles
Path to your static files you want to be served with GraphQL Mesh HTTP Server
{"type": "string"}
config-schema.json
playground
Show GraphiQL Playground
{"type": "boolean"}
config-schema.json
sslCredentials
SSL Credentials for HTTPS Server If this is provided, Mesh will be served via HTTPS
{}
config-schema.json
endpoint
Path to GraphQL Endpoint (default: /graphql)
{"type": "string"}
config-schema.json
browser
Path to the browser that will be used by `mesh serve` to open a playground window in development mode This feature can be disabled by passing `false` (Any of: String, Boolean)
{"anyOf": [{"type": "string"}, {"type": "boolean"}]}
config-schema.json
playgroundTitle
Title of GraphiQL Playground
{"type": "string"}
config-schema.json
trustProxy
Configure Express Proxy Handling [Learn more](https://expressjs.com/en/guide/behind-proxies.html)
{"type": "string"}
config-schema.json
batchingLimit
Enable and define a limit for [Request Batching](https://github.com/graphql/graphql-over-http/blob/main/rfcs/Batching.md)
{"type": "integer"}
config-schema.json
generateOperations
Use this only if you don't want to use `documents` for SDK, and let Mesh generate them for you
{}
config-schema.json
name
The name you wish to set to your remote API, this will be used for building the GraphQL context
{"type": "string"}
config-schema.json
handler
Point to the handler you wish to use, it can either be a predefined handler, or a custom
{}
config-schema.json
transforms
List of transforms to apply to the current API source, before unifying it with the rest of the sources
{"type": "array", "items": {}, "additionalItems": false}
config-schema.json
cache
Transformer to apply caching for your data sources
{"type": "array", "items": {}, "additionalItems": false}
config-schema.json
encapsulate
Transformer to apply encapsulation to the API source, by creating a field for it under the root query
{}
config-schema.json
filterSchema
Transformer to filter (white/black list) GraphQL types, fields and arguments (Any of: FilterSchemaTransform, Any)
{"anyOf": [{}, {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]}]}
config-schema.json
hoistField
Transformer to hoist GraphQL fields
{"type": "array", "items": {}, "additionalItems": false}
config-schema.json
namingConvention
Transformer to apply naming convention to GraphQL Types
{}
config-schema.json
prefix
Prefix transform
{}
config-schema.json
prune
Prune transform
{}
config-schema.json
rateLimit
RateLimit transform
{"type": "array", "items": {}, "additionalItems": false}
config-schema.json
rename
Transformer to rename GraphQL types and fields (Any of: RenameTransform, Any)
{"anyOf": [{}, {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]}]}
config-schema.json
replaceField
Transformer to replace GraphQL field with partial of full config from a different field
{}
config-schema.json
resolversComposition
Transformer to apply composition to resolvers (Any of: ResolversCompositionTransform, Any)
{"anyOf": [{}, {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]}]}
config-schema.json
transferSchema
Transformer to transfer (move or copy) GraphQL parts of GraphQL schema across Types and Fields
{}
config-schema.json
typeMerging
[Type Merging](https://www.graphql-tools.com/docs/stitch-type-merging) Configuration
{}
config-schema.json
graphql
Handler for remote/local/third-party GraphQL schema (Any of: GraphQLHandlerHTTPConfiguration, GraphQLHandlerCodeFirstConfiguration, GraphQLHandlerMultipleHTTPConfiguration)
{"anyOf": [{}, {}, {}]}
config-schema.json
grpc
Handler for gRPC and Protobuf schemas
{}
config-schema.json
jsonSchema
Handler for JSON Schema specification. Source could be a local json file, or a url to it.
{}
config-schema.json
neo4j
Handler for Neo4j
{}
config-schema.json
odata
Handler for OData
{}
config-schema.json
openapi
Handler for Swagger / OpenAPI 2/3 specification. Source could be a local json/swagger file, or a url to it.
{}
config-schema.json
postgraphile
Handler for Postgres database, based on `postgraphile`
{}
config-schema.json
soap
Handler for SOAP
{}
config-schema.json
thrift
Handler for OData
{}
config-schema.json
tuql
Handler for SQLite database, based on `tuql`
{}
config-schema.json
mock
Mock configuration for your source
{}
config-schema.json
rateLimit
RateLimit plugin
{}
config-schema.json
snapshot
Configuration for Snapshot extension
{}
config-schema.json
result
Extract specific property from the result
{"type": "string"}
config-schema.json
resultType
If return types don't match, you can specify a result type to apply inline fragment
{"type": "string"}
config-schema.json
result
Extract specific property from the result
{"type": "string"}
config-schema.json
resultType
If return types don't match, you can specify a result type to apply inline fragment
{"type": "string"}
config-schema.json
sources
HTTP Source Configurations
{"type": "array", "items": {}, "additionalItems": false}
config-schema.json
strategy
Handling strategy (default: fallback) (Allowed values: fallback, race, highestValue)
{"type": "string", "enum": ["fallback", "race", "highestValue"]}
config-schema.json
strategyConfig
Handling strategy configuration
{}
config-schema.json
source
A file path to your GraphQL Schema If you provide a path to a code file(js or ts), other options will be ignored and the schema exported from the file will be used directly.
{"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]}
config-schema.json
endpoint
A url or file path to your remote GraphQL endpoint. If you provide a path to a code file(js or ts), other options will be ignored and the schema exported from the file will be used directly.
{"type": "string"}
config-schema.json
schemaHeaders
JSON object representing the Headers to add to the runtime of the API calls only for schema introspection
{"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]}
config-schema.json
operationHeaders
JSON object representing the Headers to add to the runtime of the API calls only for operation during runtime
{"type": "object", "properties": {}}
config-schema.json
useGETForQueries
Use HTTP GET for Query operations
{"type": "boolean"}
config-schema.json
method
HTTP method used for GraphQL operations (Allowed values: GET, POST)
{"type": "string", "enum": ["GET", "POST"]}
config-schema.json
credentials
Request Credentials if your environment supports it. [See more](https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials) @default "same-origin" (Allowed values: omit, include)
{"type": "string", "enum": ["omit", "include"]}
config-schema.json
webSocketImpl
Path to a custom W3 Compatible WebSocket Implementation
{"type": "string"}
config-schema.json
source
Path to the introspection You can separately give schema introspection or SDL
{"type": "string"}
config-schema.json
subscriptionsProtocol
SSE - Server Sent Events WS - New graphql-ws LEGACY_WS - Legacy subscriptions-transport-ws (Allowed values: SSE, WS, LEGACY_WS)
{"type": "string", "enum": ["SSE", "WS", "LEGACY_WS"]}
config-schema.json
subscriptionsEndpoint
URL to your endpoint serving all subscription queries for this source
{"type": "string"}
config-schema.json
retry
Retry attempts if fails
{"type": "integer"}
config-schema.json
timeout
Timeout in milliseconds
{"type": "integer"}
config-schema.json
batch
Enable/Disable automatic query batching
{"type": "boolean"}
config-schema.json
connectionParams
JSON object representing the `connectionParams` from a WebSocket connection to add to the runtime of the API calls only for operation during runtime. More information about the WebSocket `connectionParams`: - When using `subscriptionsProtocol=WS` (graphql-ws): https://github.com/enisdenjo/graphql-ws/blob/master/docs/interfaces/client.ClientOptions.md#connectionparams - When using `subscriptionsProtocol=LEGACY_WS` (subscriptions-transport-ws): https://github.com/apollographql/subscriptions-transport-ws/blob/51270cc7dbaf09c7b9aa67368f1de58148c7d334/README.md#subscriptionclient
{"type": "object", "properties": {}}
config-schema.json
endpoint
gRPC Endpoint
{"type": "string"}
config-schema.json
source
gRPC Proto file that contains your protobuf schema OR Use a binary-encoded or JSON file descriptor set file (Any of: ProtoFilePath, String)
{"anyOf": [{}, {"type": "string"}]}
config-schema.json
requestTimeout
Request timeout in milliseconds Default: 200000
{"type": "integer"}
config-schema.json
credentialsSsl
SSL Credentials
{}
config-schema.json
useHTTPS
Use https instead of http for gRPC connection
{"type": "boolean"}
config-schema.json
metaData
MetaData
{"type": "object", "properties": {}}
config-schema.json
prefixQueryMethod
prefix to collect Query method default: list, get
{"type": "array", "items": {"type": "string"}, "additionalItems": false}
config-schema.json
indices
When arrays are stringified, by default they are not given explicit indices: `a=b&a=c&a=d` You may override this by setting the indices option to true: `a[0]=b&a[1]=c&a[2]=d`
{"type": "boolean"}
config-schema.json
arrayFormat
You can configure how to format arrays in the query strings. Note: when using arrayFormat set to 'comma', you can also pass the commaRoundTrip option set to true or false, to append [] on single-item arrays, so that they can round trip through a parse. (Allowed values: indices, brackets, repeat, comma)
{"type": "string", "enum": ["indices", "brackets", "repeat", "comma"]}
config-schema.json
commaRoundTrip
Even if there is a single item in an array, this option treats them as arrays (default: false)
{"type": "boolean"}
config-schema.json
source
Path to the bundle file
{"type": "string"}
config-schema.json
operations
Any of: JsonSchemaHTTPOperation, JsonSchemaPubSubOperation
{"type": "array", "items": {"anyOf": [{}, {}]}, "additionalItems": false}