Skip to content

Commit

Permalink
Merge pull request #268 from github/openapi-update-89532ee0b634358882…
Browse files Browse the repository at this point in the history 
…099e3da92d7dddbcd70a0bd71c21bb027cba37bd82bd7d

Update OpenAPI Descriptions
  • Loading branch information
@ahoglund
ahoglund committed Apr 16, 2021
2 parents 6117e89 + ceaa372 commit cfcd615
Show file tree
Hide file tree
Showing 32 changed files with 2,934 additions and 138 deletions.
120 changes: 107 additions & 13 deletions descriptions/api.github.com/api.github.com.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24458,7 +24458,7 @@
"/repos/{owner}/{repo}/code-scanning/sarifs": {
"post": {
"summary": "Upload an analysis as SARIF data",
"description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"",
"description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"",
"operationId": "code-scanning/upload-sarif",
"tags": [
"code-scanning"
Expand Down Expand Up @@ -34808,6 +34808,10 @@
"description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).\"",
"nullable": true
},
"https_enforced": {
"type": "boolean",
"description": "Specify whether HTTPS should be enforced for the repository."
},
"public": {
"type": "boolean",
"description": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan."
Expand Down Expand Up @@ -34863,6 +34867,11 @@
"required": [
"public"
]
},
{
"required": [
"https_enforced"
]
}
]
},
Expand Down Expand Up @@ -52094,7 +52103,9 @@
"account",
"permissions",
"created_at",
"updated_at"
"updated_at",
"suspended_by",
"suspended_at"
]
},
"app-permissions": {
Expand Down Expand Up @@ -62585,6 +62596,11 @@
},
"deletable": {
"type": "boolean"
},
"warning": {
"type": "string",
"description": "Warning generated when processing the analysis",
"example": "123 results were ignored"
}
},
"required": [
Expand All @@ -62600,7 +62616,8 @@
"url",
"sarif_id",
"tool",
"deletable"
"deletable",
"warning"
]
},
"code-scanning-analysis-deletion": {
Expand Down Expand Up @@ -66095,6 +66112,51 @@
"path"
]
},
"pages-https-certificate": {
"title": "Pages Https Certificate",
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"new",
"authorization_created",
"authorization_pending",
"authorized",
"authorization_revoked",
"issued",
"uploaded",
"approved",
"errored",
"bad_authz",
"destroy_pending",
"dns_changed"
],
"example": "approved"
},
"description": {
"type": "string",
"example": "Certificate is approved"
},
"domains": {
"type": "array",
"description": "Array of the domain set and its alternate name (if it is configured)",
"example": [
"example.com",
"www.example.com"
]
},
"expires_at": {
"type": "string",
"format": "date"
}
},
"required": [
"state",
"description",
"domains"
]
},
"page": {
"title": "GitHub Pages",
"description": "The configuration for GitHub Pages for a repository.",
Expand Down Expand Up @@ -66142,6 +66204,14 @@
"type": "boolean",
"description": "Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site.",
"example": true
},
"https_certificate": {
"$ref": "#/components/schemas/pages-https-certificate"
},
"https_enforced": {
"type": "boolean",
"description": "Whether https is enabled on the domain",
"example": true
}
},
"required": [
Expand Down Expand Up @@ -71655,7 +71725,9 @@
"repository_selection": "selected",
"created_at": "2017-07-08T16:18:44-04:00",
"updated_at": "2017-07-08T16:18:44-04:00",
"app_slug": "github-actions"
"app_slug": "github-actions",
"suspended_at": null,
"suspended_by": null
}
]
},
Expand Down Expand Up @@ -71706,7 +71778,9 @@
"repository_selection": "selected",
"created_at": "2017-07-08T16:18:44-04:00",
"updated_at": "2017-07-08T16:18:44-04:00",
"app_slug": "github-actions"
"app_slug": "github-actions",
"suspended_at": null,
"suspended_by": null
}
},
"installation-token": {
Expand Down Expand Up @@ -74233,7 +74307,9 @@
"config.yml",
".github/issue_TEMPLATE.md"
],
"app_slug": "github-actions"
"app_slug": "github-actions",
"suspended_at": null,
"suspended_by": null
}
},
"installation-paginated": {
Expand Down Expand Up @@ -74287,7 +74363,9 @@
"config.yml",
".github/issue_TEMPLATE.md"
],
"app_slug": "github-actions"
"app_slug": "github-actions",
"suspended_at": null,
"suspended_by": null
}
]
}
Expand Down Expand Up @@ -80402,7 +80480,8 @@
"guid": null,
"version": "2.4.0"
},
"deletable": true
"deletable": true,
"warning": ""
},
{
"ref": "refs/heads/my-branch",
Expand All @@ -80421,7 +80500,8 @@
"guid": null,
"version": "1.2.0"
},
"deletable": true
"deletable": true,
"warning": ""
}
]
},
Expand All @@ -80444,7 +80524,8 @@
"guid": null,
"version": "2.4.0"
},
"deletable": true
"deletable": true,
"warning": ""
}
},
"code-scanning-analysis-deletion": {
Expand Down Expand Up @@ -84636,7 +84717,16 @@
"branch": "master",
"path": "/"
},
"public": true
"public": true,
"https_certificate": {
"state": "approved",
"description": "Certificate is approved",
"domains": [
"developer.github.com"
],
"expires_at": "2021-05-22"
},
"https_enforced": true
}
},
"page-build-items": {
Expand Down Expand Up @@ -89300,7 +89390,9 @@
"repository_selection": "all",
"created_at": "2017-07-08T16:18:44-04:00",
"updated_at": "2017-07-08T16:18:44-04:00",
"app_slug": "github-actions"
"app_slug": "github-actions",
"suspended_at": null,
"suspended_by": null
},
{
"id": 3,
Expand Down Expand Up @@ -89348,7 +89440,9 @@
"repository_selection": "all",
"created_at": "2017-07-08T16:18:44-04:00",
"updated_at": "2017-07-08T16:18:44-04:00",
"app_slug": "github-actions"
"app_slug": "github-actions",
"suspended_at": null,
"suspended_by": null
}
]
}
Expand Down
Loading

0 comments on commit cfcd615

Please sign in to comment.