Skip to content

Commit

Permalink
Update OpenAPI 3.1 Descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-openapi-bot
github-openapi-bot committed Jul 27, 2023
1 parent 8482a8d commit 2264fb2
Show file tree
Hide file tree
Showing 36 changed files with 3,054 additions and 3,987 deletions.
248 changes: 125 additions & 123 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7713,14 +7713,14 @@
}
}
},
"/orgs/{org}/codespaces/billing": {
"/orgs/{org}/codespaces/access": {
"put": {
"summary": "Manage access control for organization codespaces",
"description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces billing permissions for users according to the visibility.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"description": "Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"tags": [
"codespaces"
],
"operationId": "codespaces/set-codespaces-billing",
"operationId": "codespaces/set-codespaces-access",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces"
Expand Down Expand Up @@ -7803,17 +7803,17 @@
}
}
},
"/orgs/{org}/codespaces/billing/selected_users": {
"/orgs/{org}/codespaces/access/selected_users": {
"post": {
"summary": "Add users to Codespaces billing for an organization",
"description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the billing settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"summary": "Add users to Codespaces access for an organization",
"description": "Codespaces for the specified users will be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"tags": [
"codespaces"
],
"operationId": "codespaces/set-codespaces-billing-users",
"operationId": "codespaces/set-codespaces-access-users",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-billing-for-an-organization"
"url": "https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization"
},
"parameters": [
{
Expand Down Expand Up @@ -7882,15 +7882,15 @@
}
},
"delete": {
"summary": "Remove users from Codespaces billing for an organization",
"description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the billing settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"summary": "Remove users from Codespaces access for an organization",
"description": "Codespaces for the specified users will no longer be billed to the organization.\n\nTo use this endpoint, the access settings for the organization must be set to `selected_members`.\nFor information on how to change this setting, see \"[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.",
"tags": [
"codespaces"
],
"operationId": "codespaces/delete-codespaces-billing-users",
"operationId": "codespaces/delete-codespaces-access-users",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-billing-for-an-organization"
"url": "https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization"
},
"deprecated": true,
"parameters": [
Expand Down Expand Up @@ -43456,8 +43456,8 @@
"type": "string",
"description": "The level at which the comment is targeted.",
"enum": [
"LINE",
"FILE"
"line",
"file"
]
}
},
Expand Down Expand Up @@ -100816,7 +100816,7 @@
]
},
"languages": {
"description": "CodeQL languages to be analyzed. Supported values are: `c-cpp`, `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, and `ruby`.",
"description": "CodeQL languages to be analyzed. Supported values are: `c-cpp`, `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, `ruby`, and `swift`.",
"type": "array",
"items": {
"type": "string",
Expand Down Expand Up @@ -116412,6 +116412,111 @@
"archived_at"
]
},
"secret-scanning-alert-resolution-webhook": {
"type": [
"string",
"null"
],
"description": "The reason for resolving the alert.",
"enum": [
"false_positive",
"wont_fix",
"revoked",
"used_in_tests",
"pattern_deleted",
"pattern_edited",
null
]
},
"secret-scanning-alert-webhook": {
"type": "object",
"properties": {
"number": {
"$ref": "#/components/schemas/alert-number"
},
"created_at": {
"$ref": "#/components/schemas/alert-created-at"
},
"updated_at": {
"anyOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/alert-updated-at"
}
]
},
"url": {
"$ref": "#/components/schemas/alert-url"
},
"html_url": {
"$ref": "#/components/schemas/alert-html-url"
},
"locations_url": {
"type": "string",
"format": "uri",
"description": "The REST API URL of the code locations for this alert."
},
"resolution": {
"$ref": "#/components/schemas/secret-scanning-alert-resolution-webhook"
},
"resolved_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
},
"resolved_by": {
"anyOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/simple-user"
}
]
},
"resolution_comment": {
"type": [
"string",
"null"
],
"description": "An optional comment to resolve an alert."
},
"secret_type": {
"type": "string",
"description": "The type of secret that secret scanning detected."
},
"push_protection_bypassed": {
"type": [
"boolean",
"null"
],
"description": "Whether push protection was bypassed for the detected secret."
},
"push_protection_bypassed_by": {
"anyOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/simple-user"
}
]
},
"push_protection_bypassed_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
}
}
},
"webhook-branch-protection-rule-created": {
"title": "branch protection rule created event",
"type": "object",
Expand Down Expand Up @@ -261053,7 +261158,7 @@
]
},
"alert": {
"$ref": "#/components/schemas/secret-scanning-alert"
"$ref": "#/components/schemas/secret-scanning-alert-webhook"
},
"enterprise": {
"$ref": "#/components/schemas/enterprise"
Expand Down Expand Up @@ -261088,7 +261193,7 @@
]
},
"alert": {
"$ref": "#/components/schemas/secret-scanning-alert"
"$ref": "#/components/schemas/secret-scanning-alert-webhook"
},
"installation": {
"$ref": "#/components/schemas/simple-installation"
Expand Down Expand Up @@ -261137,7 +261242,7 @@
]
},
"alert": {
"$ref": "#/components/schemas/secret-scanning-alert"
"$ref": "#/components/schemas/secret-scanning-alert-webhook"
},
"enterprise": {
"$ref": "#/components/schemas/enterprise"
Expand Down Expand Up @@ -261172,110 +261277,7 @@
]
},
"alert": {
"type": "object",
"properties": {
"created_at": {
"$ref": "#/components/schemas/alert-created-at"
},
"html_url": {
"$ref": "#/components/schemas/alert-html-url"
},
"locations_url": {
"description": "The REST API URL of the code locations for this alert.",
"type": "string",
"format": "uri"
},
"number": {
"$ref": "#/components/schemas/alert-number"
},
"push_protection_bypassed": {
"description": "Whether push protection was bypassed for the detected secret.",
"type": [
"boolean",
"null"
]
},
"push_protection_bypassed_at": {
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"push_protection_bypassed_by": {
"anyOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/simple-user"
}
]
},
"resolution": {
"description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.",
"type": [
"string",
"null"
],
"enum": [
null,
"false_positive",
"wont_fix",
"revoked",
"used_in_tests",
"pattern_deleted",
"pattern_edited"
]
},
"resolved_at": {
"description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"resolved_by": {
"anyOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/simple-user"
}
]
},
"resolution_comment": {
"description": "An optional comment to resolve an alert.",
"type": [
"string",
"null"
]
},
"secret": {
"description": "The secret that was detected.",
"type": "string"
},
"secret_type": {
"description": "The type of secret that secret scanning detected.",
"type": "string"
},
"secret_type_display_name": {
"description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\"",
"type": "string"
},
"state": {
"$ref": "#/components/schemas/secret-scanning-alert-state"
},
"updated_at": {
"$ref": "#/components/schemas/alert-updated-at"
},
"url": {
"$ref": "#/components/schemas/alert-url"
}
}
"$ref": "#/components/schemas/secret-scanning-alert-webhook"
},
"enterprise": {
"$ref": "#/components/schemas/enterprise"
Expand Down Expand Up @@ -261310,7 +261312,7 @@
]
},
"alert": {
"$ref": "#/components/schemas/secret-scanning-alert"
"$ref": "#/components/schemas/secret-scanning-alert-webhook"
},
"enterprise": {
"$ref": "#/components/schemas/enterprise"
Expand Down
Loading

0 comments on commit 2264fb2

Please sign in to comment.