schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
config-schema.json | mode | Specify to apply naming-convention transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap) | {"type": "string", "enum": ["bare", "wrap"]} |
config-schema.json | typeNames | Allowed values: camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, upperCase, lowerCase | {"type": "string", "enum": ["camelCase", "capitalCase", "constantCase", "dotCase", "headerCase", "noCase", "paramCase", "pascalCase", "pathCase", "sentenceCase", "snakeCase", "upperCase", "lowerCase"]} |
config-schema.json | fieldNames | Allowed values: camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, upperCase, lowerCase | {"type": "string", "enum": ["camelCase", "capitalCase", "constantCase", "dotCase", "headerCase", "noCase", "paramCase", "pascalCase", "pathCase", "sentenceCase", "snakeCase", "upperCase", "lowerCase"]} |
config-schema.json | enumValues | Allowed values: camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, upperCase, lowerCase | {"type": "string", "enum": ["camelCase", "capitalCase", "constantCase", "dotCase", "headerCase", "noCase", "paramCase", "pascalCase", "pathCase", "sentenceCase", "snakeCase", "upperCase", "lowerCase"]} |
config-schema.json | fieldArgumentNames | Allowed values: camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, upperCase, lowerCase | {"type": "string", "enum": ["camelCase", "capitalCase", "constantCase", "dotCase", "headerCase", "noCase", "paramCase", "pascalCase", "pathCase", "sentenceCase", "snakeCase", "upperCase", "lowerCase"]} |
config-schema.json | mode | Specify to apply prefix transform to bare schema or by wrapping original schema (Allowed values: bare, wrap) | {"type": "string", "enum": ["bare", "wrap"]} |
config-schema.json | value | The prefix to apply to the schema types. By default it's the API name. | {"type": "string"} |
config-schema.json | ignore | List of ignored types | {"type": "array", "items": {"type": "string"}, "additionalItems": false} |
config-schema.json | includeRootOperations | Changes root types and changes the field names (default: false) | {"type": "boolean"} |
config-schema.json | includeTypes | Changes types (default: true) | {"type": "boolean"} |
config-schema.json | skipPruning | Types to skip pruning | {"type": "array", "items": {"type": "string"}, "additionalItems": false} |
config-schema.json | skipEmptyCompositeTypePruning | Set to `true` to skip pruning object types or interfaces with no fields | {"type": "boolean"} |
config-schema.json | skipUnimplementedInterfacesPruning | Set to `true` to skip pruning interfaces that are not implemented by any other types | {"type": "boolean"} |
config-schema.json | skipEmptyUnionPruning | Set to `true` to skip pruning empty unions | {"type": "boolean"} |
config-schema.json | skipUnusedTypesPruning | Set to `true` to skip pruning unused types | {"type": "boolean"} |
config-schema.json | type | The type name that the following field belongs to | {"type": "string"} |
config-schema.json | field | The field of the type that the rate limit is applied to | {"type": "string"} |
config-schema.json | max | The maximum number of requests that can be made in a given time period | {"type": "integer"} |
config-schema.json | ttl | The time period in which the rate limit is applied | {"type": "integer"} |
config-schema.json | identifier | The identifier expression that determines the identity of the request (e.g. `{context.req.socket.remoteAddress}`) | {"type": "string"} |
config-schema.json | mode | Specify to apply rename transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap) | {"type": "string", "enum": ["bare", "wrap"]} |
config-schema.json | renames | Array of rename rules | {"type": "array", "items": {}, "additionalItems": false} |
config-schema.json | useRegExpForTypes | Use Regular Expression for type names | {"type": "boolean"} |
config-schema.json | useRegExpForFields | Use Regular Expression for field names | {"type": "boolean"} |
config-schema.json | useRegExpForArguments | Use Regular Expression for field names | {"type": "boolean"} |
config-schema.json | regExpFlags | Flags to use in the Regular Expression | {"type": "string"} |
config-schema.json | includeDefaults | Flag to indicate whether certain default types (built-ins, scalars and other types specified an exclusion list) should be renamed or not.
@default: false | {"type": "boolean"} |
config-schema.json | typeDefs | Additional type definition to used to replace field types | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | replacements | Array of rules to replace fields | {"type": "array", "items": {}, "additionalItems": false} |
config-schema.json | scope | Allowed values: config, hoistValue | {"type": "string", "enum": ["config", "hoistValue"]} |
config-schema.json | mode | Specify to apply resolvers-composition transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap) | {"type": "string", "enum": ["bare", "wrap"]} |
config-schema.json | compositions | Array of resolver/composer to apply | {"type": "array", "items": {}, "additionalItems": false} |
config-schema.json | resolver | The GraphQL Resolver path
Example: Query.users | {"type": "string"} |
config-schema.json | composer | Path to the composer function
Example: ./src/auth.js#authComposer | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | transfers | Array of rules to transfer fields or args | {"type": "array", "items": {}, "additionalItems": false} |
config-schema.json | action | Allowed values: move, copy | {"type": "string", "enum": ["move", "copy"]} |
config-schema.json | 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 | {"type": "array", "items": {}, "additionalItems": false} |
config-schema.json | additionalConfiguration | The path to a code file that has additional type merging configuration | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | keyField | Specifies the name of a field to pick off origin objects as the key value. When omitted, a `@key` directive must be included on the return type's definition to be built into an object key.
https://www.graphql-tools.com/docs/stitch-directives-sdl#object-keys | {"type": "string"} |
config-schema.json | keyArg | Specifies which field argument receives the merge key. This may be omitted for fields with only one argument where the recipient can be inferred. | {"type": "string"} |
config-schema.json | additionalArgs | Specifies a string of additional keys and values to apply to other arguments,
formatted as `\"\"\" arg1: "value", arg2: "value" \"\"\"`. | {"type": "string"} |
config-schema.json | key | Advanced use only; Allows building a custom key just for the argument from the selectionSet included by the `@key` directive. | {"type": "array", "items": {"type": "string"}, "additionalItems": false} |
config-schema.json | argsExpr | Advanced use only; This argument specifies a string expression that allows more customization of the input arguments. Rules for evaluation of this argument are as follows:
- basic object parsing of the input key: `"arg1: $key.arg1, arg2: $key.arg2"`
- any expression enclosed by double brackets will be evaluated once for each of the requested keys, and then sent as a list: `"input: { keys: [[$key]] }"`
- selections from the key can be referenced by using the $ sign and dot notation: `"upcs: [[$key.upc]]"`, so that `$key.upc` refers to the `upc` field of the key. | {"type": "string"} |
config-schema.json | typeName | Name of the type (Query by default) | {"type": "string"} |
config-schema.json | key | Specifies a base selection set needed to merge the annotated type across subschemas.
Analogous to the `selectionSet` setting specified in [merged type configuration](https://www.graphql-tools.com/docs/stitch-type-merging#basic-example). | {} |
config-schema.json | canonical | Specifies types and fields
that provide a [canonical definition](https://www.graphql-tools.com/docs/stitch-type-merging#canonical-definitions) to be built into the gateway schema. Useful for selecting preferred characteristics among types and fields that overlap across subschemas. Root fields marked as canonical specify which subschema the field proxies for new queries entering the graph. | {"type": "boolean"} |
config-schema.json | computed | specifies a selection of fields required from other services to compute the value of this field.
These additional fields are only selected when the computed field is requested.
Analogous to [computed field](https://www.graphql-tools.com/docs/stitch-type-merging#computed-fields) in merged type configuration.
Computed field dependencies must be sent into the subservice using an [object key](https://www.graphql-tools.com/docs/stitch-directives-sdl#object-keys). | {} |
config-schema.json | db | Pointer to your SQLite database | {"type": "string"} |
config-schema.json | infile | Path to the SQL Dump file if you want to build a in-memory database | {"type": "string"} |
config-schema.json | serve | Configuration for `mesh start` or `mesh dev` command.
Those commands won't be available in programmatic usage. | {} |
config-schema.json | sdk | SDK Configuration | {} |
config-schema.json | codegen | Codegen Configuration | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | sources | Defines the list of your external data sources for your API mesh | {"type": "array", "items": {}, "additionalItems": false} |
config-schema.json | transforms | Transform to apply to the unified mesh schema | {"type": "array", "items": {}, "additionalItems": false} |
config-schema.json | additionalTypeDefs | Additional type definitions, or type definitions overrides you wish to add to the schema mesh | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | additionalResolvers | Additional resolvers, or resolvers overrides you wish to add to the schema mesh (Any of: String, AdditionalStitchingResolverObject, AdditionalStitchingBatchResolverObject, AdditionalSubscriptionObject) | {"type": "array", "items": {"anyOf": [{"type": "string"}, {}, {}, {}]}, "additionalItems": false} |
config-schema.json | items | Any of: String, AdditionalStitchingResolverObject, AdditionalStitchingBatchResolverObject, AdditionalSubscriptionObject | {"anyOf": [{"type": "string"}, {}, {}, {}]} |
config-schema.json | cache | Backend cache | {} |
config-schema.json | merger | Merge method | {"type": "string"} |
config-schema.json | pubsub | PubSub Implementation (Any of: String, PubSubConfig) | {"anyOf": [{"type": "string"}, {}]} |
config-schema.json | 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. | {"type": "array", "items": {"type": "string"}, "additionalItems": false} |
config-schema.json | logger | Logger instance that matches `Console` interface of NodeJS | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | customFetch | Path to a custom W3 Compatible Fetch Implementation | {"anyOf": [{"type": "object", "additionalProperties": true}, {"type": "string"}, {"type": "array", "additionalItems": true}]} |
config-schema.json | skipSSLValidation | Allow connections to an SSL endpoint without certificates | {"type": "boolean"} |
config-schema.json | additionalEnvelopPlugins | You can provide Envelop plugins | {"type": "string"} |
proxies.json | matchCondition | Required - an object defining the requests that will trigger the execution of this proxy. It contains two properties shared with HTTP triggers - methods and route | {} |
proxies.json | backendUri | The URL of the backend resource to which the request should be proxied. This value may be templated. If this property is not included, Azure Functions will respond with an HTTP 200 OK | {"type": "string"} |
proxies.json | requestOverrides | The requestOverrides object defines changes made to the request when the backend resource is called. You can make changes to the HTTP method, headers, and query string parameters. | {} |
proxies.json | responseOverrides | The responseOverrides object defines changes made to the response passed back to the client. You can make changes to the response's status code, reason phrase, headers, and body. | {} |
proxies.json | route | Required - This defines the route template, controlling to which request URLs your proxy will respond. Unlike in HTTP triggers, there is no default value | {"type": "string"} |
proxies.json | methods | This is an array of the HTTP methods to which the proxy will respond. If not specified, the proxy will respond to all HTTP methods on the route. | {"type": "array", "minItems": 1, "items": {}, "uniqueItems": true} |
proxies.json | backend.request.method | This is the HTTP method which will be used to call the backend. | {"anyOf": [{}, {}]} |
proxies.json | backend.request.querystring.<ParameterName> | A query string parameter which can be set for the call to the backend. Replace "<ParameterName>" with the name of the parameter you wish to set. If the empty string is provided, the parameter will not be included on the backend request | {} |
proxies.json | backend.request.headers.<HeaderName> | A header which can be set for the call to the backend. Replace "<HeaderName>" with the name of the header you wish to set. If the empty string is provided, the header will not be included on the backend request. | {} |
proxies.json | ^backend\.request\.querystring\..+$ | A query string parameter which can be set for the call to the backend. Values can reference application settings and parameters from the original client request. If the empty string is provided, the parameter will not be included on the backend request | {} |
proxies.json | ^backend\.request\.headers\..+$ | A header which can be set for the call to the backend. Values can reference application settings, parameters from the original client request, and parameters from the backend response. If the empty string is provided, the header will not be included on the backend request. | {} |
proxies.json | response.statusCode | The HTTP status code to be returned to the client. | {} |
proxies.json | response.statusReason | The HTTP reason phrase to be returned to the client. | {} |
proxies.json | response.body | The string representation of the body to be returned to the client. | {"anyOf": [{"type": "string"}, {"type": "object"}, {"type": "array", "minItems": 1, "items": {"type": "object"}}]} |
proxies.json | response.headers.<HeaderName> | A header which can be set for the response to the client. Replace "<HeaderName>" with the name of the header you wish to set. If the empty string is provided, the header will not be included on the response. | {} |
proxies.json | ^response\.headers\..+$ | A header which can be set for the response to the client. Values can reference application settings, parameters from the original client request, and parameters from the backend response. If the empty string is provided, the header will not be included on the response. | {} |
proxies.json | defaultSnippets | Read from one of the request headers | {"label": "Original Request Header", "body": "{request.headers.<HeaderName>}"} |
proxies.json | defaultSnippets | Read one of the original request query string parameters | {"label": "Original Request Query String Parameter", "body": "{request.querystring.<ParameterName>}"} |
proxies.json | defaultSnippets | Read the request method | {"label": "Original Request Method", "body": "{request.method}"} |
proxies.json | defaultSnippets | Read from one of the backend response headers | {"label": "Backend Response Header", "body": "{backend.response.headers.<HeaderName>}"} |
proxies.json | defaultSnippets | Read the backend response status code. | {"label": "Backend Response Status Code", "body": "{backend.response.statusCode}"} |
proxies.json | defaultSnippets | Read the backend response status reason. | {"label": "Backend Response Status Reason", "body": "{backend.response.statusReason}"} |
proxies.json | defaultSnippets | Read from one of the original request headers | {"label": "Original Request Header", "body": "{request.headers.<HeaderName>}"} |
proxies.json | defaultSnippets | Read one of the original request query string parameters | {"label": "Original Request Query String", "body": "{request.querystring.<ParameterName>}"} |
proxies.json | defaultSnippets | Read the original request method | {"label": "Original Request Method", "body": "{request.method}"} |
proxies.json | defaultSnippets | Read from backend request headers | {"label": "Backend Request Header", "body": "{backend.request.headers.<HeaderName>}"} |
proxies.json | defaultSnippets | Read one of the backend request query string parameters | {"label": "Backend Request Query String", "body": "{backend.request.querystring.<ParameterName>}"} |
proxies.json | defaultSnippets | Read the backend request method | {"label": "Backend Request Method", "body": "{backend.request.method}"} |
proxies.json | proxies | The proxies object defines the proxies that will be used by the function app | {"type": "object", "properties": {"<ProxyName>": {}}, "additionalProperties": {}} |
proxies.json | <ProxyName> | Default template for a proxy. Replace "<ProxyName>" with a friendly name you wish to set. | {} |
proxies.json | additionalProperties | A friendly name for the proxy | {} |
samcli.json | init | Initialize an AWS SAM application. | {"properties": {"parameters": {"type": "object", "properties": {"no_interactive": {"type": "boolean"}, "architecture": {"type": "string", "enum": ["arm64", "x86_64"]}, "location": {"type": "string"}, "runtime": {"type": "string", "enum": ["dotnet6", "go1.x", "java11", "java17", "java8", "java8.al2", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "provided", "provided.al2", "python3.10", "python3.11", "python3.7", "python3.8", "python3.9", "ruby2.7", "ruby3.2"]}, "package_type": {"type": "string", "enum": ["Image", "Zip"]}, "base_image": {"type": "string", "enum": ["amazon/dotnet6-base", "amazon/go-provided.al2-base", "amazon/go1.x-base", "amazon/java11-base", "amazon/java17-base", "amazon/java8-base", "amazon/java8.al2-base", "amazon/nodejs12.x-base", "amazon/nodejs14.x-base", "amazon/nodejs16.x-base", "amazon/nodejs18.x-base", "amazon/python3.10-base", "amazon/python3.11-base", "amazon/python3.7-base", "amazon/python3.8-base", "amazon/python3.9-base", "amazon/ruby2.7-base", "amazon/ruby3.2-base"]}, "dependency_manager": {"type": "string", "enum": ["bundler", "cli-package", "gradle", "maven", "mod", "npm", "pip"]}, "output_dir": {"type": "string", "default": "."}, "name": {"type": "string"}, "app_template": {"type": "string"}, "no_input": {"type": "boolean"}, "extra_context": {"type": "string"}, "tracing": {"type": "boolean"}, "application_insights": {"type": "boolean"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}}}}, "required": ["parameters"]} |
samcli.json | parameters | Available parameters for the init command:
* no_interactive:
Disable interactive prompting for init parameters. (fail if any required values are missing)
* architecture:
Architectures for Lambda functions.
Architectures: ['arm64', 'x86_64']
* location:
Template location (git, mercurial, http(s), zip, path).
* runtime:
Lambda runtime for application.
Runtimes: dotnet6, go1.x, java17, java11, java8.al2, java8, nodejs18.x, nodejs16.x, nodejs14.x, nodejs12.x, provided, provided.al2, python3.9, python3.8, python3.7, python3.11, python3.10, ruby3.2, ruby2.7
* package_type:
Lambda deployment package type.
Package Types: Zip, Image
* base_image:
Lambda base image for deploying IMAGE based package type.
Base images: amazon/dotnet6-base, amazon/go-provided.al2-base, amazon/go1.x-base, amazon/java11-base, amazon/java17-base, amazon/java8-base, amazon/java8.al2-base, amazon/nodejs12.x-base, amazon/nodejs14.x-base, amazon/nodejs16.x-base, amazon/nodejs18.x-base, amazon/python3.10-base, amazon/python3.11-base, amazon/python3.7-base, amazon/python3.8-base, amazon/python3.9-base, amazon/ruby2.7-base, amazon/ruby3.2-base
* dependency_manager:
Dependency manager for Lambda runtime.
Dependency managers: bundler, cli-package, gradle, maven, mod, npm, pip
* output_dir:
Directory to initialize AWS SAM application.
* name:
Name of AWS SAM Application.
* app_template:
Identifier of the managed application template to be used. Alternatively, run '$sam init' without options for an interactive workflow.
* no_input:
Disable Cookiecutter prompting and accept default values defined in the cookiecutter config.
* extra_context:
Override custom parameters in the template's cookiecutter.json configuration e.g. {"customParam1": "customValue1", "customParam2":"customValue2"}
* tracing:
Enable AWS X-Ray tracing for application.
* application_insights:
Enable CloudWatch Application Insights monitoring for application.
* beta_features:
Enable/Disable beta features.
* debug:
Turn on debug logging to print debug message generated by AWS SAM CLI and display timestamps. | {"type": "object", "properties": {"no_interactive": {"type": "boolean"}, "architecture": {"type": "string", "enum": ["arm64", "x86_64"]}, "location": {"type": "string"}, "runtime": {"type": "string", "enum": ["dotnet6", "go1.x", "java11", "java17", "java8", "java8.al2", "nodejs12.x", "nodejs14.x", "nodejs16.x", "nodejs18.x", "provided", "provided.al2", "python3.10", "python3.11", "python3.7", "python3.8", "python3.9", "ruby2.7", "ruby3.2"]}, "package_type": {"type": "string", "enum": ["Image", "Zip"]}, "base_image": {"type": "string", "enum": ["amazon/dotnet6-base", "amazon/go-provided.al2-base", "amazon/go1.x-base", "amazon/java11-base", "amazon/java17-base", "amazon/java8-base", "amazon/java8.al2-base", "amazon/nodejs12.x-base", "amazon/nodejs14.x-base", "amazon/nodejs16.x-base", "amazon/nodejs18.x-base", "amazon/python3.10-base", "amazon/python3.11-base", "amazon/python3.7-base", "amazon/python3.8-base", "amazon/python3.9-base", "amazon/ruby2.7-base", "amazon/ruby3.2-base"]}, "dependency_manager": {"type": "string", "enum": ["bundler", "cli-package", "gradle", "maven", "mod", "npm", "pip"]}, "output_dir": {"type": "string", "default": "."}, "name": {"type": "string"}, "app_template": {"type": "string"}, "no_input": {"type": "boolean"}, "extra_context": {"type": "string"}, "tracing": {"type": "boolean"}, "application_insights": {"type": "boolean"}, "beta_features": {"type": "boolean"}, "debug": {"type": "boolean"}}} |
samcli.json | no_interactive | Disable interactive prompting for init parameters. (fail if any required values are missing) | {"type": "boolean"} |
samcli.json | architecture | Architectures for Lambda functions.
Architectures: ['arm64', 'x86_64'] | {"type": "string", "enum": ["arm64", "x86_64"]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.