schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
config-schema.json | invalidations | Invalidate a query or queries when a specific operation is done without an error | {"type": "array", "items": {}, "additionalItems": false} |
config-schema.json | resourceIdentifier | Custom strategy for building resources identifiers
By default resource identifiers are built by concatenating the Typename with the id separated by a color (`User:1`).
This may be useful if you are using a relay compliant schema and the Typename information is not required for building a unique topic.
Default: "{typename}:{id}" | {"type": "string"} |
config-schema.json | includeIdentifierExtension | Whether the extensions should include a list of all resource identifiers for the latest operation result.
Any of those can be used for invalidating and re-scheduling the operation execution.
This is mainly useful for discovering and learning what kind of topics a given query will subscribe to.
The default value is `true` if `DEBUG` environment variable is set | {"type": "boolean"} |
config-schema.json | idFieldName | Identifier unique field
Default: "id" | {"type": "string"} |
config-schema.json | indexBy | Specify which fields should be indexed for specific invalidations. | {"type": "array", "items": {}, "additionalItems": false} |
config-schema.json | field | Path to the operation that could effect it. In a form: Mutation.something. Note that wildcard is not supported in this field. | {"type": "string"} |
config-schema.json | if | If this expression is truthy, mocking would be enabled
You can use environment variables expression, for example: `process.env.MOCKING_ENABLED != null` | {"type": "boolean"} |
config-schema.json | preserveResolvers | Do not mock any other resolvers other than defined in `mocks`.
For example, you can enable this if you don't want to mock entire schema but partially. | {"type": "boolean"} |
config-schema.json | mocks | Mock configurations | {"type": "array", "items": {}, "additionalItems": false} |
config-schema.json | initializeStore | The path to the code runs before the store is attached to the schema | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | apply | Resolver path
Example: User.firstName | {"type": "string"} |
config-schema.json | if | If this expression is truthy, mocking would be enabled
You can use environment variables expression, for example: `${MOCKING_ENABLED}` | {"type": "boolean"} |
config-schema.json | faker | Faker.js expression or function
Read more (https://github.com/marak/Faker.js/#fakerfake)
Example:
faker: `name.firstName`
faker: `{{ name.firstName }} {{ name.lastName }}` | {"type": "string"} |
config-schema.json | custom | Custom mocking
It can be a module or json file.
Both "moduleName#exportName" or only "moduleName" would work | {"type": "string"} |
config-schema.json | length | Length of the mock list
For the list types `[ObjectType]`, how many `ObjectType` you want to return?
default: 2 | {"type": "integer"} |
config-schema.json | store | Get the data from the mock store | {} |
config-schema.json | updateStore | Update the data on the mock store | {"type": "array", "items": {}, "additionalItems": false} |
config-schema.json | includeOperationDocument | default `false`. When set to `true`, includes the GraphQL document defining the operations and fragments | {"type": "boolean"} |
config-schema.json | includeExecuteVariables | default `false`. When set to `true`, includes all the operation variables with their values | {"type": "boolean"} |
config-schema.json | includeRawResult | default: `false`. When set to `true`, includes the execution result of both delegation and execution | {"type": "boolean"} |
config-schema.json | trackResolvers | default `false`. When set to `true`, track resolvers as segments to monitor their performance | {"type": "boolean"} |
config-schema.json | includeResolverArgs | default `false`. When set to `true`, includes all the arguments passed to resolvers and delegation with their values | {"type": "boolean"} |
config-schema.json | rootFieldsNaming | default `false`. When set to `true` append the names of operation root fields to the transaction name | {"type": "boolean"} |
config-schema.json | extractOperationName | Allows to set a custom operation name to be used as transaction name and attribute
`extractOperationName: {context.headers['x-operation-name']}` | {"type": "string"} |
config-schema.json | requestCount | Any of: Boolean, String | {"anyOf": [{"type": "boolean"}, {"type": "string"}]} |
config-schema.json | requestTotalDuration | Any of: Boolean, String | {"anyOf": [{"type": "boolean"}, {"type": "string"}]} |
config-schema.json | requestSummary | Any of: Boolean, String | {"anyOf": [{"type": "boolean"}, {"type": "string"}]} |
config-schema.json | parse | Any of: Boolean, String | {"anyOf": [{"type": "boolean"}, {"type": "string"}]} |
config-schema.json | validate | Any of: Boolean, String | {"anyOf": [{"type": "boolean"}, {"type": "string"}]} |
config-schema.json | contextBuilding | Any of: Boolean, String | {"anyOf": [{"type": "boolean"}, {"type": "string"}]} |
config-schema.json | execute | Any of: Boolean, String | {"anyOf": [{"type": "boolean"}, {"type": "string"}]} |
config-schema.json | errors | Any of: Boolean, String | {"anyOf": [{"type": "boolean"}, {"type": "string"}]} |
config-schema.json | deprecatedFields | Any of: Boolean, String | {"anyOf": [{"type": "boolean"}, {"type": "string"}]} |
config-schema.json | delegation | Any of: Boolean, String | {"anyOf": [{"type": "boolean"}, {"type": "string"}]} |
config-schema.json | fetch | Any of: Boolean, String | {"anyOf": [{"type": "boolean"}, {"type": "string"}]} |
config-schema.json | http | Any of: Boolean, String | {"anyOf": [{"type": "boolean"}, {"type": "string"}]} |
config-schema.json | endpoint | The path to the metrics endpoint
default: `/metrics` | {"type": "string"} |
config-schema.json | ttl | Maximum age in ms. Defaults to `Infinity`. Set it to 0 for disabling the global TTL. | {"type": "number"} |
config-schema.json | ttlPerCoordinate | Overwrite the ttl for query operations whose selection contains a specific schema coordinate (e.g. Query.users).
Useful if the selection of a specific field should reduce the TTL of the query operation. | {"type": "array", "items": {}, "additionalItems": false} |
config-schema.json | ignoredTypes | Skip caching of following the types. | {"type": "array", "items": {"type": "string"}, "additionalItems": false} |
config-schema.json | idFields | List of fields that are used to identify the entity. | {"type": "array", "items": {"type": "string"}, "additionalItems": false} |
config-schema.json | invalidateViaMutation | Whether the mutation execution result should be used for invalidating resources.
Defaults to `true` | {"type": "boolean"} |
config-schema.json | includeExtensionMetadata | Include extension values that provide useful information, such as whether the cache was hit or which resources a mutation invalidated. | {"type": "boolean"} |
config-schema.json | sessionId | Allows to cache responses based on the resolved session id.
Return a unique value for each session.
Creates a global session by default.
Example;
```yaml
sessionId: "{context.headers.userId}"
``` | {"type": "string"} |
config-schema.json | if | Specify whether the cache should be used based on the context.
```yaml
if: "context.headers.userId != null"
``` | {"type": "string"} |
config-schema.json | cacheKey | Customize the behavior how the response cache key is computed from the documentString, variableValues, contextValue and sessionId.
If the given string is interpolated as empty, default behavior is used.
Example;
```yaml
# Cache by specific value
cacheKey: "{variableValues.userId}"
# Cache by documentString
cacheKey: "{documentString}"
# Cache by operationName
cacheKey: "{operationName}"
# Cache by some header value
cacheKey: "{contextValue.headers.authorization}"
# Or combine two of each
cacheKey: "{contextValue.headers.authorization}-{operationName}"
``` | {"type": "string"} |
config-schema.json | shouldCacheResult | Checks if the result should be cached.
```yaml
shouldCacheResult: "result.errors.length > 0"
``` | {"type": "string"} |
config-schema.json | if | Expression for when to activate this extension.
Value can be a valid JS expression string or a boolean (Any of: String, Boolean) | {"anyOf": [{"type": "string"}, {"type": "boolean"}]} |
config-schema.json | apply | HTTP URL pattern to be applied
For example;
apply:
- http://my-remote-api.com/* \<- * will apply this extension to all paths of remote API | {"type": "array", "items": {"type": "string"}, "additionalItems": false} |
config-schema.json | outputDir | Path to the directory of the generated snapshot files | {"type": "string"} |
config-schema.json | skipIntrospection | If you wish to disable introspection for logging (default: false) | {"type": "boolean"} |
config-schema.json | prefix | prefix.operations.count (default: graphql) | {"type": "string"} |
config-schema.json | client | Client Configuration | {} |
config-schema.json | protocol | Allowed values: tcp, udp, uds, stream | {"type": "string", "enum": ["tcp", "udp", "uds", "stream"]} |
config-schema.json | connectionString | A connection string to your Postgres database | {"type": "string"} |
config-schema.json | 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. | {"type": "array", "items": {"type": "string"}, "additionalItems": false} |
config-schema.json | pool | Connection Pool instance or settings or you can provide the path of a code file that exports any of those | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | appendPlugins | Extra Postgraphile Plugins to append | {"type": "array", "items": {"type": "string"}, "additionalItems": false} |
config-schema.json | skipPlugins | Postgraphile Plugins to skip (e.g. "graphile-build#NodePlugin") | {"type": "array", "items": {"type": "string"}, "additionalItems": false} |
config-schema.json | options | Extra Postgraphile options that will be added to the postgraphile constructor. It can either be an object or a string pointing to the object's path (e.g. "./my-config#options"). See the [postgraphile docs](https://www.graphile.org/postgraphile/usage-library/) for more information. (Any of: JSON, String) | {"anyOf": [{"type": "object", "properties": {}}, {"type": "string"}]} |
config-schema.json | subscriptions | Enable GraphQL websocket transport support for subscriptions (default: true) | {"type": "boolean"} |
config-schema.json | live | Enables live-query support via GraphQL subscriptions (sends updated payload any time nested collections/records change) (default: true) | {"type": "boolean"} |
config-schema.json | contextOptions | A file that exports a function which takes context as a paramter and returns postgraphile context options (e.g. "./my-function#pgSettings"). See the [postgraphile docs](https://www.graphile.org/postgraphile/usage-schema/) for more information. | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | timeout | Timeout for the HTTP request in milliseconds | {"type": "integer"} |
config-schema.json | type | Allowed values: query, mutation, Query, Mutation | {"type": "string", "enum": ["query", "mutation", "Query", "Mutation"]} |
config-schema.json | source | A url to your WSDL or generated SDL with annotations | {"type": "string"} |
config-schema.json | schemaHeaders | JSON object representing the Headers to add to the runtime of the API calls only for schema introspection
You can also provide `.js` or `.ts` file path that exports schemaHeaders as an object | {"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 | source | A file path to your Supergraph 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. | {"type": "string"} |
config-schema.json | hostName | The name of the host to connect to. | {"type": "string"} |
config-schema.json | port | The port number to attach to on the host. | {"type": "integer"} |
config-schema.json | path | The path on which the Thrift service is listening. Defaults to '/thrift'. | {"type": "string"} |
config-schema.json | https | Boolean value indicating whether to use https. Defaults to false. | {"type": "boolean"} |
config-schema.json | protocol | Name of the Thrift protocol type to use. Defaults to 'binary'. (Allowed values: binary, compact, json) | {"type": "string", "enum": ["binary", "compact", "json"]} |
config-schema.json | serviceName | The name of your service. Used for logging. | {"type": "string"} |
config-schema.json | operationHeaders | JSON object representing the Headers to add to the runtime of the API calls | {"type": "object", "properties": {}} |
config-schema.json | schemaHeaders | If you are using a remote URL endpoint to fetch your schema, you can set headers for the HTTP request to fetch your schema. | {"type": "object", "properties": {}} |
config-schema.json | idl | Path to IDL file | {"type": "string"} |
config-schema.json | field | The type and field to apply cache to, you can use wild cards as well, for example: `Query.*` | {"type": "string"} |
config-schema.json | cacheKey | Cache key to use to store your resolvers responses.
The default is: `{typeName}-{fieldName}-{argsHash}-{fieldNamesHash}`
Available variables:
- `{args.argName}` - use resolver argument
- `{typeName}` - use name of the type
- `{fieldName}` - use name of the field
- `{argsHash}` - a hash based on the 'args' object
- `{fieldNamesHash}` - a hash based on the field names selected by the client
- `{info}` - the GraphQLResolveInfo of the resolver
Available interpolations:
- `{format|date}` - returns the current date with a specific format | {"type": "string"} |
config-schema.json | invalidate | Invalidation rules | {} |
config-schema.json | effectingOperations | Invalidate the cache when a specific operation is done without an error | {"type": "array", "items": {}, "additionalItems": false} |
config-schema.json | ttl | Specified in seconds, the time-to-live (TTL) value limits the lifespan | {"type": "integer"} |
config-schema.json | operation | Path to the operation that could effect it. In a form: Mutation.something. Note that wildcard is not supported in this field. | {"type": "string"} |
config-schema.json | matchKey | Cache key to invalidate on successful resolver (no error), see `cacheKey` for list of available options in this field. | {"type": "string"} |
config-schema.json | name | Optional, name to use for grouping under the root types. If not specific, the API name is used. | {"type": "string"} |
config-schema.json | applyTo | Allow you to choose which root operations you would like to apply. By default, it's applied to all root types. | {} |
config-schema.json | version | Version of the federation spec
Default: v2.0 | {"type": "string"} |
config-schema.json | resolveReference | Any of: String, ResolveReferenceObject | {"anyOf": [{"type": "string"}, {}]} |
config-schema.json | queryFieldName | Name of root field name that resolves the reference | {"type": "string"} |
config-schema.json | args | You need configure the arguments for that field;
```yaml
args:
someArg: "{root.someKeyValue}"
``` | {"type": "object", "properties": {}} |
config-schema.json | mode | Specify to apply filter-schema transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap) | {"type": "string", "enum": ["bare", "wrap"]} |
config-schema.json | filters | Array of filter rules | {"type": "array", "items": {"type": "string"}, "additionalItems": false} |
config-schema.json | typeName | Type name that defines where field should be hoisted to | {"type": "string"} |
config-schema.json | pathConfig | Array of fieldsNames to reach the field to be hoisted (Any of: String, HoistFieldTransformFieldPathConfigObject) | {"type": "array", "items": {"anyOf": [{"type": "string"}, {}]}, "additionalItems": false} |
config-schema.json | items | Any of: String, HoistFieldTransformFieldPathConfigObject | {"anyOf": [{"type": "string"}, {}]} |
config-schema.json | newFieldName | Name the hoisted field should have when hoisted to the type specified in typeName | {"type": "string"} |
config-schema.json | filterArgsInPath | Defines if args in path are filtered (default = false) | {"type": "boolean"} |
config-schema.json | fieldName | Field name | {"type": "string"} |
config-schema.json | filterArgs | Match fields based on argument, needs to implement `(arg: GraphQLArgument) => boolean`; | {"type": "array", "items": {"type": "string"}, "additionalItems": false} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.