publiccode.json

description: While the standard is structured to be meaningful on an international level, there are additional information that can be added that makes sense in specific countries, such as declaring compliance with local laws or regulations. The provided extension mechanism is the usage of country-specific sections.

description:
This key specifies the version to which the current extension schema adheres to, for forward compatibility.

Please note how the value of this key is independent from the top-level publiccodeYmlVersion one (see The Standard (core)). In such a way, the extensions schema versioning is independent both from the core version of the schema and from every other Country.

description: This key contains the full name of one of the technical contacts. It must be a real person; do NOT populate this key with generic contact information, company departments, associations, etc.

description: This key contains the e-mail address of the technical contact. It must be an email address of where the technical contact can be directly reached; do NOT populate this key with mailing-lists or generic contact points like "info@acme.inc". The e-mail address must not be obfuscated. To improve resistance against e-mail collection, use \x64 to replace @, as allowed by the YAML specification.

format: email

description: phone number (with international prefix). This has to be a string.

description: This key contains an explicit affiliation information for the technical contact. In case of multiple maintainers, this can be used to create a relation between each technical contact and each maintainer entity. It can contain for instance a company name, an association name, etc.

required: name until

description: The name of the contractor, whether it's a company or a physical person.

description: This is a date (YYYY-MM-DD). This key must contain the date at which the maintenance is going to end. In case of community maintenance, the value should not be more than 2 years in the future, and thus will need to be regularly updated as the community continues working on the project.

format: date

description: This key points to the maintainer website. It can either point to the main institutional website, or to a more project-specific page or website.

description: The name of the dependency (e.g. MySQL, NFC Reader)

description: The first compatible version

description: The latest compatible version

description: The only major version for which the software is compatible. It assumes compatibility with all patches and bugfixes later applied to this version.

description: Whether the dependency is optional or mandatory

description:
publiccode.yml is a metadata standard for repositories containing software developed or acquired by the Public Administration, aimed at making them easily discoverabile and thus reusable by other entities.

By including a publiccode.yml file in the root of a repository, and populating it with information about the software, technicians and civil servants can evaluate it. Automatic indexing tools can also be built, since the format is easily readable by both humans and machines.

publiccode.yml is mandatory for all public software developed in Italy, according to the national guidelines: this enables the Developers Italia crawler to build the national software catalog. The standard is designed to be interoperable internationally, thus the country-specific keys are separated by the core part and are defined in specific sections that each government can rule.

description: This key specifies the version to which the current publiccode.yml adheres to, for forward compatibility.

description: This key contains the name of the software. It contains the (short) public name of the product, which can be localised in the specific localisation section. It should be the name most people usually refer to the software. In case the software has both an internal "code" name and a commercial name, use the commercial name.

description: This key contains the name of the "suite" to which the software belongs.

description:
A unique identifier for this software. This string must be a URL to the source code repository (git, svn, …) in which the software is published. If the repository is available under multiple protocols, prefer HTTP/HTTPS URLs which don't require user authentication.

Forks created for the purpose of contributing upstream should not modify this file; this helps software parsing publiccode.yml to immediately skip technical forks. On the contrary, a complete fork that is meant to be maintained separately from the original software should modify this line, to give themselves the status of a different project.

description: If the url parameter does not serve a human readable or browsable page, but only serves source code to a source control client, with this key you have an option to specify a landing page. This page, ideally, is where your users will land when they will click a button labeled something like "Go to the application source code". In case the product provides an automated graphical installer, this URL can point to a page which contains a reference to the source code but also offers the download of such an installer.

description:
In case this software is a variant or a fork of another software, which might or might not contain a publiccode.yml file, this key will contain the url of the original project(s).

The existence of this key identifies the fork as a software variant, descending from the specified repositories.

description:
This key contains the latest stable version number of the software. The version number is a string that is not meant to be interpreted and parsed but just displayed; parsers should not assume semantic versioning or any other specific version format.

The key can be omitted if the software is currently in initial development and has never been released yet.

description: This key contains the date at which the latest version was released. This date is mandatory if the software has been released at least once and thus the version number is present.

description: This key contains the path to the logo of the software. Logos should be in vector format; raster formats are only allowed as a fallback. In this case, they should be transparent PNGs, minimum 1000px of width. The key value can be the relative path to the file starting from the root of the repository, or it can be an absolute URL pointing to the logo in raw version. In both cases, the file must reside inside the same repository where the publiccode.yml file is stored.

description: A monochromatic (black) logo. The logo should be in vector format; raster formats are only allowed as a fallback. In this case, they should be transparent PNGs, minimum 1000px of width. The key value can be the relative path to the file starting from the root of the repository, or it can be an absolute URL pointing to the logo in raw version. In both cases, the file must reside inside the same repository where the publiccode.yml file is stored.

description:
A list of Media Types (MIME Types) as mandated in RFC 6838 which the application can handle as input.

In case the software does not support any input, you can skip this field or use application/x.empty.

description:
A list of Media Types (MIME Types) as mandated in RFC 6838 which the application can handle as output.

In case the software does not support any output, you can skip this field or use application/x.empty.

description:
This key specifies which platform the software runs on. It is meant to describe the platforms that users will use to access and operate the software, rather than the platform the software itself runs on.

Use the predefined values if possible. If the software runs on a platform for which a predefined value is not available, a different value can be used.

enum: web windows mac linux ios android

description: A list of words that can be used to describe the software and can help building catalogs of open software.

enum: accounting agile-project-management applicant-tracking application-development appointment-scheduling backup billing-and-invoicing blog budgeting business-intelligence business-process-management cad call-center-management cloud-management collaboration communications compliance-management contact-management content-management crm customer-service-and-support data-analytics data-collection data-visualization digital-asset-management digital-citizenship document-management donor-management e-commerce e-signature email-management email-marketing employee-management enterprise-project-management enterprise-social-networking erp event-management facility-management feedback-and-reviews-management financial-reporting fleet-management fundraising gamification geographic-information-systems grant-management graphic-design help-desk hr ide identity-management instant-messaging inventory-management it-asset-management it-development it-management it-security it-service-management knowledge-management learning-management-system marketing mind-mapping mobile-marketing mobile-payment network-management office online-booking online-community payment-gateway payroll predictive-analysis procurement productivity-suite project-collaboration project-management property-management real-estate-management remote-support resource-management sales-management seo service-desk social-media-management survey talent-management task-management taxes-management test-management time-management time-tracking translation video-conferencing video-editing visitor-management voip warehouse-management web-collaboration web-conferencing website-builder workflow-management

description:
A list of the names of prominent public administrations (that will serve as "testimonials") that are currently known to the software maintainer to be using this software.

Parsers are encouraged to enhance this list also with other information that can obtain independently; for instance, a fork of a software, owned by an administration, could be used as a signal of usage of the software.

description: A link to a public roadmap of the software.

enum: concept development beta stable obsolete

enum: standalone/mobile standalone/iot standalone/desktop standalone/web standalone/backend standalone/other addon library configurationFiles

description: This key explicitly includes certain countries in the intended audience, i.e. the software explicitly claims compliance with specific processes, technologies or laws. All countries are specified using lowercase ISO 3166-1 alpha-2 two-letter country codes.

description: This key explicitly marks countries as NOT supported. This might be the case if there is a conflict between how software is working and a specific law, process or technology. All countries are specified using lowercase ISO 3166-1 alpha-2 two-letter country codes.

description: This key contains a list of tags related to the field of application of the software.

enum: agriculture culture defence education emergency-services employment energy environment finance-and-economic-development foreign-affairs government healthcare infrastructures justice local-authorities manufacturing research science-and-technology security society sport tourism transportation welfare

description:
This section contains a general description of the software. Parsers can use this section for instance to create a web page describing the software.,

Note: since all the strings contained in this section are user-visible and written in a specific language, you must specify the language you are editing the text in (using the IETF BCP 47 specifications) by creating a sub-section with that name. The primary language subtag cannot be omitted, as mandated by the BCP 47.

required: genericName shortDescription

description: This key is an opportunity to localise the name in a specific language. It contains the (short) public name of the product. It should be the name most people usually refer to the software. In case the software has both an internal "code" name and a commercial name, use the commercial name.

description: This key is the "Generic name", which refers to the specific category to which the software belongs. You can usually find the generic name in the presentation of the software, when you write: "Software xxx is a yyy". Notable examples include "Text Editor", "Word Processor", "Web Browser", "Chat" and so on… The generic name can be up to 35 characters long.

description: This key contains a short description of the software. It should be a single line containing a single sentence. Maximum 150 characters are allowed.

description:
This key contains a longer description of the software, between 500 and 10000 chars. It is meant to provide an overview of the capabilities of the software for a potential user. The audience for this text should be that of users of the software, not developers. You can think of this text as the description of the software that would be in its website (if the software had one).

This description can contain some basic markdown: *italic*, **bold**, bullet points and [links](#).

description:
This key contains a reference to the user-level (not developer-level) documentation of the software. The value must be a URL to a hosted version of the documentation.

It is suggested that the URL points to a hosted version of the documentation that is immediately readable through a common web browser in both desktop and mobile format. The documentation should be rendered in HTML and browsable like a website (with a navigation index, a search bar, etc.).

If the documentation is instead available only as a document, put a direct view/download link as URL in this key. You should commit the document as part of the source code repository, and then link to it using the code hosting source browser URL (e.g.: GitHub URL to the file). Prefer using open formats like PDF or ODT for maximum interoperability.

Whichever the format for the documentation, remember to make its source files available under an open license, possibly by committing them as part of the repository itself.

description:
This key contains a reference to the API documentation of the software. The value must be a URL to a hosted version of the documentation.

It is suggested that the URL points to a hosted version of the documentation that is immediately readable through a common web browser. The documentation should be rendered in HTML and browsable like a website (with a navigation index, a search bar, etc.), and if there is a reference or test deployment, possibly offer an interactive interface (e.g. Swagger).

If the documentation is instead available only as a document, put a direct view/download link as URL in this key. You should commit the document as part of the source code repository, and then link to it using the code hosting source browser URL (e.g.: GitHub URL to the file). Prefer using open formats like PDF or ODT for maximum interoperability.

Whichever the format for the documentation, remember to make its source files available under an open license, possibly by committing them as part of the repository itself.

description:
This key contains a list of software features, describing what capabilities the software allows to do. The audience for this text should be that of public decision makers who will be commissioning the software. The features should thus not target developers; instead of listing technical features referring to implementation details, prefer listing user-visible functionalities of the software.

While the key is mandatory, there is no mandatory minimum or maximum number of features that should be listed in this key. Each feature must use a maximum of 100 characters.

The suggested number of features to list is between 5 and 20, depending on the software size and complexity. There is no need for exhaustiveness, as users can always read the documentation for additional information.

description: This key contains one or multiple paths to files showing screenshots of the software. They are meant to give a quick idea on how the software looks like and how it works. The key value can be the relative path to the file starting from the root of the repository, or it can be an absolute URL pointing to the screenshot in raw version. In both cases, the file must reside inside the same repository where the publiccode.yml file is stored.

description:
This key contains one or multiple URLs of videos showing how the software works. Like screenshots, videos should be used to give a quick overview on how the software looks like and how it works. Videos must be hosted on a video sharing website that supports the oEmbed standard; popular options are YouTube and Vimeo.

Since videos are an integral part of the documentation, it is recommended to publish them with an open license.

description: A list of awards won by the software.

description: This string describes the license under which the software is distributed. The string must contain a valid SPDX expression, referring to one (or multiple) open-source license. Please refer to the SPDX documentation for further information.

description:
This string describes the entity that owns the copyright on "most" of the code in the repository. Normally, this is the line that is reported with the copyright symbol at the top of most files in the repo.

It is possible to list multiple owners if required so, using an English sentence. It is also possible to informally refer to a community of group of people like "Linus Torvalds and all Linux contributors".

In case it is not possible to name a main copyright owner, it is possible to omit this key; in those cases, if the repo has a authors file, you can point to it through legal/authorsFile.

description: This string describes the entity that owns this repository; this might or might not be the same entity who owns the copyright on the code itself. For instance, in case of a fork of the original software, the repoOwner is probably different from the mainCopyrightOwner.

description: Some open-source software adopt a convention of identify the copyright holders through a file that lists all the entities that own the copyright. This is common in projects strongly backed by a community where there are many external contributors and no clear single/main copyright owner. In such cases, this key can be used to refer to the authors file, using a path relative to the root of the repository.

description: This section provides information on the maintenance status of the software, useful to evaluate whether the software is actively developed or not.

description: This key describes how the software is currently maintained.

enum: internal contract community none

description: This key describes the entity or entities, if any, that are currently contracted for maintaining the software. They can be companies, organizations, or other collective names.

$ref: #/definitions/Contractor

description:
One or more contacts maintaining this software.

This key describes the technical people currently responsible for maintaining the software. All contacts need to be a physical person, not a company or an organisation. If somebody is acting as a representative of an institution, it must be listed within the affiliation of the contact.

In case of a commercial agreement (or a chain of such agreements), specify the final entities actually contracted to deliver the maintenance. Do not specify the software owner unless it is technically involved with the maintenance of the product as well.

$ref: #/definitions/Contact

description: This section provides an overview of the localization features of the software.

required: localisationReady availableLanguages

description: If yes, the software has infrastructure in place or is otherwise designed to be multilingual. It does not need to be available in more than one language.

description: If present, this is the list of languages in which the software is available. Of course, this list will contain at least one language. The primary language subtag cannot be omitted, as mandated by the BCP 47.

description:
This section provides an overview on the system-level dependencies required to install and use this software.

NOTE: do not list dependencies at the source code level (e.g.: software libraries being used), and focus only on runtime and/or system-level dependencies that must be installed and maintained separately. For instance, a database is a good example of such dependencies.

description: This key contains a list of runtime dependencies that are distributed under an open-source license.

$ref: #/definitions/Dependency

description: This key contains a list of runtime dependencies that are distributed under a proprietary license.

description: This key contains a list of hardware dependencies that must be owned to use the software.

description: This section contains the keys for auto-declaring the compliance with the current legislation, with respect to the following sections. Not including these keys implies that the compliance is not known or not declared.

description: If present and set to yes, the software is compliant with the Italian accessibility laws (L. 4/2004), as further explained in the linee guida di design (Italian language).

description:
If present and set to yes, the software is compliant with the linee guida sull'interoperabilità.

Regulatory reference: Art. 73 del CAD (Italian language).

description: If present and set to yes, the software is compliant with the Misure minime di sicurezza ICT per le Pubbliche amministrazioni (Italian language).

description: If present and set to yes, the software interfaces with SPID - il Sistema Pubblico di Identità Digitale.

description: If present and set to yes, the software interfaces with the Italian electronic ID card (Carta di Identità Elettronica).

description: If present and set to yes, the software interfaces with ANPR.

description: If present and set to yes, the software interfaces with pagoPA.

description: This key represents the administration code inside the Public Administration index (codice IPA).

required: publiccodeYmlVersion name url releaseDate platforms categories developmentStatus softwareType description legal maintenance localisation

title: JSON schema for publiccode.yml


sponge-mixins.json

type: string

description: The dot-separated path to the mixin class relative to the specified package. The class must be annotated with @Mixin

type: object

description: Injection options

type: integer

description: Sets the default minimum of injections that must be successfully applied per injector

description: Sets the default injector group

default: default

type: array

description: Registers injection points for this configuration

description: Sets the maximum allowed number of opcodes that can be shifted in @At annotations. This is hard capped at 5

description: Overwrite options

type: boolean

description: Sets whether the visibility of overwritten methods should be conformed to the target class

description: Sets whether overwriting methods must explicitly be declared through @Overwrite annotations

description: The name of a parent configuration that options get inherited from

description: Target selector. Either the specifies the phase directly or use "@env(PHASE)" separated by '&', '\', or ' '

description: Minimum version of the mixin subsystem required for this configuration

description: Minimum compatibility level required for mixins in this set

description: Determines whether mixin failures in this configuration are considered terminal and stop the game

description: The priority of this configuration. Will be inherited if smaller than 0

description: Default mixin priority for this configuration. Will be inherited if smaller than 0

description: The target package where the mixin classes reside

description: Mixin classes to load in all environments. Class names get prepended with the specified package

description: Mixin classes to load ONLY on client. Class names get prepended with the specified package

description: Mixin classes to load ONLY on server. Class names get prepended with the specified package

description: Sets whether targets' source files will be updated to the mixin source file

description: The path to the reference map resource to use for this configuration

description: Increases log detail level from DEBUG to INFO

description: Name of the mixin config plugin to use for this config


jshintrc.json

description: Prohibit the use of bitwise operators (&, |, ^, etc.)

description: Requires you to always put curly braces around blocks in loops and conditionals

description: Prohibits the use of `==` and `!=` in favor of `===` and `!==`

description: The ECMAScript version to which the code must adhere

description: Requires all `for in` loops to filter object's items with obj.hasOwnProperty()

description: Prohibits overwriting prototypes of native objects such as Array, Date and so on

description: Suppresses warnings about declaring variables inside of control structures while accessing them later from the outside

description: Enables warnings about the use of identifiers which are defined in future versions of JavaScript

description: Suppresses warnings about the __iterator__ property.

description: Prohibits the use of a variable before it was defined

description: Prohibits unnecessary clauses within `switch` statements

description: Max cyclomatic complexity per function

type: boolean integer

description: Max depth of nested blocks

description: Maximum amount of warnings JSHint will produce before giving up

description: Max number of formal parameters allowed per function

description: Max number statements per function

description: Prohibits the use of `arguments.caller` and `arguments.callee`

description: Prohibits the use of the comma operator

description: Warns about `non-breaking whitespace` characters

description: Prohibits the use of constructors for side-effects (without assignment)

description: Suppresses warnings about invalid `typeof`operator values

description: Async functions resolve on their return value. In most cases, this makes returning the result of an AwaitExpression (which is itself a Promise instance) unnecessary

description: Enables warnings for regular expressions which do not include the 'u' flag

description: Suppresses warnings about variable shadowing. i.e. declaring a variable that had been already declared somewhere in the outer scope

type: boolean string

description: Prohibits the use of the grouping operator when it is not strictly required.

description: Requires all code to run in ES5 strict mode

description: Warns when a comma is not placed after the last element in an array or object literal

description: Prohibits the use of explicitly undeclared variables

description: Warns when you define and never use your variables

description: Forbids the use of VariableStatements (`var`) in favor of `let` and `const`

description: Suppresses warnings about the use of assignments in cases where comparisons are expected

description: Suppresses warnings about the `debugger` statements in your code

description: Tells JSHint that your code uses ES3 array elision elements, or empty elements

description: Suppresses warnings about `== null` comparisons

description: Suppresses warnings about the use of `eval`

description: Suppresses warnings about the use of expressions where normally you would expect to see assignments or function calls

description: Suppresses warnings about missing semicolons, but only when the semicolon is omitted for the last statement in a one-line block

description: Suppresses warnings about functions inside of loops

description: Tells JSHint that your code uses Mozilla JavaScript extensions

description: Suppresses warnings about generator functions with no `yield` statement in them

description: Prohibits the use of `++` and `--`

description: Suppresses warnings about the `__proto__` property

description: Suppresses warnings about the use of script-targeted URLs

description: Suppresses warnings about constructions like `new function () { ... };` and `new Object;`

description: Suppresses warnings about possible strict violations when the code is running in strict mode and you use `this` in a non-constructor function

description: Suppresses warnings about the use of the `with` statement

description: [Environment] Web Browser (window, document, etc)

description: [Environment] Browserify

description: [Environment] CouchDB

description: [Environment] Development/debugging (alert, confirm, etc)

description: [Environment] Dojo Toolkit

description: [Environment] Jasmine unit testing framework

description: [Environment] jQuery

description: [Environment] Mocha unit testing framework

description: [Environment] ES6 module

description: [Environment] MooTools

description: [Environment] Node.js

description: [Environment] Widely adopted globals (escape, unescape, etc)

description: [Environment] PhantomJS runtime environment

description: [Environment] Prototype JavaScript framework

description: [Environment] Rhino

description: [Environment] Defines globals exposed by the ShellJS library

description: [Environment] Defines globals for typed array constructors

description: [Environment] Web Workers

description: [Environment] Windows Scripting Host

description: [Environment] Yahoo User Interface

description: Specify a white list of global variables that are not formally defined in the source code

description: Name of the global. Set to `true` for read/write, `false` for read-only.

description: Specify the path to another configuration file to use as a base, relative to the current file

description: Specify the options that should only be applied to files matching a given path pattern

description: The path pattern to apply the given options to

title: JSON schema for JSHint configuration files


liquibase-flow-file-latest.json

title: Liquibase Flow File

$ref: #/$defs/variable

description: Include other properties files as global variables, accessible in any stage. The key value pairs in the included file are imported with a prefix appended; the prefix is specified here as the key.

description: Variables which can be accessed in any stage. Variables can be used in the definition of other variables, and may be defined in any order.

$ref: #/$defs/stage

description: This stage runs after all of the stages in the stages block. The end stage is guaranteed to execute. If there is an exception in any stage, the end stage will still execute.

description: Variables which can be accessed only in this stage. Variables can be used in the definition of other variables, and may be defined in any order.

$ref: #/$defs/action

description: The actions to run in this stage.

description: Conditional control of whether the stage is executed or skipped

additionalProperties: false

description: Specify the type of the action. If omitted or left empty, it is assumed that the type is 'liquibase'.

type: number string boolean object array null


fabric.mod.json

description: The language adapter to use

description: The entrypoint function or class

description: The entrypoint function or class

description: Contact e-mail pertaining to the mod

description: IRC channel pertaining to the mod. Must be of a valid URL format

description: Project or user homepage. Must be a valid HTTP/HTTPS address

description: Project issue tracker. Must be a valid HTTP/HTTPS address

description: Project source code repository. Must be a valid URL

description: Custom contact or profile informations

enum: * client server

description: The environment where this mod will be loaded

description: A string value pointing to a path from the root of the JAR to a nested JAR which should be loaded alongside the outer mod JAR

description: The name of the person

description: The name of the person

description: Contact information for the person

$ref: #/definitions/contactInfo

$ref: #/definitions/versionRange

description: Multiple version ranges that are combined with an "OR" relationship - only one of the ranges needs to match

description:
A version range that matches versions. The following variants are supported:

- A single asterisk matches any version.
- Ranges following NPM semver specification including >=, >, =, <, <=, X-ranges (1.x), tilde ranges (fixed minor) and caret ranges (fixed major).
- Additionally exact string matches will always be performed.

x-intellij-html-description:
A version range or an array of those that match versions. The following variants are supported:

* matches any version.

Ranges following NPM semver specification:

>=, >, =, < and <

X-ranges to specify variable components, e.g. 1.x

tilde ranges that allow patch version changes, e.g. ~1.2.3

caret ranges that allow up to minor version changes, e.g. ^1.2.3

Exact string matches are always performed as well.

If an array of ranges is used, they're treated as in an "OR" relationship - only one of the ranges needs to match.

markdownDescription:
A version range or an array of those that match versions. The following variants are supported:

- `*` matches any version.
- Ranges following [NPM semver specification](https://docs.npmjs.com/about-semantic-versioning):
  - `>=`, `>`, `=`, `<` and `<=`
  - X-ranges to specify variable components, e.g. `1.x`
  - tilde ranges that allow patch version changes, e.g. `~1.2.3`
  - caret ranges that allow up to minor version changes, e.g. `^1.2.3`
- Exact string matches are always performed as well.

If an array of ranges is used, they're treated as in an "OR" relationship - only one of the ranges needs to match.

description: The mod identifier

description: The mod version

description: The version of the fabric.mod.json schema

$ref: #/definitions/environment

$ref: #/definitions/entrypoint

description: The entrypoint for all environments (classes must implement ModInitializer)

description: The entrypoint for the client environment (classes must implement ClientModInitializer)

description: The entrypoint for the server environment (classes must implement DedicatedServerModInitializer)

description: The entrypoint called just before the game instance is created (classes must implement PreLaunchEntrypoint)

description: The entrypoint for the data generator environment (classes must implement DataGeneratorEntrypoint)

description: The entrypoint for the Game Test environment (classes must implement FabricGameTest)

description: Custom mod entrypoints

description: The entrypoints used by this mod

description: Contains an array of nestedJar objects

$ref: #/definitions/nestedJar

description: A string→string dictionary, connecting namespaces to LanguageAdapter implementations

description: Path to mixin file from the root of the JAR

description: Path to an access widener definition file

description: id→versionRange map for dependencies. Failure to meet these causes a hard failure

$ref: #/definitions/versionRanges

description: id→versionRange map for dependencies. Failure to meet these causes a soft failure (warning)

description: id→versionRange map for dependencies. Are not matched and are mainly used as metadata

description: id→versionRange map for dependencies. A successful match causes a soft failure (warning)

description: id→versionRange map for dependencies. A successful match causes a hard failure

description: Name of the mod

description: Description of the mod

$ref: #/definitions/person

description: The direct authorship information

description: Contributors to this mod

description: Contact information for the mod

description: The license the mod uses

description: The path to a single .PNG file from the root of the JAR

description: A string→string dictionary, where the keys conform to widths of each PNG file, and the values are said files' paths

description: A map of namespace:id→value for custom data fields.

required: id version schemaVersion


hadolint.json

title: JSON Schema for Hadolint, a Dockerfile linter tool

description: Dockerfile linter, validate inline bash, written in Haskell

description: Disable inline ignore pragmas `# hadolint ignore=DLxxxx`

description: A threshold controlling how severe a rule violation must be before the return code indicates failure.

const: error

description: Never return failure.

const: warning

description: Return failure if only rules of severity above `warning` are violated

const: info

description: Return failure if only rules of severity above `info` are violated

const: style

description: Return failure if only rules of severity above `style` are violated

const: ignore

description: Return failure if any rule is violated.

description: Return failure if any rule is violated.

enum: tty json checkstyle codeclimate gitlab_codeclimate gnu codacy

description: Output format

description: Strictly adhere to label-schem, don't allow additional labels.

description: A label-schema. See https://github.com/hadolint/hadolint#linting-labels for reference.

description: Don't colorize output.

description: Don't exit with a failure status code when any rule is violated.

description: A list of rules to be treated with "error" severity

$ref: #/properties/ignored/items

description: A list of rules to be treated with "warning" severity

description: A list of rules to be treated with "info" severity

description: A list of rules to be treated with "style" severity

description: A list of rules to be ignored

description: Use absolute WORKDIR.

description: For some bash commands it makes no sense running them in a Docker container like ssh, vim, shutdown, service, ps, free, top, kill, mount, ifconfig.

description: Last user should not be root.

description: Use WORKDIR to switch to a directory.

description: Do not use sudo as it leads to unpredictable behavior. Use a tool like gosu to enforce root.

description: Do not use apt-get upgrade or dist-upgrade.

description: Always tag the version of an image explicitly.

description: Using latest is prone to errors if the image will ever update. Pin the version explicitly to a release tag.

description: Pin versions in apt-get install.

description: Delete the apt-get lists after installing something.

description: Use ADD for extracting archives into an image.

description: Valid UNIX ports range from 0 to 65535.

description: Multiple `HEALTHCHECK` instructions.

description: Pin versions in pip.

description: Use the `-y` switch.

description: Avoid additional packages by specifying --no-install-recommends.

description: Pin versions in `npm`.

description: Pin versions in apk add. Instead of `apk add <package>` use `apk add <package>=<version>`.

description: Use the `--no-cache` switch to avoid the need to use `--update` and remove `/var/cache/apk/*` when done installing packages.

description: Use `COPY` instead of `ADD` for files and folders.

description: `COPY` with more than 2 arguments requires the last argument to end with `/`

description: `COPY --from` should reference a previously defined `FROM` alias

description: `COPY --from` cannot reference its own `FROM` alias

description: `FROM` aliases (stage names) must be unique

description: Use arguments JSON notation for CMD and ENTRYPOINT arguments

description: Use only an allowed registry in the FROM image

description: Do not use `apt` as it is meant to be an end-user tool, use `apt-get` or `apt-cache` instead

description: Pin versions in gem install. Instead of `gem install <gem>` use `gem install <gem>:<version>`

description: Do not use --platform flag with FROM.

description: Use the `-y` switch to avoid manual input `yum install -y <package>`

description: `yum clean all` missing after yum command.

description: Specify version with `yum install -y <package>-<version>`

description: Non-interactive switch missing from `zypper` command: `zypper install -y`

description: Do not use `zypper dist-upgrade`.

description: `zypper clean` missing after zypper use.

description: Specify version with `zypper install -y <package>[=]<version>`.

description: Use the `-y` switch to avoid manual input `dnf install -y <package>`

description: `dnf clean all` missing after dnf command.

description: Specify version with `dnf install -y <package>-<version>`

description: Avoid cache directory with `pip install --no-cache-dir <package>`.

description: `ONBUILD`, `FROM` or `MAINTAINER` triggered from within `ONBUILD` instruction.

description: Do not refer to an environment variable within the same `ENV` statement where it is defined.

description: `COPY` to a relative destination without `WORKDIR` set.

description: `useradd` without flag `-l` and high UID will result in excessively large Image.

description: `wget` without flag `--progress` will result in excessively bloated build logs when downloading larger files.

description: Invalid Label Key

description: Label `<label>` is missing.

description: Superfluous label(s) present.

description: Label `<label>` is empty.

description: Label `<label>` is not a valid URL.

description: Label `<label>` is not a valid time format - must conform to RFC3339.

description: Label `<label>` is not a valid SPDX license identifier.

description: Label `<label>` is not a valid git hash.

description: Label `<label>` does not conform to semantic versioning.

description: `HEALTHCHECK` instruction missing.

description: Label `<label>` is not a valid email format - must conform to RFC5322.

description: Multiple consecutive `RUN` instructions. Consider consolidation.

description: `yarn cache clean` missing after `yarn install` was run.

description: MAINTAINER is deprecated.

description: Either use Wget or Curl but not both.

description: Multiple `CMD` instructions found.

description: Multiple `ENTRYPOINT` instructions found.

description: Use `SHELL` to change the default shell.

description: Set the `SHELL` option -o pipefail before `RUN` with a pipe in it

description: `$` is not used specially and should therefore be escaped.

description: This `\c` will be a regular `'c'`  in this context.

description: Remove space after `=` if trying to assign a value (or for empty string, use `var='' ...`).

description: Use semicolon or linefeed before `done` (or quote to make it literal).

description: This is a unicode non-breaking space. Delete it and retype as space.

description: You need a space here

description: It's not `foo &; bar`, just `foo & bar`.

description: Trying to declare parameters? Don't. Use `()` and refer to params as `$1`, `$2` etc.

description: Don't use $ on the left side of assignments.

description: Don't put spaces around the `=` in assignments.

description: For command expansion, the tick should slant left (\` vs ´).

description: Did you forget to close this double-quoted string?

description: This is actually an end quote, but due to next char, it looks suspect.

description: Scripts are case sensitive. Use `if`, not `If`.

description: This `{/}` is literal. Check expression (missing `;/\n`?) or quote it.

description: Don't use `$` on the iterator name in for loops.

description: Braces are required when expanding arrays, as in `${array[idx]}`.

description: You need a space or linefeed between the function name and body.

description: Unexpected `==`. For assignment, use `=`. For comparison, use `[ .. ]` or `[[ .. ]]`.

description: Quote/escape special characters when using `eval`, e.g. `eval "a=(b)"`.

description: You need a space before the `#`.

description: Useless cat. Consider `cmd < file | ..` or `cmd file | ..` instead.

description: Note that `A && B || C` is not if-then-else. C may run when A is true.

description: This word is outside of quotes. Did you intend to 'nest '"'single quotes'"' instead'?

description: `echo` won't expand escape sequences. Consider `printf`.

description: Use `./*glob*` or `-- *glob*` so names with dashes won't become options.

description: In POSIX sh, something is undefined.

description: Quote this to prevent word splitting

description: Double quote to prevent globbing and word splitting.

description: Word is in the form `"A"B"C"` (B indicated). Did you mean `"ABC"` or `"A\"B\"C"`?

description: var is referenced but not assigned.

description: Declare and assign separately to avoid masking return values.

description: Use `cd ... || exit` in case `cd` fails.

description: In POSIX sh, 'source' in place of '.' is undefined.

description: A list of trusted registries. Ex: docker.io


license-report-config.json

description: license report output format

description: HTML output format

description: passed directly to tableify (see: https://github.com/kessler/node-tableify)

description: CSV output format

default: false

description: CSV output format: escape fields containing delimiter character

description: export deps. or deps/dev-/opt-/peer- deps. falsey -> output everything

description: NPM registry URL

description: package names that will be excluded from the report

description: fields participating in the report and their order

enum: department relatedTo name licensePeriod material licenseType link remoteVersion installedVersion author

default: comment

type: number

description: path to the package.json

title: JSON schema for license report tool configuration file


drupal-links-task.json

title: The static title for the local task

title: The translation context for the title value.

title: The name of the route this task links to

title: Parameters for route variables when generating a link

title: The route name where the root tab appears

title: The plugin ID of the parent tab

title: The weight of the tab

title: Array of link options

title: Class for task implementations

title: Deriver class

title: Cache tags

title: JSON schema for Drupal task links file


box.schema.json

description: CFML engine the package supports

title: Engine Type

description: The name of the engine

enum: railo lucee adobe

title: Engine Version

description: The semantic version of the engine that is supported

title: Dependency

description: Dependencies are specified with a package name/slug to version range, local file path, URL, or Git/SVN endpoint. The version range is a string which has one or more space-separated descriptors.

description: A person who has been involved in creating or maintaining this package

type: object string

description: Name of the person

description: URL for the person

format: uri

description: Email address of the person

title: Package Manifest

description: Configuration file for a CFML package

title: Name

description: The name of the package

title: Slug

description: ForgeBox unique slug

title: Version

description: Semantic version of your package

title: Author

description: Author of this package

title: Location

description: Location of where to download the package. Overrides ForgeBox location

title: Directory

description: Install directory where this package should be placed once installed. If not defined, it installs were the CommandBox command was executed.

title: Create Package Directory

description: This determines if the container directory will contain a sub-directory according to the package slug name. The default is true

title: Package Directory

description: This name will be used for the package sub-directory instead of the slug name

title: Homepage

description: Project homepage URL

title: Documentation

description: Documentation URL

title: Repository

description: Source repository

title: Repository Type

description: The version control system. Popular examples are git, svn, or mercurial

title: Repository URL

description: The URL at which the repository resides

title: Bugs

description: Bug issue management URL

title: Short Description

description: ForgeBox short description

title: Description

description: ForgeBox big description. If not set, it can be taken from a Readme.md, Readme, or Readme.txt

title: Instructions

description: Install instructions. If not set, it can be taken from a instructions.md, instructions, or instructions.txt

title: Change Log

description: Change log. If not set, it can be taken from a changelog.md, changelog, or changelog.txt

title: Type

description: ForgeBox contribution type

enum: caching cf-engines cfbuilder-extensions cfwheels-plugins cms commandbox-commands commandbox-modules commandbox-recipes contentbox-modules contentbox-themes contentbox-widgets demos di interceptors logging lucee-extensions messaging-queues modules mvc nosql plugins preside-extensions preside-skeletons projects testing wirebox-aspects wirebox-listeners

title: Keywords

description: ForgeBox keywords

type: array string

title: Keyword

description: ForgeBox keyword

title: Private

description: Designates the package as a private ForgeBox package. Private packages are not publicly accessible, but still offer all the benefits of ForgeBox.

title: Engines

description: CFML engines the package supports

$ref: #/definitions/engine

description: The name of the default CFML engine for the `start` command to use.

description: Deprecated. The HTTP port the server will be started on when you use the start command. Use `port` in `server.json` instead.

title: Project URL

description: Default project URL if not using CommandBox start server commands

title: Licenses

description: List of licenses the package can have

title: License

description: A license the package can have

title: License Type

description: The license type. For example, MIT.

title: License URL

description: The URL at which the license resides

title: Contributors

description: Contributors to the package

$ref: #/definitions/dependency

title: Install Paths

description: Tracks install locations so uninstall can work. The key is the package name/slug and the value is the path

title: Scripts

description: Set of script commands that correspond to the interception points in CommandBox or arbitrary names that can be run with the `run-script` command

description: Run BEFORE the package is installed

description: Run WHILE the package is installed

description: Run AFTER the package is installed

description: Run BEFORE the package is uninstalled

description: Run AFTER the package is uninstalled

description: Run BEFORE bump the package version

description: Run AFTER bump the package version, but BEFORE Git repo is tagged

description: Run AFTER bump the package version and AFTER Git repo is tagged

description: Run BEFORE the package is published

description: Run AFTER the package is published

title: Ignore

description: List of file globs to ignore when installing the package similar to .gitignore patterns

description: Ignore glob pattern

title: TestBox

description: TestBox integration

title: TestBox Runner

description: The URI location of the test runner for an app or several with slug names

type: string array

description: The runner URIs mapped to slug names

title: Labels List

description: A list of labels to only include when running the tests

description: A label a spec must have to be ran

title: Exclude List

description: A list of labels to exclude when running the tests

description: A label to be excluded from the test run

title: CF Migrations

description: Configuration object for CF Migration database settings.

title: Migrations Directory

description: Location of generated migration files that migration commands will use.

title: Database Schema

title: Migrations Directory

title: Database Password

title: Database Connection String

title: Database class

title: Database Username

title: Default Grammar

description: Name of the qb service to use for grammar.


package-configuration-schema.json

title: ORT package configuration

description: The OSS-Review-Toolkit (ORT) provides a possibility to define path excludes and license finding curations for a specific package (dependency) and provenance in a package configuration file. A full list of all available options can be found at https://github.com/oss-review-toolkit/ort/blob/main/docs/config-file-package-configuration-yml.md.

$ref: #/definitions/licenseFindingCurations

$ref: #/definitions/pathExcludeReason

required: pattern reason

$ref: #/definitions/vcsMatcher

type: integer string

required: path concluded_license reason


webhook.json

title: Discord Webhook

description: Discord Webhook JSON Schema

$ref: #/definitions/string

description: Allow $schema because additionalProperties is false

description:
The message contents
Max is 2000 characters

description:
Override the default username of the webhook
Name cannot contain "clyde"

description: Override the default avatar of the webhook

$ref: #/definitions/url

description:
Whether or not this message will play in TTS
Default is false

$ref: #/definitions/boolean

description:
Embedded rich content
Max is 6000 characters

description:
Title of embed
Max is 256 characters

description:
Description of embed
Max is 4096 characters

description:
URL of embed
Only support http / https

description:
Timestamp of embed content
ISO8601 Timestamp

format: date-time

description:
Color code of the embed
Only support color in decimal
To match embed background color, use 3092790
Default is 2105893

description: Footer information

description:
Footer text
Max is 2048 characters

description:
URL of footer icon
Only support http / https

description: Image information

description:
Source url of image
Only support http / https

description: Thumbnail information

description:
Source url of thumbnail
Only support http / https

description: Author information

description:
Name of author
Max is 256 characters

description:
URL of author
Only support http / https

description:
URL of author icon
Only support http / https

description: Fields information

description: Fields information

required: name value

description:
Name of the field
REQUIRED Max is 256

description:
Value of the field
REQUIRED Max is 1024

description:
Whether or not this field should display inline
Default is false

description: Allowed mentions for the message

description: An array of allowed mention types to parse from the content.

enum: roles users everyone

description:
Array of role_ids to mention
Max is 100 of role_ids
Mutually exclusive with parse roles

$ref: #/definitions/id

description:
Array of user_ids to mention
Max is 100 of user_ids
Mutually exclusive with parse users


geojson.json

title: Coordinates

title: Geometry

description: A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.

title: Feature

description:
A GeoJSON object with the type `Feature` is a feature object.

* A feature object must have a member with the name `geometry`. The value of the geometry member is a geometry object as defined above or a JSON null value.

* A feature object must have a member with the name `properties`. The value of the properties member is an object (any JSON object or a JSON null value).

* If a feature has a commonly used identifier, that identifier should be included as a member of the feature object with the name `id`.

required: geometry properties

title: Geometry

$ref: #/definitions/geometry

title: Properties

title: Linear Ring Coordinates

$ref: #/definitions/lineStringCoordinates

title: Line String Coordinates

$ref: #/definitions/coordinates

$ref: #/definitions/position

title: Polygon Coordinates

description: For type `Polygon`, the `coordinates` member must be an array of LinearRing coordinate arrays. For Polygons with multiple rings, the first must be the exterior ring and any others must be interior rings or holes.

$ref: #/definitions/linearRingCoordinates

title: Position

description:
A position is the fundamental geometry construct. The `coordinates` member of a geometry object is composed of one position (in the case of a Point geometry), an array of positions (LineString or MultiPoint geometries), an array of arrays of positions (Polygons, MultiLineStrings), or a multidimensional array of positions (MultiPolygon).

A position is represented by an array of numbers. There must be at least two elements, and may be more. The order of elements must follow x, y, z order (easting, northing, altitude for coordinates in a projected coordinate reference system, or longitude, latitude, altitude for coordinates in a geographic coordinate reference system). Any number of additional elements are allowed -- interpretation and meaning of additional elements is beyond the scope of this specification.

description: This object represents a geometry, feature, or collection of features.

title: Point

description: For type `Point`, the `coordinates` member must be a single position.

title: Multi Point Geometry

description: For type `MultiPoint`, the `coordinates` member must be an array of positions.

title: Line String

description:
For type `LineString`, the `coordinates` member must be an array of two or more positions.

A LinearRing is closed LineString with 4 or more positions. The first and last positions are equivalent (they represent equivalent points). Though a LinearRing is not explicitly represented as a GeoJSON geometry type, it is referred to in the Polygon geometry type definition.

title: MultiLineString

description: For type `MultiLineString`, the `coordinates` member must be an array of LineString coordinate arrays.

title: Polygon

$ref: #/definitions/polygonCoordinates

title: Multi-Polygon Geometry

description: For type `MultiPolygon`, the `coordinates` member must be an array of Polygon coordinate arrays.

title: Geometry Collection

description:
A GeoJSON object with type `GeometryCollection` is a geometry object which represents a collection of geometry objects.

A geometry collection must have a member with the name `geometries`. The value corresponding to `geometries` is an array. Each element in this array is a GeoJSON geometry object.

title: Geometries

$ref: #/definitions/feature

title: Feature Collection

description:
A GeoJSON object with the type `FeatureCollection` is a feature collection object.

An object of type `FeatureCollection` must have a member with the name `features`. The value corresponding to `features` is an array. Each element in the array is a feature object as defined above.

title: Features

title: Type

description: The type of GeoJSON object.

enum: Point MultiPoint LineString MultiLineString Polygon MultiPolygon GeometryCollection Feature FeatureCollection

title: Coordinate Reference System (CRS)

description:
The coordinate reference system (CRS) of a GeoJSON object is determined by its `crs` member (referred to as the CRS object below). If an object has no crs member, then its parent or grandparent object's crs member may be acquired. If no crs member can be so acquired, the default CRS shall apply to the GeoJSON object.

* The default CRS is a geographic coordinate reference system, using the WGS84 datum, and with longitude and latitude units of decimal degrees.

* The value of a member named `crs` must be a JSON object (referred to as the CRS object below) or JSON null. If the value of CRS is null, no CRS can be assumed.

* The crs member should be on the top-level GeoJSON object in a hierarchy (in feature collection, feature, geometry order) and should not be repeated or overridden on children or grandchildren of the object.

* A non-null CRS object has two mandatory members: `type` and `properties`.

* The value of the type member must be a string, indicating the type of CRS object.

* The value of the properties member must be an object.

* CRS shall not change coordinate ordering.

required: type properties

title: CRS Type

title: CRS Properties

title: Link Object

title: href

description: The value of the required `href` member must be a dereferenceable URI.

title: Link Object Type

description: The value of the optional `type` member must be a string that hints at the format used to represent CRS parameters at the provided URI. Suggested values are: `proj4`, `ogcwkt`, `esriwkt`, but others can be used.

title: Bounding Box

description: To include information on the coordinate range for geometries, features, or feature collections, a GeoJSON object may have a member named `bbox`. The value of the bbox member must be a 2*n array where n is the number of dimensions represented in the contained geometries, with the lowest values for all axes followed by the highest values. The axes order of a bbox follows the axes order of geometries. In addition, the coordinate reference system for the bbox is assumed to match the coordinate reference system of the GeoJSON object of which it is a member.

title: GeoJSON Object


cryproj.dev.schema.json

$comment: JSON Schema for CRYENGINE dev

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

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


web-types.json

description: Language in which JavaScript objects types are specified.

description: Markup language in which descriptions are formatted.

enum: html markdown none

description: Provide configuration for the specified web framework. This is an advanced feature, which is used to provide support for templating frameworks like Angular, Vue, Svelte, etc.

$ref: #/definitions/enablement-rules

$ref: #/definitions/disablement-rules

description: In many frameworks symbols can have multiple versions of a name. Specify canonical name conversion rule for names of particular symbol kinds against which comparisons will be made. Format of the 'canonical-names' property names is '{namespace}/{symbol kind}'. By default symbol names in HTML namespace are converted to lower-case, and in CSS and JS namespaces are left as-is. In case of name patterns, rules are applied to each part of the pattern separately, so even if the symbol with pattern is in HTML namespace, references to JS events will be case-sensitive.

$ref: #/definitions/name-converter

description: Provide an array of name conversions, in which particular symbol kinds should be matched against canonical names of symbols. By default symbol names are converted using canonical-names rule.

$ref: #/definitions/name-converters

description: Provide an array of name conversions, in which particular symbol kinds should be proposed in auto completion. Format of the 'name-variants' property names is '{namespace}/{symbol kind}'. All symbol kinds are by default provided as-is.

description: Specify rules for enabling web framework support. Only one framework can be enabled in a particular file. If you need your contributions to be enabled in all files, regardless of the context, do not specify the framework.

description: Node.js package names, which enable framework support within the folder containing the package.json.

description: RegExps to match script URLs, which enable framework support within a particular HTML.

$ref: #/definitions/pattern

description: Extensions of files, which should have the framework support enabled. Use this to support custom file extensions like '.vue' or '.svelte'. Never specify generic extensions like '.html', '.js' or '.ts'. If you need your contributions to be present in every file don't specify the framework at all

description: RegExp patterns to match file names, which should have the framework support enabled. Use carefully as broken pattern may even freeze IDE.

description: Global JavaScript libraries names enabled within the IDE, which enable framework support in the whole project

description: Specify rules for disabling web framework support. These rules take precedence over enable-when rules. They allow to turn off framework support in case of some conflicts between frameworks priority.

description: Extensions of files, which should have the framework support disabled

description: RegExp patterns to match file names, which should have the framework support disabled

enum: as-is PascalCase camelCase lowercase UPPERCASE kebab-case snake_case

description: Relative path to the icon representing the symbol.

description: The base for any contributions.

$ref: #/definitions/name

$ref: #/definitions/description

$ref: #/definitions/description-sections

$ref: #/definitions/doc-url

$ref: #/definitions/icon

$ref: #/definitions/source

$ref: #/definitions/deprecated

$ref: #/definitions/experimental

$ref: #/definitions/priority

$ref: #/definitions/proximity

$ref: #/definitions/virtual

$ref: #/definitions/abstract

$ref: #/definitions/extension

$ref: #/definitions/extends

$ref: #/definitions/name-pattern-root

$ref: #/definitions/html

$ref: #/definitions/css

$ref: #/definitions/js

$ref: #/definitions/exclusive-contributions

description: The base for any contribution, which can possibly have a JS type.

$ref: #/definitions/base-contribution

$ref: #/definitions/type-list

description: A generic contribution. All contributions are of this type, except for HTML attributes and elements, as well as predefined CSS contribution kinds.

$ref: #/definitions/typed-contribution

$ref: #/definitions/default

$ref: #/definitions/required

$ref: #/definitions/html-attribute-value

description: Specify type according to selected language for type syntax. The type can be specified by a string expression, an object with list of imports and an expression, or an array of possible types.

$ref: #/definitions/type

$ref: #/definitions/type-reference

description: Name of module, which exports the type. May be omitted, in which case it's assumed to be the name of the library.

description: Name of the symbol to import

description: Provide one of special attribute value types:  "enum", "of-match", or a simple JavaScript type according to the specified type format.

description: Allows to specify the source of the entity. For Vue.js component this may be for instance a class.

description: Path to the file, relative to the web-types JSON.

description: Offset in the file under which the source symbol, like class name, is located.

required: file offset

description: Name of module, which exports the symbol. May be omitted, in which case it's assumed to be the name of the library.

description: Name of the exported symbol.

description: Short description to be rendered in documentation popup. It will be rendered according to description-markup setting.

description: Custom sections to be shown below description in the documentation popup.

description: Link to online documentation.

description: Mark contribution as virtual. Virtual contributions can be filtered out if needed in references. A virtual contribution meaning may differ by framework or kind contexts, but usually means something synthetic or something, which gets erased in the runtime by the framework. E.g. Vue or Angular attribute bindings are virtual.

description: Mark contribution as abstract. Such contributions serve only as super contributions for other contributions.

description: Mark contribution as an extension. Such contributions do not define a new contribution on their own, but can provide additional properties or contributions to existing contributions.

enum: lowest low normal high highest

$ref: #/definitions/name-pattern

description:
Specify list of contribution kinds qualified with a namespace, for which during reference resolution this will be the final contribution host. E.g. if a special HTML element does not accept standard attributes, add:
"exclusive-contributions": ["/html/attributes"].

description: A reference to an element in Web-Types model.

description: A RegEx pattern to match whole content. Syntax should work with at least ECMA, Java and Python implementations.

description: HTML elements.

description: HTML attributes.

description: DOM events are deprecated in HTML namespace. Contribute events to JS namespace: /js/events

description: Contains contributions to HTML namespace. It's property names represent symbol kinds, its property values contain list of contributions of particular kind. There are 2 predefined kinds, which integrate directly with IDE - HTML elements and HTML attributes. There are also 2 deprecated kinds: tags (which is equivalent to 'elements') and 'events' (which was moved to JS namespace)

description: Deprecated, use `elements` property.

description: Deprecated vue-specific property - contribute Vue directives to /contributions/html/vue-directives

deprecationMessage: Contribute Vue directives to /contributions/html/vue-directives

description: CSS properties

description: CSS pseudo-elements

description: CSS pseudo-classes

description: CSS functions

description: CSS classes

description: Contains contributions to CSS namespace. It's property names represent symbol kinds, its property values contain list of contributions of particular kind. There are 5 predefined kinds, which integrate directly with IDE - properties, classes, functions, pseudo-elements and pseudo-classes.

description: Specify whether the pseudo-element requires arguments.

description: Specify whether the pseudo-class requires arguments.

description: DOM events

description: JavaScript properties of an object, HTML tag, framework component, etc.

description: Contains contributions to JS namespace. It's property names represent symbol kinds, its property values contain list of contributions of particular kind. There are 2 predefined kinds, which integrate directly with IDE - properties and events.

description: Deprecated, use top-level js-types-syntax property.

description: Deprecated, use top-level property.

description: Whether directive requires an argument

description: Framework, for which the components are provided by the library. If the library is not enabled in a particular context, all symbols from this file will not be available as well. If you want symbols to be always available do not specify framework.

description: Name of the library.

description: Version of the library, for which Web-Types are provided.

description: Symbol can be contributed to one of the 3 namespaces - HTML, CSS and JS. Within a particular namespace there can be different kinds of symbols. In each of the namespaces, there are several predefined kinds, which integrate directly with IDE, but providers are free to define their own.

title: JSON schema for Web-Types


dotnetcli.host.json

pattern: ^(true|false)$

$ref: #/definitions/symbolInfo

title: JSON schema for .NET CLI template host files


ava.json

$ref: #/definitions/path

description: Configuration Schema for the JavaScript test runner AVA

$ref: #/definitions/array-of-paths

description: An array of glob patterns to select test files. Files with an underscore prefix are ignored. By default only selects files with `cjs`, `mjs` & `js` extensions, even if the pattern matches other files. Specify `extensions` to allow other file extensions

description: An array of glob patterns to match files that, even if changed, are ignored by the watcher

description: Not typically useful in the `package.json` configuration, but equivalent to specifying `--match` on the CLI

description: Defaults to `true` to cache compiled files under `node_modules/.cache/ava.` If `false`, files are cached in a temporary directory instead

description: Max number of test files running at the same time (default: CPU cores)

description: Use worker threads to run tests (enabled by default). If `false`, tests will run in child processes

description: Stop running further tests once a test fails

description: If `false`, does not fail a test if it doesn't run assertions

title: environment variables

description: Specifies environment variables to be made available to the tests. The environment variables defined here override the ones from `process.env`

description: If `true`, enables the TAP reporter

description: If `true`, enables verbose output (though currently non-verbose output is not supported)

description: Specifies a fixed location for storing snapshot files. Use this if your snapshots are ending up in the wrong location

$ref: #/definitions/array-of-strings

title: extensions

enum: commonjs module

default: cjs mjs js

description: Extensions of test files. Setting this overrides the default `["cjs", "mjs", "js"]` value, so make sure to include those extensions in the list. Experimentally you can configure how files are loaded

description: Extra modules to require before tests are run. Modules are required in the worker processes

description: Timeouts in AVA behave differently than in other test frameworks. AVA resets a timer after each test, forcing tests to quit if no new test results were received within the specified timeout. This can be used to handle stalled tests. See our timeout documentation for more options

description: Configure Node.js arguments used to launch worker processes

description: If `false`, disable parallel builds (default: `true`)

title: configuration

description: Configures @ava/typescript for projects that precompile TypeScript. Alternatively, you can use `ts-node` to do live testing without transpiling, in which case you shouldn't use the `typescript` property

description: You can configure AVA to recognize additional file extensions as TypeScript (e.g., `["ts", "tsx"]` to add partial JSX support). Note that the preserve mode for JSX is not (yet) supported. See also AVA's `extensions` object

title: paths

description: AVA searches your entire project for `*.js`, `*.cjs`, `*.mjs` and `*.ts` files (or other extensions you've configured). It will ignore such files found in the `rewritePaths` targets (e.g. `build/`). If you use more specific paths, for instance `build/main/`, you may need to change AVA's `files` configuration to ignore other directories. Paths are relative to your project directory

description: If `false`, AVA will assume you have already compiled your project. If set to `'tsc'`, AVA will run the TypeScript compiler before running your tests. This can be inefficient when using AVA in watch mode

title: AVA Config Schema


enum: running stopped

enum: never on-failure on-unhealthy always

enum: never on-create

$ref: #/definitions/createOptions

type: number string boolean

contentMediaType: application/json

title: The configuration for all the modules.

required: $edgeAgent $edgeHub

title: Configuration for the edgeAgent module

required: schemaVersion runtime systemModules modules

required: type settings

$ref: #/definitions/moduleType

required: username password address

required: edgeAgent edgeHub

$ref: #/definitions/moduleSettings

$ref: #/definitions/env

$ref: #/definitions/imagePullPolicy

title: The Edgehub Schema

required: type settings status restartPolicy

$ref: #/definitions/status

$ref: #/definitions/restartPolicy

$ref: #/definitions/startupOrder

required: type status restartPolicy settings

title: Configuration for the edgeHub module

required: schemaVersion routes

title: JSON schema for Azure IoT Edge Deployment version 2.0


ansible-lint-config.json

title: Glob-like paths to be excluded.

title: Configure how to display file paths

title: Enable List

title: Exclude Paths

title: Extra Vars

title: Kinds

title: Loop Var Prefix

title: Maximum Block Depth

title: Mock Modules

title: Mock Roles

title: Offline

title: Only Builtins Allow Collections

title: Only Builtins Allow Modules

title: Parseable

title: Profile

title: Progressive (removed feature)

title: Project Directory

title: Quiet

$ref: #/$defs/rule

enum: command-instead-of-module command-instead-of-shell deprecated-bare-vars deprecated-local-action deprecated-module empty-string-compare fqcn fqcn[action-core] fqcn[action] fqcn[canonical] fqcn[keyword] galaxy galaxy[no-changelog] galaxy[no-runtime] galaxy[tags] galaxy[version-incorrect] galaxy[version-missing] ignore-errors inline-env-var internal-error jinja jinja[invalid] jinja[spacing] key-order latest literal-compare load-failure load-failure[not-found] loop-var-prefix loop-var-prefix[missing] loop-var-prefix[wrong] meta-incorrect meta-no-tags meta-runtime meta-video-links name name[casing] name[play] name[prefix] name[template] no-changed-when no-handler no-jinja-when no-log-password no-prompting no-relative-paths no-same-owner no-tabs only-builtins package-latest parser-error partial-become playbook-extension risky-file-permissions risky-octal risky-shell-pipe role-name run-once run-once[play] run-once[task] sanity sanity[bad-ignore] sanity[cannot-ignore] schema syntax-check var-naming yaml

title: Rules specific configuration.

title: Rulesdir

title: SARIF Output filename

title: Skip Action Validation

title: Skip List

title: Strict

title: Tags

default: {stem} |

title: Allow custom prefix for task[prefix]

title: Use Default Rules

title: Regex used to verify variable names

title: Verbosity

title: Warn List

title: Write List

title: Ansible-lint Configuration Schema


monika-config-schema.json

description: Number of times an alert should return true before Monika sends incident notifications

description: Number of times an alert should return false before Monika sends recovery notifications

title: Interval

description: The number of seconds to repeat the probe

title: Postgres

description: Monitor postgres readiness

title: URI connection

description: Postgres uri connection configuration

required: host port database

description: Postgres host address to connect to

title: Port

description: Postgres port to connect to

title: Database

description: Name of the database

title: Username

description: Username with access to the database

title: Password

description: User's database password

title: Redis

description: Monitor redis health

title: URI connection

description: redis uri connection configuration

required: host port

title: Redis host

description: The hostname or IP address of the redis server

title: Port number

description: Port number used for the redis

title: Password

description: Password used for the redis AUTH, if set.

title: Username

description: Username used for the redis AUTH, if set.

title: MongoDB

description: Monitor MongoDB health

title: MongoDB URI

description: The hostname or IP address of the MongoDB server

title: MongoDB host

title: Port number

description: Port number used for the MongoDB

title: Password

description: Password used for the MongoDB AUTH, if set.

title: Username

description: Username used for the MongoDB AUTH, if set.

title: MariaDB/Mysql

description: Monitor MariaDB/Mysql health

required: host port username password database

title: Database host

description: The hostname or IP address of the database server

title: Port number

description: Port number used by your database server

title: Username

description: User with access to the database

title: Password

description: User password for authentication

title: Database

default: Name of the database

title: Requests

description: The http or ping request to probe for

title: HTTP Method

description: The http method

enum: GET POST DELETE PUT PATCH

default: GET

title: Url

description: The remote URL address to probe

title: Timeout

description: Set the timeout for the request in milliseconds, default is 10 seconds

title: SaveBody

description: Should response body be saved in the database

$ref: #/definitions/alerts

title: Ping

description: If defined and to true, the request is an ICMP ping

title: AllowUnauthorized

description: If defined and to true, the request will ignore SSL certificate validity

$ref: #/definitions/body

$ref: #/definitions/headers

title: Socket

description: Socket is a TCP type request

required: host port data

description: Address to your host

title: Port

description: Host port to connect to

title: Data

description: Data payload for the request

title: Alerts

description: The condition which will trigger an alert and the subsequent notification

required: assertion message

title: Assertion

description: An expression that will trigger an alert when its is logically true. See the assertions here: https://monika.hyperjump.tech/guides/alerts#alert-query

default: response.status != 200

title: Message

description: Message that will be sent to the notification channel

default: Http Response status code is not 200!

required: query message

title: Query

description: Note: Query is deprecated, please use assertion

title: Message

title: Body

description: The data bytes transmitted in an HTTP transaction message immediately following the headers if there are any

title: Headers

description: A list of strings sent and received by both the client program and server on every HTTP request and response

description: Media type(s) that is/are acceptable for the response

description: Character sets that are acceptable

description: List of acceptable encodings

description: Authentication credentials for HTTP authentication

description: Used to specify directives that must be obeyed by all caching mechanisms along the request-response chain

description: An HTTP cookie previously sent by the server with Set-Cookie

description: General header that allows the sender or client to specify options that are desired for that particular connection

description: The Media type of the body of the request (used with POST and PUT requests

description: General header used to inform how long a persistent connection should stay open

description: Initiates a request for cross-origin resource sharing (asks server for Access-Control-* response fields)

description: This is the address of the previous web page (referrer) from which a link to the currently requested page was followed

description: The user agent string of the user agent

description: Monika monitoring configuration schema

title: Probes

description: Probe is a description of the target, methods, timing and payloads to begin monitoring/probing a target.

title: Id

description: Unique string identification of the probe

title: Name

description: A human-readible probe name

examples: get-user login-check web-heatlh-check

title: Description

description: Description of the probe

default: Ensure connectivity to github is successful

$ref: #/definitions/interval

$ref: #/definitions/postgres

$ref: #/definitions/redis

$ref: #/definitions/mongo

$ref: #/definitions/mariadb

$ref: #/definitions/requests

$ref: #/definitions/socket

$ref: #/definitions/incidentThreshold

$ref: #/definitions/recoveryThreshold

title: Notifications

description: Alerts of incidents and recoveries will be sent via these notification channels

title: Desktop

required: id type

description: Unique notification id

const: desktop

title: Discord

description: Unique notification id

description: Data for your payload

description: The URL of the Discord Webhook that will receive notification

title: Workplace

description: Unique notification id

description: Data for your payload

description: Thread id is the set of numbers at the end of the url

description: Workplace access token for custom integration

title: Google Chat

description: Unique notification id

description: Data for your payload

description: The webhook URL for your google chat

title: Lark

description: Unique notification id

description: Data for your payload

description: The webhook URL for your lark suite

title: Mailgun

description: Data for your payload

description: An array of email addresses that will receive the e-mail from Monika

description: Mailgun account API key, mailgun registered key to identify your account

description: The domain to set in Mailgun

title: Microsoft Teams

description: Unique notification id

description: Data for your payload

description: Your teams webhook URL

title: Monika Notification

description: Unique notification id

description: Data for your payload

description: Your Monika notification URL

title: Pagerduty

description: Unique pagerduty notif id

description: Data for your payload

description: Pagerduty integration key

description: Monika Probe ID

title: Sendgrid

description: Unique sendgrid notification id

description: Data for your payload

description: A string of email addresses that has been verified in your sendgrid account

description: Sendgrid account api key, sendgrid registered key to identify your account

title: Slack

description: Unique slack notification id

description: Data for your payload

description: The URL webhook for Slack

title: SMTP

description: Unique smtp notification id

description: Data for your payload

description: An array of email address that will receive the email from Monika

description: The smtp host that you will be using for sending the email

description: The port allowed to be used for sending mail in your host

description: Registered username on your smtp server

description: The password set for your username

title: Statuspage

description: Notification identity number

description: Data for your payload

description: Statuspage API key

description: Statuspage page ID

title: Telegram

description: Unique telegram notification id

description: Data for your payload

description: The ID of the group where the bot should send the messages

description: Token for your telegram bot

title: Webhook

description: Unique webhook notification id

description: Data for your payload

description: The URL of the server that will receive the webhook notification

title: WhatsApp for Business

description: Unique whatsapp notification id

description: Data for your payload

description: An array of phone numbers registered for WhatsApp, should start with your controu code number

description: Your WhatsApp API username

description: Your Whatsapp API user password

title: Dingtalk

description: Unique Dingtalk notification id

description: Data for your payload

description: the token of your Dingtalk account

title: Pushover

description: Unique Pushover notification id

description: Data for your payload

description: Pushover application token

description: Pushover user key

title: Gotify

description: Unique Gotify notification id

description: Data for your payload

description: Gotify application token

description: Gotify base url

title: Opsgenie

description: Unique opsgenie notification id

description: Data for your payload

description: Opsgenie application token

title: Pushbullet

description: Unique notification id

description: Data for your payload

description: Pushbullet application token.

description: Pushbullet device identifier (optional)

title: Instatus

description: The type of notification

description: Data for your payload

description: Instatus API key

description: Instatus Page ID

description: Database internal configuration

description: Maximum Monika database size

description: Delete strategy when limit reached

description: Schedule to trim the db in crontab

title: Status notification

description: Sends status notification periodically according to a cron schedule. Set to false to disable.

title: Certificate

description: Check validity of your TLS certificate(s).

description: The list of domains to check

description: Hostname to check

description: Custom HTTPs Options

description: The number of days to send notification to user before the domain expires


$ref: #/definitions/Consumer

$ref: #/definitions/Healthy

$ref: #/definitions/Unhealthy

required: username password

$ref: #/definitions/ConsumerGroup

required: id cert key

$ref: #/definitions/ACLGroup

$ref: #/definitions/BasicAuth

$ref: #/definitions/HMACAuth

$ref: #/definitions/JWTAuth

$ref: #/definitions/KeyAuth

$ref: #/definitions/MTLSAuth


docfx.json

$ref: #/definitions/fileMappingContent

$ref: #/definitions/fileMappingResource

$ref: #/definitions/fileMappingOverwrite

$ref: #/definitions/xref

description: Contains metadata that will be applied to every file, in key-value pair format.

$ref: #/definitions/globalMetadataFiles

description: Contains metadata that will be applied to specific files.

$ref: #/definitions/fileMetadataFiles

$ref: #/definitions/template

$ref: #/definitions/theme

description: Force to re-process the documentation in post processors. It will be cascaded from force option.

description: Run in debug mode. With debug mode, raw model and view model will be exported automatically when it encounters error when applying templates. If not specified, it is false.

description: The output folder for files generated for debugging purpose when in debug mode. If not specified, it is ${TempPath}/docfx.

description: Specify the port of the hosted website.

description: If set to true, data model to run template script will be extracted in `.raw.json` extension.

description: Specify the output folder for the raw model. If not set, the raw model will be generated to the same folder as the output documentation.

description: If set to true, data model to apply template will be extracted in `.view.json` extension.

description: Specify the output folder for the view model. If not set, the view model will be generated to the same folder as the output documentation.

description: If set to true, template will not be actually applied to the documents. This option is always used with `--exportRawModel` or `--exportViewModel`, so that only raw model files or view model files are generated.

description: Set the max parallelism, 0 (default) is same as the count of CPU cores.

description: Set the LRU cached model count (approximately the same as the count of input files). By default, it is 8192 for 64bit and 3072 for 32bit process. With LRU cache enabled, memory usage decreases and time consumed increases. If set to 0, Lru cache is disabled.

description: Set the name of markdown engine, default is dfm, and another build-in engine is gfm.

description: Set the parameters for markdown engine.

description: Disable default lang keyword, e.g. `null`.

$ref: #/definitions/disableGitFeatures

description: If set to true, DocFX does not copy file to the output folder. Instead, it saves a link_to_path property inside manifest.json.

description: If set to true, cleans up historical cache data when building.

description: Build section defines configuration values for the build command.

$ref: #/definitions/metadataConfigItem

description: Metadata section defines an array of source projects and their output folder.

$ref: #/definitions/fileMappingSrc

description: Defines the output folder of the generated metadata files.

description: If set to true, disables default API visibility filter rule.

description: If set to true, it would disable incremental build.

description: If set to true, DocFX would not render triple-slash-comments in source code as markdown.

description: Defines the filter configuration file.

description: If set to true, DocFX would keep ` in comment id instead of replacing it with -.

required: src dest

$ref: #/definitions/fileMappingItem

description: Contains all the files to generate documentation, including metadata `yml` files and conceptual `md` files.

description: Contains all the resource files that conceptual and metadata files dependent on, e.g. image files.

description: Contains all the conceptual files which contains yaml header with `uid` and is intended to override the existing metadata `yml` files.

description: [Obsoleted] Contains `rpk` files that define the external references.

description: Defines the source projects to have metadata generated.

description: The name of current item, the value is not used for now.

$ref: #/definitions/files

$ref: #/definitions/exclude

description: Defines the root folder for the source files, it has the same meaning as `cwd`

description: [Obsoleted] Defines the root folder for the source files, it has the same meaning as `src`

description: The destination folder for the files if copy/transform is used.

description:
Version name for the current file-mapping item.
If not set, treat the current file-mapping item as in default version.
Mappings with the same version name will be built together.
Cross reference doesn't support cross different versions.

description:
The Root TOC Path used for navbar in current version, relative to output root.
If not set, will use the toc in output root in current version if exists.

description:
Pattern match will be case sensitive.
By default the pattern is case insensitive.

description:
Disable pattern begin with `!` to mean negate.
By default the usage is enabled.

description: Disable `{a,b}c` => `["ac", "bc"]`. By default the usage is enabled.

description:
Disable the usage of `\` to escape values.
By default the usage is enabled.

description:
Disable the usage of `**` to match everything including `/` when it is the beginning of the pattern or is after `/`.
By default the usage is enable.

description:
Allow files start with `.` to be matched even if `.` is not explicitly specified in the pattern.
By default files start with `.` will not be matched by `*` unless the pattern starts with `.`.

description: Specifies the urls of xrefmap used by content files. Currently, it supports following scheme: http, https, ftp, file, embedded.

description: Specify a list of JSON file path containing globalMetadata settings, as similar to `{"key":"value"}`.

description: Specify a list of JSON file path containing fileMetadata settings, as similar to `{"key":"value"}`.

description: The latter ones will override the former ones if the name of the file inside the template collides. If omitted, embedded default template will be used.

description: The themes applied to the documentation. Theme is used to customize the styles generated by `template`. It can be a string or an array. The latter ones will override the former ones if the name of the file inside the template collides. If omitted, no theme will be applied, the default theme inside the template will be used.

description: The file glob pattern collection, with path relative to property `src`/`cwd` if value is set.

description: The file glob pattern collection for files that should be excluded, with path relative to property `src`/`cwd` if value is set.

description: If set to true, DocFX would not fetch Git related information for articles.

title: DocFx configuration file