Skip to content

Commit d1f141f

Browse files
natalialuzuriaganatalialuzuriaga
committed
Update code.json schema tables
Signed-off-by: Natalia Luzuriaga <natalia.luzuriaga@cms.hhs.gov>
1 parent a8ee6d1 commit d1f141f

1 file changed

Lines changed: 166 additions & 18 deletions

File tree

‎docs/metadata.md‎

Lines changed: 166 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,14 @@ We encourage agencies to contribute by [submitting an agency schema addition iss
7474
<td>Name of the project or software</td>
7575
<td></td>
7676
</tr>
77+
<tr>
78+
<td>version</td>
79+
<td>optional</td>
80+
<td>🇺🇸</td>
81+
<td>str</td>
82+
<td>The version for this release</td>
83+
<td></td>
84+
</tr>
7785
<tr>
7886
<td>description</td>
7987
<td>required</td>
@@ -169,6 +177,38 @@ We encourage agencies to contribute by [submitting an agency schema addition iss
169177
- private
170178
</td>
171179
</tr>
180+
<tr>
181+
<td>homepageURL</td>
182+
<td>optional</td>
183+
<td>🇺🇸</td>
184+
<td>str</td>
185+
<td>The URL of the public release homepage</td>
186+
<td></td>
187+
</tr>
188+
<tr>
189+
<td>downloadURL</td>
190+
<td>optional</td>
191+
<td>🇺🇸</td>
192+
<td>str</td>
193+
<td>The URL where a distribution of the release can be found</td>
194+
<td></td>
195+
</tr>
196+
<tr>
197+
<td>disclaimerURL</td>
198+
<td>optional</td>
199+
<td>🇺🇸</td>
200+
<td>str</td>
201+
<td>The URL where disclaimer language regarding the release can be found</td>
202+
<td></td>
203+
</tr>
204+
<tr>
205+
<td>disclaimerText</td>
206+
<td>optional</td>
207+
<td>🇺🇸</td>
208+
<td>str</td>
209+
<td>Short paragraph that includes disclaimer language to accompany the release</td>
210+
<td></td>
211+
</tr>
172212
<tr>
173213
<td>vcs</td>
174214
<td>required</td>
@@ -199,6 +239,14 @@ We encourage agencies to contribute by [submitting an agency schema addition iss
199239
<td>Measures frequency of code reuse in various forms</td>
200240
<td></td>
201241
</tr>
242+
<tr>
243+
<td>languages</td>
244+
<td>required</td>
245+
<td>🇺🇸</td>
246+
<td>arr</td>
247+
<td>Programming languages that make up the codebase</td>
248+
<td></td>
249+
</tr>
202250
<tr>
203251
<td>maintenance</td>
204252
<td>required</td>
@@ -220,6 +268,44 @@ We encourage agencies to contribute by [submitting an agency schema addition iss
220268
<td>Contract number</td>
221269
<td></td>
222270
</tr>
271+
<tr>
272+
<td>SBOM</td>
273+
<td>required</td>
274+
<td>🇺🇸</td>
275+
<td>str</td>
276+
<td>Link of the upstream repositories and dependencies used, in the form of a Software Bill of Materials/SBOM. If the software does not have a SBOM, enter 'None'. (i.e. Github provides an SBOM: https://github.com/$ORG_NAME/$REPO_NAME/network/dependencies)</td>
277+
<td></td>
278+
</tr>
279+
<tr>
280+
<td>relatedCode/name <br> relatedCode/URL <br> relatedCode/isGovernmentRepo</td>
281+
<td>optional</td>
282+
<td>🇺🇸</td>
283+
<td>obj</td>
284+
<td>An array of affiliated government repositories that may be a part of the same project</td>
285+
<td>relatedCode for 'code-gov-front-end' would include 'code-gov-api' and 'code-gov-api-client'</td>
286+
</tr>
287+
<tr>
288+
<td>reusedCode/name <br> reusedCode/URL</td>
289+
<td>optional</td>
290+
<td>🇺🇸</td>
291+
<td>obj</td>
292+
<td>An array of government source code, libraries, frameworks, APIs, platforms or other software used in this release</td>
293+
<td>
294+
- US Web Design Standards<br>
295+
- cloud.gov<br>
296+
- Federalist<br>
297+
- Digital Services Playbook<br>
298+
- Analytics Reporter<br>
299+
</td>
300+
</tr>
301+
<tr>
302+
<td>partners/name <br> partners/email</td>
303+
<td>optional</td>
304+
<td>🇺🇸</td>
305+
<td>obj</td>
306+
<td>An array of objects including an acronym for each agency partnering on the release and the contact email at such agency</td>
307+
<td></td>
308+
</tr>
223309
<tr>
224310
<td>date/created <br> date/lastModified date/metadataLastUpdated</td>
225311
<td>required</td>
@@ -324,6 +410,14 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json).
324410
<td>Name of the project or software</td>
325411
<td></td>
326412
</tr>
413+
<tr>
414+
<td>version</td>
415+
<td>optional</td>
416+
<td>🇺🇸</td>
417+
<td>str</td>
418+
<td>The version for this release</td>
419+
<td></td>
420+
</tr>
327421
<tr>
328422
<td>description</td>
329423
<td>required</td>
@@ -415,14 +509,6 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json).
415509
<td>The URL of the public release repository for open source repositories. This field is not required for repositories that are only available as government-wide reuse or are closed (pursuant to one of the exemptions). It can be listed as 'private' for repositories that are closed.</td>
416510
<td></td>
417511
</tr>
418-
<tr>
419-
<td>projectURL</td>
420-
<td>optional</td>
421-
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>
422-
<td>str</td>
423-
<td>URL to landing page, demo, or production instance of project</td>
424-
<td></td>
425-
</tr>
426512
<tr>
427513
<td>repositoryHost</td>
428514
<td>required</td>
@@ -448,6 +534,38 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json).
448534
- public<br>
449535
- private
450536
</td>
537+
</tr>
538+
<tr>
539+
<td>homepageURL</td>
540+
<td>optional</td>
541+
<td>🇺🇸</td>
542+
<td>str</td>
543+
<td>The URL of the public release homepage</td>
544+
<td></td>
545+
</tr>
546+
<tr>
547+
<td>downloadURL</td>
548+
<td>optional</td>
549+
<td>🇺🇸</td>
550+
<td>str</td>
551+
<td>The URL where a distribution of the release can be found</td>
552+
<td></td>
553+
</tr>
554+
<tr>
555+
<td>disclaimerURL</td>
556+
<td>optional</td>
557+
<td>🇺🇸</td>
558+
<td>str</td>
559+
<td>The URL where disclaimer language regarding the release can be found</td>
560+
<td></td>
561+
</tr>
562+
<tr>
563+
<td>disclaimerText</td>
564+
<td>optional</td>
565+
<td>🇺🇸</td>
566+
<td>str</td>
567+
<td>Short paragraph that includes disclaimer language to accompany the release</td>
568+
<td></td>
451569
</tr>
452570
<tr>
453571
<td>vcs</td>
@@ -542,14 +660,52 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json).
542660
- none
543661
</td>
544662
</tr>
545-
<tr>
663+
<tr>
546664
<td>contractNumber</td>
547665
<td>required</td>
548666
<td>📜</td>
549667
<td>array</td>
550668
<td>Contract number</td>
551669
<td></td>
552670
</tr>
671+
<tr>
672+
<td>SBOM</td>
673+
<td>required</td>
674+
<td>🇺🇸</td>
675+
<td>str</td>
676+
<td>Link of the upstream repositories and dependencies used, in the form of a Software Bill of Materials/SBOM. If the software does not have a SBOM, enter 'None'. (i.e. Github provides an SBOM: https://github.com/$ORG_NAME/$REPO_NAME/network/dependencies)</td>
677+
<td></td>
678+
</tr>
679+
<tr>
680+
<td>relatedCode/name <br> relatedCode/URL <br> relatedCode/isGovernmentRepo</td>
681+
<td>optional</td>
682+
<td>🇺🇸</td>
683+
<td>obj</td>
684+
<td>An array of affiliated government repositories that may be a part of the same project</td>
685+
<td>relatedCode for 'code-gov-front-end' would include 'code-gov-api' and 'code-gov-api-client'</td>
686+
</tr>
687+
<tr>
688+
<td>reusedCode/name <br> reusedCode/URL</td>
689+
<td>optional</td>
690+
<td>🇺🇸</td>
691+
<td>obj</td>
692+
<td>An array of government source code, libraries, frameworks, APIs, platforms or other software used in this release</td>
693+
<td>
694+
- US Web Design Standards<br>
695+
- cloud.gov<br>
696+
- Federalist<br>
697+
- Digital Services Playbook<br>
698+
- Analytics Reporter<br>
699+
</td>
700+
</tr>
701+
<tr>
702+
<td>partners/name <br> partners/email</td>
703+
<td>optional</td>
704+
<td>🇺🇸</td>
705+
<td>obj</td>
706+
<td>An array of objects including an acronym for each agency partnering on the release and the contact email at such agency</td>
707+
<td></td>
708+
</tr>
553709
<tr>
554710
<td>date/created <br> date/lastModified date/metadataLastUpdated</td>
555711
<td>required</td>
@@ -653,7 +809,7 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json).
653809
<td></td>
654810
</tr>
655811
<tr>
656-
<td>project</td>
812+
<td>projects</td>
657813
<td>required</td>
658814
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>
659815
<td>arr</td>
@@ -669,14 +825,6 @@ Full schema can be found in [schema-2.0.0.json](../schemas/schema-2.0.0.json).
669825
<td>IDR, PECOS</td>
670826
</tr>
671827
<tr>
672-
<td>upstream</td>
673-
<td>optional</td>
674-
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>
675-
<td>arr</td>
676-
<td>Link of the upstream repositories and dependencies used, in the form of a Software Bill of Materials/SBOM (https://github.com/$ORG_NAME/$REPO_NAME/network/dependencies)</td>
677-
<td>augur, uswds</td>
678-
</tr>
679-
<tr>
680828
<td>subsetInHealthcare</td>
681829
<td>required</td>
682830
<td><img src="../assets/cms-logo.jpg" alt="CMS Logo"></td>

0 commit comments

Comments
 (0)