Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ There are two types of snapshots:
| Hyper-V | VM | <https://docs.microsoft.com/windows-server/virtualization/hyper-v/manage/enable-or-disable-checkpoints-in-hyper-v>
| Google Compute Engine | Disk | <https://cloud.google.com/compute/docs/disks/create-snapshots>
| VMware | VM | <https://pubs.vmware.com/vsphere-50/topic/com.vmware.wssdk.pg.doc_50/PG_Ch11_VM_Manage.13.3.html>
| XenServer | VM | <https://support.citrix.com/article/CTX122978>
| XenServer | VM | <https://docs.citrix.com/en-us/xencenter/current-release/vms-snapshots.html>

### Upgrading with a hotpatch

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ updates:

{% data reusables.dependabot.default-dependencies-allow-ignore %}

Use the `allow` option to customize which dependencies are updated. This has no impact on security updates for vulnerable dependencies. You can use the following options:
Use the `allow` option to customize which dependencies are updated. This applies to both version and security updates. You can use the following options:

- `dependency-name`—use to allow updates for dependencies with matching names, optionally using `*` to match zero or more characters. For Java dependencies, the format of the `dependency-name` attribute is: `groupId:artifactId`, for example: `org.kohsuke:github-api`.
- `dependency-type`—use to allow updates for dependencies of specific types.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,9 @@ _Search_
{% if currentVersion == "free-pro-team@latest" %}
- [`DELETE /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-a-repository) (:write)
{% endif %}
{% if currentVersion == "free-pro-team@latest" %}
- [`GET /repos/:owner/:repo/pages/health`](/rest/reference/repos#get-a-dns-health-check-for-github-pages) (:write)
{% endif %}
- [`PUT /repos/:owner/:repo/topics`](/rest/reference/repos#replace-all-repository-topics) (:write)
- [`POST /repos/:owner/:repo/transfer`](/rest/reference/repos#transfer-a-repository) (:write)
{% if currentVersion == "free-pro-team@latest" %}
Expand Down Expand Up @@ -678,6 +681,9 @@ _Teams_
- [`POST /repos/:owner/:repo/pages/builds`](/rest/reference/repos#request-a-github-pages-build) (:write)
- [`GET /repos/:owner/:repo/pages/builds/:build_id`](/rest/reference/repos#get-github-pages-build) (:read)
- [`GET /repos/:owner/:repo/pages/builds/latest`](/rest/reference/repos#get-latest-pages-build) (:read)
{% if currentVersion == "free-pro-team@latest" %}
- [`GET /repos/:owner/:repo/pages/health`](/rest/reference/repos#get-a-dns-health-check-for-github-pages) (:write)
{% endif %}

### Permission on "pull requests"

Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ services:
build:
context: .
dockerfile: Dockerfile.openapi_decorator
image: 'openapi_decorator:${BUILD_SHA}'
image: 'openapi_decorator'
89 changes: 89 additions & 0 deletions lib/rest/static/decorated/api.github.com.json
Original file line number Diff line number Diff line change
Expand Up @@ -66563,6 +66563,95 @@
}
]
},
{
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/pages/health",
"serverUrl": "https://api.github.com",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/health",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/pages/health</code></pre>"
},
{
"lang": "JavaScript",
"source": "await octokit.request('GET /repos/{owner}/{repo}/pages/health', {\n owner: 'octocat',\n repo: 'hello-world'\n})",
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'GET /repos/{owner}/{repo}/pages/health'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>\n})\n</code></pre>"
}
],
"summary": "Get a DNS health check for GitHub Pages",
"description": "Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages.\n\nThe first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response.\n\nUsers must have admin or owner permissions. GitHub Apps must have the `pages:write` and `administration:write` permission to use this endpoint.",
"tags": [
"repos"
],
"operationId": "repos/get-pages-health-check",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/repos#get-a-dns-health-check-for-github-pages"
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "pages"
},
"slug": "get-a-dns-health-check-for-github-pages",
"category": "repos",
"categoryLabel": "Repos",
"subcategory": "pages",
"subcategoryLabel": "Pages",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Gets a health check of the DNS settings for the <code>CNAME</code> record configured for a repository's GitHub Pages.</p>\n<p>The first request to this endpoint returns a <code>202 Accepted</code> status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a <code>200 OK</code> status with the health check results in the response.</p>\n<p>Users must have admin or owner permissions. GitHub Apps must have the <code>pages:write</code> and <code>administration:write</code> permission to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
"httpStatusMessage": "OK",
"description": "Response",
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"domain\"</span>: {\n <span class=\"hljs-attr\">\"host\"</span>: <span class=\"hljs-string\">\"example.com\"</span>,\n <span class=\"hljs-attr\">\"uri\"</span>: <span class=\"hljs-string\">\"http://example.com/\"</span>,\n <span class=\"hljs-attr\">\"nameservers\"</span>: <span class=\"hljs-string\">\"default\"</span>,\n <span class=\"hljs-attr\">\"dns_resolves\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_proxied\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_cloudflare_ip\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_fastly_ip\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_old_ip_address\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_a_record\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"has_cname_record\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"has_mx_records_present\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_valid_domain\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_apex_domain\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"should_be_a_record\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_cname_to_github_user_domain\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_cname_to_pages_dot_github_dot_com\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_cname_to_fastly\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_pointed_to_github_pages_ip\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_non_github_pages_ip_present\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_pages_domain\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_served_by_pages\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_valid\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"reason\"</span>: <span class=\"hljs-literal\">null</span>,\n <span class=\"hljs-attr\">\"responds_to_https\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"enforces_https\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"https_error\"</span>: <span class=\"hljs-literal\">null</span>,\n <span class=\"hljs-attr\">\"is_https_eligible\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"caa_error\"</span>: <span class=\"hljs-literal\">null</span>\n },\n <span class=\"hljs-attr\">\"alt_domain\"</span>: {\n <span class=\"hljs-attr\">\"host\"</span>: <span class=\"hljs-string\">\"www.example.com\"</span>,\n <span class=\"hljs-attr\">\"uri\"</span>: <span class=\"hljs-string\">\"http://www.example.com/\"</span>,\n <span class=\"hljs-attr\">\"nameservers\"</span>: <span class=\"hljs-string\">\"default\"</span>,\n <span class=\"hljs-attr\">\"dns_resolves\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_proxied\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_cloudflare_ip\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_fastly_ip\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_old_ip_address\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_a_record\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"has_cname_record\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"has_mx_records_present\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_valid_domain\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_apex_domain\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"should_be_a_record\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_cname_to_github_user_domain\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_cname_to_pages_dot_github_dot_com\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_cname_to_fastly\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_pointed_to_github_pages_ip\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_non_github_pages_ip_present\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_pages_domain\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"is_served_by_pages\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"is_valid\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"reason\"</span>: <span class=\"hljs-literal\">null</span>,\n <span class=\"hljs-attr\">\"responds_to_https\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"enforces_https\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"https_error\"</span>: <span class=\"hljs-literal\">null</span>,\n <span class=\"hljs-attr\">\"is_https_eligible\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"caa_error\"</span>: <span class=\"hljs-literal\">null</span>\n }\n}\n</code></pre>"
},
{
"httpStatusCode": "202",
"httpStatusMessage": "Accepted",
"description": "Empty response"
},
{
"httpStatusCode": "400",
"httpStatusMessage": "Bad Request",
"description": "Custom domains are not available for GitHub Pages"
},
{
"httpStatusCode": "404",
"httpStatusMessage": "Not Found",
"description": "Resource not found"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
"description": "There isn't a CNAME for this page"
}
]
},
{
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/projects",
Expand Down
Loading