webextension.json

description: Use this to include a stylesheet in your popup that will make it look consistent with the browser's UI and with other add-ons that use the browser_style property. Although this key defaults to false, it's recommended that you include it and set it to true.

$ref: #/definitions/icon

description: The popup appears when the user clicks the icon.

description: Tooltip for the main toolbar icon.

description: This introduces some fairly strict policies that will make extensions more secure by default, and provides you with the ability to create and enforce rules governing the types of content that can be loaded and executed by your extensions and applications.

default: script-src 'self'; object-src 'self'

enum: <all_urls> activeTab alarms bookmarks browsingData contextMenus contextualIdentities cookies downloads downloads.open geolocation history identity idle management nativeMessaging notifications proxy sessions storage tabs topSites webNavigation webRequest webRequestBlocking

description: The applications key contains keys that are specific to a particular host application.

description: id is the extension ID

description: Minimum version of Gecko to support. Defaults to '42a1'. (Requires Gecko 45)

description: Maximum version of Gecko to support. Defaults to '*'. (Requires Gecko 45)

description: Link to an add-on update manifest. (Requires Gecko 45)

format: uri

description: "The extension's author, intended for display in the browser's user interface. If the developer key is supplied and it contains the "name" property, it will override the author key. There's no way to specify multiple authors."

description: The background page is an HTML page that runs in the extension process. It exists for the lifetime of your extension, and only one instance of it at a time is active.

description: When false, makes the background page an event page (loaded only when needed).

description: Specify the HTML of the background page.

description: A background page will be generated by the extension system that includes each of the files listed in the scripts property.

description: browser action is a button that your extension adds to the browser's toolbar. The button has an icon, and may optionally have a popup whose content is specified using HTML, CSS, and JavaScript.

description: Defines the part of the browser in which the button is initially placed.

enum: navbar menupanel tabstrip personaltoolbar

default: navbar

description: Use the chrome_settings_overrides key to override certain browser settings

description: Defines the page to be used as the browser's homepage.

description: Use the chrome_url_overrides key to provide a custom replacement for the documents loaded into various special pages usually provided by the browser itself.

description: Provide a replacement for the page that shows the bookmarks.

description: Provide a replacement for the page that shows the browsing history.

description: Provide a replacement for the document that's shown in the "new tab" page

description: Use the commands API to add keyboard shortcuts that trigger actions in your extension, for example, an action to open the browser action or send a command to the extension.

$ref: #/definitions/command

description: Content scripts are JavaScript files that run in the context of web pages.

description: Specifies which pages this content script will be injected into.

description: Excludes pages that this content script would otherwise be injected into.

description: The list of CSS files to be injected into matching pages. These are injected in the order they appear in this array, before any DOM is constructed or displayed for the page.

$ref: #/definitions/scripts

description: The list of JavaScript files to be injected into matching pages. These are injected in the order they appear in this array.

description: Controls when the files in js are injected.

description: Controls whether the content script runs in all frames of the matching page, or only the top frame.

description: Applied after matches to include only those URLs that also match this glob. Intended to emulate the @include Greasemonkey keyword.

description: Applied after matches to exclude URLs that match this glob. Intended to emulate the @exclude Greasemonkey keyword.

description: Whether to insert the content script on about:blank and about:srcdoc.

description: Specifies the subdirectory of _locales that contains the default strings for this extension.

default: en

description: A plain text description of the extension

description: The name of the extension's developer and their homepage URL, intended for display in the browser's user interface.

description: A DevTools extension adds functionality to the Chrome DevTools. It can add new UI panels and sidebars, interact with the inspected page, get information about network requests, and more.

required: paths script scopes

required: paths scopes scripts

description: The URL of the homepage for this add-on. The add-on management page will contain a link to this URL.

description: One or more icons that represent the extension, app, or theme. Recommended format: PNG; also BMP, GIF, ICO, JPEG.

description: Specify how this extension will behave if allowed to run in incognito mode.

enum: spanning split not_allowed

default: spanning

description: One integer specifying the version of the manifest file format your package requires.

description: The name of the extension

description: The omnibox API allows you to register a keyword with Google Chrome's address bar, which is also known as the omnibox.

description: The keyword that will trigger your extension.

description: Use the optional_permissions key to list permissions which you want to ask for at runtime, after your add-on has been installed.

enum: activeTab background bookmarks clipboardRead clipboardWrite contentSettings contextMenus cookies debugger geolocation history idle management notifications pageCapture tabs topSites webNavigation webRequest webRequestBlocking

description: Use the options_ui key to define an options page for your add-on.

description: The path to an HTML file containing the specification of your options page.

description: Use this to include a stylesheet in your page that will make it look consistent with the browser's UI and with other add-ons that use the browser_style property.

description: If true, the options page will open in a normal browser tab, rather than being integrated into the browser's add-ons manager.

description: Use the chrome.pageAction API to put icons inside the address bar. Page actions represent actions that can be taken on the current page, but that aren't applicable to all pages.

description: Tooltip for the main toolbar icon.

description: Permissions help to limit damage if your extension or app is compromised by malware. Some permissions are also displayed to users before installation, as detailed in Permission Warnings.

description: Use this key to register one of more web-based protocol handlers.

description: Use this object to register a single web-based protocol handler

description: A string defining the protocol.

enum: bitcoin geo im irc ircs magnet mailto mms news nntp sip sms smsto ssh tel urn webcal wtai xmpp

description: A pre-existing protocol allowed for use with WebExtensions. See https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/protocol_handlers for more information.

description: A custom-named protocol. These MUST be prefixed with 'web+' or 'ext+', followed by a string consisting of only lower-case ASCII characters.

description: A string representing the name of the protocol handler. This will be displayed to the user when they are being asked if they want this handler to open the link.

description: A string representing the URL of the handler. This string must include "%s" as a placeholder: this will be replaced with the escaped URL of the document to be handled. This URL might be a true URL, or it could be a phone number, email address, or so forth.

description: The short name is typically used where there is insufficient space to display the full name.

description: A sidebar is a pane that is displayed at the left-hand side of the browser window, next to the web page. The browser provides a UI that enables the user to see the currently available sidebars and to select a sidebar to display.

description: The path to an HTML file that specifies the sidebar's contents.

description: Title for the sidebar. This is used in the browser UI for listing and opening sidebars, and is displayed at the top of the sidebar when it is open.

description: One to four dot-separated integers identifying the version of this extension.

description: An array of strings specifying the paths (relative to the package root) of packaged resources that are expected to be usable in the context of a web page.

title: JSON schema for WebExtensions manifest files


gitversion.json

description: Output from the GitVersion tool, describing the current version of the repo it was executed from

$id: #/properties/Major

type: integer

title: Major version part

$id: #/properties/Minor

title: Minor version part

$id: #/properties/Patch

title: Patch version part

$id: #/properties/PreReleaseTag

type: string

title: Pre-release tag

$id: #/properties/PreReleaseTagWithDash

title: Pre-release tag with dash

$id: #/properties/PreReleaseLabel

title: Pre-release label

$id: #/properties/PreReleaseNumber

title: Pre-release number

$id: #/properties/WeightedPreReleaseNumber

title: Weighted pre-release number

description: A summation of branch specific pre-release-weight and the PreReleaseNumber. It can be used to obtain a monotonically increasing version number across the branches

$id: #/properties/BuildMetaData

title: Build metadata

$id: #/properties/BuildMetaDataPadded

title: Build metadata, padded

$id: #/properties/FullBuildMetaData

title: Full build metadata

description: Includes branch and commit hash

$id: #/properties/MajorMinorPatch

title: Major.Minor.Patch version

$id: #/properties/SemVer

title: Semantic version

$id: #/properties/LegacySemVer

title: Legacy semantic version

description: For pre v2.0 compatibility

$id: #/properties/LegacySemVerPadded

title: Legacy semantic version, padded

$id: #/properties/AssemblySemVer

title: Assembly semantic version

description: Semantic version for windows/.NET assembly use. If configured as Major.Minor, gives you the ability to roll out hot fixes to your assembly without breaking existing applications that may be referencing it.

$id: #/properties/AssemblySemFileVer

title: Semantic version for windows/.NET assembly file use. May be used to contain the full version number when AssemblyVersion is set to Major.Minor

$id: #/properties/FullSemVer

title: Full semantic version

$id: #/properties/InformationalVersion

title: Informational version

description: Combined version and build metadata

$id: #/properties/BranchName

title: Branch name

description: Repository branch name

$id: #/properties/EscapedBranchName

title: Escaped branch name

description: Repository branch name, containing only alphanumeric characters and -

$id: #/properties/Sha

title: SHA

description: The commit hash that was used for the build

$id: #/properties/ShortSha

title: Short SHA

description: A shorter representation of the build commit hash

title: NuGet version v2

description: NuGet package version string, using semantic version v2.0

$id: #/properties/NuGetVersion

title: NuGet version

description: NuGet package version string, without semantic version v2.0 format

title: NuGet pre-release tag v2

description: NuGet package pre-release tag for semantic version v2.0

$id: #/properties/NuGetPreReleaseTag

title: NuGetPreReleaseTag

description: NuGet package pre-release tag, without semantic version v2.0 format

$id: #/properties/VersionSourceSha

title: Version source SHA

description: The hash of the commit used as version source

$id: #/properties/CommitsSinceVersionSource

title: Commits since version source

title: Commits since version source, padded

description: The number of commits made since the version source commit (zero-padded)

$id: #/properties/CommitDate

title: Commit date

required: Major Minor Patch PreReleaseTag PreReleaseTagWithDash PreReleaseLabel PreReleaseNumber WeightedPreReleaseNumber BuildMetaData BuildMetaDataPadded FullBuildMetaData MajorMinorPatch SemVer LegacySemVer LegacySemVerPadded AssemblySemVer AssemblySemFileVer FullSemVer InformationalVersion BranchName EscapedBranchName Sha ShortSha NuGetVersionV2 NuGetVersion NuGetPreReleaseTagV2 NuGetPreReleaseTag VersionSourceSha CommitsSinceVersionSource CommitsSinceVersionSourcePadded CommitDate

title: GitVersion Variables

type: object


container-structure-test.json

$id: #/definitions/envVar

required: key value

description: The name of the environment variables

description: The value of the environment variable

$id: #/definitions/label

description: The name of the label

description: The value of the label

type: boolean

description: Interpreted the value as regex

description: The Container Structure Tests provide a powerful framework to validate the structure of a container image. These tests can be used to check the output of commands in an image, as well as verify metadata and contents of the filesystem

description: The schema version of Structure Tests.

type: array

description: A list of command tests

required: name command

description: The name of the test

description: A list of commands (each with optional flags) to run before the actual command under test.

description: A list of commands (each with optional flags) to run after the actual command under test.

$ref: #/definitions/envVar

description: The command to run in the test.

description: The arguments to pass to the command.

description: List of regexes that should match the stdout from running the command.

description: List of regexes that should not match the stdout from running the command..

description: List of regexes that should match the stderr from running the command.

description: List of regexes that should not match the stderr from running the command.

description: Exit code that the command should exit with.

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.

required: name path shouldExist

description: The name of the test

description: Path to the file or directory under test

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

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

type: number

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

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

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

enum: owner group any other

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: The name of the test

description: Path to the file under test

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

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

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.

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

description: A list of other files to check.

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

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

$ref: #/definitions/label

description: The entrypoint of the container

description: The CMD specified in the container

description: The ports exposed in the container.

description: The ports NOT exposed in the container.

description: The volumes exposed in the container.

description: The volumes NOT exposed in the container

description: The default working directory of the container.

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

title: Container Structure Tests


github-discussion.json

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.

description: Definition of the input types in the discussion form

enum: markdown textarea input dropdown checkboxes


lerna.json

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.

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

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

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

description: Enable workspaces integration when using Yarn.

description: Array of globs to use a workspace locations.

description: Array of globs to use a package locations.

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

description: Options for the CLI commands.

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.

type: string array

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.

description: Options for the bootstrap command.

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.

description: Options for the init command.

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

description: Options for the run command.

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

description: Options for the version command.

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

title: A JSON schema for lerna.json files


title: dprint configuration file

description: Schema for a dprint configuration file.

description: The JSON schema reference. Normally you shouldn't bother to provide this as the dprint vscode editor extension will handle constructing the schema for you based on the plugins provided.

description: Whether to format files only when they change.

description: Configurations to extend.

description: A file path or url to a configuration file to extend.

description: A collection of file paths and/or urls to configuration files to extend.

description: The width of a line the printer will try to stay under. Note that the printer may exceed this width in certain cases.

description: The number of characters for an indent.

description: Whether to use tabs (true) or spaces (false) for indentation.

description: The kind of newline to use.

const: auto

description: For each file, uses the newline kind found at the end of the last line.

const: crlf

description: Uses carriage return, line feed.

const: lf

description: Uses line feed.

const: system

description: Uses the system standard (ex. crlf on Windows).

description: Array of patterns (globs) to use to find files to format.

description: Array of patterns (globs) to exclude files or directories to format.

description: Array of plugin URLs to format files.

description: Plugin configuration.


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

description: List of tuning objects

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

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

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

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

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


catalogue-entry-schema.json

title: Catalogue entry

required: description primaryContact filters searchTags

title: Primary contact

description: Contact details for the owner of the asset, i.e. the Product Owner.These details will be used when customers make enquiries or request access to the asset through the portal.

description: must end with `gov.uk`

Jo Doe

role: PO

title: Technical documentation

description: Allows you to provide paths to technical documentation to be published to the portal.

description: Path to the technical documentation, relative to the current working directory.

title: Filters

description: A list of filtering options to improve searchability on the portal. Please check the README file to check the valid combinations of `lifecycle`, `profile`, and `access`.

required: asset_type owner categories visibility lifecycle profile access

enum:
In Development
Pre-Prod
Prod

enum: Strategic Transitional

enum: Open Closed

enum: Deprecated Removed

const: Legacy

const: Closed

enum:
REST API
SOAP API
Event
Datasets

enum:
AME Payments
Citizen Income
Citizen Information
Document Repository Services
Integration
Legacy Bridge
Notifications Platform
Personal Independence Payment
Reference Data Service
Retirement, Bereavement & Care
Common Capabilities
Other

title: Categories

enum:
Address
Awards
Citizen
Data
Document Services
Financial
GUID
SMS
Other

enum: Internal Public

enum:
In Development
Pre-Prod
Prod
Deprecated
Removed

title: The profile Schema

enum: Strategic Transitional Legacy

asset_type: REST API

owner: Integration

visibility: Internal

lifecycle: Prod

profile: Transitional

access: Open

description: Tags to label the asset in order to increase discoverability. Minimum of 3 in CSV format.

title: Related assets

description: A list of other assets that are related to the asset being published. Must match the Asset ID on the related asset's business documentation page on the portal at https://gitlab.com/dwp/integration/api-exchange/exchange-content/-/tree/main/output/dwp/portal/workspaces/primary/content/_catalogueEntries.

description: This is an example service

lifecycle: Pre-Prod

access: Closed


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