|
1 | 1 | { |
2 | | - "$schema": "http://json-schema.org/draft-04/schema#", |
3 | | - "title": "CMS Code.json Metadata", |
| 2 | + "$schema": "https://json-schema.org/draft/2020-12/schema", |
| 3 | + "$id": "https://dsacms.github.io/code-json-schema.json", |
| 4 | + "title": "CMS code.json metadata", |
4 | 5 | "description": "A metadata standard for software repositories of CMS", |
5 | 6 | "type": "object", |
6 | 7 | "properties": { |
|
70 | 71 | "required": [ |
71 | 72 | "name", |
72 | 73 | "URL" |
73 | | - ] |
| 74 | + ], |
| 75 | + "additionalProperties": false |
74 | 76 | } |
75 | 77 | }, |
76 | 78 | "usageType": { |
|
95 | 97 | "exemptByPolicyDate" |
96 | 98 | ] |
97 | 99 | }, |
98 | | - "description": "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)", |
99 | | - "additionalProperties": false |
| 100 | + "description": "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)" |
100 | 101 | }, |
101 | 102 | "exemptionText": { |
102 | 103 | "type": [ |
|
157 | 158 | "hg", |
158 | 159 | "svn", |
159 | 160 | "rcs", |
160 | | - "bzr" |
| 161 | + "bzr", |
| 162 | + "none" |
161 | 163 | ] |
162 | 164 | }, |
163 | 165 | "laborHours": { |
164 | 166 | "type": "number", |
| 167 | + "minimum": 0, |
165 | 168 | "description": "Labor hours invested in the project. Calculated using COCOMO measured by the SCC tool: https://github.com/boyter/scc?tab=readme-ov-file#cocomo" |
166 | 169 | }, |
167 | 170 | "reuseFrequency": { |
168 | 171 | "type": "object", |
169 | 172 | "description": "Measures frequency of code reuse in various forms. (e.g. forks, downloads, clones)", |
170 | 173 | "properties": { |
171 | 174 | "forks": { |
172 | | - "type": "integer" |
| 175 | + "type": "integer", |
| 176 | + "minimum": 0 |
173 | 177 | }, |
174 | 178 | "clones": { |
175 | | - "type": "integer" |
| 179 | + "type": "integer", |
| 180 | + "minimum": 0 |
176 | 181 | } |
177 | 182 | }, |
178 | 183 | "additionalProperties": true |
|
191 | 196 | "android", |
192 | 197 | "other" |
193 | 198 | ] |
194 | | - } |
| 199 | + }, |
| 200 | + "uniqueItems": true |
195 | 201 | }, |
196 | 202 | "categories": { |
197 | 203 | "type": "array", |
198 | 204 | "description": "Categories the project belongs to. Select from: https://yml.publiccode.tools/categories-list.html", |
199 | 205 | "items": { |
200 | 206 | "type": "string" |
201 | | - } |
| 207 | + }, |
| 208 | + "uniqueItems": true |
202 | 209 | }, |
203 | 210 | "softwareType": { |
204 | 211 | "type": "string", |
|
220 | 227 | "description": "Programming languages that make up the codebase", |
221 | 228 | "items": { |
222 | 229 | "type": "string" |
223 | | - } |
| 230 | + }, |
| 231 | + "uniqueItems": true |
224 | 232 | }, |
225 | 233 | "maintenance": { |
226 | 234 | "type": "string", |
|
237 | 245 | "description": "Contract number(s) under which the project was developed", |
238 | 246 | "items": { |
239 | 247 | "type": "string" |
240 | | - } |
| 248 | + }, |
| 249 | + "uniqueItems": true |
| 250 | + }, |
| 251 | + "SBOM": { |
| 252 | + "type": "string", |
| 253 | + "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)" |
241 | 254 | }, |
242 | 255 | "date": { |
243 | 256 | "type": "object", |
|
258 | 271 | "format": "date-time", |
259 | 272 | "description": "Date when metadata was last updated" |
260 | 273 | } |
261 | | - } |
| 274 | + }, |
| 275 | + "additionalProperties": false |
262 | 276 | }, |
263 | 277 | "tags": { |
264 | 278 | "type": "array", |
265 | 279 | "description": "Topics and keywords associated with the project to improve search and discoverability", |
266 | 280 | "items": { |
267 | 281 | "type": "string" |
268 | | - } |
| 282 | + }, |
| 283 | + "uniqueItems": true |
269 | 284 | }, |
270 | 285 | "contact": { |
271 | 286 | "type": "object", |
|
280 | 295 | "type": "string", |
281 | 296 | "description": "Name of the point of contact" |
282 | 297 | } |
283 | | - } |
| 298 | + }, |
| 299 | + "additionalProperties": false |
284 | 300 | }, |
285 | 301 | "feedbackMechanism": { |
286 | 302 | "type": "string", |
|
331 | 347 | "description": "Project(s) that is associated or related to the repository, if any (e.g. Bluebutton, MPSM)", |
332 | 348 | "items": { |
333 | 349 | "type": "string" |
334 | | - } |
| 350 | + }, |
| 351 | + "uniqueItems": true |
335 | 352 | }, |
336 | 353 | "systems": { |
337 | 354 | "type": "array", |
338 | 355 | "description": "CMS systems that the repository interfaces with or depends on, if any (e.g. IDR, PECOS)", |
339 | 356 | "items": { |
340 | 357 | "type": "string" |
341 | | - } |
342 | | - }, |
343 | | - "upstream": { |
344 | | - "type": "string", |
345 | | - "description": "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)" |
| 358 | + }, |
| 359 | + "uniqueItems": true |
346 | 360 | }, |
347 | 361 | "subsetInHealthcare": { |
348 | 362 | "type": "array", |
|
355 | 369 | "medicaid" |
356 | 370 | ] |
357 | 371 | }, |
358 | | - "description": "Healthcare-related subset" |
| 372 | + "description": "Healthcare-related subset", |
| 373 | + "uniqueItems": true |
359 | 374 | }, |
360 | 375 | "userType": { |
361 | 376 | "type": "array", |
|
367 | 382 | "government" |
368 | 383 | ] |
369 | 384 | }, |
370 | | - "description": "Types of users who interact with the software" |
| 385 | + "description": "Types of users who interact with the software", |
| 386 | + "uniqueItems": true |
371 | 387 | }, |
372 | 388 | "maturityModelTier": { |
373 | 389 | "type": "integer", |
|
400 | 416 | "languages", |
401 | 417 | "maintenance", |
402 | 418 | "contractNumber", |
| 419 | + "SBOM", |
403 | 420 | "date", |
404 | 421 | "tags", |
405 | 422 | "contact", |
|
0 commit comments