You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/metadata.md
+26-8Lines changed: 26 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,11 +4,11 @@
4
4
5
5
- federal code.json standard, created as part of [M-16-21](https://obamawhitehouse.archives.gov/sites/default/files/omb/memoranda/2016/m_16_21.pdf)
6
6
- required metadata outlined in the [SHARE IT ACT](https://www.congress.gov/bill/118th-congress/house-bill/9566/text/ih) (e.g. repository visibility, contract number)
7
-
- publiccode.yml metadata, an international metadata standard
7
+
-[publiccode.yml](https://yml.publiccode.tools/) metadata, an international metadata standard
8
8
9
9
By harmonizing various standards, this opens up the opportunity to share our work not just on an agency level but also on a national and international level.
10
10
11
-
The generic code.json schema can be found in the [`schemas` directory](../schemas/schema-1.0.0.json).
11
+
The generic code.json schema can be found in the [`schemas` directory](../schemas/schema-2.0.0.json).
12
12
13
13
### Extending the schema for agency use
14
14
@@ -74,7 +74,7 @@ We encourage agencies to contribute by [submitting an agency schema addition iss
74
74
<td>required</td>
75
75
<td>🇺🇸</td>
76
76
<td>str</td>
77
-
<td>A short description of the project. It should be a single line containing a single sentence. Maximum 150 characters are allowed.</td>
77
+
<td>A one or two sentence description of the software.</td>
78
78
<td></td>
79
79
</tr>
80
80
<tr>
@@ -109,7 +109,7 @@ We encourage agencies to contribute by [submitting an agency schema addition iss
109
109
<td>required</td>
110
110
<td>🇺🇸📜</td>
111
111
<td>str</td>
112
-
<td>A list of enumerated values which describes the usage permissions for the release: (1) openSource: Open source; (2) governmentWideReuse: Government-wide reuse; (3) exemptByNationalSecurity: The source code is primarily for use in national security system as defined in section 11103 of title 40, USC; (4) exemptByNationalIntelligence: The source code is developed by an agency or part of an agency that is an element of the intelligence community, as defined in section 3(4) of the National Security Act of 1947; (5) exemptByFOIA: The source code is exempt under the Freedom of Information Act; (6) exemptByEAR: The source code is exempt under the Export Administration Regulations; (7) exemptByITAR: The source code is exempt under the the International Traffic in Arms Regulations; (8) exemptByTSA: The source code is exempt under the regulations of the Transportation Security Administration relating to the protection of Sensitive Security Information; (9) exemptByClassifiedInformation: The source code is exempt under the Federal laws and regulations governing the sharing of classified information not covered by exemptByNationalSecurity, exemptByNationalIntelligence, exemptbyFOIA, exemptByEAR, exemptByITAR, and exemptByTSA; (10) exemptByPrivacyRisk: The sharing or public accessibility of the source code would create an identifiable risk to the privacy of an individual; (11) exemptByIPRestriction: The sharing of the source code is limited by patent or intellectual property restrictions; (12) exemptByAgencySystem: The sharing of the source code would create an identifiable risk to the stability, security, or integrity of the agency’s systems or personnel; (13) exemptByAgencyMission: The sharing of the source code would create an identifiable risk to agency mission, programs, or operations; (14) exemptByCIO: The CIO believes it is in the national interest to exempt sharing the source code; (15) exemptByPolicyDate: The release was created prior to the M-16-21 policy (August 8, 2016)",
112
+
<td>A list of enumerated values which describes the usage permissions for the release: (1) openSource: Open source; (2) governmentWideReuse: Government-wide reuse; (3) exemptByNationalSecurity: The source code is primarily for use in national security system as defined in section 11103 of title 40, USC; (4) exemptByNationalIntelligence: The source code is developed by an agency or part of an agency that is an element of the intelligence community, as defined in section 3(4) of the National Security Act of 1947; (5) exemptByFOIA: The source code is exempt under the Freedom of Information Act; (6) exemptByEAR: The source code is exempt under the Export Administration Regulations; (7) exemptByITAR: The source code is exempt under the the International Traffic in Arms Regulations; (8) exemptByTSA: The source code is exempt under the regulations of the Transportation Security Administration relating to the protection of Sensitive Security Information; (9) exemptByClassifiedInformation: The source code is exempt under the Federal laws and regulations governing the sharing of classified information not covered by exemptByNationalSecurity, exemptByNationalIntelligence, exemptbyFOIA, exemptByEAR, exemptByITAR, and exemptByTSA; (10) exemptByPrivacyRisk: The sharing or public accessibility of the source code would create an identifiable risk to the privacy of an individual; (11) exemptByIPRestriction: The sharing of the source code is limited by patent or intellectual property restrictions; (12) exemptByAgencySystem: The sharing of the source code would create an identifiable risk to the stability, security, or integrity of the agency’s systems or personnel; (13) exemptByAgencyMission: The sharing of the source code would create an identifiable risk to agency mission, programs, or operations; (14) exemptByCIO: The CIO believes it is in the national interest to exempt sharing the source code; (15) exemptByPolicyDate: The release was created prior to the M-16-21 policy (August 8, 2016)"
113
113
</td>
114
114
<td>
115
115
- openSource<br>
@@ -369,12 +369,19 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json).
369
369
<td>required</td>
370
370
<td>🇺🇸📜</td>
371
371
<td>str</td>
372
-
<td>A list of enumerated values which describes the usage permissions for the release: (1) openSource: Open source; (2) governmentWideReuse: Government-wide reuse; (3) exemptByLaw: The sharing of the source code is restricted by law or regulation, including—but not limited to—patent or intellectual property law, the Export Asset Regulations, the International Traffic in Arms Regulation, and the Federal laws and regulations governing classified information; (4) exemptByNationalSecurity: The sharing of the source code would create an identifiable risk to the detriment of national security, confidentiality of Government information, or individual privacy; (5) exemptByAgencySystem: The sharing of the source code would create an identifiable risk to the stability, security, or integrity of the agency’s systems or personnel, (6) exemptByAgencyMission: The sharing of the source code would create an identifiable risk to agency mission, programs, or operations; (7) exemptByCIO: The CIO believes it is in the national interest to exempt sharing the source code; (8) exemptByPolicyDate: The release was created prior to the M-16-21 policy (August 8, 2016)</td>
372
+
<td>A list of enumerated values which describes the usage permissions for the release: (1) openSource: Open source; (2) governmentWideReuse: Government-wide reuse; (3) exemptByNationalSecurity: The source code is primarily for use in national security system as defined in section 11103 of title 40, USC; (4) exemptByNationalIntelligence: The source code is developed by an agency or part of an agency that is an element of the intelligence community, as defined in section 3(4) of the National Security Act of 1947; (5) exemptByFOIA: The source code is exempt under the Freedom of Information Act; (6) exemptByEAR: The source code is exempt under the Export Administration Regulations; (7) exemptByITAR: The source code is exempt under the the International Traffic in Arms Regulations; (8) exemptByTSA: The source code is exempt under the regulations of the Transportation Security Administration relating to the protection of Sensitive Security Information; (9) exemptByClassifiedInformation: The source code is exempt under the Federal laws and regulations governing the sharing of classified information not covered by exemptByNationalSecurity, exemptByNationalIntelligence, exemptbyFOIA, exemptByEAR, exemptByITAR, and exemptByTSA; (10) exemptByPrivacyRisk: The sharing or public accessibility of the source code would create an identifiable risk to the privacy of an individual; (11) exemptByIPRestriction: The sharing of the source code is limited by patent or intellectual property restrictions; (12) exemptByAgencySystem: The sharing of the source code would create an identifiable risk to the stability, security, or integrity of the agency’s systems or personnel; (13) exemptByAgencyMission: The sharing of the source code would create an identifiable risk to agency mission, programs, or operations; (14) exemptByCIO: The CIO believes it is in the national interest to exempt sharing the source code; (15) exemptByPolicyDate: The release was created prior to the M-16-21 policy (August 8, 2016)"</td>
373
373
<td>
374
374
- openSource<br>
375
375
- governmentWideReuse<br>
376
-
- exemptByLaw<br>
377
376
- exemptByNationalSecurity<br>
377
+
- exemptByNationalIntelligence<br>
378
+
- exemptByFOIA<br>
379
+
- exemptByEAR<br>
380
+
- exemptByITAR<br>
381
+
- exemptByTSA<br>
382
+
- exemptByClassifiedInformation<br>
383
+
- exemptByPrivacyRisk<br>
384
+
- exemptByIPRestriction<br>
378
385
- exemptByAgencySystem<br>
379
386
- exemptByAgencyMission<br>
380
387
- exemptByCIO<br>
@@ -394,7 +401,7 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json).
394
401
<td>required</td>
395
402
<td>🇺🇸</td>
396
403
<td>str</td>
397
-
<td>Organization responsible for the project</td>
404
+
<td>The organization or component within the agency to which the releases listed belong.</td>
398
405
<td>Centers for Medicare & Medicaid Services</td>
399
406
</tr>
400
407
<tr>
@@ -574,6 +581,17 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json).
574
581
- Submitting issues to repo<br>
575
582
</td>
576
583
</tr>
584
+
<tr>
585
+
<td>AIUseCaseInventory</td>
586
+
<td>required</td>
587
+
<td>📜</td>
588
+
<td>bool</td>
589
+
<td>Indicates if the software is included in the agency's AI use case inventory</td>
590
+
<td>
591
+
- true<br>
592
+
- false
593
+
</td>
594
+
</tr>
577
595
<tr>
578
596
<td>localisation</td>
579
597
<td>required</td>
@@ -693,7 +711,7 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json).
693
711
</tbody>
694
712
</table>
695
713
696
-
Full schema can be found in [schema-0.1.0.json](../schemas/cms/schema-0.1.0.json).
714
+
Full schema can be found in [schema-0.2.0.json](../schemas/cms/schema-0.2.0.json).
0 commit comments