@itentialopensource/adapter-github/entities/CodeScanning/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": "codeScanningListAlertsForOrg",
      "enum": [
        "codeScanningListAlertsForOrg",
        "codeScanningListAlertsForRepo",
        "codeScanningGetAlert",
        "codeScanningUpdateAlert",
        "codeScanningListAlertInstances",
        "codeScanningListRecentAnalyses",
        "codeScanningGetAnalysis",
        "codeScanningDeleteAnalysis",
        "codeScanningListCodeqlDatabases",
        "codeScanningGetCodeqlDatabase",
        "codeScanningCreateVariantAnalysis",
        "codeScanningGetVariantAnalysis",
        "codeScanningGetVariantAnalysisRepoTask",
        "codeScanningGetDefaultSetup",
        "codeScanningUpdateDefaultSetup",
        "codeScanningUploadSarif",
        "codeScanningGetSarif"
      ],
      "external_name": "ph_request_type"
    },
    "toolName": {
      "type": "string",
      "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "tool_name"
    },
    "toolGuid": {
      "type": "string",
      "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can spec...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "tool_guid"
    },
    "perPage": {
      "type": "number",
      "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-i...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "per_page"
    },
    "alertNumber": {
      "type": "number",
      "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "alert_number"
    },
    "sarifId": {
      "type": "string",
      "description": "The SARIF ID obtained after uploading.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "sarif_id"
    },
    "analysisId": {
      "type": "number",
      "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "analysis_id"
    },
    "confirmDelete": {
      "type": "string",
      "description": "Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "confirm_delete"
    },
    "codeqlVariantAnalysisId": {
      "type": "number",
      "description": "The ID of the variant analysis.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "codeql_variant_analysis_id"
    },
    "repoOwner": {
      "type": "string",
      "description": "The account owner of the variant analysis repository. The name is not case sensitive.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "repo_owner"
    },
    "repoName": {
      "type": "string",
      "description": "The name of the variant analysis repository.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "repo_name"
    }
  },
  "definitions": {}
}