From d1bdef8191bf638faf068ce61031cd426460dd82 Mon Sep 17 00:00:00 2001 From: Octokit Bot <33075676+octokitbot@users.noreply.github.com> Date: Tue, 27 Apr 2021 11:33:33 -0700 Subject: [PATCH] feat: `GET /repos/{owner}/{repo}/pages/health` (#71) --- cache/api.github.com.deref.json | 381 ++++++++++++++++++++++++++++ cache/api.github.com.json | 353 ++++++++++++++++++++++++++ cache/ghes-2.22.deref.json | 6 + cache/ghes-2.22.json | 9 + cache/ghes-3.0.deref.json | 6 + cache/ghes-3.0.json | 9 + cache/github.ae.deref.json | 11 + cache/github.ae.json | 10 + generated/api.github.com.deref.json | 288 +++++++++++++++++++++ generated/api.github.com.json | 216 ++++++++++++++++ generated/ghes-2.22.deref.json | 6 + generated/ghes-2.22.json | 9 + generated/ghes-3.0.deref.json | 6 + generated/ghes-3.0.json | 9 + generated/github.ae.deref.json | 11 + generated/github.ae.json | 10 + 16 files changed, 1340 insertions(+) diff --git a/cache/api.github.com.deref.json b/cache/api.github.com.deref.json index 4f6ddc9c9..c8e17ff4d 100644 --- a/cache/api.github.com.deref.json +++ b/cache/api.github.com.deref.json @@ -164295,6 +164295,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -164386,6 +164390,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -164406,6 +164411,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, @@ -164581,6 +164587,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -164671,6 +164681,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"javascript\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", "created_at": "2021-01-13T11:55:49Z", "results_count": 3, "rules_count": 67, @@ -253283,6 +253294,376 @@ } } }, + "/repos/{owner}/{repo}/pages/health": { + "get": { + "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" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Pages Health Check Status", + "description": "Pages Health Check Status", + "type": "object", + "properties": { + "domain": { + "type": "object", + "properties": { + "host": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "nameservers": { + "type": "string" + }, + "dns_resolves": { + "type": "boolean" + }, + "is_proxied": { + "type": "boolean", + "nullable": true + }, + "is_cloudflare_ip": { + "type": "boolean", + "nullable": true + }, + "is_fastly_ip": { + "type": "boolean", + "nullable": true + }, + "is_old_ip_address": { + "type": "boolean", + "nullable": true + }, + "is_a_record": { + "type": "boolean", + "nullable": true + }, + "has_cname_record": { + "type": "boolean", + "nullable": true + }, + "has_mx_records_present": { + "type": "boolean", + "nullable": true + }, + "is_valid_domain": { + "type": "boolean" + }, + "is_apex_domain": { + "type": "boolean" + }, + "should_be_a_record": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_github_user_domain": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_pages_dot_github_dot_com": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_fastly": { + "type": "boolean", + "nullable": true + }, + "is_pointed_to_github_pages_ip": { + "type": "boolean", + "nullable": true + }, + "is_non_github_pages_ip_present": { + "type": "boolean", + "nullable": true + }, + "is_pages_domain": { + "type": "boolean" + }, + "is_served_by_pages": { + "type": "boolean", + "nullable": true + }, + "is_valid": { + "type": "boolean" + }, + "reason": { + "type": "string", + "nullable": true + }, + "responds_to_https": { + "type": "boolean" + }, + "enforces_https": { + "type": "boolean" + }, + "https_error": { + "type": "string", + "nullable": true + }, + "is_https_eligible": { + "type": "boolean", + "nullable": true + }, + "caa_error": { + "type": "string", + "nullable": true + } + } + }, + "alt_domain": { + "type": "object", + "nullable": true, + "properties": { + "host": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "nameservers": { + "type": "string" + }, + "dns_resolves": { + "type": "boolean" + }, + "is_proxied": { + "type": "boolean", + "nullable": true + }, + "is_cloudflare_ip": { + "type": "boolean", + "nullable": true + }, + "is_fastly_ip": { + "type": "boolean", + "nullable": true + }, + "is_old_ip_address": { + "type": "boolean", + "nullable": true + }, + "is_a_record": { + "type": "boolean", + "nullable": true + }, + "has_cname_record": { + "type": "boolean", + "nullable": true + }, + "has_mx_records_present": { + "type": "boolean", + "nullable": true + }, + "is_valid_domain": { + "type": "boolean" + }, + "is_apex_domain": { + "type": "boolean" + }, + "should_be_a_record": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_github_user_domain": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_pages_dot_github_dot_com": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_fastly": { + "type": "boolean", + "nullable": true + }, + "is_pointed_to_github_pages_ip": { + "type": "boolean", + "nullable": true + }, + "is_non_github_pages_ip_present": { + "type": "boolean", + "nullable": true + }, + "is_pages_domain": { + "type": "boolean" + }, + "is_served_by_pages": { + "type": "boolean", + "nullable": true + }, + "is_valid": { + "type": "boolean" + }, + "reason": { + "type": "string", + "nullable": true + }, + "responds_to_https": { + "type": "boolean" + }, + "enforces_https": { + "type": "boolean" + }, + "https_error": { + "type": "string", + "nullable": true + }, + "is_https_eligible": { + "type": "boolean", + "nullable": true + }, + "caa_error": { + "type": "string", + "nullable": true + } + } + } + } + }, + "examples": { + "default": { + "value": { + "domain": { + "host": "example.com", + "uri": "http://example.com/", + "nameservers": "default", + "dns_resolves": true, + "is_proxied": false, + "is_cloudflare_ip": false, + "is_fastly_ip": false, + "is_old_ip_address": false, + "is_a_record": true, + "has_cname_record": false, + "has_mx_records_present": false, + "is_valid_domain": true, + "is_apex_domain": true, + "should_be_a_record": true, + "is_cname_to_github_user_domain": false, + "is_cname_to_pages_dot_github_dot_com": false, + "is_cname_to_fastly": false, + "is_pointed_to_github_pages_ip": true, + "is_non_github_pages_ip_present": false, + "is_pages_domain": false, + "is_served_by_pages": true, + "is_valid": true, + "reason": null, + "responds_to_https": true, + "enforces_https": true, + "https_error": null, + "is_https_eligible": true, + "caa_error": null + }, + "alt_domain": { + "host": "www.example.com", + "uri": "http://www.example.com/", + "nameservers": "default", + "dns_resolves": true, + "is_proxied": false, + "is_cloudflare_ip": false, + "is_fastly_ip": false, + "is_old_ip_address": false, + "is_a_record": true, + "has_cname_record": false, + "has_mx_records_present": false, + "is_valid_domain": true, + "is_apex_domain": true, + "should_be_a_record": true, + "is_cname_to_github_user_domain": false, + "is_cname_to_pages_dot_github_dot_com": false, + "is_cname_to_fastly": false, + "is_pointed_to_github_pages_ip": true, + "is_non_github_pages_ip_present": false, + "is_pages_domain": false, + "is_served_by_pages": true, + "is_valid": true, + "reason": null, + "responds_to_https": true, + "enforces_https": true, + "https_error": null, + "is_https_eligible": true, + "caa_error": null + } + } + } + } + } + } + }, + "202": { + "description": "Empty response" + }, + "400": { + "description": "Custom domains are not available for GitHub Pages" + }, + "422": { + "description": "There isn't a CNAME for this page" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "pages" + } + } + }, "/repos/{owner}/{repo}/projects": { "get": { "summary": "List repository projects", diff --git a/cache/api.github.com.json b/cache/api.github.com.json index b230587c2..bcfd84751 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -35161,6 +35161,63 @@ } } }, + "/repos/{owner}/{repo}/pages/health": { + "get": { + "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" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pages-health-check" + }, + "examples": { + "default": { + "$ref": "#/components/examples/pages-health-check" + } + } + } + } + }, + "202": { + "description": "Empty response" + }, + "400": { + "description": "Custom domains are not available for GitHub Pages" + }, + "422": { + "description": "There isn't a CNAME for this page" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "pages" + } + } + }, "/repos/{owner}/{repo}/projects": { "get": { "summary": "List repository projects", @@ -62532,6 +62589,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "code-scanning-analysis-category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "code-scanning-analysis-created-at": { "type": "string", "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -62561,6 +62622,9 @@ "environment": { "$ref": "#/components/schemas/code-scanning-analysis-environment" }, + "category": { + "$ref": "#/components/schemas/code-scanning-analysis-category" + }, "error": { "type": "string", "example": "error reading field xyz" @@ -66295,6 +66359,228 @@ "status" ] }, + "pages-health-check": { + "title": "Pages Health Check Status", + "description": "Pages Health Check Status", + "type": "object", + "properties": { + "domain": { + "type": "object", + "properties": { + "host": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "nameservers": { + "type": "string" + }, + "dns_resolves": { + "type": "boolean" + }, + "is_proxied": { + "type": "boolean", + "nullable": true + }, + "is_cloudflare_ip": { + "type": "boolean", + "nullable": true + }, + "is_fastly_ip": { + "type": "boolean", + "nullable": true + }, + "is_old_ip_address": { + "type": "boolean", + "nullable": true + }, + "is_a_record": { + "type": "boolean", + "nullable": true + }, + "has_cname_record": { + "type": "boolean", + "nullable": true + }, + "has_mx_records_present": { + "type": "boolean", + "nullable": true + }, + "is_valid_domain": { + "type": "boolean" + }, + "is_apex_domain": { + "type": "boolean" + }, + "should_be_a_record": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_github_user_domain": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_pages_dot_github_dot_com": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_fastly": { + "type": "boolean", + "nullable": true + }, + "is_pointed_to_github_pages_ip": { + "type": "boolean", + "nullable": true + }, + "is_non_github_pages_ip_present": { + "type": "boolean", + "nullable": true + }, + "is_pages_domain": { + "type": "boolean" + }, + "is_served_by_pages": { + "type": "boolean", + "nullable": true + }, + "is_valid": { + "type": "boolean" + }, + "reason": { + "type": "string", + "nullable": true + }, + "responds_to_https": { + "type": "boolean" + }, + "enforces_https": { + "type": "boolean" + }, + "https_error": { + "type": "string", + "nullable": true + }, + "is_https_eligible": { + "type": "boolean", + "nullable": true + }, + "caa_error": { + "type": "string", + "nullable": true + } + } + }, + "alt_domain": { + "type": "object", + "nullable": true, + "properties": { + "host": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "nameservers": { + "type": "string" + }, + "dns_resolves": { + "type": "boolean" + }, + "is_proxied": { + "type": "boolean", + "nullable": true + }, + "is_cloudflare_ip": { + "type": "boolean", + "nullable": true + }, + "is_fastly_ip": { + "type": "boolean", + "nullable": true + }, + "is_old_ip_address": { + "type": "boolean", + "nullable": true + }, + "is_a_record": { + "type": "boolean", + "nullable": true + }, + "has_cname_record": { + "type": "boolean", + "nullable": true + }, + "has_mx_records_present": { + "type": "boolean", + "nullable": true + }, + "is_valid_domain": { + "type": "boolean" + }, + "is_apex_domain": { + "type": "boolean" + }, + "should_be_a_record": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_github_user_domain": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_pages_dot_github_dot_com": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_fastly": { + "type": "boolean", + "nullable": true + }, + "is_pointed_to_github_pages_ip": { + "type": "boolean", + "nullable": true + }, + "is_non_github_pages_ip_present": { + "type": "boolean", + "nullable": true + }, + "is_pages_domain": { + "type": "boolean" + }, + "is_served_by_pages": { + "type": "boolean", + "nullable": true + }, + "is_valid": { + "type": "boolean" + }, + "reason": { + "type": "string", + "nullable": true + }, + "responds_to_https": { + "type": "boolean" + }, + "enforces_https": { + "type": "boolean" + }, + "https_error": { + "type": "string", + "nullable": true + }, + "is_https_eligible": { + "type": "boolean", + "nullable": true + }, + "caa_error": { + "type": "string", + "nullable": true + } + } + } + } + }, "pull-request": { "type": "object", "title": "Pull Request", @@ -80464,6 +80750,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -80484,6 +80771,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, @@ -80508,6 +80796,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"javascript\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", "created_at": "2021-01-13T11:55:49Z", "results_count": 3, "rules_count": 67, @@ -84798,6 +85087,70 @@ "updated_at": "2014-02-10T19:00:51Z" } }, + "pages-health-check": { + "value": { + "domain": { + "host": "example.com", + "uri": "http://example.com/", + "nameservers": "default", + "dns_resolves": true, + "is_proxied": false, + "is_cloudflare_ip": false, + "is_fastly_ip": false, + "is_old_ip_address": false, + "is_a_record": true, + "has_cname_record": false, + "has_mx_records_present": false, + "is_valid_domain": true, + "is_apex_domain": true, + "should_be_a_record": true, + "is_cname_to_github_user_domain": false, + "is_cname_to_pages_dot_github_dot_com": false, + "is_cname_to_fastly": false, + "is_pointed_to_github_pages_ip": true, + "is_non_github_pages_ip_present": false, + "is_pages_domain": false, + "is_served_by_pages": true, + "is_valid": true, + "reason": null, + "responds_to_https": true, + "enforces_https": true, + "https_error": null, + "is_https_eligible": true, + "caa_error": null + }, + "alt_domain": { + "host": "www.example.com", + "uri": "http://www.example.com/", + "nameservers": "default", + "dns_resolves": true, + "is_proxied": false, + "is_cloudflare_ip": false, + "is_fastly_ip": false, + "is_old_ip_address": false, + "is_a_record": true, + "has_cname_record": false, + "has_mx_records_present": false, + "is_valid_domain": true, + "is_apex_domain": true, + "should_be_a_record": true, + "is_cname_to_github_user_domain": false, + "is_cname_to_pages_dot_github_dot_com": false, + "is_cname_to_fastly": false, + "is_pointed_to_github_pages_ip": true, + "is_non_github_pages_ip_present": false, + "is_pages_domain": false, + "is_served_by_pages": true, + "is_valid": true, + "reason": null, + "responds_to_https": true, + "enforces_https": true, + "https_error": null, + "is_https_eligible": true, + "caa_error": null + } + } + }, "project-items-2": { "value": [ { diff --git a/cache/ghes-2.22.deref.json b/cache/ghes-2.22.deref.json index d11eb0992..88f249fc9 100644 --- a/cache/ghes-2.22.deref.json +++ b/cache/ghes-2.22.deref.json @@ -145520,6 +145520,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -145611,6 +145615,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -145631,6 +145636,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, diff --git a/cache/ghes-2.22.json b/cache/ghes-2.22.json index 5d12e3b97..895d5fce7 100644 --- a/cache/ghes-2.22.json +++ b/cache/ghes-2.22.json @@ -55635,6 +55635,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "code-scanning-analysis-category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "code-scanning-analysis-created-at": { "type": "string", "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -55664,6 +55668,9 @@ "environment": { "$ref": "#/components/schemas/code-scanning-analysis-environment" }, + "category": { + "$ref": "#/components/schemas/code-scanning-analysis-category" + }, "error": { "type": "string", "example": "error reading field xyz" @@ -71791,6 +71798,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -71811,6 +71819,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, diff --git a/cache/ghes-3.0.deref.json b/cache/ghes-3.0.deref.json index e517ccbc2..1e18f4225 100644 --- a/cache/ghes-3.0.deref.json +++ b/cache/ghes-3.0.deref.json @@ -150803,6 +150803,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -150894,6 +150898,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -150914,6 +150919,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, diff --git a/cache/ghes-3.0.json b/cache/ghes-3.0.json index fb7a43b01..db8ea6ffe 100644 --- a/cache/ghes-3.0.json +++ b/cache/ghes-3.0.json @@ -57447,6 +57447,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "code-scanning-analysis-category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "code-scanning-analysis-created-at": { "type": "string", "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -57476,6 +57480,9 @@ "environment": { "$ref": "#/components/schemas/code-scanning-analysis-environment" }, + "category": { + "$ref": "#/components/schemas/code-scanning-analysis-category" + }, "error": { "type": "string", "example": "error reading field xyz" @@ -73814,6 +73821,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -73834,6 +73842,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, diff --git a/cache/github.ae.deref.json b/cache/github.ae.deref.json index 9120e9932..435f61eab 100644 --- a/cache/github.ae.deref.json +++ b/cache/github.ae.deref.json @@ -130947,6 +130947,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -131038,6 +131042,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -131058,6 +131063,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, @@ -131233,6 +131239,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -131323,6 +131333,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"javascript\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", "created_at": "2021-01-13T11:55:49Z", "results_count": 3, "rules_count": 67, diff --git a/cache/github.ae.json b/cache/github.ae.json index 34f31d7c3..6bdd66de7 100644 --- a/cache/github.ae.json +++ b/cache/github.ae.json @@ -53662,6 +53662,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "code-scanning-analysis-category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "code-scanning-analysis-created-at": { "type": "string", "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -53691,6 +53695,9 @@ "environment": { "$ref": "#/components/schemas/code-scanning-analysis-environment" }, + "category": { + "$ref": "#/components/schemas/code-scanning-analysis-category" + }, "error": { "type": "string", "example": "error reading field xyz" @@ -69306,6 +69313,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -69326,6 +69334,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, @@ -69350,6 +69359,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"javascript\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", "created_at": "2021-01-13T11:55:49Z", "results_count": 3, "rules_count": 67, diff --git a/generated/api.github.com.deref.json b/generated/api.github.com.deref.json index 184d47f95..91b21cbfa 100644 --- a/generated/api.github.com.deref.json +++ b/generated/api.github.com.deref.json @@ -133632,6 +133632,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -133721,6 +133725,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -133741,6 +133746,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, @@ -133881,6 +133887,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -133969,6 +133979,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"javascript\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", "created_at": "2021-01-13T11:55:49Z", "results_count": 3, "rules_count": 67, @@ -205418,6 +205429,283 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/pages/health": { + "get": { + "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" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { "type": "string" } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Pages Health Check Status", + "description": "Pages Health Check Status", + "type": "object", + "properties": { + "domain": { + "type": "object", + "properties": { + "host": { "type": "string" }, + "uri": { "type": "string" }, + "nameservers": { "type": "string" }, + "dns_resolves": { "type": "boolean" }, + "is_proxied": { "type": "boolean", "nullable": true }, + "is_cloudflare_ip": { + "type": "boolean", + "nullable": true + }, + "is_fastly_ip": { "type": "boolean", "nullable": true }, + "is_old_ip_address": { + "type": "boolean", + "nullable": true + }, + "is_a_record": { "type": "boolean", "nullable": true }, + "has_cname_record": { + "type": "boolean", + "nullable": true + }, + "has_mx_records_present": { + "type": "boolean", + "nullable": true + }, + "is_valid_domain": { "type": "boolean" }, + "is_apex_domain": { "type": "boolean" }, + "should_be_a_record": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_github_user_domain": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_pages_dot_github_dot_com": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_fastly": { + "type": "boolean", + "nullable": true + }, + "is_pointed_to_github_pages_ip": { + "type": "boolean", + "nullable": true + }, + "is_non_github_pages_ip_present": { + "type": "boolean", + "nullable": true + }, + "is_pages_domain": { "type": "boolean" }, + "is_served_by_pages": { + "type": "boolean", + "nullable": true + }, + "is_valid": { "type": "boolean" }, + "reason": { "type": "string", "nullable": true }, + "responds_to_https": { "type": "boolean" }, + "enforces_https": { "type": "boolean" }, + "https_error": { "type": "string", "nullable": true }, + "is_https_eligible": { + "type": "boolean", + "nullable": true + }, + "caa_error": { "type": "string", "nullable": true } + } + }, + "alt_domain": { + "type": "object", + "nullable": true, + "properties": { + "host": { "type": "string" }, + "uri": { "type": "string" }, + "nameservers": { "type": "string" }, + "dns_resolves": { "type": "boolean" }, + "is_proxied": { "type": "boolean", "nullable": true }, + "is_cloudflare_ip": { + "type": "boolean", + "nullable": true + }, + "is_fastly_ip": { "type": "boolean", "nullable": true }, + "is_old_ip_address": { + "type": "boolean", + "nullable": true + }, + "is_a_record": { "type": "boolean", "nullable": true }, + "has_cname_record": { + "type": "boolean", + "nullable": true + }, + "has_mx_records_present": { + "type": "boolean", + "nullable": true + }, + "is_valid_domain": { "type": "boolean" }, + "is_apex_domain": { "type": "boolean" }, + "should_be_a_record": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_github_user_domain": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_pages_dot_github_dot_com": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_fastly": { + "type": "boolean", + "nullable": true + }, + "is_pointed_to_github_pages_ip": { + "type": "boolean", + "nullable": true + }, + "is_non_github_pages_ip_present": { + "type": "boolean", + "nullable": true + }, + "is_pages_domain": { "type": "boolean" }, + "is_served_by_pages": { + "type": "boolean", + "nullable": true + }, + "is_valid": { "type": "boolean" }, + "reason": { "type": "string", "nullable": true }, + "responds_to_https": { "type": "boolean" }, + "enforces_https": { "type": "boolean" }, + "https_error": { "type": "string", "nullable": true }, + "is_https_eligible": { + "type": "boolean", + "nullable": true + }, + "caa_error": { "type": "string", "nullable": true } + } + } + } + }, + "examples": { + "default": { + "value": { + "domain": { + "host": "example.com", + "uri": "http://example.com/", + "nameservers": "default", + "dns_resolves": true, + "is_proxied": false, + "is_cloudflare_ip": false, + "is_fastly_ip": false, + "is_old_ip_address": false, + "is_a_record": true, + "has_cname_record": false, + "has_mx_records_present": false, + "is_valid_domain": true, + "is_apex_domain": true, + "should_be_a_record": true, + "is_cname_to_github_user_domain": false, + "is_cname_to_pages_dot_github_dot_com": false, + "is_cname_to_fastly": false, + "is_pointed_to_github_pages_ip": true, + "is_non_github_pages_ip_present": false, + "is_pages_domain": false, + "is_served_by_pages": true, + "is_valid": true, + "reason": null, + "responds_to_https": true, + "enforces_https": true, + "https_error": null, + "is_https_eligible": true, + "caa_error": null + }, + "alt_domain": { + "host": "www.example.com", + "uri": "http://www.example.com/", + "nameservers": "default", + "dns_resolves": true, + "is_proxied": false, + "is_cloudflare_ip": false, + "is_fastly_ip": false, + "is_old_ip_address": false, + "is_a_record": true, + "has_cname_record": false, + "has_mx_records_present": false, + "is_valid_domain": true, + "is_apex_domain": true, + "should_be_a_record": true, + "is_cname_to_github_user_domain": false, + "is_cname_to_pages_dot_github_dot_com": false, + "is_cname_to_fastly": false, + "is_pointed_to_github_pages_ip": true, + "is_non_github_pages_ip_present": false, + "is_pages_domain": false, + "is_served_by_pages": true, + "is_valid": true, + "reason": null, + "responds_to_https": true, + "enforces_https": true, + "https_error": null, + "is_https_eligible": true, + "caa_error": null + } + } + } + } + } + } + }, + "202": { "description": "Empty response" }, + "400": { + "description": "Custom domains are not available for GitHub Pages" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { "type": "string" }, + "documentation_url": { "type": "string" }, + "url": { "type": "string" }, + "status": { "type": "string" } + } + } + } + } + }, + "422": { "description": "There isn't a CNAME for this page" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "pages" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/projects": { "get": { "summary": "List repository projects", diff --git a/generated/api.github.com.json b/generated/api.github.com.json index 46144f6e1..e2ae8536d 100644 --- a/generated/api.github.com.json +++ b/generated/api.github.com.json @@ -26468,6 +26468,50 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/pages/health": { + "get": { + "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" + }, + "parameters": [ + { "$ref": "#/components/parameters/owner" }, + { "$ref": "#/components/parameters/repo" } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/pages-health-check" }, + "examples": { + "default": { + "$ref": "#/components/examples/pages-health-check" + } + } + } + } + }, + "202": { "description": "Empty response" }, + "400": { + "description": "Custom domains are not available for GitHub Pages" + }, + "404": { "$ref": "#/components/responses/not_found" }, + "422": { "description": "There isn't a CNAME for this page" } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "pages" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/projects": { "get": { "summary": "List repository projects", @@ -46732,6 +46776,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "code-scanning-analysis-category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "code-scanning-analysis-created-at": { "type": "string", "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -46759,6 +46807,9 @@ "environment": { "$ref": "#/components/schemas/code-scanning-analysis-environment" }, + "category": { + "$ref": "#/components/schemas/code-scanning-analysis-category" + }, "error": { "type": "string", "example": "error reading field xyz" }, "created_at": { "$ref": "#/components/schemas/code-scanning-analysis-created-at" @@ -49191,6 +49242,104 @@ }, "required": ["url", "status"] }, + "pages-health-check": { + "title": "Pages Health Check Status", + "description": "Pages Health Check Status", + "type": "object", + "properties": { + "domain": { + "type": "object", + "properties": { + "host": { "type": "string" }, + "uri": { "type": "string" }, + "nameservers": { "type": "string" }, + "dns_resolves": { "type": "boolean" }, + "is_proxied": { "type": "boolean", "nullable": true }, + "is_cloudflare_ip": { "type": "boolean", "nullable": true }, + "is_fastly_ip": { "type": "boolean", "nullable": true }, + "is_old_ip_address": { "type": "boolean", "nullable": true }, + "is_a_record": { "type": "boolean", "nullable": true }, + "has_cname_record": { "type": "boolean", "nullable": true }, + "has_mx_records_present": { "type": "boolean", "nullable": true }, + "is_valid_domain": { "type": "boolean" }, + "is_apex_domain": { "type": "boolean" }, + "should_be_a_record": { "type": "boolean", "nullable": true }, + "is_cname_to_github_user_domain": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_pages_dot_github_dot_com": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_fastly": { "type": "boolean", "nullable": true }, + "is_pointed_to_github_pages_ip": { + "type": "boolean", + "nullable": true + }, + "is_non_github_pages_ip_present": { + "type": "boolean", + "nullable": true + }, + "is_pages_domain": { "type": "boolean" }, + "is_served_by_pages": { "type": "boolean", "nullable": true }, + "is_valid": { "type": "boolean" }, + "reason": { "type": "string", "nullable": true }, + "responds_to_https": { "type": "boolean" }, + "enforces_https": { "type": "boolean" }, + "https_error": { "type": "string", "nullable": true }, + "is_https_eligible": { "type": "boolean", "nullable": true }, + "caa_error": { "type": "string", "nullable": true } + } + }, + "alt_domain": { + "type": "object", + "nullable": true, + "properties": { + "host": { "type": "string" }, + "uri": { "type": "string" }, + "nameservers": { "type": "string" }, + "dns_resolves": { "type": "boolean" }, + "is_proxied": { "type": "boolean", "nullable": true }, + "is_cloudflare_ip": { "type": "boolean", "nullable": true }, + "is_fastly_ip": { "type": "boolean", "nullable": true }, + "is_old_ip_address": { "type": "boolean", "nullable": true }, + "is_a_record": { "type": "boolean", "nullable": true }, + "has_cname_record": { "type": "boolean", "nullable": true }, + "has_mx_records_present": { "type": "boolean", "nullable": true }, + "is_valid_domain": { "type": "boolean" }, + "is_apex_domain": { "type": "boolean" }, + "should_be_a_record": { "type": "boolean", "nullable": true }, + "is_cname_to_github_user_domain": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_pages_dot_github_dot_com": { + "type": "boolean", + "nullable": true + }, + "is_cname_to_fastly": { "type": "boolean", "nullable": true }, + "is_pointed_to_github_pages_ip": { + "type": "boolean", + "nullable": true + }, + "is_non_github_pages_ip_present": { + "type": "boolean", + "nullable": true + }, + "is_pages_domain": { "type": "boolean" }, + "is_served_by_pages": { "type": "boolean", "nullable": true }, + "is_valid": { "type": "boolean" }, + "reason": { "type": "string", "nullable": true }, + "responds_to_https": { "type": "boolean" }, + "enforces_https": { "type": "boolean" }, + "https_error": { "type": "string", "nullable": true }, + "is_https_eligible": { "type": "boolean", "nullable": true }, + "caa_error": { "type": "string", "nullable": true } + } + } + } + }, "pull-request": { "type": "object", "title": "Pull Request", @@ -60661,6 +60810,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -60677,6 +60827,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, @@ -60701,6 +60852,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"javascript\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", "created_at": "2021-01-13T11:55:49Z", "results_count": 3, "rules_count": 67, @@ -64909,6 +65061,70 @@ "updated_at": "2014-02-10T19:00:51Z" } }, + "pages-health-check": { + "value": { + "domain": { + "host": "example.com", + "uri": "http://example.com/", + "nameservers": "default", + "dns_resolves": true, + "is_proxied": false, + "is_cloudflare_ip": false, + "is_fastly_ip": false, + "is_old_ip_address": false, + "is_a_record": true, + "has_cname_record": false, + "has_mx_records_present": false, + "is_valid_domain": true, + "is_apex_domain": true, + "should_be_a_record": true, + "is_cname_to_github_user_domain": false, + "is_cname_to_pages_dot_github_dot_com": false, + "is_cname_to_fastly": false, + "is_pointed_to_github_pages_ip": true, + "is_non_github_pages_ip_present": false, + "is_pages_domain": false, + "is_served_by_pages": true, + "is_valid": true, + "reason": null, + "responds_to_https": true, + "enforces_https": true, + "https_error": null, + "is_https_eligible": true, + "caa_error": null + }, + "alt_domain": { + "host": "www.example.com", + "uri": "http://www.example.com/", + "nameservers": "default", + "dns_resolves": true, + "is_proxied": false, + "is_cloudflare_ip": false, + "is_fastly_ip": false, + "is_old_ip_address": false, + "is_a_record": true, + "has_cname_record": false, + "has_mx_records_present": false, + "is_valid_domain": true, + "is_apex_domain": true, + "should_be_a_record": true, + "is_cname_to_github_user_domain": false, + "is_cname_to_pages_dot_github_dot_com": false, + "is_cname_to_fastly": false, + "is_pointed_to_github_pages_ip": true, + "is_non_github_pages_ip_present": false, + "is_pages_domain": false, + "is_served_by_pages": true, + "is_valid": true, + "reason": null, + "responds_to_https": true, + "enforces_https": true, + "https_error": null, + "is_https_eligible": true, + "caa_error": null + } + } + }, "project-items-2": { "value": [ { diff --git a/generated/ghes-2.22.deref.json b/generated/ghes-2.22.deref.json index e18fd5c1a..4fa2c0dbc 100644 --- a/generated/ghes-2.22.deref.json +++ b/generated/ghes-2.22.deref.json @@ -118377,6 +118377,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -118466,6 +118470,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -118486,6 +118491,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, diff --git a/generated/ghes-2.22.json b/generated/ghes-2.22.json index 6b2269617..f6142a4d7 100644 --- a/generated/ghes-2.22.json +++ b/generated/ghes-2.22.json @@ -41690,6 +41690,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "code-scanning-analysis-category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "code-scanning-analysis-created-at": { "type": "string", "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -41717,6 +41721,9 @@ "environment": { "$ref": "#/components/schemas/code-scanning-analysis-environment" }, + "category": { + "$ref": "#/components/schemas/code-scanning-analysis-category" + }, "error": { "type": "string", "example": "error reading field xyz" }, "created_at": { "$ref": "#/components/schemas/code-scanning-analysis-created-at" @@ -54203,6 +54210,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -54219,6 +54227,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, diff --git a/generated/ghes-3.0.deref.json b/generated/ghes-3.0.deref.json index df52560f8..e43f5b9ed 100644 --- a/generated/ghes-3.0.deref.json +++ b/generated/ghes-3.0.deref.json @@ -122534,6 +122534,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -122623,6 +122627,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -122643,6 +122648,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, diff --git a/generated/ghes-3.0.json b/generated/ghes-3.0.json index 8fc3cdbfc..e5d6db950 100644 --- a/generated/ghes-3.0.json +++ b/generated/ghes-3.0.json @@ -43027,6 +43027,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "code-scanning-analysis-category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "code-scanning-analysis-created-at": { "type": "string", "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -43054,6 +43058,9 @@ "environment": { "$ref": "#/components/schemas/code-scanning-analysis-environment" }, + "category": { + "$ref": "#/components/schemas/code-scanning-analysis-category" + }, "error": { "type": "string", "example": "error reading field xyz" }, "created_at": { "$ref": "#/components/schemas/code-scanning-analysis-created-at" @@ -55688,6 +55695,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -55704,6 +55712,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, diff --git a/generated/github.ae.deref.json b/generated/github.ae.deref.json index c2de553d4..6a55e489f 100644 --- a/generated/github.ae.deref.json +++ b/generated/github.ae.deref.json @@ -107156,6 +107156,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -107245,6 +107249,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -107265,6 +107270,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, @@ -107405,6 +107411,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "error": { "type": "string", "example": "error reading field xyz" @@ -107493,6 +107503,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"javascript\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", "created_at": "2021-01-13T11:55:49Z", "results_count": 3, "rules_count": 67, diff --git a/generated/github.ae.json b/generated/github.ae.json index 0b5ffdab1..c1f8d6f20 100644 --- a/generated/github.ae.json +++ b/generated/github.ae.json @@ -40141,6 +40141,10 @@ "type": "string", "description": "Identifies the variable values associated with the environment in which this analysis was performed." }, + "code-scanning-analysis-category": { + "type": "string", + "description": "Identifies the configuration and environment under which the analysis was executed." + }, "code-scanning-analysis-created-at": { "type": "string", "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", @@ -40168,6 +40172,9 @@ "environment": { "$ref": "#/components/schemas/code-scanning-analysis-environment" }, + "category": { + "$ref": "#/components/schemas/code-scanning-analysis-category" + }, "error": { "type": "string", "example": "error reading field xyz" }, "created_at": { "$ref": "#/components/schemas/code-scanning-analysis-created-at" @@ -52253,6 +52260,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"python\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:python", "created_at": "2020-08-27T15:05:21Z", "results_count": 17, "rules_count": 49, @@ -52269,6 +52277,7 @@ "analysis_key": ".github/workflows/shiftleft.yml:build", "environment": "{}", "error": "", + "category": ".github/workflows/shiftleft.yml:build/", "created_at": "2020-08-31T22:46:44Z", "results_count": 17, "rules_count": 32, @@ -52293,6 +52302,7 @@ "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", "environment": "{\"language\":\"javascript\"}", "error": "", + "category": ".github/workflows/codeql-analysis.yml:analyze/language:javascript", "created_at": "2021-01-13T11:55:49Z", "results_count": 3, "rules_count": 67,