schema-2.0.0.json

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://dsacms.github.io/code-json-schema.json",
    "title": "code.json metadata",
    "description": "A metadata standard for software repositories",
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "Name of the project or software"
        },
        "version": {
            "type": "string",
            "description": "The version for this release. For example, '1.0.0'."
        },
        "description": {
            "type": "string",
            "description": "A one or two sentence description of the software."
        },
        "status": {
            "type": "string",
            "enum": [
                "Ideation",
                "Development",
                "Alpha",
                "Beta",
                "Release Candidate",
                "Production",
                "Archival"
            ],
            "description": "Development status of the project"
        },
        "permissions": {
            "type": "object",
            "description": "An object containing description of the usage/restrictions regarding the release",
            "properties": {
                "licenses": {
                    "type": "array",
                    "description": "License(s) for the release",
                    "items": {
                        "type": "object",
                        "properties": {
                            "name": {
                                "type": "string",
                                "enum": [
                                    "CC0-1.0",
                                    "Apache-2.0",
                                    "MIT",
                                    "MPL-2.0",
                                    "GPL-2.0-only",
                                    "GPL-3.0-only",
                                    "GPL-3.0-or-later",
                                    "LGPL-2.1-only",
                                    "LGPL-3.0-only",
                                    "BSD-2-Clause",
                                    "BSD-3-Clause",
                                    "EPL-2.0",
                                    "Other",
                                    "None"
                                ],
                                "description": "An abbreviation for the name of the license"
                            },
                            "URL": {
                                "type": "string",
                                "format": "uri",
                                "description": "The URL of the release license in the repository"
                            }
                        },
                        "required": [
                            "name",
                            "URL"
                        ],
                        "additionalProperties": false
                    }
                },
                "usageType": {
                    "type": "array",
                    "items": {
                        "type": "string",
                        "enum": [
                            "openSource",
                            "governmentWideReuse",
                            "exemptByNationalSecurity",
                            "exemptByNationalIntelligence",
                            "exemptByFOIA",
                            "exemptByEAR",
                            "exemptByITAR",
                            "exemptByTSA",
                            "exemptByClassifiedInformation",
                            "exemptByPrivacyRisk",
                            "exemptByIPRestriction",
                            "exemptByAgencySystem",
                            "exemptByAgencyMission",
                            "exemptByCIO",
                            "exemptByPolicyDate"
                        ]
                    },
                    "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)"
                },
                "exemptionText": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "description": "If an exemption is listed in the 'usageType' field, this field should include a one- or two- sentence justification for the exemption used."
                }
            },
            "additionalProperties": false,
            "required": [
                "licenses",
                "usageType"
            ]
        },
        "organization": {
            "type": "string",
            "description": "The organization or component within the agency to which the releases listed belong. For example, '18F' or 'Navy'."
        },
        "repositoryURL": {
            "type": "string",
            "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). It can be listed as 'private' for repositories that are closed."
        },
        "repositoryVisibility": {
            "type": "string",
            "enum": [
                "public",
                "private"
            ],
            "description": "Visibility of repository"
        },
        "homepageURL": {
            "type": "string",
            "format": "uri",
            "description": "The URL of the public release homepage."
        },
        "downloadURL": {
            "type": "string",
            "format": "uri",
            "description": "The URL where a distribution of the release can be found."
        },
        "disclaimerURL": {
            "type": "string",
            "format": "uri",
            "description": "The URL where disclaimer language regarding the release can be found."
        },
        "disclaimerText": {
            "type": "string",
            "description": "Short paragraph that includes disclaimer language to accompany the release."
        },
        "vcs": {
            "type": "string",
            "description": "Version control system used",
            "enum": [
                "git",
                "hg",
                "svn",
                "rcs",
                "bzr",
                "none"
            ]
        },
        "laborHours": {
            "type": "number",
            "minimum": 0,
            "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"
        },
        "reuseFrequency": {
            "type": "object",
            "description": "Measures frequency of code reuse in various forms. (e.g. forks, downloads, clones)",
            "properties": {
                "forks": {
                    "type": "integer",
                    "minimum": 0
                },
                "clones": {
                    "type": "integer",
                    "minimum": 0
                }
            },
            "additionalProperties": true
        },
        "languages": {
            "type": "array",
            "description": "Programming languages that make up the codebase",
            "items": {
                "type": "string"
            },
            "uniqueItems": true
        },
        "maintenance": {
            "type": "string",
            "description": "The dedicated staff that keeps the software up-to-date, if any",
            "enum": [
                "internal",
                "contract",
                "community",
                "none"
            ]
        },
        "contractNumber": {
            "type": "array",
            "description": "Contract number(s) under which the project was developed",
            "items": {
                "type": "string"
            },
            "uniqueItems": true
        },
        "SBOM": {
            "type": "string",
            "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)"
        },
        "relatedCode": {
            "type": "array",
            "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'.",
            "items": {
                "type": "object",
                "properties": {
                    "name": {
                        "type": "string",
                        "description": "The name of the code repository, project, library or release."
                    },
                    "URL": {
                        "type": "string",
                        "format": "uri",
                        "description": "The URL where the code repository, project, library or release can be found."
                    },
                    "isGovernmentRepo": {
                        "type": "boolean",
                        "description": "True or False. Is the code repository owned or managed by a federal agency?"
                    }
                },
                "additionalProperties": false
            }
        },
        "reusedCode": {
            "type": "array",
            "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.",
            "items": {
                "type": "object",
                "properties": {
                    "name": {
                        "type": "string",
                        "description": "The name of the software used in this release."
                    },
                    "URL": {
                        "type": "string",
                        "format": "uri",
                        "description": "The URL where the software can be found."
                    }
                },
                "additionalProperties": false
            }
        },
        "partners": {
            "type": "array",
            "description": "An array of objects including an acronym for each agency partnering on the release and the contact email at such agency.",
            "items": {
                "type": "object",
                "properties": {
                    "name": {
                        "type": "string",
                        "description": "The acronym describing the partner agency."
                    },
                    "email": {
                        "type": "string",
                        "description": "The email address for the point of contact at the partner agency."
                    }
                },
                "additionalProperties": false
            }
        },
        "date": {
            "type": "object",
            "description": "A date object describing the release",
            "properties": {
                "created": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Creation date of project."
                },
                "lastModified": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Date when the project was last modified"
                },
                "metadataLastUpdated": {
                    "type": "string",
                    "format": "date-time",
                    "description": "Date when metadata was last updated"
                }
            },
            "additionalProperties": false
        },
        "tags": {
            "type": "array",
            "description": "Topics and keywords associated with the project to improve search and discoverability",
            "items": {
                "type": "string"
            },
            "uniqueItems": true
        },
        "contact": {
            "type": "object",
            "description": "Point of contact for the release",
            "properties": {
                "email": {
                    "type": "string",
                    "format": "email",
                    "description": "Email address of the point of contact"
                },
                "name": {
                    "type": "string",
                    "description": "Name of the point of contact"
                }
            },
            "additionalProperties": false
        },
        "feedbackMechanism": {
            "type": "string",
            "format": "uri",
            "description": "Method a repository receives feedback from the community (i.e. URL to GitHub repository issues page)"
        },
        "AIUseCaseID": {
            "type": "string",
            "description": "The software's ID in the AI Use Case Inventory. If the software is not currently listed in the inventory, enter '0'."
        }
    },
    "required": [
        "name",
        "description",
        "status",
        "permissions",
        "organization",
        "repositoryURL",
        "repositoryVisibility",
        "vcs",
        "laborHours",
        "reuseFrequency",
        "languages",
        "maintenance",
        "contractNumber",
        "SBOM",
        "date",
        "tags",
        "contact",
        "feedbackMechanism",
        "AIUseCaseID"
    ],
    "additionalProperties": true
}