package.schema.json

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://github.com/ossf/package-feeds/blob/main/package.schema.json",
    "title": "Package Schema Version 1.0",
    "description": "The package representation as outputted by a ScheduledFeed",
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "description": "The name of the package",
        "examples": ["foopackage", "Foo.Package", "@foouser/barpackage", "github.com/foo-user/bar-package"]
      },
      "version": {
        "type": "string",
        "description": "The package version, formatted respective to the given package type",
        "examples": ["1.0.0", "v1.0", "v0.1.1-197001010-ae2f65d", "foo-main"]
      },
      "created_date": {
        "type": "string",
        "description": "RFC 3339 timestamp representing the package creation date",
        "format": "date-time",
        "examples": ["1970-01-01T00:00:00.00000Z"]
      },
      "type": {
        "type": "string",
        "description": "The type of package, this being the `FeedName` of the given package feed",
        "examples": ["pypi", "npm", "crates", "goproxy"]
      },
      "artifact_id": {
        "type": "string",
        "description": "Identifies a particular downloadable artifact for this package version. No particular format is guaranteed; e.g. names may indicate platform-specific variants or include commit hashes.",
        "examples": ["factor_reader-1.0.3.tar.gz", "micrograd2023-0.0.3-py3-none-any.whl", "odoo14_addon_l10n_es_aeat-14.0.3.0.2.dev1-py3-none-any.whl"]
      },
      "schema_ver": {
        "type": "string",
        "pattern":  "^[1-9][0-9]*\\.[0-9]+",
        "description": "The schema version, increments in the minor reflect additive changes",
        "examples": ["1.0", "1.5", "2.0", "10.0"]
      }
    },
    "required": [ "name", "version", "created_date", "type", "schema_ver" ],
    "additionalProperties": false
  }