diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 062c2ecda371..12b7fd517c5b 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -31590,12 +31590,12 @@ }, "security_and_analysis": { "type": "object or nullable", - "description": "

Specify which security and analysis features to enable or disable.

", + "description": "

Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: {\"security_and_analysis\": {\"advanced_security\": {\"status\": \"enabled\"}}}. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

", "nullable": true, "properties": { "advanced_security": { "type": "object", - "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\" If you're an admin user for a repository covered by an Advanced Security license, you can check whether Advanced Security is currently enabled by using a GET /repos/{owner}/{repo} request.

", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", "properties": { "status": { "type": "string", @@ -31610,7 +31610,7 @@ "name": "advanced_security", "in": "body", "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\" If you're an admin user for a repository covered by an Advanced Security license, you can check whether Advanced Security is currently enabled by using a `GET /repos/{owner}/{repo}` request.", + "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", "childParamsGroups": [ { "parentName": "advanced_security", @@ -31629,12 +31629,49 @@ ] } ] + }, + "secret_scanning": { + "type": "object", + "description": "

Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "secret_scanning", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] } }, "name": "security_and_analysis", "in": "body", "rawType": "object", - "rawDescription": "Specify which security and analysis features to enable or disable.", + "rawDescription": "Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: `{\"security_and_analysis\": {\"advanced_security\": {\"status\": \"enabled\"}}}`. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", "childParamsGroups": [ { "parentName": "security_and_analysis", @@ -31643,7 +31680,7 @@ "params": [ { "type": "object", - "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\" If you're an admin user for a repository covered by an Advanced Security license, you can check whether Advanced Security is currently enabled by using a GET /repos/{owner}/{repo} request.

", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", "properties": { "status": { "type": "string", @@ -31658,7 +31695,7 @@ "name": "advanced_security", "in": "body", "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\" If you're an admin user for a repository covered by an Advanced Security license, you can check whether Advanced Security is currently enabled by using a `GET /repos/{owner}/{repo}` request.", + "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", "childParamsGroups": [ { "parentName": "advanced_security", @@ -31677,6 +31714,43 @@ ] } ] + }, + { + "type": "object", + "description": "

Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "secret_scanning", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] } ] }, @@ -31695,6 +31769,22 @@ "childParamsGroups": [] } ] + }, + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] } ] }, @@ -31919,12 +32009,12 @@ }, { "type": "object or nullable", - "description": "

Specify which security and analysis features to enable or disable.

", + "description": "

Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: {\"security_and_analysis\": {\"advanced_security\": {\"status\": \"enabled\"}}}. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

", "nullable": true, "properties": { "advanced_security": { "type": "object", - "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\" If you're an admin user for a repository covered by an Advanced Security license, you can check whether Advanced Security is currently enabled by using a GET /repos/{owner}/{repo} request.

", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", "properties": { "status": { "type": "string", @@ -31939,7 +32029,7 @@ "name": "advanced_security", "in": "body", "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\" If you're an admin user for a repository covered by an Advanced Security license, you can check whether Advanced Security is currently enabled by using a `GET /repos/{owner}/{repo}` request.", + "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", "childParamsGroups": [ { "parentName": "advanced_security", @@ -31958,12 +32048,49 @@ ] } ] + }, + "secret_scanning": { + "type": "object", + "description": "

Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "secret_scanning", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] } }, "name": "security_and_analysis", "in": "body", "rawType": "object", - "rawDescription": "Specify which security and analysis features to enable or disable.", + "rawDescription": "Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: `{\"security_and_analysis\": {\"advanced_security\": {\"status\": \"enabled\"}}}`. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", "childParamsGroups": [ { "parentName": "security_and_analysis", @@ -31972,7 +32099,7 @@ "params": [ { "type": "object", - "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\" If you're an admin user for a repository covered by an Advanced Security license, you can check whether Advanced Security is currently enabled by using a GET /repos/{owner}/{repo} request.

", + "description": "

Use the status property to enable or disable GitHub Advanced Security for this repository. For more information, see \"About GitHub Advanced Security.\"

", "properties": { "status": { "type": "string", @@ -31987,7 +32114,7 @@ "name": "advanced_security", "in": "body", "rawType": "object", - "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\" If you're an admin user for a repository covered by an Advanced Security license, you can check whether Advanced Security is currently enabled by using a `GET /repos/{owner}/{repo}` request.", + "rawDescription": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", "childParamsGroups": [ { "parentName": "advanced_security", @@ -32006,6 +32133,43 @@ ] } ] + }, + { + "type": "object", + "description": "

Use the status property to enable or disable secret scanning for this repository. For more information, see \"About secret scanning.\"

", + "properties": { + "status": { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + }, + "name": "secret_scanning", + "in": "body", + "rawType": "object", + "rawDescription": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", + "childParamsGroups": [ + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] + } + ] } ] }, @@ -32024,6 +32188,22 @@ "childParamsGroups": [] } ] + }, + { + "parentName": "secret_scanning", + "parentType": "object", + "id": "secret_scanning-object", + "params": [ + { + "type": "string", + "description": "

Can be enabled or disabled.

", + "name": "status", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `enabled` or `disabled`.", + "childParamsGroups": [] + } + ] } ] }, @@ -47253,7 +47433,7 @@ } ], "summary": "Get a code scanning analysis for a repository", - "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\nFor an example response, see \"[Custom media type for code scanning](#custom-media-type-for-code-scanning).\"\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", "operationId": "code-scanning/get-analysis", "tags": [ "code-scanning" @@ -47273,7 +47453,7 @@ "categoryLabel": "Code scanning", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint.\nGitHub Apps must have the security_events read permission to use this endpoint.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.\nFor an example response, see \"Custom media type for code scanning.\"

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", + "descriptionHTML": "

Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint.\nGitHub Apps must have the security_events read permission to use this endpoint.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", "responses": [ { "httpStatusCode": "200", diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 58ec377202a0..3a752b159fb6 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -46697,7 +46697,7 @@ } ], "summary": "Get a code scanning analysis for a repository", - "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\nFor an example response, see \"[Custom media type for code scanning](#custom-media-type-for-code-scanning).\"\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", "operationId": "code-scanning/get-analysis", "tags": [ "code-scanning" @@ -46717,7 +46717,7 @@ "categoryLabel": "Code scanning", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint.\nGitHub Apps must have the security_events read permission to use this endpoint.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.\nFor an example response, see \"Custom media type for code scanning.\"

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", + "descriptionHTML": "

Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint.\nGitHub Apps must have the security_events read permission to use this endpoint.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", "responses": [ { "httpStatusCode": "200", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 4f574754aa3a..5d875fc285e4 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -39230,7 +39230,7 @@ } ], "summary": "Get a code scanning analysis for a repository", - "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\nFor an example response, see \"[Custom media type for code scanning](#custom-media-type-for-code-scanning).\"\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", "operationId": "code-scanning/get-analysis", "tags": [ "code-scanning" @@ -39250,7 +39250,7 @@ "categoryLabel": "Code scanning", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint.\nGitHub Apps must have the security_events read permission to use this endpoint.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.\nFor an example response, see \"Custom media type for code scanning.\"

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", + "descriptionHTML": "

Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint.\nGitHub Apps must have the security_events read permission to use this endpoint.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", "responses": [ { "httpStatusCode": "200", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index a7af61b57d22..0a1e6bf02ad5 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -116289,12 +116289,22 @@ }, "security_and_analysis": { "type": "object", - "description": "Specify which security and analysis features to enable or disable.", + "description": "Specify which security and analysis features to enable or disable. For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request: `{\"security_and_analysis\": {\"advanced_security\": {\"status\": \"enabled\"}}}`. If you have admin permissions for a private repository covered by an Advanced Security license, you can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", "nullable": true, "properties": { "advanced_security": { "type": "object", - "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\" If you're an admin user for a repository covered by an Advanced Security license, you can check whether Advanced Security is currently enabled by using a `GET /repos/{owner}/{repo}` request.", + "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", + "properties": { + "status": { + "type": "string", + "description": "Can be `enabled` or `disabled`." + } + } + }, + "secret_scanning": { + "type": "object", + "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", "properties": { "status": { "type": "string", @@ -171893,7 +171903,7 @@ "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { "get": { "summary": "Get a code scanning analysis for a repository", - "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\nFor an example response, see \"[Custom media type for code scanning](#custom-media-type-for-code-scanning).\"\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", "operationId": "code-scanning/get-analysis", "tags": [ "code-scanning" diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index 20e58c46da5a..c4c5dd2f1eb9 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -160614,7 +160614,7 @@ "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { "get": { "summary": "Get a code scanning analysis for a repository", - "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\nFor an example response, see \"[Custom media type for code scanning](#custom-media-type-for-code-scanning).\"\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", "operationId": "code-scanning/get-analysis", "tags": [ "code-scanning" diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index b1927a532daa..293ac370296c 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -128016,7 +128016,7 @@ "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { "get": { "summary": "Get a code scanning analysis for a repository", - "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\nFor an example response, see \"[Custom media type for code scanning](#custom-media-type-for-code-scanning).\"\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", "operationId": "code-scanning/get-analysis", "tags": [ "code-scanning"