Skip to content

Commit 26802e7

Browse files
authored
docs(standard): add organisation key (#229)
1 parent c5da87b commit 26802e7

File tree

2 files changed

+47
-4
lines changed

2 files changed

+47
-4
lines changed

docs/standard/schema.core.rst

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,45 @@ The keys are:
288288
configuration files, bash scripts, ansible playbooks, Dockerfiles, or
289289
other instruction sets.
290290

291+
Section ``organisation``
292+
~~~~~~~~~~~~~~~~~~~~~~~~
293+
294+
This optional section provides the organisation publishing the software.
295+
296+
Key ``organisation/uri``
297+
'''''''''''''''''''''''
298+
299+
- Type: string
300+
- Presence: mandatory
301+
- Example: ``"https://example.org/my-organisation"``, ``"urn:x-foobar:my-organisation"``
302+
303+
The URI identifying the organisation publishing the software. The value
304+
SHOULD be a stable, resolvable URI or a persistent identifier.
305+
306+
Parsers MAY use the URI structure to extract additional information if it follows a
307+
recognized format (for example, inferring an institutional domain or an
308+
official code).
309+
310+
It is RECOMMENDED that crawlers and consumers of publiccode.yml verify this
311+
information out-of-band, to ensure that the declared `organisationUri` actually
312+
corresponds to the organisation in control of the repository.
313+
The specific verification method depends on the implementation and policies of the
314+
platform consuming the file.
315+
316+
Key ``organisation/name``
317+
'''''''''''''''''''''''
318+
319+
- Type: string
320+
- Presence: optional
321+
- Example: ``"My organisation"``
322+
323+
The canonical name of the organisation publishing the software.
324+
325+
It MUST correspond to the same entity identified by ``organisation/uri`` and is
326+
intended to provide a human-readable label for that URI.
327+
It SHOULD be the canonical, widely recognized form of the name (such as the
328+
registered legal or institutional name).
329+
291330
Section ``intendedAudience``
292331
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
293332

@@ -560,8 +599,8 @@ In case it is not possible to name a main copyright owner, it is
560599
possible to omit this key; in those cases, if the repo has a authors
561600
file, you can point to it through ``legal/authorsFile``.
562601

563-
Key ``legal/repoOwner``
564-
'''''''''''''''''''''''
602+
Key ``legal/repoOwner`` (*deprecated*)
603+
''''''''''''''''''''''''''''''''''''''
565604

566605
- Type: string
567606
- Presence: optional
@@ -572,6 +611,8 @@ or might not be the same entity who owns the copyright on the code
572611
itself. For instance, in case of a fork of the original software, the
573612
``repoOwner`` is probably different from the ``mainCopyrightOwner``.
574613

614+
This key is deprecated, use ``organisation/name`` instead.
615+
575616
Key ``legal/authorsFile`` (*deprecated*)
576617
''''''''''''''''''''''''''''''''''''''''
577618

docs/standard/schema.it.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,12 +125,14 @@ Section ``riuso``
125125
This section contains a set of keys related to the publication of the software
126126
inside the reuse catalog of `Developers Italia <https://developers.italia.it>`__.
127127

128-
Chiave ``riuso/codiceIPA``
129-
''''''''''''''''''''''''''
128+
Chiave ``riuso/codiceIPA`` (*deprecated*)
129+
'''''''''''''''''''''''''''''''''''''''''
130130

131131
- Type: string (iPA code)
132132
- Presence: mandatory if ``repoOwner`` is a Public Administration
133133
- Example: ``c_h501``
134134

135135
This key represents the administration code inside the Public Administration
136136
index (codice IPA).
137+
138+
This key is deprecated, use ``organisation/uri`` instead.

0 commit comments

Comments
 (0)