description: A globally unique identifier.

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

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

$ref: #/definitions/SpecifId

description: If missing, the latest revision is implied.

$ref: #/definitions/SpecifRevision

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

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

$ref: #/definitions/SpecifAlternativeId

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.

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.

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.

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.

$ref: #/definitions/SpecifKey

required: title url

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

$ref: #/definitions/SpecifOrg

format: email

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.

enum: plain xhtml

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.

description: A string containing some text.

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

$ref: #/definitions/SpecifTextFormat

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

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

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

$ref: #/definitions/SpecifMultiLanguageText

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.

$ref: #/definitions/SpecifValue

required: id value

title: Enumerated Values

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

$ref: #/definitions/SpecifEnumeratedValue

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

format: date-time

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.

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.

enum: auto user

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

title: Data-type 'Boolean'

$ref: #/definitions/SpecifText

$ref: #/definitions/SpecifReplaces

$ref: #/definitions/SpecifDateTime

required: id title type changedAt

title: Data-type 'dateTime', 'duration' or 'URI'

enum: xs:dateTime xs:duration xs:anyURI

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

$ref: #/definitions/SpecifEnumeratedValues

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

title: Data-type 'Integer'

title: Minimum Value of a Number

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

title: Maximum Value of a Number

title: Data-type 'Double'

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

title: Number of fraction digits of a Decimal Number

title: Minimum Value of a Number

title: Maximum Value of a Number

title: Data-type 'String' with plain or formatted text. The property's text object MAY specify the format and language.

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

title: Maximum String Length

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'.

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

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

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.

description: Must be a member of resourceClasses.

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.

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.

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.

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.

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.

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.

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.

description: Must be a member of resources or statements.

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

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

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

description: The next hierarchy level.

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

description: The file's name.

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

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

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.

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.

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

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.

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

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.

description: The class definitions for resources.

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

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

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.

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

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

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

title: JSON-Schema for SpecIF v1.1


tson.json

title: TSON Schema

type: object

type: array

description: List of tuning objects

type: string

description: The tuning's name

description: A description of the tuning

description: A unique identifier for the tuning

description: List of scale objects

description: A list of the scale's notes

description: The note's frequency ratio

type: number

description: The note's frequency ratio

description: The note's name

description: The note's frequency ratio

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".

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

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

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

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.

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.

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.

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

description: A list of spectrum objects

description: The spectrum's name

description: A description of the spectrum

description: A unique identifier for the spectrum

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

description: The partial's frequency ratio

description: The partial's frequency ratio

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

enum:
frequency ratio
ratio

enum:
amplitude weight
weight

description: The partial's frequency ratio

description: The partial's frequency ratio

enum:
partials
partial distribution

description: A list of set objects

description: A unique identifier for the set

description: The set's name

description: A description of the set

description: A list of set member objects

description: A reference of a tuning's ID

description: A reference of a spectrum's ID

type: boolean

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.

required: id members


description: General configuration settings.

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

description: AWS Region name

description: AWS authentication section

cn-northwest-1: china-profile

default: my-default-profile

type: integer

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

description: hooks to execute after executing tests

$ref: #/definitions/HookData

description: hooks to execute prior to executing tests

description: List of AWS regions

description: AWS Region name

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

description: Enable regional auto-buckets.

description: Tags to apply to CloudFormation template

description: Hook definition

description: hook configuration

description: hook type

description: Project specific configuration section

description: AWS Region name

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

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

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

default: private

description: ACL for uploaded s3 objects

examples: bucket-owner-read private

description: Enable regional auto-buckets.

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

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

description: Test specific configuration section.

description: AWS Region name

description: AWS authentication section

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

description: hooks to execute after executing tests

description: List of AWS regions

description: AWS Region name

description: Enable regional auto-buckets.

description: Cloudformation Stack Name

description: Prefix to apply to generated CFN Stack Name

description: Suffix to apply to generated CFN Stack Name

description: Taskcat configuration file

$ref: #/definitions/GeneralConfig

$ref: #/definitions/ProjectConfig


$comment: JSON Schema for CRYENGINE 5.3

title: Variable name

description: CVar name

title: Command name

description: Console command name

$ref: #/definitions/cvars

title: Value of the CVar

description: The default value of the CVar

required: name value

title: Assets folder

description: This indicates where the assets are stored

default: Assets

title: Code folder

description: This indicates where the code is stored

default: Code

title: Lib's name

title: Lib's name to import for all the supported platforms

title: Lib's name to import for the win_x64 platform

title: Lib's name to import for the win_x86 platform

title: Project name

description: This indicates the project name

title: Project GUID

title: Engine version

description: This indicates which engine version will be used

title: Plugin name

description: Required plugin's name

examples: CryDefaultEntities CrySensorSystem CryPerceptionSystem CryUserAnalytics CryOSVR CryOculusVR CryOpenVR CryLobby

title: Plugin type

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

title: This plugin will be used only by these platforms

enum: pc ps4 xboxone linux

required: path type

title: Project version

$ref: #/definitions/commands

title: Value of the command

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

required: content info require version

title: CryProj schema


vars.json

title: Ansible Vars Schema


mtad.json

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

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

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.

description: A custom command required to start the application.

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

description: Defines the memory allocated to the application.

enum: hard soft

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.

$ref: #/definitions/generic-memory

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.

$ref: #/definitions/module-parameters-docker

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

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.

$ref: #/definitions/module-parameters-domains

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

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

enum: port process http

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

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

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

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

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

$ref: #/definitions/module-parameters-hosts

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

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.

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

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

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

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.

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.

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

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.

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.

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

$ref: #/definitions/module-parameters-routes

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

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.

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

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.

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.

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

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.

$ref: #/definitions/module-parameters-tasks

description: The application upload timeout in seconds.

required: name command

description: The task name.

description: The command to be executed.

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

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

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

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

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

description: Keep the existing environment

description: Keep the existing Service bindings

description: Keep the existing routes

description: Restart on vcap-application env change

description: Restart on vcap-services env change

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.

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'.

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

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

$ref: #/definitions/properties-metadata

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

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

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

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

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

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

description: Name of the service to create.

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

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

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

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

description: Name of the service plan to be used.

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.

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

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

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

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

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

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

description: The version of the provider MTA.

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

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

description: The service plan.

description: The custom tags for a service instance.

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

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

description: Default value is true.

description: Default value is false.

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

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

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.

description: Additional information about the hook's parameters.

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

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

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

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.

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

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

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

description: The provider or vendor of this software.

description: A copyright statement from the provider.

description: Global parameters related to the MTA application.

description: Additional information about the MTA's parameters.

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

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

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.

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

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

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

description: Additional information about the module's properties.

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

description: Additional information about the module's parameters.

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

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.

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

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

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

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

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

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

description: A free text describing this resource.

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.

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.

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.

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

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

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

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

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

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

title: mtad.yaml v3.3


uplugin.json

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

enum: Unknown Debug DebugGame Development Shipping Test

description: Enumerates build target types.

enum: Unknown Game Server Client Editor Program

description: Description of a loadable module.

description: List of additional dependencies for building this module.

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

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

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

description: Name of this module

description: List of allowed platforms

description: List of disallowed platforms

description: List of allowed programs

description: List of disallowed programs

description: List of allowed targets

$ref: #/definitions/BuildTargetType

description: List of allowed target configurations

$ref: #/definitions/BuildConfiguration

description: List of disallowed target configurations

description: List of disallowed targets

description: Usage type of module

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

description: Descriptor for a plugin reference.

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

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

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

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

description: Name of the plugin

description: List of allowed platforms

description: List of disallowed platforms

description: List of allowed targets

description: List of allowed target configurations

description: List of disallowed targets

required: Enabled Name

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

description: Can this plugin contain content?

description: Can this plugin contain Verse code?

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

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

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

description: Marks the plugin as beta in the UI

description: Marks the plugin as experimental in the UI

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

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

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

description: The name of the category this plugin

default: Other

description: The company or individual who created this plugin.

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

description: Description of the plugin

description: Documentation URL string.

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

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

enum: Unspecified Enabled Disabled

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

description: Descriptor version number.

description: Friendly name of the plugin

description: List of all localization targets associated with this plugin

required: LoadingPolicy Name

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

enum: Never Always Editor Game PropertyNames ToolTips Max

description: Name of this target

description: Marketplace URL for this plugin.

description: List of all modules associated with this plugin

$ref: #/definitions/ModuleDescriptor

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

description: Plugins used by this plugin

$ref: #/definitions/PluginReferenceDescriptor

description: Post-build steps for each host platform

$comment: Define platform as key, command as value.

description: Pre-build steps for each host platform

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

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

description: Support URL/email for this plugin.

description: Version number for the plugin.

description: Name of the version for this plugin.

title: JSON schema for Unreal Engine uplugin


creatomic.json

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

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

scope: resource

type: string array

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

enum: onSave onType

default: onType

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

scope: window

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

type: boolean array

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

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

title: JSON schema for Creatomic configuration file


artifacthub-repo.json

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

format: uuid

description: Repository owners

title: owner

description: A repository owner

description: A repository owner name

description: A repository owner email

description: Packages that should not be indexed by Artifact Hub

title: package

description: A package

description: A package name

description: Regular expression

title: An Artifact Hub config file


fossa-deps.schema.json

title: fossa-deps

description: fossa-deps for dependency specification for FOSSA CLI

enum: alpine centos debian redhat ubuntu oraclelinux busybox sles fedora

description: Name of the distribution OS.

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

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

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.

required: name type

enum: apk deb

description: Architecture associated with this package

$ref: #/$defs/os

description: Version of the distribution OS.

required: name type arch os osVersion

description: Epoch associated with version (if any).

description: Version of the distribution OS.

$ref: #/$defs/referenced-app-dependency

$ref: #/$defs/referenced-apk-deb-dependency

$ref: #/$defs/referenced-rpm-dependency

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.

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

description: Description of the dependency (if any)

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

required: name version license

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

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

required: name path

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

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.

description: Description of the dependency (if any)

required: name url version

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

$ref: #/$defs/referenced-dependency

description: Custom dependency and their license for project

$ref: #/$defs/custom-dependency

description: Local dependencies upload to server for license scanning

$ref: #/$defs/vendored-dependency

description: Remote dependencies to license scanning

$ref: #/$defs/remote-dependency


config-schema.json

title: Cache

$ref: #/definitions/CFWorkersKVCacheConfig

$ref: #/definitions/FileCacheConfig

$ref: #/definitions/LocalforageConfig

$ref: #/definitions/RedisConfig

title: CFWorkersKVCacheConfig

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

title: FileCacheConfig

title: LocalforageConfig

enum: WEBSQL INDEXEDDB LOCALSTORAGE

description: Allowed values: WEBSQL, INDEXEDDB, LOCALSTORAGE

title: RedisConfig

title: ServeConfig

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

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

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

$ref: #/definitions/CorsConfig

description: Configuration for CORS

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

description: Show GraphiQL Playground

$ref: #/definitions/HTTPSConfig

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

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

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)

description: Title of GraphiQL Playground

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

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

title: CorsConfig

title: HTTPSConfig

required: key cert

title: SDKConfig

$ref: #/definitions/GenerateOperationsConfig

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

title: GenerateOperationsConfig

title: Source

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

$ref: #/definitions/Handler

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

$ref: #/definitions/Transform

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

required: name handler

title: Transform

$ref: #/definitions/CacheTransformConfig

description: Transformer to apply caching for your data sources

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

$ref: #/definitions/ExtendTransform

$ref: #/definitions/FederationTransform

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

$ref: #/definitions/FilterSchemaTransform

$ref: #/definitions/HoistFieldTransformConfig

description: Transformer to hoist GraphQL fields

description: Transformer to apply naming convention to GraphQL Types

$ref: #/definitions/PrefixTransformConfig

description: Prefix transform

$ref: #/definitions/PruneTransformConfig

description: Prune transform

$ref: #/definitions/RateLimitTransformConfig

description: RateLimit transform

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

$ref: #/definitions/RenameTransform

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

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

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

$ref: #/definitions/TypeMergingConfig

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

title: Handler

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

$ref: #/definitions/GrpcHandler

description: Handler for gRPC and Protobuf schemas

$ref: #/definitions/JsonSchemaHandler

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

$ref: #/definitions/MongooseHandler

$ref: #/definitions/MySQLHandler

description: Handler for Neo4j

$ref: #/definitions/ODataHandler

description: Handler for OData

$ref: #/definitions/OpenapiHandler

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

$ref: #/definitions/PostGraphileHandler

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

$ref: #/definitions/RAMLHandler

$ref: #/definitions/SoapHandler

description: Handler for SOAP

$ref: #/definitions/SupergraphHandler

$ref: #/definitions/ThriftHandler

description: Handler for OData

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

title: Plugin

description: Mock configuration for your source

description: RateLimit plugin

description: Configuration for Snapshot extension

title: MaskedErrorsPluginConfig

title: AdditionalStitchingResolverObject

description: Extract specific property from the result

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

required: sourceName sourceTypeName sourceFieldName targetTypeName targetFieldName

title: AdditionalStitchingBatchResolverObject

required: sourceName sourceTypeName sourceFieldName keyField keysArg targetTypeName targetFieldName

title: AdditionalSubscriptionObject

title: PubSubConfig

title: GraphQLHandlerMultipleHTTPConfiguration

description: HTTP Source Configurations

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

description: Handling strategy configuration

title: GraphQLHandlerhighestValueStrategyConfig

title: GraphQLHandlerCodeFirstConfiguration

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.

title: GraphQLHandlerHTTPConfiguration

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.

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

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

description: Use HTTP GET for Query operations

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

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)

description: Path to a custom W3 Compatible WebSocket Implementation

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

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

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

description: Retry attempts if fails

description: Timeout in milliseconds

description: Enable/Disable automatic query batching

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

title: GrpcHandler

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)

description:
Request timeout in milliseconds
Default: 200000

description: SSL Credentials

description: Use https instead of http for gRPC connection

description: MetaData

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

title: LoadOptions

title: ProtoFilePath

title: GrpcCredentialsSsl

title: QueryStringOptions

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`

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)

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

title: JsonSchemaHandler

description: Path to the bundle file

description: Any of: JsonSchemaHTTPOperation, JsonSchemaPubSubOperation

description: Will be removed later

description: Will be removed later

description: Timeout for the HTTP request in milliseconds

title: JsonSchemaHTTPOperation

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

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

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

description: Your chance to provide request schema name.

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

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

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

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

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

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

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

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

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

# Example:
argTypeMap:
  user_id:
    type: string

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

# Example:
queryParamArgMap:
  id: user_id

enum: GET HEAD POST PUT DELETE CONNECT OPTIONS TRACE PATCH

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

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

title: JsonSchemaPubSubOperation

description: Allowed values: Query, Mutation, Subscription

title: MongooseHandler

title: MongooseModel

title: ComposeWithMongooseOpts

title: ComposeMongooseInputType

title: ComposeWithMongooseFieldsOpts

title: TypeConverterResolversOpts

description: Any of: Boolean, ComposeWithMongooseResolverOpts

description: Any of: Boolean, JSON

description: Any of: Boolean, PaginationResolverOpts

title: ComposeWithMongooseResolverOpts

title: FilterHelperArgsOpts

description: Any of: Boolean, JSON

title: SortHelperArgsOpts

title: LimitHelperArgsOpts

title: RecordHelperArgsOpts

title: PaginationResolverOpts

title: MySQLHandler

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

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

description: The source IP address to use for TCP connection

description: The MySQL user to authenticate as

description: The password of that MySQL user

description: Name of the database to use for this connection

description: SSL Options for your MySQL connection

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

description: Use specific tables for your schema

description: Use specific fields of specific tables

title: TableField

title: MySQLSSLOptions

description: Default: true

description: Path to your CA

title: Neo4jHandler

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

description: Provide GraphQL Type Definitions instead of inferring

description: Username for basic authentication

description: Password for basic authentication

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

title: ODataHandler

description: Base URL for OData API

description: Custom $metadata File or URL

description: Headers to be used with the $metadata requests

description: Headers to be used with the operation requests

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

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

title: OpenapiHandler

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

description: Format of the files referenced from the source file, for cases content type isn't detected automatically (Allowed values: 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

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

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

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

title: OASSelectQueryOrMutationFieldConfig

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

title: HivePlugin

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

description: Access Token

description: Agent Options

description: Collects schema usage based on operations

description: Schema reporting

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

title: HiveAgentOptions

description: 30s by default

description: 5 by default

description: 200 by default

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

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

title: HiveUsageOptions

description: Extract client info from GraphQL Context

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

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

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

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

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

title: HiveClientInfo

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

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

title: HiveReportingOptions

description: Author of current version of the schema

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

title: HiveSelfHostingOptions

description:
Point to your own instance of GraphQL Hive API

Used by schema reporting and token info.

description:
Address of your own GraphQL Hive application

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

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

Used by usage reporting.

title: HTTPCachePlugin

description: Any of: String, URLPatternObj

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

description: Any of: String, URLPatternObj

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

title: URLPatternObj

title: HTTPDetailsExtensionsConfig

title: LiveQueryConfig

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

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

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

description:
Identifier unique field

Default: "id"

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

title: LiveQueryInvalidation

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

title: LiveQueryIndexBy

title: MockingConfig

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.

description: Mock configurations

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

title: MockingFieldConfig

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

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

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

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

description: Get the data from the mock store

description: Update the data on the mock store

title: GetFromMockStoreConfig

title: UpdateMockStoreConfig

title: NewrelicConfig

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

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

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

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

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

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

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

title: OperationFieldPermissionsConfig

title: OperationFieldPermission

title: PrometheusConfig

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

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

title: RateLimitPluginConfig

title: ResponseCacheConfig

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

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.

description: Skip caching of following the types.

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

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

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

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

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

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

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

title: ResponseCacheTTLConfig

title: SerializeHeadersConfig

title: SnapshotPluginConfig

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

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

description: Path to the directory of the generated snapshot files

title: StatsdPlugin

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

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

description: Client Configuration

title: StatsdClientConfiguration

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

title: StatsdClientBufferHolder

title: PostGraphileHandler

description: A connection string to your Postgres database

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.

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

description: Extra Postgraphile Plugins to append

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

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)

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

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

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.

title: RAMLHandler

title: RAMLSelectQueryOrMutationFieldConfig

title: SoapHandler

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

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

title: SupergraphHandler

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.

title: ThriftHandler

description: The name of the host to connect to.

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

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

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

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

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

description: Path to IDL file

title: CacheTransformConfig

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

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

description: Invalidation rules

title: CacheInvalidateConfig

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

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

title: CacheEffectingOperationConfig

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

title: EncapsulateTransformObject

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

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

title: EncapsulateTransformApplyTo

title: ExtendTransform

title: FederationTransform

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

title: FederationTransformType

title: FederationObjectConfig

description: Any of: String, ResolveReferenceObject

title: FederationObjectKeyConfig

title: ResolveReferenceObject

description: Name of root field name that resolves the reference

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

title: FederationField

title: FederationFieldConfig

title: FederationFieldProvidesConfig

title: FederationFieldRequiresConfig

title: FederationFieldTagConfig

title: FederationFieldOverrideConfig

title: FilterSchemaTransform

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

description: Array of filter rules

title: HoistFieldTransformConfig

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

description: Any of: String, HoistFieldTransformFieldPathConfigObject

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

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

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

title: HoistFieldTransformFieldPathConfigObject

description: Field name

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

title: NamingConventionTransformConfig

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

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

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

title: PrefixTransformConfig

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

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

description: List of ignored types

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

description: Changes types (default: true)

title: PruneTransformConfig

description: Types to skip pruning

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

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

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

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

title: RateLimitTransformConfig

description: The type name that the following field belongs to

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

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

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

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

title: RenameTransform

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

description: Array of rename rules

title: RenameTransformObject

description: Use Regular Expression for type names

description: Use Regular Expression for field names

description: Use Regular Expression for field names

description: Flags to use in the Regular Expression

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

title: RenameConfig

title: ReplaceFieldTransformConfig

description: Additional type definition to used to replace field types

description: Array of rules to replace fields

title: ReplaceFieldTransformObject

description: Allowed values: config, hoistValue

title: ReplaceFieldConfig

title: ResolversCompositionTransform

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

description: Array of resolver/composer to apply

title: ResolversCompositionTransformObject

description:
The GraphQL Resolver path
Example: Query.users

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

title: TransferSchemaTransformConfig

description: Array of rules to transfer fields or args

title: TransferSchemaTransformObject

description: Allowed values: move, copy

title: TypeMergingConfig

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

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

title: MergedRootFieldConfig

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

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.

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

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

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.

title: MergedTypeConfig

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

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.

title: KeyAnnotation

title: MergedTypeField

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

title: ComputedAnnotation

title: TuqlHandler

description: Pointer to your SQLite database

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

title: Config

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

description: SDK Configuration

description: Codegen Configuration

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

description: Transform to apply to the unified mesh schema

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

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

description: Backend cache

description: Merge method

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

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.

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

description: Path to a custom W3 Compatible Fetch Implementation

description: Allow connections to an SSL endpoint without certificates

description: You can provide Envelop plugins


proxies.json

$ref: #/definitions/match-condition-schema

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

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

$ref: #/definitions/requestOverrides-schema

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.

$ref: #/definitions/responseOverrides-schema

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.

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

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.

$ref: #/definitions/http-method-schema

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

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

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

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

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

description: The HTTP status code to be returned to the client.

description: The HTTP reason phrase to be returned to the client.

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

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

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

label: Original Request Header

description: Read from one of the request headers

body: {request.headers.<HeaderName>}

label: Original Request Query String Parameter

description: Read one of the original request query string parameters

body: {request.querystring.<ParameterName>}

label: Original Request Method

description: Read the request method

body: {request.method}

label: Backend Response Header

description: Read from one of the backend response headers

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

label: Backend Response Status Code

description: Read the backend response status code.

body: {backend.response.statusCode}

label: Backend Response Status Reason

description: Read the 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}

label: Backend Request Header

description: Read from backend request headers

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

label: Backend Request Query String

description: Read one of the backend request query string parameters

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

label: Backend Request Method

description: Read the backend request method

body: {backend.request.method}

enum: GET POST HEAD OPTIONS PUT TRACE DELETE PATCH CONNECT

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

$ref: #/definitions/proxy-schema

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

description: A friendly name for the proxy

title: JSON schema for Azure Functions Proxies proxies.json files