Schema registry

mtad.yaml

A MTA deployment descriptors v3.3

mtad.yamlmtad.yml

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your mtad.yaml and it validates in your browser — nothing is uploaded.

Validate a mtad.yaml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`_schema-version`required	`string`	Used to indicate to an MTA processing tool (e.g. a deployer), which schema version was taken as the base when authoring a descriptor. default: `"3.3.0"`
`ID`required	`string`	A globally unique ID of this MTA. Unlimited string of unicode characters.
`version`required	`string`	Application version. Shall follow the semantic versioning standard.
`description`	`string`	A non-translatable description of this MTA. This is not a text for application users.
`provider`	`string`	The provider or vendor of this software.
`copyright`	`string`	A copyright statement from the provider.
`parameters`	`object`	Global parameters related to the MTA application.
`parameters.apply-namespace`	`array`	Apply namespace to application names, service names and application routes.
`parameters.apps-stage-timeout`	`number`	[CF] Defines how long, in seconds, your application can take during staging before the MTA operation times out.
`parameters.apps-start-timeout`	`number`	[CF] Defines how long, in seconds, your application can take to start before the MTA operation times out.
`parameters.apps-task-execution-timeout`	`number`	[CF] Defines how long, in seconds, your application can take to execute a task before the MTA operation times out
`parameters.apps-upload-timeout`	`number`	[CF] Defines how long, in seconds, you can upload your application binary before the MTA operation times out.
`parameters.enable-parallel-deployments`	`boolean`	[CF/XSA] Defines if parallel deployment of modules is enabled. When enabled, modules without explicitly set deployed-after parameter are deployed in parallel.
`parameters.keep-existing-routes`	`boolean`	[CF/XSA] Indicates if the existing routes of all applications within that MTA should be kept.
`parameters.bg-dependency-aware-stop-order`	`boolean`	[CF] Enables dependency-aware stop ordering during the final phase of blue-green deployments.
`parameters-metadata`	`object`	—
`hooks`	`array<object>`	—
`modules`	`array<object>`	A list of modules to be deployed by the MTA application.
`resources`	`array<object>`	A list of resources to be deployed by the MTA application.
`module-types`	`array<object>`	A list of custom module type definitions that will be used by the MTA application.
`resource-types`	`array<object>`	A list of custom resource type definitions that will be used by the MTA application.

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
220 properties, 91% carrying a description, max nesting depth 9.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`anyOf`	JSON Schema Core, draft 2020-12	§10.2.1.2 — "anyOf"
`const`	JSON Schema Validation, draft 2020-12	§6.1.3 — "const"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`minItems`	JSON Schema Validation, draft 2020-12	§6.4.2 — "minItems"
`minimum`	JSON Schema Validation, draft 2020-12	§6.2.4 — "minimum"
`pattern`	JSON Schema Validation, draft 2020-12	§6.3.3 — "pattern"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`required`	JSON Schema Validation, draft 2020-12	§6.5.3 — "required"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"
`uniqueItems`	JSON Schema Validation, draft 2020-12	§6.4.3 — "uniqueItems"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas