Skip to content

Commit 4889e23

Browse files
authored
Merge pull request #318 from publiccodeyml/supports
Add `supports` and deprecate the country specific sections
2 parents a025c42 + 010d33c commit 4889e23

5 files changed

Lines changed: 99 additions & 20 deletions

File tree

docs/standard/aliases-list.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. _aliases-list:
2+
3+
List of aliases
4+
===============
5+
6+
Here follows the list of aliases that can be used in the
7+
``supports`` key. Each alias resolves to the canonical resource it
8+
refers to.
9+
10+
======== ===============================================
11+
alias resource
12+
======== ===============================================
13+
gdpr https://eur-lex.europa.eu/eli/reg/2016/679/oj
14+
eidas https://eur-lex.europa.eu/eli/reg/2014/910/oj
15+
nis2 https://eur-lex.europa.eu/eli/dir/2022/2555/oj
16+
cra https://eur-lex.europa.eu/eli/reg/2024/2847/oj
17+
spid https://www.spid.gov.it/
18+
cie https://www.cartaidentita.interno.gov.it/
19+
anpr https://www.anpr.interno.it/
20+
pagopa https://www.pagopa.gov.it/
21+
io https://io.italia.it/
22+
======== ===============================================

docs/standard/country.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
.. _`country-section`:
22

3-
Country-specific sections
4-
=========================
3+
Country-specific sections (*deprecated*)
4+
========================================
5+
6+
Country-specific sections are deprecated and will be removed in
7+
publiccode.yml 1.0. The use cases they covered are now expressed with
8+
generic keys: declare compliance with national regulations or
9+
integration with national platforms through the ``supports`` key, and
10+
reference the publishing administration through the ``organisation`` key.
511

612
Country-specific sections allow including information relevant only within a
713
given country, such as compliance with national regulations or integration with

docs/standard/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,5 @@ Table of contents
4949
forks.rst
5050
categories-list.rst
5151
scope-list.rst
52+
aliases-list.rst
5253
example.rst

docs/standard/schema.core.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,36 @@ The keys are:
295295
configuration files, bash scripts, ansible playbooks, Dockerfiles, or
296296
other instruction sets.
297297

298+
Key ``supports``
299+
~~~~~~~~~~~~~~~~
300+
301+
- Type: array of objects
302+
- Presence: optional
303+
304+
A list of standards, regulations, frameworks or systems that the
305+
software supports or complies with.
306+
307+
Each item is an object with a single property:
308+
309+
- ``id`` - **mandatory** - an identifier for the supported standard,
310+
regulation, framework or system. It is either an alias in
311+
the form ``alias:<name>`` (e.g. ``alias:gdpr``), resolved through the
312+
:ref:`list of aliases <aliases-list>`, or any other valid URI (URL or
313+
URN) referencing the resource directly.
314+
315+
An ``alias:`` value MUST exist in the
316+
:ref:`list of aliases <aliases-list>`. An unknown alias is an error.
317+
Any other value MUST be a syntactically valid URI. A value that is
318+
well formed but not otherwise known is accepted as is.
319+
320+
Example:
321+
322+
.. code:: yaml
323+
324+
supports:
325+
- id: alias:gdpr
326+
- id: https://eur-lex.europa.eu/eli/reg/2016/679/oj
327+
298328
Section ``organisation``
299329
~~~~~~~~~~~~~~~~~~~~~~~~
300330

docs/standard/schema.it.rst

Lines changed: 38 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
.. _italian-sections:
22

3-
Italy
4-
-----
3+
Italy (*deprecated*)
4+
--------------------
5+
6+
The entire Italian country-specific section is deprecated and will be
7+
removed in publiccode.yml 1.0. Use the generic ``supports`` key for
8+
compliance with national regulations and integration with national
9+
platforms, and the ``organisation`` key to reference the publishing
10+
administration.
511

612
All the keys listed below are specific for Italy and, as such, they must
713
be inserted in a section named with the ``IT`` code.
814

915

10-
Key ``countryExtensionVersion``
11-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16+
Key ``countryExtensionVersion`` (*deprecated*)
17+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1218

1319
- Type: string
1420
- Presence: mandatory
@@ -17,6 +23,8 @@ Key ``countryExtensionVersion``
1723

1824
This key **MUST** always be set to ``1.0``.
1925

26+
This key is deprecated together with the rest of the Italian section.
27+
2028
Key ``conforme`` (*deprecated*)
2129
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2230

@@ -72,12 +80,14 @@ Key ``conforme/gdpr`` (*deprecated*)
7280

7381
If present and set to ``true``, the software respects the GDPR.
7482

83+
Use the ``supports`` key with ``alias:gdpr`` instead.
7584

76-
Section ``piattaforme``
77-
~~~~~~~~~~~~~~~~~~~~~~~
7885

79-
Key ``piattaforme/spid``
80-
''''''''''''''''''''''''
86+
Section ``piattaforme`` (*deprecated*)
87+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
88+
89+
Key ``piattaforme/spid`` (*deprecated*)
90+
'''''''''''''''''''''''''''''''''''''''
8191

8292
- Type: boolean
8393
- Presence: optional
@@ -87,42 +97,52 @@ If present and set to ``true``, the software interfaces with `SPID
8797
- il Sistema Pubblico di Identità
8898
Digitale <https://developers.italia.it/it/spid>`__.
8999

90-
Key ``piattaforme/cie``
91-
'''''''''''''''''''''''
100+
Use the ``supports`` key with ``alias:spid`` instead.
101+
102+
Key ``piattaforme/cie`` (*deprecated*)
103+
''''''''''''''''''''''''''''''''''''''
92104

93105
- Type: boolean
94106
- Presence: optional
95107

96108
If present and set to ``true``, the software interfaces with the Italian
97109
electronic ID card (``Carta di Identità Elettronica``).
98110

99-
Key ``piattaforme/anpr``
100-
''''''''''''''''''''''''
111+
Use the ``supports`` key with ``alias:cie`` instead.
112+
113+
Key ``piattaforme/anpr`` (*deprecated*)
114+
'''''''''''''''''''''''''''''''''''''''
101115

102116
- Type: boolean
103117
- Presence: optional
104118

105119
If present and set to ``true``, the software interfaces with ANPR.
106120

107-
Key ``piattafome/pagopa``
108-
'''''''''''''''''''''''''
121+
Use the ``supports`` key with ``alias:anpr`` instead.
122+
123+
Key ``piattafome/pagopa`` (*deprecated*)
124+
''''''''''''''''''''''''''''''''''''''''
109125

110126
- Type: boolean
111127
- Presence: optional
112128

113129
If present and set to ``true``, the software interfaces with pagoPA.
114130

115-
Key ``piattaforme/io``
116-
'''''''''''''''''''''''''
131+
Use the ``supports`` key with ``alias:pagopa`` instead.
132+
133+
Key ``piattaforme/io`` (*deprecated*)
134+
'''''''''''''''''''''''''''''''''''''
117135

118136
- Type: boolean
119137
- Presence: optional
120138

121139
If present and set to ``true``, the software interfaces with `IO - the public services app <https://io.italia.it/>`__.
122140

141+
Use the ``supports`` key with ``alias:io`` instead.
142+
123143

124-
Section ``riuso``
125-
~~~~~~~~~~~~~~~~~
144+
Section ``riuso`` (*deprecated*)
145+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
126146

127147
This section contains a set of keys related to the publication of the software
128148
inside the reuse catalog of `Developers Italia <https://developers.italia.it>`__.

0 commit comments

Comments
 (0)