Skip to content
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: json-validate
name: json-schema-tests
on:
pull_request:
types: [opened, synchronize]
Expand All @@ -11,7 +11,7 @@ permissions:
pull-requests: write # enable write permissions for pull request comments

jobs:
json-yaml-validate:
Comment thread
natalialuzuriaga marked this conversation as resolved.
json-validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand All @@ -22,3 +22,17 @@ jobs:
with:
comment: "true"
json_schema_version: "draft-04"

schema-tests:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Install the JSON Schema CLI
uses: sourcemeta/jsonschema@v11.1.1

- name: Run generic schema unit tests
run: jsonschema test schemas/test/gov-schema.json --resolve schemas/schema-2.0.0.json

- name: Run CMS schema unit tests
run: jsonschema test schemas/test/cms-schema.json --resolve schemas/cms/schema-0.2.0.json
42 changes: 30 additions & 12 deletions code.json
Original file line number Diff line number Diff line change
@@ -1,22 +1,29 @@
{
"name": "gov-codejson",
"description": "code.json: An agency-wide metadata standard for software projects",
"longDescription": "This repository contains documentation on code.json, a metadata standard used to collect information on the agency's software projects in compliance with M-16-21 and the SHARE IT Act.",
"longDescription": "This repository contains documentation on code.json, a metadata standard used to collect information on agency software projects in compliance with M-16-21 and the SHARE IT Act.",
"status": "Production",
"permissions": {
"license": [
"licenses": [
Comment thread
natalialuzuriaga marked this conversation as resolved.
{
"name": "CC0 1.0 Universal",
"name": "CC0-1.0",
Comment thread
natalialuzuriaga marked this conversation as resolved.
"URL": "https://github.com/DSACMS/gov-codejson/blob/main/LICENSE"
}
],
"usageType": "openSource",
"usageType": [
"openSource"
],
"exemptionText": ""
},
"organization": "Centers for Medicare & Medicaid Services",
"repositoryURL": "https://github.com/DSACMS/gov-codejson",
"repositoryHost": "github.com/DSACMS",
"repositoryVisibility": "public",
"vcs": "git",
"laborHours": 3479,
"reuseFrequency": {
"forks": 2
},
"platforms": [
"web"
],
Expand All @@ -26,15 +33,20 @@
],
"softwareType": "standalone/web",
"languages": [
"Markdown"
"javascript"
],
"maintenance": "internal",
"maintenance": "community",
"contractNumber": [],
"date": {
"created": "2025-02-04T21:59:53Z",
"lastModified": "2025-02-11T18:45:30Z",
"metaDataLastUpdated": "2025-02-11T18:47:02.924Z"
"lastModified": "2025-08-13T22:27:54Z",
"metaDataLastUpdated": "2025-08-15T16:41:02.063Z"
},
"tags": [
"dsacms-tier3",
"government",
"json",
"metadata-standard",
"guide",
"codejson",
"OSPO",
Expand All @@ -46,17 +58,23 @@
"email": "opensource@cms.hhs.gov",
"name": "CMS Open Source Team"
},
"feedbackMechanism": "https://github.com/DSACMS/gov-codejson/issues",
"AIUseCaseID": "0",
"localisation": false,
"repositoryType": "standards",
"userInput": false,
"fismaLevel": "Low",
"fismaLevel": "low",
"group": "CMS/OA/DSAC",
"projects": [
"SHARE IT Act"
],
"systems": [],
"upstream": "https://github.com/DSACMS/gov-codejson/network/dependencies",
"subsetInHealthcare": [
"Operational"
"operational"
],
"userType": [
"Government"
"government"
],
"repositoryHost": "github.com/DSACMS",
"maturityModelTier": 3
}
37 changes: 20 additions & 17 deletions docs/examples.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Examples of code.json

Below are good examples of metadata in CMS code.json files. We hope it helps when creating your repository-level code.json file.
Below are examples of well-structured and comprehensive metadata in CMS code.json files. These examples demonstrate best practices for repository-level metadata documentation.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these examples just for CMS code.json, or broadly for all Federal code.json?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Examples are currently just CMS code.jsons. Can def add more examples of other agencies


For additional reference, the [test directory](../schemas/test) contains unit tests of code.json files from various DSACMS repositories. These tests help ensure consistency and compliance as we make future updates to the schemas.
Comment thread
natalialuzuriaga marked this conversation as resolved.
Outdated

We encourage you to review these examples and tests when creating or updating your repository-level code.json file to maintain consistency with federal standards.

## Example 1: [DedupliFHIR](https://github.com/DSACMS/dedupliFHIR)

Expand All @@ -10,21 +14,20 @@ DedupliFHIR is a desktop app tool that uses AI deduplication to identify duplica
{
"name": "dedupliFHIR",
"description": "Prototype for basic deduplication and aggregation of eCQM data",
"longDescription": "A CLI bundled with an electron front-end that provides data-linkage and AI deduplication for reported ACO data at scale.",
"longDescription": "A CLI bundled with an Electron.js front-end that provides data-linkage and AI deduplication for reported Accountable Care Organization (ACO) data at scale.",
Comment thread
natalialuzuriaga marked this conversation as resolved.
Outdated
"status": "Production",
"permissions": {
"license": [
{
"name": "CC0 1.0 Universal",
"name": "CC0 1.0",
"URL": "https://github.com/DSACMS/dedupliFHIR/blob/main/LICENSE"
}
],
"usageType": "openSource",
"usageType": ["openSource"],
Comment thread
natalialuzuriaga marked this conversation as resolved.
Outdated
"exemptionText": ""
},
"organization": "Centers for Medicare & Medicaid Services",
"repositoryURL": "https://github.com/DSACMS/dedupliFHIR",
"projectURL": "",
Comment thread
natalialuzuriaga marked this conversation as resolved.
"repositoryHost": "github.com/DSACMS",
"repositoryVisibility": "public",
"vcs": "git",
Expand Down Expand Up @@ -71,21 +74,21 @@ DedupliFHIR is a desktop app tool that uses AI deduplication to identify duplica
"email": "opensource@cms.hhs.gov",
"name": "CMS Open Source Team"
},
"feedbackMechanisms": "https://github.com/DSACMS/dedupliFHIR/issues",
"feedbackMechanism": "https://github.com/DSACMS/dedupliFHIR/issues",
"AIUseCaseID": "0",
"localisation": false,
"repositoryType": "application",
"userInput": "true",
"fismaLevel": "Moderate",
"userInput": true,
Comment thread
natalialuzuriaga marked this conversation as resolved.
Outdated
"fismaLevel": "moderate",
"group": "CMS/OA/DSAC",
"projects": [],
"systems": [],
"upstream": "https://github.com/DSACMS/dedupliFHIR/network/dependencies",
"subsetInHealthcare": [
"Operational"
"operational"
],
"userType": [
"Providers"
"providers"
],
"maturityModelTier": "3"
}
Expand All @@ -104,11 +107,11 @@ The CMS Metrics Website is a [tier 3](https://github.com/DSACMS/repo-scaffolder/
"permissions": {
"license": [
{
"name": "CC0 1.0 Universal",
"name": "CC0 1.0",
"URL": "https://github.com/DSACMS/metrics/blob/main/LICENSE.md"
}
],
"usageType": "openSource",
"usageType": ["openSource"],
"exemptionText": ""
},
"organization": "Centers for Medicare & Medicaid Services",
Expand Down Expand Up @@ -154,21 +157,21 @@ The CMS Metrics Website is a [tier 3](https://github.com/DSACMS/repo-scaffolder/
"email": "opensource@cms.hhs.gov",
"name": "CMS/OA/DSAC/OSPO"
},
"feedbackMechanisms": "https://github.com/DSACMS/metrics/issues",
"feedbackMechanism": "https://github.com/DSACMS/metrics/issues",
"AIUseCaseID": "0",
"localisation": false,
"repositoryType": "website",
"userInput": "No",
"fismaLevel": "Low",
"userInput": false,
"fismaLevel": "low",
"group": "CMS/OA/DSAC",
"projects": [],
"systems": [],
"upstream": "https://github.com/DSACMS/metrics/network/dependencies",
"subsetInHealthcare": [
"Operational"
"operational"
],
"userType": [
"Government"
"government"
],
"maturityModelTier": 3
}
Expand Down
20 changes: 10 additions & 10 deletions schemas/cms/schema-0.2.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -317,9 +317,9 @@
"type": "string",
"description": "Level of security categorization assigned to an information system under the Federal Information Security Modernization Act (FISMA): https://security.cms.gov/learn/federal-information-security-modernization-act-fisma",
"enum": [
"Low",
"Moderate",
"High"
"low",
"moderate",
"high"
]
},
"group": {
Expand Down Expand Up @@ -349,10 +349,10 @@
"items": {
"type": "string",
"enum": [
"Policy",
"Operational",
"Medicare",
"Medicaid"
"policy",
"operational",
"medicare",
"medicaid"
]
},
"description": "Healthcare-related subset"
Expand All @@ -362,9 +362,9 @@
"items": {
"type": "string",
"enum": [
"Providers",
"Patients",
"Government"
"providers",
"patients",
"government"
]
},
"description": "Types of users who interact with the software"
Expand Down
9 changes: 8 additions & 1 deletion schemas/schema-2.0.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,13 @@
},
"additionalProperties": true
},
"languages": {
"type": "array",
"description": "Programming languages that make up the codebase",
"items": {
"type": "string"
}
},
"maintenance": {
"type": "string",
"description": "The dedicated staff that keeps the software up-to-date, if any",
Expand Down Expand Up @@ -241,5 +248,5 @@
"feedbackMechanism",
"AIUseCaseID"
],
"additionalProperties": false
"additionalProperties": true
}
Loading
Loading