product-schema.json

{
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "title": {
      "title": "Title",
      "description": "The title of this product",
      "type": "string"
    },
    "versionCommand": {
      "title": "Version command",
      "description": "Command to fetch the products version.",
      "examples": [
        "helm version",
        "go version"
      ],
      "type": "string"
    },
    "releasePolicyLink": {
      "title": "Release policy link",
      "description": "URL to the producs release policy page.",
      "type": "string",
      "pattern": "^https?://.+$"
    },
    "iconUrl": {
      "title": "Icon url",
      "description": "URL to the product icon.",
      "type": "string",
      "format": "uri-template"
    },
    "category": {
      "title": "Category",
      "description": "Specify the category of this product.",
      "enum": [
        "app",
        "db",
        "device",
        "framework",
        "lang",
        "library",
        "os",
        "server-app",
        "service",
        "standard"
      ]
    },
    "permalink": {
      "title": "Permalink",
      "description": "The URL to this product. Must start with a slash.",
      "examples": [
        "/foo",
        "/bar"
      ],
      "$ref": "#/$defs/link"
    },
    "tags": {
      "title": "Tags",
      "description": "Tags which fit this product. Only lowercase, numbers and minus are allowed. Separated via spaces.",
      "type": "string",
      "pattern": "^[a-z0-9\\-]+( [a-z0-9\\-]+)*$",
      "examples": [
        "foo bar"
      ]
    },
    "alternate_urls": {
      "title": "Alternate URLs",
      "description": "Array of alternate urls for this product. Must start with a slash.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/link"
      }
    },
    "auto": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "git": {
                "title": "Git",
                "description": "URL to git repo. Fetches releases from tags.",
                "type": "string"
              },
              "regex": {
                "$ref": "#/$defs/regex"
              },
              "regex_exclude": {
                "$ref": "#/$defs/regex"
              },
              "template": {
                "$ref": "#/$defs/template"
              }
            },
            "required": [
              "git"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "npm": {
                "title": "Npm",
                "description": "Name of the npm package to track.",
                "type": "string"
              },
              "regex": {
                "$ref": "#/$defs/regex"
              },
              "regex_exclude": {
                "$ref": "#/$defs/regex"
              },
              "template": {
                "$ref": "#/$defs/template"
              }
            },
            "required": [
              "npm"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "docker_hub": {
                "title": "Dockerhub",
                "description": "Image name on dockerhub to track.",
                "type": "string"
              },
              "regex": {
                "$ref": "#/$defs/regex"
              },
              "regex_exclude": {
                "$ref": "#/$defs/regex"
              },
              "template": {
                "$ref": "#/$defs/template"
              }
            },
            "required": [
              "docker_hub"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "distrowatch": {
                "title": "Distrowatch",
                "description": "Name of the distro on distrowatch.",
                "type": "string"
              },
              "regex": {
                "$ref": "#/$defs/regex"
              },
              "regex_exclude": {
                "$ref": "#/$defs/regex"
              },
              "template": {
                "$ref": "#/$defs/template"
              }
            },
            "required": [
              "distrowatch"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "custom": {
                "title": "Custom",
                "description": "Use a custom script in the release-data repo.",
                "type": "boolean"
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "github_releases": {
                "title": "Github releases",
                "description": "Github repo to track the releases from in the format {author}/{repo}.",
                "type": "string"
              },
              "regex": {
                "$ref": "#/$defs/regex"
              },
              "regex_exclude": {
                "$ref": "#/$defs/regex"
              }
            },
            "required": [
              "github_releases"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "pypi": {
                "title": "Pypi",
                "description": "Package name on pypi.",
                "type": "string"
              },
              "regex": {
                "$ref": "#/$defs/regex"
              },
              "regex_exclude": {
                "$ref": "#/$defs/regex"
              },
              "template": {
                "$ref": "#/$defs/template"
              }
            },
            "required": [
              "pypi"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "maven": {
                "title": "Maven",
                "description": "Package name on maven.",
                "type": "string"
              },
              "regex": {
                "$ref": "#/$defs/regex"
              },
              "regex_exclude": {
                "$ref": "#/$defs/regex"
              },
              "template": {
                "$ref": "#/$defs/template"
              }
            },
            "required": [
              "maven"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "cgit": {
                "title": "Cgit",
                "description": "Fetch versions (from tags) with their dates from a cgit repository.",
                "type": "string"
              },
              "regex": {
                "$ref": "#/$defs/regex"
              },
              "regex_exclude": {
                "$ref": "#/$defs/regex"
              },
              "template": {
                "$ref": "#/$defs/template"
              }
            },
            "required": [
              "cgit"
            ],
            "additionalProperties": false
          }
        ]
      }
    },
    "customColumns": {
      "title": "Custom columns",
      "description": "Array of custom columns for this product.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/customColumn"
      }
    },
    "releases": {
      "title": "Releases",
      "description": "Array of releases for this product.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/release"
      }
    }
  },
  "required": [
    "title",
    "category",
    "permalink",
    "releases"
  ],
  "$defs": {
    "boolOrDate": {
      "oneOf": [
        {
          "type": "string",
          "format": "date"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "link": {
      "type": "string",
      "pattern": "^/"
    },
    "template": {
      "title": "Template",
      "description": "Template which will be used to create the final release.",
      "type": "string"
    },
    "regex": {
      "title": "Regex",
      "description": "Regex which will be used to filter the versions.",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ]
    },
    "customColumn": {
      "type": "object",
      "properties": {
        "property": {
          "title": "Property",
          "description": "Name of the custom property in release cycles.",
          "examples": [
            "supportedIosVersions",
            "correspondingAndroidVersion"
          ],
          "type": "string"
        },
        "position": {
          "title": "Position",
          "description": "Position of the custom column in the table.",
          "enum": [
            "after-release-column",
            "before-latest-column",
            "after-latest-column"
          ]
        },
        "label": {
          "title": "Label",
          "description": "Label of the custom column.",
          "type": "string"
        },
        "description": {
          "title": "Description",
          "description": "A description of what contains the custom column.",
          "type": "string"
        },
        "link": {
          "title": "Link",
          "description": "A link that gives more information about what contains the custom column.",
          "type": "string"
        }
      },
      "required": [
        "property",
        "position",
        "label"
      ]
    },
    "release": {
      "type": "object",
      "properties": {
        "releaseCycle": {
          "title": "releaseCycle",
          "description": "The release cycle which this release is part of.",
          "examples": [
            "1",
            "1.0"
          ],
          "type": "string"
        },
        "link": {
          "title": "Link",
          "description": "Link to changelog for the latest release.",
          "oneOf": [
            {
              "type": "string",
              "pattern": "[^ ]+"
            },
            {
              "type": "null"
            }
          ]
        },
        "releaseLabel": {
          "title": "Release label",
          "description": "The human readable name of this release.",
          "type": "string"
        },
        "eolColumn": {
          "title": "EOL column",
          "description": "Name of the EOL column or `false` to disable the column.",
          "examples": [
            "General Support",
            false
          ],
          "oneOf": [
            {
              "const": false
            },
            {
              "type": "string"
            }
          ]
        },
        "eol": {
          "title": "EOL",
          "description": "Date in the format `yyyy-mm-dd` or `false` if not available.",
          "$ref": "#/$defs/boolOrDate"
        },
        "eoasColumn": {
          "title": "Active support column",
          "description": "Name of the active support column or `false` to disable the column.",
          "type": "boolean"
        },
        "eoas": {
          "$ref": "#/$defs/boolOrDate"
        },
        "eoesColumn": {
          "title": "Extended support column",
          "description": "Name of the extended support column or `false` to disable the column.",
          "type": "boolean"
        },
        "eoes": {
          "$ref": "#/$defs/boolOrDate"
        },
        "discontinuedColumn": {
          "title": "Discontinued column",
          "description": "Name of the discontinued column or `false` to disable the column.",
          "type": "boolean"
        },
        "discontinued": {
          "title": "Discontinued",
          "description": "Whether this cycle is now discontinued.",
          "$ref": "#/$defs/boolOrDate"
        },
        "releaseDateColumn": {
          "title": "Release date column",
          "description": "Name of the release date column or `false` to disable the column.",
          "type": "boolean"
        },
        "releaseDate": {
          "title": "Release date",
          "description": "Release Date for the first release in this cycle.",
          "$ref": "#/$defs/boolOrDate"
        },
        "releaseColumn": {
          "title": "Release column",
          "description": "Name of the release column or `false` to disable the column.",
          "type": "boolean"
        },
        "latest": {
          "title": "Latest release",
          "description": "The latest release in this cycle.",
          "type": "string"
        },
        "latestReleaseDate": {
          "title": "Latest release date",
          "description": "The date of the latest release.",
          "type": "string",
          "format": "date-time"
        }
      },
      "allOf": [
        {
          "if": {
            "properties": {
              "eolColumn": {
                "type": "string"
              }
            },
            "required": [
              "eolColumn"
            ]
          },
          "then": {
            "required": [
              "eol"
            ]
          }
        },
        {
          "if": {
            "properties": {
              "eoasColumn": {
                "type": "string"
              }
            },
            "required": [
              "eoasColumn"
            ]
          },
          "then": {
            "required": [
              "eoas"
            ]
          }
        },
        {
          "if": {
            "properties": {
              "eoesColumn": {
                "type": "string"
              }
            },
            "required": [
              "eoesColumn"
            ]
          },
          "then": {
            "required": [
              "eoes"
            ]
          }
        },
        {
          "if": {
            "properties": {
              "discontinuedColumn": {
                "type": "string"
              }
            },
            "required": [
              "discontinuedColumn"
            ]
          },
          "then": {
            "required": [
              "discontinued"
            ]
          }
        },
        {
          "if": {
            "properties": {
              "releaseDateColumn": {
                "type": "string"
              }
            },
            "required": [
              "releaseDateColumn"
            ]
          },
          "then": {
            "required": [
              "releaseDate"
            ]
          }
        },
        {
          "if": {
            "properties": {
              "releaseColumn": {
                "type": "string"
              }
            },
            "required": [
              "releaseColumn"
            ]
          },
          "then": {
            "required": [
              "latest"
            ]
          }
        }
      ],
      "required": [
        "releaseCycle"
      ]
    }
  }
}