key: exitCode

description: Exit code that the command should exit with.


key: fileExistenceTests

description: File existence tests check to make sure a specific file (or directory) exist within the file system of the image. No contents of the files or directories are checked. These tests can also be used to ensure a file or directory is not present in the file system.

type: array

type: object

required: name path shouldExist

type: string

type: boolean

type: number

enum: owner group any other


key: name

description: The name of the test


key: path

description: Path to the file or directory under test


key: shouldExist

description: Whether or not the specified file or directory should exist in the file system


key: permissions

description: The expected Unix permission string (e.g. drwxrwxrwx) of the files or directory.


key: uid

description: The expected Unix user ID of the owner of the file or directory.


key: gid

description: The expected Unix group ID of the owner of the file or directory.


key: isExecutableBy

description: Checks if file is executable by a given user.


key: fileContentTests

description: File content tests open a file on the file system and check its contents. These tests assume the specified file is a file, and that it exists

required: name path


description: Path to the file under test


key: expectedContents

description: List of regexes that should match the contents of the file


key: excludedContents

description: List of regexes that should not match the contents of the file


key: licenseTests

description: License tests check a list of copyright files and makes sure all licenses are allowed at Google. By default it will look at where Debian lists all copyright files, but can also look at an arbitrary list of files.


key: debian

description: if the image is based on Debian, check where Debian lists all licenses.


key: files

description: A list of other files to check.


key: env

description: A list of environment variable key/value pairs that should be set in the container.


key: labels

description: A list of image labels key/value pairs that should be set on the container.


key: entrypoint

description: The entrypoint of the container


key: cmd

description: The CMD specified in the container


key: exposedPorts

description: The ports exposed in the container.


key: unexposedPorts

description: The ports NOT exposed in the container.


key: volumes

description: The volumes exposed in the container.


key: unmountedVolumes

description: The volumes NOT exposed in the container


key: workdir

description: The default working directory of the container.


key: globalEnvVars

description: A list of environment variables can optionally be specified as part of the test setup.


key: title

description: A default title that will be pre-populated in the discussion submission form.


description: Labels that will automatically be added to discussions created with this template.


key: body

description: Definition of the input types in the discussion form

enum: markdown textarea input dropdown checkboxes


description:
Lerna is a tool used in JavaScript monorepo projects. The lerna.json file is
used to configure lerna to to best fit your project.

type: string array


key: version

description: The current version of the repository (or independent).


key: npmClient

description: Specify which client to run commands with (change to "yarn" to run commands with yarn. Defaults to "npm".


key: npmClientArgs

description: Array of strings that will be passed as arguments to the npmClient.


key: useWorkspaces

description: Enable workspaces integration when using Yarn.


key: workspaces

description: Array of globs to use a workspace locations.


key: packages

description: Array of globs to use a package locations.


key: ignoreChanges

description: Array of globs of files to ignore when detecting changed packages.


key: command

description: Options for the CLI commands.


key: publish

description: Options for the publish command.


description: An array of globs that won't be included in "lerna changed/publish". Use this to prevent publishing of a new version unnecessarily for changes, such as fixing a README.md typo.


key: message

description: A custom commit message when performing version updates for publication. See https://github.com/lerna/lerna/tree/master/commands/version#--message-msg for more information.


key: bootstrap

description: Options for the bootstrap command.


key: ignore

description: An array of globs that won't be bootstrapped when running "lerna bootstrap" command.


description: Array of strings that will be passed as arguments directly to "npm install" during the "lerna bootstrap" command.


key: init

description: Options for the init command.


key: exact

description: Use lerna 1.x behavior of "exact" comparison. It will enforce the exact match for all subsequent executions.


key: run

description: Options for the run command.


description: Which npm client should be used when running package scripts.


description: Options for the version command.


key: allowBranch

description: A whitelist of globs that match git branches where "lerna version" is enabled.


description: The Specification Integration Facility (SpecIF) integrates partial system models from different methods and tools in a semantic net. Collaborators shall browse, search and audit engineering results in a common context. Also, the exchange of model information between organizations and tools is facilitated. SpecIF represents the visible, i.e. the diagrams and the text, as well as the semantics of system specifications.

format: uri

required: title url

format: email

enum: plain xhtml

required: id value

format: date-time

enum: auto user

required: id title type changedAt

enum: xs:dateTime xs:duration xs:anyURI

type: integer

required: id title dataType changedAt

required: id title propertyClasses changedAt

required: id title changedAt

required: class values

required: id class properties changedAt

required: id class subject object changedAt

required: id resource changedAt

required: $schema id dataTypes propertyClasses resourceClasses statementClasses resources statements hierarchies


key: SpecifId

description: A globally unique identifier.


key: SpecifAlternativeId

description: A list of pointers to resources resp. statements which have been merged to this one.


key: id

description: A string with a valid identifier of a model-element


key: revision

description: If missing, the latest revision is implied.


key: project

description: A string with a valid project identifier in case the identifier is not globally unique.


key: SpecifAlternativeIds

description: The list of consolidated items to be used in case a consolidated item shall be updated.


key: SpecifRevision

description: A globally unique revision tag with one or multiple blocks with alphanumeric characters separated by a special character [.:,;/-]. Sequential as well as branching/merging notations are possible.


key: SpecifReplaces

description: For change and configuration management; the first revision has 0 entries, a simple modification has 1 entry and the result of a merge has 2 entries.


key: SpecifKey

description: A key for a particular revision of an identifiable item, e.g. of a resource. A key consists of a globally unique identifier and a revision. No or an undefined revision means the latest revision of the identified item.


key: SpecifKeys

description: A list of keys referencing items such as propertyClasses, resourceClasses or statementClasses; any list must have >0 entries including those of any parent element.


key: SpecifCreatedBy

description: The creator of the SpecIF data-set (file). If specified, at least an e-mail address must be given.


key: SpecifText

description: A good class name indicates it's role. The use of a vocabulary-term is recommended, which in turn can be translated to any natural or domain language.


key: SpecifMultiLanguageText

description: A list of items with text and language properties. If the information is be provided in multiple languages, the language must be specified for proper selection; it is however not required by the schema to avoid a lot of overhead in most cases with a single language.


key: text

description: A string containing some text.


key: format

description: By default, the format is assumed 'plain'.


key: language

description: An IETF language tag such as 'en', 'en-US, 'fr' or 'de'.


key: SpecifValue

description: For properties with a dataType other than 'xs:string'.


description: For properties with dataType 'xs:string'.


key: SpecifValues

description: If 'multiple' of the propertyClass is undefined or false, the array must contain one item. If the value is unknown, omit the whole property. By default, the class' value applies.


key: SpecifEnumeratedValues

description: Enumerated values for the given dataType. If 'multiple' is true 0..n options may be selected, otherwise exactly one must be selected.


key: SpecifDateTime

description: An ISO-8601 dateTime string. For reduced accuracy, any number of values may be dropped, but only from right to left.


key: SpecifIcon

description: A symbol for display as a prefix to titles; applicable to all instances of the class. Is usually a XML-encoded UTF-8 symbol, can be an URL or dataURL.


key: SpecifInstantiation

description: Indicates whether an instance of the class is created automatically, manually or both. All is allowed, if the property is omitted. The class is abstract and cannot be instantiated, if the property list is present, but empty.


key: type

description: The corresponding definition in https://www.w3.org/TR/xmlschema-2/ applies.


key: enumeration

description: An optional list of values to choose from for a specific instance; multiple values are allowed, if 'multiple' is set to 'true'.


key: multiple

description: Indicates whether multiple values are allowed; by default the value is 'false'.


key: minInclusive

description: Optional use by dataTypes 'xs:integer' and 'xs:double'.


key: maxInclusive


key: fractionDigits

description: Optional use by dataType 'xs:double', indicates the number of decimals.


key: maxLength

description: Optional use by dataType 'xs:string'.


key: dataType

description: Must be a member of dataTypes.


description: Optional use by all propertyClasses. Indicates whether multiple values can be given. If omitted, the 'multiple' property of the dataType applies; by default the value is 'false'.


key: values

description: An optional list of default values in case the instantiated resource's or statement's property is missing.


key: format

description: The default format of a property's text value. Is superseded by a text value's format attribute.


key: unit

description: The unit of a property's numeric value; preferrably an SI unit symbol such as 'm^3/kg' (Système international (d'unités)) or a currency symbol.


key: extends

description: Must be a member of resourceClasses.


key: propertyClasses

description: A list of keys referencing propertyClasses; a base resourceClass must have at least one propertyClass, whereas an extending class may have none.


description: Must be a member of statementClasses.


key: isUndirected

description: Indicates that an instance's subject and object are equivalent and can be exchanged without change in meaning.


description: A list of keys referencing propertyClasses; a statementClass may exist without propertyClasses.


key: subjectClasses

description: A list of keys referencing eligible resource and statement classes for a statement's subject; if missing, all resource or statement classes are eligible.


key: objectClasses

description: A list of keys referencing eligible resource and statement classes for a statement's object; if missing, all resource or statement classes are eligible.


key: class

description: Must be a member of 'propertyClasses'. In addition, it must be listed in the propertyClasses of the respective resource's or statement's (or any of it's parent's) class.


key: SpecifProperties

description: A list of properties of a resource or statement; the number of properties including any parent's properties must be >0.


description: Must be a member of resourceClasses.


key: language

description: An IETF language tag such as 'en', 'en-US, 'fr' or 'de' showing the used language of the resource. Is superseded by a property's language value.


description: Must be a member of statementClasses.


description: An IETF language tag such as 'en', 'en-US, 'fr' or 'de' showing the used language of the statement. Is superseded by a property's language value.


key: subject

description: Must be a member of resources or statements.


key: object


key: properties

description: If there is no title property, the statementClass' title applies.


key: title

description: The node's label; if missing, the value of the referenced resource's title property is applied.


key: resource

description: The pointer to the resource to be displayed at this position.


key: nodes

description: The next hierarchy level.


key: SpecifNodes

description: A list of pointers to resources; may be nested forming a tree, i.e. a hierarchy of pointers.


description: The file's name.


key: url

description: An absolute or relative URL to the file; will be of format 'uri-reference' in future. If missing, the title applies.


key: type

description: The file's media type (formerly MIME-type) according to https://www.iana.org/assignments/media-types/media-types.xhtml.


key: $schema

description: An absolute URL pointing to this SpecIF schema. Supports both specif.de and schemastore.org.


description: The project's name; if missing, the first hierarchy node's title applies.


key: description

description: The project's description; if missing, the first hierarchy node's description applies.


key: isExtension

description: Indicates that the project is not schema-compliant on its own; by default the value is 'false'. Of course, it is expected that once extended the project is schema-compliant.


description: An IETF language tag such as 'en', 'en-US, 'fr' or 'de' showing the used language of the project. Is superseded by a resource's, statement's or property's language value. By default, 'en' is assumed.


key: dataTypes

description: The base data types for use by property class definitions.


key: propertyClasses

description: Class definition of a property for resources or statements. Is a sub-element of the respective resourceClass or statementClass. If no revision or change information is specified, the respective values of the parent element apply.


key: resourceClasses

description: The class definitions for resources.


key: statementClasses

description: The class definitions for statements in subject-predicate-object statements, where subject and object are resources.


key: resources

description: The resources such as diagrams, model elements or requirements.


key: statements

description: Subject-predicate-Object statements, where subject and object are resources. In other terms, statements are directed relations between two resources building a semantic net.


key: hierarchies

description: A list of hierarchies with pointers to resources; may be nested to build a tree, i.e. a hierarchy of pointers.


key: files

description: A list of files being referenced by a resource's or statement's property of dataType XHTML using an <object> tag. A file should have a media type as defined by IANA (see below).


key: tunings

description: List of tuning objects

required: notes reference

required:
repeat
repeat ratio

required: min minimum

required:
min
min frequency

required:
minimum
min frequency

required: max maximum

required:
max
max frequency

required:
maximum
max frequency

required: id scales


key: name

description: The tuning's name


description: A description of the tuning


key: id

description: A unique identifier for the tuning


key: scales

description: List of scale objects


key: notes

description: A list of the scale's notes


key: frequency ratio

description: The note's frequency ratio


key: ratio

description: The note's frequency ratio


description: The note's name


key: items

description: The note's frequency ratio


key: reference

description:
A reference frequency that is used to map the note's frequency ratios to real frequencies values (ie., in Hz).
Can be either a number (optionally appended with " Hz") or an object containing a frequency and an optional note that references one of the note names from the scale's notes list.
If no note name is provided, the reference frequency will be mapped to the frequency ratio "1".


key: frequency

description: The reference frequency - a number, optionally with " Hz" appended


key: note

description: The name of the note that should be mapped onto the reference frequency


key: repeat ratio

description: The frequency ratio at which the scale's notes will repeat


key: repeat


key: max frequency

description:
A maximum frequency for the scale.
When mapping the scale's notes onto actual frequencies, notes from this scale will not be mapped above the provided frequency.


key: max


key: maximum


key: min frequency

description:
A minimum frequency for the scale.
When mapping the scale's notes onto actual frequencies, notes from this scale will not be mapped below the provided frequency.


key: minimum


key: min


key: spectrum

description:
The spectrum of the tones that should be used for this tuning.
This enables multiple, scale-dependent spectra to be used within a single tuning.


key: spectra

description: A list of spectrum objects

enum:
frequency ratio
ratio

enum:
amplitude weight
weight

enum:
partials
partial distribution


key: name

description: The spectrum's name


key: description

description: A description of the spectrum


key: id

description: A unique identifier for the spectrum


key: partial distribution

description: A list of partials that should be used to reconstruct the spectrum


key: frequency ratio

description: The partial's frequency ratio


key: ratio

description: The partial's frequency ratio


key: amplitude weight

description:
The partial's amplitude weight.
This determines how much the partial contributes to the overall power (ie., loudness) of the reconstructed spectrum.


key: weight


key: partials


key: sets

description: A list of set objects

required: id members


description: A unique identifier for the set


description: The set's name


description: A description of the set


key: members

description: A list of set member objects


key: tuning

description: A reference of a tuning's ID


description: A reference of a spectrum's ID


key: override scale spectra

description: If true, the set's spectrum should be applied to all scales in the set's tuning, overriding any spectra that are references by the scales.


description: Taskcat configuration file

cn-northwest-1: china-profile

default: my-default-profile

default: private

examples: bucket-owner-read private


key: GeneralConfig

description: General configuration settings.


description: List of AWS regions where artifacts need to be copied. This helps same region artifact bucket access to resources


key: items

description: AWS Region name


key: auth

description: AWS authentication section


key: parameters

description: Parameter key-values to pass to CloudFormation, parameters provided in global config take precedence


key: posthooks

description: hooks to execute after executing tests


key: prehooks

description: hooks to execute prior to executing tests


key: regions

description: List of AWS regions


description: Name of S3 bucket to upload project to, if left out a bucket will be auto-generated


description: Enable regional auto-buckets.


key: tags

description: Tags to apply to CloudFormation template


key: HookData

description: Hook definition


key: config

description: hook configuration


key: type

description: hook type


key: ProjectConfig

description: Project specific configuration section


description: List of Availablilty Zones ID's to exclude when generating availability zones


description: Availability Zone ID, eg.: 'use1-az1'


description: Build Lambda zips recursively for submodules, set to false to disable


description: Path relative to the project root containing Lambda zip files, default is 'lambda_functions/source'


description: Path relative to the project root to place Lambda zip files


key: name

description: Project name, used as s3 key prefix when uploading objects


description: Organization ID to use when launching CFN Stacks. starts with o-. It is found on Organization Settings page


key: owner

description: email address for project owner (not used at present)


description: Package Lambda functions into zips before uploading to s3, set to false to disable


description: hooks to execute after executing tests


description: List of AWS regions


description: AWS Region name


description: Role name to use when launching CFN Stacks.


description: Enable (deprecated) sigv2 access to auto-generated buckets


description: ACL for uploaded s3 objects


description: Enable regional auto-buckets.


description: Shorten stack names generated for tests, set to true to enable


key: template

description: path to template file relative to the project config file path


key: TestConfig

description: Test specific configuration section.


description: List of AWS regions where artifacts need to be copied. This helps same region artifact bucket access to resources


description: AWS authentication section


description: Availability Zone ID, eg.: 'use1-az1'


description: Parameter key-values to pass to CloudFormation, parameters provided in global config take precedence


description: hooks to execute prior to executing tests


description: Name of S3 bucket to upload project to, if left out a bucket will be auto-generated


description: Cloudformation Stack Name


description: Prefix to apply to generated CFN Stack Name


description: Suffix to apply to generated CFN Stack Name


description: Tags to apply to CloudFormation template


key: cvars

description: CVar name


key: commands

description: Console command name


key: value

description: The default value of the CVar


key: items

description: This indicates where the assets are stored

default: Assets


description: This indicates where the code is stored

default: Code


description: This indicates the project name


key: engine

description: This indicates which engine version will be used


key: path

description: Required plugin's name

examples: CryDefaultEntities CrySensorSystem CryPerceptionSystem CryUserAnalytics CryOSVR CryOculusVR CryOpenVR CryLobby


description: EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one


description: Arguments that has to be passed to the command. Leave empty if it has not parameters


description: MTA deployment descriptor schema v3.3. Contains Cloud Foundry specific types and parameters.

enum: hard soft

enum: port process http

required: name command

enum: application-logs auditlog rabbitmq autoscaler portal-services fs-storage hana jobscheduler xsuaa connectivity destination feature-flags redis ml-foundation-services mongodb objectstore postgresql


key: app-name

description: The name of the application in the Cloud Foundry environment to be deployed for this module, based on the module name.


key: buildpack

description: The name or the URL of a custom buildpack required by the application.


key: buildpacks

description: An array of buildpacks. If a buildpack parameter already exists, it will be overwritten by the buildpacks listed in the buildpacks parameter, so that you have to include it in the array.


key: command

description: A custom command required to start the application.


key: create-service-broker

description: Specifies whether [true|false] a service broker should be registered for the application module; default value is: false.


key: dependency-type

description: Defines the memory allocated to the application.


key: disk-quota

description: The disk space that will be available to the application. This parameter requires a unit of measurement M, MB, G, or GB in upper or lower case.


key: docker

description: Creates a module from a docker image. When using a docker image parameter, we do not need to specify the module in the MANIFEST.mf file.When uploading a docker image, the content of a module is not needed.


key: domain

description: The domain on which the application will be available later.


key: domains

description: The domains on which the application will be available later. The resulting application routes will be the Cartesian product of the domains and hosts. That is, a separate route for each host is constructed on each domain.


key: enable-ssh

description: Enables use of SSH within an application. Supported for the Diego container runtime environment only.


key: health-check-type

description: Defines how the module will be monitored for availability.


key: health-check-timeout

description: The timeout is the amount of time (in seconds) allowed to elapse between starting up an app and the first healthy response.


key: health-check-invocation-timeout

description: The timeout in seconds for individual health check requests for http and port health checks.


key: health-check-http-endpoint

description: A http health check defaults to using '/' as its endpoint, but you can specify a custom endpoint.


key: host

description: The hostname or subdomain where an application is available later.


key: hosts

description: The hostnames or subdomain where an application is available later.


key: idle-domain

description: The idle domain on which the idle application will be available during blue-green deploy.


key: idle-domains

description: The domains on which the idle application will be available during blue-green deploy. The resulting application routes will be the Cartesian product of the domains and hosts. That is, a separate route for each host is constructed on each domain.


key: idle-host

description: The hostname or subdomain where the idle application will be available during blue-green deploy.


key: idle-hosts

description: The hostnames or subdomain where the idle application will be available during blue-green deploy.


key: instances

description: The number of application instances that will be started during the deployment.


key: keep-existing

description: Defines the application attributes which will be kept after the deployment or blue-green deployment has finished. The supported attributes which could be kept are application environment, application bindings and application routes. If not specified, the default values are false, which indicates that each application attribute will be updated with the new values presented in the deployment descriptor.


key: keep-existing-routes

description: When specified on module level, it indicates if the existing routes of the module's corresponding application should be kept even if they are not defined within the deployment and/or extension descriptors.When specified on global level, under the parameters section of the descriptor, it indicates if the existing routes of all applications within that MTA should be kept.The module-level variant of the parameter has priority over the global parameter.This parameter is typically used when users want to keep the routes they have mapped manually by using the cf map-route command. We discourage this approach, as manual operations could lead to inconsistent deployment results and difficult troubleshooting. We recommend you to define all routes in the deployment and/or extension descriptors, which allows for their automatic management.


key: memory

description: Defines the memory allocated to the application.


key: no-route

description: Defines if a route should be assigned to the application.


key: no-start

description: Start/do not start the application during deployment. This parameter setting overrides the command-line option --no-start. If you explicitly set the no-start to false for the module foo in the example provided, then the module foo is started on deployment, even if you also specify the command-line option --no-start with the cf deploy command.


key: restart-on-env-change

description: Specifies whether an application should be restarted if an environment variable has been changed in one of the following categories: vcap-application, vcap-services, user-provided. If you set these parameters to false, the changes in environment are not consumable by a running instances of the application. If your application depends on the latest environment, it might become outdated.


key: routes

description: A parameter that lists multiple HTTP routes. It is a combination of the old parameters host, domain, port and route-path, which encompasses the full addresses to which to bind a module. In case the new routes parameter and the old ones are available, the routes value is used and the values of the old parameters are ignored. Each route for the application is created if it does not already exist. A routes parameter consists of one or many HTTP routes following the pattern myhost.my.domain/path


key: service-broker-name

description: The name of the service broker in the Cloud Foundry environment to be created and registered for the specified application module.


key: service-broker-password

description: The password used for authentication by the XS controller at the service broker when performing service-related requests. The parameter is mandatory if create-service-broker: true.


key: service-broker-space-scoped

description: Makes the service plans of the broker visible only within the targeted space.


key: service-broker-url

description: Specifies the value of the service broker universal resource locator (URL) to register; service requests are sent to this URL. The parameter is mandatory if create-service-broker: true.


key: service-broker-user

description: The name of the user required for authentication by the XS controller at the service broker when performing service-related requests. The parameter is mandatory if create-service-broker: true.


key: stack

description: Use this parameter to define which prebuilt root file system (rootfs) you want to use.


key: tasks

description: Specify tasks, which are available for execution in the current droplet of the application. Also provide use of environment variables which are specified with the env scope.


key: upload-timeout

description: The application upload timeout in seconds.


key: name

description: The task name.


key: command

description: The command to be executed.


description: Defines the memory that is available to the Cloud Foundry task.


key: disk-quota

description: Defines the disk space that is available to the Cloud Foundry task.


key: image

description: An image parameter is a docker image from the Docker Hub or somewhere else. eg. cloudfoundry/test-app


key: username

description: The username is optional, but if a Docker image from a private repository is uploaded, then it is mandatory.


key: password

description: The password is optional, but if a Docker image from a private repository is uploaded, then it is mandatory.


key: env

description: Keep the existing environment


key: service-bindings

description: Keep the existing Service bindings


key: routes

description: Keep the existing routes


key: vcap-application

description: Restart on vcap-application env change


key: vcap-services

description: Restart on vcap-services env change


key: user-provided

description: Restart on user-provided env change


description: An MTA internal name which must match either a provided name, a resource name, or a module name within the same MTA.


key: list

description: All required and found configuration data sets will be assembled into a JSON array and provided to the module by the lookup name as specified by the value of 'list'.


key: properties

description: Required properties can be mapped from provided properties. Provided property values can be accessed by "~{<provided-property-name>}". Such expressions can be part of an arbitrary string


key: properties-metadata

description: Additional information about the required dependency's properties.


key: parameters

description: Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the module at runtime. Provided property values can be accessed by "~{<provided-property-name>}". Such expressions can be part of an arbitrary string


key: parameters-metadata

description: Additional information about the required dependency's parameters.


key: content-target

description: Specify that the resource would be used as a target for the module content deployment.


key: name

description: An MTA internal name which can used by a requiring module.


key: public

description: Indicates, that the provided properties shall be made publicly available by the deployer. Default value is false.


description: Property names and values make up the configuration data which is to be provided to requiring modules at runtime


description: Additional information about the provided dependency's properties.


description: Additional information about the provided dependency's parameters.


description: An MTA internal name which must match either a provided name, or a resource name within the same MTA.


description: Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the resource at runtime. Provided property values can be accessed by "~{<provided-property-name>}". Such expressions can be part of an arbitrary string


key: service

description: Name of the service to create.


key: service-key-name

description: Used when consuming an existing service key. Specifies the name of the service key. See Consumption of existing service keys for more information.


key: service-name

description: Service instance name. Default value is the resource name.


key: service-broker

description: The name of the service broker to be used.


key: service-plan

description: Name of the service plan to be used.


key: service-tags

description: Some services employ a list of custom tags, which provide an easier way for applications to parse <VCAP_SERVICES> for credentials. You can provide custom tags when creating a service instance. For more information, see Service Tags.


key: siteId

description: A globally unique ID (GUID) for your Fiori LaunchPad site.


key: config

description: Map value, containing the service creation configuration, for example, url and user credentials (user and password).


key: syslog-drain-url

description: URL to which logs for bound applications are streamed.


key: skip-service-updates

description: Map value, containing the service components (parameters, plan, tags) to skip when updating a service.


key: provider-nid

description: When used for cross-MTA dependency resolution the provider-nid is always 'mta'.


key: provider-id

description: The resource from the provider MTA <mta-id>:<mta-provides-dependency-name>.


key: version

description: The version of the provider MTA.


key: target

description: The name of the organization and space in which the provider MTA is deployed.


key: parameters

description: The configuration parameters which will be passed to the service broker.


key: plan

description: The service plan.


key: tags

description: The custom tags for a service instance.


key: org

description: The org in which the configuration will be looked for


key: space

description: The space in which the configuration will be looked for


key: overwritable

description: Default value is true.


key: optional

description: Default value is false.


key: name

description: An internal name which can be used for documentation purposes and shown by the deployer.


key: type

description: Defines the type of action that should be executed by the deployer.

default: task


key: phases

description: A list of strings that define the points at which the hook must be executed.


description: Configuration parameters that are used when executing the hook to the target runtime environment.


key: parameters-metadata

description: Additional information about the hook's parameters.


key: requires

description: List of names either matching a resource name or a provided dependency name provided within the same MTA that are required by this hook.


description: An MTA internal name which must match either a provided name, or a resource name within the same MTA.


description: Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the hook at runtime. Provided property values can be accessed by "~{<provided-property-name>}". Such expressions can be part of an arbitrary string


description: Defines the name of the Cloud Foundry task that should be executed.


key: command

description: Defines the actual command that is executed as a Cloud Foundry task.


key: memory

description: Defines the memory that is available to the Cloud Foundry task.


key: disk-quota

description: Defines the disk space that is available to the Cloud Foundry task.


description: Used to indicate to an MTA processing tool (e.g. a deployer), which schema version was taken as the base when authoring a descriptor.


key: ID

description: A globally unique ID of this MTA. Unlimited string of unicode characters.


key: version

description: Application version. Shall follow the semantic versioning standard.


key: description

description: A non-translatable description of this MTA. This is not a text for application users.


key: provider

description: The provider or vendor of this software.


key: copyright

description: A copyright statement from the provider.


key: parameters

description: Global parameters related to the MTA application.


description: Additional information about the MTA's parameters.


key: hooks

description: A list of hooks that will be executed for the MTA.


key: modules

description: A list of modules to be deployed by the MTA application.

required: name type


description: The module name which must be unique and cannot be the same as any provided property set or resource name.


description: The module type that defines the design-time tools for the module.


description: A free text describing this module.


key: path

description: The path to a folder that contains the module artifacts.


key: deployed-after

description: A list containing the names of the modules that must be deployed prior to this one.


key: properties

description: A collection of key-value pairs that are available to the module at runtime.


key: properties-metadata

description: Additional information about the module's properties.


description: Configuration parameters that are used when deploying the module to the target runtime environment.


key: parameters-metadata

description: Additional information about the module's parameters.


description: A list of hooks that will be executed for the module.


key: requires

description: List of names either matching a resource name or a name provided by another module within the same MTA that are required by this module.


key: provides

description: List of provided names (MTA internal) to which properties can be attached


key: resources

description: A list of resources to be deployed by the MTA application.


key: name

description: The resource name which must be unique and cannot be the same as any provided property set or resource name.


key: type

description: The resource type that defines the design-time tools for the resource.


key: active

description: If a resource is declared to be active, it is allocated and bound according to declared requirements. Default value is true.


key: optional

description: A resource can be declared to be optional, if the MTA can compensate for its non-existence. Default value is false.


key: description

description: A free text describing this resource.


key: processed-after

description: A list containing the names of the resources that must be processed prior to this one.


description: Property names and values make up the configuration data which is to be provided to requiring modules at runtime.


description: Additional information about the resource's properties.


key: parameters

description: Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to requiring modules at runtime. Untyped resources cannot have parameters.


description: Additional information about the resource's parameters.


key: hooks

description: A list of hooks that will be executed for the resource.


description: List of names either matching a resource name or a name provided by another resource within the same MTA that are required by this resource.


key: module-types

description: A list of custom module type definitions that will be used by the MTA application.

required: name extends


description: An MTA internal name of the module type that will be specified in the 'type' element of modules consuming it.


key: extends

description: The name of the extended type. Can be another module type defined in this descriptor or one of the default types supported by the deployer.


description: A collection of key-value pairs that will be inherited by all modules of this type.


description: Additional information about the module type's properties.


description: Configuration parameters that will be inherited in all modules of this type.


description: Additional information about the module's parameters.


key: resource-types

description: A list of custom resource type definitions that will be used by the MTA application.


description: An MTA internal name of the resource type that will be specified in the 'type' element of resources consuming it.


description: The name of the extended type. Can be another resource type defined in this descriptor or one of the default types supported by the deployer.


key: properties

description: A collection of key-value pairs that will be inherited by all resources of this type.


key: properties-metadata

description: Additional information about the resource type's properties.


description: Configuration parameters that will be inherited in all resources of this type.


description: Descriptor for plugins. Contains all the information contained within a `.uplugin` file.

enum: Unknown Debug DebugGame Development Shipping Test

enum: Unknown Game Server Client Editor Program

enum: EarliestPossible PostConfigInit PostSplashScreen PreEarlyLoadingScreen PreLoadingScreen PreDefault Default PostDefault PostEngineInit None Max

enum: Runtime RuntimeNoCommandlet RuntimeAndProgram CookedOnly UncookedOnly Developer DeveloperTool Editor EditorNoCommandlet EditorAndProgram Program ServerOnly ClientOnly ClientOnlyNoCommandlet Max

required: Enabled Name

default: Other

enum: Unspecified Enabled Disabled

required: LoadingPolicy Name

enum: Never Always Editor Game PropertyNames ToolTips Max


key: BuildConfiguration

description: Available build configurations. Mirorred from `UnrealTargetConfiguration`.


key: BuildTargetType

description: Enumerates build target types.


key: ModuleDescriptor

description: Description of a loadable module.


key: AdditionalDependencies

description: List of additional dependencies for building this module.


key: HasExplicitPlatforms

description: When true, an empty PlatformAllowList is interpeted as 'no platforms' with the expectation that explict platforms will be added in plugin extensions


key: LoadingPhase

description: When should the module be loaded during the startup sequence? This is sort of an advanced setting.


key: Name

description: Name of this module


key: PlatformAllowList

description: List of allowed platforms


key: PlatformDenyList

description: List of disallowed platforms


key: ProgramAllowList

description: List of allowed programs


key: ProgramDenyList

description: List of disallowed programs


key: TargetAllowList

description: List of allowed targets


key: TargetConfigurationAllowList

description: List of allowed target configurations


key: TargetConfigurationDenyList

description: List of disallowed target configurations


key: TargetDenyList

description: List of disallowed targets


key: Type

description: Usage type of module


key: PluginReferenceDescriptor

description: Descriptor for a plugin reference.


key: Enabled

description: Whether it should be enabled by default


description: When true, empty `SupportedTargetPlatforms` and `PlatformAllowList` are interpreted as *no platforms* with the expectation that explicit platforms will be added in plugin platform extensions


key: Optional

description: Whether this plugin is optional, and the game should silently ignore it not being present


key: Description

description: Description of the plugin for users that do not have it installed.


key: MarketplaceURL

description: URL for this plugin on the marketplace, if the user doesn't have it installed.


description: Name of the plugin


key: CanContainContent

description: Can this plugin contain content?


key: CanContainVerse

description: Can this plugin contain Verse code?


key: ExplicitlyLoaded

description: When true, this plugin's modules will not be loaded automatically nor will it's content be mounted automatically.


key: HasExplicitPlatforms

description: When true, an empty SupportedTargetPlatforms is interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin platform extensions


key: Installed

description: Signifies that the plugin was installed on top of the engine


key: IsBetaVersion

description: Marks the plugin as beta in the UI


key: IsExperimentalVersion

description: Marks the plugin as experimental in the UI


key: IsHidden

description: For auto-generated plugins that should not be listed in the plugin browser for users to disable freely.


key: IsPluginExtension

description: If true, this plugin from a platform extension extending another plugin


key: RequiresBuildPlatform

description: For plugins that are under a platform folder (eg. /PS4/), determines whether compiling the plugin requires the build platform and/or SDK to be available


key: Category

description: The name of the category this plugin


key: CreatedBy

description: The company or individual who created this plugin.


key: CreatedByURL

description: Hyperlink URL string for the company or individual who created this plugin. This is optional.


description: Description of the plugin


key: DocsURL

description: Documentation URL string.


key: EditorCustomVirtualPath

description: Optional custom virtual path to display in editor to better organize.


key: EnabledByDefault

description: Whether this plugin should be enabled by default for all projects


key: EngineVersion

description: Version of the engine that this plugin is compatible with


key: FileVersion

description: Descriptor version number.


key: FriendlyName

description: Friendly name of the plugin


key: LocalizationTargets

description: List of all localization targets associated with this plugin


key: LoadingPolicy

description: When should the localization data associated with a target should be loaded?


key: Name

description: Name of this target


key: MarketplaceURL

description: Marketplace URL for this plugin.


key: Modules

description: List of all modules associated with this plugin


key: ParentPluginName

description: If specified, this is the real plugin that this one is just extending


key: Plugins

description: Plugins used by this plugin


key: PostBuildSteps

description: Post-build steps for each host platform


key: PreBuildSteps

description: Pre-build steps for each host platform


key: SupportedPrograms

description: List of programs that are supported by this plugin.


key: SupportedTargetPlatforms

description: Controls a subset of platforms that can use this plugin, and which ones will stage the `.uplugin` file and content files.


key: SupportURL

description: Support URL/email for this plugin.


key: Version

description: Version number for the plugin.


key: VersionName

description: Name of the version for this plugin.


description: Control whether tslint is enabled for TypeScript files or not.


description: Control whether tslint is enabled for JavaScript files or not.

scope: resource


description: An additional rules directory


description: Validate a file when there is only a default tslint configuration is found


description: The path to the rules configuration file


description: Control if TypeScript definition files should be ignored


description: Configure glob patterns of file paths to exclude from linting


description: Run the linter on save (onSave) or on type (onType)

enum: onSave onType

default: onType

scope: window


description: A path added to NODE_PATH when resolving the tslint module.


description: Turns auto fix on save on or off, or defines which rules (e.g. `no-var-keyword`) to auto fix on save.

type: boolean array


description: Always show rule failures as warnings, independent of the tslint configuration.


key: repositoryID

description: An identifier of the Artifact Hub repository where the packages will be published to

format: uuid


key: owners

description: Repository owners


key: items

description: A repository owner


key: name

description: A repository owner name


key: email

description: A repository owner email


key: ignore

description: Packages that should not be indexed by Artifact Hub


description: A package


description: A package name


key: version

description: Regular expression


description: fossa-deps for dependency specification for FOSSA CLI

enum: alpine centos debian redhat ubuntu oraclelinux busybox sles fedora

enum: bower cargo carthage composer cpan renv gem git go hackage hex maven npm nuget paket pub pypi cocoapods swift url

enum: apk deb

required: name type arch os osVersion

required: name version license

required: name path

required: name url version


key: os

description: Name of the distribution OS.


description: Name of the dependency. This name will be used to search for dependency in relevant registries.


key: type

description: Type of the dependency. It informs FOSSA which relevant registries to search for dependency's distribution.


description: Version of the dependency. It informs FOSSA which version of the dependency to scan. If not provided, latest version will be used.


key: arch

description: Architecture associated with this package


key: osVersion

description: Version of the distribution OS.


key: epoch

description: Epoch associated with version (if any).


description: Name of the dependency. This will be the name used in FOSSA's dashboard.


description: Version of the dependency. This will be the version used in FOSSA's dashboard.


key: license

description: License of the dependency. This string will be used to infer license type.


key: description

description: Description of the dependency (if any)


key: homepage

description: Homepage of the dependency. This should be web address.


description: Name of the dependency. This will be the name associated with this vendored dependency in FOSSA's dashboard


key: path

description: Path to directory, which will be archived and upload to provided endpoint for license scanning.


description: Version of the dependency. This will be the version associated with this vendored dependency in FOSSA's dashboard


description: Name of the dependency. This will be the version used in FOSSA's dashboard.


key: url

description: Url of the dependency's source code. This will be the downloaded by FOSSA for scanning with the analysis.


description: Version of the dependency.


key: referenced-dependencies

description: Reference dependency to locate from registry and include it project's dependency and license scanning.


key: custom-dependencies

description: Custom dependency and their license for project


key: vendored-dependencies

description: Local dependencies upload to server for license scanning


key: remote-dependencies

description: Remote dependencies to license scanning


key: namespace

description:
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).


key: driver

description: Allowed values: WEBSQL, INDEXEDDB, LOCALSTORAGE

enum: WEBSQL INDEXEDDB LOCALSTORAGE


key: items


key: fork

description: Spawn multiple server instances as node clusters (default: `1`) (Any of: Int, Boolean)


key: port

description: TCP Port to listen (default: `4000`) (Any of: Int, String)


key: hostname

description: The binding hostname (default: `localhost`)


key: cors

description: Configuration for CORS


key: staticFiles

description: Path to your static files you want to be served with GraphQL Mesh HTTP Server


key: playground

description: Show GraphiQL Playground


key: sslCredentials

description:
SSL Credentials for HTTPS Server
If this is provided, Mesh will be served via HTTPS


key: endpoint

description: Path to GraphQL Endpoint (default: /graphql)


key: browser

description:
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)


key: playgroundTitle

description: Title of GraphiQL Playground


key: trustProxy

description:
Configure Express Proxy Handling
[Learn more](https://expressjs.com/en/guide/behind-proxies.html)


key: batchingLimit

description: Enable and define a limit for [Request Batching](https://github.com/graphql/graphql-over-http/blob/main/rfcs/Batching.md)


key: generateOperations

description:
Use this only if you don't want to use `documents` for SDK,
and let Mesh generate them for you


key: name

description: The name you wish to set to your remote API, this will be used for building the GraphQL context


key: handler

description: Point to the handler you wish to use, it can either be a predefined handler, or a custom


key: transforms

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


key: cache

description: Transformer to apply caching for your data sources


key: encapsulate

description: Transformer to apply encapsulation to the API source, by creating a field for it under the root query


key: filterSchema

description: Transformer to filter (white/black list) GraphQL types, fields and arguments (Any of: FilterSchemaTransform, Any)


key: hoistField

description: Transformer to hoist GraphQL fields


key: namingConvention

description: Transformer to apply naming convention to GraphQL Types


key: prefix

description: Prefix transform


key: prune

description: Prune transform


key: rateLimit

description: RateLimit transform


key: rename

description: Transformer to rename GraphQL types and fields (Any of: RenameTransform, Any)


key: replaceField

description: Transformer to replace GraphQL field with partial of full config from a different field


key: resolversComposition

description: Transformer to apply composition to resolvers (Any of: ResolversCompositionTransform, Any)


key: transferSchema

description: Transformer to transfer (move or copy) GraphQL parts of GraphQL schema across Types and Fields


key: typeMerging

description: [Type Merging](https://www.graphql-tools.com/docs/stitch-type-merging) Configuration


key: graphql

description: Handler for remote/local/third-party GraphQL schema (Any of: GraphQLHandlerHTTPConfiguration, GraphQLHandlerCodeFirstConfiguration, GraphQLHandlerMultipleHTTPConfiguration)


key: grpc

description: Handler for gRPC and Protobuf schemas


key: jsonSchema

description:
Handler for JSON Schema specification.
Source could be a local json file, or a url to it.


Handler for Neo4j


key: odata

description: Handler for OData


key: openapi

description: Handler for Swagger / OpenAPI 2/3 specification. Source could be a local json/swagger file, or a url to it.


key: postgraphile

description: Handler for Postgres database, based on `postgraphile`


key: soap

description: Handler for SOAP


key: thrift

description: Handler for OData


key: tuql

description: Handler for SQLite database, based on `tuql`


key: mock

description: Mock configuration for your source


description: RateLimit plugin


key: snapshot

description: Configuration for Snapshot extension


key: result

description: Extract specific property from the result


key: resultType

description:
If return types don't match,
you can specify a result type to apply inline fragment


key: sources

description: HTTP Source Configurations


key: strategy

description: Handling strategy (default: fallback) (Allowed values: fallback, race, highestValue)

enum: fallback race highestValue


key: strategyConfig

description: Handling strategy configuration


key: source

description:
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.


key: endpoint

description:
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.


key: schemaHeaders

description: JSON object representing the Headers to add to the runtime of the API calls only for schema introspection


key: operationHeaders

description: JSON object representing the Headers to add to the runtime of the API calls only for operation during runtime


key: useGETForQueries

description: Use HTTP GET for Query operations


key: method

description: HTTP method used for GraphQL operations (Allowed values: GET, POST)

enum: GET POST


key: credentials

description:
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)

enum: omit include


key: webSocketImpl

description: Path to a custom W3 Compatible WebSocket Implementation


description:
Path to the introspection
You can separately give schema introspection or SDL


key: subscriptionsProtocol

description:
SSE - Server Sent Events
WS - New graphql-ws
LEGACY_WS - Legacy subscriptions-transport-ws (Allowed values: SSE, WS, LEGACY_WS)

enum: SSE WS LEGACY_WS


key: subscriptionsEndpoint

description: URL to your endpoint serving all subscription queries for this source


key: retry

description: Retry attempts if fails


key: timeout

description: Timeout in milliseconds


key: batch

description: Enable/Disable automatic query batching


key: connectionParams

description:
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


description: gRPC Endpoint


description:
gRPC Proto file that contains your protobuf schema
OR
Use a binary-encoded or JSON file descriptor set file (Any of: ProtoFilePath, String)


key: requestTimeout

description:
Request timeout in milliseconds
Default: 200000


key: credentialsSsl

description: SSL Credentials


key: useHTTPS

description: Use https instead of http for gRPC connection


key: metaData

description: MetaData


key: prefixQueryMethod

description: prefix to collect Query method default: list, get


key: indices

description:
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`


key: arrayFormat

description:
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)

enum: indices brackets repeat comma


key: commaRoundTrip

description:
Even if there is a single item in an array, this option treats them as arrays
(default: false)


key: source

description: Path to the bundle file


key: operations

description: Any of: JsonSchemaHTTPOperation, JsonSchemaPubSubOperation


key: items


key: bundlePath

description: Will be removed later


key: bundleHeaders

description: Will be removed later


description: Timeout for the HTTP request in milliseconds


key: field

description:
This Field based on the field name of the URL path.
Example: "https://MyAPIURL.com/FieldNameHere/",
so we will set the "field: FieldNameHere".


key: description

description:
Your chance to describe the operation!
Make sure the description is clear and concise.


key: type

description: Type field is set the opertion type: Query, Mutation or Subscription. (Allowed values: Query, Mutation, Subscription)

enum: Query Mutation Subscription


key: requestSchema

description: Your chance to provide request schema name.


key: requestSample

description:
The path definition of the JSON Schema sample.
Example: "./jsons/questions.response.json".


key: requestTypeName

description: Inset any name for the type of the request body.


key: requestBaseBody

description:
This body will be merged with the request body sent with
the underlying HTTP request


key: responseSchema

description: Yay! Now you can provide the response schema name.


key: responseSample

description: Did you use Sample? Provide the response sample path.


key: responseTypeName

description: Inset any name for the type of the response body.


key: responseByStatusCode

description:
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
```


key: exposeResponseMetadata

description:
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
}
```


key: argTypeMap

description:
Mapping the JSON Schema and define the arguments of the operation.

# Example:
argTypeMap:
  user_id:
    type: string


key: queryParamArgMap

description:
JSON object representing the mapping of query search parameters (added to the route path) and the matching argument.

# Example:
queryParamArgMap:
  id: user_id


key: method

description: Allowed values: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH

enum: GET HEAD POST PUT DELETE CONNECT OPTIONS TRACE PATCH


key: binary

description:
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


description: Allowed values: Query, Mutation, Subscription


key: findById

description: Any of: Boolean, ComposeWithMongooseResolverOpts


key: findByIds


key: findOne


key: findMany


key: updateById


key: updateOne


key: updateMany


key: removeById


key: removeOne


key: removeMany


key: createOne


key: createMany


key: count


key: connection

description: Any of: Boolean, JSON


key: pagination

description: Any of: Boolean, PaginationResolverOpts


key: operators

description: Any of: Boolean, JSON


key: host

description: The hostname of the database you are connecting to. (Default: localhost)


key: port

description: The port number to connect to. (Default: 3306)


key: localAddress

description: The source IP address to use for TCP connection


key: user

description: The MySQL user to authenticate as


key: password

description: The password of that MySQL user


key: database

description: Name of the database to use for this connection


key: ssl

description: SSL Options for your MySQL connection


key: pool

description:
Use existing `Pool` instance
Format: modulePath#exportName


key: tables

description: Use specific tables for your schema


key: tableFields

description: Use specific fields of specific tables


key: rejectUnauthorized

description: Default: true


key: ca

description: Path to your CA


key: endpoint

description: URL for the Neo4j Instance e.g. neo4j://localhost


key: source

description: Provide GraphQL Type Definitions instead of inferring


key: username

description: Username for basic authentication


description: Password for basic authentication


key: alwaysIncludeRelationships

description: 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.


description: Specifies database name


description: Base URL for OData API


description: Custom $metadata File or URL


key: schemaHeaders

description: Headers to be used with the $metadata requests


key: operationHeaders

description: Headers to be used with the operation requests


key: batch

description: Enable batching (Allowed values: multipart, json)

enum: multipart json


key: expandNavProps

description: Use $expand for navigation props instead of seperate HTTP requests (Default: false)


description: A pointer to your API source (Support both JSON and YAML) - could be a local file, remote file or url endpoint


key: fallbackFormat

description: Format of the files referenced from the source file, for cases content type isn't detected automatically (Allowed values: json, yaml, js, ts)

enum: json yaml js ts


description:
Specifies the URL on which all paths will be based on.
Overrides the server object in the OAS.


description: If you are using a remote URL endpoint to fetch your schema, you can set headers for the HTTP request to fetch your schema.


description: JSON object representing the Headers to add to the runtime of the API calls


key: ignoreErrorResponses

description:
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


key: selectQueryOrMutationField

description: Allows to explicitly override the default operation (Query or Mutation) for any OAS operation


key: queryParams

description: JSON object representing the query search parameters to add to the API calls


key: timeout

description: Timeout for the HTTP request in milliseconds


key: type

description: Allowed values: query, mutation, Query, Mutation

enum: query mutation Query Mutation


key: enabled

description:
If this expression is truthy, mocking would be enabled
You can use environment variables expression, for example: `process.env.MOCKING_ENABLED != null`


key: token

description: Access Token


key: agent

description: Agent Options


key: usage

description: Collects schema usage based on operations


key: reporting

description: Schema reporting


key: selfHosting

description:
Options for self-hosting
[See more](https://github.com/kamilkisiela/graphql-hive/tree/main/packages/libraries/client#self-hosting)


description: 30s by default


key: maxRetries

description: 5 by default


key: minTimeout

description: 200 by default


key: sendInterval

description: Send reports in interval (defaults to 10_000ms)


key: maxSize

description: Max number of traces to send at once (defaults to 25)


key: clientInfo

description: Extract client info from GraphQL Context


key: max

description:
Hive uses LRU cache to store info about operations.
This option represents the maximum size of the cache.
Default: 1000


key: ttl

description:
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


key: exclude

description: A list of operations (by name) to be ignored by Hive.


key: sampleRate

description:
Sample rate to determine sampling.
0.0 = 0% chance of being sent
1.0 = 100% chance of being sent
Default: 1.0


key: processVariables

description:
(Experimental) Enables collecting Input fields usage based on the variables passed to the operation.
Default: false


key: name

description:
Extract client name
Example: `{context.headers['x-client-name']}`


key: version

description:
Extract client version
Example: `{context.headers['x-client-version']}`


key: author

description: Author of current version of the schema


key: commit

description: Commit SHA hash (or any identifier) related to the schema version


key: graphqlEndpoint

description:
Point to your own instance of GraphQL Hive API

Used by schema reporting and token info.


key: applicationUrl

description:
Address of your own GraphQL Hive application

Used by token info to generate a link to the organization, project and target.


key: usageEndpoint

description:
Point to your own instance of GraphQL Hive Usage API

Used by usage reporting.


key: matches

description: If the following patterns match the request URL, the response will be cached. (Any of: String, URLPatternObj)


key: items

description: Any of: String, URLPatternObj


key: ignores

description: If the following patterns match the request URL, the response will not be cached. (Any of: String, URLPatternObj)


key: invalidations

description: Invalidate a query or queries when a specific operation is done without an error


key: resourceIdentifier

description:
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}"


key: includeIdentifierExtension

description:
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


key: idFieldName

description:
Identifier unique field

Default: "id"


key: indexBy

description: Specify which fields should be indexed for specific invalidations.


key: field

description: Path to the operation that could effect it. In a form: Mutation.something. Note that wildcard is not supported in this field.


key: if

description:
If this expression is truthy, mocking would be enabled
You can use environment variables expression, for example: `process.env.MOCKING_ENABLED != null`


key: preserveResolvers

description:
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.


key: mocks

description: Mock configurations


key: initializeStore

description: The path to the code runs before the store is attached to the schema


key: apply

description:
Resolver path
Example: User.firstName


description:
If this expression is truthy, mocking would be enabled
You can use environment variables expression, for example: `${MOCKING_ENABLED}`


key: faker

description:
Faker.js expression or function
Read more (https://github.com/marak/Faker.js/#fakerfake)
Example:
faker: `name.firstName`
faker: `{{ name.firstName }} {{ name.lastName }}`


key: custom

description:
Custom mocking
It can be a module or json file.
Both "moduleName#exportName" or only "moduleName" would work


key: length

description:
Length of the mock list
For the list types `[ObjectType]`, how many `ObjectType` you want to return?
default: 2


key: store

description: Get the data from the mock store


key: updateStore

description: Update the data on the mock store


key: includeOperationDocument

description: default `false`. When set to `true`, includes the GraphQL document defining the operations and fragments


key: includeExecuteVariables

description: default `false`. When set to `true`, includes all the operation variables with their values


key: includeRawResult

description: default: `false`. When set to `true`, includes the execution result of both delegation and execution


key: trackResolvers

description: default `false`. When set to `true`, track resolvers as segments to monitor their performance


key: includeResolverArgs

description: default `false`. When set to `true`, includes all the arguments passed to resolvers and delegation with their values


key: rootFieldsNaming

description: default `false`. When set to `true` append the names of operation root fields to the transaction name


key: extractOperationName

description:
Allows to set a custom operation name to be used as transaction name and attribute
`extractOperationName: {context.headers['x-operation-name']}`


key: requestCount

description: Any of: Boolean, String


key: requestTotalDuration

description: Any of: Boolean, String


key: requestSummary

description: Any of: Boolean, String


key: parse

description: Any of: Boolean, String


key: validate

description: Any of: Boolean, String


key: contextBuilding

description: Any of: Boolean, String


key: execute

description: Any of: Boolean, String


key: errors

description: Any of: Boolean, String


key: deprecatedFields

description: Any of: Boolean, String


key: delegation

description: Any of: Boolean, String


key: fetch

description: Any of: Boolean, String


key: http

description: Any of: Boolean, String


key: endpoint

description:
The path to the metrics endpoint
default: `/metrics`


key: ttl

description: Maximum age in ms. Defaults to `Infinity`. Set it to 0 for disabling the global TTL.


key: ttlPerCoordinate

description:
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.


key: ignoredTypes

description: Skip caching of following the types.


key: idFields

description: List of fields that are used to identify the entity.


key: invalidateViaMutation

description:
Whether the mutation execution result should be used for invalidating resources.
Defaults to `true`


key: includeExtensionMetadata

description: Include extension values that provide useful information, such as whether the cache was hit or which resources a mutation invalidated.


key: sessionId

description:
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}"
```


key: if

description:
Specify whether the cache should be used based on the context.
```yaml
if: "context.headers.userId != null"
```


key: cacheKey

description:
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}"
```


key: shouldCacheResult

description:
Checks if the result should be cached.
```yaml
shouldCacheResult: "result.errors.length > 0"
```


description:
Expression for when to activate this extension.
Value can be a valid JS expression string or a boolean (Any of: String, Boolean)


key: apply

description:
HTTP URL pattern to be applied
For example;
  apply:
      - http://my-remote-api.com/* \<- * will apply this extension to all paths of remote API


key: outputDir

description: Path to the directory of the generated snapshot files


key: skipIntrospection

description: If you wish to disable introspection for logging (default: false)


key: prefix

description: prefix.operations.count (default: graphql)


key: client

description: Client Configuration


key: protocol

description: Allowed values: tcp, udp, uds, stream

enum: tcp udp uds stream


key: connectionString

description: A connection string to your Postgres database


key: schemaName

description: 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.


key: pool

description: Connection Pool instance or settings or you can provide the path of a code file that exports any of those


key: appendPlugins

description: Extra Postgraphile Plugins to append


key: skipPlugins

description: Postgraphile Plugins to skip (e.g. "graphile-build#NodePlugin")


key: options

description: 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)


key: subscriptions

description: Enable GraphQL websocket transport support for subscriptions (default: true)


key: live

description: Enables live-query support via GraphQL subscriptions (sends updated payload any time nested collections/records change) (default: true)


key: contextOptions

description: 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.


key: timeout

description: Timeout for the HTTP request in milliseconds


key: type

description: Allowed values: query, mutation, Query, Mutation


key: source

description: A url to your WSDL or generated SDL with annotations


key: schemaHeaders

description:
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


key: operationHeaders

description: JSON object representing the Headers to add to the runtime of the API calls only for operation during runtime


description:
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.


key: hostName

description: The name of the host to connect to.


key: port

description: The port number to attach to on the host.


key: path

description: The path on which the Thrift service is listening. Defaults to '/thrift'.


key: https

description: Boolean value indicating whether to use https. Defaults to false.


key: protocol

description: Name of the Thrift protocol type to use. Defaults to 'binary'. (Allowed values: binary, compact, json)

enum: binary compact json


key: serviceName

description: The name of your service. Used for logging.


description: JSON object representing the Headers to add to the runtime of the API calls


description: If you are using a remote URL endpoint to fetch your schema, you can set headers for the HTTP request to fetch your schema.


key: idl

description: Path to IDL file


key: field

description: The type and field to apply cache to, you can use wild cards as well, for example: `Query.*`


key: cacheKey

description:
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


key: invalidate

description: Invalidation rules


key: effectingOperations

description: Invalidate the cache when a specific operation is done without an error


key: ttl

description: Specified in seconds, the time-to-live (TTL) value limits the lifespan


key: operation

description: Path to the operation that could effect it. In a form: Mutation.something. Note that wildcard is not supported in this field.


key: matchKey

description: Cache key to invalidate on successful resolver (no error), see `cacheKey` for list of available options in this field.


key: name

description: Optional, name to use for grouping under the root types. If not specific, the API name is used.


key: applyTo

description: Allow you to choose which root operations you would like to apply. By default, it's applied to all root types.


key: version

description:
Version of the federation spec
Default: v2.0


key: resolveReference

description: Any of: String, ResolveReferenceObject


key: queryFieldName

description: Name of root field name that resolves the reference


key: args

description:
You need configure the arguments for that field;
```yaml
args:
  someArg: "{root.someKeyValue}"
```


key: mode

description: Specify to apply filter-schema transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap)

enum: bare wrap


key: filters

description: Array of filter rules


key: typeName

description: Type name that defines where field should be hoisted to


key: pathConfig

description: Array of fieldsNames to reach the field to be hoisted (Any of: String, HoistFieldTransformFieldPathConfigObject)


key: items

description: Any of: String, HoistFieldTransformFieldPathConfigObject


key: newFieldName

description: Name the hoisted field should have when hoisted to the type specified in typeName


key: filterArgsInPath

description: Defines if args in path are filtered (default = false)


key: fieldName

description: Field name


key: filterArgs

description: Match fields based on argument, needs to implement `(arg: GraphQLArgument) => boolean`;


description: Specify to apply naming-convention transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap)


key: typeNames

description: Allowed values: camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, upperCase, lowerCase

enum: camelCase capitalCase constantCase dotCase headerCase noCase paramCase pascalCase pathCase sentenceCase snakeCase upperCase lowerCase


key: fieldNames


key: enumValues


key: fieldArgumentNames


description: Specify to apply prefix transform to bare schema or by wrapping original schema (Allowed values: bare, wrap)


key: value

description: The prefix to apply to the schema types. By default it's the API name.


key: ignore

description: List of ignored types


key: includeRootOperations

description: Changes root types and changes the field names (default: false)


key: includeTypes

description: Changes types (default: true)


key: skipPruning

description: Types to skip pruning


key: skipEmptyCompositeTypePruning

description: Set to `true` to skip pruning object types or interfaces with no fields


key: skipUnimplementedInterfacesPruning

description: Set to `true` to skip pruning interfaces that are not implemented by any other types


key: skipEmptyUnionPruning

description: Set to `true` to skip pruning empty unions


key: skipUnusedTypesPruning

description: Set to `true` to skip pruning unused types


key: type

description: The type name that the following field belongs to


key: field

description: The field of the type that the rate limit is applied to


key: max

description: The maximum number of requests that can be made in a given time period


key: ttl

description: The time period in which the rate limit is applied


key: identifier

description: The identifier expression that determines the identity of the request (e.g. `{context.req.socket.remoteAddress}`)


key: mode

description: Specify to apply rename transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap)


key: renames

description: Array of rename rules


key: useRegExpForTypes

description: Use Regular Expression for type names


key: useRegExpForFields

description: Use Regular Expression for field names


key: useRegExpForArguments

description: Use Regular Expression for field names


key: regExpFlags

description: Flags to use in the Regular Expression


key: includeDefaults

description:
Flag to indicate whether certain default types (built-ins, scalars and other types specified an exclusion list) should be renamed or not.

@default: false


key: typeDefs

description: Additional type definition to used to replace field types


key: replacements

description: Array of rules to replace fields


key: scope

description: Allowed values: config, hoistValue

enum: config hoistValue


description: Specify to apply resolvers-composition transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap)


key: compositions

description: Array of resolver/composer to apply


key: resolver

description:
The GraphQL Resolver path
Example: Query.users


key: composer

description:
Path to the composer function
Example: ./src/auth.js#authComposer


key: transfers

description: Array of rules to transfer fields or args


key: action

description: Allowed values: move, copy

enum: move copy


key: queryFields

description:
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


key: additionalConfiguration

description: The path to a code file that has additional type merging configuration


key: keyField

description:
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


key: keyArg

description: Specifies which field argument receives the merge key. This may be omitted for fields with only one argument where the recipient can be inferred.


key: additionalArgs

description:
Specifies a string of additional keys and values to apply to other arguments,
formatted as `\"\"\" arg1: "value", arg2: "value" \"\"\"`.


key: key

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


key: argsExpr

description:
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.


key: typeName

description: Name of the type (Query by default)


description:
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).


key: canonical

description:
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.


key: computed

description:
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).


key: db

description: Pointer to your SQLite database


key: infile

description: Path to the SQL Dump file if you want to build a in-memory database


key: serve

description:
Configuration for `mesh start` or `mesh dev` command.
Those commands won't be available in programmatic usage.


key: sdk

description: SDK Configuration


key: codegen

description: Codegen Configuration


key: sources

description: Defines the list of your external data sources for your API mesh


key: transforms

description: Transform to apply to the unified mesh schema


key: additionalTypeDefs

description: Additional type definitions, or type definitions overrides you wish to add to the schema mesh


key: additionalResolvers

description: Additional resolvers, or resolvers overrides you wish to add to the schema mesh (Any of: String, AdditionalStitchingResolverObject, AdditionalStitchingBatchResolverObject, AdditionalSubscriptionObject)


key: items

description: Any of: String, AdditionalStitchingResolverObject, AdditionalStitchingBatchResolverObject, AdditionalSubscriptionObject


key: cache

description: Backend cache


key: merger

description: Merge method


key: pubsub

description: PubSub Implementation (Any of: String, PubSubConfig)


key: documents

description:
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.


key: logger

description: Logger instance that matches `Console` interface of NodeJS


key: customFetch

description: Path to a custom W3 Compatible Fetch Implementation


key: skipSSLValidation

description: Allow connections to an SSL endpoint without certificates


key: additionalEnvelopPlugins

description: You can provide Envelop plugins


key: matchCondition

description: 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


key: backendUri

description: 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


key: requestOverrides

description: 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.


key: responseOverrides

description: 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.


key: route

description: Required - This defines the route template, controlling to which request URLs your proxy will respond. Unlike in HTTP triggers, there is no default value


key: methods

description: 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.


This is the HTTP method which will be used to call the backend.


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


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.


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


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.


The HTTP status code to be returned to the client.


The HTTP reason phrase to be returned to the client.


description: The string representation of the body to be returned to the client.


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.


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.


key: defaultSnippets

description: Read from one of the request headers

label: Original Request Header

body: {request.headers.<HeaderName>}


description: Read one of the original request query string parameters

label: Original Request Query String Parameter

body: {request.querystring.<ParameterName>}


description: Read the request method

label: Original Request Method

body: {request.method}


description: Read from one of the backend response headers

label: Backend Response Header

body: {backend.response.headers.<HeaderName>}


description: Read the backend response status code.

label: Backend Response Status Code

body: {backend.response.statusCode}


description: Read the backend response status reason.

label: Backend Response Status Reason

body: {backend.response.statusReason}


description: Read from one of the original request headers

body: {request.headers.<HeaderName>}


label: Original Request Query String

body: {request.querystring.<ParameterName>}


description: Read the original request method

body: {request.method}


description: Read from backend request headers

label: Backend Request Header

body: {backend.request.headers.<HeaderName>}


description: Read one of the backend request query string parameters

label: Backend Request Query String

body: {backend.request.querystring.<ParameterName>}


description: Read the backend request method

label: Backend Request Method

body: {backend.request.method}


key: proxies

description: The proxies object defines the proxies that will be used by the function app


key: <ProxyName>

description: Default template for a proxy. Replace "<ProxyName>" with a friendly name you wish to set.


key: additionalProperties

description: A friendly name for the proxy


key: init

description: Initialize an AWS SAM application.

enum: Image Zip

enum: bundler cli-package gradle maven mod npm pip


key: parameters

description:
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.


description: Disable interactive prompting for init parameters. (fail if any required values are missing)


key: architecture

description:
Architectures for Lambda functions.

Architectures: ['arm64', 'x86_64']


key: location

description: Template location (git, mercurial, http(s), zip, path).


key: runtime

description:
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


description:
Lambda deployment package type.

Package Types: Zip, Image