@itentialopensource/adapter-github/entities/SecurityAdvisories/schema.json

This adapter integrates with system described as: github.

{
  "$id": "schema.json",
  "type": "object",
  "schema": "http://json-schema.org/draft-07/schema#",
  "translate": true,
  "dynamicfields": true,
  "properties": {
    "ph_request_type": {
      "type": "string",
      "description": "type of request (internal to adapter)",
      "default": "securityAdvisoriesListGlobalAdvisories",
      "enum": [
        "securityAdvisoriesListGlobalAdvisories",
        "securityAdvisoriesGetGlobalAdvisory",
        "securityAdvisoriesListOrgRepositoryAdvisories",
        "securityAdvisoriesListRepositoryAdvisories",
        "securityAdvisoriesCreateRepositoryAdvisory",
        "securityAdvisoriesCreatePrivateVulnerabilityReport",
        "securityAdvisoriesGetRepositoryAdvisory",
        "securityAdvisoriesUpdateRepositoryAdvisory",
        "securityAdvisoriesCreateRepositoryAdvisoryCveRequest",
        "securityAdvisoriesCreateFork"
      ],
      "external_name": "ph_request_type"
    },
    "ghsaId": {
      "type": "string",
      "description": "The GHSA (GitHub Security Advisory) identifier of the advisory.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "ghsa_id"
    },
    "cveId": {
      "type": "string",
      "description": "If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "cve_id"
    },
    "isWithdrawn": {
      "type": "boolean",
      "description": "Whether to only return advisories that have been withdrawn.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "is_withdrawn"
    },
    "epssPercentage": {
      "type": "string",
      "description": "If specified, only return advisories that have an EPSS percentage score that matches the provided value.\nThe EPSS percentage represents the likelihood of a CVE being expl...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "epss_percentage"
    },
    "epssPercentile": {
      "type": "string",
      "description": "If specified, only return advisories that have an EPSS percentile score that matches the provided value.\nThe EPSS percentile represents the relative rank of the CVE's lik...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "epss_percentile"
    },
    "perPage": {
      "type": "number",
      "description": "The number of advisories to return per page. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-paginatio...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "per_page"
    }
  },
  "definitions": {}
}