nsconfig.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/nowsecure/nowsecure-action/main/nsconfig.schema.json",
  "title": "NowSecure GitHub action configuration",
  "allOf": [{ "$ref": "#/$defs/filterbase" }],
  "properties": {
    "filters": {
      "type": "object",
      "additionalProperties": { "$ref": "#/$defs/filter" }
    },
    "configs": {
      "type": "object",
      "additionalProperties": { "$ref": "#/$defs/config" }
    },
    "key": { "$ref": "#/$defs/keyparams" },
    "labels": { "$ref": "#/$defs/labels" },
    "summary": { "$ref": "#/$defs/summary" }
  },
  "unevaluatedProperties": false,
  "$defs": {
    "filterbase": {
      "type": "object",
      "properties": {
        "minimum-severity": { "$ref": "#/$defs/severity" },
        "include-warnings": { "type": "boolean" },
        "exclude-checks": { "$ref": "#/$defs/checklist" },
        "include-checks": { "$ref": "#/$defs/checklist" }
      }
    },
    "filter": {
      "allOf": [{ "$ref": "#/$defs/filterbase" }],
      "unevaluatedProperties": false
    },
    "filterorstring": {
      "anyOf": [{ "$ref": "#/$defs/filter" }, { "type": "string" }]
    },
    "config": {
      "type": "object",
      "properties": {
        "filter": { "$ref": "#/$defs/filterorstring" },
        "key": { "$ref": "#/$defs/keyparams" },
        "labels": { "$ref": "#/$defs/labels" },
        "summary": { "$ref": "#/$defs/summary" }
      },
      "unevaluatedProperties": false
    },
    "severity": {
      "type": "string",
      "enum": ["critical", "high", "medium", "low", "info"]
    },
    "summary": {
      "type": "string",
      "enum": ["none", "short", "long"]
    },
    "checklist": {
      "type": "array",
      "items": { "type": "string" }
    },
    "keyparams": {
      "type": "object",
      "properties": {
        "package": { "type": "boolean" },
        "platform": { "type": "boolean" },
        "v1-key": { "type": "string" }
      },
      "additionalProperties": false
    },
    "labellistorstring": {
      "anyOf": [
        { "type": "array", "items": { "type": "string" } },
        { "type": "string" }
      ]
    },
    "labelmapping": {
      "type": "object",
      "properties": {
        "always": { "$ref": "#/$defs/labellistorstring" },
        "info": { "$ref": "#/$defs/labellistorstring" },
        "warning": { "$ref": "#/$defs/labellistorstring" },
        "low": { "$ref": "#/$defs/labellistorstring" },
        "medium": { "$ref": "#/$defs/labellistorstring" },
        "high": { "$ref": "#/$defs/labellistorstring" },
        "critical": { "$ref": "#/$defs/labellistorstring" },
        "category-labels": { "type": "boolean" }
      },
      "unevaluatedProperties": false
    },
    "labels": {
      "anyOf": [
        { "$ref": "#/$defs/labellistorstring" },
        { "$ref": "#/$defs/labelmapping" }
      ]
    }
  }
}