Added Tests + Schema Updates #33
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,175 +1,25 @@ | ||
| # Examples of code.json | ||
|
|
||
| Below are examples of well-structured and comprehensive metadata in CMS code.json files. These examples demonstrate best practices for repository-level metadata documentation. | ||
|
Contributor
There was a problem hiding this comment. Are these examples just for CMS code.json, or broadly for all Federal code.json?
Contributor
Author
There was a problem hiding this comment. Examples are currently just CMS code.jsons. Can def add more examples of other agencies |
||
|
|
||
| For additional reference, the [tests directory](../schemas/tests) contain 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. | ||
|
|
||
| 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) | ||
|
|
||
| DedupliFHIR is a desktop app tool that uses AI deduplication to identify duplicates in patient records. It is a [tier 3](https://github.com/DSACMS/repo-scaffolder/blob/dev/maturity-model-tiers.md#tier-information) project launched in production that receives user input. | ||
|
|
||
|
natalialuzuriaga marked this conversation as resolved.
|
||
| Link to code.json file: [codejson-example-dedupliFHIR.json](https://github.com/DSACMS/gov-codejson/blob/main/tests/examples/codejson-example-dedupliFHIR.json) | ||
|
|
||
| ## Example 2: [CMS Metrics Website](https://github.com/DSACMS/metrics) | ||
|
|
||
| The CMS Metrics Website is a [tier 3](https://github.com/DSACMS/repo-scaffolder/blob/dev/maturity-model-tiers.md#tier-information) project where government employees can view repository metrics on CMS open source projects, currently maintained by the CMS OSPO. | ||
|
|
||
| Link to code.json file: [codejson-example-metrics.json](https://github.com/DSACMS/gov-codejson/blob/main/tests/examples/codejson-example-metrics.json) | ||
|
|
||
| ## Example 3: [gov-codejson](https://github.com/DSACMS/gov-codejson) | ||
|
|
||
| gov-codejson (this repository!) is a [tier 3](https://github.com/DSACMS/repo-scaffolder/blob/dev/maturity-model-tiers.md#tier-information) project containing documentation on the code.json metadata standard, currently maintained by the federal government community. | ||
|
|
||
| Link to code.json file: [code.json](https://github.com/DSACMS/gov-codejson/blob/main/code.json) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| { | ||
| "target": "../schemas/cms/schema-0.2.0.json", | ||
| "$comment": "This test suite validates code.json files for compliance with the CMS schema requirements.", | ||
| "tests": [ | ||
| { | ||
| "description": "Example 1: DedupliFHIR", | ||
| "valid": true, | ||
| "dataPath": "./examples/codejson-example-dedupliFHIR.json" | ||
| }, | ||
| { | ||
| "description": "Example 2: metrics", | ||
| "valid": true, | ||
| "dataPath": "./examples/codejson-example-metrics.json" | ||
| }, | ||
| { | ||
| "description": "Example 3: gov-codejson", | ||
| "valid": true, | ||
| "dataPath": "../code.json" | ||
| } | ||
| ] | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.