diff --git a/docs/metadata.md b/docs/metadata.md
index 944aa91..6fd1c4f 100644
--- a/docs/metadata.md
+++ b/docs/metadata.md
@@ -150,7 +150,40 @@ By harmonizing various standards, this opens up the opportunity to share our wor
|
- | vcs (version control system) |
+ projectURL |
+ optional |
+  |
+ str |
+ URL to landing page, demo, or production instance of project |
+ |
+
+
+ | repositoryHost |
+ required |
+ |
+ str |
+ Location where source code is hosted |
+
+ - github.com/CMSgov
+ - github.com/CMS-Enterprise
+ - github.com/DSACMS
+ - github.cms.gov
+ - CCSQ GitHub
+ |
+
+
+ | repositoryVisibility |
+ required |
+ π |
+ str |
+ Visibility of repository |
+
+ - public
+ - private
+ |
+
+
+ | vcs |
required |
πΊπΈ |
str |
@@ -172,7 +205,15 @@ By harmonizing various standards, this opens up the opportunity to share our wor
|
- | platform |
+ reuseFrequency/forks
reuseFrequency/clones |
+ required |
+ π |
+ obj |
+ Measures frequency of code reuse in various forms |
+ |
+
+
+ | platforms |
required |
π |
arr |
@@ -226,13 +267,21 @@ By harmonizing various standards, this opens up the opportunity to share our wor
required |
ππ |
str |
- Maintenance status |
+ The dedicated staff that keeps the software up-to-date, if any |
- internal
- contract
- community
- none
|
+
+
+ | contractNumber |
+ required |
+ π |
+ int |
+ Contract number |
+ |
date/created
date/lastModified date/metadataLastUpdated |
@@ -247,7 +296,7 @@ By harmonizing various standards, this opens up the opportunity to share our wor
required |
πΊπΈ |
arr |
- Tags associated with the project |
+ Topics and keywords associated with the project to improve search and discoverability |
|
@@ -257,6 +306,19 @@ By harmonizing various standards, this opens up the opportunity to share our wor
| obj |
Point of contact for the release
Email of point of contact
Name of point of contact |
|
+
+
+ | feedbackMechanisms |
+ required |
+ π |
+ arr |
+ Array of methods repositories receive feedback. Default value is the URL to GitHub repository issues |
+
+ - Submitting issues to repo
+ - Submitting PRs to repo
+ - Project website
+ - Email
+ |
| localisation |
@@ -302,7 +364,7 @@ By harmonizing various standards, this opens up the opportunity to share our wor
required |
|
str |
- FISMA security level link |
+ Level of security categorization assigned to an information system under the Federal Information Security Modernization Act (FISMA): link |
- low
- moderate
@@ -318,6 +380,30 @@ By harmonizing various standards, this opens up the opportunity to share our wor
| |
+ | project |
+ required |
+ |
+ arr |
+ Project(s) that is associated or related to the repository, if any. |
+ Bluebutton, MPSM, codejson |
+
+
+ | systems |
+ optional |
+ |
+ arr |
+ CMS systems that the repository interfaces with or depends on, if any. |
+ IDR, PECOS |
+
+
+ | upstream |
+ optional |
+ |
+ arr |
+ 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) |
+ augur, uswds |
+
+
| subsetInHealthcare |
required |
|
@@ -342,95 +428,19 @@ By harmonizing various standards, this opens up the opportunity to share our wor
- government
-
- | repositoryHost |
- required |
- |
- str |
- Location where source code is hosted |
-
- - github.com/CMSgov
- - github.com/CMS-Enterprise
- - github.com/DSACMS
- - github.cms.gov
- - CCSQ GitHub
- |
-
| maturityModelTier |
required |
|
int |
Maturity model tier |
- 1, 2, 3, 4 |
-
-
- | contractNumber |
- required |
- π |
- int |
- Contract number |
- |
-
-
- | repositoryVisibility |
- required |
- π |
- str |
- Visibility of repository |
-
- - public
- - private
- |
-
-
- reuseFrequency/forks
reuseFrequency/downloads |
- required |
- π |
- obj |
- Measures frequency of code reuse in various forms |
- |
-
-
- | feedbackMechanisms |
- required |
- π |
- arr |
- Array of methods repositories receive feedback. Default value is the URL to GitHub repository issues |
-
- - Submitting issues to repo
- - Submitting PRs to repo
- - Project website
- - Email
- |
-
-
- | project |
- required |
- |
- arr |
- Maps repositories to projects |
- bluebutton, codejson |
-
-
- | systems |
- optional |
- |
- arr |
- Maps repositories to CMS systems |
- idr |
-
-
- | upstream |
- optional |
- |
- arr |
- List of upstream repos used, link to SBOM. |
- augur, uswds |
+ 0, 1, 2, 3, 4 |
+Full schema can be found in [schema-0.1.0.json](../schemas/schema-0.1.0.json).
+
### Adding new metadata fields
We are open to adding more fields to CMS code.json for any metadata the agency sees value in collecting. Request new metadata fields by filing a metadata field addition issue [here](https://github.com/DSACMS/gov-codejson/issues/new?template=metadata-field-addition.md).
diff --git a/schemas/schema-0.1.0.json b/schemas/schema-0.1.0.json
index 40bf0c2..ee744ee 100644
--- a/schemas/schema-0.1.0.json
+++ b/schemas/schema-0.1.0.json
@@ -116,6 +116,11 @@
"format": "uri",
"description": "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)."
},
+ "projectURL": {
+ "type": "string",
+ "format": "uri",
+ "description": "URL to landing page, demo, or production instance of project"
+ },
"repositoryHost": {
"type": "string",
"description": "Location where source code is hosted",
@@ -129,7 +134,10 @@
},
"repositoryVisibility": {
"type": "string",
- "enum": ["public", "private"],
+ "enum": [
+ "public",
+ "private"
+ ],
"description": "Visibility of repository"
},
"vcs": {
@@ -151,11 +159,11 @@
"type": "object",
"description": "Measures frequency of code reuse in various forms. (e.g. forks, downloads, clones)",
"properties": {
- "forks": {
- "type": "integer"
+ "forks": {
+ "type": "integer"
},
- "clones": {
- "type": "integer"
+ "clones": {
+ "type": "integer"
}
},
"additionalProperties": true
@@ -307,14 +315,14 @@
"projects": {
"type": "array",
"description": "Project(s) that is associated or related to the repository, if any (e.g. Bluebutton, MPSM)",
- "items": {
+ "items": {
"type": "string"
}
},
"systems": {
"type": "array",
"description": "CMS systems that the repository interfaces with or depends on, if any (e.g. IDR, PECOS)",
- "items": {
+ "items": {
"type": "string"
}
},
@@ -350,6 +358,7 @@
"maturityModelTier": {
"type": "integer",
"enum": [
+ 0,
1,
2,
3,