Skip to content

Commit 72882f5

Browse files
Update gov schema to include optional fields
Signed-off-by: Natalia Luzuriaga <natalia.luzuriaga@cms.hhs.gov>
1 parent 6507306 commit 72882f5

1 file changed

Lines changed: 83 additions & 0 deletions

File tree

schemas/schema-2.0.0.json

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
"type": "string",
1010
"description": "Name of the project or software"
1111
},
12+
"version": {
13+
"type": "string",
14+
"description": "The version for this release. For example, '1.0.0'."
15+
},
1216
"description": {
1317
"type": "string",
1418
"description": "A one or two sentence description of the software."
@@ -124,6 +128,25 @@
124128
],
125129
"description": "Visibility of repository"
126130
},
131+
"homepageURL": {
132+
"type": "string",
133+
"format": "uri",
134+
"description": "The URL of the public release homepage."
135+
},
136+
"downloadURL": {
137+
"type": "string",
138+
"format": "uri",
139+
"description": "The URL where a distribution of the release can be found."
140+
},
141+
"disclaimerURL": {
142+
"type": "string",
143+
"format": "uri",
144+
"description": "The URL where disclaimer language regarding the release can be found."
145+
},
146+
"disclaimerText": {
147+
"type": "string",
148+
"description": "Short paragraph that includes disclaimer language to accompany the release."
149+
},
127150
"vcs": {
128151
"type": "string",
129152
"description": "Version control system used",
@@ -186,6 +209,66 @@
186209
"type": "string",
187210
"description": "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)"
188211
},
212+
"relatedCode": {
213+
"type": "array",
214+
"description": "An array of affiliated government repositories that may be a part of the same project. For example, relatedCode for 'code-gov-front-end' would include 'code-gov-api' and 'code-gov-api-client'.",
215+
"items": {
216+
"type": "object",
217+
"properties": {
218+
"name": {
219+
"type": "string",
220+
"description": "The name of the code repository, project, library or release."
221+
},
222+
"URL": {
223+
"type": "string",
224+
"format": "uri",
225+
"description": "The URL where the code repository, project, library or release can be found."
226+
},
227+
"isGovernmentRepo": {
228+
"type": "boolean",
229+
"description": "True or False. Is the code repository owned or managed by a federal agency?"
230+
}
231+
},
232+
"additionalProperties": false
233+
}
234+
},
235+
"reusedCode": {
236+
"type": "array",
237+
"description": "An array of government source code, libraries, frameworks, APIs, platforms or other software used in this release. For example, US Web Design Standards, cloud.gov, Federalist, Digital Services Playbook, Analytics Reporter.",
238+
"items": {
239+
"type": "object",
240+
"properties": {
241+
"name": {
242+
"type": "string",
243+
"description": "The name of the software used in this release."
244+
},
245+
"URL": {
246+
"type": "string",
247+
"format": "uri",
248+
"description": "The URL where the software can be found."
249+
}
250+
},
251+
"additionalProperties": false
252+
}
253+
},
254+
"partners": {
255+
"type": "array",
256+
"description": "An array of objects including an acronym for each agency partnering on the release and the contact email at such agency.",
257+
"items": {
258+
"type": "object",
259+
"properties": {
260+
"name": {
261+
"type": "string",
262+
"description": "The acronym describing the partner agency."
263+
},
264+
"email": {
265+
"type": "string",
266+
"description": "The email address for the point of contact at the partner agency."
267+
}
268+
},
269+
"additionalProperties": false
270+
}
271+
},
189272
"date": {
190273
"type": "object",
191274
"description": "A date object describing the release",

0 commit comments

Comments
 (0)