publiccode.yml
publiccode.yml
publiccode.yml
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
publiccode.yml and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
publiccodeYmlVersionrequired | string | The publiccode.yml specification version this file adheres to. one of: "0", "0.2", "0.2.0", "0.2.1", "0.2.2", "0.3" … (+9) |
namerequired | string | The (short) public name of the software, as most people usually refer to it. If the software has both an internal code name and a commercial name, use the commercial name. It can be localised in the description section. |
applicationSuite | string | The name of the suite to which the software belongs. |
urlrequired | string | A unique identifier for this software: a URL to the source code repository (git, svn, ...) where it is published. Prefer HTTP/HTTPS URLs that do not require authentication, if the repository supports multiple protocols. Forks meant to |
landingURL | string | A human-readable landing page, useful when url only serves source code to a source control client rather than a browsable page. Ideally where a "Go to the application source code" button would lead. Can also point to a page offering an |
isBasedOn | oneOf | The URL(s) of the original project(s), if this software is a variant or fork of another software. Its presence identifies this software as descending from the specified repositories. |
softwareVersion | string | The latest stable version number of the software. It is a display only string; parsers should not assume semantic versioning or any other specific format. |
releaseDate | string | The date the latest version was released. |
logo | string | The path to the logo of the software. Vector formats (SVG or SVGZ) are preferred, but PNG is also accepted. It can be a relative path from the repository root or an absolute URL to the raw file, but the file must reside in the same |
monochromeLogodeprecated | string | DEPRECATED. 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 wide. The key value can be the relative path to the |
inputTypesdeprecated | array<string> | DEPRECATED. 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. |
outputTypesdeprecated | array<string> | DEPRECATED. 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. |
platformsrequired | oneOf | The platforms that users use to access and operate the software, rather than the platform the software itself runs on. Use predefined values if possible. |
categories | array | A list of categories that can be used to describe the software and can help build catalogs of open software. |
usedBy | array<string> | The names of prominent public administrations known to be using this software, serving as testimonials. Parsers are encouraged to enrich this list with independently obtained signals of usage, such as forks owned by an administration. |
roadmap | string | A link to a public roadmap of the software. |
developmentStatusrequired | enum | — one of: "concept", "development", "beta", "stable", "obsolete" |
softwareTyperequired | enum | — one of: "standalone/mobile…, "standalone/iot", "standalone/deskto…, "standalone/web", "standalone/backen…, "standalone/other" … (+3) |
supports | array<object> | A list of standards, regulations, frameworks or systems that the software supports or complies with. |
intendedAudience | object | — |
intendedAudience.countries | array<string> | Countries explicitly included in the intended audience, i.e. whose processes, technologies or laws the software explicitly claims compliance with. Uses uppercase ISO 3166-1 alpha-2 codes; lowercase codes are deprecated but still accepted. |
intendedAudience.unsupportedCountries | array<string> | Countries explicitly marked as NOT supported, for instance when the software conflicts with a specific law, process or technology. Uses uppercase ISO 3166-1 alpha-2 codes; lowercase codes are deprecated but still accepted. |
intendedAudience.scope | array | Tags related to the field of application of the software. |
descriptionrequired | object | A general, user-visible description of the software, for instance to build a web page describing it. Since the content is written in a specific language, specify the language as the subsection name, using an IETF BCP 47 language tag. The |
legalrequired | object | — |
legal.licenserequired | string | The license under which the software is distributed, as a valid SPDX expression referring to one or more open source licenses. |
legal.mainCopyrightOwner | string | The entity that owns the copyright on most of the code in the repository, normally the one reported at the top of most files. Multiple owners, or an informal group (e.g. "Linus Torvalds and all Linux contributors"), can be listed as an |
legal.repoOwnerdeprecated | string | DEPRECATED. 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. Use organisation/name instead. |
legal.authorsFiledeprecated | string | DEPRECATED. Some open-source software identify copyright holders through a file listing all entities that own the copyright. This key refers to that file using a path relative to the root of the repository. |
maintenancerequired | object | Information on the maintenance status of the software, useful to evaluate whether it is actively developed. |
maintenance.typerequired | enum | How the software is currently maintained. one of: "internal", "contract", "community", "none" |
maintenance.contractors | array | The entity or entities currently contracted for maintaining the software. Mandatory when maintenance/type is contract, and must not be present otherwise. |
maintenance.contacts | array | One or more contacts maintaining this software. This key is mandatory when maintenance/type is internal or community and optional otherwise. All contacts need to be a physical person, not a company or an organisation. If somebody is acting |
localisationrequired | object | An overview of the localisation features of the software. |
localisation.localisationReadyrequired | boolean | If true, 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.availableLanguagesrequired | array<string> | 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 | object | An overview of the system-level dependencies required to install and use this software, such as a database. Do not list source code level dependencies (e.g. software libraries); focus only on runtime and system-level dependencies that must |
dependsOn.open | array | Runtime dependencies distributed under an open source license. |
dependsOn.proprietary | array | Runtime dependencies distributed under a proprietary license. |
dependsOn.hardware | array | Hardware dependencies that must be owned to use the software. |
organisation | object | — |
organisation.name | string | The canonical name of the organisation publishing the software. |
organisation.urirequired | string | The organisation publishing the software as a stable resolvable URI or a persistent identifier. |
fundedBy | array | A list of organisations that are currently known to be funding the development of this software. |
ITdeprecated | object | DEPRECATED. Country-specific sections will be removed in publiccode.yml 1.0. Use supports for compliance and integrations, and organisation for the publishing administration. |
IT.countryExtensionVersionrequireddeprecated | string | DEPRECATED together with the entire Italian section. Version 1.0 is used by current files; 0.2 is accepted for compatibility with older publiccode.yml versions. one of: "0.2", "1.0" |
IT.conformedeprecated | object | DEPRECATED. This section contains keys for declaring compliance with Italian legislation. Use supports where an appropriate identifier or alias exists. |
IT.conforme.lineeGuidaDesigndeprecated | boolean | DEPRECATED. If true, the software is compliant with the former Italian design guidelines. |
IT.conforme.modelloInteroperabilitadeprecated | boolean | DEPRECATED. If true, the software is compliant with the former Italian interoperability guidelines. |
IT.conforme.misureMinimeSicurezzadeprecated | boolean | DEPRECATED. If true, the software is compliant with the Italian minimum ICT security measures for Public Administrations. |
IT.conforme.gdprdeprecated | boolean | DEPRECATED. If true, the software complies with the GDPR. Use supports with alias:gdpr instead. |
IT.piattaformedeprecated | object | DEPRECATED. Use supports with the corresponding platform alias instead. |
IT.piattaforme.spiddeprecated | boolean | DEPRECATED. If true, the software interfaces with SPID. Use supports with alias:spid instead. |
IT.piattaforme.ciedeprecated | boolean | DEPRECATED. If true, the software interfaces with the Italian electronic identity card. Use supports with alias:cie instead. |
IT.piattaforme.anprdeprecated | boolean | DEPRECATED. If true, the software interfaces with ANPR. Use supports with alias:anpr instead. |
IT.piattaforme.pagopadeprecated | boolean | DEPRECATED. If true, the software interfaces with pagoPA. Use supports with alias:pagopa instead. |
IT.piattaforme.iodeprecated | boolean | DEPRECATED. If true, the software interfaces with the IO app. Use supports with alias:io instead. |
IT.riusodeprecated | object | DEPRECATED. Use organisation to identify the publishing administration. |
IT.riuso.codiceIPAdeprecated | string | DEPRECATED. This key represents the administration code in the Italian Public Administration index. Use organisation/uri instead. |
itdeprecated | allOf | DEPRECATED. Use the uppercase IT country code. The entire country-specific section will be removed in publiccode.yml 1.0. |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- 93 properties, 88% carrying a description, max nesting depth 9.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
allOf | JSON Schema Core, draft 2020-12 | §10.2.1.1 — "allOf" |
deprecated | JSON Schema Validation, draft 2020-12 | §9.3 — "deprecated" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
format | JSON Schema Validation, draft 2020-12 | §7 — Vocabularies for Semantic Content With "format" |
if | JSON Schema Core, draft 2020-12 | §10.2.2.1 — "if" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
maxLength | JSON Schema Validation, draft 2020-12 | §6.3.1 — "maxLength" |
minItems | JSON Schema Validation, draft 2020-12 | §6.4.2 — "minItems" |
minLength | JSON Schema Validation, draft 2020-12 | §6.3.2 — "minLength" |
not | JSON Schema Core, draft 2020-12 | §10.2.1.4 — "not" |
oneOf | JSON Schema Core, draft 2020-12 | §10.2.1.3 — "oneOf" |
pattern | JSON Schema Validation, draft 2020-12 | §6.3.3 — "pattern" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
required | JSON Schema Validation, draft 2020-12 | §6.5.3 — "required" |
then | JSON Schema Core, draft 2020-12 | §10.2.2.2 — "then" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
format: "date" | RFC 3339 | §5.6 — Internet Date/Time Format |
format: "uri" | RFC 3986 (STD 66) | §3 — Syntax Components |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.