JSON schema for publiccode.yml Json Format

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

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

applicationSuite - This key contains the name of the â€œsuiteâ€ to which the software belongs.

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

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

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

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

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

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

roadmap - A link to a public roadmap of the software.

developmentStatus

softwareType

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

#	Values	Actions
{{$index+1}}.

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

#	Values	Actions
{{$index+1}}.

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

#	Actions
{{$index+1}}.

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

#	Actions
{{$index+1}}.

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

#	Values	Actions
{{$index+1}}.

.intendedAudience

_

intendedAudience.countries 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.

#	Values	Actions
{{$index+1}}.

intendedAudience.unsupportedCountries 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.

#	Values	Actions
{{$index+1}}.

intendedAudience.scope This key contains a list of tags related to the field of application of the software.

#	Actions
{{$index+1}}.

.description

_

.legal

_

legal.license - 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.

legal.mainCopyrightOwner - 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.

legal.repoOwner - 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.

legal.authorsFile - 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.

.maintenance

_

maintenance.type - This key describes how the software is currently maintained.

maintenance.contractors 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.

#	name	until	email	website	Actions
{{$index+1}}.

maintenance.contacts 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.

#	name	email	phone	affiliation	Actions
{{$index+1}}.

.localisation

_

localisation.localisationReady - 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.

localisation.availableLanguages 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.

#	Values	Actions
{{$index+1}}.

.dependsOn

_

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

#	name	optional	Actions
{{$index+1}}.

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

#	name	optional	Actions
{{$index+1}}.

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

#	name	optional	Actions
{{$index+1}}.

.it

_

it.countryExtensionVersion - 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.

.it.conforme

_

it.conforme.lineeGuidaDesign - 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).

it.conforme.modelloInteroperatibilita - If present and set to yes, the software is compliant with the linee guida sullâ€™interoperabilitÃ . Regulatory reference: Art. 73 del CAD (Italian language).

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

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

.it.piattaforme

_

it.piattaforme.spid - If present and set to yes, the software interfaces with SPID - il Sistema Pubblico di IdentitÃ Digitale.

it.piattaforme.cie - If present and set to yes, the software interfaces with the Italian electronic ID card (Carta di IdentitÃ Elettronica).

it.piattaforme.anpr - If present and set to yes, the software interfaces with ANPR.

it.piattaforme.pagopa - If present and set to yes, the software interfaces with pagoPA.

.it.riuso

_

it.riuso.codiceIPA - This key represents the administration code inside the Public Administration index (codice IPA).

ToolMatter

Your Apps in Action

Use this form to visualize JSON schema for publiccode.yml.

{{repoTitle.MainEntity}}

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

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

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

_

intendedAudience.countries 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.

intendedAudience.scope This key contains a list of tags related to the field of application of the software.

_

_

_

maintenance.contractors 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.

_

localisation.availableLanguages 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.

_

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

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

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

_

_

_

_

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}