schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
config-schema.json | items | Any of: JsonSchemaHTTPOperation, JsonSchemaPubSubOperation | {"anyOf": [{}, {}]} |
config-schema.json | bundlePath | Will be removed later | {"type": "string"} |
config-schema.json | bundleHeaders | Will be removed later | {"type": "object", "properties": {}} |
config-schema.json | timeout | Timeout for the HTTP request in milliseconds | {"type": "integer"} |
config-schema.json | field | This Field based on the field name of the URL path.
Example: "https://MyAPIURL.com/FieldNameHere/",
so we will set the "field: FieldNameHere". | {"type": "string"} |
config-schema.json | description | Your chance to describe the operation!
Make sure the description is clear and concise. | {"type": "string"} |
config-schema.json | type | Type field is set the opertion type: Query, Mutation or Subscription. (Allowed values: Query, Mutation, Subscription) | {"type": "string", "enum": ["Query", "Mutation", "Subscription"]} |
config-schema.json | requestSchema | Your chance to provide request schema name. | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | requestSample | The path definition of the JSON Schema sample.
Example: "./jsons/questions.response.json". | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | requestTypeName | Inset any name for the type of the request body. | {"type": "string"} |
config-schema.json | requestBaseBody | This body will be merged with the request body sent with
the underlying HTTP request | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | responseSchema | Yay! Now you can provide the response schema name. | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | responseSample | Did you use Sample? Provide the response sample path. | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | responseTypeName | Inset any name for the type of the response body. | {"type": "string"} |
config-schema.json | responseByStatusCode | You can define your response schemas by status codes;
```yaml filename=".meshrc.yaml"
responseByStatusCode:
200:
responseSchema: ./someschema.json#/somepath
404:
responseSample: ./error-sample.json
responseTypeName: MyError
``` | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | exposeResponseMetadata | Expose response details done to the upstream API
When you enable this, you will see a new field in the response type;
```graphql
type MyResponseType {
myFooField: String
_response: ResponseMetadata
}
# And a new type for the response metadata object
type ResponseMetadata {
url: URL
status: Int
method: String
headers: JSON
body: String
}
``` | {"type": "boolean"} |
config-schema.json | argTypeMap | Mapping the JSON Schema and define the arguments of the operation.
# Example:
argTypeMap:
user_id:
type: string | {"type": "object", "properties": {}} |
config-schema.json | queryParamArgMap | JSON object representing the mapping of query search parameters (added to the route path) and the matching argument.
# Example:
queryParamArgMap:
id: user_id | {"type": "object", "properties": {}} |
config-schema.json | method | Allowed values: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH | {"type": "string", "enum": ["GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"]} |
config-schema.json | binary | If true, this operation cannot have requestSchema or requestSample
And the request body will be passed as binary with its mime type
unless you define an explicit Content-Type header | {"type": "boolean"} |
config-schema.json | type | Allowed values: Query, Mutation, Subscription | {"type": "string", "enum": ["Query", "Mutation", "Subscription"]} |
config-schema.json | requestBaseBody | This body will be merged with the request body sent with
the underlying HTTP request | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | findById | Any of: Boolean, ComposeWithMongooseResolverOpts | {"anyOf": [{"type": "boolean"}, {}]} |
config-schema.json | findByIds | Any of: Boolean, ComposeWithMongooseResolverOpts | {"anyOf": [{"type": "boolean"}, {}]} |
config-schema.json | findOne | Any of: Boolean, ComposeWithMongooseResolverOpts | {"anyOf": [{"type": "boolean"}, {}]} |
config-schema.json | findMany | Any of: Boolean, ComposeWithMongooseResolverOpts | {"anyOf": [{"type": "boolean"}, {}]} |
config-schema.json | updateById | Any of: Boolean, ComposeWithMongooseResolverOpts | {"anyOf": [{"type": "boolean"}, {}]} |
config-schema.json | updateOne | Any of: Boolean, ComposeWithMongooseResolverOpts | {"anyOf": [{"type": "boolean"}, {}]} |
config-schema.json | updateMany | Any of: Boolean, ComposeWithMongooseResolverOpts | {"anyOf": [{"type": "boolean"}, {}]} |
config-schema.json | removeById | Any of: Boolean, ComposeWithMongooseResolverOpts | {"anyOf": [{"type": "boolean"}, {}]} |
config-schema.json | removeOne | Any of: Boolean, ComposeWithMongooseResolverOpts | {"anyOf": [{"type": "boolean"}, {}]} |
config-schema.json | removeMany | Any of: Boolean, ComposeWithMongooseResolverOpts | {"anyOf": [{"type": "boolean"}, {}]} |
config-schema.json | createOne | Any of: Boolean, ComposeWithMongooseResolverOpts | {"anyOf": [{"type": "boolean"}, {}]} |
config-schema.json | createMany | Any of: Boolean, ComposeWithMongooseResolverOpts | {"anyOf": [{"type": "boolean"}, {}]} |
config-schema.json | count | Any of: Boolean, ComposeWithMongooseResolverOpts | {"anyOf": [{"type": "boolean"}, {}]} |
config-schema.json | connection | Any of: Boolean, JSON | {"anyOf": [{"type": "boolean"}, {"type": "object", "properties": {}}]} |
config-schema.json | pagination | Any of: Boolean, PaginationResolverOpts | {"anyOf": [{"type": "boolean"}, {}]} |
config-schema.json | operators | Any of: Boolean, JSON | {"anyOf": [{"type": "boolean"}, {"type": "object", "properties": {}}]} |
config-schema.json | host | The hostname of the database you are connecting to. (Default: localhost) | {"type": "string"} |
config-schema.json | port | The port number to connect to. (Default: 3306) | {"type": "integer"} |
config-schema.json | localAddress | The source IP address to use for TCP connection | {"type": "string"} |
config-schema.json | user | The MySQL user to authenticate as | {"type": "string"} |
config-schema.json | password | The password of that MySQL user | {"type": "string"} |
config-schema.json | database | Name of the database to use for this connection | {"type": "string"} |
config-schema.json | ssl | SSL Options for your MySQL connection | {} |
config-schema.json | pool | Use existing `Pool` instance
Format: modulePath#exportName | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | tables | Use specific tables for your schema | {"type": "array", "items": {"type": "string"}, "additionalItems": false} |
config-schema.json | tableFields | Use specific fields of specific tables | {"type": "array", "items": {}, "additionalItems": false} |
config-schema.json | rejectUnauthorized | Default: true | {"type": "boolean"} |
config-schema.json | ca | Path to your CA | {"type": "string"} |
config-schema.json | endpoint | URL for the Neo4j Instance e.g. neo4j://localhost | {"type": "string"} |
config-schema.json | source | Provide GraphQL Type Definitions instead of inferring | {"type": "string"} |
config-schema.json | username | Username for basic authentication | {"type": "string"} |
config-schema.json | password | Password for basic authentication | {"type": "string"} |
config-schema.json | alwaysIncludeRelationships | Specifies whether relationships should always be included in the type definitions as [relationship](https://grandstack.io/docs/neo4j-graphql-js.html#relationship-types) types, even if the relationships do not have properties. | {"type": "boolean"} |
config-schema.json | database | Specifies database name | {"type": "string"} |
config-schema.json | endpoint | Base URL for OData API | {"type": "string"} |
config-schema.json | source | Custom $metadata File or URL | {"type": "string"} |
config-schema.json | schemaHeaders | Headers to be used with the $metadata requests | {"type": "object", "properties": {}} |
config-schema.json | operationHeaders | Headers to be used with the operation requests | {"type": "object", "properties": {}} |
config-schema.json | batch | Enable batching (Allowed values: multipart, json) | {"type": "string", "enum": ["multipart", "json"]} |
config-schema.json | expandNavProps | Use $expand for navigation props instead of seperate HTTP requests (Default: false) | {"type": "boolean"} |
config-schema.json | source | A pointer to your API source (Support both JSON and YAML) - could be a local file, remote file or url endpoint | {"type": "string"} |
config-schema.json | fallbackFormat | Format of the files referenced from the source file, for cases content type isn't detected automatically (Allowed values: json, yaml, js, ts) | {"type": "string", "enum": ["json", "yaml", "js", "ts"]} |
config-schema.json | endpoint | Specifies the URL on which all paths will be based on.
Overrides the server object in the OAS. | {"type": "string"} |
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 | operationHeaders | JSON object representing the Headers to add to the runtime of the API calls | {"type": "object", "properties": {}} |
config-schema.json | ignoreErrorResponses | Responses are converted to a Union type grouping all possible responses.
Applying this will ignore all responses with status code other than 2xx, resulting in simpler response types, usualy regular object type instead of union.
Default: false | {"type": "boolean"} |
config-schema.json | selectQueryOrMutationField | Allows to explicitly override the default operation (Query or Mutation) for any OAS operation | {"type": "array", "items": {}, "additionalItems": false} |
config-schema.json | queryParams | JSON object representing the query search parameters to add to the API calls | {"type": "object", "properties": {}} |
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 | enabled | If this expression is truthy, mocking would be enabled
You can use environment variables expression, for example: `process.env.MOCKING_ENABLED != null` | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | token | Access Token | {"type": "string"} |
config-schema.json | agent | Agent Options | {} |
config-schema.json | usage | Collects schema usage based on operations | {} |
config-schema.json | reporting | Schema reporting | {} |
config-schema.json | selfHosting | Options for self-hosting
[See more](https://github.com/kamilkisiela/graphql-hive/tree/main/packages/libraries/client#self-hosting) | {} |
config-schema.json | timeout | 30s by default | {"type": "integer"} |
config-schema.json | maxRetries | 5 by default | {"type": "integer"} |
config-schema.json | minTimeout | 200 by default | {"type": "integer"} |
config-schema.json | sendInterval | Send reports in interval (defaults to 10_000ms) | {"type": "integer"} |
config-schema.json | maxSize | Max number of traces to send at once (defaults to 25) | {"type": "integer"} |
config-schema.json | clientInfo | Extract client info from GraphQL Context | {} |
config-schema.json | max | Hive uses LRU cache to store info about operations.
This option represents the maximum size of the cache.
Default: 1000 | {"type": "integer"} |
config-schema.json | ttl | Hive uses LRU cache to store info about operations.
This option represents the maximum age of an unused operation in the cache.
Default: no ttl | {"type": "integer"} |
config-schema.json | exclude | A list of operations (by name) to be ignored by Hive. | {"type": "array", "items": {"type": "string"}, "additionalItems": false} |
config-schema.json | sampleRate | Sample rate to determine sampling.
0.0 = 0% chance of being sent
1.0 = 100% chance of being sent
Default: 1.0 | {"type": "number"} |
config-schema.json | processVariables | (Experimental) Enables collecting Input fields usage based on the variables passed to the operation.
Default: false | {"type": "boolean"} |
config-schema.json | name | Extract client name
Example: `{context.headers['x-client-name']}` | {"type": "string"} |
config-schema.json | version | Extract client version
Example: `{context.headers['x-client-version']}` | {"type": "string"} |
config-schema.json | author | Author of current version of the schema | {"type": "string"} |
config-schema.json | commit | Commit SHA hash (or any identifier) related to the schema version | {"type": "string"} |
config-schema.json | graphqlEndpoint | Point to your own instance of GraphQL Hive API
Used by schema reporting and token info. | {"type": "string"} |
config-schema.json | applicationUrl | Address of your own GraphQL Hive application
Used by token info to generate a link to the organization, project and target. | {"type": "string"} |
config-schema.json | usageEndpoint | Point to your own instance of GraphQL Hive Usage API
Used by usage reporting. | {"type": "string"} |
config-schema.json | matches | If the following patterns match the request URL, the response will be cached. (Any of: String, URLPatternObj) | {"type": "array", "items": {"anyOf": [{"type": "string"}, {}]}, "additionalItems": false} |
config-schema.json | items | Any of: String, URLPatternObj | {"anyOf": [{"type": "string"}, {}]} |
config-schema.json | ignores | If the following patterns match the request URL, the response will not be cached. (Any of: String, URLPatternObj) | {"type": "array", "items": {"anyOf": [{"type": "string"}, {}]}, "additionalItems": false} |
config-schema.json | items | Any of: String, URLPatternObj | {"anyOf": [{"type": "string"}, {}]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.