jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-06 15:01:04 -05:00
Code Issues Projects Releases Wiki Activity

Update OpenAPI Descriptions (#25816)

Browse Source
This commit is contained in:
github-openapi-bot
2022-03-03 18:55:16 -06:00
committed by GitHub
parent d04e4046ae
commit 862aca9368
12 changed files with 41 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
lib/rest/static/decorated/api.github.com.json
View File

@@ -80969,12 +80969,12 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
},
{
"name": "resolution",
@@ -81088,12 +81088,12 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
},
{
"name": "resolution",
@@ -81206,12 +81206,12 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
},
{
"name": "resolution",
@@ -81264,7 +81264,7 @@
"category": "secret-scanning",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.</p>",
"descriptionHTML": "<p>Lists secret scanning alerts for an eligible repository, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the <code>repo</code> scope or <code>security_events</code> scope.\nFor public repositories, you may instead use the <code>public_repo</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -81340,7 +81340,7 @@
"category": "secret-scanning",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.</p>",
"descriptionHTML": "<p>Gets a single secret scanning alert detected in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the <code>repo</code> scope or <code>security_events</code> scope.\nFor public repositories, you may instead use the <code>public_repo</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",
@@ -81468,7 +81468,7 @@
"slug": "update-a-secret-scanning-alert",
"category": "secret-scanning",
"notes": [],
"descriptionHTML": "<p>Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> write permission to use this endpoint.</p>",
"descriptionHTML": "<p>Updates the status of a secret scanning alert in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the <code>repo</code> scope or <code>security_events</code> scope.\nFor public repositories, you may instead use the <code>public_repo</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> write permission to use this endpoint.</p>",
"bodyParameters": [
{
"description": "<p><strong>Required</strong>. Sets the state of the secret scanning alert. Can be either <code>open</code> or <code>resolved</code>. You must provide <code>resolution</code> when you set the state to <code>resolved</code>.</p>",
@@ -81601,7 +81601,7 @@
"category": "secret-scanning",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.</p>",
"descriptionHTML": "<p>Lists all locations for a given secret scanning alert for an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the <code>repo</code> scope or <code>security_events</code> scope.\nFor public repositories, you may instead use the <code>public_repo</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.</p>",
"responses": [
{
"httpStatusCode": "200",

4
lib/rest/static/decorated/ghes-3.1.json
View File

@@ -66019,12 +66019,12 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.1/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/enterprise-server@3.1/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
},
{
"name": "resolution",

4
lib/rest/static/decorated/ghes-3.2.json
View File

@@ -68239,12 +68239,12 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.2/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/enterprise-server@3.2/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
},
{
"name": "resolution",

8
lib/rest/static/decorated/ghes-3.3.json
View File

@@ -68420,12 +68420,12 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.3/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/enterprise-server@3.3/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
},
{
"name": "resolution",
@@ -68538,12 +68538,12 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.3/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/enterprise-server@3.3/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
},
{
"name": "resolution",

12
lib/rest/static/decorated/ghes-3.4.json
View File

@@ -72056,12 +72056,12 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.4/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/enterprise-server@3.4/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
},
{
"name": "resolution",
@@ -72175,12 +72175,12 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.4/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/enterprise-server@3.4/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
},
{
"name": "resolution",
@@ -72293,12 +72293,12 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.4/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/enterprise-server@3.4/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
},
{
"name": "resolution",

4
lib/rest/static/decorated/github.ae.json
View File

@@ -61132,12 +61132,12 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/github-ae@latest/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/github-ae@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
},
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/github-ae@latest/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/github-ae@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
},
{
"name": "resolution",

14
lib/rest/static/dereferenced/api.github.com.deref.json
View File

@@ -22928,7 +22928,7 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
@@ -103013,7 +103013,7 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
@@ -359526,7 +359526,7 @@
"/repos/{owner}/{repo}/secret-scanning/alerts": {
"get": {
"summary": "List secret scanning alerts for a repository",
"description": "Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.",
"description": "Lists secret scanning alerts for an eligible repository, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.",
"tags": [
"secret-scanning"
],
@@ -359568,7 +359568,7 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
@@ -359887,7 +359887,7 @@
"/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": {
"get": {
"summary": "Get a secret scanning alert",
"description": "Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.",
"description": "Gets a single secret scanning alert detected in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.",
"tags": [
"secret-scanning"
],
@@ -360174,7 +360174,7 @@
},
"patch": {
"summary": "Update a secret scanning alert",
"description": "Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.",
"description": "Updates the status of a secret scanning alert in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.",
"operationId": "secret-scanning/update-alert",
"tags": [
"secret-scanning"
@@ -360520,7 +360520,7 @@
"/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": {
"get": {
"summary": "List locations for a secret scanning alert",
"description": "Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.",
"description": "Lists all locations for a given secret scanning alert for an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope.\nFor public repositories, you may instead use the `public_repo` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.",
"tags": [
"secret-scanning"
],

2
lib/rest/static/dereferenced/ghes-3.1.deref.json
View File

@@ -305005,7 +305005,7 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.1/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.1/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"

2
lib/rest/static/dereferenced/ghes-3.2.deref.json
View File

@@ -312390,7 +312390,7 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.2/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.2/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"

4
lib/rest/static/dereferenced/ghes-3.3.deref.json
View File

@@ -84262,7 +84262,7 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.3/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
@@ -315432,7 +315432,7 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.3/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"

6
lib/rest/static/dereferenced/ghes-3.4.deref.json
View File

@@ -29281,7 +29281,7 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.4/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
@@ -94318,7 +94318,7 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.4/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"
@@ -329266,7 +329266,7 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/enterprise-server@3.4/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.4/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"

2
lib/rest/static/dereferenced/github.ae.deref.json
View File

@@ -286905,7 +286905,7 @@
{
"name": "secret_type",
"in": "query",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/github-ae@latest/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/github-ae@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
"required": false,
"schema": {
"type": "string"