gitabu 0.1.0

data/lib/gitabu/public/api/v3/code_scanning.json

@@ -0,0 +1,666 @@
+{
+  "result": [
+    {
+      "namespace_description": "List code scanning alerts for an organization",
+      "method": "get",
+      "endpoint": "/orgs/{org}/code-scanning/alerts",
+      "field_0": {
+        "field_type": "header",
+        "fields": {
+          "name": "accept",
+          "type": "string",
+          "in": "header",
+          "description": "Setting toapplication/vnd.github.v3+json is recommended."
+        }
+      },
+      "field_1": {
+        "field_type": "path",
+        "fields": {
+          "name": "org",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_2": {
+        "field_type": "query",
+        "fields": {
+          "name": "before",
+          "type": "string",
+          "in": "query",
+          "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor."
+        }
+      },
+      "field_3": {
+        "field_type": "query",
+        "fields": {
+          "name": "after",
+          "type": "string",
+          "in": "query",
+          "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor."
+        }
+      },
+      "field_4": {
+        "field_type": "query",
+        "fields": {
+          "name": "page",
+          "type": "integer",
+          "in": "query",
+          "description": "Page number of the results to fetch.Default: 1"
+        }
+      },
+      "field_5": {
+        "field_type": "query",
+        "fields": {
+          "name": "per_page",
+          "type": "integer",
+          "in": "query",
+          "description": "Results per page (max 100)Default: 30"
+        }
+      },
+      "field_6": {
+        "field_type": "query",
+        "fields": {
+          "name": "direction",
+          "type": "string",
+          "in": "query",
+          "description": "One of asc (ascending) or desc (descending).Default: desc"
+        }
+      },
+      "field_7": {
+        "field_type": "query",
+        "fields": {
+          "name": "state",
+          "type": "string",
+          "in": "query",
+          "description": "Set to open, closed, fixed, or dismissed` to list code scanning alerts in a specific state."
+        }
+      },
+      "field_8": {
+        "field_type": "query",
+        "fields": {
+          "name": "sort",
+          "type": "string",
+          "in": "query",
+          "description": "Can be one of created, updated.Default: created"
+        }
+      }
+    },
+    {
+      "namespace_description": "List code scanning alerts for a repository",
+      "method": "get",
+      "endpoint": "/repos/{owner}/{repo}/code-scanning/alerts",
+      "field_0": {
+        "field_type": "header",
+        "fields": {
+          "name": "accept",
+          "type": "string",
+          "in": "header",
+          "description": "Setting toapplication/vnd.github.v3+json is recommended."
+        }
+      },
+      "field_1": {
+        "field_type": "path",
+        "fields": {
+          "name": "owner",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_2": {
+        "field_type": "path",
+        "fields": {
+          "name": "repo",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_3": {
+        "field_type": "query",
+        "fields": {
+          "name": "tool_name",
+          "type": "string",
+          "in": "query",
+          "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."
+        }
+      },
+      "field_4": {
+        "field_type": "query",
+        "fields": {
+          "name": "tool_guid",
+          "type": "stringnull",
+          "in": "query",
+          "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 specify the tool by using either tool_guid or tool_name, but not both."
+        }
+      },
+      "field_5": {
+        "field_type": "query",
+        "fields": {
+          "name": "page",
+          "type": "integer",
+          "in": "query",
+          "description": "Page number of the results to fetch.Default: 1"
+        }
+      },
+      "field_6": {
+        "field_type": "query",
+        "fields": {
+          "name": "per_page",
+          "type": "integer",
+          "in": "query",
+          "description": "Results per page (max 100)Default: 30"
+        }
+      },
+      "field_7": {
+        "field_type": "query",
+        "fields": {
+          "name": "ref",
+          "type": "string",
+          "in": "query",
+          "description": "The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge."
+        }
+      },
+      "field_8": {
+        "field_type": "query",
+        "fields": {
+          "name": "direction",
+          "type": "string",
+          "in": "query",
+          "description": "One of asc (ascending) or desc (descending).Default: desc"
+        }
+      },
+      "field_9": {
+        "field_type": "query",
+        "fields": {
+          "name": "sort",
+          "type": "string",
+          "in": "query",
+          "description": "Can be one of created, updated, number.Default: number"
+        }
+      },
+      "field_10": {
+        "field_type": "query",
+        "fields": {
+          "name": "state",
+          "type": "string",
+          "in": "query",
+          "description": "Set to open, closed, fixed, or dismissed` to list code scanning alerts in a specific state."
+        }
+      }
+    },
+    {
+      "namespace_description": "Get a code scanning alert",
+      "method": "get",
+      "endpoint": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}",
+      "field_0": {
+        "field_type": "header",
+        "fields": {
+          "name": "accept",
+          "type": "string",
+          "in": "header",
+          "description": "Setting toapplication/vnd.github.v3+json is recommended."
+        }
+      },
+      "field_1": {
+        "field_type": "path",
+        "fields": {
+          "name": "owner",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_2": {
+        "field_type": "path",
+        "fields": {
+          "name": "repo",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_3": {
+        "field_type": "path",
+        "fields": {
+          "name": "alert_number",
+          "type": "integer",
+          "in": "path",
+          "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 GET /repos/{owner}/{repo}/code-scanning/alerts operation."
+        }
+      }
+    },
+    {
+      "namespace_description": "Update a code scanning alert",
+      "method": "patch",
+      "endpoint": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}",
+      "field_0": {
+        "field_type": "header",
+        "fields": {
+          "name": "accept",
+          "type": "string",
+          "in": "header",
+          "description": "Setting toapplication/vnd.github.v3+json is recommended."
+        }
+      },
+      "field_1": {
+        "field_type": "path",
+        "fields": {
+          "name": "owner",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_2": {
+        "field_type": "path",
+        "fields": {
+          "name": "repo",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_3": {
+        "field_type": "path",
+        "fields": {
+          "name": "alert_number",
+          "type": "integer",
+          "in": "path",
+          "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 GET /repos/{owner}/{repo}/code-scanning/alerts operation."
+        }
+      },
+      "field_4": {
+        "field_type": "body",
+        "fields": {
+          "name": "state",
+          "type": "string",
+          "in": "body",
+          "description": "Required. Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed."
+        }
+      },
+      "field_5": {
+        "field_type": "body",
+        "fields": {
+          "name": "dismissed_reason",
+          "type": "string or null",
+          "in": "body",
+          "description": "Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests."
+        }
+      }
+    },
+    {
+      "namespace_description": "List instances of a code scanning alert",
+      "method": "get",
+      "endpoint": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances",
+      "field_0": {
+        "field_type": "header",
+        "fields": {
+          "name": "accept",
+          "type": "string",
+          "in": "header",
+          "description": "Setting toapplication/vnd.github.v3+json is recommended."
+        }
+      },
+      "field_1": {
+        "field_type": "path",
+        "fields": {
+          "name": "owner",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_2": {
+        "field_type": "path",
+        "fields": {
+          "name": "repo",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_3": {
+        "field_type": "path",
+        "fields": {
+          "name": "alert_number",
+          "type": "integer",
+          "in": "path",
+          "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 GET /repos/{owner}/{repo}/code-scanning/alerts operation."
+        }
+      },
+      "field_4": {
+        "field_type": "query",
+        "fields": {
+          "name": "page",
+          "type": "integer",
+          "in": "query",
+          "description": "Page number of the results to fetch.Default: 1"
+        }
+      },
+      "field_5": {
+        "field_type": "query",
+        "fields": {
+          "name": "per_page",
+          "type": "integer",
+          "in": "query",
+          "description": "Results per page (max 100)Default: 30"
+        }
+      },
+      "field_6": {
+        "field_type": "query",
+        "fields": {
+          "name": "ref",
+          "type": "string",
+          "in": "query",
+          "description": "The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge."
+        }
+      }
+    },
+    {
+      "namespace_description": "List code scanning analyses for a repository",
+      "method": "get",
+      "endpoint": "/repos/{owner}/{repo}/code-scanning/analyses",
+      "field_0": {
+        "field_type": "header",
+        "fields": {
+          "name": "accept",
+          "type": "string",
+          "in": "header",
+          "description": "Setting toapplication/vnd.github.v3+json is recommended."
+        }
+      },
+      "field_1": {
+        "field_type": "path",
+        "fields": {
+          "name": "owner",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_2": {
+        "field_type": "path",
+        "fields": {
+          "name": "repo",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_3": {
+        "field_type": "query",
+        "fields": {
+          "name": "tool_name",
+          "type": "string",
+          "in": "query",
+          "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."
+        }
+      },
+      "field_4": {
+        "field_type": "query",
+        "fields": {
+          "name": "tool_guid",
+          "type": "stringnull",
+          "in": "query",
+          "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 specify the tool by using either tool_guid or tool_name, but not both."
+        }
+      },
+      "field_5": {
+        "field_type": "query",
+        "fields": {
+          "name": "page",
+          "type": "integer",
+          "in": "query",
+          "description": "Page number of the results to fetch.Default: 1"
+        }
+      },
+      "field_6": {
+        "field_type": "query",
+        "fields": {
+          "name": "per_page",
+          "type": "integer",
+          "in": "query",
+          "description": "Results per page (max 100)Default: 30"
+        }
+      },
+      "field_7": {
+        "field_type": "query",
+        "fields": {
+          "name": "ref",
+          "type": "string",
+          "in": "query",
+          "description": "The Git reference for the analyses you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge."
+        }
+      },
+      "field_8": {
+        "field_type": "query",
+        "fields": {
+          "name": "sarif_id",
+          "type": "string",
+          "in": "query",
+          "description": "Filter analyses belonging to the same SARIF upload."
+        }
+      }
+    },
+    {
+      "namespace_description": "Get a code scanning analysis for a repository",
+      "method": "get",
+      "endpoint": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}",
+      "field_0": {
+        "field_type": "header",
+        "fields": {
+          "name": "accept",
+          "type": "string",
+          "in": "header",
+          "description": "Setting toapplication/vnd.github.v3+json is recommended."
+        }
+      },
+      "field_1": {
+        "field_type": "path",
+        "fields": {
+          "name": "owner",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_2": {
+        "field_type": "path",
+        "fields": {
+          "name": "repo",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_3": {
+        "field_type": "path",
+        "fields": {
+          "name": "analysis_id",
+          "type": "integer",
+          "in": "path",
+          "description": "The ID of the analysis, as returned from the GET /repos/{owner}/{repo}/code-scanning/analyses operation."
+        }
+      }
+    },
+    {
+      "namespace_description": "Delete a code scanning analysis from a repository",
+      "method": "delete",
+      "endpoint": "\"deletable\": true\n",
+      "field_0": {
+        "field_type": "header",
+        "fields": {
+          "name": "accept",
+          "type": "string",
+          "in": "header",
+          "description": "Setting toapplication/vnd.github.v3+json is recommended."
+        }
+      },
+      "field_1": {
+        "field_type": "path",
+        "fields": {
+          "name": "owner",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_2": {
+        "field_type": "path",
+        "fields": {
+          "name": "repo",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_3": {
+        "field_type": "path",
+        "fields": {
+          "name": "analysis_id",
+          "type": "integer",
+          "in": "path",
+          "description": "The ID of the analysis, as returned from the GET /repos/{owner}/{repo}/code-scanning/analyses operation."
+        }
+      },
+      "field_4": {
+        "field_type": "query",
+        "fields": {
+          "name": "confirm_delete",
+          "type": "stringnull",
+          "in": "query",
+          "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 400 response with the message: Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete."
+        }
+      }
+    },
+    {
+      "namespace_description": "Upload an analysis as SARIF data",
+      "method": "post",
+      "endpoint": "gzip -c analysis-data.sarif | base64 -w0\n",
+      "field_0": {
+        "field_type": "header",
+        "fields": {
+          "name": "accept",
+          "type": "string",
+          "in": "header",
+          "description": "Setting toapplication/vnd.github.v3+json is recommended."
+        }
+      },
+      "field_1": {
+        "field_type": "path",
+        "fields": {
+          "name": "owner",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_2": {
+        "field_type": "path",
+        "fields": {
+          "name": "repo",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_3": {
+        "field_type": "body",
+        "fields": {
+          "name": "commit_sha",
+          "type": "string",
+          "in": "body",
+          "description": "Required. The SHA of the commit to which the analysis you are uploading relates."
+        }
+      },
+      "field_4": {
+        "field_type": "body",
+        "fields": {
+          "name": "ref",
+          "type": "string",
+          "in": "body",
+          "description": "Required. The full Git reference, formatted as refs/heads/<branch name>,\nrefs/pull/<number>/merge, or refs/pull/<number>/head."
+        }
+      },
+      "field_5": {
+        "field_type": "body",
+        "fields": {
+          "name": "sarif",
+          "type": "string",
+          "in": "body",
+          "description": "Required. A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\""
+        }
+      },
+      "field_6": {
+        "field_type": "body",
+        "fields": {
+          "name": "checkout_uri",
+          "type": "string",
+          "in": "body",
+          "description": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository."
+        }
+      },
+      "field_7": {
+        "field_type": "body",
+        "fields": {
+          "name": "started_at",
+          "type": "string",
+          "in": "body",
+          "description": "The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ."
+        }
+      },
+      "field_8": {
+        "field_type": "body",
+        "fields": {
+          "name": "tool_name",
+          "type": "string",
+          "in": "body",
+          "description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts."
+        }
+      }
+    },
+    {
+      "namespace_description": "Get information about a SARIF upload",
+      "method": "get",
+      "endpoint": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}",
+      "field_0": {
+        "field_type": "header",
+        "fields": {
+          "name": "accept",
+          "type": "string",
+          "in": "header",
+          "description": "Setting toapplication/vnd.github.v3+json is recommended."
+        }
+      },
+      "field_1": {
+        "field_type": "path",
+        "fields": {
+          "name": "owner",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_2": {
+        "field_type": "path",
+        "fields": {
+          "name": "repo",
+          "type": "string",
+          "in": "path",
+          "description": ""
+        }
+      },
+      "field_3": {
+        "field_type": "path",
+        "fields": {
+          "name": "sarif_id",
+          "type": "string",
+          "in": "path",
+          "description": "The SARIF ID obtained after uploading."
+        }
+      }
+    }
+  ]
+}