From 79f43cdb77732c131a6c886971f09beffad3694d Mon Sep 17 00:00:00 2001 From: github-openapi-bot Date: Wed, 13 Jul 2022 15:30:59 -0700 Subject: [PATCH 1/2] Update OpenAPI Descriptions --- lib/rest/static/dereferenced/api.github.com.deref.json | 8 ++++---- lib/rest/static/dereferenced/ghes-3.4.deref.json | 4 ++-- lib/rest/static/dereferenced/ghes-3.5.deref.json | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 2fe4fb2e0e..d280ede1b0 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -80939,7 +80939,7 @@ "/orgs/{org}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for an organization", - "description": "Lists all code scanning alerts for the default branch (usually `main`\nor `master`) for all eligible repositories in an organization.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `security_events` read permission to use this endpoint.", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `security_events` read permission to use this endpoint.", "tags": [ "code-scanning" ], @@ -81033,7 +81033,7 @@ }, { "name": "state", - "description": "Set to `open`, `closed`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", + "description": "If specified, only code scanning alerts with this state will be returned.", "in": "query", "required": false, "schema": { @@ -241476,7 +241476,7 @@ "/repos/{owner}/{repo}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for a repository", - "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint with private repos, the `public_repo` scope also grants permission to read\nsecurity events on public repos only. GitHub Apps must have the `security_events` read\npermission to use this endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "description": "Lists code scanning alerts.\n\nTo use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope.\n\nGitHub Apps must have the `security_events` read\npermission to use this endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used `ref` in the request).", "tags": [ "code-scanning" ], @@ -241585,7 +241585,7 @@ }, { "name": "state", - "description": "Set to `open`, `closed`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", + "description": "If specified, only code scanning alerts with this state will be returned.", "in": "query", "required": false, "schema": { diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index 7b53f716d1..687f622867 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -213746,7 +213746,7 @@ "/repos/{owner}/{repo}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for a repository", - "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint with private repos, the `public_repo` scope also grants permission to read\nsecurity events on public repos only. GitHub Apps must have the `security_events` read\npermission to use this endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "description": "Lists code scanning alerts.\n\nTo use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope.\n\nGitHub Apps must have the `security_events` read\npermission to use this endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used `ref` in the request).", "tags": [ "code-scanning" ], @@ -213855,7 +213855,7 @@ }, { "name": "state", - "description": "Set to `open`, `closed`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", + "description": "If specified, only code scanning alerts with this state will be returned.", "in": "query", "required": false, "schema": { diff --git a/lib/rest/static/dereferenced/ghes-3.5.deref.json b/lib/rest/static/dereferenced/ghes-3.5.deref.json index 14d5ffd1d7..82b76e0362 100644 --- a/lib/rest/static/dereferenced/ghes-3.5.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.5.deref.json @@ -84441,7 +84441,7 @@ "/orgs/{org}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for an organization", - "description": "Lists all code scanning alerts for the default branch (usually `main`\nor `master`) for all eligible repositories in an organization.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `security_events` read permission to use this endpoint.", + "description": "Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.5/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nTo use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `security_events` read permission to use this endpoint.", "tags": [ "code-scanning" ], @@ -84535,7 +84535,7 @@ }, { "name": "state", - "description": "Set to `open`, `closed`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", + "description": "If specified, only code scanning alerts with this state will be returned.", "in": "query", "required": false, "schema": { @@ -223653,7 +223653,7 @@ "/repos/{owner}/{repo}/code-scanning/alerts": { "get": { "summary": "List code scanning alerts for a repository", - "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint with private repos, the `public_repo` scope also grants permission to read\nsecurity events on public repos only. GitHub Apps must have the `security_events` read\npermission to use this endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "description": "Lists code scanning alerts.\n\nTo use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope.\n\nGitHub Apps must have the `security_events` read\npermission to use this endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used `ref` in the request).", "tags": [ "code-scanning" ], @@ -223762,7 +223762,7 @@ }, { "name": "state", - "description": "Set to `open`, `closed`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", + "description": "If specified, only code scanning alerts with this state will be returned.", "in": "query", "required": false, "schema": { From 7c9c4c397e2030ce8c4e9dee21127e63151809ce Mon Sep 17 00:00:00 2001 From: github-openapi-bot Date: Wed, 13 Jul 2022 22:40:34 +0000 Subject: [PATCH 2/2] Add decorated OpenAPI schema files --- lib/rest/static/decorated/api.github.com.json | 8 ++++---- lib/rest/static/decorated/ghes-3.4.json | 4 ++-- lib/rest/static/decorated/ghes-3.5.json | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 3d1a57f151..2fb5641af0 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -175275,7 +175275,7 @@ }, { "name": "state", - "description": "

Set to open, closed, fixed, or dismissed to list code scanning alerts in a specific state.

", + "description": "

If specified, only code scanning alerts with this state will be returned.

", "in": "query", "required": false, "schema": { @@ -176565,7 +176565,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all code scanning alerts for the default branch (usually main\nor master) for all eligible repositories in an organization.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the repo scope or security_events scope.

\n

GitHub Apps must have the security_events read permission to use this endpoint.

", + "descriptionHTML": "

Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"Managing security managers in your organization.\"

\n

To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the repo scope or security_events scope.

\n

GitHub Apps must have the security_events read permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -176692,7 +176692,7 @@ }, { "name": "state", - "description": "

Set to open, closed, fixed, or dismissed to list code scanning alerts in a specific state.

", + "description": "

If specified, only code scanning alerts with this state will be returned.

", "in": "query", "required": false, "schema": { @@ -177268,7 +177268,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all open code scanning alerts for the default branch (usually main\nor master). You must use an access token with the security_events scope to use\nthis endpoint with private repos, the public_repo scope also grants permission to read\nsecurity events on public repos only. GitHub Apps must have the security_events read\npermission to use this endpoint.

\n

The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used ref in the request).

", + "descriptionHTML": "

Lists code scanning alerts.

\n

To use this endpoint, you must use an access token with the security_events scope or, for alerts from public repositories only, an access token with the public_repo scope.

\n

GitHub Apps must have the security_events read\npermission to use this endpoint.

\n

The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used ref in the request).

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index 88d7b761d3..5fded48d5c 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -161539,7 +161539,7 @@ }, { "name": "state", - "description": "

Set to open, closed, fixed, or dismissed to list code scanning alerts in a specific state.

", + "description": "

If specified, only code scanning alerts with this state will be returned.

", "in": "query", "required": false, "schema": { @@ -162105,7 +162105,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all open code scanning alerts for the default branch (usually main\nor master). You must use an access token with the security_events scope to use\nthis endpoint with private repos, the public_repo scope also grants permission to read\nsecurity events on public repos only. GitHub Apps must have the security_events read\npermission to use this endpoint.

\n

The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used ref in the request).

", + "descriptionHTML": "

Lists code scanning alerts.

\n

To use this endpoint, you must use an access token with the security_events scope or, for alerts from public repositories only, an access token with the public_repo scope.

\n

GitHub Apps must have the security_events read\npermission to use this endpoint.

\n

The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used ref in the request).

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/lib/rest/static/decorated/ghes-3.5.json b/lib/rest/static/decorated/ghes-3.5.json index 7cfb1a158e..43e1b22318 100644 --- a/lib/rest/static/decorated/ghes-3.5.json +++ b/lib/rest/static/decorated/ghes-3.5.json @@ -170064,7 +170064,7 @@ }, { "name": "state", - "description": "

Set to open, closed, fixed, or dismissed to list code scanning alerts in a specific state.

", + "description": "

If specified, only code scanning alerts with this state will be returned.

", "in": "query", "required": false, "schema": { @@ -171344,7 +171344,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all code scanning alerts for the default branch (usually main\nor master) for all eligible repositories in an organization.\nTo use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the repo scope or security_events scope.

\n

GitHub Apps must have the security_events read permission to use this endpoint.

", + "descriptionHTML": "

Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"Managing security managers in your organization.\"

\n

To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the repo scope or security_events scope.

\n

GitHub Apps must have the security_events read permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -171471,7 +171471,7 @@ }, { "name": "state", - "description": "

Set to open, closed, fixed, or dismissed to list code scanning alerts in a specific state.

", + "description": "

If specified, only code scanning alerts with this state will be returned.

", "in": "query", "required": false, "schema": { @@ -172037,7 +172037,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists all open code scanning alerts for the default branch (usually main\nor master). You must use an access token with the security_events scope to use\nthis endpoint with private repos, the public_repo scope also grants permission to read\nsecurity events on public repos only. GitHub Apps must have the security_events read\npermission to use this endpoint.

\n

The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used ref in the request).

", + "descriptionHTML": "

Lists code scanning alerts.

\n

To use this endpoint, you must use an access token with the security_events scope or, for alerts from public repositories only, an access token with the public_repo scope.

\n

GitHub Apps must have the security_events read\npermission to use this endpoint.

\n

The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the default branch (or for the specified Git reference if you used ref in the request).

", "statusCodes": [ { "httpStatusCode": "200",