schemes-schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/pha4ge/amplicon-schemas",
  "title": "Amplicon Scheme",
  "description": "A PrimalSeq Amplicon Scheme",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
        "name": {
            "description": "The canonical name of the primer scheme",
            "type": "string"
        },
        "organism": {
            "description": "The organism that this primer scheme refers to, e.g. SARS-CoV-2",
            "type": "string"
        },
        "organism_aliases": {
            "description": "Aliases for organism name",
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "aliases": {
            "description": "Aliases for amplicon scheme name",
            "type": "array",
            "items": {
                "type": "string"
            },
            "uniqueItems": true
        },
        "developers": {
            "description": "Persons or organisations responsible for developing the amplicon scheme",
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "name": {
                        "description": "Descriptive name of the person or organisation",
                        "type": "string"
                    },
                    "url": {
                        "description": "URL to identifier for person or organisation. For person, links to ORCID profiles are preferred",
                        "type": "string"
                    }
                }
            },
            "minItems": 1
        },
        "vendors": {
            "description": "Vendors where one can purchase the primers described in the amplicon scheme or a kit containing these primers",
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "name": {
                        "description": "Name of the vendor",
                        "type": "string"
                    },
                    "url": {
                        "description": "URL to page describing primer or kit product",
                        "type": "string"
                    }
                }
            }
        },
        "amplicon_size": {
            "description": "The length (in base pairs) of an amplicon in the primer scheme",
            "type": "integer"
        },
        "bed_url": {
            "description": "Link to location where BED file for scheme can be downloaded",
            "type": "string"
        },
        "bed_checksum": {
            "description": "Checksum for the primer scheme BED file, in format hash:checksum, where hash is lowercase name of hash e.g. sha256",
            "type": "string"
        },
        "reference_url": {
            "description": "URL for reference sequence that the primer scheme refers to",
            "type": "string"
        },
        "reference_checksum": {
            "description": "Checksum for the reference sequence, format as described for bed_checksum",
            "type": "string"
        },
        "citation": {
            "description": "Link to publication describing the scheme (DOIs preferred when available)",
            "type": "string"
        }
      },
      "required": [ "name", "organism", "developers", "amplicon_size", "bed_url" ]
    }
}