From dc76b859401496774fc520dec751e15cbc8459aa Mon Sep 17 00:00:00 2001 From: github-openapi-bot Date: Wed, 10 Mar 2021 12:31:26 -0800 Subject: [PATCH] Update OpenAPI Descriptions --- .../api.github.com/api.github.com.json | 406 +- .../api.github.com/api.github.com.yaml | 276 +- .../dereferenced/api.github.com.deref.json | 727 ++- .../dereferenced/api.github.com.deref.yaml | 960 ++-- .../dereferenced/ghes-2.18.deref.json | 615 ++- .../dereferenced/ghes-2.18.deref.yaml | 3379 ++++++------ descriptions/ghes-2.18/ghes-2.18.json | 351 +- descriptions/ghes-2.18/ghes-2.18.yaml | 241 +- .../dereferenced/ghes-2.19.deref.json | 619 ++- .../dereferenced/ghes-2.19.deref.yaml | 3409 +++++++------ descriptions/ghes-2.19/ghes-2.19.json | 355 +- descriptions/ghes-2.19/ghes-2.19.yaml | 245 +- .../dereferenced/ghes-2.20.deref.json | 619 ++- .../dereferenced/ghes-2.20.deref.yaml | 3453 +++++++------ descriptions/ghes-2.20/ghes-2.20.json | 355 +- descriptions/ghes-2.20/ghes-2.20.yaml | 245 +- .../dereferenced/ghes-2.21.deref.json | 628 ++- .../dereferenced/ghes-2.21.deref.yaml | 3599 +++++++------ descriptions/ghes-2.21/ghes-2.21.json | 364 +- descriptions/ghes-2.21/ghes-2.21.yaml | 251 +- .../dereferenced/ghes-2.22.deref.json | 689 ++- .../dereferenced/ghes-2.22.deref.yaml | 4129 ++++++++------- descriptions/ghes-2.22/ghes-2.22.json | 383 +- descriptions/ghes-2.22/ghes-2.22.yaml | 266 +- .../ghes-3.0/dereferenced/ghes-3.0.deref.json | 689 ++- .../ghes-3.0/dereferenced/ghes-3.0.deref.yaml | 4315 ++++++++-------- descriptions/ghes-3.0/ghes-3.0.json | 383 +- descriptions/ghes-3.0/ghes-3.0.yaml | 266 +- .../dereferenced/github.ae.deref.json | 1590 +++++- .../dereferenced/github.ae.deref.yaml | 4513 ++++++++++------- descriptions/github.ae/github.ae.json | 1236 ++++- descriptions/github.ae/github.ae.yaml | 720 ++- 32 files changed, 26952 insertions(+), 13324 deletions(-) diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 7c4272fcb4..7a33f031dd 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -906,6 +906,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -1664,6 +1673,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -3997,6 +4015,9 @@ { "$ref": "#/components/parameters/audit-log-order" }, + { + "$ref": "#/components/parameters/page" + }, { "$ref": "#/components/parameters/per_page" } @@ -5760,6 +5781,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -5915,6 +5937,9 @@ }, { "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -8132,6 +8157,12 @@ }, { "$ref": "#/components/parameters/runner_group_id" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" } ], "responses": { @@ -9116,6 +9147,12 @@ }, { "$ref": "#/components/parameters/secret_name" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" } ], "responses": { @@ -9343,6 +9380,9 @@ }, { "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -10839,6 +10879,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -11318,6 +11359,22 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "exclude", + "description": "Exclude attributes from the API response to improve performance", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "example": "repositories", + "type": "string" + } + } } ], "responses": { @@ -11470,6 +11527,22 @@ }, { "$ref": "#/components/parameters/migration_id" + }, + { + "name": "exclude", + "description": "Exclude attributes from the API response to improve performance", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "example": "repositories", + "type": "string" + } + } } ], "responses": { @@ -12033,6 +12106,15 @@ }, { "$ref": "#/components/parameters/org" + }, + { + "name": "token", + "description": "package token", + "schema": { + "type": "string" + }, + "required": false, + "in": "query" } ], "responses": { @@ -12067,7 +12149,7 @@ "tags": [ "packages" ], - "operationId": "packages/get-all-package-versions-for-a-package-owned-by-an-org", + "operationId": "packages/get-all-package-versions-for-package-owned-by-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" @@ -12081,6 +12163,26 @@ }, { "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "name": "state", + "in": "query", + "required": false, + "description": "The state of the package, either active or deleted.", + "schema": { + "type": "string", + "enum": [ + "active", + "deleted" + ], + "default": "active" + } } ], "responses": { @@ -13058,7 +13160,12 @@ "$ref": "#/components/parameters/per_page" }, { - "$ref": "#/components/parameters/page" + "name": "page", + "description": "Page token", + "in": "query", + "schema": { + "type": "string" + } } ], "responses": { @@ -13477,6 +13584,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { @@ -23655,7 +23771,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. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "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. GitHub Apps must have the `security_events` read permission to use\nthis 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).", "tags": [ "code-scanning" ], @@ -24135,7 +24251,8 @@ "description": "Allow deletion if the specified analysis is the last in a set. The parameter can be used without a value as the parameter value is not considered. If you attempt to delete the final analysis in a set without using this parameter you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`", "required": false, "schema": { - "type": "string" + "type": "string", + "nullable": true } } ], @@ -24181,7 +24298,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -25189,6 +25306,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -25563,9 +25700,15 @@ { "$ref": "#/components/parameters/repo" }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -25632,7 +25775,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -25665,6 +25808,14 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -25736,7 +25887,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -25833,13 +25984,19 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -25894,7 +26051,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -26136,7 +26293,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -26237,7 +26394,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -26417,7 +26574,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -26665,7 +26822,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -27703,7 +27861,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -27713,6 +27872,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -27770,6 +27949,26 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -27777,6 +27976,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -28207,7 +28407,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -28279,7 +28479,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -28430,7 +28630,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -28516,7 +28716,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -28890,7 +29090,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -35219,7 +35420,17 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/sort" + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "created_at" + ] + } }, { "name": "direction", @@ -37550,6 +37761,79 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content-file" + }, + "examples": { + "default": { + "$ref": "#/components/examples/content-file" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -37963,7 +38247,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -39399,6 +39683,12 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" } ], "responses": { @@ -40464,6 +40754,24 @@ }, { "$ref": "#/components/parameters/count" + }, + { + "name": "filter", + "description": "filter results", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "excludedAttributes", + "description": "attributes to exclude", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -40610,6 +40918,15 @@ }, { "$ref": "#/components/parameters/scim_group_id" + }, + { + "name": "excludedAttributes", + "description": "Attributes to exclude.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -40920,6 +41237,15 @@ }, { "$ref": "#/components/parameters/count" + }, + { + "name": "filter", + "description": "filter results", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -46933,6 +47259,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -48242,6 +48569,15 @@ }, { "$ref": "#/components/parameters/package_name" + }, + { + "name": "token", + "description": "package token", + "schema": { + "type": "string" + }, + "required": false, + "in": "query" } ], "responses": { @@ -48276,7 +48612,7 @@ "tags": [ "packages" ], - "operationId": "packages/get-all-package-versions-for-a-package-owned-by-the-authenticated-user", + "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" @@ -48287,6 +48623,26 @@ }, { "$ref": "#/components/parameters/package_name" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "name": "state", + "in": "query", + "required": false, + "description": "The state of the package, either active or deleted.", + "schema": { + "type": "string", + "enum": [ + "active", + "deleted" + ], + "default": "active" + } } ], "responses": { @@ -61366,13 +61722,14 @@ }, "code-scanning-ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "code-scanning-alert-state": { "type": "string", "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -91016,6 +91373,7 @@ "schema": { "type": "string", "enum": [ + "", "day", "week" ], diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 88453c306d..250bab7e8d 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -625,6 +625,12 @@ paths: parameters: - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -1173,6 +1179,12 @@ paths: parameters: - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -2832,6 +2844,7 @@ paths: - "$ref": "#/components/parameters/audit-log-after" - "$ref": "#/components/parameters/audit-log-before" - "$ref": "#/components/parameters/audit-log-order" + - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/per_page" responses: '200': @@ -4004,6 +4017,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -4109,6 +4123,7 @@ paths: schema: type: boolean - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -5696,6 +5711,8 @@ paths: parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner_group_id" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" responses: '200': description: response @@ -6482,6 +6499,8 @@ paths: parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret_name" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" responses: '200': description: response @@ -6644,6 +6663,7 @@ paths: - "$ref": "#/components/parameters/audit-log-before" - "$ref": "#/components/parameters/audit-log-order" - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: Response @@ -7649,6 +7669,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -7984,6 +8005,17 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: exclude + description: Exclude attributes from the API response to improve performance + in: query + schema: + type: array + items: + description: Allowed values that can be passed to the exclude param. + enum: + - repositories + example: repositories + type: string responses: '200': description: response @@ -8096,6 +8128,17 @@ paths: parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/migration_id" + - name: exclude + description: Exclude attributes from the API response to improve performance + in: query + schema: + type: array + items: + description: Allowed values that can be passed to the exclude param. + enum: + - repositories + example: repositories + type: string responses: '200': description: |- @@ -8493,6 +8536,12 @@ paths: - "$ref": "#/components/parameters/package_type" - "$ref": "#/components/parameters/package_name" - "$ref": "#/components/parameters/org" + - name: token + description: package token + schema: + type: string + required: false + in: query responses: '204': description: Empty response @@ -8518,7 +8567,7 @@ paths: If `package_type` is not `container`, your token must also include the `repo` scope. tags: - packages - operationId: packages/get-all-package-versions-for-a-package-owned-by-an-org + operationId: packages/get-all-package-versions-for-package-owned-by-org externalDocs: description: API method documentation url: https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user @@ -8526,6 +8575,18 @@ paths: - "$ref": "#/components/parameters/package_type" - "$ref": "#/components/parameters/package_name" - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" + - name: state + in: query + required: false + description: The state of the package, either active or deleted. + schema: + type: string + enum: + - active + - deleted + default: active responses: '200': description: response @@ -9270,7 +9331,11 @@ paths: parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per_page" - - "$ref": "#/components/parameters/page" + - name: page + description: Page token + in: query + schema: + type: string responses: '200': description: response @@ -9582,6 +9647,12 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: pinned + in: query + required: false + description: Pinned discussions only filter + schema: + type: string responses: '200': description: response @@ -16970,7 +17041,7 @@ paths: The response includes a `most_recent_instance` object. This provides details of the most recent instance of this alert - for the the default branch or for the specified Git reference + for the default branch or for the specified Git reference (if you used `ref` in the request). tags: - code-scanning @@ -17378,6 +17449,7 @@ paths: required: false schema: type: string + nullable: true responses: '200': description: response @@ -17407,6 +17479,10 @@ paths: description: |- Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. + There are two places where you can upload code scanning results. + - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)." + - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." + You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example: ``` @@ -18157,6 +18233,20 @@ paths: type: string - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -18449,8 +18539,10 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -18495,7 +18587,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -18516,6 +18608,11 @@ paths: default: latest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -18562,7 +18659,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -18630,12 +18727,14 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -18671,7 +18770,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -18910,7 +19009,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -18971,7 +19070,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -19107,7 +19206,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -19275,6 +19374,7 @@ paths: schema: type: string default: none + nullable: true - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" responses: @@ -20119,9 +20219,24 @@ paths: - newest - oldest - stargazers + - watchers default: newest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -20160,11 +20275,26 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -20543,7 +20673,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -20589,7 +20719,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -20688,7 +20818,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -20745,7 +20875,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -21074,6 +21204,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -25373,7 +25504,15 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/sort" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -27057,6 +27196,56 @@ paths: previews: [] category: repos subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/repos#get-a-repository-readme + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/content-file" + examples: + default: + "$ref": "#/components/examples/content-file" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents "/repos/{owner}/{repo}/releases": get: summary: List releases @@ -27336,7 +27525,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -28301,6 +28490,8 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" responses: '200': description: response @@ -29119,6 +29310,18 @@ paths: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/start_index" - "$ref": "#/components/parameters/count" + - name: filter + description: filter results + in: query + required: false + schema: + type: string + - name: excludedAttributes + description: attributes to exclude + in: query + required: false + schema: + type: string responses: '200': description: response @@ -29214,6 +29417,12 @@ paths: parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/scim_group_id" + - name: excludedAttributes + description: Attributes to exclude. + in: query + required: false + schema: + type: string responses: '200': description: response @@ -29428,6 +29637,12 @@ paths: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/start_index" - "$ref": "#/components/parameters/count" + - name: filter + description: filter results + in: query + required: false + schema: + type: string responses: '200': description: response @@ -33854,6 +34069,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -34791,6 +35007,12 @@ paths: parameters: - "$ref": "#/components/parameters/package_type" - "$ref": "#/components/parameters/package_name" + - name: token + description: package token + schema: + type: string + required: false + in: query responses: '204': description: Empty response @@ -34816,13 +35038,25 @@ paths: If `package_type` is not `container`, your token must also include the `repo` scope. tags: - packages - operationId: packages/get-all-package-versions-for-a-package-owned-by-the-authenticated-user + operationId: packages/get-all-package-versions-for-package-owned-by-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - "$ref": "#/components/parameters/package_type" - "$ref": "#/components/parameters/package_name" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" + - name: state + in: query + required: false + description: The state of the package, either active or deleted. + schema: + type: string + enum: + - active + - deleted + default: active responses: '200': description: response @@ -44606,12 +44840,15 @@ components: if provided in the uploaded SARIF data. code-scanning-ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. code-scanning-alert-state: type: string description: State of a code scanning alert. enum: - open + - closed - dismissed - fixed alert-number: @@ -69369,6 +69606,7 @@ components: schema: type: string enum: + - '' - day - week default: day diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 290e985a82..b89d66e5ac 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -4257,6 +4257,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -9931,6 +9940,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -21390,6 +21408,15 @@ ] } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, { "name": "per_page", "description": "Results per page (max 100).", @@ -32289,6 +32316,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -34988,6 +35016,15 @@ "type": "integer", "default": 30 } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -48089,6 +48126,24 @@ "schema": { "type": "integer" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -52926,6 +52981,24 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -54793,6 +54866,15 @@ "type": "integer", "default": 30 } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -62526,6 +62608,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -66590,6 +66673,22 @@ "type": "integer", "default": 1 } + }, + { + "name": "exclude", + "description": "Exclude attributes from the API response to improve performance", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "example": "repositories", + "type": "string" + } + } } ], "responses": { @@ -69444,6 +69543,22 @@ "schema": { "type": "integer" } + }, + { + "name": "exclude", + "description": "Exclude attributes from the API response to improve performance", + "in": "query", + "schema": { + "type": "array", + "items": { + "description": "Allowed values that can be passed to the exclude param.", + "enum": [ + "repositories" + ], + "example": "repositories", + "type": "string" + } + } } ], "responses": { @@ -75183,6 +75298,15 @@ "schema": { "type": "string" } + }, + { + "name": "token", + "description": "package token", + "schema": { + "type": "string" + }, + "required": false, + "in": "query" } ], "responses": { @@ -75268,7 +75392,7 @@ "tags": [ "packages" ], - "operationId": "packages/get-all-package-versions-for-a-package-owned-by-an-org", + "operationId": "packages/get-all-package-versions-for-package-owned-by-org", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" @@ -75307,6 +75431,38 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "state", + "in": "query", + "required": false, + "description": "The state of the package, either active or deleted.", + "schema": { + "type": "string", + "enum": [ + "active", + "deleted" + ], + "default": "active" + } } ], "responses": { @@ -80617,11 +80773,10 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "Page token", "in": "query", "schema": { - "type": "integer", - "default": 1 + "type": "string" } } ], @@ -82899,6 +83054,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { @@ -150229,7 +150393,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. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "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. GitHub Apps must have the `security_events` read permission to use\nthis 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).", "tags": [ "code-scanning" ], @@ -150301,7 +150465,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } }, { @@ -150314,6 +150478,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -150369,6 +150534,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -150564,7 +150730,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -150579,6 +150745,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -150926,6 +151093,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -151136,7 +151304,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -151151,6 +151319,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -151502,6 +151671,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -151712,7 +151882,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -151727,6 +151897,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -152011,7 +152182,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } } ], @@ -152027,7 +152198,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -152042,6 +152213,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -152296,7 +152468,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } }, { @@ -152324,7 +152496,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "commit_sha": { "description": "The SHA of the commit to which the analysis you are uploading relates.", @@ -152585,7 +152757,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "commit_sha": { "description": "The SHA of the commit to which the analysis you are uploading relates.", @@ -152818,7 +152990,8 @@ "description": "Allow deletion if the specified analysis is the last in a set. The parameter can be used without a value as the parameter value is not considered. If you attempt to delete the final analysis in a set without using this parameter you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`", "required": false, "schema": { - "type": "string" + "type": "string", + "nullable": true } } ], @@ -152993,7 +153166,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -153035,7 +153208,7 @@ }, "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "sarif": { "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning).\"", @@ -158253,6 +158426,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -164118,9 +164311,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -164865,7 +165076,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -164927,6 +165138,14 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -165914,7 +166133,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -168212,13 +168431,31 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -169980,7 +170217,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -172631,7 +172868,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -173346,7 +173583,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -174038,7 +174275,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -174761,7 +174998,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -183338,7 +183576,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -183360,6 +183599,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -185080,6 +185339,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -185087,6 +185366,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -187567,7 +187847,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -187729,7 +188009,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -188089,7 +188369,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -188304,7 +188584,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -189320,7 +189600,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -242315,16 +242596,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -262972,6 +263252,279 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -265459,7 +266012,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -271260,6 +271813,24 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -271574,6 +272145,7 @@ "schema": { "type": "string", "enum": [ + "", "day", "week" ], @@ -272078,6 +272650,7 @@ "schema": { "type": "string", "enum": [ + "", "day", "week" ], @@ -277009,6 +277582,24 @@ "schema": { "type": "integer" } + }, + { + "name": "filter", + "description": "filter results", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "excludedAttributes", + "description": "attributes to exclude", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -277396,6 +277987,15 @@ "schema": { "type": "string" } + }, + { + "name": "excludedAttributes", + "description": "Attributes to exclude.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -277998,6 +278598,15 @@ "schema": { "type": "integer" } + }, + { + "name": "filter", + "description": "filter results", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -310308,6 +310917,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -324163,6 +324773,15 @@ "schema": { "type": "string" } + }, + { + "name": "token", + "description": "package token", + "schema": { + "type": "string" + }, + "required": false, + "in": "query" } ], "responses": { @@ -324248,7 +324867,7 @@ "tags": [ "packages" ], - "operationId": "packages/get-all-package-versions-for-a-package-owned-by-the-authenticated-user", + "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" @@ -324279,6 +324898,38 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "state", + "in": "query", + "required": false, + "description": "The state of the package, either active or deleted.", + "schema": { + "type": "string", + "enum": [ + "active", + "deleted" + ], + "default": "active" + } } ], "responses": { diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 97bf32ad5b..5c5e0c3d35 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -2452,6 +2452,12 @@ paths: description: Page number of the results to fetch. in: query schema: *14 + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -3429,6 +3435,12 @@ paths: description: Page number of the results to fetch. in: query schema: *14 + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -6148,6 +6160,10 @@ paths: enum: - desc - asc + - name: page + description: Page number of the results to fetch. + in: query + schema: *14 - name: per_page description: Results per page (max 100). in: query @@ -9073,6 +9089,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -9679,6 +9696,10 @@ paths: description: Results per page (max 100). in: query schema: *13 + - name: page + description: Page number of the results to fetch. + in: query + schema: *14 responses: '200': description: response @@ -11780,7 +11801,7 @@ paths: required: *48 examples: default: - value: &482 + value: &483 - login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= @@ -13230,6 +13251,14 @@ paths: in: path required: true schema: *46 + - name: page + description: Page number of the results to fetch. + in: query + schema: *14 + - name: per_page + description: Results per page (max 100). + in: query + schema: *13 responses: '200': description: response @@ -14273,6 +14302,14 @@ paths: in: path required: true schema: *121 + - name: page + description: Page number of the results to fetch. + in: query + schema: *14 + - name: per_page + description: Results per page (max 100). + in: query + schema: *13 responses: '200': description: response @@ -14567,6 +14604,10 @@ paths: description: Results per page (max 100). in: query schema: *13 + - name: page + description: Page number of the results to fetch. + in: query + schema: *14 responses: '200': description: Response @@ -16424,6 +16465,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -17085,6 +17127,17 @@ paths: description: Page number of the results to fetch. in: query schema: *14 + - name: exclude + description: Exclude attributes from the API response to improve performance + in: query + schema: + type: array + items: + description: Allowed values that can be passed to the exclude param. + enum: + - repositories + example: repositories + type: string responses: '200': description: response @@ -17572,6 +17625,17 @@ paths: required: true schema: &154 type: integer + - name: exclude + description: Exclude attributes from the API response to improve performance + in: query + schema: + type: array + items: + description: Allowed values that can be passed to the exclude param. + enum: + - repositories + example: repositories + type: string responses: '200': description: |- @@ -17855,7 +17919,7 @@ paths: description: repo_name parameter in: path required: true - schema: &481 + schema: &482 type: string responses: '204': @@ -18370,7 +18434,7 @@ paths: title: Package description: A software package type: object - properties: &483 + properties: &484 id: description: Unique identifier of the package. type: integer @@ -18428,7 +18492,7 @@ paths: updated_at: type: string format: date-time - required: &484 + required: &485 - id - name - package_type @@ -18560,6 +18624,12 @@ paths: in: path required: true schema: *100 + - name: token + description: package token + schema: + type: string + required: false + in: query responses: '204': description: Empty response @@ -18588,7 +18658,7 @@ paths: If `package_type` is not `container`, your token must also include the `repo` scope. tags: - packages - operationId: packages/get-all-package-versions-for-a-package-owned-by-an-org + operationId: packages/get-all-package-versions-for-package-owned-by-org externalDocs: description: API method documentation url: https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user @@ -18609,6 +18679,24 @@ paths: in: path required: true schema: *100 + - name: page + description: Page number of the results to fetch. + in: query + schema: *14 + - name: per_page + description: Results per page (max 100). + in: query + schema: *13 + - name: state + in: query + required: false + description: The state of the package, either active or deleted. + schema: + type: string + enum: + - active + - deleted + default: active responses: '200': description: response @@ -19894,9 +19982,10 @@ paths: in: query schema: *13 - name: page - description: Page number of the results to fetch. + description: Page token in: query - schema: *14 + schema: + type: string responses: '200': description: response @@ -20475,6 +20564,12 @@ paths: description: Page number of the results to fetch. in: query schema: *14 + - name: pinned + in: query + required: false + description: Pinned discussions only filter + schema: + type: string responses: '200': description: response @@ -20588,7 +20683,7 @@ paths: - url examples: default: - value: &452 + value: &453 - author: login: octocat id: 1 @@ -20898,7 +20993,7 @@ paths: required: *183 examples: default: - value: &453 + value: &454 author: login: octocat id: 1 @@ -21123,7 +21218,7 @@ paths: - url examples: default: - value: &454 + value: &455 - author: login: octocat id: 1 @@ -21417,7 +21512,7 @@ paths: required: *187 examples: default: - value: &455 + value: &456 author: login: octocat id: 1 @@ -22239,19 +22334,19 @@ paths: examples: response-if-user-has-an-active-membership-with-team: summary: Response if user has an active membership with team - value: &456 + value: &457 url: https://api.github.com/teams/1/memberships/octocat role: member state: active response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer - value: &457 + value: &458 url: https://api.github.com/teams/1/memberships/octocat role: maintainer state: active response-if-user-has-a-pending-membership-with-team: summary: Response if user has a pending membership with team - value: &458 + value: &459 url: https://api.github.com/teams/1/memberships/octocat role: member state: pending @@ -22328,13 +22423,13 @@ paths: examples: response-if-users-membership-with-team-is-now-active: summary: Response if user's membership with team is now active - value: &459 + value: &460 url: https://api.github.com/teams/1/memberships/octocat role: member state: active response-if-users-membership-with-team-is-now-pending: summary: Response if user's membership with team is now pending - value: &460 + value: &461 url: https://api.github.com/teams/1/memberships/octocat role: member state: pending @@ -22528,7 +22623,7 @@ paths: - permissions examples: default: - value: &461 + value: &462 - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 html_url: https://github.com/orgs/api-playground/projects/1 @@ -22625,7 +22720,7 @@ paths: required: *198 examples: default: - value: &462 + value: &463 owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 html_url: https://github.com/orgs/api-playground/projects/1 @@ -22896,7 +22991,7 @@ paths: title: Team Repository description: A team's access to a repository. type: object - properties: &463 + properties: &464 id: description: Unique identifier of the repository example: 42 @@ -23231,7 +23326,7 @@ paths: type: integer master_branch: type: string - required: &464 + required: &465 - archive_url - assignees_url - blobs_url @@ -23834,7 +23929,7 @@ paths: required: *174 examples: response-if-child-teams-exist: - value: &465 + value: &466 - id: 2 node_id: MDQ6VGVhbTI= url: https://api.github.com/teams/2 @@ -30625,7 +30720,7 @@ paths: - updated_at examples: default: - value: &430 + value: &431 total_count: 2 secrets: - name: GH_TOKEN @@ -30728,7 +30823,7 @@ paths: required: *231 examples: default: - value: &431 + value: &432 name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' @@ -37171,7 +37266,7 @@ paths: The response includes a `most_recent_instance` object. This provides details of the most recent instance of this alert - for the the default branch or for the specified Git reference + for the default branch or for the specified Git reference (if you used `ref` in the request). tags: - code-scanning @@ -37225,7 +37320,9 @@ paths: required: false schema: &281 type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. - name: state description: Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state. @@ -37236,6 +37333,7 @@ paths: description: State of a code scanning alert. enum: &272 - open + - closed - dismissed - fixed responses: @@ -37356,8 +37454,9 @@ paths: properties: &276 ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. analysis_key: type: string description: Identifies the configuration under which the @@ -38094,7 +38193,9 @@ paths: required: false schema: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. @@ -38116,8 +38217,9 @@ paths: properties: &284 ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. commit_sha: description: The SHA of the commit to which the analysis you are uploading relates. @@ -38425,6 +38527,7 @@ paths: required: false schema: type: string + nullable: true responses: '200': description: response @@ -38472,7 +38575,7 @@ paths: title: Scim Error description: Scim Error type: object - properties: &442 + properties: &443 message: type: string nullable: true @@ -38512,6 +38615,10 @@ paths: description: |- Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. + There are two places where you can upload code scanning results. + - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)." + - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." + You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example: ``` @@ -38553,8 +38660,9 @@ paths: pattern: "^[0-9a-fA-F]+$" ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. sarif: description: A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) @@ -39991,6 +40099,20 @@ paths: description: Page number of the results to fetch. in: query schema: *14 + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -41306,8 +41428,16 @@ paths: in: path required: true schema: *201 + - name: page + description: Page number of the results to fetch. + in: query + schema: *14 + - name: per_page + description: Results per page (max 100). + in: query + schema: *13 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -41446,7 +41576,7 @@ paths: required: true schema: *201 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -41482,6 +41612,11 @@ paths: description: Page number of the results to fetch. in: query schema: *14 + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -41540,7 +41675,7 @@ paths: required: true schema: *201 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -41801,12 +41936,20 @@ paths: required: true schema: *201 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - name: per_page + description: Results per page (max 100). + in: query + schema: *13 + - name: page + description: Page number of the results to fetch. + in: query + schema: *14 responses: '200': description: response @@ -42018,7 +42161,7 @@ paths: required: true schema: *201 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -42043,7 +42186,7 @@ paths: title: Status description: The status of a commit. type: object - properties: &420 + properties: &421 url: type: string avatar_url: @@ -42072,7 +42215,7 @@ paths: properties: *5 required: *6 nullable: true - required: &421 + required: &422 - url - avatar_url - id @@ -42890,7 +43033,7 @@ paths: required: true schema: *201 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -43403,7 +43546,7 @@ paths: required: true schema: *201 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -43731,7 +43874,7 @@ paths: required: true schema: *201 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -44032,6 +44175,7 @@ paths: schema: type: string default: none + nullable: true - name: per_page description: Results per page (max 100). in: query @@ -45606,6 +45750,7 @@ paths: - newest - oldest - stargazers + - watchers default: newest - name: per_page description: Results per page (max 100). @@ -45615,6 +45760,20 @@ paths: description: Page number of the results to fetch. in: query schema: *14 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -45774,11 +45933,26 @@ paths: in: path required: true schema: *201 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -46430,7 +46604,7 @@ paths: required: true schema: *201 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -46537,7 +46711,7 @@ paths: required: true schema: *201 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -46665,7 +46839,7 @@ paths: required: true schema: *201 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -46733,7 +46907,7 @@ paths: required: true schema: *201 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -47252,6 +47426,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -48518,7 +48693,7 @@ paths: description: A user ID. Only return users with an ID greater than this ID. in: query required: false - schema: &488 + schema: &489 type: integer responses: '200': @@ -49016,7 +49191,7 @@ paths: required: *350 examples: default: - value: &486 + value: &487 - id: 1 repository: id: 1296269 @@ -56757,11 +56932,14 @@ paths: required: true schema: *201 - name: sort - description: One of `created` (when the repository was starred) or `updated` - (when it was last pushed to). in: query required: false - schema: *90 + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -60362,7 +60540,7 @@ paths: required: *407 examples: default: - value: + value: &408 type: file encoding: base64 size: 5362 @@ -60390,6 +60568,68 @@ paths: previews: [] category: repos subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/repos#get-a-repository-readme + parameters: + - name: owner + in: path + required: true + schema: *200 + - name: repo + in: path + required: true + schema: *201 + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + title: Content File + description: Content File + type: object + properties: *406 + required: *407 + examples: + default: + value: *408 + '404': + description: Resource Not Found + content: *9 + '422': + description: Validation Failed + content: *21 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents "/repos/{owner}/{repo}/releases": get: summary: List releases @@ -60431,7 +60671,7 @@ paths: title: Release description: A release. type: object - properties: &408 + properties: &409 url: type: string format: uri @@ -60500,7 +60740,7 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: &410 + properties: &411 url: type: string format: uri @@ -60545,7 +60785,7 @@ paths: properties: *5 required: *6 nullable: true - required: &411 + required: &412 - id - name - content_type @@ -60563,7 +60803,7 @@ paths: type: string body_text: type: string - required: &409 + required: &410 - assets_url - upload_url - tarball_url @@ -60735,11 +60975,11 @@ paths: title: Release description: A release. type: object - properties: *408 - required: *409 + properties: *409 + required: *410 examples: default: - value: &414 + value: &415 url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 assets_url: https://api.github.com/repos/octocat/Hello-World/releases/1/assets @@ -60848,7 +61088,7 @@ paths: description: asset_id parameter in: path required: true - schema: &412 + schema: &413 type: integer responses: '200': @@ -60863,11 +61103,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *410 - required: *411 + properties: *411 + required: *412 examples: default: - value: &413 + value: &414 url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip id: 1 @@ -60935,7 +61175,7 @@ paths: description: asset_id parameter in: path required: true - schema: *412 + schema: *413 requestBody: content: application/json: @@ -60964,11 +61204,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *410 - required: *411 + properties: *411 + required: *412 examples: default: - value: *413 + value: *414 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60997,7 +61237,7 @@ paths: description: asset_id parameter in: path required: true - schema: *412 + schema: *413 responses: '204': description: Empty response @@ -61038,11 +61278,11 @@ paths: title: Release description: A release. type: object - properties: *408 - required: *409 + properties: *409 + required: *410 examples: default: - value: *414 + value: *415 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61069,7 +61309,7 @@ paths: required: true schema: *201 - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -61084,11 +61324,11 @@ paths: title: Release description: A release. type: object - properties: *408 - required: *409 + properties: *409 + required: *410 examples: default: - value: *414 + value: *415 '404': description: Resource Not Found content: *9 @@ -61122,7 +61362,7 @@ paths: description: release_id parameter in: path required: true - schema: &415 + schema: &416 type: integer responses: '200': @@ -61134,11 +61374,11 @@ paths: title: Release description: A release. type: object - properties: *408 - required: *409 + properties: *409 + required: *410 examples: default: - value: *414 + value: *415 '404': description: Resource Not Found content: *9 @@ -61170,7 +61410,7 @@ paths: description: release_id parameter in: path required: true - schema: *415 + schema: *416 requestBody: content: application/json: @@ -61216,11 +61456,11 @@ paths: title: Release description: A release. type: object - properties: *408 - required: *409 + properties: *409 + required: *410 examples: default: - value: *414 + value: *415 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61249,7 +61489,7 @@ paths: description: release_id parameter in: path required: true - schema: *415 + schema: *416 responses: '204': description: Empty response @@ -61282,7 +61522,7 @@ paths: description: release_id parameter in: path required: true - schema: *415 + schema: *416 - name: per_page description: Results per page (max 100). in: query @@ -61302,8 +61542,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *410 - required: *411 + properties: *411 + required: *412 examples: default: value: @@ -61399,7 +61639,7 @@ paths: description: release_id parameter in: path required: true - schema: *415 + schema: *416 - name: name in: query schema: @@ -61423,8 +61663,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *410 - required: *411 + properties: *411 + required: *412 examples: response-for-successful-upload: value: @@ -61514,7 +61754,7 @@ paths: type: array items: type: object - properties: &416 + properties: &417 number: type: integer description: The security alert number. @@ -61544,7 +61784,7 @@ paths: be either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. type: string - enum: &417 + enum: &418 - open - resolved resolution: @@ -61553,7 +61793,7 @@ paths: reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`." nullable: true - oneOf: &418 + oneOf: &419 - enum: - false_positive - wont_fix @@ -61670,7 +61910,7 @@ paths: application/json: schema: type: object - properties: *416 + properties: *417 examples: default: value: @@ -61736,14 +61976,14 @@ paths: either `open` or `resolved`. You must provide `resolution` when you set the state to `resolved`. type: string - enum: *417 + enum: *418 resolution: type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`." nullable: true - oneOf: *418 + oneOf: *419 required: - state example: @@ -61756,7 +61996,7 @@ paths: application/json: schema: type: object - properties: *416 + properties: *417 examples: default: value: @@ -61960,7 +62200,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: &419 + items: &420 type: integer examples: default: @@ -62356,7 +62596,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: *419 + items: *420 examples: default: value: @@ -62450,8 +62690,8 @@ paths: title: Status description: The status of a commit. type: object - properties: *420 - required: *421 + properties: *421 + required: *422 examples: default: value: @@ -62579,7 +62819,7 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: &422 + properties: &423 subscribed: description: Determines if notifications should be received from this repository. @@ -62604,7 +62844,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/example - required: &423 + required: &424 - created_at - ignored - reason @@ -62677,8 +62917,8 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: *422 - required: *423 + properties: *423 + required: *424 examples: default: value: @@ -62929,6 +63169,14 @@ paths: in: path required: true schema: *201 + - name: page + description: Page number of the results to fetch. + in: query + schema: *14 + - name: per_page + description: Results per page (max 100). + in: query + schema: *13 responses: '200': description: response @@ -62938,16 +63186,16 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: &424 + properties: &425 names: type: array items: type: string - required: &425 + required: &426 - names examples: default: - value: &426 + value: &427 names: - octocat - atom @@ -63021,11 +63269,11 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: *424 - required: *425 + properties: *425 + required: *426 examples: default: - value: *426 + value: *427 '415': description: Preview Header Missing content: *12 @@ -63073,9 +63321,10 @@ paths: description: 'Must be one of: `day`, `week`.' in: query required: false - schema: &427 + schema: &428 type: string enum: + - '' - day - week default: day @@ -63100,7 +63349,7 @@ paths: items: title: Traffic type: object - properties: &428 + properties: &429 timestamp: type: string format: date-time @@ -63108,7 +63357,7 @@ paths: type: integer count: type: integer - required: &429 + required: &430 - timestamp - uniques - count @@ -63369,7 +63618,7 @@ paths: description: 'Must be one of: `day`, `week`.' in: query required: false - schema: *427 + schema: *428 responses: '200': description: response @@ -63391,8 +63640,8 @@ paths: items: title: Traffic type: object - properties: *428 - required: *429 + properties: *429 + required: *430 required: - uniques - count @@ -64058,7 +64307,7 @@ paths: required: *231 examples: default: - value: *430 + value: *431 headers: Link: example: ; rel="next", ; @@ -64156,7 +64405,7 @@ paths: required: *231 examples: default: - value: *431 + value: *432 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64349,14 +64598,26 @@ paths: description: 'Used for pagination: the index of the first result to return.' in: query required: false - schema: &436 + schema: &437 type: integer - name: count description: 'Used for pagination: the number of results to return.' in: query required: false - schema: &437 + schema: &438 type: integer + - name: filter + description: filter results + in: query + required: false + schema: + type: string + - name: excludedAttributes + description: attributes to exclude + in: query + required: false + schema: + type: string responses: '200': description: response @@ -64529,7 +64790,7 @@ paths: application/json: schema: type: object - properties: &432 + properties: &433 schemas: type: array items: @@ -64563,12 +64824,12 @@ paths: type: string location: type: string - required: &433 + required: &434 - schemas - id examples: default: - value: &434 + value: &435 schemas: - urn:ietf:params:scim:schemas:core:2.0:Group id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc @@ -64614,7 +64875,13 @@ paths: description: Identifier generated by the GitHub SCIM endpoint. in: path required: true - schema: &435 + schema: &436 + type: string + - name: excludedAttributes + description: Attributes to exclude. + in: query + required: false + schema: type: string responses: '200': @@ -64623,11 +64890,11 @@ paths: application/json: schema: type: object - properties: *432 - required: *433 + properties: *433 + required: *434 examples: default: - value: *434 + value: *435 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -64657,7 +64924,7 @@ paths: description: Identifier generated by the GitHub SCIM endpoint. in: path required: true - schema: *435 + schema: *436 requestBody: content: application/json: @@ -64700,11 +64967,11 @@ paths: application/json: schema: type: object - properties: *432 - required: *433 + properties: *433 + required: *434 examples: default: - value: *434 + value: *435 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -64734,7 +65001,7 @@ paths: description: Identifier generated by the GitHub SCIM endpoint. in: path required: true - schema: *435 + schema: *436 requestBody: content: application/json: @@ -64789,8 +65056,8 @@ paths: application/json: schema: type: object - properties: *432 - required: *433 + properties: *433 + required: *434 examples: default: value: @@ -64835,7 +65102,7 @@ paths: description: Identifier generated by the GitHub SCIM endpoint. in: path required: true - schema: *435 + schema: *436 responses: '204': description: Empty response @@ -64884,12 +65151,18 @@ paths: description: 'Used for pagination: the index of the first result to return.' in: query required: false - schema: *436 + schema: *437 - name: count description: 'Used for pagination: the number of results to return.' in: query required: false - schema: *437 + schema: *438 + - name: filter + description: filter results + in: query + required: false + schema: + type: string responses: '200': description: response @@ -65123,7 +65396,7 @@ paths: application/json: schema: type: object - properties: &438 + properties: &439 schemas: type: array items: @@ -65172,12 +65445,12 @@ paths: type: string location: type: string - required: &439 + required: &440 - schemas - id examples: default: - value: &440 + value: &441 schemas: - urn:ietf:params:scim:schemas:core:2.0:User id: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc @@ -65226,7 +65499,7 @@ paths: description: scim_user_id parameter in: path required: true - schema: &441 + schema: &442 type: string responses: '200': @@ -65235,11 +65508,11 @@ paths: application/json: schema: type: object - properties: *438 - required: *439 + properties: *439 + required: *440 examples: default: - value: *440 + value: *441 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -65273,7 +65546,7 @@ paths: description: scim_user_id parameter in: path required: true - schema: *441 + schema: *442 requestBody: content: application/json: @@ -65352,11 +65625,11 @@ paths: application/json: schema: type: object - properties: *438 - required: *439 + properties: *439 + required: *440 examples: default: - value: *440 + value: *441 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -65401,7 +65674,7 @@ paths: description: scim_user_id parameter in: path required: true - schema: *441 + schema: *442 requestBody: content: application/json: @@ -65440,8 +65713,8 @@ paths: application/json: schema: type: object - properties: *438 - required: *439 + properties: *439 + required: *440 examples: default: value: @@ -65494,7 +65767,7 @@ paths: description: scim_user_id parameter in: path required: true - schema: *441 + schema: *442 responses: '204': description: Empty response @@ -65592,7 +65865,7 @@ paths: title: SCIM /Users description: SCIM /Users provisioning endpoints type: object - properties: &443 + properties: &444 schemas: description: SCIM schema used. type: array @@ -65718,7 +65991,7 @@ paths: type: string display: type: string - required: &444 + required: &445 - id - schemas - externalId @@ -65813,49 +66086,49 @@ paths: description: Not Modified '404': description: Resource Not Found - content: &445 + content: &446 application/json: schema: title: Scim Error description: Scim Error type: object - properties: *442 + properties: *443 application/scim+json: schema: title: Scim Error description: Scim Error type: object - properties: *442 + properties: *443 '403': description: Forbidden - content: &446 + content: &447 application/json: schema: title: Scim Error description: Scim Error type: object - properties: *442 + properties: *443 application/scim+json: schema: title: Scim Error description: Scim Error type: object - properties: *442 + properties: *443 '400': description: Bad Request - content: &447 + content: &448 application/json: schema: title: Scim Error description: Scim Error type: object - properties: *442 + properties: *443 application/scim+json: schema: title: Scim Error description: Scim Error type: object - properties: *442 + properties: *443 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -65886,11 +66159,11 @@ paths: title: SCIM /Users description: SCIM /Users provisioning endpoints type: object - properties: *443 - required: *444 + properties: *444 + required: *445 examples: default: - value: &448 + value: &449 schemas: - urn:ietf:params:scim:schemas:core:2.0:User id: edefdfedf-050c-11e7-8d32 @@ -65915,10 +66188,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *445 + content: *446 '403': description: Forbidden - content: *446 + content: *447 '500': description: Internal Error content: @@ -65927,13 +66200,13 @@ paths: title: Scim Error description: Scim Error type: object - properties: *442 + properties: *443 application/scim+json: schema: title: Scim Error description: Scim Error type: object - properties: *442 + properties: *443 '409': description: Conflict content: @@ -65942,16 +66215,16 @@ paths: title: Scim Error description: Scim Error type: object - properties: *442 + properties: *443 application/scim+json: schema: title: Scim Error description: Scim Error type: object - properties: *442 + properties: *443 '400': description: Bad Request - content: *447 + content: *448 requestBody: content: application/json: @@ -66043,7 +66316,7 @@ paths: description: scim_user_id parameter in: path required: true - schema: *441 + schema: *442 responses: '200': description: response @@ -66053,17 +66326,17 @@ paths: title: SCIM /Users description: SCIM /Users provisioning endpoints type: object - properties: *443 - required: *444 + properties: *444 + required: *445 examples: default: - value: *448 + value: *449 '404': description: Resource Not Found - content: *445 + content: *446 '403': description: Forbidden - content: *446 + content: *447 '304': description: Not Modified x-github: @@ -66095,7 +66368,7 @@ paths: description: scim_user_id parameter in: path required: true - schema: *441 + schema: *442 responses: '200': description: response @@ -66105,19 +66378,19 @@ paths: title: SCIM /Users description: SCIM /Users provisioning endpoints type: object - properties: *443 - required: *444 + properties: *444 + required: *445 examples: default: - value: *448 + value: *449 '304': description: Not Modified '404': description: Resource Not Found - content: *445 + content: *446 '403': description: Forbidden - content: *446 + content: *447 requestBody: content: application/json: @@ -66224,7 +66497,7 @@ paths: description: scim_user_id parameter in: path required: true - schema: *441 + schema: *442 responses: '200': description: response @@ -66234,22 +66507,22 @@ paths: title: SCIM /Users description: SCIM /Users provisioning endpoints type: object - properties: *443 - required: *444 + properties: *444 + required: *445 examples: default: - value: *448 + value: *449 '304': description: Not Modified '404': description: Resource Not Found - content: *445 + content: *446 '403': description: Forbidden - content: *446 + content: *447 '400': description: Bad Request - content: *447 + content: *448 '429': description: Too many requests content: @@ -66344,16 +66617,16 @@ paths: description: scim_user_id parameter in: path required: true - schema: *441 + schema: *442 responses: '204': description: Empty response '404': description: Resource Not Found - content: *445 + content: *446 '403': description: Forbidden - content: *446 + content: *447 '304': description: Not Modified x-github: @@ -66418,7 +66691,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: &449 + schema: &450 type: string enum: - desc @@ -66496,7 +66769,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: &450 + items: &451 type: object properties: object_url: @@ -66669,7 +66942,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *449 + schema: *450 - name: per_page description: Results per page (max 100). in: query @@ -66807,7 +67080,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *450 + items: *451 required: - sha - node_id @@ -67018,7 +67291,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *449 + schema: *450 - name: per_page description: Results per page (max 100). in: query @@ -67153,7 +67426,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *450 + items: *451 pull_request: type: object properties: @@ -67401,7 +67674,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *449 + schema: *450 responses: '200': description: response @@ -67446,7 +67719,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *450 + items: *451 required: - id - node_id @@ -67549,7 +67822,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *449 + schema: *450 - name: per_page description: Results per page (max 100). in: query @@ -67790,7 +68063,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *450 + items: *451 temp_clone_token: type: string allow_merge_commit: @@ -68094,7 +68367,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *450 + items: *451 related: type: array nullable: true @@ -68301,7 +68574,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *449 + schema: *450 - name: per_page description: Results per page (max 100). in: query @@ -68413,7 +68686,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *450 + items: *451 blog: type: string nullable: true @@ -68500,7 +68773,7 @@ paths: - name: team_id in: path required: true - schema: &451 + schema: &452 type: integer responses: '200': @@ -68547,7 +68820,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 requestBody: content: application/json: @@ -68647,7 +68920,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 responses: '204': description: Empty response @@ -68683,7 +68956,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query @@ -68713,7 +68986,7 @@ paths: required: *183 examples: default: - value: *452 + value: *453 headers: Link: example: ; rel="next", ; @@ -68756,7 +69029,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 requestBody: content: application/json: @@ -68834,7 +69107,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: discussion_number in: path required: true @@ -68889,7 +69162,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: discussion_number in: path required: true @@ -68922,7 +69195,7 @@ paths: required: *183 examples: default: - value: *453 + value: *454 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68958,7 +69231,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: discussion_number in: path required: true @@ -68992,7 +69265,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: discussion_number in: path required: true @@ -69025,7 +69298,7 @@ paths: required: *187 examples: default: - value: *454 + value: *455 headers: Link: example: ; rel="next", ; @@ -69068,7 +69341,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: discussion_number in: path required: true @@ -69137,7 +69410,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: discussion_number in: path required: true @@ -69195,7 +69468,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: discussion_number in: path required: true @@ -69230,7 +69503,7 @@ paths: required: *187 examples: default: - value: *455 + value: *456 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69266,7 +69539,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: discussion_number in: path required: true @@ -69304,7 +69577,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: discussion_number in: path required: true @@ -69394,7 +69667,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: discussion_number in: path required: true @@ -69477,7 +69750,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: discussion_number in: path required: true @@ -69563,7 +69836,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: discussion_number in: path required: true @@ -69642,7 +69915,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: per_page description: Results per page (max 100). in: query @@ -69698,7 +69971,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: role description: "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - @@ -69773,7 +70046,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: username in: path required: true @@ -69816,7 +70089,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: username in: path required: true @@ -69902,7 +70175,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: username in: path required: true @@ -69942,7 +70215,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: username in: path required: true @@ -69961,13 +70234,13 @@ paths: examples: response-if-user-has-an-active-membership-with-team: summary: Response if user has an active membership with team - value: *456 + value: *457 response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer - value: *457 + value: *458 response-if-user-has-a-pending-membership-with-team: summary: Response if user has a pending membership with team - value: *458 + value: *459 '404': description: Resource Not Found content: *9 @@ -70004,7 +70277,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: username in: path required: true @@ -70040,10 +70313,10 @@ paths: examples: response-if-users-membership-with-team-is-now-active: summary: Response if user's membership with team is now active - value: *459 + value: *460 response-if-users-membership-with-team-is-now-pending: summary: Response if user's membership with team is now pending - value: *460 + value: *461 '403': description: Response if team synchronization is set up '422': @@ -70109,7 +70382,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: username in: path required: true @@ -70145,7 +70418,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: per_page description: Results per page (max 100). in: query @@ -70169,7 +70442,7 @@ paths: required: *198 examples: default: - value: *461 + value: *462 headers: Link: example: ; rel="next", ; @@ -70214,7 +70487,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: project_id in: path required: true @@ -70232,7 +70505,7 @@ paths: required: *198 examples: default: - value: *462 + value: *463 '404': description: Response if project is not managed by this team '415': @@ -70270,7 +70543,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: project_id in: path required: true @@ -70357,7 +70630,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: project_id in: path required: true @@ -70400,7 +70673,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: per_page description: Results per page (max 100). in: query @@ -70461,7 +70734,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: owner in: path required: true @@ -70479,8 +70752,8 @@ paths: title: Team Repository description: A team's access to a repository. type: object - properties: *463 - required: *464 + properties: *464 + required: *465 examples: alternative-response-with-extra-repository-information: value: @@ -70746,7 +71019,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: owner in: path required: true @@ -70809,7 +71082,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: owner in: path required: true @@ -70849,7 +71122,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 responses: '200': description: response @@ -70896,7 +71169,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 requestBody: content: application/json: @@ -70994,7 +71267,7 @@ paths: - name: team_id in: path required: true - schema: *451 + schema: *452 - name: per_page description: Results per page (max 100). in: query @@ -71019,7 +71292,7 @@ paths: required: *174 examples: response-if-child-teams-exist: - value: *465 + value: *466 headers: Link: example: ; rel="next", ; @@ -71067,7 +71340,7 @@ paths: - title: Private User description: Private User type: object - properties: &466 + properties: &467 login: type: string example: octocat @@ -71224,7 +71497,7 @@ paths: type: boolean ldap_dn: type: string - required: &467 + required: &468 - avatar_url - events_url - followers_url @@ -71265,7 +71538,7 @@ paths: - title: Public User description: Public User type: object - properties: &489 + properties: &490 login: type: string id: @@ -71385,7 +71658,7 @@ paths: collaborators: type: integer example: 3 - required: &490 + required: &491 - avatar_url - events_url - followers_url @@ -71573,8 +71846,8 @@ paths: title: Private User description: Private User type: object - properties: *466 - required: *467 + properties: *467 + required: *468 examples: default: value: @@ -71843,7 +72116,7 @@ paths: title: Email description: Email type: object - properties: &468 + properties: &469 email: type: string format: email @@ -71858,7 +72131,7 @@ paths: type: string example: public nullable: true - required: &469 + required: &470 - email - primary - verified @@ -71921,11 +72194,11 @@ paths: title: Email description: Email type: object - properties: *468 - required: *469 + properties: *469 + required: *470 examples: default: - value: &485 + value: &486 - email: octocat@github.com verified: true primary: true @@ -72004,8 +72277,8 @@ paths: title: Email description: Email type: object - properties: *468 - required: *469 + properties: *469 + required: *470 examples: default: value: @@ -72360,7 +72633,7 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: &470 + properties: &471 id: type: integer example: 3 @@ -72454,7 +72727,7 @@ paths: raw_key: type: string nullable: true - required: &471 + required: &472 - id - primary_key_id - key_id @@ -72470,7 +72743,7 @@ paths: - subkeys examples: default: - value: &491 + value: &492 - id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -72552,11 +72825,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *470 - required: *471 + properties: *471 + required: *472 examples: default: - value: &472 + value: &473 id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -72622,7 +72895,7 @@ paths: description: gpg_key_id parameter in: path required: true - schema: &473 + schema: &474 type: integer responses: '200': @@ -72633,11 +72906,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *470 - required: *471 + properties: *471 + required: *472 examples: default: - value: *472 + value: *473 '404': description: Resource Not Found content: *9 @@ -72671,7 +72944,7 @@ paths: description: gpg_key_id parameter in: path required: true - schema: *473 + schema: *474 responses: '204': description: Empty response @@ -73042,7 +73315,7 @@ paths: required: *138 examples: default: - value: &474 + value: &475 limit: collaborators_only origin: user expires_at: '2018-08-17T04:18:39Z' @@ -73087,7 +73360,7 @@ paths: required: *138 examples: default: - value: *474 + value: *475 '422': description: Validation Failed content: *21 @@ -73147,6 +73420,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -73273,7 +73547,7 @@ paths: title: Key description: Key type: object - properties: &475 + properties: &476 key_id: type: string key: @@ -73291,7 +73565,7 @@ paths: type: boolean read_only: type: boolean - required: &476 + required: &477 - key_id - key - id @@ -73378,11 +73652,11 @@ paths: title: Key description: Key type: object - properties: *475 - required: *476 + properties: *476 + required: *477 examples: default: - value: &477 + value: &478 key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -73438,11 +73712,11 @@ paths: title: Key description: Key type: object - properties: *475 - required: *476 + properties: *476 + required: *477 examples: default: - value: *477 + value: *478 '404': description: Resource Not Found content: *9 @@ -73530,7 +73804,7 @@ paths: title: User Marketplace Purchase description: User Marketplace Purchase type: object - properties: &478 + properties: &479 billing_cycle: type: string example: monthly @@ -73589,7 +73863,7 @@ paths: type: object properties: *82 required: *83 - required: &479 + required: &480 - billing_cycle - next_billing_date - unit_count @@ -73600,7 +73874,7 @@ paths: - plan examples: default: - value: &480 + value: &481 - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' unit_count: @@ -73683,11 +73957,11 @@ paths: title: User Marketplace Purchase description: User Marketplace Purchase type: object - properties: *478 - required: *479 + properties: *479 + required: *480 examples: default: - value: *480 + value: *481 headers: Link: example: ; rel="next", ; @@ -74793,7 +75067,7 @@ paths: description: repo_name parameter in: path required: true - schema: *481 + schema: *482 responses: '204': description: Empty response @@ -74921,7 +75195,7 @@ paths: required: *48 examples: default: - value: *482 + value: *483 headers: Link: example: ; rel="next", ; @@ -74977,11 +75251,11 @@ paths: title: Package description: A software package type: object - properties: *483 - required: *484 + properties: *484 + required: *485 examples: default: - value: &492 + value: &493 id: 40201 name: octo-name package_type: rubygems @@ -75155,6 +75429,12 @@ paths: in: path required: true schema: *156 + - name: token + description: package token + schema: + type: string + required: false + in: query responses: '204': description: Empty response @@ -75183,7 +75463,7 @@ paths: If `package_type` is not `container`, your token must also include the `repo` scope. tags: - packages - operationId: packages/get-all-package-versions-for-a-package-owned-by-the-authenticated-user + operationId: packages/get-all-package-versions-for-package-owned-by-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user @@ -75200,6 +75480,24 @@ paths: in: path required: true schema: *156 + - name: page + description: Page number of the results to fetch. + in: query + schema: *14 + - name: per_page + description: Results per page (max 100). + in: query + schema: *13 + - name: state + in: query + required: false + description: The state of the package, either active or deleted. + schema: + type: string + enum: + - active + - deleted + default: active responses: '200': description: response @@ -75553,11 +75851,11 @@ paths: title: Email description: Email type: object - properties: *468 - required: *469 + properties: *469 + required: *470 examples: default: - value: *485 + value: *486 headers: Link: example: ; rel="next", ; @@ -75694,7 +75992,7 @@ paths: examples: default: summary: Default response - value: &487 + value: &488 - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World @@ -76029,7 +76327,7 @@ paths: required: *350 examples: default: - value: *486 + value: *487 headers: Link: example: ; rel="next", ; @@ -76172,7 +76470,7 @@ paths: examples: default-response: summary: Default response - value: *487 + value: *488 application/vnd.github.v3.star+json: schema: type: array @@ -76180,7 +76478,7 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: &493 + properties: &494 starred_at: type: string format: date-time @@ -76190,13 +76488,13 @@ paths: type: object properties: *54 required: *55 - required: &494 + required: &495 - starred_at - repo examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: &495 + value: &496 - starred_at: '2011-01-16T19:06:43Z' repo: id: 1296269 @@ -76631,7 +76929,7 @@ paths: description: A user ID. Only return users with an ID greater than this ID. in: query required: false - schema: *488 + schema: *489 - name: per_page description: Results per page (max 100). in: query @@ -76698,13 +76996,13 @@ paths: - title: Private User description: Private User type: object - properties: *466 - required: *467 + properties: *467 + required: *468 - title: Public User description: Public User type: object - properties: *489 - required: *490 + properties: *490 + required: *491 additionalProperties: false examples: default-response: @@ -77151,11 +77449,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *470 - required: *471 + properties: *471 + required: *472 examples: default: - value: *491 + value: *492 headers: Link: example: ; rel="next", ; @@ -77390,7 +77688,7 @@ paths: required: *48 examples: default: - value: *482 + value: *483 headers: Link: example: ; rel="next", ; @@ -77442,11 +77740,11 @@ paths: title: Package description: A software package type: object - properties: *483 - required: *484 + properties: *484 + required: *485 examples: default: - value: *492 + value: *493 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -78067,7 +78365,7 @@ paths: examples: default-response: summary: Default response - value: *487 + value: *488 application/vnd.github.v3.star+json: schema: type: array @@ -78075,12 +78373,12 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: *493 - required: *494 + properties: *494 + required: *495 examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: *495 + value: *496 headers: Link: example: ; rel="next", ; diff --git a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json index 11b1bbf946..b30da5d436 100644 --- a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json +++ b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json @@ -1140,6 +1140,43 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1899,6 +1936,34 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -2744,6 +2809,35 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -8911,6 +9005,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -10508,6 +10611,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -28017,6 +28129,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -30679,6 +30792,15 @@ "type": "integer", "default": 30 } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -43615,6 +43737,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -48038,6 +48161,35 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -94486,6 +94638,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -100147,9 +100319,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -100894,7 +101084,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -100956,6 +101146,14 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -101937,7 +102135,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -104189,13 +104387,31 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -105934,7 +106150,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -108169,7 +108385,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -108884,7 +109100,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -109576,7 +109792,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -110299,7 +110515,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -116955,7 +117172,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -116977,6 +117195,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -118673,6 +118911,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -118680,6 +118938,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -121476,7 +121735,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -121691,7 +121950,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -122707,7 +122966,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -164648,6 +164908,34 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -173085,16 +173373,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -192567,6 +192854,279 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -195054,7 +195614,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -199871,6 +200431,24 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -234335,6 +234913,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" diff --git a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml index c5b13267b6..287d213582 100644 --- a/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml +++ b/descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml @@ -742,6 +742,32 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: &9 + type: string + enum: + - asc + - desc + default: desc + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string responses: '200': description: response @@ -1100,7 +1126,7 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: &83 + properties: &84 login: type: string example: github @@ -1141,7 +1167,7 @@ paths: type: string example: A great organization nullable: true - required: &84 + required: &85 - login - url - id @@ -1211,7 +1237,7 @@ paths: - name: org in: path required: true - schema: &85 + schema: &86 type: string responses: '202': @@ -1267,6 +1293,21 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1276,7 +1317,7 @@ paths: type: array items: type: object - properties: &9 + properties: &10 id: type: integer name: @@ -1367,10 +1408,10 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default: - value: &10 + value: &11 id: 2 name: DevTools Hook Env image_url: https://my_file_server/path/to/devtools_env.tar.gz @@ -1431,7 +1472,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: &11 + schema: &12 type: integer responses: '200': @@ -1440,10 +1481,10 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default: - value: *10 + value: *11 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -1474,7 +1515,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *11 + schema: *12 responses: '200': description: response @@ -1482,7 +1523,7 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default-response: value: @@ -1575,7 +1616,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *11 + schema: *12 responses: '204': description: Empty response @@ -1645,7 +1686,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *11 + schema: *12 responses: '202': description: response @@ -1653,7 +1694,7 @@ paths: application/json: schema: type: object - properties: &12 + properties: &13 url: type: string state: @@ -1732,7 +1773,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *11 + schema: *12 responses: '200': description: response @@ -1740,7 +1781,7 @@ paths: application/json: schema: type: object - properties: *12 + properties: *13 examples: default: value: @@ -1783,6 +1824,23 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + description: One of `created` (when the repository was starred) or `updated` + (when it was last pushed to) or `name`. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1792,7 +1850,7 @@ paths: type: array items: type: object - properties: &13 + properties: &14 id: type: integer name: @@ -1905,10 +1963,10 @@ paths: application/json: schema: type: object - properties: *13 + properties: *14 examples: default: - value: &14 + value: &15 id: 1 name: Check Commits enforcement: disabled @@ -2006,7 +2064,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: &15 + schema: &16 type: integer responses: '200': @@ -2015,10 +2073,10 @@ paths: application/json: schema: type: object - properties: *13 + properties: *14 examples: default: - value: *14 + value: *15 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -2048,7 +2106,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -2056,7 +2114,7 @@ paths: application/json: schema: type: object - properties: *13 + properties: *14 examples: default: value: @@ -2147,7 +2205,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '204': description: Empty response @@ -2198,7 +2256,7 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: &18 + properties: &19 id: type: integer url: @@ -2254,7 +2312,7 @@ paths: - title: Simple User description: Simple User type: object - properties: &16 + properties: &17 login: type: string example: octocat @@ -2320,7 +2378,7 @@ paths: starred_at: type: string example: '"2020-07-09T00:17:55Z"' - required: &17 + required: &18 - avatar_url - events_url - followers_url @@ -2351,7 +2409,7 @@ paths: type: object description: The permissions granted to the user-to-server access token. - properties: &26 + properties: &27 actions: type: string description: 'The level of permission to grant the @@ -2600,7 +2658,7 @@ paths: enum: - read - write - example: &27 + example: &28 contents: read issues: read deployments: write @@ -2634,8 +2692,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true required: - permissions @@ -2643,7 +2701,7 @@ paths: - single_file_name - repositories_url - account - required: &19 + required: &20 - app - id - note @@ -2658,7 +2716,7 @@ paths: - updated_at examples: default: - value: &41 + value: &42 - id: 2 url: https://enterprise.octocat.com/api/v3/authorizations/2 app: @@ -2750,8 +2808,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -2900,11 +2958,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: &42 + value: &43 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -2988,7 +3046,7 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: &20 + properties: &21 id: description: Unique identifier of the GitHub app example: 37 @@ -3002,8 +3060,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true name: description: The name of the GitHub app @@ -3074,7 +3132,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &21 + required: &22 - id - node_id - owner @@ -3089,7 +3147,7 @@ paths: additionalProperties: true examples: default: - value: &40 + value: &41 id: 1 node_id: MDExOkludGVncmF0aW9uMQ== owner: @@ -3169,8 +3227,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true - type: object properties: @@ -3260,13 +3318,13 @@ paths: -----END RSA PRIVATE KEY----- '404': description: Resource Not Found - content: &24 + content: &25 application/json: schema: title: Basic Error description: Basic Error type: object - properties: &28 + properties: &29 message: type: string documentation_url: @@ -3279,10 +3337,10 @@ paths: title: Validation Error Simple description: Validation Error Simple type: object - required: &90 + required: &91 - message - documentation_url - properties: &91 + properties: &92 message: type: string documentation_url: @@ -3321,7 +3379,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: &30 + schema: &31 type: integer default: 30 - name: page @@ -3340,7 +3398,7 @@ paths: title: Installation description: Installation type: object - properties: &22 + properties: &23 id: description: The ID of the installation. type: integer @@ -3351,8 +3409,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true - title: Enterprise description: An enterprise account @@ -3484,8 +3542,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true suspended_at: type: string @@ -3495,7 +3553,7 @@ paths: type: string example: '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' nullable: true - required: &23 + required: &24 - id - app_id - app_slug @@ -3593,7 +3651,7 @@ paths: description: installation_id parameter in: path required: true - schema: &25 + schema: &26 type: integer responses: '200': @@ -3604,8 +3662,8 @@ paths: title: Installation description: Installation type: object - properties: *22 - required: *23 + properties: *23 + required: *24 examples: default: value: @@ -3649,10 +3707,10 @@ paths: app_slug: github-actions '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: &29 + content: &30 application/json: schema: type: object @@ -3698,13 +3756,13 @@ paths: description: installation_id parameter in: path required: true - schema: *25 + schema: *26 responses: '204': description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -3748,7 +3806,7 @@ paths: description: installation_id parameter in: path required: true - schema: *25 + schema: *26 requestBody: content: application/json: @@ -3775,8 +3833,8 @@ paths: type: object description: The permissions granted to the user-to-server access token. - properties: *26 - example: *27 + properties: *27 + example: *28 responses: '201': description: response @@ -3816,7 +3874,7 @@ paths: title: Repository description: A git repository type: object - properties: &51 + properties: &52 id: description: Unique identifier of the repository example: 42 @@ -3837,7 +3895,7 @@ paths: - title: License Simple description: License Simple type: object - properties: &72 + properties: &73 key: type: string example: mit @@ -3859,7 +3917,7 @@ paths: html_url: type: string format: uri - required: &73 + required: &74 - key - name - url @@ -3890,8 +3948,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true private: description: Whether the repository is private or public. @@ -4367,7 +4425,7 @@ paths: example: '"2020-07-09T00:17:42Z"' anonymous_access_enabled: type: boolean - required: &52 + required: &53 - archive_url - assignees_url - blobs_url @@ -4572,40 +4630,40 @@ paths: anonymous_access_enabled: false '403': description: Forbidden - content: &31 + content: &32 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 '415': description: Preview Header Missing - content: *29 + content: *30 '401': description: Requires Authentication - content: &32 + content: &33 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: &43 + content: &44 application/json: schema: title: Validation Error description: Validation Error type: object - required: &88 + required: &89 - message - documentation_url - properties: &89 + properties: &90 message: type: string documentation_url: @@ -4665,11 +4723,17 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -4681,7 +4745,7 @@ paths: title: Application Grant description: The authorization associated with an OAuth Access. type: object - properties: &33 + properties: &34 id: type: integer example: 1 @@ -4723,10 +4787,10 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true - required: &34 + required: &35 - app - id - scopes @@ -4755,13 +4819,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4792,7 +4856,7 @@ paths: description: grant_id parameter in: path required: true - schema: &35 + schema: &36 type: integer responses: '200': @@ -4803,8 +4867,8 @@ paths: title: Application Grant description: The authorization associated with an OAuth Access. type: object - properties: *33 - required: *34 + properties: *34 + required: *35 examples: default: value: @@ -4822,10 +4886,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4852,7 +4916,7 @@ paths: description: grant_id parameter in: path required: true - schema: *35 + schema: *36 responses: '204': description: Empty response @@ -4860,10 +4924,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4891,12 +4955,12 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: &36 + schema: &37 type: string - name: access_token in: path required: true - schema: &37 + schema: &38 type: string responses: '204': @@ -4928,11 +4992,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 - name: access_token in: path required: true - schema: *37 + schema: *38 responses: '200': description: response @@ -4940,7 +5004,7 @@ paths: application/json: schema: type: object - properties: &38 + properties: &39 id: type: integer url: @@ -5015,7 +5079,7 @@ paths: type: boolean examples: default: - value: &39 + value: &40 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -5078,11 +5142,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 - name: access_token in: path required: true - schema: *37 + schema: *38 responses: '200': description: response @@ -5090,10 +5154,10 @@ paths: application/json: schema: type: object - properties: *38 + properties: *39 examples: default: - value: *39 + value: *40 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5117,11 +5181,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 - name: access_token in: path required: true - schema: *37 + schema: *38 responses: '204': description: Empty response @@ -5163,21 +5227,21 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true examples: default: - value: *40 + value: *41 '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -5209,11 +5273,17 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -5226,11 +5296,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *41 + value: *42 headers: Link: example: ; rel="next", ; @@ -5240,13 +5310,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5322,11 +5392,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *42 + value: *43 headers: Location: example: https://api.github.com/authorizations/1 @@ -5334,24 +5404,24 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 '410': description: Gone - content: &48 + content: &49 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5385,7 +5455,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 requestBody: content: application/json: @@ -5429,8 +5499,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: response-if-returning-an-existing-token: value: @@ -5471,11 +5541,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *42 + value: *43 headers: Location: example: https://api.github.com/authorizations/1 @@ -5483,15 +5553,15 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5523,7 +5593,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 - name: fingerprint in: path required: true @@ -5568,8 +5638,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: response-if-returning-an-existing-token: value: @@ -5603,8 +5673,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: value: @@ -5631,7 +5701,7 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5662,7 +5732,7 @@ paths: description: authorization_id parameter in: path required: true - schema: &44 + schema: &45 type: integer responses: '200': @@ -5674,11 +5744,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: &45 + value: &46 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -5699,10 +5769,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5731,7 +5801,7 @@ paths: description: authorization_id parameter in: path required: true - schema: *44 + schema: *45 requestBody: content: application/json: @@ -5778,14 +5848,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *45 + value: *46 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5815,7 +5885,7 @@ paths: description: authorization_id parameter in: path required: true - schema: *44 + schema: *45 responses: '204': description: Empty response @@ -5823,10 +5893,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5858,7 +5928,7 @@ paths: title: Code Of Conduct description: Code Of Conduct type: object - properties: &46 + properties: &47 key: type: string example: contributor_covenant @@ -5924,7 +5994,7 @@ paths: type: string format: uri nullable: true - required: &47 + required: &48 - url - html_url - key @@ -5944,7 +6014,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -5985,8 +6055,8 @@ paths: title: Code Of Conduct description: Code Of Conduct type: object - properties: *46 - required: *47 + properties: *47 + required: *48 examples: default: value: @@ -6045,12 +6115,12 @@ paths: html_url: http://contributor-covenant.org/version/1/4/ '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6155,21 +6225,21 @@ paths: self.save() '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *48 + content: *49 '415': description: Preview Header Missing - content: *29 + content: *30 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6464,7 +6534,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -6480,7 +6550,7 @@ paths: title: Event description: Event type: object - properties: &75 + properties: &76 id: type: string type: @@ -6490,7 +6560,7 @@ paths: title: Actor description: Actor type: object - properties: &49 + properties: &50 id: type: integer login: @@ -6506,7 +6576,7 @@ paths: avatar_url: type: string format: uri - required: &50 + required: &51 - id - login - gravatar_id @@ -6530,8 +6600,8 @@ paths: title: Actor description: Actor type: object - properties: *49 - required: *50 + properties: *50 + required: *51 payload: type: object properties: @@ -6589,8 +6659,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true labels: type: array @@ -6641,8 +6711,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assignees: type: array @@ -6650,8 +6720,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true milestone: @@ -6661,7 +6731,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &68 + properties: &69 url: type: string format: uri @@ -6706,8 +6776,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true open_issues: type: integer @@ -6733,7 +6803,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &69 + required: &70 - closed_issues - creator - description @@ -6805,7 +6875,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: &53 + enum: &54 - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER @@ -6825,8 +6895,8 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 performed_via_github_app: nullable: true allOf: @@ -6838,8 +6908,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true required: &210 - assignee @@ -6898,8 +6968,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -6917,7 +6987,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *53 + enum: *54 performed_via_github_app: nullable: true allOf: @@ -6929,13 +6999,13 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true reactions: title: Reaction Rollup type: object - properties: &70 + properties: &71 url: type: string format: uri @@ -6957,7 +7027,7 @@ paths: type: integer rocket: type: integer - required: &71 + required: &72 - url - total_count - "+1" @@ -7004,7 +7074,7 @@ paths: type: string format: date-time nullable: true - required: &76 + required: &77 - id - type - actor @@ -7016,7 +7086,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '503': description: Service Unavailable content: &181 @@ -7100,58 +7170,58 @@ paths: title: Link With Type description: Hypermedia Link with Type type: object - properties: &54 + properties: &55 href: type: string type: type: string - required: &55 + required: &56 - href - type user: title: Link With Type description: Hypermedia Link with Type type: object - properties: *54 - required: *55 + properties: *55 + required: *56 security_advisories: title: Link With Type description: Hypermedia Link with Type type: object - properties: *54 - required: *55 + properties: *55 + required: *56 current_user: title: Link With Type description: Hypermedia Link with Type type: object - properties: *54 - required: *55 + properties: *55 + required: *56 current_user_public: title: Link With Type description: Hypermedia Link with Type type: object - properties: *54 - required: *55 + properties: *55 + required: *56 current_user_actor: title: Link With Type description: Hypermedia Link with Type type: object - properties: *54 - required: *55 + properties: *55 + required: *56 current_user_organization: title: Link With Type description: Hypermedia Link with Type type: object - properties: *54 - required: *55 + properties: *55 + required: *56 current_user_organizations: type: array items: title: Link With Type description: Hypermedia Link with Type type: object - properties: *54 - required: *55 + properties: *55 + required: *56 required: - timeline - user @@ -7216,12 +7286,12 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: &56 + schema: &57 type: string - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -7237,7 +7307,7 @@ paths: title: Base Gist description: Base Gist type: object - properties: &57 + properties: &58 url: type: string format: uri @@ -7294,8 +7364,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true comments_url: type: string @@ -7306,8 +7376,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true truncated: type: boolean @@ -7317,7 +7387,7 @@ paths: history: type: array items: {} - required: &58 + required: &59 - id - node_id - url @@ -7336,7 +7406,7 @@ paths: - updated_at examples: default: - value: &59 + value: &60 - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits @@ -7388,7 +7458,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7456,7 +7526,7 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: &60 + properties: &61 url: type: string forks_url: @@ -7513,14 +7583,14 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true truncated: type: boolean examples: default: - value: &61 + value: &62 url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits @@ -7541,15 +7611,15 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7576,11 +7646,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *56 + schema: *57 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -7596,11 +7666,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *57 - required: *58 + properties: *58 + required: *59 examples: default: - value: *59 + value: *60 headers: Link: example: ; rel="next", ; @@ -7608,12 +7678,12 @@ paths: schema: *6 '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7637,11 +7707,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *56 + schema: *57 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -7657,11 +7727,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *57 - required: *58 + properties: *58 + required: *59 examples: default: - value: *59 + value: *60 headers: Link: example: ; rel="next", ; @@ -7669,12 +7739,12 @@ paths: schema: *6 '401': description: Requires Authentication - content: *32 + content: *33 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7696,7 +7766,7 @@ paths: description: gist_id parameter in: path required: true - schema: &62 + schema: &63 type: string responses: '200': @@ -7707,13 +7777,13 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *60 + properties: *61 examples: default: - value: *61 + value: *62 '403': description: Forbidden Gist - content: &66 + content: &67 application/json: schema: type: object @@ -7734,7 +7804,7 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified x-github: @@ -7759,7 +7829,7 @@ paths: description: gist_id parameter in: path required: true - schema: *62 + schema: *63 requestBody: content: application/json: @@ -7810,16 +7880,16 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *60 + properties: *61 examples: default: - value: *61 + value: *62 '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7840,18 +7910,18 @@ paths: description: gist_id parameter in: path required: true - schema: *62 + schema: *63 responses: '204': description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7873,11 +7943,11 @@ paths: description: gist_id parameter in: path required: true - schema: *62 + schema: *63 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -7893,7 +7963,7 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: &63 + properties: &64 id: type: integer example: 1 @@ -7915,8 +7985,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -7931,8 +8001,8 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *53 - required: &64 + enum: *54 + required: &65 - url - id - node_id @@ -7979,10 +8049,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8003,7 +8073,7 @@ paths: description: gist_id parameter in: path required: true - schema: *62 + schema: *63 requestBody: content: application/json: @@ -8026,11 +8096,11 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *63 - required: *64 + properties: *64 + required: *65 examples: default: - value: &65 + value: &66 id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== url: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 @@ -8066,10 +8136,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8091,12 +8161,12 @@ paths: description: gist_id parameter in: path required: true - schema: *62 + schema: *63 - name: comment_id description: comment_id parameter in: path required: true - schema: &67 + schema: &68 type: integer responses: '200': @@ -8107,19 +8177,19 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *63 - required: *64 + properties: *64 + required: *65 examples: default: - value: *65 + value: *66 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden Gist - content: *66 + content: *67 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8140,12 +8210,12 @@ paths: description: gist_id parameter in: path required: true - schema: *62 + schema: *63 - name: comment_id description: comment_id parameter in: path required: true - schema: *67 + schema: *68 requestBody: content: application/json: @@ -8168,14 +8238,14 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *63 - required: *64 + properties: *64 + required: *65 examples: default: - value: *65 + value: *66 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8196,12 +8266,12 @@ paths: description: gist_id parameter in: path required: true - schema: *62 + schema: *63 - name: comment_id description: comment_id parameter in: path required: true - schema: *67 + schema: *68 responses: '204': description: Empty response @@ -8209,10 +8279,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8234,11 +8304,11 @@ paths: description: gist_id parameter in: path required: true - schema: *62 + schema: *63 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -8268,8 +8338,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true change_status: type: object @@ -8326,12 +8396,12 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8353,11 +8423,11 @@ paths: description: gist_id parameter in: path required: true - schema: *62 + schema: *63 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -8373,7 +8443,7 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *60 + properties: *61 examples: default: value: @@ -8425,12 +8495,12 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8451,7 +8521,7 @@ paths: description: gist_id parameter in: path required: true - schema: *62 + schema: *63 responses: '201': description: response @@ -8461,8 +8531,8 @@ paths: title: Base Gist description: Base Gist type: object - properties: *57 - required: *58 + properties: *58 + required: *59 examples: default: value: @@ -8515,15 +8585,15 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8545,7 +8615,7 @@ paths: description: gist_id parameter in: path required: true - schema: *62 + schema: *63 responses: '204': description: Response if gist is starred @@ -8561,7 +8631,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8583,18 +8653,18 @@ paths: description: gist_id parameter in: path required: true - schema: *62 + schema: *63 responses: '204': description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8615,7 +8685,7 @@ paths: description: gist_id parameter in: path required: true - schema: *62 + schema: *63 responses: '204': description: Empty response @@ -8623,10 +8693,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8648,7 +8718,7 @@ paths: description: gist_id parameter in: path required: true - schema: *62 + schema: *63 - name: sha in: path required: true @@ -8663,19 +8733,19 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *60 + properties: *61 examples: default: - value: *61 + value: *62 '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8827,7 +8897,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -8851,8 +8921,8 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 repository_selection: type: string example: selected @@ -8968,12 +9038,12 @@ paths: schema: *6 '403': description: Forbidden - content: *31 + content: *32 '304': description: Not Modified '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -9028,6 +9098,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -9046,7 +9117,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: &95 + schema: &96 type: string - name: sort description: What to sort results by. Can be either `created`, `updated`, @@ -9064,19 +9135,14 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: &96 - type: string - enum: - - asc - - desc - default: desc + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *56 + schema: *57 - name: collab in: query required: false @@ -9100,7 +9166,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -9166,8 +9232,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true labels: description: Labels to associate with this issue; pass one or @@ -9207,8 +9273,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assignees: type: array @@ -9216,8 +9282,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true milestone: @@ -9226,8 +9292,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *68 - required: *69 + properties: *69 + required: *70 locked: type: boolean active_lock_reason: @@ -9279,8 +9345,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body_html: type: string @@ -9293,8 +9359,8 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 performed_via_github_app: nullable: true allOf: @@ -9305,20 +9371,20 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true author_association: title: author_association type: string example: OWNER description: How the author is associated with the repository. - enum: *53 + enum: *54 reactions: title: Reaction Rollup type: object - properties: *70 - required: *71 + properties: *71 + required: *72 required: &98 - assignee - closed_at @@ -9579,12 +9645,12 @@ paths: schema: *6 '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9617,7 +9683,11 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 responses: '200': description: response @@ -9629,8 +9699,8 @@ paths: title: License Simple description: License Simple type: object - properties: *72 - required: *73 + properties: *73 + required: *74 examples: default: value: @@ -9855,10 +9925,10 @@ paths: featured: true '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified x-github: @@ -9915,7 +9985,7 @@ paths: type: string X-CommonMarker-Version: example: 0.17.4 - schema: &74 + schema: &75 type: string content: text/html: @@ -9958,7 +10028,7 @@ paths: headers: X-CommonMarker-Version: example: 0.17.4 - schema: *74 + schema: *75 content: text/html: schema: @@ -10041,7 +10111,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -10057,14 +10127,14 @@ paths: title: Event description: Event type: object - properties: *75 - required: *76 + properties: *76 + required: *77 '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '304': description: Not Modified '301': @@ -10108,7 +10178,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *56 + schema: *57 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -10120,7 +10190,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -10136,7 +10206,7 @@ paths: title: Thread description: Thread type: object - properties: &77 + properties: &78 id: type: string repository: @@ -10163,8 +10233,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true private: type: boolean @@ -10383,8 +10453,8 @@ paths: - title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 subscribers_count: type: integer network_count: @@ -10491,7 +10561,7 @@ paths: subscription_url: type: string example: https://api.github.com/notifications/threads/2/subscription - required: &78 + required: &79 - id - unread - reason @@ -10592,13 +10662,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10650,10 +10720,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10675,7 +10745,7 @@ paths: description: thread_id parameter in: path required: true - schema: &79 + schema: &80 type: integer responses: '200': @@ -10686,8 +10756,8 @@ paths: title: Thread description: Thread type: object - properties: *77 - required: *78 + properties: *78 + required: *79 examples: default: value: @@ -10774,10 +10844,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10798,7 +10868,7 @@ paths: description: thread_id parameter in: path required: true - schema: *79 + schema: *80 responses: '205': description: response @@ -10806,7 +10876,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10831,7 +10901,7 @@ paths: description: thread_id parameter in: path required: true - schema: *79 + schema: *80 responses: '200': description: response @@ -10841,7 +10911,7 @@ paths: title: Thread Subscription description: Thread Subscription type: object - properties: &80 + properties: &81 subscribed: type: boolean example: true @@ -10867,7 +10937,7 @@ paths: type: string format: uri example: https://api.github.com/repos/1 - required: &81 + required: &82 - created_at - ignored - reason @@ -10875,7 +10945,7 @@ paths: - subscribed examples: default: - value: &82 + value: &83 subscribed: true ignored: false reason: @@ -10886,10 +10956,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10915,7 +10985,7 @@ paths: description: thread_id parameter in: path required: true - schema: *79 + schema: *80 requestBody: content: application/json: @@ -10935,19 +11005,19 @@ paths: title: Thread Subscription description: Thread Subscription type: object - properties: *80 - required: *81 + properties: *81 + required: *82 examples: default: - value: *82 + value: *83 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10972,7 +11042,7 @@ paths: description: thread_id parameter in: path required: true - schema: *79 + schema: *80 responses: '204': description: Empty response @@ -10980,10 +11050,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11040,7 +11110,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 responses: '200': description: response @@ -11052,11 +11122,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *83 - required: *84 + properties: *84 + required: *85 examples: default: - value: &315 + value: &316 - login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= @@ -11099,7 +11169,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 responses: '200': description: response @@ -11109,7 +11179,7 @@ paths: title: Organization Full description: Organization Full type: object - properties: &86 + properties: &87 login: type: string example: github @@ -11256,7 +11326,7 @@ paths: updated_at: type: string format: date-time - required: &87 + required: &88 - login - url - id @@ -11370,7 +11440,7 @@ paths: seats: 5 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11402,7 +11472,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 requestBody: content: application/json: @@ -11532,8 +11602,8 @@ paths: title: Organization Full description: Organization Full type: object - properties: *86 - required: *87 + properties: *87 + required: *88 examples: default: value: @@ -11588,13 +11658,13 @@ paths: - title: Validation Error description: Validation Error type: object - required: *88 - properties: *89 + required: *89 + properties: *90 - title: Validation Error Simple description: Validation Error Simple type: object - required: *90 - properties: *91 + required: *91 + properties: *92 '409': description: Conflict content: &169 @@ -11603,10 +11673,10 @@ paths: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11636,11 +11706,11 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -11656,8 +11726,8 @@ paths: title: Event description: Event type: object - properties: *75 - required: *76 + properties: *76 + required: *77 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11678,11 +11748,11 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -11698,7 +11768,7 @@ paths: title: Org Hook description: Org Hook type: object - properties: &92 + properties: &93 id: type: integer example: 1 @@ -11748,7 +11818,7 @@ paths: example: '2011-09-06T17:26:27Z' type: type: string - required: &93 + required: &94 - id - url - type @@ -11783,7 +11853,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11804,7 +11874,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 requestBody: content: application/json: @@ -11887,11 +11957,11 @@ paths: title: Org Hook description: Org Hook type: object - properties: *92 - required: *93 + properties: *93 + required: *94 examples: default: - value: &94 + value: &95 id: 1 url: https://api.github.com/orgs/octocat/hooks/1 ping_url: https://api.github.com/orgs/octocat/hooks/1/pings @@ -11913,10 +11983,10 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11938,7 +12008,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: hook_id in: path required: true @@ -11952,14 +12022,14 @@ paths: title: Org Hook description: Org Hook type: object - properties: *92 - required: *93 + properties: *93 + required: *94 examples: default: - value: *94 + value: *95 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11983,7 +12053,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: hook_id in: path required: true @@ -12056,8 +12126,8 @@ paths: title: Org Hook description: Org Hook type: object - properties: *92 - required: *93 + properties: *93 + required: *94 examples: default: value: @@ -12076,10 +12146,10 @@ paths: type: Organization '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12099,7 +12169,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: hook_id in: path required: true @@ -12109,7 +12179,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12131,7 +12201,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: hook_id in: path required: true @@ -12141,7 +12211,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12172,7 +12242,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 responses: '200': description: response @@ -12182,8 +12252,8 @@ paths: title: Installation description: Installation type: object - properties: *22 - required: *23 + properties: *23 + required: *24 examples: default: value: &205 @@ -12256,7 +12326,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: filter description: "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you @@ -12272,6 +12342,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -12290,7 +12361,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *95 + schema: *96 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -12307,18 +12378,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *96 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *56 + schema: *57 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -12347,7 +12418,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12377,7 +12448,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: filter description: "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -12407,7 +12478,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -12423,8 +12494,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -12461,7 +12532,7 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12482,7 +12553,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: username in: path required: true @@ -12521,7 +12592,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: username in: path required: true @@ -12531,7 +12602,7 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12553,7 +12624,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: username in: path required: true @@ -12586,16 +12657,16 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *83 - required: *84 + properties: *84 + required: *85 user: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true permissions: type: object @@ -12731,10 +12802,10 @@ paths: site_admin: false '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12766,7 +12837,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: username in: path required: true @@ -12879,10 +12950,10 @@ paths: site_admin: false '422': description: Validation Failed - content: *43 + content: *44 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12905,7 +12976,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: username in: path required: true @@ -12915,10 +12986,10 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12939,7 +13010,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: filter description: "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -12955,7 +13026,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -12971,8 +13042,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -13005,7 +13076,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: username in: path required: true @@ -13039,7 +13110,7 @@ paths: documentation_url: https://docs.github.com/enterprise-server@2.18/rest/reference/orgs#convert-member-to-outside-collaborator '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13060,7 +13131,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: username in: path required: true @@ -13108,7 +13179,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: per_page description: Results per page (max 100) in: query @@ -13117,6 +13188,22 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + description: The sort order for the response collection. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -13175,11 +13262,11 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -13226,11 +13313,11 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -13291,11 +13378,11 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -13340,7 +13427,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: state description: Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. @@ -13356,7 +13443,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -13419,8 +13506,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -13528,7 +13615,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 requestBody: content: application/json: @@ -13593,16 +13680,16 @@ paths: updated_at: '2014-03-04T18:58:10Z' '401': description: Requires Authentication - content: *32 + content: *33 '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *48 + content: *49 '422': description: Validation Failed content: *105 @@ -13634,11 +13721,11 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -13654,8 +13741,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -13685,7 +13772,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: username in: path required: true @@ -13717,7 +13804,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: username in: path required: true @@ -13727,7 +13814,7 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -13747,7 +13834,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: username in: path required: true @@ -13775,7 +13862,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: type description: 'Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. @@ -13820,7 +13907,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -13840,7 +13927,7 @@ paths: required: *109 examples: default: - value: &302 + value: &303 - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World @@ -13997,7 +14084,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 requestBody: content: application/json: @@ -14118,8 +14205,8 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 examples: default: value: &189 @@ -14242,10 +14329,10 @@ paths: type: string '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14284,11 +14371,11 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -14435,7 +14522,7 @@ paths: schema: *6 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14458,7 +14545,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 requestBody: content: application/json: @@ -14603,8 +14690,8 @@ paths: title: Organization Full description: Organization Full type: object - properties: *86 - required: *87 + properties: *87 + required: *88 ldap_dn: description: Distinguished Name (DN) that team maps to within LDAP environment @@ -14675,10 +14762,10 @@ paths: ldap_dn: uid=asdf,ou=users,dc=github,dc=com '422': description: Validation Failed - content: *43 + content: *44 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14702,7 +14789,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: team_slug description: team_slug parameter in: path @@ -14726,7 +14813,7 @@ paths: value: *114 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14781,8 +14868,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -14854,13 +14941,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14922,13 +15009,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed content: *105 @@ -14982,10 +15069,10 @@ paths: type: string '401': description: Requires Authentication - content: *32 + content: *33 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15070,7 +15157,7 @@ paths: type: string '401': description: Requires Authentication - content: *32 + content: *33 '503': description: Service Unavailable content: @@ -15095,7 +15182,7 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15191,13 +15278,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15256,10 +15343,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15295,10 +15382,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15343,7 +15430,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -15402,10 +15489,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15483,10 +15570,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '422': description: Validation Failed content: @@ -15496,13 +15583,13 @@ paths: - title: Validation Error description: Validation Error type: object - required: *88 - properties: *89 + required: *89 + properties: *90 - title: Validation Error Simple description: Validation Error Simple type: object - required: *90 - properties: *91 + required: *91 + properties: *92 '503': description: Service Unavailable content: @@ -15580,13 +15667,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed content: *105 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15667,10 +15754,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15768,10 +15855,10 @@ paths: type: string '401': description: Requires Authentication - content: *32 + content: *33 '410': description: Gone - content: *48 + content: *49 '422': description: Validation Failed content: *105 @@ -15825,13 +15912,13 @@ paths: type: string '401': description: Requires Authentication - content: *32 + content: *33 '410': description: Gone - content: *48 + content: *49 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15883,7 +15970,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -15899,8 +15986,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -15912,21 +15999,21 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15980,21 +16067,21 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16034,19 +16121,19 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *43 + content: *44 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16100,8 +16187,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true required: &161 - permission @@ -16131,21 +16218,21 @@ paths: site_admin: false '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16177,7 +16264,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -16215,10 +16302,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16282,13 +16369,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed content: *105 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16425,7 +16512,7 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16533,8 +16620,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true private: type: boolean @@ -16783,8 +16870,8 @@ paths: - title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 allow_squash_merge: type: boolean example: true @@ -16803,29 +16890,29 @@ paths: - title: License Simple description: License Simple type: object - properties: *72 - required: *73 + properties: *73 + required: *74 organization: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true parent: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 source: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 forks: type: integer master_branch: @@ -17897,10 +17984,10 @@ paths: anonymous_access_enabled: false '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '301': description: Moved Permanently x-github: @@ -18537,13 +18624,13 @@ paths: anonymous_access_enabled: false '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18610,7 +18697,7 @@ paths: documentation_url: https://docs.github.com/enterprise-server@2.18/rest/reference/repos#delete-a-repository '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18640,7 +18727,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -18656,8 +18743,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -18669,7 +18756,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18717,7 +18804,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18754,7 +18841,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -18844,8 +18931,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true teams: description: The list of teams with review dismissal @@ -19202,7 +19289,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19353,8 +19440,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true committer: nullable: true @@ -19362,8 +19449,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true parents: type: array @@ -19558,10 +19645,10 @@ paths: protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection '415': description: Preview Header Missing - content: *29 + content: *30 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19701,7 +19788,7 @@ paths: parent: '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19963,8 +20050,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true teams: type: array @@ -20042,16 +20129,16 @@ paths: - url '403': description: Forbidden - content: *31 + content: *32 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed content: *105 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20098,7 +20185,7 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20235,7 +20322,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20428,7 +20515,7 @@ paths: value: *144 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20475,7 +20562,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20530,7 +20617,7 @@ paths: enabled: true '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20587,7 +20674,7 @@ paths: value: *145 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20633,7 +20720,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20697,7 +20784,7 @@ paths: contexts_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20766,10 +20853,10 @@ paths: value: *148 '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20855,7 +20942,7 @@ paths: - continuous-integration/travis-ci '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20920,13 +21007,13 @@ paths: - continuous-integration/jenkins '422': description: Validation Failed - content: *43 + content: *44 '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20991,10 +21078,10 @@ paths: - continuous-integration/travis-ci '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21059,10 +21146,10 @@ paths: - continuous-integration/travis-ci '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21151,7 +21238,7 @@ paths: parent: '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21241,7 +21328,7 @@ paths: value: *149 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21314,7 +21401,7 @@ paths: value: *149 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21388,7 +21475,7 @@ paths: value: *149 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21462,7 +21549,7 @@ paths: value: *149 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21509,15 +21596,15 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: value: *102 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21582,15 +21669,15 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: value: *102 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21656,15 +21743,15 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: value: *102 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21730,15 +21817,15 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: value: *102 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22155,8 +22242,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true pull_requests: items: @@ -22291,8 +22378,8 @@ paths: They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true required: - id @@ -22942,7 +23029,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -23146,8 +23233,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true repository: title: Minimal Repository @@ -23612,8 +23699,8 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 examples: default: value: @@ -23863,7 +23950,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -24072,7 +24159,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -24215,7 +24302,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24346,8 +24433,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true inviter: nullable: true @@ -24355,8 +24442,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true permissions: description: The permission associated with the invitation. @@ -24510,10 +24597,10 @@ paths: description: Response when person is already a collaborator '422': description: Validation Failed - content: *43 + content: *44 '403': description: Forbidden - content: *31 + content: *32 x-github: triggersNotification: true githubCloudOnly: false @@ -24612,7 +24699,7 @@ paths: site_admin: false '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24644,7 +24731,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -24690,8 +24777,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -24704,12 +24791,12 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *53 + enum: *54 reactions: title: Reaction Rollup type: object - properties: *70 - required: *71 + properties: *71 + required: *72 required: &163 - url - html_url @@ -24802,7 +24889,7 @@ paths: description: comment_id parameter in: path required: true - schema: *67 + schema: *68 responses: '200': description: response @@ -24850,7 +24937,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24889,7 +24976,7 @@ paths: description: comment_id parameter in: path required: true - schema: *67 + schema: *68 requestBody: content: application/json: @@ -24950,7 +25037,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24979,13 +25066,13 @@ paths: description: comment_id parameter in: path required: true - schema: *67 + schema: *68 responses: '204': description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25015,7 +25102,7 @@ paths: description: comment_id parameter in: path required: true - schema: *67 + schema: *68 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. @@ -25035,7 +25122,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -25065,8 +25152,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true content: description: The reaction to use @@ -25124,10 +25211,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25168,7 +25255,7 @@ paths: description: comment_id parameter in: path required: true - schema: *67 + schema: *68 requestBody: content: application/json: @@ -25246,10 +25333,10 @@ paths: value: *166 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25338,7 +25425,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *56 + schema: *57 - name: until description: 'Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -25349,11 +25436,25 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -25449,7 +25550,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 '400': description: Bad Request content: &188 @@ -25458,7 +25559,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 application/scim+json: schema: title: Scim Error @@ -25485,7 +25586,7 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 '409': description: Conflict content: *169 @@ -25564,10 +25665,10 @@ paths: protected: false '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25610,7 +25711,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -25726,10 +25827,10 @@ paths: type: string '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *43 + content: *44 x-github: triggersNotification: true githubCloudOnly: false @@ -25771,7 +25872,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -25851,8 +25952,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: type: string @@ -25883,8 +25984,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *68 - required: *69 + properties: *69 + required: *70 active_lock_reason: type: string example: too heated @@ -25917,8 +26018,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assignees: type: array @@ -25926,8 +26027,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true requested_reviewers: @@ -25936,8 +26037,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true requested_teams: @@ -25962,8 +26063,8 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 sha: type: string user: @@ -25972,8 +26073,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true required: - label @@ -25992,8 +26093,8 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 sha: type: string user: @@ -26002,8 +26103,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true required: - label @@ -26079,7 +26180,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *53 + enum: *54 draft: description: Indicates whether or not the pull request is a draft. @@ -26574,7 +26675,7 @@ paths: schema: *6 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26643,8 +26744,16 @@ paths: in: path required: true schema: *128 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *31 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -26747,10 +26856,10 @@ paths: ..... '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 '500': description: Internal Error content: *175 @@ -26783,7 +26892,7 @@ paths: required: true schema: *128 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -26814,11 +26923,16 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -26884,7 +26998,7 @@ paths: required: true schema: *128 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -26905,7 +27019,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -27130,12 +27244,20 @@ paths: required: true schema: *128 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - name: per_page + description: Results per page (max 100). + in: query + schema: *31 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 responses: '200': description: response @@ -27317,7 +27439,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27347,7 +27469,7 @@ paths: required: true schema: *128 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -27356,7 +27478,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -27372,7 +27494,7 @@ paths: title: Status description: The status of a commit. type: object - properties: &277 + properties: &278 url: type: string avatar_url: @@ -27398,10 +27520,10 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true - required: &278 + required: &279 - url - avatar_url - id @@ -27893,7 +28015,7 @@ paths: content: *175 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27949,7 +28071,7 @@ paths: required: true schema: *128 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -28431,10 +28553,10 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '302': description: Found x-github: @@ -28462,7 +28584,7 @@ paths: required: true schema: *128 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -28751,10 +28873,10 @@ paths: payload: '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *43 + content: *44 '409': description: Conflict content: *169 @@ -28790,7 +28912,7 @@ paths: required: true schema: *128 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -28884,10 +29006,10 @@ paths: payload: '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 '409': description: Conflict content: *169 @@ -28931,7 +29053,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -29033,10 +29155,10 @@ paths: description: Response if repository is empty '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29091,10 +29213,11 @@ paths: schema: type: string default: none + nullable: true - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -29155,8 +29278,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -29194,8 +29317,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true required: &183 - id @@ -29540,7 +29663,7 @@ paths: message: 'Conflict: Commit status checks failed for topic-branch.' '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29632,7 +29755,7 @@ paths: production_environment: true '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29683,7 +29806,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -29728,8 +29851,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true description: description: A short description of the status. @@ -29787,8 +29910,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true required: &186 - id @@ -29844,7 +29967,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30033,7 +30156,7 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30103,10 +30226,10 @@ paths: value: *187 '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30161,7 +30284,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -30177,8 +30300,8 @@ paths: title: Event description: Event type: object - properties: *75 - required: *76 + properties: *76 + required: *77 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30214,15 +30337,30 @@ paths: - newest - oldest - stargazers + - watchers default: newest - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -30381,11 +30519,26 @@ paths: in: path required: true schema: *128 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -30400,8 +30553,8 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 examples: default: value: *189 @@ -30410,13 +30563,13 @@ paths: content: *188 '422': description: Validation Failed - content: *43 + content: *44 '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30490,16 +30643,16 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 '409': description: Conflict content: *169 '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30577,13 +30730,13 @@ paths: node_id: Q29udGVudCBvZiB0aGUgYmxvYg== '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *43 + content: *44 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30897,10 +31050,10 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31003,7 +31156,7 @@ paths: payload: '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31111,7 +31264,7 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31197,7 +31350,7 @@ paths: required: true schema: *128 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -31239,7 +31392,7 @@ paths: value: *194 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31265,7 +31418,7 @@ paths: required: true schema: *128 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -31276,7 +31429,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31483,7 +31636,7 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31558,7 +31711,7 @@ paths: value: *199 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31744,13 +31897,13 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31784,6 +31937,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -31845,10 +31999,10 @@ paths: truncated: false '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31877,7 +32031,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -32045,7 +32199,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32187,13 +32341,13 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *43 + content: *44 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32240,7 +32394,7 @@ paths: value: *204 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32362,10 +32516,10 @@ paths: value: *204 '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32399,7 +32553,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32435,7 +32589,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32473,7 +32627,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32518,8 +32672,8 @@ paths: title: Installation description: Installation type: object - properties: *22 - required: *23 + properties: *23 + required: *24 examples: default: value: *205 @@ -32527,7 +32681,7 @@ paths: description: Moved Permanently '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -32562,7 +32716,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -32583,7 +32737,7 @@ paths: required: *207 examples: default: - value: &317 + value: &318 - id: 1 repository: id: 1296269 @@ -32982,7 +33136,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *95 + schema: *96 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -32999,18 +33153,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *96 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *56 + schema: *57 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -33164,10 +33318,10 @@ paths: description: Moved Permanently '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33433,19 +33587,19 @@ paths: type: string '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *43 + content: *44 '503': description: Service Unavailable content: *181 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *48 + content: *49 x-github: triggersNotification: true githubCloudOnly: false @@ -33477,7 +33631,7 @@ paths: (when it was last pushed to). in: query required: false - schema: &249 + schema: &256 type: string enum: - created @@ -33498,11 +33652,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *56 + schema: *57 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -33559,10 +33713,10 @@ paths: schema: *6 '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33602,7 +33756,7 @@ paths: description: comment_id parameter in: path required: true - schema: *67 + schema: *68 responses: '200': description: response @@ -33648,7 +33802,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33685,7 +33839,7 @@ paths: description: comment_id parameter in: path required: true - schema: *67 + schema: *68 requestBody: content: application/json: @@ -33716,7 +33870,7 @@ paths: value: *213 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33745,7 +33899,7 @@ paths: description: comment_id parameter in: path required: true - schema: *67 + schema: *68 responses: '204': description: Empty response @@ -33778,7 +33932,7 @@ paths: description: comment_id parameter in: path required: true - schema: *67 + schema: *68 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. @@ -33798,7 +33952,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -33827,10 +33981,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33871,7 +34025,7 @@ paths: description: comment_id parameter in: path required: true - schema: *67 + schema: *68 requestBody: content: application/json: @@ -33926,10 +34080,10 @@ paths: value: *166 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33968,7 +34122,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -34001,8 +34155,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true event: type: string @@ -34045,8 +34199,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assigner: nullable: true @@ -34054,8 +34208,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true review_requester: nullable: true @@ -34063,8 +34217,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true requested_reviewer: nullable: true @@ -34072,8 +34226,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true requested_team: title: Team @@ -34151,7 +34305,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *53 + enum: *54 lock_reason: type: string nullable: true @@ -34325,7 +34479,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34539,13 +34693,13 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *48 + content: *49 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34631,10 +34785,10 @@ paths: description: Moved Permanently '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *48 + content: *49 '304': description: Not Modified x-github: @@ -34769,21 +34923,21 @@ paths: value: *217 '422': description: Validation Failed - content: *43 + content: *44 '503': description: Service Unavailable content: *181 '403': description: Forbidden - content: *31 + content: *32 '301': description: Moved Permanently '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *48 + content: *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35102,11 +35256,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *56 + schema: *57 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -35135,10 +35289,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *48 + content: *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35217,16 +35371,16 @@ paths: type: string '403': description: Forbidden - content: *31 + content: *32 '410': description: Gone - content: *48 + content: *49 '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 x-github: triggersNotification: true githubCloudOnly: false @@ -35261,7 +35415,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -35288,8 +35442,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true event: type: string @@ -35321,7 +35475,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *53 + enum: *54 body: type: string example: '":+1:"' @@ -35381,7 +35535,7 @@ paths: schema: *6 '410': description: Gone - content: *48 + content: *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35431,7 +35585,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -35474,7 +35628,7 @@ paths: schema: *6 '410': description: Gone - content: *48 + content: *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35543,10 +35697,10 @@ paths: value: *223 '410': description: Gone - content: *48 + content: *49 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35614,10 +35768,10 @@ paths: value: *223 '410': description: Gone - content: *48 + content: *49 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35652,7 +35806,7 @@ paths: description: Empty response '410': description: Gone - content: *48 + content: *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35716,10 +35870,10 @@ paths: default: true '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *48 + content: *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35775,16 +35929,16 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 '410': description: Gone - content: *48 + content: *49 '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35825,10 +35979,10 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35878,7 +36032,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -35907,13 +36061,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *48 + content: *49 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35995,10 +36149,10 @@ paths: value: *166 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -36042,7 +36196,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -36069,13 +36223,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *48 + content: *49 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36120,7 +36274,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -36253,7 +36407,7 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36301,7 +36455,7 @@ paths: value: *228 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36363,7 +36517,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -36392,7 +36546,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36472,10 +36626,10 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36523,7 +36677,7 @@ paths: value: *230 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36689,8 +36843,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *72 - required: *73 + properties: *73 + required: *74 required: - _links - git_url @@ -36856,10 +37010,10 @@ paths: message: Merge Conflict '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36919,7 +37073,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -36935,8 +37089,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *68 - required: *69 + properties: *69 + required: *70 examples: default: value: @@ -36981,7 +37135,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37045,8 +37199,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *68 - required: *69 + properties: *69 + required: *70 examples: default: value: &232 @@ -37091,10 +37245,10 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37135,14 +37289,14 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *68 - required: *69 + properties: *69 + required: *70 examples: default: value: *232 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37209,8 +37363,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *68 - required: *69 + properties: *69 + required: *70 examples: default: value: *232 @@ -37248,7 +37402,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37282,7 +37436,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -37351,7 +37505,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *56 + schema: *57 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -37362,7 +37516,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -37378,8 +37532,8 @@ paths: title: Thread description: Thread type: object - properties: *77 - required: *78 + properties: *78 + required: *79 examples: default: value: *237 @@ -37538,7 +37692,7 @@ paths: public: true '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37618,10 +37772,10 @@ paths: value: *240 '422': description: Validation Failed - content: *43 + content: *44 '415': description: Preview Header Missing - content: *29 + content: *30 '409': description: Conflict content: *169 @@ -37724,7 +37878,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *43 + content: *44 '400': description: Bad Request content: *188 @@ -37764,13 +37918,13 @@ paths: description: Empty response '422': description: Validation Failed - content: *43 + content: *44 '415': description: Preview Header Missing - content: *29 + content: *30 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37806,7 +37960,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -37842,8 +37996,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true commit: type: string @@ -38097,6 +38251,21 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -38160,7 +38329,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -38214,7 +38383,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -38281,7 +38450,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: Responds with effective values inherited from owner and/or @@ -38347,7 +38516,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -38407,16 +38576,16 @@ paths: schema: *6 '401': description: Requires Authentication - content: *32 + content: *33 '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *48 + content: *49 '422': description: Validation Failed content: *105 @@ -38487,16 +38656,16 @@ paths: value: *124 '401': description: Requires Authentication - content: *32 + content: *33 '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *48 + content: *49 '422': description: Validation Failed content: *105 @@ -38587,7 +38756,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -38617,7 +38786,7 @@ paths: description: Not Modified '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38717,7 +38886,7 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: &253 + properties: &252 url: type: string format: uri @@ -38788,8 +38957,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: type: string @@ -38821,8 +38990,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *68 - required: *69 + properties: *69 + required: *70 active_lock_reason: type: string example: too heated @@ -38855,8 +39024,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assignees: type: array @@ -38864,8 +39033,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true requested_reviewers: @@ -38874,8 +39043,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true requested_teams: @@ -39581,8 +39750,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *72 - required: *73 + properties: *73 + required: *74 pushed_at: type: string format: date-time @@ -39825,7 +39994,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *53 + enum: *54 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -39849,8 +40018,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true comments: type: integer @@ -39875,7 +40044,7 @@ paths: changed_files: type: integer example: 5 - required: &254 + required: &253 - _links - assignee - labels @@ -39919,7 +40088,7 @@ paths: - review_comments examples: default: - value: &255 + value: &254 url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 node_id: MDExOlB1bGxSZXF1ZXN0MQ== @@ -40412,10 +40581,10 @@ paths: type: string '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *43 + content: *44 x-github: triggersNotification: true githubCloudOnly: false @@ -40457,11 +40626,14 @@ paths: required: true schema: *128 - name: sort - description: One of `created` (when the repository was starred) or `updated` - (when it was last pushed to). in: query required: false - schema: *249 + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -40477,11 +40649,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *56 + schema: *57 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -40498,7 +40670,7 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: &250 + properties: &249 url: description: URL for the pull request review comment example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 @@ -40553,8 +40725,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: description: The text of the comment. @@ -40585,7 +40757,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *53 + enum: *54 _links: type: object properties: @@ -40623,15 +40795,15 @@ paths: reactions: title: Reaction Rollup type: object - properties: *70 - required: *71 + properties: *71 + required: *72 body_html: type: string example: '"

comment body

"' body_text: type: string example: '"comment body"' - required: &251 + required: &250 - url - id - node_id @@ -40761,7 +40933,7 @@ paths: description: comment_id parameter in: path required: true - schema: *67 + schema: *68 responses: '200': description: response @@ -40772,11 +40944,11 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *250 - required: *251 + properties: *249 + required: *250 examples: default: - value: &252 + value: &251 url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 id: 10 @@ -40822,7 +40994,7 @@ paths: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40882,7 +41054,7 @@ paths: description: comment_id parameter in: path required: true - schema: *67 + schema: *68 requestBody: content: application/json: @@ -40906,11 +41078,11 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *250 - required: *251 + properties: *249 + required: *250 examples: default: - value: *252 + value: *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40960,13 +41132,13 @@ paths: description: comment_id parameter in: path required: true - schema: *67 + schema: *68 responses: '204': description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40996,7 +41168,7 @@ paths: description: comment_id parameter in: path required: true - schema: *67 + schema: *68 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. @@ -41016,7 +41188,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -41045,10 +41217,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41089,7 +41261,7 @@ paths: description: comment_id parameter in: path required: true - schema: *67 + schema: *68 requestBody: content: application/json: @@ -41144,10 +41316,10 @@ paths: value: *166 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41201,7 +41373,7 @@ paths: - name: pull_number in: path required: true - schema: &256 + schema: &255 type: integer responses: '200': @@ -41216,11 +41388,11 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: *253 - required: *254 + properties: *252 + required: *253 examples: default: - value: *255 + value: *254 '304': description: Not Modified '500': @@ -41228,7 +41400,7 @@ paths: content: *175 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41259,7 +41431,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 requestBody: content: application/json: @@ -41305,17 +41477,17 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: *253 - required: *254 + properties: *252 + required: *253 examples: default: - value: *255 + value: *254 '422': description: Validation Failed - content: *43 + content: *44 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41358,13 +41530,13 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: sort description: One of `created` (when the repository was starred) or `updated` (when it was last pushed to). in: query required: false - schema: *249 + schema: *256 - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -41380,11 +41552,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *56 + schema: *57 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -41401,8 +41573,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *250 - required: *251 + properties: *249 + required: *250 examples: default: value: *257 @@ -41474,7 +41646,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 responses: '201': description: response @@ -41675,12 +41847,12 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: comment_id description: comment_id parameter in: path required: true - schema: *67 + schema: *68 requestBody: content: application/json: @@ -41704,8 +41876,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *250 - required: *251 + properties: *249 + required: *250 examples: default: value: @@ -41759,7 +41931,7 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 x-github: triggersNotification: true githubCloudOnly: false @@ -41792,11 +41964,11 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -41851,11 +42023,11 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -41894,7 +42066,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *43 + content: *44 '500': description: Internal Error content: *175 @@ -41926,7 +42098,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 responses: '204': description: Response if pull request has been merged @@ -41958,7 +42130,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 requestBody: content: application/json: @@ -42042,13 +42214,13 @@ paths: message: Head branch was modified. Review and try the merge again. '422': description: Validation Failed - content: *43 + content: *44 '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 x-github: triggersNotification: true githubCloudOnly: false @@ -42078,11 +42250,11 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -42103,8 +42275,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true teams: type: array @@ -42184,7 +42356,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 requestBody: content: application/json: @@ -42730,7 +42902,7 @@ paths: description: Response if user is not a collaborator '403': description: Forbidden - content: *31 + content: *32 x-github: triggersNotification: true githubCloudOnly: false @@ -42759,7 +42931,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 requestBody: content: application/json: @@ -42790,7 +42962,7 @@ paths: description: response '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42819,11 +42991,11 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -42853,8 +43025,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: description: The text of the review. @@ -42907,7 +43079,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *53 + enum: *54 required: &262 - id - node_id @@ -42994,7 +43166,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 requestBody: content: application/json: @@ -43120,7 +43292,7 @@ paths: content: *105 '403': description: Forbidden - content: *31 + content: *32 x-github: triggersNotification: true githubCloudOnly: false @@ -43150,7 +43322,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: review_id description: review_id parameter in: path @@ -43206,7 +43378,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43234,7 +43406,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: review_id description: review_id parameter in: path @@ -43332,7 +43504,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: review_id description: review_id parameter in: path @@ -43357,7 +43529,7 @@ paths: content: *105 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43386,7 +43558,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: review_id description: review_id parameter in: path @@ -43395,7 +43567,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -43454,8 +43626,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: type: string @@ -43481,7 +43653,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *53 + enum: *54 _links: type: object properties: @@ -43621,7 +43793,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43652,7 +43824,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: review_id description: review_id parameter in: path @@ -43721,7 +43893,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed content: *105 @@ -43753,7 +43925,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: review_id description: review_id parameter in: path @@ -43798,13 +43970,13 @@ paths: value: *265 '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed content: *105 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43834,7 +44006,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 requestBody: content: application/json: @@ -43870,13 +44042,13 @@ paths: url: https://github.com/repos/octocat/Hello-World/pulls/53 '422': description: Validation Failed - content: *43 + content: *44 '403': description: Forbidden - content: *31 + content: *32 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -43932,7 +44104,7 @@ paths: required: *267 examples: default: - value: + value: &268 type: file encoding: base64 size: 5362 @@ -43950,10 +44122,72 @@ paths: html: https://github.com/octokit/octokit.rb/blob/master/README.md '404': description: Resource Not Found - content: *24 + content: *25 + '422': + description: Validation Failed + content: *44 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository-readme + parameters: + - name: owner + in: path + required: true + schema: *127 + - name: repo + in: path + required: true + schema: *128 + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + title: Content File + description: Content File + type: object + properties: *266 + required: *267 + examples: + default: + value: *268 + '404': + description: Resource Not Found + content: *25 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43985,7 +44219,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -44001,7 +44235,7 @@ paths: title: Release description: A release. type: object - properties: &268 + properties: &269 url: type: string format: uri @@ -44061,8 +44295,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assets: type: array @@ -44070,7 +44304,7 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: &270 + properties: &271 url: type: string format: uri @@ -44112,10 +44346,10 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true - required: &271 + required: &272 - id - name - content_type @@ -44133,7 +44367,7 @@ paths: type: string body_text: type: string - required: &269 + required: &270 - assets_url - upload_url - tarball_url @@ -44228,7 +44462,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44305,11 +44539,11 @@ paths: title: Release description: A release. type: object - properties: *268 - required: *269 + properties: *269 + required: *270 examples: default: - value: &274 + value: &275 url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 assets_url: https://api.github.com/repos/octocat/Hello-World/releases/1/assets @@ -44384,7 +44618,7 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 x-github: triggersNotification: true githubCloudOnly: false @@ -44418,7 +44652,7 @@ paths: description: asset_id parameter in: path required: true - schema: &272 + schema: &273 type: integer responses: '200': @@ -44433,11 +44667,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *270 - required: *271 + properties: *271 + required: *272 examples: default: - value: &273 + value: &274 url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip id: 1 @@ -44471,10 +44705,10 @@ paths: site_admin: false '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 '302': description: Found x-github: @@ -44505,7 +44739,7 @@ paths: description: asset_id parameter in: path required: true - schema: *272 + schema: *273 requestBody: content: application/json: @@ -44534,11 +44768,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *270 - required: *271 + properties: *271 + required: *272 examples: default: - value: *273 + value: *274 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44567,7 +44801,7 @@ paths: description: asset_id parameter in: path required: true - schema: *272 + schema: *273 responses: '204': description: Empty response @@ -44608,11 +44842,11 @@ paths: title: Release description: A release. type: object - properties: *268 - required: *269 + properties: *269 + required: *270 examples: default: - value: *274 + value: *275 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44639,7 +44873,7 @@ paths: required: true schema: *128 - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -44654,14 +44888,14 @@ paths: title: Release description: A release. type: object - properties: *268 - required: *269 + properties: *269 + required: *270 examples: default: - value: *274 + value: *275 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44692,7 +44926,7 @@ paths: description: release_id parameter in: path required: true - schema: &275 + schema: &276 type: integer responses: '200': @@ -44704,14 +44938,14 @@ paths: title: Release description: A release. type: object - properties: *268 - required: *269 + properties: *269 + required: *270 examples: default: - value: *274 + value: *275 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44740,7 +44974,7 @@ paths: description: release_id parameter in: path required: true - schema: *275 + schema: *276 requestBody: content: application/json: @@ -44786,11 +45020,11 @@ paths: title: Release description: A release. type: object - properties: *268 - required: *269 + properties: *269 + required: *270 examples: default: - value: *274 + value: *275 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44819,7 +45053,7 @@ paths: description: release_id parameter in: path required: true - schema: *275 + schema: *276 responses: '204': description: Empty response @@ -44852,11 +45086,11 @@ paths: description: release_id parameter in: path required: true - schema: *275 + schema: *276 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -44872,8 +45106,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *270 - required: *271 + properties: *271 + required: *272 examples: default: value: @@ -44970,7 +45204,7 @@ paths: description: release_id parameter in: path required: true - schema: *275 + schema: *276 - name: name in: query schema: @@ -44994,8 +45228,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *270 - required: *271 + properties: *271 + required: *272 examples: response-for-successful-upload: value: @@ -45061,7 +45295,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -45077,8 +45311,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default-response: @@ -45119,8 +45353,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true required: - starred_at @@ -45156,7 +45390,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45195,7 +45429,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: &276 + items: &277 type: integer examples: default: @@ -45330,8 +45564,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true total: type: integer @@ -45545,7 +45779,7 @@ paths: - 3 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45591,7 +45825,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: *276 + items: *277 examples: default: value: @@ -45685,8 +45919,8 @@ paths: title: Status description: The status of a commit. type: object - properties: *277 - required: *278 + properties: *278 + required: *279 examples: default: value: @@ -45752,7 +45986,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -45768,8 +46002,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -45814,7 +46048,7 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: &279 + properties: &280 subscribed: description: Determines if notifications should be received from this repository. @@ -45839,7 +46073,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/example - required: &280 + required: &281 - created_at - ignored - reason @@ -45859,7 +46093,7 @@ paths: description: Response if you don't subscribe to the repository '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -45912,8 +46146,8 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: *279 - required: *280 + properties: *280 + required: *281 examples: default: value: @@ -45980,7 +46214,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -46112,7 +46346,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -46164,6 +46398,14 @@ paths: in: path required: true schema: *128 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *31 responses: '200': description: response @@ -46173,16 +46415,16 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: &281 + properties: &282 names: type: array items: type: string - required: &282 + required: &283 - names examples: default: - value: &283 + value: &284 names: - octocat - atom @@ -46190,10 +46432,10 @@ paths: - api '415': description: Preview Header Missing - content: *29 + content: *30 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46256,17 +46498,17 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: *281 - required: *282 + properties: *282 + required: *283 examples: default: - value: *283 + value: *284 '415': description: Preview Header Missing - content: *29 + content: *30 '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed content: *105 @@ -46338,8 +46580,8 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 examples: default: value: *189 @@ -46538,8 +46780,8 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 examples: default: value: @@ -46798,7 +47040,7 @@ paths: type: string '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified x-github: @@ -46863,7 +47105,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: &284 + schema: &285 type: string enum: - desc @@ -46872,7 +47114,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -46941,7 +47183,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: &285 + items: &286 type: object properties: object_url: @@ -47058,10 +47300,10 @@ paths: content: *181 '422': description: Validation Failed - content: *43 + content: *44 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47114,11 +47356,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *284 + schema: *285 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -47218,8 +47460,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true committer: nullable: true @@ -47252,7 +47494,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *285 + items: *286 required: - sha - node_id @@ -47385,7 +47627,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47463,11 +47705,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *284 + schema: *285 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -47531,8 +47773,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true user: @@ -47541,8 +47783,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true labels: type: array @@ -47572,8 +47814,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true milestone: nullable: true @@ -47581,8 +47823,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *68 - required: *69 + properties: *69 + required: *70 comments: type: integer created_at: @@ -47598,7 +47840,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *285 + items: *286 pull_request: type: object properties: @@ -47636,15 +47878,15 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *53 + enum: *54 draft: type: boolean repository: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 body_html: type: string body_text: @@ -47662,8 +47904,8 @@ paths: They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true required: - assignee @@ -47784,12 +48026,12 @@ paths: content: *181 '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47846,7 +48088,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *284 + schema: *285 responses: '200': description: response @@ -47891,7 +48133,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *285 + items: *286 required: - id - node_id @@ -47927,13 +48169,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47994,11 +48236,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *284 + schema: *285 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -48040,8 +48282,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true private: type: boolean @@ -48217,8 +48459,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *72 - required: *73 + properties: *73 + required: *74 permissions: type: object properties: @@ -48235,7 +48477,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *285 + items: *286 temp_clone_token: type: string allow_merge_commit: @@ -48432,7 +48674,7 @@ paths: content: *181 '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified x-github: @@ -48539,7 +48781,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *285 + items: *286 related: type: array nullable: true @@ -48684,7 +48926,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48747,11 +48989,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *284 + schema: *285 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -48859,7 +49101,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *285 + items: *286 blog: type: string nullable: true @@ -48922,7 +49164,7 @@ paths: content: *181 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49031,7 +49273,7 @@ paths: application/json: schema: type: object - properties: &286 + properties: &287 status: type: string scheduled_time: @@ -49050,7 +49292,7 @@ paths: - number examples: default: - value: &287 + value: &288 status: scheduled scheduled_time: Tuesday, January 22 at 15:34 -0800 connection_services: @@ -49085,10 +49327,10 @@ paths: application/json: schema: type: object - properties: *286 + properties: *287 examples: default: - value: *287 + value: *288 requestBody: content: application/json: @@ -49598,14 +49840,14 @@ paths: type: array items: type: object - properties: &288 + properties: &289 key: type: string pretty-print: type: string examples: default: - value: &289 + value: &290 - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64 - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... @@ -49634,10 +49876,10 @@ paths: type: array items: type: object - properties: *288 + properties: *289 examples: default: - value: *289 + value: *290 requestBody: content: application/json: @@ -49673,10 +49915,10 @@ paths: type: array items: type: object - properties: *288 + properties: *289 examples: default: - value: *289 + value: *290 requestBody: content: application/json: @@ -49967,7 +50209,7 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *96 + schema: *9 - name: per_page description: Results per page (max 100) in: query @@ -49988,15 +50230,15 @@ paths: description: A team discussion is a persistent record of a free-form conversation within a team. type: object - properties: &290 + properties: &291 author: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: description: The main text of the discussion. @@ -50067,9 +50309,9 @@ paths: reactions: title: Reaction Rollup type: object - properties: *70 - required: *71 - required: &291 + properties: *71 + required: *72 + required: &292 - author - body - body_html @@ -50199,11 +50441,11 @@ paths: description: A team discussion is a persistent record of a free-form conversation within a team. type: object - properties: *290 - required: *291 + properties: *291 + required: *292 examples: default: - value: &292 + value: &293 author: login: octocat id: 1 @@ -50326,7 +50568,7 @@ paths: - name: discussion_number in: path required: true - schema: &293 + schema: &294 type: integer responses: '200': @@ -50338,11 +50580,11 @@ paths: description: A team discussion is a persistent record of a free-form conversation within a team. type: object - properties: *290 - required: *291 + properties: *291 + required: *292 examples: default: - value: *292 + value: *293 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50392,7 +50634,7 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 responses: '200': description: response @@ -50403,8 +50645,8 @@ paths: description: A team discussion is a persistent record of a free-form conversation within a team. type: object - properties: *290 - required: *291 + properties: *291 + required: *292 examples: default: value: @@ -50517,7 +50759,7 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 responses: '204': description: Empty response @@ -50560,12 +50802,12 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *96 + schema: *9 - name: per_page description: Results per page (max 100) in: query @@ -50585,15 +50827,15 @@ paths: title: Team Discussion Comment description: A reply to a discussion within a team. type: object - properties: &294 + properties: &295 author: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: description: The main text of the comment. @@ -50643,9 +50885,9 @@ paths: reactions: title: Reaction Rollup type: object - properties: *70 - required: *71 - required: &295 + properties: *71 + required: *72 + required: &296 - author - body - body_html @@ -50757,7 +50999,7 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 responses: '201': description: response @@ -50767,11 +51009,11 @@ paths: title: Team Discussion Comment description: A reply to a discussion within a team. type: object - properties: *294 - required: *295 + properties: *295 + required: *296 examples: default: - value: &296 + value: &297 author: login: octocat id: 1 @@ -50876,11 +51118,11 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 - name: comment_number in: path required: true - schema: &297 + schema: &298 type: integer responses: '200': @@ -50891,11 +51133,11 @@ paths: title: Team Discussion Comment description: A reply to a discussion within a team. type: object - properties: *294 - required: *295 + properties: *295 + required: *296 examples: default: - value: *296 + value: *297 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50944,11 +51186,11 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 - name: comment_number in: path required: true - schema: *297 + schema: *298 responses: '200': description: response @@ -50958,8 +51200,8 @@ paths: title: Team Discussion Comment description: A reply to a discussion within a team. type: object - properties: *294 - required: *295 + properties: *295 + required: *296 examples: default: value: @@ -51065,11 +51307,11 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 - name: comment_number in: path required: true - schema: *297 + schema: *298 responses: '204': description: Empty response @@ -51112,11 +51354,11 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 - name: comment_number in: path required: true - schema: *297 + schema: *298 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. @@ -51213,11 +51455,11 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 - name: comment_number in: path required: true - schema: *297 + schema: *298 responses: '201': description: response @@ -51305,7 +51547,7 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.18/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. @@ -51402,7 +51644,7 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 responses: '201': description: response @@ -51514,8 +51756,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -51654,7 +51896,7 @@ paths: resource: TeamMember '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51738,7 +51980,7 @@ paths: title: Team Membership description: Team Membership type: object - properties: &298 + properties: &299 url: type: string format: uri @@ -51752,7 +51994,7 @@ paths: type: string state: type: string - required: &299 + required: &300 - role - state - url @@ -51820,8 +52062,8 @@ paths: title: Team Membership description: Team Membership type: object - properties: *298 - required: *299 + properties: *299 + required: *300 examples: response-if-users-membership-with-team-is-now-active: summary: Response if user's membership with team is now active @@ -51960,7 +52202,7 @@ paths: title: Team Project description: A team's access to a project. type: object - properties: &300 + properties: &301 owner_url: type: string url: @@ -51986,8 +52228,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -52014,7 +52256,7 @@ paths: - read - write - admin - required: &301 + required: &302 - owner_url - url - html_url @@ -52131,8 +52373,8 @@ paths: title: Team Project description: A team's access to a project. type: object - properties: *300 - required: *301 + properties: *301 + required: *302 examples: default: value: @@ -52361,7 +52603,7 @@ paths: required: *109 examples: default: - value: *302 + value: *303 headers: Link: example: ; rel="next", ; @@ -53038,7 +53280,7 @@ paths: - title: Private User description: Private User type: object - properties: &303 + properties: &304 login: type: string example: octocat @@ -53191,7 +53433,7 @@ paths: type: boolean ldap_dn: type: string - required: &304 + required: &305 - avatar_url - events_url - followers_url @@ -53232,7 +53474,7 @@ paths: - title: Public User description: Public User type: object - properties: &319 + properties: &320 login: type: string id: @@ -53349,7 +53591,7 @@ paths: collaborators: type: integer example: 3 - required: &320 + required: &321 - avatar_url - events_url - followers_url @@ -53466,10 +53708,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -53535,8 +53777,8 @@ paths: title: Private User description: Private User type: object - properties: *303 - required: *304 + properties: *304 + required: *305 examples: default: value: @@ -53586,16 +53828,16 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -53617,7 +53859,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -53633,7 +53875,7 @@ paths: title: Email description: Email type: object - properties: &305 + properties: &306 email: type: string format: email @@ -53648,14 +53890,14 @@ paths: type: string example: public nullable: true - required: &306 + required: &307 - email - primary - verified - visibility examples: default: - value: &316 + value: &317 - email: octocat@github.com verified: true primary: true @@ -53669,13 +53911,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -53734,8 +53976,8 @@ paths: title: Email description: Email type: object - properties: *305 - required: *306 + properties: *306 + required: *307 examples: default: value: @@ -53753,18 +53995,18 @@ paths: visibility: '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -53819,16 +54061,16 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -53849,7 +54091,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -53865,8 +54107,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -53880,10 +54122,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -53904,7 +54146,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -53920,8 +54162,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -53935,10 +54177,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -53972,15 +54214,15 @@ paths: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54011,13 +54253,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54046,13 +54288,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54074,7 +54316,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -54090,7 +54332,7 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: &307 + properties: &308 id: type: integer example: 3 @@ -54184,7 +54426,7 @@ paths: raw_key: type: string nullable: true - required: &308 + required: &309 - id - primary_key_id - key_id @@ -54200,7 +54442,7 @@ paths: - subkeys examples: default: - value: &321 + value: &322 - id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -54237,13 +54479,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54282,11 +54524,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *307 - required: *308 + properties: *308 + required: *309 examples: default: - value: &309 + value: &310 id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -54318,18 +54560,18 @@ paths: PGP PUBLIC KEY BLOCK-----"' '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54352,7 +54594,7 @@ paths: description: gpg_key_id parameter in: path required: true - schema: &310 + schema: &311 type: integer responses: '200': @@ -54363,22 +54605,22 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *307 - required: *308 + properties: *308 + required: *309 examples: default: - value: *309 + value: *310 '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54401,24 +54643,24 @@ paths: description: gpg_key_id parameter in: path required: true - schema: *310 + schema: *311 responses: '204': description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54453,7 +54695,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -54478,8 +54720,8 @@ paths: title: Installation description: Installation type: object - properties: *22 - required: *23 + properties: *23 + required: *24 examples: default: value: @@ -54570,13 +54812,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54618,11 +54860,11 @@ paths: description: installation_id parameter in: path required: true - schema: *25 + schema: *26 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -54649,8 +54891,8 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 examples: default: value: @@ -54767,10 +55009,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '304': description: Not Modified x-github: @@ -54810,23 +55052,23 @@ paths: description: installation_id parameter in: path required: true - schema: *25 + schema: *26 - name: repository_id in: path required: true - schema: &311 + schema: &312 type: integer responses: '204': description: Empty response '403': description: Forbidden - content: *31 + content: *32 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54856,22 +55098,22 @@ paths: description: installation_id parameter in: path required: true - schema: *25 + schema: *26 - name: repository_id in: path required: true - schema: *311 + schema: *312 responses: '204': description: Empty response '403': description: Forbidden - content: *31 + content: *32 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54916,6 +55158,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -54934,7 +55177,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *95 + schema: *96 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -54951,18 +55194,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *96 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *56 + schema: *57 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -54991,7 +55234,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified x-github: @@ -55023,7 +55266,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -55039,7 +55282,7 @@ paths: title: Key description: Key type: object - properties: &312 + properties: &313 key_id: type: string key: @@ -55057,7 +55300,7 @@ paths: type: boolean read_only: type: boolean - required: &313 + required: &314 - key_id - key - id @@ -55094,13 +55337,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55144,11 +55387,11 @@ paths: title: Key description: Key type: object - properties: *312 - required: *313 + properties: *313 + required: *314 examples: default: - value: &314 + value: &315 key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -55159,18 +55402,18 @@ paths: read_only: false '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55204,22 +55447,22 @@ paths: title: Key description: Key type: object - properties: *312 - required: *313 + properties: *313 + required: *314 examples: default: - value: *314 + value: *315 '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55250,13 +55493,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55288,7 +55531,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -55390,13 +55633,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55417,7 +55660,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 responses: '200': description: response @@ -55470,10 +55713,10 @@ paths: site_admin: false '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55493,7 +55736,7 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 requestBody: content: application/json: @@ -55562,13 +55805,13 @@ paths: site_admin: false '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55594,7 +55837,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -55610,11 +55853,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *83 - required: *84 + properties: *84 + required: *85 examples: default: - value: *315 + value: *316 headers: Link: example: ; rel="next", ; @@ -55624,10 +55867,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55712,13 +55955,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed content: *105 @@ -55751,7 +55994,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -55767,11 +56010,11 @@ paths: title: Email description: Email type: object - properties: *305 - required: *306 + properties: *306 + required: *307 examples: default: - value: *316 + value: *317 headers: Link: example: ; rel="next", ; @@ -55781,13 +56024,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55873,7 +56116,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -55884,7 +56127,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *56 + schema: *57 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -55903,12 +56146,12 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 examples: default: summary: Default response - value: &318 + value: &319 - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World @@ -56015,15 +56258,15 @@ paths: anonymous_access_enabled: false '422': description: Validation Failed - content: *43 + content: *44 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56145,8 +56388,8 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 examples: default: value: *189 @@ -56157,18 +56400,18 @@ paths: type: string '401': description: Requires Authentication - content: *32 + content: *33 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *43 + content: *44 '400': description: Bad Request content: *188 @@ -56210,7 +56453,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -56231,7 +56474,7 @@ paths: required: *207 examples: default: - value: *317 + value: *318 headers: Link: example: ; rel="next", ; @@ -56241,13 +56484,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56275,13 +56518,13 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 '409': description: Conflict content: *169 '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified x-github: @@ -56315,10 +56558,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56344,16 +56587,16 @@ paths: (when it was last pushed to). in: query required: false - schema: *249 + schema: *256 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *96 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -56369,12 +56612,12 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 examples: default-response: summary: Default response - value: *318 + value: *319 application/vnd.github.v3.star+json: schema: type: array @@ -56382,7 +56625,7 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: &322 + properties: &323 starred_at: type: string format: date-time @@ -56390,15 +56633,15 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 - required: &323 + properties: *52 + required: *53 + required: &324 - starred_at - repo examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: &324 + value: &325 - starred_at: '2011-01-16T19:06:43Z' repo: id: 1296269 @@ -56514,10 +56757,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56554,15 +56797,15 @@ paths: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 '401': description: Requires Authentication - content: *32 + content: *33 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56593,13 +56836,13 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '401': description: Requires Authentication - content: *32 + content: *33 '304': description: Not Modified x-github: @@ -56631,15 +56874,15 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 '401': description: Requires Authentication - content: *32 + content: *33 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56660,7 +56903,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -56680,7 +56923,7 @@ paths: required: *109 examples: default: - value: *302 + value: *303 headers: Link: example: ; rel="next", ; @@ -56690,10 +56933,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56717,7 +56960,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -56792,10 +57035,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56825,7 +57068,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 responses: '200': description: response @@ -56837,8 +57080,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -56888,13 +57131,13 @@ paths: - title: Private User description: Private User type: object - properties: *303 - required: *304 + properties: *304 + required: *305 - title: Public User description: Public User type: object - properties: *319 - required: *320 + properties: *320 + required: *321 additionalProperties: false examples: default-response: @@ -56974,7 +57217,7 @@ paths: private_repos: 9999 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57000,7 +57243,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57016,8 +57259,8 @@ paths: title: Event description: Event type: object - properties: *75 - required: *76 + properties: *76 + required: *77 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57043,11 +57286,11 @@ paths: - name: org in: path required: true - schema: *85 + schema: *86 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57063,8 +57306,8 @@ paths: title: Event description: Event type: object - properties: *75 - required: *76 + properties: *76 + required: *77 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57089,7 +57332,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57105,8 +57348,8 @@ paths: title: Event description: Event type: object - properties: *75 - required: *76 + properties: *76 + required: *77 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57131,7 +57374,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57147,8 +57390,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -57182,7 +57425,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57198,8 +57441,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -57267,11 +57510,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *56 + schema: *57 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57287,11 +57530,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *57 - required: *58 + properties: *58 + required: *59 examples: default: - value: *59 + value: *60 headers: Link: example: ; rel="next", ; @@ -57299,7 +57542,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57325,7 +57568,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57341,11 +57584,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *307 - required: *308 + properties: *308 + required: *309 examples: default: - value: *321 + value: *322 headers: Link: example: ; rel="next", ; @@ -57432,10 +57675,10 @@ paths: octicon: repo '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57476,8 +57719,8 @@ paths: title: Installation description: Installation type: object - properties: *22 - required: *23 + properties: *23 + required: *24 examples: default: value: *205 @@ -57511,7 +57754,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57572,7 +57815,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57588,11 +57831,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *83 - required: *84 + properties: *84 + required: *85 examples: default: - value: *315 + value: *316 headers: Link: example: ; rel="next", ; @@ -57634,7 +57877,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57694,10 +57937,10 @@ paths: schema: *6 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *43 + content: *44 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57731,7 +57974,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57747,8 +57990,8 @@ paths: title: Event description: Event type: object - properties: *75 - required: *76 + properties: *76 + required: *77 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57773,7 +58016,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57789,8 +58032,8 @@ paths: title: Event description: Event type: object - properties: *75 - required: *76 + properties: *76 + required: *77 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57849,7 +58092,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57869,7 +58112,7 @@ paths: required: *109 examples: default: - value: *302 + value: *303 headers: Link: example: ; rel="next", ; @@ -57961,16 +58204,16 @@ paths: (when it was last pushed to). in: query required: false - schema: *249 + schema: *256 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *96 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57986,12 +58229,12 @@ paths: title: Repository description: A git repository type: object - properties: *51 - required: *52 + properties: *52 + required: *53 examples: default-response: summary: Default response - value: *318 + value: *319 application/vnd.github.v3.star+json: schema: type: array @@ -57999,12 +58242,12 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: *322 - required: *323 + properties: *323 + required: *324 examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: *324 + value: *325 headers: Link: example: ; rel="next", ; @@ -58034,7 +58277,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -58054,7 +58297,7 @@ paths: required: *109 examples: default: - value: *302 + value: *303 headers: Link: example: ; rel="next", ; diff --git a/descriptions/ghes-2.18/ghes-2.18.json b/descriptions/ghes-2.18/ghes-2.18.json index cdf565ea4e..9a9cd1fe1c 100644 --- a/descriptions/ghes-2.18/ghes-2.18.json +++ b/descriptions/ghes-2.18/ghes-2.18.json @@ -824,6 +824,32 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1284,6 +1310,23 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -1794,6 +1837,24 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -2902,6 +2963,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -3294,6 +3364,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -5853,6 +5932,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -6007,6 +6087,9 @@ }, { "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -7658,6 +7741,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -8345,6 +8429,24 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -15587,6 +15689,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -15961,9 +16083,15 @@ { "$ref": "#/components/parameters/repo" }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -16030,7 +16158,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -16063,6 +16191,14 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -16138,7 +16274,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -16239,13 +16375,19 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -16300,7 +16442,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -16445,7 +16587,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -16546,7 +16688,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -16726,7 +16868,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -16974,7 +17116,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -17665,7 +17808,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -17675,6 +17819,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -17732,6 +17896,26 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -17739,6 +17923,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -18311,7 +18496,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -18397,7 +18582,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -18771,7 +18956,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -23722,6 +23908,23 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -24401,7 +24604,17 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/sort" + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "created_at" + ] + } }, { "name": "direction", @@ -26624,6 +26837,79 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content-file" + }, + "examples": { + "default": { + "$ref": "#/components/examples/content-file" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -27037,7 +27323,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -28259,6 +28545,12 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" } ], "responses": { @@ -33649,6 +33941,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -36709,6 +37002,20 @@ "type": "integer" } }, + "direction": { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, "key-ids": { "name": "key_ids", "in": "path", @@ -36862,20 +37169,6 @@ "type": "string" } }, - "direction": { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, "owner": { "name": "owner", "in": "path", diff --git a/descriptions/ghes-2.18/ghes-2.18.yaml b/descriptions/ghes-2.18/ghes-2.18.yaml index c61a4ed016..0cf00d1fa5 100644 --- a/descriptions/ghes-2.18/ghes-2.18.yaml +++ b/descriptions/ghes-2.18/ghes-2.18.yaml @@ -600,6 +600,23 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string responses: '200': description: response @@ -904,6 +921,17 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1294,6 +1322,19 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: One of `created` (when the repository was starred) or `updated` + (when it was last pushed to) or `name`. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -2099,6 +2140,12 @@ paths: parameters: - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -2385,6 +2432,12 @@ paths: parameters: - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -4167,6 +4220,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -4269,6 +4323,7 @@ paths: schema: type: boolean - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -5439,6 +5494,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -5911,6 +5967,18 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: The sort order for the response collection. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -11312,6 +11380,20 @@ paths: type: string - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -11604,8 +11686,10 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -11650,7 +11734,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -11671,6 +11755,11 @@ paths: default: latest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -11724,7 +11813,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -11799,12 +11888,14 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -11840,7 +11931,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -11998,7 +12089,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -12059,7 +12150,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -12195,7 +12286,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -12363,6 +12454,7 @@ paths: schema: type: string default: none + nullable: true - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" responses: @@ -12964,9 +13056,24 @@ paths: - newest - oldest - stargazers + - watchers default: newest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -13005,11 +13112,26 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -13485,7 +13607,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -13542,7 +13664,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -13871,6 +13993,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -17206,6 +17329,17 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -17721,7 +17855,15 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/sort" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -19273,6 +19415,56 @@ paths: previews: [] category: repos subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository-readme + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/content-file" + examples: + default: + "$ref": "#/components/examples/content-file" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents "/repos/{owner}/{repo}/releases": get: summary: List releases @@ -19552,7 +19744,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -20376,6 +20568,8 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" responses: '200': description: response @@ -24451,6 +24645,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -26514,6 +26709,17 @@ components: required: true schema: type: integer + direction: + name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc key-ids: name: key_ids in: path @@ -26633,17 +26839,6 @@ components: required: false schema: type: string - direction: - name: direction - description: One of `asc` (ascending) or `desc` (descending). - in: query - required: false - schema: - type: string - enum: - - asc - - desc - default: desc owner: name: owner in: path diff --git a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json index 5206af05c2..42599cedf7 100644 --- a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json +++ b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json @@ -1140,6 +1140,43 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1899,6 +1936,34 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -2746,6 +2811,35 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -8925,6 +9019,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -10528,6 +10631,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -28047,6 +28159,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -30714,6 +30827,15 @@ "type": "integer", "default": 30 } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -44253,6 +44375,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -48681,6 +48804,35 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -97468,6 +97620,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -103129,9 +103301,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -103876,7 +104066,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -103938,6 +104128,14 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -104929,7 +105127,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -107186,13 +107384,31 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -108931,7 +109147,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -111166,7 +111382,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -111881,7 +112097,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -112573,7 +112789,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -113296,7 +113512,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -119992,7 +120209,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -120014,6 +120232,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -121710,6 +121948,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -121717,6 +121975,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -124176,7 +124435,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -124338,7 +124597,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -124698,7 +124957,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -124913,7 +125172,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -125929,7 +126188,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -168072,6 +168332,34 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -176509,16 +176797,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -195991,6 +196278,279 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -198478,7 +199038,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -203295,6 +203855,24 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -237584,6 +238162,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" diff --git a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml index 540a1e6e51..803d929b1f 100644 --- a/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml +++ b/descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml @@ -742,6 +742,32 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: &9 + type: string + enum: + - asc + - desc + default: desc + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string responses: '200': description: response @@ -1100,7 +1126,7 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: &82 + properties: &83 login: type: string example: github @@ -1141,7 +1167,7 @@ paths: type: string example: A great organization nullable: true - required: &83 + required: &84 - login - url - id @@ -1211,7 +1237,7 @@ paths: - name: org in: path required: true - schema: &84 + schema: &85 type: string responses: '202': @@ -1267,6 +1293,21 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1276,7 +1317,7 @@ paths: type: array items: type: object - properties: &9 + properties: &10 id: type: integer name: @@ -1367,7 +1408,7 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default: value: @@ -1432,7 +1473,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: &10 + schema: &11 type: integer responses: '200': @@ -1441,7 +1482,7 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default: value: @@ -1488,7 +1529,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *10 + schema: *11 responses: '200': description: response @@ -1496,7 +1537,7 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default-response: value: @@ -1589,7 +1630,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *10 + schema: *11 responses: '204': description: Empty response @@ -1659,7 +1700,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *10 + schema: *11 responses: '202': description: response @@ -1667,7 +1708,7 @@ paths: application/json: schema: type: object - properties: &11 + properties: &12 url: type: string state: @@ -1746,7 +1787,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *10 + schema: *11 responses: '200': description: response @@ -1754,7 +1795,7 @@ paths: application/json: schema: type: object - properties: *11 + properties: *12 examples: default: value: @@ -1797,6 +1838,23 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + description: One of `created` (when the repository was starred) or `updated` + (when it was last pushed to) or `name`. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1806,7 +1864,7 @@ paths: type: array items: type: object - properties: &12 + properties: &13 id: type: integer name: @@ -1919,10 +1977,10 @@ paths: application/json: schema: type: object - properties: *12 + properties: *13 examples: default: - value: &13 + value: &14 id: 1 name: Check Commits enforcement: disabled @@ -2020,7 +2078,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: &14 + schema: &15 type: integer responses: '200': @@ -2029,10 +2087,10 @@ paths: application/json: schema: type: object - properties: *12 + properties: *13 examples: default: - value: *13 + value: *14 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -2062,7 +2120,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -2070,7 +2128,7 @@ paths: application/json: schema: type: object - properties: *12 + properties: *13 examples: default: value: @@ -2161,7 +2219,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '204': description: Empty response @@ -2212,7 +2270,7 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: &17 + properties: &18 id: type: integer url: @@ -2268,7 +2326,7 @@ paths: - title: Simple User description: Simple User type: object - properties: &15 + properties: &16 login: type: string example: octocat @@ -2334,7 +2392,7 @@ paths: starred_at: type: string example: '"2020-07-09T00:17:55Z"' - required: &16 + required: &17 - avatar_url - events_url - followers_url @@ -2365,7 +2423,7 @@ paths: type: object description: The permissions granted to the user-to-server access token. - properties: &25 + properties: &26 actions: type: string description: 'The level of permission to grant the @@ -2614,7 +2672,7 @@ paths: enum: - read - write - example: &26 + example: &27 contents: read issues: read deployments: write @@ -2648,8 +2706,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true required: - permissions @@ -2657,7 +2715,7 @@ paths: - single_file_name - repositories_url - account - required: &18 + required: &19 - app - id - note @@ -2672,7 +2730,7 @@ paths: - updated_at examples: default: - value: &40 + value: &41 - id: 2 url: https://enterprise.octocat.com/api/v3/authorizations/2 app: @@ -2764,8 +2822,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -2914,11 +2972,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: &41 + value: &42 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -3002,7 +3060,7 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: &19 + properties: &20 id: description: Unique identifier of the GitHub app example: 37 @@ -3020,8 +3078,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true name: description: The name of the GitHub app @@ -3092,7 +3150,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &20 + required: &21 - id - node_id - owner @@ -3107,7 +3165,7 @@ paths: additionalProperties: true examples: default: - value: &39 + value: &40 id: 1 slug: octoapp node_id: MDExOkludGVncmF0aW9uMQ== @@ -3188,8 +3246,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true - type: object properties: @@ -3279,13 +3337,13 @@ paths: -----END RSA PRIVATE KEY----- '404': description: Resource Not Found - content: &23 + content: &24 application/json: schema: title: Basic Error description: Basic Error type: object - properties: &27 + properties: &28 message: type: string documentation_url: @@ -3298,10 +3356,10 @@ paths: title: Validation Error Simple description: Validation Error Simple type: object - required: &89 + required: &90 - message - documentation_url - properties: &90 + properties: &91 message: type: string documentation_url: @@ -3340,7 +3398,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: &29 + schema: &30 type: integer default: 30 - name: page @@ -3359,7 +3417,7 @@ paths: title: Installation description: Installation type: object - properties: &21 + properties: &22 id: description: The ID of the installation. type: integer @@ -3370,8 +3428,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true - title: Enterprise description: An enterprise account @@ -3503,8 +3561,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true suspended_at: type: string @@ -3514,7 +3572,7 @@ paths: type: string example: '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' nullable: true - required: &22 + required: &23 - id - app_id - app_slug @@ -3612,7 +3670,7 @@ paths: description: installation_id parameter in: path required: true - schema: &24 + schema: &25 type: integer responses: '200': @@ -3623,8 +3681,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: @@ -3668,10 +3726,10 @@ paths: app_slug: github-actions '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: &28 + content: &29 application/json: schema: type: object @@ -3717,13 +3775,13 @@ paths: description: installation_id parameter in: path required: true - schema: *24 + schema: *25 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -3767,7 +3825,7 @@ paths: description: installation_id parameter in: path required: true - schema: *24 + schema: *25 requestBody: content: application/json: @@ -3794,8 +3852,8 @@ paths: type: object description: The permissions granted to the user-to-server access token. - properties: *25 - example: *26 + properties: *26 + example: *27 responses: '201': description: response @@ -3835,7 +3893,7 @@ paths: title: Repository description: A git repository type: object - properties: &50 + properties: &51 id: description: Unique identifier of the repository example: 42 @@ -3856,7 +3914,7 @@ paths: - title: License Simple description: License Simple type: object - properties: &71 + properties: &72 key: type: string example: mit @@ -3878,7 +3936,7 @@ paths: html_url: type: string format: uri - required: &72 + required: &73 - key - name - url @@ -3909,8 +3967,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true private: description: Whether the repository is private or public. @@ -4386,7 +4444,7 @@ paths: example: '"2020-07-09T00:17:42Z"' anonymous_access_enabled: type: boolean - required: &51 + required: &52 - archive_url - assignees_url - blobs_url @@ -4592,40 +4650,40 @@ paths: anonymous_access_enabled: false '403': description: Forbidden - content: &30 + content: &31 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '415': description: Preview Header Missing - content: *28 + content: *29 '401': description: Requires Authentication - content: &31 + content: &32 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: &42 + content: &43 application/json: schema: title: Validation Error description: Validation Error type: object - required: &87 + required: &88 - message - documentation_url - properties: &88 + properties: &89 message: type: string documentation_url: @@ -4685,11 +4743,17 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -4701,7 +4765,7 @@ paths: title: Application Grant description: The authorization associated with an OAuth Access. type: object - properties: &32 + properties: &33 id: type: integer example: 1 @@ -4743,10 +4807,10 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true - required: &33 + required: &34 - app - id - scopes @@ -4775,13 +4839,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4812,7 +4876,7 @@ paths: description: grant_id parameter in: path required: true - schema: &34 + schema: &35 type: integer responses: '200': @@ -4823,8 +4887,8 @@ paths: title: Application Grant description: The authorization associated with an OAuth Access. type: object - properties: *32 - required: *33 + properties: *33 + required: *34 examples: default: value: @@ -4842,10 +4906,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4872,7 +4936,7 @@ paths: description: grant_id parameter in: path required: true - schema: *34 + schema: *35 responses: '204': description: Empty response @@ -4880,10 +4944,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4911,12 +4975,12 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: &35 + schema: &36 type: string - name: access_token in: path required: true - schema: &36 + schema: &37 type: string responses: '204': @@ -4948,11 +5012,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *35 + schema: *36 - name: access_token in: path required: true - schema: *36 + schema: *37 responses: '200': description: response @@ -4960,7 +5024,7 @@ paths: application/json: schema: type: object - properties: &37 + properties: &38 id: type: integer url: @@ -5035,7 +5099,7 @@ paths: type: boolean examples: default: - value: &38 + value: &39 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -5098,11 +5162,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *35 + schema: *36 - name: access_token in: path required: true - schema: *36 + schema: *37 responses: '200': description: response @@ -5110,10 +5174,10 @@ paths: application/json: schema: type: object - properties: *37 + properties: *38 examples: default: - value: *38 + value: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5137,11 +5201,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *35 + schema: *36 - name: access_token in: path required: true - schema: *36 + schema: *37 responses: '204': description: Empty response @@ -5183,21 +5247,21 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true examples: default: - value: *39 + value: *40 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -5229,11 +5293,17 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -5246,11 +5316,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *40 + value: *41 headers: Link: example: ; rel="next", ; @@ -5260,13 +5330,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5342,11 +5412,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *41 + value: *42 headers: Location: example: https://api.github.com/authorizations/1 @@ -5354,24 +5424,24 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 '410': description: Gone - content: &47 + content: &48 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5405,7 +5475,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *35 + schema: *36 requestBody: content: application/json: @@ -5449,8 +5519,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: response-if-returning-an-existing-token: value: @@ -5491,11 +5561,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *41 + value: *42 headers: Location: example: https://api.github.com/authorizations/1 @@ -5503,15 +5573,15 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5543,7 +5613,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *35 + schema: *36 - name: fingerprint in: path required: true @@ -5588,8 +5658,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: response-if-returning-an-existing-token: value: @@ -5623,8 +5693,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: value: @@ -5651,7 +5721,7 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5682,7 +5752,7 @@ paths: description: authorization_id parameter in: path required: true - schema: &43 + schema: &44 type: integer responses: '200': @@ -5694,11 +5764,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: &44 + value: &45 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -5719,10 +5789,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5751,7 +5821,7 @@ paths: description: authorization_id parameter in: path required: true - schema: *43 + schema: *44 requestBody: content: application/json: @@ -5798,14 +5868,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *44 + value: *45 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5835,7 +5905,7 @@ paths: description: authorization_id parameter in: path required: true - schema: *43 + schema: *44 responses: '204': description: Empty response @@ -5843,10 +5913,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5878,7 +5948,7 @@ paths: title: Code Of Conduct description: Code Of Conduct type: object - properties: &45 + properties: &46 key: type: string example: contributor_covenant @@ -5944,7 +6014,7 @@ paths: type: string format: uri nullable: true - required: &46 + required: &47 - url - html_url - key @@ -5964,7 +6034,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6005,8 +6075,8 @@ paths: title: Code Of Conduct description: Code Of Conduct type: object - properties: *45 - required: *46 + properties: *46 + required: *47 examples: default: value: @@ -6065,12 +6135,12 @@ paths: html_url: http://contributor-covenant.org/version/1/4/ '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6175,21 +6245,21 @@ paths: self.save() '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *47 + content: *48 '415': description: Preview Header Missing - content: *28 + content: *29 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6484,7 +6554,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -6500,7 +6570,7 @@ paths: title: Event description: Event type: object - properties: &74 + properties: &75 id: type: string type: @@ -6510,7 +6580,7 @@ paths: title: Actor description: Actor type: object - properties: &48 + properties: &49 id: type: integer login: @@ -6526,7 +6596,7 @@ paths: avatar_url: type: string format: uri - required: &49 + required: &50 - id - login - gravatar_id @@ -6550,8 +6620,8 @@ paths: title: Actor description: Actor type: object - properties: *48 - required: *49 + properties: *49 + required: *50 payload: type: object properties: @@ -6609,8 +6679,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true labels: type: array @@ -6661,8 +6731,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assignees: type: array @@ -6670,8 +6740,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true milestone: @@ -6681,7 +6751,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &67 + properties: &68 url: type: string format: uri @@ -6726,8 +6796,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true open_issues: type: integer @@ -6753,7 +6823,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &68 + required: &69 - closed_issues - creator - description @@ -6825,7 +6895,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: &52 + enum: &53 - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER @@ -6845,8 +6915,8 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 performed_via_github_app: nullable: true allOf: @@ -6858,8 +6928,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true required: &210 - assignee @@ -6918,8 +6988,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -6937,7 +7007,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *52 + enum: *53 performed_via_github_app: nullable: true allOf: @@ -6949,13 +7019,13 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true reactions: title: Reaction Rollup type: object - properties: &69 + properties: &70 url: type: string format: uri @@ -6977,7 +7047,7 @@ paths: type: integer rocket: type: integer - required: &70 + required: &71 - url - total_count - "+1" @@ -7024,7 +7094,7 @@ paths: type: string format: date-time nullable: true - required: &75 + required: &76 - id - type - actor @@ -7036,7 +7106,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '503': description: Service Unavailable content: &181 @@ -7120,58 +7190,58 @@ paths: title: Link With Type description: Hypermedia Link with Type type: object - properties: &53 + properties: &54 href: type: string type: type: string - required: &54 + required: &55 - href - type user: title: Link With Type description: Hypermedia Link with Type type: object - properties: *53 - required: *54 + properties: *54 + required: *55 security_advisories: title: Link With Type description: Hypermedia Link with Type type: object - properties: *53 - required: *54 + properties: *54 + required: *55 current_user: title: Link With Type description: Hypermedia Link with Type type: object - properties: *53 - required: *54 + properties: *54 + required: *55 current_user_public: title: Link With Type description: Hypermedia Link with Type type: object - properties: *53 - required: *54 + properties: *54 + required: *55 current_user_actor: title: Link With Type description: Hypermedia Link with Type type: object - properties: *53 - required: *54 + properties: *54 + required: *55 current_user_organization: title: Link With Type description: Hypermedia Link with Type type: object - properties: *53 - required: *54 + properties: *54 + required: *55 current_user_organizations: type: array items: title: Link With Type description: Hypermedia Link with Type type: object - properties: *53 - required: *54 + properties: *54 + required: *55 required: - timeline - user @@ -7236,12 +7306,12 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: &55 + schema: &56 type: string - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -7257,7 +7327,7 @@ paths: title: Base Gist description: Base Gist type: object - properties: &56 + properties: &57 url: type: string format: uri @@ -7314,8 +7384,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true comments_url: type: string @@ -7326,8 +7396,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true truncated: type: boolean @@ -7337,7 +7407,7 @@ paths: history: type: array items: {} - required: &57 + required: &58 - id - node_id - url @@ -7356,7 +7426,7 @@ paths: - updated_at examples: default: - value: &58 + value: &59 - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits @@ -7408,7 +7478,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7476,7 +7546,7 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: &59 + properties: &60 url: type: string forks_url: @@ -7533,14 +7603,14 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true truncated: type: boolean examples: default: - value: &60 + value: &61 url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits @@ -7561,15 +7631,15 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7596,11 +7666,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *55 + schema: *56 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -7616,11 +7686,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *56 - required: *57 + properties: *57 + required: *58 examples: default: - value: *58 + value: *59 headers: Link: example: ; rel="next", ; @@ -7628,12 +7698,12 @@ paths: schema: *6 '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7657,11 +7727,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *55 + schema: *56 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -7677,11 +7747,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *56 - required: *57 + properties: *57 + required: *58 examples: default: - value: *58 + value: *59 headers: Link: example: ; rel="next", ; @@ -7689,12 +7759,12 @@ paths: schema: *6 '401': description: Requires Authentication - content: *31 + content: *32 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7716,7 +7786,7 @@ paths: description: gist_id parameter in: path required: true - schema: &61 + schema: &62 type: string responses: '200': @@ -7727,13 +7797,13 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *59 + properties: *60 examples: default: - value: *60 + value: *61 '403': description: Forbidden Gist - content: &65 + content: &66 application/json: schema: type: object @@ -7754,7 +7824,7 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified x-github: @@ -7779,7 +7849,7 @@ paths: description: gist_id parameter in: path required: true - schema: *61 + schema: *62 requestBody: content: application/json: @@ -7830,16 +7900,16 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *59 + properties: *60 examples: default: - value: *60 + value: *61 '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7860,18 +7930,18 @@ paths: description: gist_id parameter in: path required: true - schema: *61 + schema: *62 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7893,11 +7963,11 @@ paths: description: gist_id parameter in: path required: true - schema: *61 + schema: *62 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -7913,7 +7983,7 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: &62 + properties: &63 id: type: integer example: 1 @@ -7935,8 +8005,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -7951,8 +8021,8 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *52 - required: &63 + enum: *53 + required: &64 - url - id - node_id @@ -7999,10 +8069,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8023,7 +8093,7 @@ paths: description: gist_id parameter in: path required: true - schema: *61 + schema: *62 requestBody: content: application/json: @@ -8046,11 +8116,11 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *62 - required: *63 + properties: *63 + required: *64 examples: default: - value: &64 + value: &65 id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== url: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 @@ -8086,10 +8156,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8111,12 +8181,12 @@ paths: description: gist_id parameter in: path required: true - schema: *61 + schema: *62 - name: comment_id description: comment_id parameter in: path required: true - schema: &66 + schema: &67 type: integer responses: '200': @@ -8127,19 +8197,19 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *62 - required: *63 + properties: *63 + required: *64 examples: default: - value: *64 + value: *65 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden Gist - content: *65 + content: *66 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8160,12 +8230,12 @@ paths: description: gist_id parameter in: path required: true - schema: *61 + schema: *62 - name: comment_id description: comment_id parameter in: path required: true - schema: *66 + schema: *67 requestBody: content: application/json: @@ -8188,14 +8258,14 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *62 - required: *63 + properties: *63 + required: *64 examples: default: - value: *64 + value: *65 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8216,12 +8286,12 @@ paths: description: gist_id parameter in: path required: true - schema: *61 + schema: *62 - name: comment_id description: comment_id parameter in: path required: true - schema: *66 + schema: *67 responses: '204': description: Empty response @@ -8229,10 +8299,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8254,11 +8324,11 @@ paths: description: gist_id parameter in: path required: true - schema: *61 + schema: *62 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -8288,8 +8358,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true change_status: type: object @@ -8346,12 +8416,12 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8373,11 +8443,11 @@ paths: description: gist_id parameter in: path required: true - schema: *61 + schema: *62 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -8393,7 +8463,7 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *59 + properties: *60 examples: default: value: @@ -8445,12 +8515,12 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8471,7 +8541,7 @@ paths: description: gist_id parameter in: path required: true - schema: *61 + schema: *62 responses: '201': description: response @@ -8481,8 +8551,8 @@ paths: title: Base Gist description: Base Gist type: object - properties: *56 - required: *57 + properties: *57 + required: *58 examples: default: value: @@ -8535,15 +8605,15 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8565,7 +8635,7 @@ paths: description: gist_id parameter in: path required: true - schema: *61 + schema: *62 responses: '204': description: Response if gist is starred @@ -8581,7 +8651,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8603,18 +8673,18 @@ paths: description: gist_id parameter in: path required: true - schema: *61 + schema: *62 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8635,7 +8705,7 @@ paths: description: gist_id parameter in: path required: true - schema: *61 + schema: *62 responses: '204': description: Empty response @@ -8643,10 +8713,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8668,7 +8738,7 @@ paths: description: gist_id parameter in: path required: true - schema: *61 + schema: *62 - name: sha in: path required: true @@ -8683,19 +8753,19 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *59 + properties: *60 examples: default: - value: *60 + value: *61 '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8847,7 +8917,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -8871,8 +8941,8 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 repository_selection: type: string example: selected @@ -8988,12 +9058,12 @@ paths: schema: *6 '403': description: Forbidden - content: *30 + content: *31 '304': description: Not Modified '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -9048,6 +9118,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -9066,7 +9137,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: &94 + schema: &95 type: string - name: sort description: What to sort results by. Can be either `created`, `updated`, @@ -9084,19 +9155,14 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: &95 - type: string - enum: - - asc - - desc - default: desc + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *55 + schema: *56 - name: collab in: query required: false @@ -9120,7 +9186,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -9186,8 +9252,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true labels: description: Labels to associate with this issue; pass one or @@ -9227,8 +9293,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assignees: type: array @@ -9236,8 +9302,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true milestone: @@ -9246,8 +9312,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *67 - required: *68 + properties: *68 + required: *69 locked: type: boolean active_lock_reason: @@ -9299,8 +9365,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body_html: type: string @@ -9313,8 +9379,8 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 performed_via_github_app: nullable: true allOf: @@ -9325,20 +9391,20 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true author_association: title: author_association type: string example: OWNER description: How the author is associated with the repository. - enum: *52 + enum: *53 reactions: title: Reaction Rollup type: object - properties: *69 - required: *70 + properties: *70 + required: *71 required: &97 - assignee - closed_at @@ -9599,12 +9665,12 @@ paths: schema: *6 '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9637,7 +9703,11 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 responses: '200': description: response @@ -9649,8 +9719,8 @@ paths: title: License Simple description: License Simple type: object - properties: *71 - required: *72 + properties: *72 + required: *73 examples: default: value: @@ -9875,10 +9945,10 @@ paths: featured: true '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified x-github: @@ -9935,7 +10005,7 @@ paths: type: string X-CommonMarker-Version: example: 0.17.4 - schema: &73 + schema: &74 type: string content: text/html: @@ -9978,7 +10048,7 @@ paths: headers: X-CommonMarker-Version: example: 0.17.4 - schema: *73 + schema: *74 content: text/html: schema: @@ -10061,7 +10131,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -10077,14 +10147,14 @@ paths: title: Event description: Event type: object - properties: *74 - required: *75 + properties: *75 + required: *76 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '304': description: Not Modified '301': @@ -10128,7 +10198,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *55 + schema: *56 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -10140,7 +10210,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -10156,7 +10226,7 @@ paths: title: Thread description: Thread type: object - properties: &76 + properties: &77 id: type: string repository: @@ -10183,8 +10253,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true private: type: boolean @@ -10403,8 +10473,8 @@ paths: - title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 subscribers_count: type: integer network_count: @@ -10511,7 +10581,7 @@ paths: subscription_url: type: string example: https://api.github.com/notifications/threads/2/subscription - required: &77 + required: &78 - id - unread - reason @@ -10612,13 +10682,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10670,10 +10740,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10695,7 +10765,7 @@ paths: description: thread_id parameter in: path required: true - schema: &78 + schema: &79 type: integer responses: '200': @@ -10706,8 +10776,8 @@ paths: title: Thread description: Thread type: object - properties: *76 - required: *77 + properties: *77 + required: *78 examples: default: value: @@ -10794,10 +10864,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10818,7 +10888,7 @@ paths: description: thread_id parameter in: path required: true - schema: *78 + schema: *79 responses: '205': description: response @@ -10826,7 +10896,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10851,7 +10921,7 @@ paths: description: thread_id parameter in: path required: true - schema: *78 + schema: *79 responses: '200': description: response @@ -10861,7 +10931,7 @@ paths: title: Thread Subscription description: Thread Subscription type: object - properties: &79 + properties: &80 subscribed: type: boolean example: true @@ -10887,7 +10957,7 @@ paths: type: string format: uri example: https://api.github.com/repos/1 - required: &80 + required: &81 - created_at - ignored - reason @@ -10895,7 +10965,7 @@ paths: - subscribed examples: default: - value: &81 + value: &82 subscribed: true ignored: false reason: @@ -10906,10 +10976,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10935,7 +11005,7 @@ paths: description: thread_id parameter in: path required: true - schema: *78 + schema: *79 requestBody: content: application/json: @@ -10955,19 +11025,19 @@ paths: title: Thread Subscription description: Thread Subscription type: object - properties: *79 - required: *80 + properties: *80 + required: *81 examples: default: - value: *81 + value: *82 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10992,7 +11062,7 @@ paths: description: thread_id parameter in: path required: true - schema: *78 + schema: *79 responses: '204': description: Empty response @@ -11000,10 +11070,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11060,7 +11130,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 responses: '200': description: response @@ -11072,11 +11142,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *82 - required: *83 + properties: *83 + required: *84 examples: default: - value: &315 + value: &316 - login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= @@ -11119,7 +11189,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 responses: '200': description: response @@ -11129,7 +11199,7 @@ paths: title: Organization Full description: Organization Full type: object - properties: &85 + properties: &86 login: type: string example: github @@ -11276,7 +11346,7 @@ paths: updated_at: type: string format: date-time - required: &86 + required: &87 - login - url - id @@ -11390,7 +11460,7 @@ paths: seats: 5 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11422,7 +11492,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 requestBody: content: application/json: @@ -11552,8 +11622,8 @@ paths: title: Organization Full description: Organization Full type: object - properties: *85 - required: *86 + properties: *86 + required: *87 examples: default: value: @@ -11608,13 +11678,13 @@ paths: - title: Validation Error description: Validation Error type: object - required: *87 - properties: *88 + required: *88 + properties: *89 - title: Validation Error Simple description: Validation Error Simple type: object - required: *89 - properties: *90 + required: *90 + properties: *91 '409': description: Conflict content: &169 @@ -11623,10 +11693,10 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11656,11 +11726,11 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -11676,8 +11746,8 @@ paths: title: Event description: Event type: object - properties: *74 - required: *75 + properties: *75 + required: *76 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11698,11 +11768,11 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -11718,7 +11788,7 @@ paths: title: Org Hook description: Org Hook type: object - properties: &91 + properties: &92 id: type: integer example: 1 @@ -11768,7 +11838,7 @@ paths: example: '2011-09-06T17:26:27Z' type: type: string - required: &92 + required: &93 - id - url - type @@ -11803,7 +11873,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11824,7 +11894,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 requestBody: content: application/json: @@ -11907,11 +11977,11 @@ paths: title: Org Hook description: Org Hook type: object - properties: *91 - required: *92 + properties: *92 + required: *93 examples: default: - value: &93 + value: &94 id: 1 url: https://api.github.com/orgs/octocat/hooks/1 ping_url: https://api.github.com/orgs/octocat/hooks/1/pings @@ -11933,10 +12003,10 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11958,7 +12028,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: hook_id in: path required: true @@ -11972,14 +12042,14 @@ paths: title: Org Hook description: Org Hook type: object - properties: *91 - required: *92 + properties: *92 + required: *93 examples: default: - value: *93 + value: *94 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12003,7 +12073,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: hook_id in: path required: true @@ -12076,8 +12146,8 @@ paths: title: Org Hook description: Org Hook type: object - properties: *91 - required: *92 + properties: *92 + required: *93 examples: default: value: @@ -12096,10 +12166,10 @@ paths: type: Organization '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12119,7 +12189,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: hook_id in: path required: true @@ -12129,7 +12199,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12151,7 +12221,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: hook_id in: path required: true @@ -12161,7 +12231,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12192,7 +12262,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 responses: '200': description: response @@ -12202,8 +12272,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: &205 @@ -12279,11 +12349,11 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -12307,8 +12377,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: @@ -12389,7 +12459,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: filter description: "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you @@ -12405,6 +12475,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -12423,7 +12494,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *94 + schema: *95 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -12440,18 +12511,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *95 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *55 + schema: *56 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -12480,7 +12551,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12510,7 +12581,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: filter description: "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -12540,7 +12611,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -12556,8 +12627,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -12594,7 +12665,7 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12615,7 +12686,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: username in: path required: true @@ -12654,7 +12725,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: username in: path required: true @@ -12664,7 +12735,7 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12686,7 +12757,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: username in: path required: true @@ -12719,16 +12790,16 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *82 - required: *83 + properties: *83 + required: *84 user: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true permissions: type: object @@ -12864,10 +12935,10 @@ paths: site_admin: false '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12899,7 +12970,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: username in: path required: true @@ -13012,10 +13083,10 @@ paths: site_admin: false '422': description: Validation Failed - content: *42 + content: *43 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13038,7 +13109,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: username in: path required: true @@ -13048,10 +13119,10 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13072,7 +13143,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: filter description: "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -13088,7 +13159,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -13104,8 +13175,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -13138,7 +13209,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: username in: path required: true @@ -13172,7 +13243,7 @@ paths: documentation_url: https://docs.github.com/enterprise-server@2.19/rest/reference/orgs#convert-member-to-outside-collaborator '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13193,7 +13264,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: username in: path required: true @@ -13241,7 +13312,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: per_page description: Results per page (max 100) in: query @@ -13250,6 +13321,22 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + description: The sort order for the response collection. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -13308,11 +13395,11 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -13359,11 +13446,11 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -13424,11 +13511,11 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -13473,7 +13560,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: state description: Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. @@ -13489,7 +13576,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -13552,8 +13639,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -13661,7 +13748,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 requestBody: content: application/json: @@ -13726,16 +13813,16 @@ paths: updated_at: '2014-03-04T18:58:10Z' '401': description: Requires Authentication - content: *31 + content: *32 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *47 + content: *48 '422': description: Validation Failed content: *104 @@ -13767,11 +13854,11 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -13787,8 +13874,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -13818,7 +13905,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: username in: path required: true @@ -13850,7 +13937,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: username in: path required: true @@ -13860,7 +13947,7 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -13880,7 +13967,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: username in: path required: true @@ -13908,7 +13995,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: type description: 'Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. @@ -13953,7 +14040,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -13973,7 +14060,7 @@ paths: required: *108 examples: default: - value: &302 + value: &303 - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World @@ -14130,7 +14217,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 requestBody: content: application/json: @@ -14251,8 +14338,8 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 examples: default: value: &189 @@ -14375,10 +14462,10 @@ paths: type: string '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14417,11 +14504,11 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -14568,7 +14655,7 @@ paths: schema: *6 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14591,7 +14678,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 requestBody: content: application/json: @@ -14736,8 +14823,8 @@ paths: title: Organization Full description: Organization Full type: object - properties: *85 - required: *86 + properties: *86 + required: *87 ldap_dn: description: Distinguished Name (DN) that team maps to within LDAP environment @@ -14808,10 +14895,10 @@ paths: ldap_dn: uid=asdf,ou=users,dc=github,dc=com '422': description: Validation Failed - content: *42 + content: *43 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14835,7 +14922,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: team_slug description: team_slug parameter in: path @@ -14859,7 +14946,7 @@ paths: value: *113 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14914,8 +15001,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -14987,13 +15074,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15055,13 +15142,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed content: *104 @@ -15115,10 +15202,10 @@ paths: type: string '401': description: Requires Authentication - content: *31 + content: *32 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15203,7 +15290,7 @@ paths: type: string '401': description: Requires Authentication - content: *31 + content: *32 '503': description: Service Unavailable content: @@ -15228,7 +15315,7 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15324,13 +15411,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15389,10 +15476,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15428,10 +15515,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15476,7 +15563,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -15535,10 +15622,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15616,10 +15703,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '422': description: Validation Failed content: @@ -15629,13 +15716,13 @@ paths: - title: Validation Error description: Validation Error type: object - required: *87 - properties: *88 + required: *88 + properties: *89 - title: Validation Error Simple description: Validation Error Simple type: object - required: *89 - properties: *90 + required: *90 + properties: *91 '503': description: Service Unavailable content: @@ -15713,13 +15800,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed content: *104 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15800,10 +15887,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15901,10 +15988,10 @@ paths: type: string '401': description: Requires Authentication - content: *31 + content: *32 '410': description: Gone - content: *47 + content: *48 '422': description: Validation Failed content: *104 @@ -15958,13 +16045,13 @@ paths: type: string '401': description: Requires Authentication - content: *31 + content: *32 '410': description: Gone - content: *47 + content: *48 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16016,7 +16103,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -16032,8 +16119,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -16045,21 +16132,21 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16113,21 +16200,21 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16167,19 +16254,19 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *42 + content: *43 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16233,8 +16320,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true required: &161 - permission @@ -16264,21 +16351,21 @@ paths: site_admin: false '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16310,7 +16397,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -16348,10 +16435,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16415,13 +16502,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed content: *104 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16558,7 +16645,7 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16657,8 +16744,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true private: type: boolean @@ -16907,8 +16994,8 @@ paths: - title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 allow_squash_merge: type: boolean example: true @@ -16927,29 +17014,29 @@ paths: - title: License Simple description: License Simple type: object - properties: *71 - required: *72 + properties: *72 + required: *73 organization: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true parent: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 source: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 forks: type: integer master_branch: @@ -18021,10 +18108,10 @@ paths: anonymous_access_enabled: false '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '301': description: Moved Permanently x-github: @@ -18661,13 +18748,13 @@ paths: anonymous_access_enabled: false '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18734,7 +18821,7 @@ paths: documentation_url: https://docs.github.com/enterprise-server@2.19/rest/reference/repos#delete-a-repository '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18764,7 +18851,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -18780,8 +18867,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -18793,7 +18880,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18841,7 +18928,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18878,7 +18965,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -18968,8 +19055,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true teams: description: The list of teams with review dismissal @@ -19393,7 +19480,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19544,8 +19631,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true committer: nullable: true @@ -19553,8 +19640,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true parents: type: array @@ -19749,10 +19836,10 @@ paths: protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection '415': description: Preview Header Missing - content: *28 + content: *29 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19924,7 +20011,7 @@ paths: - pull_request '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20186,8 +20273,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true teams: type: array @@ -20265,16 +20352,16 @@ paths: - url '403': description: Forbidden - content: *30 + content: *31 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed content: *104 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20321,7 +20408,7 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20458,7 +20545,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20651,7 +20738,7 @@ paths: value: *143 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20698,7 +20785,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20753,7 +20840,7 @@ paths: enabled: true '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20810,7 +20897,7 @@ paths: value: *144 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20856,7 +20943,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20920,7 +21007,7 @@ paths: contexts_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20989,10 +21076,10 @@ paths: value: *147 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21078,7 +21165,7 @@ paths: - continuous-integration/travis-ci '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21143,13 +21230,13 @@ paths: - continuous-integration/jenkins '422': description: Validation Failed - content: *42 + content: *43 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21214,10 +21301,10 @@ paths: - continuous-integration/travis-ci '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21282,10 +21369,10 @@ paths: - continuous-integration/travis-ci '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21406,7 +21493,7 @@ paths: - pull_request '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21492,8 +21579,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true examples: default: @@ -21536,7 +21623,7 @@ paths: - pull_request '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21605,15 +21692,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true examples: default: value: *148 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21683,15 +21770,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true examples: default: value: *148 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21761,15 +21848,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true examples: default: value: *148 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21824,7 +21911,7 @@ paths: value: *149 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21897,7 +21984,7 @@ paths: value: *149 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21971,7 +22058,7 @@ paths: value: *149 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22045,7 +22132,7 @@ paths: value: *149 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22092,15 +22179,15 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: value: *101 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22165,15 +22252,15 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: value: *101 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22239,15 +22326,15 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: value: *101 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22313,15 +22400,15 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: value: *101 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22738,8 +22825,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true pull_requests: items: @@ -22874,8 +22961,8 @@ paths: They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true required: - id @@ -23525,7 +23612,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -23729,8 +23816,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true repository: title: Minimal Repository @@ -24195,8 +24282,8 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 examples: default: value: @@ -24446,7 +24533,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -24655,7 +24742,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -24798,7 +24885,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24929,8 +25016,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true inviter: nullable: true @@ -24938,8 +25025,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true permissions: description: The permission associated with the invitation. @@ -25093,10 +25180,10 @@ paths: description: Response when person is already a collaborator '422': description: Validation Failed - content: *42 + content: *43 '403': description: Forbidden - content: *30 + content: *31 x-github: triggersNotification: true githubCloudOnly: false @@ -25195,7 +25282,7 @@ paths: site_admin: false '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25227,7 +25314,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -25273,8 +25360,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -25287,12 +25374,12 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *52 + enum: *53 reactions: title: Reaction Rollup type: object - properties: *69 - required: *70 + properties: *70 + required: *71 required: &163 - url - html_url @@ -25385,7 +25472,7 @@ paths: description: comment_id parameter in: path required: true - schema: *66 + schema: *67 responses: '200': description: response @@ -25433,7 +25520,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25472,7 +25559,7 @@ paths: description: comment_id parameter in: path required: true - schema: *66 + schema: *67 requestBody: content: application/json: @@ -25533,7 +25620,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25562,13 +25649,13 @@ paths: description: comment_id parameter in: path required: true - schema: *66 + schema: *67 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25598,7 +25685,7 @@ paths: description: comment_id parameter in: path required: true - schema: *66 + schema: *67 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. @@ -25618,7 +25705,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -25648,8 +25735,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true content: description: The reaction to use @@ -25707,10 +25794,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25751,7 +25838,7 @@ paths: description: comment_id parameter in: path required: true - schema: *66 + schema: *67 requestBody: content: application/json: @@ -25829,10 +25916,10 @@ paths: value: *166 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25921,7 +26008,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *55 + schema: *56 - name: until description: 'Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -25932,11 +26019,25 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -26032,7 +26133,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '400': description: Bad Request content: &188 @@ -26041,7 +26142,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 application/scim+json: schema: title: Scim Error @@ -26068,7 +26169,7 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '409': description: Conflict content: *169 @@ -26147,10 +26248,10 @@ paths: protected: false '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26193,7 +26294,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -26309,10 +26410,10 @@ paths: type: string '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *42 + content: *43 x-github: triggersNotification: true githubCloudOnly: false @@ -26354,7 +26455,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -26434,8 +26535,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: type: string @@ -26466,8 +26567,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *67 - required: *68 + properties: *68 + required: *69 active_lock_reason: type: string example: too heated @@ -26500,8 +26601,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assignees: type: array @@ -26509,8 +26610,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true requested_reviewers: @@ -26519,8 +26620,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true requested_teams: @@ -26545,8 +26646,8 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 sha: type: string user: @@ -26555,8 +26656,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true required: - label @@ -26575,8 +26676,8 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 sha: type: string user: @@ -26585,8 +26686,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true required: - label @@ -26662,7 +26763,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *52 + enum: *53 draft: description: Indicates whether or not the pull request is a draft. @@ -27157,7 +27258,7 @@ paths: schema: *6 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27226,8 +27327,16 @@ paths: in: path required: true schema: *127 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *30 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -27330,10 +27439,10 @@ paths: ..... '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 '500': description: Internal Error content: *175 @@ -27366,7 +27475,7 @@ paths: required: true schema: *127 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -27397,11 +27506,16 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -27467,7 +27581,7 @@ paths: required: true schema: *127 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -27488,7 +27602,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -27713,12 +27827,20 @@ paths: required: true schema: *127 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - name: per_page + description: Results per page (max 100). + in: query + schema: *30 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 responses: '200': description: response @@ -27900,7 +28022,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27930,7 +28052,7 @@ paths: required: true schema: *127 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -27939,7 +28061,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -27955,7 +28077,7 @@ paths: title: Status description: The status of a commit. type: object - properties: &277 + properties: &278 url: type: string avatar_url: @@ -27981,10 +28103,10 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true - required: &278 + required: &279 - url - avatar_url - id @@ -28476,7 +28598,7 @@ paths: content: *175 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28532,7 +28654,7 @@ paths: required: true schema: *127 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -29014,10 +29136,10 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '302': description: Found x-github: @@ -29045,7 +29167,7 @@ paths: required: true schema: *127 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -29334,10 +29456,10 @@ paths: payload: '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *42 + content: *43 '409': description: Conflict content: *169 @@ -29373,7 +29495,7 @@ paths: required: true schema: *127 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -29467,10 +29589,10 @@ paths: payload: '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 '409': description: Conflict content: *169 @@ -29514,7 +29636,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -29616,10 +29738,10 @@ paths: description: Response if repository is empty '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29674,10 +29796,11 @@ paths: schema: type: string default: none + nullable: true - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -29738,8 +29861,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -29777,8 +29900,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true required: &183 - id @@ -30123,7 +30246,7 @@ paths: message: 'Conflict: Commit status checks failed for topic-branch.' '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30215,7 +30338,7 @@ paths: production_environment: true '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30266,7 +30389,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -30311,8 +30434,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true description: description: A short description of the status. @@ -30370,8 +30493,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true required: &186 - id @@ -30427,7 +30550,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30616,7 +30739,7 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30686,10 +30809,10 @@ paths: value: *187 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30744,7 +30867,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -30760,8 +30883,8 @@ paths: title: Event description: Event type: object - properties: *74 - required: *75 + properties: *75 + required: *76 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30797,15 +30920,30 @@ paths: - newest - oldest - stargazers + - watchers default: newest - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -30964,11 +31102,26 @@ paths: in: path required: true schema: *127 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -30983,8 +31136,8 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 examples: default: value: *189 @@ -30993,13 +31146,13 @@ paths: content: *188 '422': description: Validation Failed - content: *42 + content: *43 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31073,16 +31226,16 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '409': description: Conflict content: *169 '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31160,13 +31313,13 @@ paths: node_id: Q29udGVudCBvZiB0aGUgYmxvYg== '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *42 + content: *43 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31480,10 +31633,10 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31586,7 +31739,7 @@ paths: payload: '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31620,7 +31773,7 @@ paths: required: true schema: *127 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -31629,7 +31782,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -31727,7 +31880,7 @@ paths: required: true schema: *127 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -31756,7 +31909,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31828,7 +31981,7 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31855,7 +32008,7 @@ paths: required: true schema: *127 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -31897,7 +32050,7 @@ paths: value: *194 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31923,7 +32076,7 @@ paths: required: true schema: *127 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -31934,7 +32087,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32141,7 +32294,7 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32216,7 +32369,7 @@ paths: value: *199 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32402,13 +32555,13 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32442,6 +32595,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -32503,10 +32657,10 @@ paths: truncated: false '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32535,7 +32689,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -32703,7 +32857,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32845,13 +32999,13 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *42 + content: *43 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32898,7 +33052,7 @@ paths: value: *204 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33020,10 +33174,10 @@ paths: value: *204 '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33057,7 +33211,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33093,7 +33247,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33131,7 +33285,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33176,8 +33330,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: *205 @@ -33185,7 +33339,7 @@ paths: description: Moved Permanently '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -33220,7 +33374,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -33241,7 +33395,7 @@ paths: required: *207 examples: default: - value: &317 + value: &318 - id: 1 repository: id: 1296269 @@ -33640,7 +33794,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *94 + schema: *95 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -33657,18 +33811,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *95 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *55 + schema: *56 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -33822,10 +33976,10 @@ paths: description: Moved Permanently '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34091,19 +34245,19 @@ paths: type: string '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *42 + content: *43 '503': description: Service Unavailable content: *181 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *47 + content: *48 x-github: triggersNotification: true githubCloudOnly: false @@ -34135,7 +34289,7 @@ paths: (when it was last pushed to). in: query required: false - schema: &249 + schema: &256 type: string enum: - created @@ -34156,11 +34310,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *55 + schema: *56 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -34217,10 +34371,10 @@ paths: schema: *6 '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34260,7 +34414,7 @@ paths: description: comment_id parameter in: path required: true - schema: *66 + schema: *67 responses: '200': description: response @@ -34306,7 +34460,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34343,7 +34497,7 @@ paths: description: comment_id parameter in: path required: true - schema: *66 + schema: *67 requestBody: content: application/json: @@ -34374,7 +34528,7 @@ paths: value: *213 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34403,7 +34557,7 @@ paths: description: comment_id parameter in: path required: true - schema: *66 + schema: *67 responses: '204': description: Empty response @@ -34436,7 +34590,7 @@ paths: description: comment_id parameter in: path required: true - schema: *66 + schema: *67 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. @@ -34456,7 +34610,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -34485,10 +34639,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34529,7 +34683,7 @@ paths: description: comment_id parameter in: path required: true - schema: *66 + schema: *67 requestBody: content: application/json: @@ -34584,10 +34738,10 @@ paths: value: *166 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34626,7 +34780,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -34659,8 +34813,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true event: type: string @@ -34703,8 +34857,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assigner: nullable: true @@ -34712,8 +34866,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true review_requester: nullable: true @@ -34721,8 +34875,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true requested_reviewer: nullable: true @@ -34730,8 +34884,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true requested_team: title: Team @@ -34809,7 +34963,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *52 + enum: *53 lock_reason: type: string nullable: true @@ -34983,7 +35137,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35197,13 +35351,13 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *47 + content: *48 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35289,10 +35443,10 @@ paths: description: Moved Permanently '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *47 + content: *48 '304': description: Not Modified x-github: @@ -35427,21 +35581,21 @@ paths: value: *217 '422': description: Validation Failed - content: *42 + content: *43 '503': description: Service Unavailable content: *181 '403': description: Forbidden - content: *30 + content: *31 '301': description: Moved Permanently '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *47 + content: *48 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35760,11 +35914,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *55 + schema: *56 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -35793,10 +35947,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *47 + content: *48 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35875,16 +36029,16 @@ paths: type: string '403': description: Forbidden - content: *30 + content: *31 '410': description: Gone - content: *47 + content: *48 '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 x-github: triggersNotification: true githubCloudOnly: false @@ -35919,7 +36073,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -35946,8 +36100,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true event: type: string @@ -35979,7 +36133,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *52 + enum: *53 body: type: string example: '":+1:"' @@ -36039,7 +36193,7 @@ paths: schema: *6 '410': description: Gone - content: *47 + content: *48 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36089,7 +36243,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -36132,7 +36286,7 @@ paths: schema: *6 '410': description: Gone - content: *47 + content: *48 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36201,10 +36355,10 @@ paths: value: *223 '410': description: Gone - content: *47 + content: *48 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36272,10 +36426,10 @@ paths: value: *223 '410': description: Gone - content: *47 + content: *48 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36310,7 +36464,7 @@ paths: description: Empty response '410': description: Gone - content: *47 + content: *48 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36374,10 +36528,10 @@ paths: default: true '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *47 + content: *48 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36433,16 +36587,16 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '410': description: Gone - content: *47 + content: *48 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36483,10 +36637,10 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36536,7 +36690,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -36565,13 +36719,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *47 + content: *48 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36653,10 +36807,10 @@ paths: value: *166 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -36700,7 +36854,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -36727,13 +36881,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *47 + content: *48 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36778,7 +36932,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -36911,7 +37065,7 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36959,7 +37113,7 @@ paths: value: *228 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37021,7 +37175,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -37050,7 +37204,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37130,10 +37284,10 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37181,7 +37335,7 @@ paths: value: *230 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37422,8 +37576,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *71 - required: *72 + properties: *72 + required: *73 required: - _links - git_url @@ -37589,10 +37743,10 @@ paths: message: Merge Conflict '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37652,7 +37806,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -37668,8 +37822,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *67 - required: *68 + properties: *68 + required: *69 examples: default: value: @@ -37714,7 +37868,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37778,8 +37932,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *67 - required: *68 + properties: *68 + required: *69 examples: default: value: &232 @@ -37824,10 +37978,10 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37868,14 +38022,14 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *67 - required: *68 + properties: *68 + required: *69 examples: default: value: *232 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37942,8 +38096,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *67 - required: *68 + properties: *68 + required: *69 examples: default: value: *232 @@ -37981,7 +38135,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38015,7 +38169,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -38084,7 +38238,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *55 + schema: *56 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -38095,7 +38249,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -38111,8 +38265,8 @@ paths: title: Thread description: Thread type: object - properties: *76 - required: *77 + properties: *77 + required: *78 examples: default: value: *237 @@ -38271,7 +38425,7 @@ paths: public: true '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38351,10 +38505,10 @@ paths: value: *240 '422': description: Validation Failed - content: *42 + content: *43 '415': description: Preview Header Missing - content: *28 + content: *29 '409': description: Conflict content: *169 @@ -38450,7 +38604,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *42 + content: *43 '400': description: Bad Request content: *188 @@ -38483,13 +38637,13 @@ paths: description: Empty response '422': description: Validation Failed - content: *42 + content: *43 '415': description: Preview Header Missing - content: *28 + content: *29 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38525,7 +38679,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -38561,8 +38715,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true commit: type: string @@ -38816,6 +38970,21 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -38879,7 +39048,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -38933,7 +39102,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -39000,7 +39169,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: Responds with effective values inherited from owner and/or @@ -39066,7 +39235,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -39126,16 +39295,16 @@ paths: schema: *6 '401': description: Requires Authentication - content: *31 + content: *32 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *47 + content: *48 '422': description: Validation Failed content: *104 @@ -39206,16 +39375,16 @@ paths: value: *123 '401': description: Requires Authentication - content: *31 + content: *32 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *47 + content: *48 '422': description: Validation Failed content: *104 @@ -39306,7 +39475,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -39336,7 +39505,7 @@ paths: description: Not Modified '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39436,7 +39605,7 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: &253 + properties: &252 url: type: string format: uri @@ -39507,8 +39676,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: type: string @@ -39540,8 +39709,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *67 - required: *68 + properties: *68 + required: *69 active_lock_reason: type: string example: too heated @@ -39574,8 +39743,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assignees: type: array @@ -39583,8 +39752,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true requested_reviewers: @@ -39593,8 +39762,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true requested_teams: @@ -40300,8 +40469,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *71 - required: *72 + properties: *72 + required: *73 pushed_at: type: string format: date-time @@ -40544,7 +40713,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *52 + enum: *53 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -40568,8 +40737,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true comments: type: integer @@ -40594,7 +40763,7 @@ paths: changed_files: type: integer example: 5 - required: &254 + required: &253 - _links - assignee - labels @@ -40638,7 +40807,7 @@ paths: - review_comments examples: default: - value: &255 + value: &254 url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 node_id: MDExOlB1bGxSZXF1ZXN0MQ== @@ -41131,10 +41300,10 @@ paths: type: string '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *42 + content: *43 x-github: triggersNotification: true githubCloudOnly: false @@ -41176,11 +41345,14 @@ paths: required: true schema: *127 - name: sort - description: One of `created` (when the repository was starred) or `updated` - (when it was last pushed to). in: query required: false - schema: *249 + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -41196,11 +41368,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *55 + schema: *56 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -41217,7 +41389,7 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: &250 + properties: &249 url: description: URL for the pull request review comment example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 @@ -41272,8 +41444,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: description: The text of the comment. @@ -41304,7 +41476,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *52 + enum: *53 _links: type: object properties: @@ -41342,15 +41514,15 @@ paths: reactions: title: Reaction Rollup type: object - properties: *69 - required: *70 + properties: *70 + required: *71 body_html: type: string example: '"

comment body

"' body_text: type: string example: '"comment body"' - required: &251 + required: &250 - url - id - node_id @@ -41480,7 +41652,7 @@ paths: description: comment_id parameter in: path required: true - schema: *66 + schema: *67 responses: '200': description: response @@ -41491,11 +41663,11 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *250 - required: *251 + properties: *249 + required: *250 examples: default: - value: &252 + value: &251 url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 id: 10 @@ -41541,7 +41713,7 @@ paths: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41601,7 +41773,7 @@ paths: description: comment_id parameter in: path required: true - schema: *66 + schema: *67 requestBody: content: application/json: @@ -41625,11 +41797,11 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *250 - required: *251 + properties: *249 + required: *250 examples: default: - value: *252 + value: *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41679,13 +41851,13 @@ paths: description: comment_id parameter in: path required: true - schema: *66 + schema: *67 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41715,7 +41887,7 @@ paths: description: comment_id parameter in: path required: true - schema: *66 + schema: *67 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. @@ -41735,7 +41907,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -41764,10 +41936,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41808,7 +41980,7 @@ paths: description: comment_id parameter in: path required: true - schema: *66 + schema: *67 requestBody: content: application/json: @@ -41863,10 +42035,10 @@ paths: value: *166 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41920,7 +42092,7 @@ paths: - name: pull_number in: path required: true - schema: &256 + schema: &255 type: integer responses: '200': @@ -41935,11 +42107,11 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: *253 - required: *254 + properties: *252 + required: *253 examples: default: - value: *255 + value: *254 '304': description: Not Modified '500': @@ -41947,7 +42119,7 @@ paths: content: *175 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41978,7 +42150,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 requestBody: content: application/json: @@ -42024,17 +42196,17 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: *253 - required: *254 + properties: *252 + required: *253 examples: default: - value: *255 + value: *254 '422': description: Validation Failed - content: *42 + content: *43 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42077,13 +42249,13 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: sort description: One of `created` (when the repository was starred) or `updated` (when it was last pushed to). in: query required: false - schema: *249 + schema: *256 - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -42099,11 +42271,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *55 + schema: *56 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -42120,8 +42292,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *250 - required: *251 + properties: *249 + required: *250 examples: default: value: *257 @@ -42193,7 +42365,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 responses: '201': description: response @@ -42394,12 +42566,12 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: comment_id description: comment_id parameter in: path required: true - schema: *66 + schema: *67 requestBody: content: application/json: @@ -42423,8 +42595,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *250 - required: *251 + properties: *249 + required: *250 examples: default: value: @@ -42478,7 +42650,7 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 x-github: triggersNotification: true githubCloudOnly: false @@ -42511,11 +42683,11 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -42570,11 +42742,11 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -42613,7 +42785,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *42 + content: *43 '500': description: Internal Error content: *175 @@ -42645,7 +42817,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 responses: '204': description: Response if pull request has been merged @@ -42677,7 +42849,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 requestBody: content: application/json: @@ -42761,13 +42933,13 @@ paths: message: Head branch was modified. Review and try the merge again. '422': description: Validation Failed - content: *42 + content: *43 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: triggersNotification: true githubCloudOnly: false @@ -42797,11 +42969,11 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -42822,8 +42994,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true teams: type: array @@ -42903,7 +43075,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 requestBody: content: application/json: @@ -43449,7 +43621,7 @@ paths: description: Response if user is not a collaborator '403': description: Forbidden - content: *30 + content: *31 x-github: triggersNotification: true githubCloudOnly: false @@ -43478,7 +43650,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 requestBody: content: application/json: @@ -43509,7 +43681,7 @@ paths: description: response '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43538,11 +43710,11 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -43572,8 +43744,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: description: The text of the review. @@ -43626,7 +43798,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *52 + enum: *53 required: &262 - id - node_id @@ -43713,7 +43885,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 requestBody: content: application/json: @@ -43839,7 +44011,7 @@ paths: content: *104 '403': description: Forbidden - content: *30 + content: *31 x-github: triggersNotification: true githubCloudOnly: false @@ -43869,7 +44041,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: review_id description: review_id parameter in: path @@ -43925,7 +44097,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43953,7 +44125,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: review_id description: review_id parameter in: path @@ -44051,7 +44223,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: review_id description: review_id parameter in: path @@ -44076,7 +44248,7 @@ paths: content: *104 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44105,7 +44277,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: review_id description: review_id parameter in: path @@ -44114,7 +44286,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -44173,8 +44345,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: type: string @@ -44200,7 +44372,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *52 + enum: *53 _links: type: object properties: @@ -44340,7 +44512,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44371,7 +44543,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: review_id description: review_id parameter in: path @@ -44440,7 +44612,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed content: *104 @@ -44472,7 +44644,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 - name: review_id description: review_id parameter in: path @@ -44517,13 +44689,13 @@ paths: value: *265 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed content: *104 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44553,7 +44725,7 @@ paths: - name: pull_number in: path required: true - schema: *256 + schema: *255 requestBody: content: application/json: @@ -44589,13 +44761,13 @@ paths: url: https://github.com/repos/octocat/Hello-World/pulls/53 '422': description: Validation Failed - content: *42 + content: *43 '403': description: Forbidden - content: *30 + content: *31 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -44651,7 +44823,7 @@ paths: required: *267 examples: default: - value: + value: &268 type: file encoding: base64 size: 5362 @@ -44669,10 +44841,72 @@ paths: html: https://github.com/octokit/octokit.rb/blob/master/README.md '404': description: Resource Not Found - content: *23 + content: *24 + '422': + description: Validation Failed + content: *43 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository-readme + parameters: + - name: owner + in: path + required: true + schema: *126 + - name: repo + in: path + required: true + schema: *127 + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + title: Content File + description: Content File + type: object + properties: *266 + required: *267 + examples: + default: + value: *268 + '404': + description: Resource Not Found + content: *24 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44704,7 +44938,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -44720,7 +44954,7 @@ paths: title: Release description: A release. type: object - properties: &268 + properties: &269 url: type: string format: uri @@ -44780,8 +45014,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assets: type: array @@ -44789,7 +45023,7 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: &270 + properties: &271 url: type: string format: uri @@ -44831,10 +45065,10 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true - required: &271 + required: &272 - id - name - content_type @@ -44852,7 +45086,7 @@ paths: type: string body_text: type: string - required: &269 + required: &270 - assets_url - upload_url - tarball_url @@ -44947,7 +45181,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45024,11 +45258,11 @@ paths: title: Release description: A release. type: object - properties: *268 - required: *269 + properties: *269 + required: *270 examples: default: - value: &274 + value: &275 url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 assets_url: https://api.github.com/repos/octocat/Hello-World/releases/1/assets @@ -45103,7 +45337,7 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 x-github: triggersNotification: true githubCloudOnly: false @@ -45137,7 +45371,7 @@ paths: description: asset_id parameter in: path required: true - schema: &272 + schema: &273 type: integer responses: '200': @@ -45152,11 +45386,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *270 - required: *271 + properties: *271 + required: *272 examples: default: - value: &273 + value: &274 url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip id: 1 @@ -45190,10 +45424,10 @@ paths: site_admin: false '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '302': description: Found x-github: @@ -45224,7 +45458,7 @@ paths: description: asset_id parameter in: path required: true - schema: *272 + schema: *273 requestBody: content: application/json: @@ -45253,11 +45487,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *270 - required: *271 + properties: *271 + required: *272 examples: default: - value: *273 + value: *274 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45286,7 +45520,7 @@ paths: description: asset_id parameter in: path required: true - schema: *272 + schema: *273 responses: '204': description: Empty response @@ -45327,11 +45561,11 @@ paths: title: Release description: A release. type: object - properties: *268 - required: *269 + properties: *269 + required: *270 examples: default: - value: *274 + value: *275 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45358,7 +45592,7 @@ paths: required: true schema: *127 - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -45373,14 +45607,14 @@ paths: title: Release description: A release. type: object - properties: *268 - required: *269 + properties: *269 + required: *270 examples: default: - value: *274 + value: *275 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45411,7 +45645,7 @@ paths: description: release_id parameter in: path required: true - schema: &275 + schema: &276 type: integer responses: '200': @@ -45423,14 +45657,14 @@ paths: title: Release description: A release. type: object - properties: *268 - required: *269 + properties: *269 + required: *270 examples: default: - value: *274 + value: *275 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45459,7 +45693,7 @@ paths: description: release_id parameter in: path required: true - schema: *275 + schema: *276 requestBody: content: application/json: @@ -45505,11 +45739,11 @@ paths: title: Release description: A release. type: object - properties: *268 - required: *269 + properties: *269 + required: *270 examples: default: - value: *274 + value: *275 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45538,7 +45772,7 @@ paths: description: release_id parameter in: path required: true - schema: *275 + schema: *276 responses: '204': description: Empty response @@ -45571,11 +45805,11 @@ paths: description: release_id parameter in: path required: true - schema: *275 + schema: *276 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -45591,8 +45825,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *270 - required: *271 + properties: *271 + required: *272 examples: default: value: @@ -45689,7 +45923,7 @@ paths: description: release_id parameter in: path required: true - schema: *275 + schema: *276 - name: name in: query schema: @@ -45713,8 +45947,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *270 - required: *271 + properties: *271 + required: *272 examples: response-for-successful-upload: value: @@ -45780,7 +46014,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -45796,8 +46030,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default-response: @@ -45838,8 +46072,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true required: - starred_at @@ -45875,7 +46109,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45914,7 +46148,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: &276 + items: &277 type: integer examples: default: @@ -46049,8 +46283,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true total: type: integer @@ -46264,7 +46498,7 @@ paths: - 3 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46310,7 +46544,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: *276 + items: *277 examples: default: value: @@ -46404,8 +46638,8 @@ paths: title: Status description: The status of a commit. type: object - properties: *277 - required: *278 + properties: *278 + required: *279 examples: default: value: @@ -46471,7 +46705,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -46487,8 +46721,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -46533,7 +46767,7 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: &279 + properties: &280 subscribed: description: Determines if notifications should be received from this repository. @@ -46558,7 +46792,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/example - required: &280 + required: &281 - created_at - ignored - reason @@ -46578,7 +46812,7 @@ paths: description: Response if you don't subscribe to the repository '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -46631,8 +46865,8 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: *279 - required: *280 + properties: *280 + required: *281 examples: default: value: @@ -46699,7 +46933,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -46831,7 +47065,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -46883,6 +47117,14 @@ paths: in: path required: true schema: *127 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *30 responses: '200': description: response @@ -46892,16 +47134,16 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: &281 + properties: &282 names: type: array items: type: string - required: &282 + required: &283 - names examples: default: - value: &283 + value: &284 names: - octocat - atom @@ -46909,10 +47151,10 @@ paths: - api '415': description: Preview Header Missing - content: *28 + content: *29 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46975,17 +47217,17 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: *281 - required: *282 + properties: *282 + required: *283 examples: default: - value: *283 + value: *284 '415': description: Preview Header Missing - content: *28 + content: *29 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed content: *104 @@ -47057,8 +47299,8 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 examples: default: value: *189 @@ -47257,8 +47499,8 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 examples: default: value: @@ -47517,7 +47759,7 @@ paths: type: string '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified x-github: @@ -47582,7 +47824,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: &284 + schema: &285 type: string enum: - desc @@ -47591,7 +47833,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -47660,7 +47902,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: &285 + items: &286 type: object properties: object_url: @@ -47777,10 +48019,10 @@ paths: content: *181 '422': description: Validation Failed - content: *42 + content: *43 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47833,11 +48075,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *284 + schema: *285 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -47937,8 +48179,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true committer: nullable: true @@ -47971,7 +48213,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *285 + items: *286 required: - sha - node_id @@ -48104,7 +48346,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48182,11 +48424,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *284 + schema: *285 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -48250,8 +48492,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true user: @@ -48260,8 +48502,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true labels: type: array @@ -48291,8 +48533,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true milestone: nullable: true @@ -48300,8 +48542,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *67 - required: *68 + properties: *68 + required: *69 comments: type: integer created_at: @@ -48317,7 +48559,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *285 + items: *286 pull_request: type: object properties: @@ -48355,15 +48597,15 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *52 + enum: *53 draft: type: boolean repository: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 body_html: type: string body_text: @@ -48381,8 +48623,8 @@ paths: They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true required: - assignee @@ -48503,12 +48745,12 @@ paths: content: *181 '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48565,7 +48807,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *284 + schema: *285 responses: '200': description: response @@ -48610,7 +48852,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *285 + items: *286 required: - id - node_id @@ -48646,13 +48888,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48713,11 +48955,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *284 + schema: *285 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -48759,8 +49001,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true private: type: boolean @@ -48936,8 +49178,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *71 - required: *72 + properties: *72 + required: *73 permissions: type: object properties: @@ -48954,7 +49196,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *285 + items: *286 temp_clone_token: type: string allow_merge_commit: @@ -49151,7 +49393,7 @@ paths: content: *181 '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified x-github: @@ -49258,7 +49500,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *285 + items: *286 related: type: array nullable: true @@ -49403,7 +49645,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49466,11 +49708,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *284 + schema: *285 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -49578,7 +49820,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *285 + items: *286 blog: type: string nullable: true @@ -49641,7 +49883,7 @@ paths: content: *181 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49750,7 +49992,7 @@ paths: application/json: schema: type: object - properties: &286 + properties: &287 status: type: string scheduled_time: @@ -49769,7 +50011,7 @@ paths: - number examples: default: - value: &287 + value: &288 status: scheduled scheduled_time: Tuesday, January 22 at 15:34 -0800 connection_services: @@ -49804,10 +50046,10 @@ paths: application/json: schema: type: object - properties: *286 + properties: *287 examples: default: - value: *287 + value: *288 requestBody: content: application/json: @@ -50317,14 +50559,14 @@ paths: type: array items: type: object - properties: &288 + properties: &289 key: type: string pretty-print: type: string examples: default: - value: &289 + value: &290 - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64 - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... @@ -50353,7 +50595,7 @@ paths: type: array items: type: object - properties: *288 + properties: *289 examples: default: value: @@ -50398,10 +50640,10 @@ paths: type: array items: type: object - properties: *288 + properties: *289 examples: default: - value: *289 + value: *290 requestBody: content: application/json: @@ -50713,15 +50955,15 @@ paths: description: A team discussion is a persistent record of a free-form conversation within a team. type: object - properties: &290 + properties: &291 author: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: description: The main text of the discussion. @@ -50792,9 +51034,9 @@ paths: reactions: title: Reaction Rollup type: object - properties: *69 - required: *70 - required: &291 + properties: *70 + required: *71 + required: &292 - author - body - body_html @@ -50909,11 +51151,11 @@ paths: description: A team discussion is a persistent record of a free-form conversation within a team. type: object - properties: *290 - required: *291 + properties: *291 + required: *292 examples: default: - value: &292 + value: &293 author: login: octocat id: 1 @@ -51021,7 +51263,7 @@ paths: - name: discussion_number in: path required: true - schema: &293 + schema: &294 type: integer responses: '200': @@ -51033,11 +51275,11 @@ paths: description: A team discussion is a persistent record of a free-form conversation within a team. type: object - properties: *290 - required: *291 + properties: *291 + required: *292 examples: default: - value: *292 + value: *293 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51072,7 +51314,7 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 responses: '200': description: response @@ -51083,8 +51325,8 @@ paths: description: A team discussion is a persistent record of a free-form conversation within a team. type: object - properties: *290 - required: *291 + properties: *291 + required: *292 examples: default: value: @@ -51182,7 +51424,7 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 responses: '204': description: Empty response @@ -51211,7 +51453,7 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 - name: direction description: Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or @@ -51243,15 +51485,15 @@ paths: title: Team Discussion Comment description: A reply to a discussion within a team. type: object - properties: &294 + properties: &295 author: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: description: The main text of the comment. @@ -51301,9 +51543,9 @@ paths: reactions: title: Reaction Rollup type: object - properties: *69 - required: *70 - required: &295 + properties: *70 + required: *71 + required: &296 - author - body - body_html @@ -51400,7 +51642,7 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 responses: '201': description: response @@ -51410,11 +51652,11 @@ paths: title: Team Discussion Comment description: A reply to a discussion within a team. type: object - properties: *294 - required: *295 + properties: *295 + required: *296 examples: default: - value: &296 + value: &297 author: login: octocat id: 1 @@ -51504,11 +51746,11 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 - name: comment_number in: path required: true - schema: &297 + schema: &298 type: integer responses: '200': @@ -51519,11 +51761,11 @@ paths: title: Team Discussion Comment description: A reply to a discussion within a team. type: object - properties: *294 - required: *295 + properties: *295 + required: *296 examples: default: - value: *296 + value: *297 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51557,11 +51799,11 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 - name: comment_number in: path required: true - schema: *297 + schema: *298 responses: '200': description: response @@ -51571,8 +51813,8 @@ paths: title: Team Discussion Comment description: A reply to a discussion within a team. type: object - properties: *294 - required: *295 + properties: *295 + required: *296 examples: default: value: @@ -51663,11 +51905,11 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 - name: comment_number in: path required: true - schema: *297 + schema: *298 responses: '204': description: Empty response @@ -51703,11 +51945,11 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 - name: comment_number in: path required: true - schema: *297 + schema: *298 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. @@ -51795,11 +52037,11 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 - name: comment_number in: path required: true - schema: *297 + schema: *298 responses: '201': description: response @@ -51878,7 +52120,7 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.19/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. @@ -51966,7 +52208,7 @@ paths: - name: discussion_number in: path required: true - schema: *293 + schema: *294 responses: '201': description: response @@ -52069,8 +52311,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -52209,7 +52451,7 @@ paths: resource: TeamMember '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52293,7 +52535,7 @@ paths: title: Team Membership description: Team Membership type: object - properties: &298 + properties: &299 url: type: string format: uri @@ -52307,7 +52549,7 @@ paths: type: string state: type: string - required: &299 + required: &300 - role - state - url @@ -52375,8 +52617,8 @@ paths: title: Team Membership description: Team Membership type: object - properties: *298 - required: *299 + properties: *299 + required: *300 examples: response-if-users-membership-with-team-is-now-active: summary: Response if user's membership with team is now active @@ -52515,7 +52757,7 @@ paths: title: Team Project description: A team's access to a project. type: object - properties: &300 + properties: &301 owner_url: type: string url: @@ -52541,8 +52783,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -52569,7 +52811,7 @@ paths: - read - write - admin - required: &301 + required: &302 - owner_url - url - html_url @@ -52686,8 +52928,8 @@ paths: title: Team Project description: A team's access to a project. type: object - properties: *300 - required: *301 + properties: *301 + required: *302 examples: default: value: @@ -52916,7 +53158,7 @@ paths: required: *108 examples: default: - value: *302 + value: *303 headers: Link: example: ; rel="next", ; @@ -53593,7 +53835,7 @@ paths: - title: Private User description: Private User type: object - properties: &303 + properties: &304 login: type: string example: octocat @@ -53746,7 +53988,7 @@ paths: type: boolean ldap_dn: type: string - required: &304 + required: &305 - avatar_url - events_url - followers_url @@ -53787,7 +54029,7 @@ paths: - title: Public User description: Public User type: object - properties: &319 + properties: &320 login: type: string id: @@ -53904,7 +54146,7 @@ paths: collaborators: type: integer example: 3 - required: &320 + required: &321 - avatar_url - events_url - followers_url @@ -54021,10 +54263,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54090,8 +54332,8 @@ paths: title: Private User description: Private User type: object - properties: *303 - required: *304 + properties: *304 + required: *305 examples: default: value: @@ -54141,16 +54383,16 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54172,7 +54414,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -54188,7 +54430,7 @@ paths: title: Email description: Email type: object - properties: &305 + properties: &306 email: type: string format: email @@ -54203,14 +54445,14 @@ paths: type: string example: public nullable: true - required: &306 + required: &307 - email - primary - verified - visibility examples: default: - value: &316 + value: &317 - email: octocat@github.com verified: true primary: true @@ -54224,13 +54466,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54289,8 +54531,8 @@ paths: title: Email description: Email type: object - properties: *305 - required: *306 + properties: *306 + required: *307 examples: default: value: @@ -54308,18 +54550,18 @@ paths: visibility: '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54374,16 +54616,16 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54404,7 +54646,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -54420,8 +54662,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -54435,10 +54677,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54459,7 +54701,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -54475,8 +54717,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -54490,10 +54732,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54527,15 +54769,15 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54566,13 +54808,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54601,13 +54843,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54629,7 +54871,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -54645,7 +54887,7 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: &307 + properties: &308 id: type: integer example: 3 @@ -54739,7 +54981,7 @@ paths: raw_key: type: string nullable: true - required: &308 + required: &309 - id - primary_key_id - key_id @@ -54755,7 +54997,7 @@ paths: - subkeys examples: default: - value: &321 + value: &322 - id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -54792,13 +55034,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54837,11 +55079,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *307 - required: *308 + properties: *308 + required: *309 examples: default: - value: &309 + value: &310 id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -54873,18 +55115,18 @@ paths: PGP PUBLIC KEY BLOCK-----"' '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54907,7 +55149,7 @@ paths: description: gpg_key_id parameter in: path required: true - schema: &310 + schema: &311 type: integer responses: '200': @@ -54918,22 +55160,22 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *307 - required: *308 + properties: *308 + required: *309 examples: default: - value: *309 + value: *310 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54956,24 +55198,24 @@ paths: description: gpg_key_id parameter in: path required: true - schema: *310 + schema: *311 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55008,7 +55250,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -55033,8 +55275,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: @@ -55125,13 +55367,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55173,11 +55415,11 @@ paths: description: installation_id parameter in: path required: true - schema: *24 + schema: *25 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -55204,8 +55446,8 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 examples: default: value: @@ -55322,10 +55564,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '304': description: Not Modified x-github: @@ -55365,23 +55607,23 @@ paths: description: installation_id parameter in: path required: true - schema: *24 + schema: *25 - name: repository_id in: path required: true - schema: &311 + schema: &312 type: integer responses: '204': description: Empty response '403': description: Forbidden - content: *30 + content: *31 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55411,22 +55653,22 @@ paths: description: installation_id parameter in: path required: true - schema: *24 + schema: *25 - name: repository_id in: path required: true - schema: *311 + schema: *312 responses: '204': description: Empty response '403': description: Forbidden - content: *30 + content: *31 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55471,6 +55713,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -55489,7 +55732,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *94 + schema: *95 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -55506,18 +55749,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *95 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *55 + schema: *56 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -55546,7 +55789,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified x-github: @@ -55578,7 +55821,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -55594,7 +55837,7 @@ paths: title: Key description: Key type: object - properties: &312 + properties: &313 key_id: type: string key: @@ -55612,7 +55855,7 @@ paths: type: boolean read_only: type: boolean - required: &313 + required: &314 - key_id - key - id @@ -55649,13 +55892,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55699,11 +55942,11 @@ paths: title: Key description: Key type: object - properties: *312 - required: *313 + properties: *313 + required: *314 examples: default: - value: &314 + value: &315 key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -55714,18 +55957,18 @@ paths: read_only: false '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55759,22 +56002,22 @@ paths: title: Key description: Key type: object - properties: *312 - required: *313 + properties: *313 + required: *314 examples: default: - value: *314 + value: *315 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55805,13 +56048,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55843,7 +56086,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -55945,13 +56188,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55972,7 +56215,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 responses: '200': description: response @@ -56025,10 +56268,10 @@ paths: site_admin: false '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56048,7 +56291,7 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 requestBody: content: application/json: @@ -56117,13 +56360,13 @@ paths: site_admin: false '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56149,7 +56392,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -56165,11 +56408,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *82 - required: *83 + properties: *83 + required: *84 examples: default: - value: *315 + value: *316 headers: Link: example: ; rel="next", ; @@ -56179,10 +56422,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56267,13 +56510,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed content: *104 @@ -56306,7 +56549,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -56322,11 +56565,11 @@ paths: title: Email description: Email type: object - properties: *305 - required: *306 + properties: *306 + required: *307 examples: default: - value: *316 + value: *317 headers: Link: example: ; rel="next", ; @@ -56336,13 +56579,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56428,7 +56671,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -56439,7 +56682,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *55 + schema: *56 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -56458,12 +56701,12 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 examples: default: summary: Default response - value: &318 + value: &319 - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World @@ -56570,15 +56813,15 @@ paths: anonymous_access_enabled: false '422': description: Validation Failed - content: *42 + content: *43 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56700,8 +56943,8 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 examples: default: value: *189 @@ -56712,18 +56955,18 @@ paths: type: string '401': description: Requires Authentication - content: *31 + content: *32 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *42 + content: *43 '400': description: Bad Request content: *188 @@ -56765,7 +57008,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -56786,7 +57029,7 @@ paths: required: *207 examples: default: - value: *317 + value: *318 headers: Link: example: ; rel="next", ; @@ -56796,13 +57039,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56830,13 +57073,13 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '409': description: Conflict content: *169 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified x-github: @@ -56870,10 +57113,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56899,16 +57142,16 @@ paths: (when it was last pushed to). in: query required: false - schema: *249 + schema: *256 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *95 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -56924,12 +57167,12 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 examples: default-response: summary: Default response - value: *318 + value: *319 application/vnd.github.v3.star+json: schema: type: array @@ -56937,7 +57180,7 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: &322 + properties: &323 starred_at: type: string format: date-time @@ -56945,15 +57188,15 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 - required: &323 + properties: *51 + required: *52 + required: &324 - starred_at - repo examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: &324 + value: &325 - starred_at: '2011-01-16T19:06:43Z' repo: id: 1296269 @@ -57069,10 +57312,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57109,15 +57352,15 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '401': description: Requires Authentication - content: *31 + content: *32 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57148,13 +57391,13 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '401': description: Requires Authentication - content: *31 + content: *32 '304': description: Not Modified x-github: @@ -57186,15 +57429,15 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '401': description: Requires Authentication - content: *31 + content: *32 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57215,7 +57458,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57235,7 +57478,7 @@ paths: required: *108 examples: default: - value: *302 + value: *303 headers: Link: example: ; rel="next", ; @@ -57245,10 +57488,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57272,7 +57515,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57347,10 +57590,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57380,7 +57623,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 responses: '200': description: response @@ -57392,8 +57635,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -57443,13 +57686,13 @@ paths: - title: Private User description: Private User type: object - properties: *303 - required: *304 + properties: *304 + required: *305 - title: Public User description: Public User type: object - properties: *319 - required: *320 + properties: *320 + required: *321 additionalProperties: false examples: default-response: @@ -57529,7 +57772,7 @@ paths: private_repos: 9999 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57555,7 +57798,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57571,8 +57814,8 @@ paths: title: Event description: Event type: object - properties: *74 - required: *75 + properties: *75 + required: *76 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57598,11 +57841,11 @@ paths: - name: org in: path required: true - schema: *84 + schema: *85 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57618,8 +57861,8 @@ paths: title: Event description: Event type: object - properties: *74 - required: *75 + properties: *75 + required: *76 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57644,7 +57887,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57660,8 +57903,8 @@ paths: title: Event description: Event type: object - properties: *74 - required: *75 + properties: *75 + required: *76 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57686,7 +57929,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57702,8 +57945,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -57737,7 +57980,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57753,8 +57996,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -57822,11 +58065,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *55 + schema: *56 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57842,11 +58085,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *56 - required: *57 + properties: *57 + required: *58 examples: default: - value: *58 + value: *59 headers: Link: example: ; rel="next", ; @@ -57854,7 +58097,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57880,7 +58123,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57896,11 +58139,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *307 - required: *308 + properties: *308 + required: *309 examples: default: - value: *321 + value: *322 headers: Link: example: ; rel="next", ; @@ -57987,10 +58230,10 @@ paths: octicon: repo '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58031,8 +58274,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: *205 @@ -58066,7 +58309,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58127,7 +58370,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58143,11 +58386,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *82 - required: *83 + properties: *83 + required: *84 examples: default: - value: *315 + value: *316 headers: Link: example: ; rel="next", ; @@ -58189,7 +58432,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58249,10 +58492,10 @@ paths: schema: *6 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *42 + content: *43 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58286,7 +58529,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58302,8 +58545,8 @@ paths: title: Event description: Event type: object - properties: *74 - required: *75 + properties: *75 + required: *76 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58328,7 +58571,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58344,8 +58587,8 @@ paths: title: Event description: Event type: object - properties: *74 - required: *75 + properties: *75 + required: *76 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58404,7 +58647,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58424,7 +58667,7 @@ paths: required: *108 examples: default: - value: *302 + value: *303 headers: Link: example: ; rel="next", ; @@ -58516,16 +58759,16 @@ paths: (when it was last pushed to). in: query required: false - schema: *249 + schema: *256 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *95 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58541,12 +58784,12 @@ paths: title: Repository description: A git repository type: object - properties: *50 - required: *51 + properties: *51 + required: *52 examples: default-response: summary: Default response - value: *318 + value: *319 application/vnd.github.v3.star+json: schema: type: array @@ -58554,12 +58797,12 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: *322 - required: *323 + properties: *323 + required: *324 examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: *324 + value: *325 headers: Link: example: ; rel="next", ; @@ -58589,7 +58832,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58609,7 +58852,7 @@ paths: required: *108 examples: default: - value: *302 + value: *303 headers: Link: example: ; rel="next", ; diff --git a/descriptions/ghes-2.19/ghes-2.19.json b/descriptions/ghes-2.19/ghes-2.19.json index 2db1b83222..24fb64c85e 100644 --- a/descriptions/ghes-2.19/ghes-2.19.json +++ b/descriptions/ghes-2.19/ghes-2.19.json @@ -824,6 +824,32 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1284,6 +1310,23 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -1794,6 +1837,24 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -2902,6 +2963,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -3294,6 +3364,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -5853,6 +5932,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -6007,6 +6087,9 @@ }, { "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -7742,6 +7825,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -8429,6 +8513,24 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -15967,6 +16069,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -16341,9 +16463,15 @@ { "$ref": "#/components/parameters/repo" }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -16410,7 +16538,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -16443,6 +16571,14 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -16518,7 +16654,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -16619,13 +16755,19 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -16680,7 +16822,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -16825,7 +16967,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -16926,7 +17068,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -17106,7 +17248,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -17354,7 +17496,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -18045,7 +18188,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -18055,6 +18199,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -18112,6 +18276,26 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -18119,6 +18303,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -18549,7 +18734,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -18621,7 +18806,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -18772,7 +18957,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -18858,7 +19043,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -19232,7 +19417,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -24256,6 +24442,23 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -24935,7 +25138,17 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/sort" + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "created_at" + ] + } }, { "name": "direction", @@ -27158,6 +27371,79 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content-file" + }, + "examples": { + "default": { + "$ref": "#/components/examples/content-file" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -27571,7 +27857,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -28793,6 +29079,12 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" } ], "responses": { @@ -34021,6 +34313,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -37081,6 +37374,20 @@ "type": "integer" } }, + "direction": { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, "key-ids": { "name": "key_ids", "in": "path", @@ -37234,20 +37541,6 @@ "type": "string" } }, - "direction": { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, "owner": { "name": "owner", "in": "path", diff --git a/descriptions/ghes-2.19/ghes-2.19.yaml b/descriptions/ghes-2.19/ghes-2.19.yaml index d6081de581..e0bf24c762 100644 --- a/descriptions/ghes-2.19/ghes-2.19.yaml +++ b/descriptions/ghes-2.19/ghes-2.19.yaml @@ -600,6 +600,23 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string responses: '200': description: response @@ -904,6 +921,17 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1294,6 +1322,19 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: One of `created` (when the repository was starred) or `updated` + (when it was last pushed to) or `name`. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -2099,6 +2140,12 @@ paths: parameters: - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -2385,6 +2432,12 @@ paths: parameters: - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -4167,6 +4220,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -4269,6 +4323,7 @@ paths: schema: type: boolean - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -5496,6 +5551,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -5968,6 +6024,18 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: The sort order for the response collection. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -11568,6 +11636,20 @@ paths: type: string - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -11860,8 +11942,10 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -11906,7 +11990,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -11927,6 +12011,11 @@ paths: default: latest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -11980,7 +12069,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -12055,12 +12144,14 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -12096,7 +12187,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -12254,7 +12345,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -12315,7 +12406,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -12451,7 +12542,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -12619,6 +12710,7 @@ paths: schema: type: string default: none + nullable: true - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" responses: @@ -13220,9 +13312,24 @@ paths: - newest - oldest - stargazers + - watchers default: newest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -13261,11 +13368,26 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -13644,7 +13766,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -13690,7 +13812,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -13789,7 +13911,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -13846,7 +13968,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -14175,6 +14297,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -17553,6 +17676,17 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -18068,7 +18202,15 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/sort" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -19620,6 +19762,56 @@ paths: previews: [] category: repos subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository-readme + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/content-file" + examples: + default: + "$ref": "#/components/examples/content-file" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents "/repos/{owner}/{repo}/releases": get: summary: List releases @@ -19899,7 +20091,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -20723,6 +20915,8 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" responses: '200': description: response @@ -24636,6 +24830,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -26699,6 +26894,17 @@ components: required: true schema: type: integer + direction: + name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc key-ids: name: key_ids in: path @@ -26818,17 +27024,6 @@ components: required: false schema: type: string - direction: - name: direction - description: One of `asc` (ascending) or `desc` (descending). - in: query - required: false - schema: - type: string - enum: - - asc - - desc - default: desc owner: name: owner in: path diff --git a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json index 9c8e315069..a5df8416c8 100644 --- a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json +++ b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json @@ -1140,6 +1140,43 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1895,6 +1932,34 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -2742,6 +2807,35 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -8930,6 +9024,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -13439,6 +13542,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -31006,6 +31118,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -33682,6 +33795,15 @@ "type": "integer", "default": 30 } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -47281,6 +47403,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -51718,6 +51841,35 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -99621,6 +99773,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -105300,9 +105472,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -106047,7 +106237,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -106109,6 +106299,14 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -107100,7 +107298,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -109369,13 +109567,31 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -111125,7 +111341,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -113360,7 +113576,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -114075,7 +114291,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -114767,7 +114983,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -115490,7 +115706,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -122194,7 +122411,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -122216,6 +122434,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -123924,6 +124162,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -123931,6 +124189,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -126399,7 +126658,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -126561,7 +126820,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -126921,7 +127180,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -127136,7 +127395,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -128152,7 +128411,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -170392,6 +170652,34 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -178847,16 +179135,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -198980,6 +199267,279 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -201467,7 +202027,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -206284,6 +206844,24 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -240653,6 +241231,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" diff --git a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml index eeaf1a4db8..17f2c7c3b5 100644 --- a/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml +++ b/descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml @@ -742,6 +742,32 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: &9 + type: string + enum: + - asc + - desc + default: desc + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string responses: '200': description: response @@ -1093,7 +1119,7 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: &81 + properties: &82 login: type: string example: github @@ -1134,7 +1160,7 @@ paths: type: string example: A great organization nullable: true - required: &82 + required: &83 - login - url - id @@ -1204,7 +1230,7 @@ paths: - name: org in: path required: true - schema: &83 + schema: &84 type: string responses: '202': @@ -1260,6 +1286,21 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1269,7 +1310,7 @@ paths: type: array items: type: object - properties: &9 + properties: &10 id: type: integer name: @@ -1360,7 +1401,7 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default: value: @@ -1425,7 +1466,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: &10 + schema: &11 type: integer responses: '200': @@ -1434,7 +1475,7 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default: value: @@ -1481,7 +1522,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *10 + schema: *11 responses: '200': description: response @@ -1489,7 +1530,7 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default-response: value: @@ -1582,7 +1623,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *10 + schema: *11 responses: '204': description: Empty response @@ -1652,7 +1693,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *10 + schema: *11 responses: '202': description: response @@ -1660,7 +1701,7 @@ paths: application/json: schema: type: object - properties: &11 + properties: &12 url: type: string state: @@ -1739,7 +1780,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *10 + schema: *11 responses: '200': description: response @@ -1747,7 +1788,7 @@ paths: application/json: schema: type: object - properties: *11 + properties: *12 examples: default: value: @@ -1790,6 +1831,23 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + description: One of `created` (when the repository was starred) or `updated` + (when it was last pushed to) or `name`. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1799,7 +1857,7 @@ paths: type: array items: type: object - properties: &12 + properties: &13 id: type: integer name: @@ -1912,10 +1970,10 @@ paths: application/json: schema: type: object - properties: *12 + properties: *13 examples: default: - value: &13 + value: &14 id: 1 name: Check Commits enforcement: disabled @@ -2013,7 +2071,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: &14 + schema: &15 type: integer responses: '200': @@ -2022,10 +2080,10 @@ paths: application/json: schema: type: object - properties: *12 + properties: *13 examples: default: - value: *13 + value: *14 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -2055,7 +2113,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -2063,7 +2121,7 @@ paths: application/json: schema: type: object - properties: *12 + properties: *13 examples: default: value: @@ -2154,7 +2212,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '204': description: Empty response @@ -2205,7 +2263,7 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: &17 + properties: &18 id: type: integer url: @@ -2261,7 +2319,7 @@ paths: - title: Simple User description: Simple User type: object - properties: &15 + properties: &16 login: type: string example: octocat @@ -2327,7 +2385,7 @@ paths: starred_at: type: string example: '"2020-07-09T00:17:55Z"' - required: &16 + required: &17 - avatar_url - events_url - followers_url @@ -2358,7 +2416,7 @@ paths: type: object description: The permissions granted to the user-to-server access token. - properties: &25 + properties: &26 actions: type: string description: 'The level of permission to grant the @@ -2607,7 +2665,7 @@ paths: enum: - read - write - example: &26 + example: &27 contents: read issues: read deployments: write @@ -2641,8 +2699,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true required: - permissions @@ -2650,7 +2708,7 @@ paths: - single_file_name - repositories_url - account - required: &18 + required: &19 - app - id - note @@ -2665,7 +2723,7 @@ paths: - updated_at examples: default: - value: &40 + value: &41 - id: 2 url: https://enterprise.octocat.com/api/v3/authorizations/2 app: @@ -2757,8 +2815,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -2907,11 +2965,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: &41 + value: &42 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -2995,7 +3053,7 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: &19 + properties: &20 id: description: Unique identifier of the GitHub app example: 37 @@ -3013,8 +3071,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true name: description: The name of the GitHub app @@ -3085,7 +3143,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &20 + required: &21 - id - node_id - owner @@ -3100,7 +3158,7 @@ paths: additionalProperties: true examples: default: - value: &39 + value: &40 id: 1 slug: octoapp node_id: MDExOkludGVncmF0aW9uMQ== @@ -3181,8 +3239,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true - type: object properties: @@ -3272,13 +3330,13 @@ paths: -----END RSA PRIVATE KEY----- '404': description: Resource Not Found - content: &23 + content: &24 application/json: schema: title: Basic Error description: Basic Error type: object - properties: &27 + properties: &28 message: type: string documentation_url: @@ -3291,10 +3349,10 @@ paths: title: Validation Error Simple description: Validation Error Simple type: object - required: &88 + required: &89 - message - documentation_url - properties: &89 + properties: &90 message: type: string documentation_url: @@ -3333,7 +3391,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: &29 + schema: &30 type: integer default: 30 - name: page @@ -3352,7 +3410,7 @@ paths: title: Installation description: Installation type: object - properties: &21 + properties: &22 id: description: The ID of the installation. type: integer @@ -3363,8 +3421,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true - title: Enterprise description: An enterprise account @@ -3496,8 +3554,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true suspended_at: type: string @@ -3507,7 +3565,7 @@ paths: type: string example: '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' nullable: true - required: &22 + required: &23 - id - app_id - app_slug @@ -3605,7 +3663,7 @@ paths: description: installation_id parameter in: path required: true - schema: &24 + schema: &25 type: integer responses: '200': @@ -3616,8 +3674,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: @@ -3661,10 +3719,10 @@ paths: app_slug: github-actions '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: &28 + content: &29 application/json: schema: type: object @@ -3710,13 +3768,13 @@ paths: description: installation_id parameter in: path required: true - schema: *24 + schema: *25 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -3760,7 +3818,7 @@ paths: description: installation_id parameter in: path required: true - schema: *24 + schema: *25 requestBody: content: application/json: @@ -3787,8 +3845,8 @@ paths: type: object description: The permissions granted to the user-to-server access token. - properties: *25 - example: *26 + properties: *26 + example: *27 responses: '201': description: response @@ -3828,7 +3886,7 @@ paths: title: Repository description: A git repository type: object - properties: &49 + properties: &50 id: description: Unique identifier of the repository example: 42 @@ -3849,7 +3907,7 @@ paths: - title: License Simple description: License Simple type: object - properties: &70 + properties: &71 key: type: string example: mit @@ -3871,7 +3929,7 @@ paths: html_url: type: string format: uri - required: &71 + required: &72 - key - name - url @@ -3902,8 +3960,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true private: description: Whether the repository is private or public. @@ -4386,7 +4444,7 @@ paths: example: '"2020-07-09T00:17:42Z"' anonymous_access_enabled: type: boolean - required: &50 + required: &51 - archive_url - assignees_url - blobs_url @@ -4593,40 +4651,40 @@ paths: anonymous_access_enabled: false '403': description: Forbidden - content: &30 + content: &31 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '415': description: Preview Header Missing - content: *28 + content: *29 '401': description: Requires Authentication - content: &31 + content: &32 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: &35 + content: &36 application/json: schema: title: Validation Error description: Validation Error type: object - required: &86 + required: &87 - message - documentation_url - properties: &87 + properties: &88 message: type: string documentation_url: @@ -4686,11 +4744,17 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -4702,7 +4766,7 @@ paths: title: Application Grant description: The authorization associated with an OAuth Access. type: object - properties: &32 + properties: &33 id: type: integer example: 1 @@ -4744,10 +4808,10 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true - required: &33 + required: &34 - app - id - scopes @@ -4776,13 +4840,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4813,7 +4877,7 @@ paths: description: grant_id parameter in: path required: true - schema: &34 + schema: &35 type: integer responses: '200': @@ -4824,8 +4888,8 @@ paths: title: Application Grant description: The authorization associated with an OAuth Access. type: object - properties: *32 - required: *33 + properties: *33 + required: *34 examples: default: value: @@ -4843,10 +4907,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4873,7 +4937,7 @@ paths: description: grant_id parameter in: path required: true - schema: *34 + schema: *35 responses: '204': description: Empty response @@ -4881,10 +4945,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4911,7 +4975,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: &36 + schema: &37 type: string requestBody: content: @@ -4930,7 +4994,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4957,11 +5021,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 - name: access_token in: path required: true - schema: &38 + schema: &39 type: string responses: '204': @@ -4996,7 +5060,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 requestBody: content: application/json: @@ -5018,11 +5082,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: &37 + value: &38 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -5061,10 +5125,10 @@ paths: site_admin: false '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5091,7 +5155,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 requestBody: content: application/json: @@ -5113,14 +5177,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *37 + value: *38 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5144,7 +5208,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 requestBody: content: application/json: @@ -5164,7 +5228,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5189,11 +5253,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 - name: access_token in: path required: true - schema: *38 + schema: *39 responses: '200': description: response @@ -5206,14 +5270,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *37 + value: *38 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5240,11 +5304,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 - name: access_token in: path required: true - schema: *38 + schema: *39 responses: '200': description: response @@ -5255,11 +5319,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *37 + value: *38 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5286,11 +5350,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 - name: access_token in: path required: true - schema: *38 + schema: *39 responses: '204': description: Empty response @@ -5335,21 +5399,21 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true examples: default: - value: *39 + value: *40 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -5381,11 +5445,17 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -5398,11 +5468,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *40 + value: *41 headers: Link: example: ; rel="next", ; @@ -5412,13 +5482,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5494,11 +5564,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *41 + value: *42 headers: Location: example: https://api.github.com/authorizations/1 @@ -5506,24 +5576,24 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '410': description: Gone - content: &46 + content: &47 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5557,7 +5627,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 requestBody: content: application/json: @@ -5601,8 +5671,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: response-if-returning-an-existing-token: value: @@ -5643,11 +5713,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *41 + value: *42 headers: Location: example: https://api.github.com/authorizations/1 @@ -5655,15 +5725,15 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5695,7 +5765,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 - name: fingerprint in: path required: true @@ -5740,8 +5810,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: response-if-returning-an-existing-token: value: @@ -5775,8 +5845,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: value: @@ -5803,7 +5873,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5834,7 +5904,7 @@ paths: description: authorization_id parameter in: path required: true - schema: &42 + schema: &43 type: integer responses: '200': @@ -5846,11 +5916,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: &43 + value: &44 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -5871,10 +5941,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5903,7 +5973,7 @@ paths: description: authorization_id parameter in: path required: true - schema: *42 + schema: *43 requestBody: content: application/json: @@ -5950,14 +6020,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *43 + value: *44 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5987,7 +6057,7 @@ paths: description: authorization_id parameter in: path required: true - schema: *42 + schema: *43 responses: '204': description: Empty response @@ -5995,10 +6065,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -6030,7 +6100,7 @@ paths: title: Code Of Conduct description: Code Of Conduct type: object - properties: &44 + properties: &45 key: type: string example: contributor_covenant @@ -6096,7 +6166,7 @@ paths: type: string format: uri nullable: true - required: &45 + required: &46 - url - html_url - key @@ -6116,7 +6186,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6157,8 +6227,8 @@ paths: title: Code Of Conduct description: Code Of Conduct type: object - properties: *44 - required: *45 + properties: *45 + required: *46 examples: default: value: @@ -6217,12 +6287,12 @@ paths: html_url: http://contributor-covenant.org/version/1/4/ '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6327,21 +6397,21 @@ paths: self.save() '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '415': description: Preview Header Missing - content: *28 + content: *29 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6636,7 +6706,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -6652,7 +6722,7 @@ paths: title: Event description: Event type: object - properties: &73 + properties: &74 id: type: string type: @@ -6662,7 +6732,7 @@ paths: title: Actor description: Actor type: object - properties: &47 + properties: &48 id: type: integer login: @@ -6678,7 +6748,7 @@ paths: avatar_url: type: string format: uri - required: &48 + required: &49 - id - login - gravatar_id @@ -6702,8 +6772,8 @@ paths: title: Actor description: Actor type: object - properties: *47 - required: *48 + properties: *48 + required: *49 payload: type: object properties: @@ -6761,8 +6831,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true labels: type: array @@ -6813,8 +6883,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assignees: type: array @@ -6822,8 +6892,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true milestone: @@ -6833,7 +6903,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &66 + properties: &67 url: type: string format: uri @@ -6878,8 +6948,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true open_issues: type: integer @@ -6905,7 +6975,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &67 + required: &68 - closed_issues - creator - description @@ -6977,7 +7047,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: &51 + enum: &52 - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER @@ -6997,8 +7067,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 performed_via_github_app: nullable: true allOf: @@ -7010,8 +7080,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true required: &209 - assignee @@ -7070,8 +7140,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -7089,7 +7159,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 performed_via_github_app: nullable: true allOf: @@ -7101,13 +7171,13 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true reactions: title: Reaction Rollup type: object - properties: &68 + properties: &69 url: type: string format: uri @@ -7129,7 +7199,7 @@ paths: type: integer rocket: type: integer - required: &69 + required: &70 - url - total_count - "+1" @@ -7176,7 +7246,7 @@ paths: type: string format: date-time nullable: true - required: &74 + required: &75 - id - type - actor @@ -7188,7 +7258,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '503': description: Service Unavailable content: &180 @@ -7272,58 +7342,58 @@ paths: title: Link With Type description: Hypermedia Link with Type type: object - properties: &52 + properties: &53 href: type: string type: type: string - required: &53 + required: &54 - href - type user: title: Link With Type description: Hypermedia Link with Type type: object - properties: *52 - required: *53 + properties: *53 + required: *54 security_advisories: title: Link With Type description: Hypermedia Link with Type type: object - properties: *52 - required: *53 + properties: *53 + required: *54 current_user: title: Link With Type description: Hypermedia Link with Type type: object - properties: *52 - required: *53 + properties: *53 + required: *54 current_user_public: title: Link With Type description: Hypermedia Link with Type type: object - properties: *52 - required: *53 + properties: *53 + required: *54 current_user_actor: title: Link With Type description: Hypermedia Link with Type type: object - properties: *52 - required: *53 + properties: *53 + required: *54 current_user_organization: title: Link With Type description: Hypermedia Link with Type type: object - properties: *52 - required: *53 + properties: *53 + required: *54 current_user_organizations: type: array items: title: Link With Type description: Hypermedia Link with Type type: object - properties: *52 - required: *53 + properties: *53 + required: *54 required: - timeline - user @@ -7388,12 +7458,12 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: &54 + schema: &55 type: string - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -7409,7 +7479,7 @@ paths: title: Base Gist description: Base Gist type: object - properties: &55 + properties: &56 url: type: string format: uri @@ -7466,8 +7536,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true comments_url: type: string @@ -7478,8 +7548,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true truncated: type: boolean @@ -7489,7 +7559,7 @@ paths: history: type: array items: {} - required: &56 + required: &57 - id - node_id - url @@ -7508,7 +7578,7 @@ paths: - updated_at examples: default: - value: &57 + value: &58 - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits @@ -7560,7 +7630,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7628,7 +7698,7 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: &58 + properties: &59 url: type: string forks_url: @@ -7685,14 +7755,14 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true truncated: type: boolean examples: default: - value: &59 + value: &60 url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits @@ -7713,15 +7783,15 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7748,11 +7818,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -7768,11 +7838,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *55 - required: *56 + properties: *56 + required: *57 examples: default: - value: *57 + value: *58 headers: Link: example: ; rel="next", ; @@ -7780,12 +7850,12 @@ paths: schema: *6 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7809,11 +7879,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -7829,11 +7899,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *55 - required: *56 + properties: *56 + required: *57 examples: default: - value: *57 + value: *58 headers: Link: example: ; rel="next", ; @@ -7841,12 +7911,12 @@ paths: schema: *6 '401': description: Requires Authentication - content: *31 + content: *32 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7868,7 +7938,7 @@ paths: description: gist_id parameter in: path required: true - schema: &60 + schema: &61 type: string responses: '200': @@ -7879,13 +7949,13 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *58 + properties: *59 examples: default: - value: *59 + value: *60 '403': description: Forbidden Gist - content: &64 + content: &65 application/json: schema: type: object @@ -7906,7 +7976,7 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified x-github: @@ -7931,7 +8001,7 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 requestBody: content: application/json: @@ -7982,16 +8052,16 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *58 + properties: *59 examples: default: - value: *59 + value: *60 '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8012,18 +8082,18 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8045,11 +8115,11 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -8065,7 +8135,7 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: &61 + properties: &62 id: type: integer example: 1 @@ -8087,8 +8157,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -8103,8 +8173,8 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 - required: &62 + enum: *52 + required: &63 - url - id - node_id @@ -8151,10 +8221,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8175,7 +8245,7 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 requestBody: content: application/json: @@ -8198,11 +8268,11 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *61 - required: *62 + properties: *62 + required: *63 examples: default: - value: &63 + value: &64 id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== url: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 @@ -8238,10 +8308,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8263,12 +8333,12 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 - name: comment_id description: comment_id parameter in: path required: true - schema: &65 + schema: &66 type: integer responses: '200': @@ -8279,19 +8349,19 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *61 - required: *62 + properties: *62 + required: *63 examples: default: - value: *63 + value: *64 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden Gist - content: *64 + content: *65 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8312,12 +8382,12 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 - name: comment_id description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -8340,14 +8410,14 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *61 - required: *62 + properties: *62 + required: *63 examples: default: - value: *63 + value: *64 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8368,12 +8438,12 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 - name: comment_id description: comment_id parameter in: path required: true - schema: *65 + schema: *66 responses: '204': description: Empty response @@ -8381,10 +8451,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8406,11 +8476,11 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -8440,8 +8510,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true change_status: type: object @@ -8498,12 +8568,12 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8525,11 +8595,11 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -8545,7 +8615,7 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *58 + properties: *59 examples: default: value: @@ -8597,12 +8667,12 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8623,7 +8693,7 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 responses: '201': description: response @@ -8633,8 +8703,8 @@ paths: title: Base Gist description: Base Gist type: object - properties: *55 - required: *56 + properties: *56 + required: *57 examples: default: value: @@ -8687,15 +8757,15 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8717,7 +8787,7 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 responses: '204': description: Response if gist is starred @@ -8733,7 +8803,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8755,18 +8825,18 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8787,7 +8857,7 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 responses: '204': description: Empty response @@ -8795,10 +8865,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8820,7 +8890,7 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 - name: sha in: path required: true @@ -8835,19 +8905,19 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *58 + properties: *59 examples: default: - value: *59 + value: *60 '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8999,7 +9069,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -9023,8 +9093,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 repository_selection: type: string example: selected @@ -9141,12 +9211,12 @@ paths: schema: *6 '403': description: Forbidden - content: *30 + content: *31 '304': description: Not Modified '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -9226,6 +9296,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -9244,7 +9315,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: &93 + schema: &94 type: string - name: sort description: What to sort results by. Can be either `created`, `updated`, @@ -9262,19 +9333,14 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: &94 - type: string - enum: - - asc - - desc - default: desc + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: collab in: query required: false @@ -9298,7 +9364,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -9364,8 +9430,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true labels: description: Labels to associate with this issue; pass one or @@ -9405,8 +9471,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assignees: type: array @@ -9414,8 +9480,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true milestone: @@ -9424,8 +9490,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 locked: type: boolean active_lock_reason: @@ -9477,8 +9543,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body_html: type: string @@ -9491,8 +9557,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 performed_via_github_app: nullable: true allOf: @@ -9503,20 +9569,20 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true author_association: title: author_association type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 reactions: title: Reaction Rollup type: object - properties: *68 - required: *69 + properties: *69 + required: *70 required: &96 - assignee - closed_at @@ -9778,12 +9844,12 @@ paths: schema: *6 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9816,7 +9882,11 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 responses: '200': description: response @@ -9828,8 +9898,8 @@ paths: title: License Simple description: License Simple type: object - properties: *70 - required: *71 + properties: *71 + required: *72 examples: default: value: @@ -10054,10 +10124,10 @@ paths: featured: true '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified x-github: @@ -10114,7 +10184,7 @@ paths: type: string X-CommonMarker-Version: example: 0.17.4 - schema: &72 + schema: &73 type: string content: text/html: @@ -10157,7 +10227,7 @@ paths: headers: X-CommonMarker-Version: example: 0.17.4 - schema: *72 + schema: *73 content: text/html: schema: @@ -10236,7 +10306,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -10252,14 +10322,14 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '304': description: Not Modified '301': @@ -10303,7 +10373,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -10315,7 +10385,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -10331,7 +10401,7 @@ paths: title: Thread description: Thread type: object - properties: &75 + properties: &76 id: type: string repository: @@ -10358,8 +10428,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true private: type: boolean @@ -10580,8 +10650,8 @@ paths: - title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 subscribers_count: type: integer network_count: @@ -10688,7 +10758,7 @@ paths: subscription_url: type: string example: https://api.github.com/notifications/threads/2/subscription - required: &76 + required: &77 - id - unread - reason @@ -10789,13 +10859,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10847,10 +10917,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10872,7 +10942,7 @@ paths: description: thread_id parameter in: path required: true - schema: &77 + schema: &78 type: integer responses: '200': @@ -10883,8 +10953,8 @@ paths: title: Thread description: Thread type: object - properties: *75 - required: *76 + properties: *76 + required: *77 examples: default: value: @@ -10971,10 +11041,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10995,7 +11065,7 @@ paths: description: thread_id parameter in: path required: true - schema: *77 + schema: *78 responses: '205': description: response @@ -11003,7 +11073,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11028,7 +11098,7 @@ paths: description: thread_id parameter in: path required: true - schema: *77 + schema: *78 responses: '200': description: response @@ -11038,7 +11108,7 @@ paths: title: Thread Subscription description: Thread Subscription type: object - properties: &78 + properties: &79 subscribed: type: boolean example: true @@ -11064,7 +11134,7 @@ paths: type: string format: uri example: https://api.github.com/repos/1 - required: &79 + required: &80 - created_at - ignored - reason @@ -11072,7 +11142,7 @@ paths: - subscribed examples: default: - value: &80 + value: &81 subscribed: true ignored: false reason: @@ -11083,10 +11153,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11112,7 +11182,7 @@ paths: description: thread_id parameter in: path required: true - schema: *77 + schema: *78 requestBody: content: application/json: @@ -11132,19 +11202,19 @@ paths: title: Thread Subscription description: Thread Subscription type: object - properties: *78 - required: *79 + properties: *79 + required: *80 examples: default: - value: *80 + value: *81 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11169,7 +11239,7 @@ paths: description: thread_id parameter in: path required: true - schema: *77 + schema: *78 responses: '204': description: Empty response @@ -11177,10 +11247,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11237,7 +11307,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 responses: '200': description: response @@ -11249,11 +11319,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *81 - required: *82 + properties: *82 + required: *83 examples: default: - value: &314 + value: &315 - login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= @@ -11296,7 +11366,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 responses: '200': description: response @@ -11306,7 +11376,7 @@ paths: title: Organization Full description: Organization Full type: object - properties: &84 + properties: &85 login: type: string example: github @@ -11462,7 +11532,7 @@ paths: updated_at: type: string format: date-time - required: &85 + required: &86 - login - url - id @@ -11576,7 +11646,7 @@ paths: seats: 5 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11608,7 +11678,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 requestBody: content: application/json: @@ -11738,8 +11808,8 @@ paths: title: Organization Full description: Organization Full type: object - properties: *84 - required: *85 + properties: *85 + required: *86 examples: default: value: @@ -11797,13 +11867,13 @@ paths: - title: Validation Error description: Validation Error type: object - required: *86 - properties: *87 + required: *87 + properties: *88 - title: Validation Error Simple description: Validation Error Simple type: object - required: *88 - properties: *89 + required: *89 + properties: *90 '409': description: Conflict content: &168 @@ -11812,10 +11882,10 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11845,11 +11915,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -11865,8 +11935,8 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11887,11 +11957,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -11907,7 +11977,7 @@ paths: title: Org Hook description: Org Hook type: object - properties: &90 + properties: &91 id: type: integer example: 1 @@ -11957,7 +12027,7 @@ paths: example: '2011-09-06T17:26:27Z' type: type: string - required: &91 + required: &92 - id - url - type @@ -11992,7 +12062,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12013,7 +12083,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 requestBody: content: application/json: @@ -12096,11 +12166,11 @@ paths: title: Org Hook description: Org Hook type: object - properties: *90 - required: *91 + properties: *91 + required: *92 examples: default: - value: &92 + value: &93 id: 1 url: https://api.github.com/orgs/octocat/hooks/1 ping_url: https://api.github.com/orgs/octocat/hooks/1/pings @@ -12122,10 +12192,10 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12147,7 +12217,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: hook_id in: path required: true @@ -12161,14 +12231,14 @@ paths: title: Org Hook description: Org Hook type: object - properties: *90 - required: *91 + properties: *91 + required: *92 examples: default: - value: *92 + value: *93 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12192,7 +12262,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: hook_id in: path required: true @@ -12265,8 +12335,8 @@ paths: title: Org Hook description: Org Hook type: object - properties: *90 - required: *91 + properties: *91 + required: *92 examples: default: value: @@ -12285,10 +12355,10 @@ paths: type: Organization '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12308,7 +12378,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: hook_id in: path required: true @@ -12318,7 +12388,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12340,7 +12410,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: hook_id in: path required: true @@ -12350,7 +12420,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12381,7 +12451,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 responses: '200': description: response @@ -12391,8 +12461,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: &204 @@ -12468,11 +12538,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -12496,8 +12566,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: @@ -12578,7 +12648,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: filter description: "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you @@ -12594,6 +12664,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -12612,7 +12683,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *93 + schema: *94 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -12629,18 +12700,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *94 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -12669,7 +12740,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12699,7 +12770,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: filter description: "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -12729,7 +12800,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -12745,8 +12816,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -12783,7 +12854,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12804,7 +12875,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -12843,7 +12914,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -12853,7 +12924,7 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12875,7 +12946,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -12908,16 +12979,16 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *81 - required: *82 + properties: *82 + required: *83 user: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true permissions: type: object @@ -13053,10 +13124,10 @@ paths: site_admin: false '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13088,7 +13159,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -13201,10 +13272,10 @@ paths: site_admin: false '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13227,7 +13298,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -13237,10 +13308,10 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13261,7 +13332,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: filter description: "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -13277,7 +13348,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -13293,8 +13364,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -13327,7 +13398,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -13361,7 +13432,7 @@ paths: documentation_url: https://docs.github.com/enterprise-server@2.20/rest/reference/orgs#convert-member-to-outside-collaborator '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13382,7 +13453,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -13430,7 +13501,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: per_page description: Results per page (max 100) in: query @@ -13439,6 +13510,22 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + description: The sort order for the response collection. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -13497,11 +13584,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -13548,11 +13635,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -13613,11 +13700,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -13662,7 +13749,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: state description: Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. @@ -13678,7 +13765,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -13741,8 +13828,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -13850,7 +13937,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 requestBody: content: application/json: @@ -13915,16 +14002,16 @@ paths: updated_at: '2014-03-04T18:58:10Z' '401': description: Requires Authentication - content: *31 + content: *32 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '422': description: Validation Failed content: *103 @@ -13956,11 +14043,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -13976,8 +14063,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -14007,7 +14094,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -14039,7 +14126,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -14049,7 +14136,7 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14069,7 +14156,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -14097,7 +14184,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: type description: 'Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. @@ -14142,7 +14229,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -14162,7 +14249,7 @@ paths: required: *107 examples: default: - value: &301 + value: &302 - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World @@ -14320,7 +14407,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 requestBody: content: application/json: @@ -14441,8 +14528,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: value: &188 @@ -14566,10 +14653,10 @@ paths: type: string '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14608,11 +14695,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -14759,7 +14846,7 @@ paths: schema: *6 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14782,7 +14869,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 requestBody: content: application/json: @@ -14927,8 +15014,8 @@ paths: title: Organization Full description: Organization Full type: object - properties: *84 - required: *85 + properties: *85 + required: *86 ldap_dn: description: Distinguished Name (DN) that team maps to within LDAP environment @@ -14999,10 +15086,10 @@ paths: ldap_dn: uid=asdf,ou=users,dc=github,dc=com '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15026,7 +15113,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -15050,7 +15137,7 @@ paths: value: *112 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15105,8 +15192,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -15178,13 +15265,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15246,13 +15333,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed content: *103 @@ -15306,10 +15393,10 @@ paths: type: string '401': description: Requires Authentication - content: *31 + content: *32 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15394,7 +15481,7 @@ paths: type: string '401': description: Requires Authentication - content: *31 + content: *32 '503': description: Service Unavailable content: @@ -15419,7 +15506,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15515,13 +15602,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15580,10 +15667,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15619,10 +15706,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15667,7 +15754,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -15726,10 +15813,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15807,10 +15894,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '422': description: Validation Failed content: @@ -15820,13 +15907,13 @@ paths: - title: Validation Error description: Validation Error type: object - required: *86 - properties: *87 + required: *87 + properties: *88 - title: Validation Error Simple description: Validation Error Simple type: object - required: *88 - properties: *89 + required: *89 + properties: *90 '503': description: Service Unavailable content: @@ -15904,13 +15991,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed content: *103 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15991,10 +16078,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16092,10 +16179,10 @@ paths: type: string '401': description: Requires Authentication - content: *31 + content: *32 '410': description: Gone - content: *46 + content: *47 '422': description: Validation Failed content: *103 @@ -16149,13 +16236,13 @@ paths: type: string '401': description: Requires Authentication - content: *31 + content: *32 '410': description: Gone - content: *46 + content: *47 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16207,7 +16294,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -16223,8 +16310,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -16236,21 +16323,21 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16304,21 +16391,21 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16358,19 +16445,19 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16424,8 +16511,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true required: &160 - permission @@ -16455,21 +16542,21 @@ paths: site_admin: false '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16501,7 +16588,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -16539,10 +16626,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16606,13 +16693,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed content: *103 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16749,7 +16836,7 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16848,8 +16935,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true private: type: boolean @@ -17102,8 +17189,8 @@ paths: - title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 allow_squash_merge: type: boolean example: true @@ -17122,29 +17209,29 @@ paths: - title: License Simple description: License Simple type: object - properties: *70 - required: *71 + properties: *71 + required: *72 organization: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true parent: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 source: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 forks: type: integer master_branch: @@ -18226,10 +18313,10 @@ paths: anonymous_access_enabled: false '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '301': description: Moved Permanently x-github: @@ -18871,13 +18958,13 @@ paths: anonymous_access_enabled: false '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18944,7 +19031,7 @@ paths: documentation_url: https://docs.github.com/enterprise-server@2.20/rest/reference/repos#delete-a-repository '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18974,7 +19061,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -18990,8 +19077,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -19003,7 +19090,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19051,7 +19138,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19088,7 +19175,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -19178,8 +19265,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true teams: description: The list of teams with review dismissal @@ -19470,7 +19557,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19621,8 +19708,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true committer: nullable: true @@ -19630,8 +19717,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true parents: type: array @@ -19826,10 +19913,10 @@ paths: protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection '415': description: Preview Header Missing - content: *28 + content: *29 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20007,7 +20094,7 @@ paths: enabled: true '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20269,8 +20356,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true teams: type: array @@ -20348,16 +20435,16 @@ paths: - url '403': description: Forbidden - content: *30 + content: *31 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed content: *103 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20404,7 +20491,7 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20541,7 +20628,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20734,7 +20821,7 @@ paths: value: *142 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20781,7 +20868,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20836,7 +20923,7 @@ paths: enabled: true '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20893,7 +20980,7 @@ paths: value: *143 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20939,7 +21026,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21003,7 +21090,7 @@ paths: contexts_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21072,10 +21159,10 @@ paths: value: *146 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21161,7 +21248,7 @@ paths: - continuous-integration/travis-ci '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21226,13 +21313,13 @@ paths: - continuous-integration/jenkins '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21297,10 +21384,10 @@ paths: - continuous-integration/travis-ci '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21365,10 +21452,10 @@ paths: - continuous-integration/travis-ci '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21489,7 +21576,7 @@ paths: - pull_request '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21575,8 +21662,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true examples: default: @@ -21619,7 +21706,7 @@ paths: - pull_request '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21688,15 +21775,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true examples: default: value: *147 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21766,15 +21853,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true examples: default: value: *147 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21844,15 +21931,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true examples: default: value: *147 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21907,7 +21994,7 @@ paths: value: *148 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21980,7 +22067,7 @@ paths: value: *148 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22054,7 +22141,7 @@ paths: value: *148 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22128,7 +22215,7 @@ paths: value: *148 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22175,15 +22262,15 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: value: *100 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22248,15 +22335,15 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: value: *100 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22322,15 +22409,15 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: value: *100 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22396,15 +22483,15 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: value: *100 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22821,8 +22908,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true pull_requests: items: @@ -22957,8 +23044,8 @@ paths: They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true required: - id @@ -23608,7 +23695,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -23812,8 +23899,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true repository: title: Minimal Repository @@ -24279,8 +24366,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: value: @@ -24531,7 +24618,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -24740,7 +24827,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -24883,7 +24970,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25014,8 +25101,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true inviter: nullable: true @@ -25023,8 +25110,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true permissions: description: The permission associated with the invitation. @@ -25178,10 +25265,10 @@ paths: description: Response when person is already a collaborator '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: triggersNotification: true githubCloudOnly: false @@ -25280,7 +25367,7 @@ paths: site_admin: false '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25312,7 +25399,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -25358,8 +25445,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -25372,12 +25459,12 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 reactions: title: Reaction Rollup type: object - properties: *68 - required: *69 + properties: *69 + required: *70 required: &162 - url - html_url @@ -25470,7 +25557,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 responses: '200': description: response @@ -25518,7 +25605,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25557,7 +25644,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -25618,7 +25705,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25647,13 +25734,13 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25683,7 +25770,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.20/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. @@ -25703,7 +25790,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -25733,8 +25820,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true content: description: The reaction to use @@ -25792,10 +25879,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25836,7 +25923,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -25914,10 +26001,10 @@ paths: value: *165 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26006,7 +26093,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: until description: 'Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -26017,11 +26104,25 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -26117,7 +26218,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '400': description: Bad Request content: &187 @@ -26126,7 +26227,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 application/scim+json: schema: title: Scim Error @@ -26153,7 +26254,7 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '409': description: Conflict content: *168 @@ -26232,10 +26333,10 @@ paths: protected: false '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26278,7 +26379,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -26394,10 +26495,10 @@ paths: type: string '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 x-github: triggersNotification: true githubCloudOnly: false @@ -26439,7 +26540,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -26519,8 +26620,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: type: string @@ -26551,8 +26652,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 active_lock_reason: type: string example: too heated @@ -26585,8 +26686,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assignees: type: array @@ -26594,8 +26695,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true requested_reviewers: @@ -26604,8 +26705,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true requested_teams: @@ -26630,8 +26731,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 sha: type: string user: @@ -26640,8 +26741,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true required: - label @@ -26660,8 +26761,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 sha: type: string user: @@ -26670,8 +26771,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true required: - label @@ -26747,7 +26848,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 draft: description: Indicates whether or not the pull request is a draft. @@ -27244,7 +27345,7 @@ paths: schema: *6 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27313,8 +27414,16 @@ paths: in: path required: true schema: *126 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *30 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -27417,10 +27526,10 @@ paths: ..... '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 '500': description: Internal Error content: *174 @@ -27453,7 +27562,7 @@ paths: required: true schema: *126 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -27484,11 +27593,16 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -27554,7 +27668,7 @@ paths: required: true schema: *126 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -27575,7 +27689,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -27801,12 +27915,20 @@ paths: required: true schema: *126 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - name: per_page + description: Results per page (max 100). + in: query + schema: *30 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 responses: '200': description: response @@ -27988,7 +28110,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28018,7 +28140,7 @@ paths: required: true schema: *126 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -28027,7 +28149,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -28043,7 +28165,7 @@ paths: title: Status description: The status of a commit. type: object - properties: &276 + properties: &277 url: type: string avatar_url: @@ -28069,10 +28191,10 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true - required: &277 + required: &278 - url - avatar_url - id @@ -28564,7 +28686,7 @@ paths: content: *174 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28620,7 +28742,7 @@ paths: required: true schema: *126 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -29102,10 +29224,10 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '302': description: Found x-github: @@ -29133,7 +29255,7 @@ paths: required: true schema: *126 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -29422,10 +29544,10 @@ paths: payload: '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 '409': description: Conflict content: *168 @@ -29461,7 +29583,7 @@ paths: required: true schema: *126 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -29555,10 +29677,10 @@ paths: payload: '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 '409': description: Conflict content: *168 @@ -29602,7 +29724,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -29704,10 +29826,10 @@ paths: description: Response if repository is empty '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29762,10 +29884,11 @@ paths: schema: type: string default: none + nullable: true - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -29826,8 +29949,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -29865,8 +29988,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true required: &182 - id @@ -30211,7 +30334,7 @@ paths: message: 'Conflict: Commit status checks failed for topic-branch.' '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30303,7 +30426,7 @@ paths: production_environment: true '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30354,7 +30477,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -30399,8 +30522,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true description: description: A short description of the status. @@ -30458,8 +30581,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true required: &185 - id @@ -30515,7 +30638,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30704,7 +30827,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30774,10 +30897,10 @@ paths: value: *186 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30832,7 +30955,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -30848,8 +30971,8 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30885,15 +31008,30 @@ paths: - newest - oldest - stargazers + - watchers default: newest - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -31053,11 +31191,26 @@ paths: in: path required: true schema: *126 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -31072,8 +31225,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: value: *188 @@ -31082,13 +31235,13 @@ paths: content: *187 '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31162,16 +31315,16 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '409': description: Conflict content: *168 '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31249,13 +31402,13 @@ paths: node_id: Q29udGVudCBvZiB0aGUgYmxvYg== '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31569,10 +31722,10 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31675,7 +31828,7 @@ paths: payload: '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31709,7 +31862,7 @@ paths: required: true schema: *126 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -31718,7 +31871,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -31816,7 +31969,7 @@ paths: required: true schema: *126 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -31845,7 +31998,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31917,7 +32070,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31944,7 +32097,7 @@ paths: required: true schema: *126 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -31986,7 +32139,7 @@ paths: value: *193 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32012,7 +32165,7 @@ paths: required: true schema: *126 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -32023,7 +32176,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32230,7 +32383,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32305,7 +32458,7 @@ paths: value: *198 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32491,13 +32644,13 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32531,6 +32684,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -32592,10 +32746,10 @@ paths: truncated: false '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32624,7 +32778,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -32792,7 +32946,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32934,13 +33088,13 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32987,7 +33141,7 @@ paths: value: *203 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33109,10 +33263,10 @@ paths: value: *203 '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33146,7 +33300,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33182,7 +33336,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33220,7 +33374,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33265,8 +33419,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: *204 @@ -33274,7 +33428,7 @@ paths: description: Moved Permanently '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -33309,7 +33463,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -33330,7 +33484,7 @@ paths: required: *206 examples: default: - value: &316 + value: &317 - id: 1 repository: id: 1296269 @@ -33729,7 +33883,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *93 + schema: *94 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -33746,18 +33900,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *94 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -33911,10 +34065,10 @@ paths: description: Moved Permanently '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34180,19 +34334,19 @@ paths: type: string '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 '503': description: Service Unavailable content: *180 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 x-github: triggersNotification: true githubCloudOnly: false @@ -34224,7 +34378,7 @@ paths: (when it was last pushed to). in: query required: false - schema: &248 + schema: &255 type: string enum: - created @@ -34245,11 +34399,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -34306,10 +34460,10 @@ paths: schema: *6 '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34349,7 +34503,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 responses: '200': description: response @@ -34395,7 +34549,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34432,7 +34586,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -34463,7 +34617,7 @@ paths: value: *212 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34492,7 +34646,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 responses: '204': description: Empty response @@ -34525,7 +34679,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.20/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. @@ -34545,7 +34699,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -34574,10 +34728,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34618,7 +34772,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -34673,10 +34827,10 @@ paths: value: *165 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34715,7 +34869,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -34748,8 +34902,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true event: type: string @@ -34792,8 +34946,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assigner: nullable: true @@ -34801,8 +34955,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true review_requester: nullable: true @@ -34810,8 +34964,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true requested_reviewer: nullable: true @@ -34819,8 +34973,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true requested_team: title: Team @@ -34898,7 +35052,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 lock_reason: type: string nullable: true @@ -35072,7 +35226,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35286,13 +35440,13 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35378,10 +35532,10 @@ paths: description: Moved Permanently '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '304': description: Not Modified x-github: @@ -35516,21 +35670,21 @@ paths: value: *216 '422': description: Validation Failed - content: *35 + content: *36 '503': description: Service Unavailable content: *180 '403': description: Forbidden - content: *30 + content: *31 '301': description: Moved Permanently '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35849,11 +36003,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -35882,10 +36036,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35964,16 +36118,16 @@ paths: type: string '403': description: Forbidden - content: *30 + content: *31 '410': description: Gone - content: *46 + content: *47 '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: triggersNotification: true githubCloudOnly: false @@ -36008,7 +36162,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -36035,8 +36189,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true event: type: string @@ -36068,7 +36222,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 body: type: string example: '":+1:"' @@ -36128,7 +36282,7 @@ paths: schema: *6 '410': description: Gone - content: *46 + content: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36178,7 +36332,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -36221,7 +36375,7 @@ paths: schema: *6 '410': description: Gone - content: *46 + content: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36290,10 +36444,10 @@ paths: value: *222 '410': description: Gone - content: *46 + content: *47 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36361,10 +36515,10 @@ paths: value: *222 '410': description: Gone - content: *46 + content: *47 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36399,7 +36553,7 @@ paths: description: Empty response '410': description: Gone - content: *46 + content: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36463,10 +36617,10 @@ paths: default: true '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36522,16 +36676,16 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '410': description: Gone - content: *46 + content: *47 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36572,10 +36726,10 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36625,7 +36779,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -36654,13 +36808,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36742,10 +36896,10 @@ paths: value: *165 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -36789,7 +36943,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -36816,13 +36970,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36867,7 +37021,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -37000,7 +37154,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37048,7 +37202,7 @@ paths: value: *227 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37110,7 +37264,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -37139,7 +37293,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37219,10 +37373,10 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37270,7 +37424,7 @@ paths: value: *229 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37511,8 +37665,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *70 - required: *71 + properties: *71 + required: *72 required: - _links - git_url @@ -37678,10 +37832,10 @@ paths: message: Merge Conflict '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37741,7 +37895,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -37757,8 +37911,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 examples: default: value: @@ -37803,7 +37957,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37867,8 +38021,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 examples: default: value: &231 @@ -37913,10 +38067,10 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37957,14 +38111,14 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 examples: default: value: *231 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38031,8 +38185,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 examples: default: value: *231 @@ -38070,7 +38224,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38104,7 +38258,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -38173,7 +38327,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -38184,7 +38338,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -38200,8 +38354,8 @@ paths: title: Thread description: Thread type: object - properties: *75 - required: *76 + properties: *76 + required: *77 examples: default: value: *236 @@ -38360,7 +38514,7 @@ paths: public: true '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38440,10 +38594,10 @@ paths: value: *239 '422': description: Validation Failed - content: *35 + content: *36 '415': description: Preview Header Missing - content: *28 + content: *29 '409': description: Conflict content: *168 @@ -38539,7 +38693,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *35 + content: *36 '400': description: Bad Request content: *187 @@ -38572,13 +38726,13 @@ paths: description: Empty response '422': description: Validation Failed - content: *35 + content: *36 '415': description: Preview Header Missing - content: *28 + content: *29 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38614,7 +38768,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -38650,8 +38804,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true commit: type: string @@ -38905,6 +39059,21 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -38968,7 +39137,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -39022,7 +39191,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -39089,7 +39258,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: Responds with effective values inherited from owner and/or @@ -39155,7 +39324,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -39215,16 +39384,16 @@ paths: schema: *6 '401': description: Requires Authentication - content: *31 + content: *32 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '422': description: Validation Failed content: *103 @@ -39295,16 +39464,16 @@ paths: value: *122 '401': description: Requires Authentication - content: *31 + content: *32 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '422': description: Validation Failed content: *103 @@ -39395,7 +39564,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -39425,7 +39594,7 @@ paths: description: Not Modified '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39525,7 +39694,7 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: &252 + properties: &251 url: type: string format: uri @@ -39596,8 +39765,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: type: string @@ -39629,8 +39798,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 active_lock_reason: type: string example: too heated @@ -39663,8 +39832,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assignees: type: array @@ -39672,8 +39841,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true requested_reviewers: @@ -39682,8 +39851,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true requested_teams: @@ -40389,8 +40558,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *70 - required: *71 + properties: *71 + required: *72 pushed_at: type: string format: date-time @@ -40633,7 +40802,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -40657,8 +40826,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true comments: type: integer @@ -40683,7 +40852,7 @@ paths: changed_files: type: integer example: 5 - required: &253 + required: &252 - _links - assignee - labels @@ -40727,7 +40896,7 @@ paths: - review_comments examples: default: - value: &254 + value: &253 url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 node_id: MDExOlB1bGxSZXF1ZXN0MQ== @@ -41220,10 +41389,10 @@ paths: type: string '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 x-github: triggersNotification: true githubCloudOnly: false @@ -41265,11 +41434,14 @@ paths: required: true schema: *126 - name: sort - description: One of `created` (when the repository was starred) or `updated` - (when it was last pushed to). in: query required: false - schema: *248 + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -41285,11 +41457,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -41306,7 +41478,7 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: &249 + properties: &248 url: description: URL for the pull request review comment example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 @@ -41361,8 +41533,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: description: The text of the comment. @@ -41393,7 +41565,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 _links: type: object properties: @@ -41468,15 +41640,15 @@ paths: reactions: title: Reaction Rollup type: object - properties: *68 - required: *69 + properties: *69 + required: *70 body_html: type: string example: '"

comment body

"' body_text: type: string example: '"comment body"' - required: &250 + required: &249 - url - id - node_id @@ -41612,7 +41784,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 responses: '200': description: response @@ -41623,11 +41795,11 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *249 - required: *250 + properties: *248 + required: *249 examples: default: - value: &251 + value: &250 url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 id: 10 @@ -41679,7 +41851,7 @@ paths: side: RIGHT '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41739,7 +41911,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -41763,11 +41935,11 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *249 - required: *250 + properties: *248 + required: *249 examples: default: - value: *251 + value: *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41817,13 +41989,13 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41853,7 +42025,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.20/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. @@ -41873,7 +42045,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -41902,10 +42074,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41946,7 +42118,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -42001,10 +42173,10 @@ paths: value: *165 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42058,7 +42230,7 @@ paths: - name: pull_number in: path required: true - schema: &255 + schema: &254 type: integer responses: '200': @@ -42073,11 +42245,11 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: *252 - required: *253 + properties: *251 + required: *252 examples: default: - value: *254 + value: *253 '304': description: Not Modified '500': @@ -42085,7 +42257,7 @@ paths: content: *174 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42116,7 +42288,7 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 requestBody: content: application/json: @@ -42162,17 +42334,17 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: *252 - required: *253 + properties: *251 + required: *252 examples: default: - value: *254 + value: *253 '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42215,13 +42387,13 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 - name: sort description: One of `created` (when the repository was starred) or `updated` (when it was last pushed to). in: query required: false - schema: *248 + schema: *255 - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -42237,11 +42409,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -42258,8 +42430,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *249 - required: *250 + properties: *248 + required: *249 examples: default: value: *256 @@ -42334,7 +42506,7 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 requestBody: content: application/json: @@ -42433,8 +42605,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *249 - required: *250 + properties: *248 + required: *249 examples: example-for-a-multi-line-comment: value: @@ -42494,10 +42666,10 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: triggersNotification: true githubCloudOnly: false @@ -42551,12 +42723,12 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 - name: comment_id description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -42580,8 +42752,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *249 - required: *250 + properties: *248 + required: *249 examples: default: value: @@ -42641,7 +42813,7 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 x-github: triggersNotification: true githubCloudOnly: false @@ -42674,11 +42846,11 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -42733,11 +42905,11 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -42776,7 +42948,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *35 + content: *36 '500': description: Internal Error content: *174 @@ -42808,7 +42980,7 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 responses: '204': description: Response if pull request has been merged @@ -42840,7 +43012,7 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 requestBody: content: application/json: @@ -42924,13 +43096,13 @@ paths: message: Head branch was modified. Review and try the merge again. '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: triggersNotification: true githubCloudOnly: false @@ -42960,11 +43132,11 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -42985,8 +43157,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true teams: type: array @@ -43066,7 +43238,7 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 requestBody: content: application/json: @@ -43614,7 +43786,7 @@ paths: description: Response if user is not a collaborator '403': description: Forbidden - content: *30 + content: *31 x-github: triggersNotification: true githubCloudOnly: false @@ -43643,7 +43815,7 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 requestBody: content: application/json: @@ -43674,7 +43846,7 @@ paths: description: response '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43703,11 +43875,11 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -43737,8 +43909,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: description: The text of the review. @@ -43791,7 +43963,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 required: &261 - id - node_id @@ -43878,7 +44050,7 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 requestBody: content: application/json: @@ -44004,7 +44176,7 @@ paths: content: *103 '403': description: Forbidden - content: *30 + content: *31 x-github: triggersNotification: true githubCloudOnly: false @@ -44034,7 +44206,7 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 - name: review_id description: review_id parameter in: path @@ -44090,7 +44262,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44118,7 +44290,7 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 - name: review_id description: review_id parameter in: path @@ -44216,7 +44388,7 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 - name: review_id description: review_id parameter in: path @@ -44241,7 +44413,7 @@ paths: content: *103 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44270,7 +44442,7 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 - name: review_id description: review_id parameter in: path @@ -44279,7 +44451,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -44338,8 +44510,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: type: string @@ -44365,7 +44537,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 _links: type: object properties: @@ -44505,7 +44677,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44536,7 +44708,7 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 - name: review_id description: review_id parameter in: path @@ -44605,7 +44777,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed content: *103 @@ -44637,7 +44809,7 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 - name: review_id description: review_id parameter in: path @@ -44682,13 +44854,13 @@ paths: value: *264 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed content: *103 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44718,7 +44890,7 @@ paths: - name: pull_number in: path required: true - schema: *255 + schema: *254 requestBody: content: application/json: @@ -44754,13 +44926,13 @@ paths: url: https://github.com/repos/octocat/Hello-World/pulls/53 '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -44816,7 +44988,7 @@ paths: required: *266 examples: default: - value: + value: &267 type: file encoding: base64 size: 5362 @@ -44834,10 +45006,72 @@ paths: html: https://github.com/octokit/octokit.rb/blob/master/README.md '404': description: Resource Not Found - content: *23 + content: *24 + '422': + description: Validation Failed + content: *36 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository-readme + parameters: + - name: owner + in: path + required: true + schema: *125 + - name: repo + in: path + required: true + schema: *126 + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + title: Content File + description: Content File + type: object + properties: *265 + required: *266 + examples: + default: + value: *267 + '404': + description: Resource Not Found + content: *24 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44869,7 +45103,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -44885,7 +45119,7 @@ paths: title: Release description: A release. type: object - properties: &267 + properties: &268 url: type: string format: uri @@ -44945,8 +45179,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assets: type: array @@ -44954,7 +45188,7 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: &269 + properties: &270 url: type: string format: uri @@ -44996,10 +45230,10 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true - required: &270 + required: &271 - id - name - content_type @@ -45017,7 +45251,7 @@ paths: type: string body_text: type: string - required: &268 + required: &269 - assets_url - upload_url - tarball_url @@ -45112,7 +45346,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45189,11 +45423,11 @@ paths: title: Release description: A release. type: object - properties: *267 - required: *268 + properties: *268 + required: *269 examples: default: - value: &273 + value: &274 url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 assets_url: https://api.github.com/repos/octocat/Hello-World/releases/1/assets @@ -45268,7 +45502,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: triggersNotification: true githubCloudOnly: false @@ -45302,7 +45536,7 @@ paths: description: asset_id parameter in: path required: true - schema: &271 + schema: &272 type: integer responses: '200': @@ -45317,11 +45551,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *269 - required: *270 + properties: *270 + required: *271 examples: default: - value: &272 + value: &273 url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip id: 1 @@ -45355,10 +45589,10 @@ paths: site_admin: false '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '302': description: Found x-github: @@ -45389,7 +45623,7 @@ paths: description: asset_id parameter in: path required: true - schema: *271 + schema: *272 requestBody: content: application/json: @@ -45418,11 +45652,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *269 - required: *270 + properties: *270 + required: *271 examples: default: - value: *272 + value: *273 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45451,7 +45685,7 @@ paths: description: asset_id parameter in: path required: true - schema: *271 + schema: *272 responses: '204': description: Empty response @@ -45492,11 +45726,11 @@ paths: title: Release description: A release. type: object - properties: *267 - required: *268 + properties: *268 + required: *269 examples: default: - value: *273 + value: *274 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45523,7 +45757,7 @@ paths: required: true schema: *126 - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -45538,14 +45772,14 @@ paths: title: Release description: A release. type: object - properties: *267 - required: *268 + properties: *268 + required: *269 examples: default: - value: *273 + value: *274 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45576,7 +45810,7 @@ paths: description: release_id parameter in: path required: true - schema: &274 + schema: &275 type: integer responses: '200': @@ -45588,14 +45822,14 @@ paths: title: Release description: A release. type: object - properties: *267 - required: *268 + properties: *268 + required: *269 examples: default: - value: *273 + value: *274 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45624,7 +45858,7 @@ paths: description: release_id parameter in: path required: true - schema: *274 + schema: *275 requestBody: content: application/json: @@ -45670,11 +45904,11 @@ paths: title: Release description: A release. type: object - properties: *267 - required: *268 + properties: *268 + required: *269 examples: default: - value: *273 + value: *274 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45703,7 +45937,7 @@ paths: description: release_id parameter in: path required: true - schema: *274 + schema: *275 responses: '204': description: Empty response @@ -45736,11 +45970,11 @@ paths: description: release_id parameter in: path required: true - schema: *274 + schema: *275 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -45756,8 +45990,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *269 - required: *270 + properties: *270 + required: *271 examples: default: value: @@ -45854,7 +46088,7 @@ paths: description: release_id parameter in: path required: true - schema: *274 + schema: *275 - name: name in: query schema: @@ -45878,8 +46112,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *269 - required: *270 + properties: *270 + required: *271 examples: response-for-successful-upload: value: @@ -45945,7 +46179,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -45961,8 +46195,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default-response: @@ -46003,8 +46237,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true required: - starred_at @@ -46040,7 +46274,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46079,7 +46313,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: &275 + items: &276 type: integer examples: default: @@ -46214,8 +46448,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true total: type: integer @@ -46429,7 +46663,7 @@ paths: - 3 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46475,7 +46709,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: *275 + items: *276 examples: default: value: @@ -46569,8 +46803,8 @@ paths: title: Status description: The status of a commit. type: object - properties: *276 - required: *277 + properties: *277 + required: *278 examples: default: value: @@ -46636,7 +46870,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -46652,8 +46886,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -46698,7 +46932,7 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: &278 + properties: &279 subscribed: description: Determines if notifications should be received from this repository. @@ -46723,7 +46957,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/example - required: &279 + required: &280 - created_at - ignored - reason @@ -46743,7 +46977,7 @@ paths: description: Response if you don't subscribe to the repository '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -46796,8 +47030,8 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: *278 - required: *279 + properties: *279 + required: *280 examples: default: value: @@ -46864,7 +47098,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -46996,7 +47230,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -47048,6 +47282,14 @@ paths: in: path required: true schema: *126 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *30 responses: '200': description: response @@ -47057,16 +47299,16 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: &280 + properties: &281 names: type: array items: type: string - required: &281 + required: &282 - names examples: default: - value: &282 + value: &283 names: - octocat - atom @@ -47074,10 +47316,10 @@ paths: - api '415': description: Preview Header Missing - content: *28 + content: *29 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47140,17 +47382,17 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: *280 - required: *281 + properties: *281 + required: *282 examples: default: - value: *282 + value: *283 '415': description: Preview Header Missing - content: *28 + content: *29 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed content: *103 @@ -47222,8 +47464,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: value: *188 @@ -47422,8 +47664,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: value: @@ -47683,7 +47925,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified x-github: @@ -47748,7 +47990,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: &283 + schema: &284 type: string enum: - desc @@ -47757,7 +47999,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -47826,7 +48068,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: &284 + items: &285 type: object properties: object_url: @@ -47943,10 +48185,10 @@ paths: content: *180 '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47999,11 +48241,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *283 + schema: *284 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -48103,8 +48345,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true committer: nullable: true @@ -48137,7 +48379,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *284 + items: *285 required: - sha - node_id @@ -48270,7 +48512,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48348,11 +48590,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *283 + schema: *284 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -48416,8 +48658,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true user: @@ -48426,8 +48668,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true labels: type: array @@ -48457,8 +48699,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true milestone: nullable: true @@ -48466,8 +48708,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 comments: type: integer created_at: @@ -48483,7 +48725,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *284 + items: *285 pull_request: type: object properties: @@ -48521,15 +48763,15 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 draft: type: boolean repository: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 body_html: type: string body_text: @@ -48547,8 +48789,8 @@ paths: They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true required: - assignee @@ -48669,12 +48911,12 @@ paths: content: *180 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48731,7 +48973,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *283 + schema: *284 responses: '200': description: response @@ -48776,7 +49018,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *284 + items: *285 required: - id - node_id @@ -48812,13 +49054,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48879,11 +49121,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *283 + schema: *284 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -48925,8 +49167,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true private: type: boolean @@ -49102,8 +49344,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *70 - required: *71 + properties: *71 + required: *72 permissions: type: object properties: @@ -49120,7 +49362,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *284 + items: *285 temp_clone_token: type: string allow_merge_commit: @@ -49317,7 +49559,7 @@ paths: content: *180 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified x-github: @@ -49424,7 +49666,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *284 + items: *285 related: type: array nullable: true @@ -49569,7 +49811,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49632,11 +49874,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *283 + schema: *284 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -49744,7 +49986,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *284 + items: *285 blog: type: string nullable: true @@ -49807,7 +50049,7 @@ paths: content: *180 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49916,7 +50158,7 @@ paths: application/json: schema: type: object - properties: &285 + properties: &286 status: type: string scheduled_time: @@ -49935,7 +50177,7 @@ paths: - number examples: default: - value: &286 + value: &287 status: scheduled scheduled_time: Tuesday, January 22 at 15:34 -0800 connection_services: @@ -49970,10 +50212,10 @@ paths: application/json: schema: type: object - properties: *285 + properties: *286 examples: default: - value: *286 + value: *287 requestBody: content: application/json: @@ -50483,14 +50725,14 @@ paths: type: array items: type: object - properties: &287 + properties: &288 key: type: string pretty-print: type: string examples: default: - value: &288 + value: &289 - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64 - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... @@ -50519,7 +50761,7 @@ paths: type: array items: type: object - properties: *287 + properties: *288 examples: default: value: @@ -50564,10 +50806,10 @@ paths: type: array items: type: object - properties: *287 + properties: *288 examples: default: - value: *288 + value: *289 requestBody: content: application/json: @@ -50854,15 +51096,15 @@ paths: description: A team discussion is a persistent record of a free-form conversation within a team. type: object - properties: &289 + properties: &290 author: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: description: The main text of the discussion. @@ -50933,9 +51175,9 @@ paths: reactions: title: Reaction Rollup type: object - properties: *68 - required: *69 - required: &290 + properties: *69 + required: *70 + required: &291 - author - body - body_html @@ -51050,11 +51292,11 @@ paths: description: A team discussion is a persistent record of a free-form conversation within a team. type: object - properties: *289 - required: *290 + properties: *290 + required: *291 examples: default: - value: &291 + value: &292 author: login: octocat id: 1 @@ -51162,7 +51404,7 @@ paths: - name: discussion_number in: path required: true - schema: &292 + schema: &293 type: integer responses: '200': @@ -51174,11 +51416,11 @@ paths: description: A team discussion is a persistent record of a free-form conversation within a team. type: object - properties: *289 - required: *290 + properties: *290 + required: *291 examples: default: - value: *291 + value: *292 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51213,7 +51455,7 @@ paths: - name: discussion_number in: path required: true - schema: *292 + schema: *293 responses: '200': description: response @@ -51224,8 +51466,8 @@ paths: description: A team discussion is a persistent record of a free-form conversation within a team. type: object - properties: *289 - required: *290 + properties: *290 + required: *291 examples: default: value: @@ -51323,7 +51565,7 @@ paths: - name: discussion_number in: path required: true - schema: *292 + schema: *293 responses: '204': description: Empty response @@ -51352,7 +51594,7 @@ paths: - name: discussion_number in: path required: true - schema: *292 + schema: *293 - name: direction description: Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or @@ -51384,15 +51626,15 @@ paths: title: Team Discussion Comment description: A reply to a discussion within a team. type: object - properties: &293 + properties: &294 author: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: description: The main text of the comment. @@ -51442,9 +51684,9 @@ paths: reactions: title: Reaction Rollup type: object - properties: *68 - required: *69 - required: &294 + properties: *69 + required: *70 + required: &295 - author - body - body_html @@ -51541,7 +51783,7 @@ paths: - name: discussion_number in: path required: true - schema: *292 + schema: *293 responses: '201': description: response @@ -51551,11 +51793,11 @@ paths: title: Team Discussion Comment description: A reply to a discussion within a team. type: object - properties: *293 - required: *294 + properties: *294 + required: *295 examples: default: - value: &295 + value: &296 author: login: octocat id: 1 @@ -51645,11 +51887,11 @@ paths: - name: discussion_number in: path required: true - schema: *292 + schema: *293 - name: comment_number in: path required: true - schema: &296 + schema: &297 type: integer responses: '200': @@ -51660,11 +51902,11 @@ paths: title: Team Discussion Comment description: A reply to a discussion within a team. type: object - properties: *293 - required: *294 + properties: *294 + required: *295 examples: default: - value: *295 + value: *296 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51698,11 +51940,11 @@ paths: - name: discussion_number in: path required: true - schema: *292 + schema: *293 - name: comment_number in: path required: true - schema: *296 + schema: *297 responses: '200': description: response @@ -51712,8 +51954,8 @@ paths: title: Team Discussion Comment description: A reply to a discussion within a team. type: object - properties: *293 - required: *294 + properties: *294 + required: *295 examples: default: value: @@ -51804,11 +52046,11 @@ paths: - name: discussion_number in: path required: true - schema: *292 + schema: *293 - name: comment_number in: path required: true - schema: *296 + schema: *297 responses: '204': description: Empty response @@ -51844,11 +52086,11 @@ paths: - name: discussion_number in: path required: true - schema: *292 + schema: *293 - name: comment_number in: path required: true - schema: *296 + schema: *297 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.20/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment. @@ -51936,11 +52178,11 @@ paths: - name: discussion_number in: path required: true - schema: *292 + schema: *293 - name: comment_number in: path required: true - schema: *296 + schema: *297 responses: '201': description: response @@ -52019,7 +52261,7 @@ paths: - name: discussion_number in: path required: true - schema: *292 + schema: *293 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.20/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion. @@ -52107,7 +52349,7 @@ paths: - name: discussion_number in: path required: true - schema: *292 + schema: *293 responses: '201': description: response @@ -52210,8 +52452,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -52343,7 +52585,7 @@ paths: resource: TeamMember '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52427,7 +52669,7 @@ paths: title: Team Membership description: Team Membership type: object - properties: &297 + properties: &298 url: type: string format: uri @@ -52441,7 +52683,7 @@ paths: type: string state: type: string - required: &298 + required: &299 - role - state - url @@ -52502,8 +52744,8 @@ paths: title: Team Membership description: Team Membership type: object - properties: *297 - required: *298 + properties: *298 + required: *299 examples: response-if-users-membership-with-team-is-now-active: summary: Response if user's membership with team is now active @@ -52641,7 +52883,7 @@ paths: title: Team Project description: A team's access to a project. type: object - properties: &299 + properties: &300 owner_url: type: string url: @@ -52667,8 +52909,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -52695,7 +52937,7 @@ paths: - read - write - admin - required: &300 + required: &301 - owner_url - url - html_url @@ -52803,8 +53045,8 @@ paths: title: Team Project description: A team's access to a project. type: object - properties: *299 - required: *300 + properties: *300 + required: *301 examples: default: value: @@ -53011,7 +53253,7 @@ paths: required: *107 examples: default: - value: *301 + value: *302 headers: Link: example: ; rel="next", ; @@ -53654,7 +53896,7 @@ paths: - title: Private User description: Private User type: object - properties: &302 + properties: &303 login: type: string example: octocat @@ -53807,7 +54049,7 @@ paths: type: boolean ldap_dn: type: string - required: &303 + required: &304 - avatar_url - events_url - followers_url @@ -53848,7 +54090,7 @@ paths: - title: Public User description: Public User type: object - properties: &318 + properties: &319 login: type: string id: @@ -53965,7 +54207,7 @@ paths: collaborators: type: integer example: 3 - required: &319 + required: &320 - avatar_url - events_url - followers_url @@ -54082,10 +54324,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54151,8 +54393,8 @@ paths: title: Private User description: Private User type: object - properties: *302 - required: *303 + properties: *303 + required: *304 examples: default: value: @@ -54202,16 +54444,16 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54233,7 +54475,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -54249,7 +54491,7 @@ paths: title: Email description: Email type: object - properties: &304 + properties: &305 email: type: string format: email @@ -54264,14 +54506,14 @@ paths: type: string example: public nullable: true - required: &305 + required: &306 - email - primary - verified - visibility examples: default: - value: &315 + value: &316 - email: octocat@github.com verified: true primary: true @@ -54285,13 +54527,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54350,8 +54592,8 @@ paths: title: Email description: Email type: object - properties: *304 - required: *305 + properties: *305 + required: *306 examples: default: value: @@ -54369,18 +54611,18 @@ paths: visibility: '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54435,16 +54677,16 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54465,7 +54707,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -54481,8 +54723,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -54496,10 +54738,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54520,7 +54762,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -54536,8 +54778,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -54551,10 +54793,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54588,15 +54830,15 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54627,13 +54869,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54662,13 +54904,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54690,7 +54932,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -54706,7 +54948,7 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: &306 + properties: &307 id: type: integer example: 3 @@ -54800,7 +55042,7 @@ paths: raw_key: type: string nullable: true - required: &307 + required: &308 - id - primary_key_id - key_id @@ -54816,7 +55058,7 @@ paths: - subkeys examples: default: - value: &320 + value: &321 - id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -54853,13 +55095,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54898,11 +55140,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *306 - required: *307 + properties: *307 + required: *308 examples: default: - value: &308 + value: &309 id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -54934,18 +55176,18 @@ paths: PGP PUBLIC KEY BLOCK-----"' '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54968,7 +55210,7 @@ paths: description: gpg_key_id parameter in: path required: true - schema: &309 + schema: &310 type: integer responses: '200': @@ -54979,22 +55221,22 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *306 - required: *307 + properties: *307 + required: *308 examples: default: - value: *308 + value: *309 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55017,24 +55259,24 @@ paths: description: gpg_key_id parameter in: path required: true - schema: *309 + schema: *310 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55069,7 +55311,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -55094,8 +55336,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: @@ -55186,13 +55428,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55234,11 +55476,11 @@ paths: description: installation_id parameter in: path required: true - schema: *24 + schema: *25 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -55265,8 +55507,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: value: @@ -55384,10 +55626,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '304': description: Not Modified x-github: @@ -55427,23 +55669,23 @@ paths: description: installation_id parameter in: path required: true - schema: *24 + schema: *25 - name: repository_id in: path required: true - schema: &310 + schema: &311 type: integer responses: '204': description: Empty response '403': description: Forbidden - content: *30 + content: *31 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55473,22 +55715,22 @@ paths: description: installation_id parameter in: path required: true - schema: *24 + schema: *25 - name: repository_id in: path required: true - schema: *310 + schema: *311 responses: '204': description: Empty response '403': description: Forbidden - content: *30 + content: *31 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55533,6 +55775,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -55551,7 +55794,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *93 + schema: *94 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -55568,18 +55811,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *94 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -55608,7 +55851,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified x-github: @@ -55640,7 +55883,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -55656,7 +55899,7 @@ paths: title: Key description: Key type: object - properties: &311 + properties: &312 key_id: type: string key: @@ -55674,7 +55917,7 @@ paths: type: boolean read_only: type: boolean - required: &312 + required: &313 - key_id - key - id @@ -55711,13 +55954,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55761,11 +56004,11 @@ paths: title: Key description: Key type: object - properties: *311 - required: *312 + properties: *312 + required: *313 examples: default: - value: &313 + value: &314 key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -55776,18 +56019,18 @@ paths: read_only: false '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55821,22 +56064,22 @@ paths: title: Key description: Key type: object - properties: *311 - required: *312 + properties: *312 + required: *313 examples: default: - value: *313 + value: *314 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55867,13 +56110,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55905,7 +56148,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -56007,13 +56250,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56034,7 +56277,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 responses: '200': description: response @@ -56087,10 +56330,10 @@ paths: site_admin: false '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56110,7 +56353,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 requestBody: content: application/json: @@ -56179,13 +56422,13 @@ paths: site_admin: false '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56211,7 +56454,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -56227,11 +56470,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *81 - required: *82 + properties: *82 + required: *83 examples: default: - value: *314 + value: *315 headers: Link: example: ; rel="next", ; @@ -56241,10 +56484,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56329,13 +56572,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed content: *103 @@ -56368,7 +56611,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -56384,11 +56627,11 @@ paths: title: Email description: Email type: object - properties: *304 - required: *305 + properties: *305 + required: *306 examples: default: - value: *315 + value: *316 headers: Link: example: ; rel="next", ; @@ -56398,13 +56641,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56490,7 +56733,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -56501,7 +56744,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -56520,12 +56763,12 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: summary: Default response - value: &317 + value: &318 - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World @@ -56633,15 +56876,15 @@ paths: anonymous_access_enabled: false '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56763,8 +57006,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: value: *188 @@ -56775,18 +57018,18 @@ paths: type: string '401': description: Requires Authentication - content: *31 + content: *32 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 '400': description: Bad Request content: *187 @@ -56828,7 +57071,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -56849,7 +57092,7 @@ paths: required: *206 examples: default: - value: *316 + value: *317 headers: Link: example: ; rel="next", ; @@ -56859,13 +57102,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56893,13 +57136,13 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '409': description: Conflict content: *168 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified x-github: @@ -56933,10 +57176,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56962,16 +57205,16 @@ paths: (when it was last pushed to). in: query required: false - schema: *248 + schema: *255 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *94 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -56987,12 +57230,12 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default-response: summary: Default response - value: *317 + value: *318 application/vnd.github.v3.star+json: schema: type: array @@ -57000,7 +57243,7 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: &321 + properties: &322 starred_at: type: string format: date-time @@ -57008,15 +57251,15 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 - required: &322 + properties: *50 + required: *51 + required: &323 - starred_at - repo examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: &323 + value: &324 - starred_at: '2011-01-16T19:06:43Z' repo: id: 1296269 @@ -57133,10 +57376,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57173,15 +57416,15 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '401': description: Requires Authentication - content: *31 + content: *32 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57212,13 +57455,13 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '401': description: Requires Authentication - content: *31 + content: *32 '304': description: Not Modified x-github: @@ -57250,15 +57493,15 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '401': description: Requires Authentication - content: *31 + content: *32 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57279,7 +57522,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57299,7 +57542,7 @@ paths: required: *107 examples: default: - value: *301 + value: *302 headers: Link: example: ; rel="next", ; @@ -57309,10 +57552,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57336,7 +57579,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57411,10 +57654,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57444,7 +57687,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 responses: '200': description: response @@ -57456,8 +57699,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -57507,13 +57750,13 @@ paths: - title: Private User description: Private User type: object - properties: *302 - required: *303 + properties: *303 + required: *304 - title: Public User description: Public User type: object - properties: *318 - required: *319 + properties: *319 + required: *320 additionalProperties: false examples: default-response: @@ -57593,7 +57836,7 @@ paths: private_repos: 9999 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57619,7 +57862,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57635,8 +57878,8 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57662,11 +57905,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57682,8 +57925,8 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57708,7 +57951,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57724,8 +57967,8 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57750,7 +57993,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57766,8 +58009,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -57801,7 +58044,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57817,8 +58060,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -57886,11 +58129,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57906,11 +58149,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *55 - required: *56 + properties: *56 + required: *57 examples: default: - value: *57 + value: *58 headers: Link: example: ; rel="next", ; @@ -57918,7 +58161,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57944,7 +58187,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57960,11 +58203,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *306 - required: *307 + properties: *307 + required: *308 examples: default: - value: *320 + value: *321 headers: Link: example: ; rel="next", ; @@ -58051,10 +58294,10 @@ paths: octicon: repo '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58095,8 +58338,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: *204 @@ -58130,7 +58373,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58191,7 +58434,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58207,11 +58450,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *81 - required: *82 + properties: *82 + required: *83 examples: default: - value: *314 + value: *315 headers: Link: example: ; rel="next", ; @@ -58253,7 +58496,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58313,10 +58556,10 @@ paths: schema: *6 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58350,7 +58593,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58366,8 +58609,8 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58392,7 +58635,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58408,8 +58651,8 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58468,7 +58711,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58488,7 +58731,7 @@ paths: required: *107 examples: default: - value: *301 + value: *302 headers: Link: example: ; rel="next", ; @@ -58580,16 +58823,16 @@ paths: (when it was last pushed to). in: query required: false - schema: *248 + schema: *255 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *94 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58605,12 +58848,12 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default-response: summary: Default response - value: *317 + value: *318 application/vnd.github.v3.star+json: schema: type: array @@ -58618,12 +58861,12 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: *321 - required: *322 + properties: *322 + required: *323 examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: *323 + value: *324 headers: Link: example: ; rel="next", ; @@ -58653,7 +58896,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58673,7 +58916,7 @@ paths: required: *107 examples: default: - value: *301 + value: *302 headers: Link: example: ; rel="next", ; diff --git a/descriptions/ghes-2.20/ghes-2.20.json b/descriptions/ghes-2.20/ghes-2.20.json index 0012199126..0e3bbf9057 100644 --- a/descriptions/ghes-2.20/ghes-2.20.json +++ b/descriptions/ghes-2.20/ghes-2.20.json @@ -824,6 +824,32 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1280,6 +1306,23 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -1790,6 +1833,24 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -2898,6 +2959,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -3552,6 +3622,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -6142,6 +6221,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -6296,6 +6376,9 @@ }, { "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -8031,6 +8114,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -8718,6 +8802,24 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -16256,6 +16358,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -16630,9 +16752,15 @@ { "$ref": "#/components/parameters/repo" }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -16699,7 +16827,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -16732,6 +16860,14 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -16807,7 +16943,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -16908,13 +17044,19 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -16969,7 +17111,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -17114,7 +17256,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -17215,7 +17357,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -17395,7 +17537,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -17643,7 +17785,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -18334,7 +18477,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -18344,6 +18488,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -18401,6 +18565,26 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -18408,6 +18592,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -18838,7 +19023,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -18910,7 +19095,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -19061,7 +19246,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -19147,7 +19332,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -19521,7 +19706,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -24545,6 +24731,23 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -25224,7 +25427,17 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/sort" + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "created_at" + ] + } }, { "name": "direction", @@ -27515,6 +27728,79 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content-file" + }, + "examples": { + "default": { + "$ref": "#/components/examples/content-file" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -27928,7 +28214,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -29150,6 +29436,12 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" } ], "responses": { @@ -34314,6 +34606,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -37374,6 +37667,20 @@ "type": "integer" } }, + "direction": { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, "key-ids": { "name": "key_ids", "in": "path", @@ -37527,20 +37834,6 @@ "type": "string" } }, - "direction": { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, "owner": { "name": "owner", "in": "path", diff --git a/descriptions/ghes-2.20/ghes-2.20.yaml b/descriptions/ghes-2.20/ghes-2.20.yaml index 4cde35a95b..2575563b90 100644 --- a/descriptions/ghes-2.20/ghes-2.20.yaml +++ b/descriptions/ghes-2.20/ghes-2.20.yaml @@ -600,6 +600,23 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string responses: '200': description: response @@ -897,6 +914,17 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1287,6 +1315,19 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: One of `created` (when the repository was starred) or `updated` + (when it was last pushed to) or `name`. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -2092,6 +2133,12 @@ paths: parameters: - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -2561,6 +2608,12 @@ paths: parameters: - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -4368,6 +4421,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -4470,6 +4524,7 @@ paths: schema: type: boolean - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -5697,6 +5752,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -6169,6 +6225,18 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: The sort order for the response collection. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -11769,6 +11837,20 @@ paths: type: string - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -12061,8 +12143,10 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -12107,7 +12191,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -12128,6 +12212,11 @@ paths: default: latest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -12181,7 +12270,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -12256,12 +12345,14 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -12297,7 +12388,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -12455,7 +12546,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -12516,7 +12607,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -12652,7 +12743,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -12820,6 +12911,7 @@ paths: schema: type: string default: none + nullable: true - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" responses: @@ -13421,9 +13513,24 @@ paths: - newest - oldest - stargazers + - watchers default: newest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -13462,11 +13569,26 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -13845,7 +13967,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -13891,7 +14013,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -13990,7 +14112,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -14047,7 +14169,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -14376,6 +14498,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -17754,6 +17877,17 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -18269,7 +18403,15 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/sort" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -19919,6 +20061,56 @@ paths: previews: [] category: repos subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository-readme + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/content-file" + examples: + default: + "$ref": "#/components/examples/content-file" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents "/repos/{owner}/{repo}/releases": get: summary: List releases @@ -20198,7 +20390,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -21022,6 +21214,8 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" responses: '200': description: response @@ -24830,6 +25024,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -26893,6 +27088,17 @@ components: required: true schema: type: integer + direction: + name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc key-ids: name: key_ids in: path @@ -27012,17 +27218,6 @@ components: required: false schema: type: string - direction: - name: direction - description: One of `asc` (ascending) or `desc` (descending). - in: query - required: false - schema: - type: string - enum: - - asc - - desc - default: desc owner: name: owner in: path diff --git a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json index 8aaab6d84b..a6998a1b0d 100644 --- a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json +++ b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.json @@ -1140,6 +1140,43 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1895,6 +1932,34 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -2742,6 +2807,35 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -8935,6 +9029,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -13444,6 +13547,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -31030,6 +31142,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -33716,6 +33829,15 @@ "type": "integer", "default": 30 } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -47357,6 +47479,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -51804,6 +51927,35 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -58520,6 +58672,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { @@ -110569,6 +110730,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -116268,9 +116449,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -117015,7 +117214,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -117077,6 +117276,14 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -118068,7 +118275,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -120350,13 +120557,31 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -122118,7 +122343,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -124353,7 +124578,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -125068,7 +125293,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -125760,7 +125985,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -126483,7 +126708,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -133444,7 +133670,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -133466,6 +133693,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -135187,6 +135434,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -135194,6 +135461,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -137672,7 +137940,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -137834,7 +138102,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -138194,7 +138462,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -138409,7 +138677,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -139425,7 +139693,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -181907,6 +182176,34 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -190372,16 +190669,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -210589,6 +210885,279 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -213076,7 +213645,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -217893,6 +218462,24 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -249642,6 +250229,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" diff --git a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml index c99c2121b6..82c1ed803e 100644 --- a/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml +++ b/descriptions/ghes-2.21/dereferenced/ghes-2.21.deref.yaml @@ -742,6 +742,32 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: &9 + type: string + enum: + - asc + - desc + default: desc + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string responses: '200': description: response @@ -1093,7 +1119,7 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: &81 + properties: &82 login: type: string example: github @@ -1134,7 +1160,7 @@ paths: type: string example: A great organization nullable: true - required: &82 + required: &83 - login - url - id @@ -1204,7 +1230,7 @@ paths: - name: org in: path required: true - schema: &83 + schema: &84 type: string responses: '202': @@ -1260,6 +1286,21 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1269,7 +1310,7 @@ paths: type: array items: type: object - properties: &9 + properties: &10 id: type: integer name: @@ -1360,7 +1401,7 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default: value: @@ -1425,7 +1466,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: &10 + schema: &11 type: integer responses: '200': @@ -1434,7 +1475,7 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default: value: @@ -1481,7 +1522,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *10 + schema: *11 responses: '200': description: response @@ -1489,7 +1530,7 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default-response: value: @@ -1582,7 +1623,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *10 + schema: *11 responses: '204': description: Empty response @@ -1652,7 +1693,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *10 + schema: *11 responses: '202': description: response @@ -1660,7 +1701,7 @@ paths: application/json: schema: type: object - properties: &11 + properties: &12 url: type: string state: @@ -1739,7 +1780,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *10 + schema: *11 responses: '200': description: response @@ -1747,7 +1788,7 @@ paths: application/json: schema: type: object - properties: *11 + properties: *12 examples: default: value: @@ -1790,6 +1831,23 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + description: One of `created` (when the repository was starred) or `updated` + (when it was last pushed to) or `name`. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1799,7 +1857,7 @@ paths: type: array items: type: object - properties: &12 + properties: &13 id: type: integer name: @@ -1912,10 +1970,10 @@ paths: application/json: schema: type: object - properties: *12 + properties: *13 examples: default: - value: &13 + value: &14 id: 1 name: Check Commits enforcement: disabled @@ -2013,7 +2071,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: &14 + schema: &15 type: integer responses: '200': @@ -2022,10 +2080,10 @@ paths: application/json: schema: type: object - properties: *12 + properties: *13 examples: default: - value: *13 + value: *14 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -2055,7 +2113,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -2063,7 +2121,7 @@ paths: application/json: schema: type: object - properties: *12 + properties: *13 examples: default: value: @@ -2154,7 +2212,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '204': description: Empty response @@ -2205,7 +2263,7 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: &17 + properties: &18 id: type: integer url: @@ -2261,7 +2319,7 @@ paths: - title: Simple User description: Simple User type: object - properties: &15 + properties: &16 login: type: string example: octocat @@ -2327,7 +2385,7 @@ paths: starred_at: type: string example: '"2020-07-09T00:17:55Z"' - required: &16 + required: &17 - avatar_url - events_url - followers_url @@ -2358,7 +2416,7 @@ paths: type: object description: The permissions granted to the user-to-server access token. - properties: &25 + properties: &26 actions: type: string description: 'The level of permission to grant the @@ -2607,7 +2665,7 @@ paths: enum: - read - write - example: &26 + example: &27 contents: read issues: read deployments: write @@ -2641,8 +2699,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true required: - permissions @@ -2650,7 +2708,7 @@ paths: - single_file_name - repositories_url - account - required: &18 + required: &19 - app - id - note @@ -2665,7 +2723,7 @@ paths: - updated_at examples: default: - value: &40 + value: &41 - id: 2 url: https://enterprise.octocat.com/api/v3/authorizations/2 app: @@ -2757,8 +2815,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -2907,11 +2965,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: &41 + value: &42 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -2995,7 +3053,7 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: &19 + properties: &20 id: description: Unique identifier of the GitHub app example: 37 @@ -3013,8 +3071,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true name: description: The name of the GitHub app @@ -3085,7 +3143,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &20 + required: &21 - id - node_id - owner @@ -3100,7 +3158,7 @@ paths: additionalProperties: true examples: default: - value: &39 + value: &40 id: 1 slug: octoapp node_id: MDExOkludGVncmF0aW9uMQ== @@ -3181,8 +3239,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true - type: object properties: @@ -3272,13 +3330,13 @@ paths: -----END RSA PRIVATE KEY----- '404': description: Resource Not Found - content: &23 + content: &24 application/json: schema: title: Basic Error description: Basic Error type: object - properties: &27 + properties: &28 message: type: string documentation_url: @@ -3291,10 +3349,10 @@ paths: title: Validation Error Simple description: Validation Error Simple type: object - required: &88 + required: &89 - message - documentation_url - properties: &89 + properties: &90 message: type: string documentation_url: @@ -3333,7 +3391,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: &29 + schema: &30 type: integer default: 30 - name: page @@ -3352,7 +3410,7 @@ paths: title: Installation description: Installation type: object - properties: &21 + properties: &22 id: description: The ID of the installation. type: integer @@ -3363,8 +3421,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true - title: Enterprise description: An enterprise account @@ -3496,8 +3554,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true suspended_at: type: string @@ -3507,7 +3565,7 @@ paths: type: string example: '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' nullable: true - required: &22 + required: &23 - id - app_id - app_slug @@ -3605,7 +3663,7 @@ paths: description: installation_id parameter in: path required: true - schema: &24 + schema: &25 type: integer responses: '200': @@ -3616,8 +3674,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: @@ -3661,10 +3719,10 @@ paths: app_slug: github-actions '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: &28 + content: &29 application/json: schema: type: object @@ -3710,13 +3768,13 @@ paths: description: installation_id parameter in: path required: true - schema: *24 + schema: *25 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -3753,7 +3811,7 @@ paths: description: installation_id parameter in: path required: true - schema: *24 + schema: *25 requestBody: content: application/json: @@ -3780,8 +3838,8 @@ paths: type: object description: The permissions granted to the user-to-server access token. - properties: *25 - example: *26 + properties: *26 + example: *27 responses: '201': description: response @@ -3821,7 +3879,7 @@ paths: title: Repository description: A git repository type: object - properties: &49 + properties: &50 id: description: Unique identifier of the repository example: 42 @@ -3842,7 +3900,7 @@ paths: - title: License Simple description: License Simple type: object - properties: &70 + properties: &71 key: type: string example: mit @@ -3864,7 +3922,7 @@ paths: html_url: type: string format: uri - required: &71 + required: &72 - key - name - url @@ -3895,8 +3953,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true private: description: Whether the repository is private or public. @@ -4387,7 +4445,7 @@ paths: example: '"2020-07-09T00:17:42Z"' anonymous_access_enabled: type: boolean - required: &50 + required: &51 - archive_url - assignees_url - blobs_url @@ -4595,40 +4653,40 @@ paths: anonymous_access_enabled: false '403': description: Forbidden - content: &30 + content: &31 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '415': description: Preview Header Missing - content: *28 + content: *29 '401': description: Requires Authentication - content: &31 + content: &32 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: &35 + content: &36 application/json: schema: title: Validation Error description: Validation Error type: object - required: &86 + required: &87 - message - documentation_url - properties: &87 + properties: &88 message: type: string documentation_url: @@ -4688,11 +4746,17 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -4704,7 +4768,7 @@ paths: title: Application Grant description: The authorization associated with an OAuth Access. type: object - properties: &32 + properties: &33 id: type: integer example: 1 @@ -4746,10 +4810,10 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true - required: &33 + required: &34 - app - id - scopes @@ -4778,13 +4842,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4815,7 +4879,7 @@ paths: description: grant_id parameter in: path required: true - schema: &34 + schema: &35 type: integer responses: '200': @@ -4826,8 +4890,8 @@ paths: title: Application Grant description: The authorization associated with an OAuth Access. type: object - properties: *32 - required: *33 + properties: *33 + required: *34 examples: default: value: @@ -4845,10 +4909,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4875,7 +4939,7 @@ paths: description: grant_id parameter in: path required: true - schema: *34 + schema: *35 responses: '204': description: Empty response @@ -4883,10 +4947,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4913,7 +4977,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: &36 + schema: &37 type: string requestBody: content: @@ -4932,7 +4996,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4959,11 +5023,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 - name: access_token in: path required: true - schema: &38 + schema: &39 type: string responses: '204': @@ -4998,7 +5062,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 requestBody: content: application/json: @@ -5020,11 +5084,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: &37 + value: &38 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -5063,10 +5127,10 @@ paths: site_admin: false '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5093,7 +5157,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 requestBody: content: application/json: @@ -5115,14 +5179,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *37 + value: *38 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5146,7 +5210,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 requestBody: content: application/json: @@ -5166,7 +5230,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5191,11 +5255,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 - name: access_token in: path required: true - schema: *38 + schema: *39 responses: '200': description: response @@ -5208,14 +5272,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *37 + value: *38 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5242,11 +5306,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 - name: access_token in: path required: true - schema: *38 + schema: *39 responses: '200': description: response @@ -5257,11 +5321,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *37 + value: *38 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5288,11 +5352,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 - name: access_token in: path required: true - schema: *38 + schema: *39 responses: '204': description: Empty response @@ -5337,21 +5401,21 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true examples: default: - value: *39 + value: *40 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -5383,11 +5447,17 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -5400,11 +5470,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *40 + value: *41 headers: Link: example: ; rel="next", ; @@ -5414,13 +5484,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5496,11 +5566,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *41 + value: *42 headers: Location: example: https://api.github.com/authorizations/1 @@ -5508,24 +5578,24 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '410': description: Gone - content: &46 + content: &47 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5559,7 +5629,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 requestBody: content: application/json: @@ -5603,8 +5673,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: response-if-returning-an-existing-token: value: @@ -5645,11 +5715,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *41 + value: *42 headers: Location: example: https://api.github.com/authorizations/1 @@ -5657,15 +5727,15 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5697,7 +5767,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *36 + schema: *37 - name: fingerprint in: path required: true @@ -5742,8 +5812,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: response-if-returning-an-existing-token: value: @@ -5777,8 +5847,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: value: @@ -5805,7 +5875,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5836,7 +5906,7 @@ paths: description: authorization_id parameter in: path required: true - schema: &42 + schema: &43 type: integer responses: '200': @@ -5848,11 +5918,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: &43 + value: &44 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -5873,10 +5943,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5905,7 +5975,7 @@ paths: description: authorization_id parameter in: path required: true - schema: *42 + schema: *43 requestBody: content: application/json: @@ -5952,14 +6022,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *17 - required: *18 + properties: *18 + required: *19 examples: default: - value: *43 + value: *44 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5989,7 +6059,7 @@ paths: description: authorization_id parameter in: path required: true - schema: *42 + schema: *43 responses: '204': description: Empty response @@ -5997,10 +6067,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -6032,7 +6102,7 @@ paths: title: Code Of Conduct description: Code Of Conduct type: object - properties: &44 + properties: &45 key: type: string example: contributor_covenant @@ -6098,7 +6168,7 @@ paths: type: string format: uri nullable: true - required: &45 + required: &46 - url - html_url - key @@ -6118,7 +6188,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6159,8 +6229,8 @@ paths: title: Code Of Conduct description: Code Of Conduct type: object - properties: *44 - required: *45 + properties: *45 + required: *46 examples: default: value: @@ -6219,12 +6289,12 @@ paths: html_url: http://contributor-covenant.org/version/1/4/ '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6329,21 +6399,21 @@ paths: self.save() '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '415': description: Preview Header Missing - content: *28 + content: *29 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6638,7 +6708,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -6654,7 +6724,7 @@ paths: title: Event description: Event type: object - properties: &73 + properties: &74 id: type: string type: @@ -6664,7 +6734,7 @@ paths: title: Actor description: Actor type: object - properties: &47 + properties: &48 id: type: integer login: @@ -6680,7 +6750,7 @@ paths: avatar_url: type: string format: uri - required: &48 + required: &49 - id - login - gravatar_id @@ -6704,8 +6774,8 @@ paths: title: Actor description: Actor type: object - properties: *47 - required: *48 + properties: *48 + required: *49 payload: type: object properties: @@ -6763,8 +6833,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true labels: type: array @@ -6815,8 +6885,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assignees: type: array @@ -6824,8 +6894,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true milestone: @@ -6835,7 +6905,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &66 + properties: &67 url: type: string format: uri @@ -6880,8 +6950,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true open_issues: type: integer @@ -6907,7 +6977,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &67 + required: &68 - closed_issues - creator - description @@ -6979,7 +7049,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: &51 + enum: &52 - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER @@ -6999,8 +7069,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 performed_via_github_app: nullable: true allOf: @@ -7012,8 +7082,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true required: &225 - assignee @@ -7072,8 +7142,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -7091,7 +7161,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 performed_via_github_app: nullable: true allOf: @@ -7103,13 +7173,13 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true reactions: title: Reaction Rollup type: object - properties: &68 + properties: &69 url: type: string format: uri @@ -7131,7 +7201,7 @@ paths: type: integer rocket: type: integer - required: &69 + required: &70 - url - total_count - "+1" @@ -7178,7 +7248,7 @@ paths: type: string format: date-time nullable: true - required: &74 + required: &75 - id - type - actor @@ -7190,7 +7260,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '503': description: Service Unavailable content: &196 @@ -7274,58 +7344,58 @@ paths: title: Link With Type description: Hypermedia Link with Type type: object - properties: &52 + properties: &53 href: type: string type: type: string - required: &53 + required: &54 - href - type user: title: Link With Type description: Hypermedia Link with Type type: object - properties: *52 - required: *53 + properties: *53 + required: *54 security_advisories: title: Link With Type description: Hypermedia Link with Type type: object - properties: *52 - required: *53 + properties: *53 + required: *54 current_user: title: Link With Type description: Hypermedia Link with Type type: object - properties: *52 - required: *53 + properties: *53 + required: *54 current_user_public: title: Link With Type description: Hypermedia Link with Type type: object - properties: *52 - required: *53 + properties: *53 + required: *54 current_user_actor: title: Link With Type description: Hypermedia Link with Type type: object - properties: *52 - required: *53 + properties: *53 + required: *54 current_user_organization: title: Link With Type description: Hypermedia Link with Type type: object - properties: *52 - required: *53 + properties: *53 + required: *54 current_user_organizations: type: array items: title: Link With Type description: Hypermedia Link with Type type: object - properties: *52 - required: *53 + properties: *53 + required: *54 required: - timeline - user @@ -7390,12 +7460,12 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: &54 + schema: &55 type: string - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -7411,7 +7481,7 @@ paths: title: Base Gist description: Base Gist type: object - properties: &55 + properties: &56 url: type: string format: uri @@ -7468,8 +7538,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true comments_url: type: string @@ -7480,8 +7550,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true truncated: type: boolean @@ -7491,7 +7561,7 @@ paths: history: type: array items: {} - required: &56 + required: &57 - id - node_id - url @@ -7510,7 +7580,7 @@ paths: - updated_at examples: default: - value: &57 + value: &58 - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits @@ -7562,7 +7632,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7630,7 +7700,7 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: &58 + properties: &59 url: type: string forks_url: @@ -7687,14 +7757,14 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true truncated: type: boolean examples: default: - value: &59 + value: &60 url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits @@ -7715,15 +7785,15 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7750,11 +7820,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -7770,11 +7840,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *55 - required: *56 + properties: *56 + required: *57 examples: default: - value: *57 + value: *58 headers: Link: example: ; rel="next", ; @@ -7782,12 +7852,12 @@ paths: schema: *6 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7811,11 +7881,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -7831,11 +7901,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *55 - required: *56 + properties: *56 + required: *57 examples: default: - value: *57 + value: *58 headers: Link: example: ; rel="next", ; @@ -7843,12 +7913,12 @@ paths: schema: *6 '401': description: Requires Authentication - content: *31 + content: *32 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7870,7 +7940,7 @@ paths: description: gist_id parameter in: path required: true - schema: &60 + schema: &61 type: string responses: '200': @@ -7881,13 +7951,13 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *58 + properties: *59 examples: default: - value: *59 + value: *60 '403': description: Forbidden Gist - content: &64 + content: &65 application/json: schema: type: object @@ -7908,7 +7978,7 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified x-github: @@ -7933,7 +8003,7 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 requestBody: content: application/json: @@ -7984,16 +8054,16 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *58 + properties: *59 examples: default: - value: *59 + value: *60 '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8014,18 +8084,18 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8047,11 +8117,11 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -8067,7 +8137,7 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: &61 + properties: &62 id: type: integer example: 1 @@ -8089,8 +8159,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -8105,8 +8175,8 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 - required: &62 + enum: *52 + required: &63 - url - id - node_id @@ -8153,10 +8223,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8177,7 +8247,7 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 requestBody: content: application/json: @@ -8200,11 +8270,11 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *61 - required: *62 + properties: *62 + required: *63 examples: default: - value: &63 + value: &64 id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== url: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 @@ -8240,10 +8310,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8265,12 +8335,12 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 - name: comment_id description: comment_id parameter in: path required: true - schema: &65 + schema: &66 type: integer responses: '200': @@ -8281,19 +8351,19 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *61 - required: *62 + properties: *62 + required: *63 examples: default: - value: *63 + value: *64 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden Gist - content: *64 + content: *65 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8314,12 +8384,12 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 - name: comment_id description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -8342,14 +8412,14 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *61 - required: *62 + properties: *62 + required: *63 examples: default: - value: *63 + value: *64 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8370,12 +8440,12 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 - name: comment_id description: comment_id parameter in: path required: true - schema: *65 + schema: *66 responses: '204': description: Empty response @@ -8383,10 +8453,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8408,11 +8478,11 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -8442,8 +8512,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true change_status: type: object @@ -8500,12 +8570,12 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8527,11 +8597,11 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -8547,7 +8617,7 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *58 + properties: *59 examples: default: value: @@ -8599,12 +8669,12 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8625,7 +8695,7 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 responses: '201': description: response @@ -8635,8 +8705,8 @@ paths: title: Base Gist description: Base Gist type: object - properties: *55 - required: *56 + properties: *56 + required: *57 examples: default: value: @@ -8689,15 +8759,15 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8719,7 +8789,7 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 responses: '204': description: Response if gist is starred @@ -8735,7 +8805,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8757,18 +8827,18 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8789,7 +8859,7 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 responses: '204': description: Empty response @@ -8797,10 +8867,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8822,7 +8892,7 @@ paths: description: gist_id parameter in: path required: true - schema: *60 + schema: *61 - name: sha in: path required: true @@ -8837,19 +8907,19 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *58 + properties: *59 examples: default: - value: *59 + value: *60 '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9001,7 +9071,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -9025,8 +9095,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 repository_selection: type: string example: selected @@ -9144,12 +9214,12 @@ paths: schema: *6 '403': description: Forbidden - content: *30 + content: *31 '304': description: Not Modified '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -9229,6 +9299,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -9247,7 +9318,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: &93 + schema: &94 type: string - name: sort description: What to sort results by. Can be either `created`, `updated`, @@ -9265,19 +9336,14 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: &94 - type: string - enum: - - asc - - desc - default: desc + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: collab in: query required: false @@ -9301,7 +9367,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -9367,8 +9433,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true labels: description: Labels to associate with this issue; pass one or @@ -9408,8 +9474,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assignees: type: array @@ -9417,8 +9483,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true milestone: @@ -9427,8 +9493,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 locked: type: boolean active_lock_reason: @@ -9480,8 +9546,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body_html: type: string @@ -9494,8 +9560,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 performed_via_github_app: nullable: true allOf: @@ -9506,20 +9572,20 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true author_association: title: author_association type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 reactions: title: Reaction Rollup type: object - properties: *68 - required: *69 + properties: *69 + required: *70 required: &96 - assignee - closed_at @@ -9782,12 +9848,12 @@ paths: schema: *6 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9820,7 +9886,11 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 responses: '200': description: response @@ -9832,8 +9902,8 @@ paths: title: License Simple description: License Simple type: object - properties: *70 - required: *71 + properties: *71 + required: *72 examples: default: value: @@ -10058,10 +10128,10 @@ paths: featured: true '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified x-github: @@ -10118,7 +10188,7 @@ paths: type: string X-CommonMarker-Version: example: 0.17.4 - schema: &72 + schema: &73 type: string content: text/html: @@ -10161,7 +10231,7 @@ paths: headers: X-CommonMarker-Version: example: 0.17.4 - schema: *72 + schema: *73 content: text/html: schema: @@ -10240,7 +10310,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -10256,14 +10326,14 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '304': description: Not Modified '301': @@ -10307,7 +10377,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -10319,7 +10389,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -10335,7 +10405,7 @@ paths: title: Thread description: Thread type: object - properties: &75 + properties: &76 id: type: string repository: @@ -10362,8 +10432,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true private: type: boolean @@ -10584,8 +10654,8 @@ paths: - title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 delete_branch_on_merge: type: boolean subscribers_count: @@ -10694,7 +10764,7 @@ paths: subscription_url: type: string example: https://api.github.com/notifications/threads/2/subscription - required: &76 + required: &77 - id - unread - reason @@ -10795,13 +10865,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10853,10 +10923,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10878,7 +10948,7 @@ paths: description: thread_id parameter in: path required: true - schema: &77 + schema: &78 type: integer responses: '200': @@ -10889,8 +10959,8 @@ paths: title: Thread description: Thread type: object - properties: *75 - required: *76 + properties: *76 + required: *77 examples: default: value: @@ -10977,10 +11047,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11001,7 +11071,7 @@ paths: description: thread_id parameter in: path required: true - schema: *77 + schema: *78 responses: '205': description: response @@ -11009,7 +11079,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11034,7 +11104,7 @@ paths: description: thread_id parameter in: path required: true - schema: *77 + schema: *78 responses: '200': description: response @@ -11044,7 +11114,7 @@ paths: title: Thread Subscription description: Thread Subscription type: object - properties: &78 + properties: &79 subscribed: type: boolean example: true @@ -11070,7 +11140,7 @@ paths: type: string format: uri example: https://api.github.com/repos/1 - required: &79 + required: &80 - created_at - ignored - reason @@ -11078,7 +11148,7 @@ paths: - subscribed examples: default: - value: &80 + value: &81 subscribed: true ignored: false reason: @@ -11089,10 +11159,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11118,7 +11188,7 @@ paths: description: thread_id parameter in: path required: true - schema: *77 + schema: *78 requestBody: content: application/json: @@ -11138,19 +11208,19 @@ paths: title: Thread Subscription description: Thread Subscription type: object - properties: *78 - required: *79 + properties: *79 + required: *80 examples: default: - value: *80 + value: *81 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11175,7 +11245,7 @@ paths: description: thread_id parameter in: path required: true - schema: *77 + schema: *78 responses: '204': description: Empty response @@ -11183,10 +11253,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11243,7 +11313,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 responses: '200': description: response @@ -11255,11 +11325,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *81 - required: *82 + properties: *82 + required: *83 examples: default: - value: &330 + value: &331 - login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= @@ -11302,7 +11372,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 responses: '200': description: response @@ -11312,7 +11382,7 @@ paths: title: Organization Full description: Organization Full type: object - properties: &84 + properties: &85 login: type: string example: github @@ -11468,7 +11538,7 @@ paths: updated_at: type: string format: date-time - required: &85 + required: &86 - login - url - id @@ -11582,7 +11652,7 @@ paths: seats: 5 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11614,7 +11684,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 requestBody: content: application/json: @@ -11744,8 +11814,8 @@ paths: title: Organization Full description: Organization Full type: object - properties: *84 - required: *85 + properties: *85 + required: *86 examples: default: value: @@ -11803,13 +11873,13 @@ paths: - title: Validation Error description: Validation Error type: object - required: *86 - properties: *87 + required: *87 + properties: *88 - title: Validation Error Simple description: Validation Error Simple type: object - required: *88 - properties: *89 + required: *89 + properties: *90 '409': description: Conflict content: &184 @@ -11818,10 +11888,10 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11851,11 +11921,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -11871,8 +11941,8 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11893,11 +11963,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -11913,7 +11983,7 @@ paths: title: Org Hook description: Org Hook type: object - properties: &90 + properties: &91 id: type: integer example: 1 @@ -11963,7 +12033,7 @@ paths: example: '2011-09-06T17:26:27Z' type: type: string - required: &91 + required: &92 - id - url - type @@ -11998,7 +12068,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12019,7 +12089,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 requestBody: content: application/json: @@ -12102,11 +12172,11 @@ paths: title: Org Hook description: Org Hook type: object - properties: *90 - required: *91 + properties: *91 + required: *92 examples: default: - value: &92 + value: &93 id: 1 url: https://api.github.com/orgs/octocat/hooks/1 ping_url: https://api.github.com/orgs/octocat/hooks/1/pings @@ -12128,10 +12198,10 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12153,7 +12223,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: hook_id in: path required: true @@ -12167,14 +12237,14 @@ paths: title: Org Hook description: Org Hook type: object - properties: *90 - required: *91 + properties: *91 + required: *92 examples: default: - value: *92 + value: *93 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12198,7 +12268,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: hook_id in: path required: true @@ -12271,8 +12341,8 @@ paths: title: Org Hook description: Org Hook type: object - properties: *90 - required: *91 + properties: *91 + required: *92 examples: default: value: @@ -12291,10 +12361,10 @@ paths: type: Organization '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12314,7 +12384,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: hook_id in: path required: true @@ -12324,7 +12394,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12346,7 +12416,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: hook_id in: path required: true @@ -12356,7 +12426,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12387,7 +12457,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 responses: '200': description: response @@ -12397,8 +12467,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: &220 @@ -12474,11 +12544,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -12502,8 +12572,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: @@ -12584,7 +12654,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: filter description: "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you @@ -12600,6 +12670,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -12618,7 +12689,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *93 + schema: *94 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -12635,18 +12706,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *94 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -12675,7 +12746,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12705,7 +12776,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: filter description: "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -12735,7 +12806,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -12751,8 +12822,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -12789,7 +12860,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12810,7 +12881,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -12849,7 +12920,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -12859,7 +12930,7 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12881,7 +12952,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -12914,16 +12985,16 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *81 - required: *82 + properties: *82 + required: *83 user: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true permissions: type: object @@ -13059,10 +13130,10 @@ paths: site_admin: false '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13094,7 +13165,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -13207,10 +13278,10 @@ paths: site_admin: false '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13233,7 +13304,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -13243,10 +13314,10 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13267,7 +13338,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: filter description: "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -13283,7 +13354,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -13299,8 +13370,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -13333,7 +13404,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -13367,7 +13438,7 @@ paths: documentation_url: https://docs.github.com/enterprise-server@2.21/rest/reference/orgs#convert-member-to-outside-collaborator '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13388,7 +13459,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -13436,7 +13507,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: per_page description: Results per page (max 100) in: query @@ -13445,6 +13516,22 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + description: The sort order for the response collection. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -13503,11 +13590,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -13554,11 +13641,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -13619,11 +13706,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -13668,7 +13755,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: state description: Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. @@ -13684,7 +13771,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -13747,8 +13834,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -13856,7 +13943,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 requestBody: content: application/json: @@ -13921,16 +14008,16 @@ paths: updated_at: '2014-03-04T18:58:10Z' '401': description: Requires Authentication - content: *31 + content: *32 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '422': description: Validation Failed content: *103 @@ -13962,11 +14049,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -13982,8 +14069,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -14013,7 +14100,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -14045,7 +14132,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -14055,7 +14142,7 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14075,7 +14162,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: username in: path required: true @@ -14103,7 +14190,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: type description: 'Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. @@ -14148,7 +14235,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -14327,7 +14414,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 requestBody: content: application/json: @@ -14448,8 +14535,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: value: &204 @@ -14574,10 +14661,10 @@ paths: type: string '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14616,11 +14703,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -14767,7 +14854,7 @@ paths: schema: *6 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14790,7 +14877,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 requestBody: content: application/json: @@ -14935,8 +15022,8 @@ paths: title: Organization Full description: Organization Full type: object - properties: *84 - required: *85 + properties: *85 + required: *86 ldap_dn: description: Distinguished Name (DN) that team maps to within LDAP environment @@ -15007,10 +15094,10 @@ paths: ldap_dn: uid=asdf,ou=users,dc=github,dc=com '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15034,7 +15121,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -15058,7 +15145,7 @@ paths: value: *112 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15081,7 +15168,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -15173,7 +15260,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -15205,7 +15292,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -15215,15 +15302,21 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *94 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: pinned + in: query + required: false + description: Pinned discussions only filter + schema: + type: string responses: '200': description: response @@ -15243,8 +15336,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: description: The main text of the discussion. @@ -15315,8 +15408,8 @@ paths: reactions: title: Reaction Rollup type: object - properties: *68 - required: *69 + properties: *69 + required: *70 required: &115 - author - body @@ -15337,7 +15430,7 @@ paths: - url examples: default: - value: &304 + value: &305 - author: login: octocat id: 1 @@ -15424,7 +15517,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -15551,7 +15644,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -15609,7 +15702,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -15647,7 +15740,7 @@ paths: required: *115 examples: default: - value: &305 + value: &306 author: login: octocat id: 1 @@ -15727,7 +15820,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -15763,7 +15856,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -15777,11 +15870,11 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *94 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -15804,8 +15897,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: description: The main text of the comment. @@ -15855,8 +15948,8 @@ paths: reactions: title: Reaction Rollup type: object - properties: *68 - required: *69 + properties: *69 + required: *70 required: &119 - author - body @@ -15872,7 +15965,7 @@ paths: - url examples: default: - value: &306 + value: &307 - author: login: octocat id: 1 @@ -15953,7 +16046,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -16065,7 +16158,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -16126,7 +16219,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -16166,7 +16259,7 @@ paths: required: *119 examples: default: - value: &307 + value: &308 author: login: octocat id: 1 @@ -16240,7 +16333,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -16280,7 +16373,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -16313,7 +16406,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -16343,8 +16436,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true content: description: The reaction to use @@ -16432,7 +16525,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -16540,7 +16633,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -16595,7 +16688,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -16624,7 +16717,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -16683,7 +16776,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -16764,7 +16857,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -16814,7 +16907,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -16836,7 +16929,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -16852,8 +16945,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -16890,7 +16983,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -16930,19 +17023,19 @@ paths: examples: response-if-user-has-an-active-membership-with-team: summary: Response if user has an active membership with team - value: &308 + value: &309 url: https://api.github.com/teams/1/memberships/octocat role: member state: active response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer - value: &309 + value: &310 url: https://api.github.com/teams/1/memberships/octocat role: maintainer state: active response-if-user-has-a-pending-membership-with-team: summary: Response if user has a pending membership with team - value: &310 + value: &311 url: https://api.github.com/teams/1/memberships/octocat role: member state: pending @@ -16978,7 +17071,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -17019,13 +17112,13 @@ paths: examples: response-if-users-membership-with-team-is-now-active: summary: Response if user's membership with team is now active - value: &311 + value: &312 url: https://api.github.com/teams/1/memberships/octocat role: member state: active response-if-users-membership-with-team-is-now-pending: summary: Response if user's membership with team is now pending - value: &312 + value: &313 url: https://api.github.com/teams/1/memberships/octocat role: member state: pending @@ -17085,7 +17178,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -17123,7 +17216,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -17132,7 +17225,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -17174,8 +17267,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -17219,7 +17312,7 @@ paths: - permissions examples: default: - value: &313 + value: &314 - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 html_url: https://github.com/orgs/api-playground/projects/1 @@ -17292,7 +17385,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -17316,7 +17409,7 @@ paths: required: *130 examples: default: - value: &314 + value: &315 owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 html_url: https://github.com/orgs/api-playground/projects/1 @@ -17385,7 +17478,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -17466,7 +17559,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -17502,7 +17595,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -17511,7 +17604,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -17564,7 +17657,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -17587,7 +17680,7 @@ paths: title: Team Repository description: A team's access to a repository. type: object - properties: &315 + properties: &316 id: description: Unique identifier of the repository example: 42 @@ -17608,8 +17701,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *70 - required: *71 + properties: *71 + required: *72 forks: type: integer permissions: @@ -17635,8 +17728,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true private: description: Whether the repository is private or public. @@ -17892,8 +17985,8 @@ paths: - title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 properties: anonymous_access_enabled: type: boolean @@ -17925,7 +18018,7 @@ paths: type: string anonymous_access_enabled: type: boolean - required: &316 + required: &317 - archive_url - assignees_url - blobs_url @@ -18260,7 +18353,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -18327,7 +18420,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -18367,7 +18460,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: team_slug description: team_slug parameter in: path @@ -18376,7 +18469,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -18397,7 +18490,7 @@ paths: required: *136 examples: response-if-child-teams-exist: - value: &317 + value: &318 - id: 2 node_id: MDQ6VGVhbTI= url: https://api.github.com/teams/2 @@ -18480,8 +18573,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -18553,13 +18646,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18621,13 +18714,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed content: *103 @@ -18681,10 +18774,10 @@ paths: type: string '401': description: Requires Authentication - content: *31 + content: *32 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18769,7 +18862,7 @@ paths: type: string '401': description: Requires Authentication - content: *31 + content: *32 '503': description: Service Unavailable content: @@ -18794,7 +18887,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18890,13 +18983,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18955,10 +19048,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18994,10 +19087,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19042,7 +19135,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -19101,10 +19194,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19182,10 +19275,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '422': description: Validation Failed content: @@ -19195,13 +19288,13 @@ paths: - title: Validation Error description: Validation Error type: object - required: *86 - properties: *87 + required: *87 + properties: *88 - title: Validation Error Simple description: Validation Error Simple type: object - required: *88 - properties: *89 + required: *89 + properties: *90 '503': description: Service Unavailable content: @@ -19279,13 +19372,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed content: *103 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19365,10 +19458,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19466,10 +19559,10 @@ paths: type: string '401': description: Requires Authentication - content: *31 + content: *32 '410': description: Gone - content: *46 + content: *47 '422': description: Validation Failed content: *103 @@ -19523,13 +19616,13 @@ paths: type: string '401': description: Requires Authentication - content: *31 + content: *32 '410': description: Gone - content: *46 + content: *47 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19581,7 +19674,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -19597,8 +19690,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -19610,21 +19703,21 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19678,21 +19771,21 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19732,19 +19825,19 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19798,8 +19891,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true required: &179 - permission @@ -19829,21 +19922,21 @@ paths: site_admin: false '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19875,7 +19968,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -19913,10 +20006,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19980,13 +20073,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed content: *103 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20123,7 +20216,7 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20155,16 +20248,16 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '410': description: Gone - content: *46 + content: *47 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20234,8 +20327,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true private: type: boolean @@ -20488,8 +20581,8 @@ paths: - title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 allow_squash_merge: type: boolean example: true @@ -20511,29 +20604,29 @@ paths: - title: License Simple description: License Simple type: object - properties: *70 - required: *71 + properties: *71 + required: *72 organization: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true parent: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 source: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 forks: type: integer master_branch: @@ -21617,10 +21710,10 @@ paths: anonymous_access_enabled: false '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '301': description: Moved Permanently x-github: @@ -22263,13 +22356,13 @@ paths: anonymous_access_enabled: false '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22336,7 +22429,7 @@ paths: documentation_url: https://docs.github.com/enterprise-server@2.21/rest/reference/repos#delete-a-repository '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22366,7 +22459,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -22382,8 +22475,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -22395,7 +22488,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22443,7 +22536,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22480,7 +22573,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -22570,8 +22663,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true teams: description: The list of teams with review dismissal @@ -22862,7 +22955,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23013,8 +23106,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true committer: nullable: true @@ -23022,8 +23115,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true parents: type: array @@ -23218,10 +23311,10 @@ paths: protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection '415': description: Preview Header Missing - content: *28 + content: *29 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23399,7 +23492,7 @@ paths: enabled: true '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23661,8 +23754,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true teams: type: array @@ -23740,16 +23833,16 @@ paths: - url '403': description: Forbidden - content: *30 + content: *31 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed content: *103 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23796,7 +23889,7 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23933,7 +24026,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24126,7 +24219,7 @@ paths: value: *161 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24173,7 +24266,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24228,7 +24321,7 @@ paths: enabled: true '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24285,7 +24378,7 @@ paths: value: *162 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24331,7 +24424,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24395,7 +24488,7 @@ paths: contexts_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24464,10 +24557,10 @@ paths: value: *165 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24553,7 +24646,7 @@ paths: - continuous-integration/travis-ci '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24618,13 +24711,13 @@ paths: - continuous-integration/jenkins '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24689,10 +24782,10 @@ paths: - continuous-integration/travis-ci '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24757,10 +24850,10 @@ paths: - continuous-integration/travis-ci '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24881,7 +24974,7 @@ paths: - pull_request '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24967,8 +25060,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true examples: default: @@ -25011,7 +25104,7 @@ paths: - pull_request '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25080,15 +25173,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true examples: default: value: *166 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25158,15 +25251,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true examples: default: value: *166 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25236,15 +25329,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true examples: default: value: *166 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25299,7 +25392,7 @@ paths: value: *167 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25372,7 +25465,7 @@ paths: value: *167 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25446,7 +25539,7 @@ paths: value: *167 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25520,7 +25613,7 @@ paths: value: *167 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25567,15 +25660,15 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: value: *100 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25640,15 +25733,15 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: value: *100 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25714,15 +25807,15 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: value: *100 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25788,15 +25881,15 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: value: *100 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26213,8 +26306,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true pull_requests: items: @@ -26349,8 +26442,8 @@ paths: They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true required: - id @@ -27000,7 +27093,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -27204,8 +27297,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true repository: title: Minimal Repository @@ -27672,8 +27765,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: value: @@ -27925,7 +28018,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -28134,7 +28227,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -28277,7 +28370,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28408,8 +28501,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true inviter: nullable: true @@ -28417,8 +28510,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true permissions: description: The permission associated with the invitation. @@ -28572,10 +28665,10 @@ paths: description: Response when person is already a collaborator '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: triggersNotification: true githubCloudOnly: false @@ -28674,7 +28767,7 @@ paths: site_admin: false '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28706,7 +28799,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -28752,8 +28845,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -28766,12 +28859,12 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 reactions: title: Reaction Rollup type: object - properties: *68 - required: *69 + properties: *69 + required: *70 required: &181 - url - html_url @@ -28864,7 +28957,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 responses: '200': description: response @@ -28912,7 +29005,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28951,7 +29044,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -29012,7 +29105,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29041,13 +29134,13 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29077,7 +29170,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.21/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. @@ -29097,7 +29190,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -29126,10 +29219,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29170,7 +29263,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -29225,10 +29318,10 @@ paths: value: *125 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29271,7 +29364,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 - name: reaction_id in: path required: true @@ -29367,7 +29460,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: until description: 'Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -29378,11 +29471,25 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -29478,7 +29585,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '400': description: Bad Request content: &203 @@ -29487,7 +29594,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 application/scim+json: schema: title: Scim Error @@ -29514,7 +29621,7 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '409': description: Conflict content: *184 @@ -29593,10 +29700,10 @@ paths: protected: false '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29639,7 +29746,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -29755,10 +29862,10 @@ paths: type: string '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 x-github: triggersNotification: true githubCloudOnly: false @@ -29800,7 +29907,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -29880,8 +29987,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: type: string @@ -29912,8 +30019,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 active_lock_reason: type: string example: too heated @@ -29946,8 +30053,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assignees: type: array @@ -29955,8 +30062,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true requested_reviewers: @@ -29965,8 +30072,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true requested_teams: @@ -29991,8 +30098,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 sha: type: string user: @@ -30001,8 +30108,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true required: - label @@ -30021,8 +30128,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 sha: type: string user: @@ -30031,8 +30138,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true required: - label @@ -30108,7 +30215,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 draft: description: Indicates whether or not the pull request is a draft. @@ -30607,7 +30714,7 @@ paths: schema: *6 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30676,8 +30783,16 @@ paths: in: path required: true schema: *134 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *30 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -30780,10 +30895,10 @@ paths: ..... '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 '500': description: Internal Error content: *190 @@ -30816,7 +30931,7 @@ paths: required: true schema: *134 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -30847,11 +30962,16 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -30917,7 +31037,7 @@ paths: required: true schema: *134 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -30938,7 +31058,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -31165,12 +31285,20 @@ paths: required: true schema: *134 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - name: per_page + description: Results per page (max 100). + in: query + schema: *30 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 responses: '200': description: response @@ -31352,7 +31480,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31382,7 +31510,7 @@ paths: required: true schema: *134 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -31391,7 +31519,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -31407,7 +31535,7 @@ paths: title: Status description: The status of a commit. type: object - properties: &291 + properties: &292 url: type: string avatar_url: @@ -31433,10 +31561,10 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true - required: &292 + required: &293 - url - avatar_url - id @@ -31928,7 +32056,7 @@ paths: content: *190 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31984,7 +32112,7 @@ paths: required: true schema: *134 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -32466,10 +32594,10 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '302': description: Found x-github: @@ -32497,7 +32625,7 @@ paths: required: true schema: *134 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -32786,10 +32914,10 @@ paths: payload: '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 '409': description: Conflict content: *184 @@ -32825,7 +32953,7 @@ paths: required: true schema: *134 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -32919,10 +33047,10 @@ paths: payload: '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 '409': description: Conflict content: *184 @@ -32966,7 +33094,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -33068,10 +33196,10 @@ paths: description: Response if repository is empty '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33126,10 +33254,11 @@ paths: schema: type: string default: none + nullable: true - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -33190,8 +33319,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true created_at: type: string @@ -33229,8 +33358,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true required: &198 - id @@ -33575,7 +33704,7 @@ paths: message: 'Conflict: Commit status checks failed for topic-branch.' '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33667,7 +33796,7 @@ paths: production_environment: true '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33727,7 +33856,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed content: *103 @@ -33764,7 +33893,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -33809,8 +33938,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true description: description: A short description of the status. @@ -33868,8 +33997,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true required: &201 - id @@ -33925,7 +34054,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34114,7 +34243,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34184,10 +34313,10 @@ paths: value: *202 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34275,7 +34404,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34304,7 +34433,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -34320,8 +34449,8 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34357,15 +34486,30 @@ paths: - newest - oldest - stargazers + - watchers default: newest - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -34526,11 +34670,26 @@ paths: in: path required: true schema: *134 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -34545,8 +34704,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: value: *204 @@ -34555,13 +34714,13 @@ paths: content: *203 '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34635,16 +34794,16 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '409': description: Conflict content: *184 '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34722,13 +34881,13 @@ paths: node_id: Q29udGVudCBvZiB0aGUgYmxvYg== '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35042,10 +35201,10 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35148,7 +35307,7 @@ paths: payload: '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35182,7 +35341,7 @@ paths: required: true schema: *134 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -35191,7 +35350,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -35289,7 +35448,7 @@ paths: required: true schema: *134 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -35318,7 +35477,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35390,7 +35549,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35417,7 +35576,7 @@ paths: required: true schema: *134 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -35459,7 +35618,7 @@ paths: value: *209 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35485,7 +35644,7 @@ paths: required: true schema: *134 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -35496,7 +35655,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35703,7 +35862,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35778,7 +35937,7 @@ paths: value: *214 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35964,13 +36123,13 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36004,6 +36163,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -36065,10 +36225,10 @@ paths: truncated: false '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36097,7 +36257,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -36265,7 +36425,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36407,13 +36567,13 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36460,7 +36620,7 @@ paths: value: *219 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36582,10 +36742,10 @@ paths: value: *219 '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36619,7 +36779,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36655,7 +36815,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36693,7 +36853,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36738,8 +36898,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: *220 @@ -36747,7 +36907,7 @@ paths: description: Moved Permanently '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -36782,7 +36942,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -36803,7 +36963,7 @@ paths: required: *222 examples: default: - value: &332 + value: &333 - id: 1 repository: id: 1296269 @@ -37202,7 +37362,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *93 + schema: *94 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -37219,18 +37379,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *94 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -37384,10 +37544,10 @@ paths: description: Moved Permanently '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37653,19 +37813,19 @@ paths: type: string '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 '503': description: Service Unavailable content: *196 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 x-github: triggersNotification: true githubCloudOnly: false @@ -37697,7 +37857,7 @@ paths: (when it was last pushed to). in: query required: false - schema: &263 + schema: &270 type: string enum: - created @@ -37718,11 +37878,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -37779,10 +37939,10 @@ paths: schema: *6 '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37822,7 +37982,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 responses: '200': description: response @@ -37868,7 +38028,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37905,7 +38065,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -37936,7 +38096,7 @@ paths: value: *228 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37965,7 +38125,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 responses: '204': description: Empty response @@ -37998,7 +38158,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.21/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. @@ -38018,7 +38178,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -38047,10 +38207,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38091,7 +38251,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -38146,10 +38306,10 @@ paths: value: *125 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38192,7 +38352,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 - name: reaction_id in: path required: true @@ -38238,7 +38398,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -38271,8 +38431,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true event: type: string @@ -38315,8 +38475,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assigner: nullable: true @@ -38324,8 +38484,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true review_requester: nullable: true @@ -38333,8 +38493,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true requested_reviewer: nullable: true @@ -38342,8 +38502,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true requested_team: title: Team @@ -38421,7 +38581,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 lock_reason: type: string nullable: true @@ -38595,7 +38755,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38809,13 +38969,13 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38901,10 +39061,10 @@ paths: description: Moved Permanently '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '304': description: Not Modified x-github: @@ -39039,21 +39199,21 @@ paths: value: *231 '422': description: Validation Failed - content: *35 + content: *36 '503': description: Service Unavailable content: *196 '403': description: Forbidden - content: *30 + content: *31 '301': description: Moved Permanently '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39372,11 +39532,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -39405,10 +39565,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39487,16 +39647,16 @@ paths: type: string '403': description: Forbidden - content: *30 + content: *31 '410': description: Gone - content: *46 + content: *47 '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: triggersNotification: true githubCloudOnly: false @@ -39531,7 +39691,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -39558,8 +39718,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true event: type: string @@ -39591,7 +39751,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 body: type: string example: '":+1:"' @@ -39651,7 +39811,7 @@ paths: schema: *6 '410': description: Gone - content: *46 + content: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39701,7 +39861,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -39744,7 +39904,7 @@ paths: schema: *6 '410': description: Gone - content: *46 + content: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39813,10 +39973,10 @@ paths: value: *237 '410': description: Gone - content: *46 + content: *47 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39884,10 +40044,10 @@ paths: value: *237 '410': description: Gone - content: *46 + content: *47 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39922,7 +40082,7 @@ paths: description: Empty response '410': description: Gone - content: *46 + content: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39986,10 +40146,10 @@ paths: default: true '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40045,16 +40205,16 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '410': description: Gone - content: *46 + content: *47 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40095,10 +40255,10 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40148,7 +40308,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -40177,13 +40337,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40265,10 +40425,10 @@ paths: value: *125 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -40362,7 +40522,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -40389,13 +40549,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40440,7 +40600,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -40573,7 +40733,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40621,7 +40781,7 @@ paths: value: *242 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40683,7 +40843,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -40712,7 +40872,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40792,10 +40952,10 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40843,7 +41003,7 @@ paths: value: *244 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41084,8 +41244,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *70 - required: *71 + properties: *71 + required: *72 required: - _links - git_url @@ -41251,10 +41411,10 @@ paths: message: Merge Conflict '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41314,7 +41474,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -41330,8 +41490,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 examples: default: value: @@ -41376,7 +41536,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41440,8 +41600,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 examples: default: value: &246 @@ -41486,10 +41646,10 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41530,14 +41690,14 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 examples: default: value: *246 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41604,8 +41764,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 examples: default: value: *246 @@ -41643,7 +41803,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41677,7 +41837,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -41746,7 +41906,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -41757,7 +41917,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -41773,8 +41933,8 @@ paths: title: Thread description: Thread type: object - properties: *75 - required: *76 + properties: *76 + required: *77 examples: default: value: *251 @@ -41933,7 +42093,7 @@ paths: public: true '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42013,10 +42173,10 @@ paths: value: *254 '422': description: Validation Failed - content: *35 + content: *36 '415': description: Preview Header Missing - content: *28 + content: *29 '409': description: Conflict content: *184 @@ -42112,7 +42272,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *35 + content: *36 '400': description: Bad Request content: *203 @@ -42145,13 +42305,13 @@ paths: description: Empty response '422': description: Validation Failed - content: *35 + content: *36 '415': description: Preview Header Missing - content: *28 + content: *29 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42187,7 +42347,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -42223,8 +42383,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true commit: type: string @@ -42478,6 +42638,21 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -42541,7 +42716,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -42595,7 +42770,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: response @@ -42662,7 +42837,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *14 + schema: *15 responses: '200': description: Responds with effective values inherited from owner and/or @@ -42728,7 +42903,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -42788,16 +42963,16 @@ paths: schema: *6 '401': description: Requires Authentication - content: *31 + content: *32 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '422': description: Validation Failed content: *103 @@ -42868,16 +43043,16 @@ paths: value: *145 '401': description: Requires Authentication - content: *31 + content: *32 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '410': description: Gone - content: *46 + content: *47 '422': description: Validation Failed content: *103 @@ -42968,7 +43143,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -42998,7 +43173,7 @@ paths: description: Not Modified '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43091,7 +43266,7 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: &267 + properties: &266 url: type: string format: uri @@ -43162,8 +43337,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: type: string @@ -43195,8 +43370,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 active_lock_reason: type: string example: too heated @@ -43229,8 +43404,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assignees: type: array @@ -43238,8 +43413,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true requested_reviewers: @@ -43248,8 +43423,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true requested_teams: @@ -43955,8 +44130,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *70 - required: *71 + properties: *71 + required: *72 pushed_at: type: string format: date-time @@ -44199,7 +44374,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -44223,8 +44398,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true comments: type: integer @@ -44249,7 +44424,7 @@ paths: changed_files: type: integer example: 5 - required: &268 + required: &267 - _links - assignee - labels @@ -44293,7 +44468,7 @@ paths: - review_comments examples: default: - value: &269 + value: &268 url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 node_id: MDExOlB1bGxSZXF1ZXN0MQ== @@ -44786,10 +44961,10 @@ paths: type: string '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 x-github: triggersNotification: true githubCloudOnly: false @@ -44824,11 +44999,14 @@ paths: required: true schema: *134 - name: sort - description: One of `created` (when the repository was starred) or `updated` - (when it was last pushed to). in: query required: false - schema: *263 + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -44844,11 +45022,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -44865,7 +45043,7 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: &264 + properties: &263 url: description: URL for the pull request review comment example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 @@ -44920,8 +45098,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: description: The text of the comment. @@ -44952,7 +45130,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 _links: type: object properties: @@ -45027,15 +45205,15 @@ paths: reactions: title: Reaction Rollup type: object - properties: *68 - required: *69 + properties: *69 + required: *70 body_html: type: string example: '"

comment body

"' body_text: type: string example: '"comment body"' - required: &265 + required: &264 - url - id - node_id @@ -45171,7 +45349,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 responses: '200': description: response @@ -45182,11 +45360,11 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *264 - required: *265 + properties: *263 + required: *264 examples: default: - value: &266 + value: &265 url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 id: 10 @@ -45238,7 +45416,7 @@ paths: side: RIGHT '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45298,7 +45476,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -45322,11 +45500,11 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *264 - required: *265 + properties: *263 + required: *264 examples: default: - value: *266 + value: *265 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45376,13 +45554,13 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45412,7 +45590,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.21/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. @@ -45432,7 +45610,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -45461,10 +45639,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45505,7 +45683,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -45560,10 +45738,10 @@ paths: value: *125 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45606,7 +45784,7 @@ paths: description: comment_id parameter in: path required: true - schema: *65 + schema: *66 - name: reaction_id in: path required: true @@ -45667,7 +45845,7 @@ paths: - name: pull_number in: path required: true - schema: &270 + schema: &269 type: integer responses: '200': @@ -45682,11 +45860,11 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: *267 - required: *268 + properties: *266 + required: *267 examples: default: - value: *269 + value: *268 '304': description: Not Modified '500': @@ -45694,7 +45872,7 @@ paths: content: *190 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45725,7 +45903,7 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 requestBody: content: application/json: @@ -45771,17 +45949,17 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: *267 - required: *268 + properties: *266 + required: *267 examples: default: - value: *269 + value: *268 '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45817,13 +45995,13 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 - name: sort description: One of `created` (when the repository was starred) or `updated` (when it was last pushed to). in: query required: false - schema: *263 + schema: *270 - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -45839,11 +46017,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -45860,8 +46038,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *264 - required: *265 + properties: *263 + required: *264 examples: default: value: *271 @@ -45936,7 +46114,7 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 requestBody: content: application/json: @@ -46035,8 +46213,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *264 - required: *265 + properties: *263 + required: *264 examples: example-for-a-multi-line-comment: value: @@ -46096,10 +46274,10 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: triggersNotification: true githubCloudOnly: false @@ -46153,12 +46331,12 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 - name: comment_id description: comment_id parameter in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -46182,8 +46360,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *264 - required: *265 + properties: *263 + required: *264 examples: default: value: @@ -46243,7 +46421,7 @@ paths: type: string '404': description: Resource Not Found - content: *23 + content: *24 x-github: triggersNotification: true githubCloudOnly: false @@ -46276,11 +46454,11 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -46335,11 +46513,11 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -46378,7 +46556,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *35 + content: *36 '500': description: Internal Error content: *190 @@ -46410,7 +46588,7 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 responses: '204': description: Response if pull request has been merged @@ -46447,7 +46625,7 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 requestBody: content: application/json: @@ -46531,13 +46709,13 @@ paths: message: Head branch was modified. Review and try the merge again. '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: triggersNotification: true githubCloudOnly: false @@ -46567,11 +46745,11 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -46592,8 +46770,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true teams: type: array @@ -46678,7 +46856,7 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 requestBody: content: application/json: @@ -47228,7 +47406,7 @@ paths: description: Response if user is not a collaborator '403': description: Forbidden - content: *30 + content: *31 x-github: triggersNotification: true githubCloudOnly: false @@ -47257,7 +47435,7 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 requestBody: content: application/json: @@ -47288,7 +47466,7 @@ paths: description: response '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47317,11 +47495,11 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -47351,8 +47529,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: description: The text of the review. @@ -47405,7 +47583,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 required: &276 - id - node_id @@ -47492,7 +47670,7 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 requestBody: content: application/json: @@ -47618,7 +47796,7 @@ paths: content: *103 '403': description: Forbidden - content: *30 + content: *31 x-github: triggersNotification: true githubCloudOnly: false @@ -47648,7 +47826,7 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 - name: review_id description: review_id parameter in: path @@ -47704,7 +47882,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47732,7 +47910,7 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 - name: review_id description: review_id parameter in: path @@ -47830,7 +48008,7 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 - name: review_id description: review_id parameter in: path @@ -47855,7 +48033,7 @@ paths: content: *103 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47884,7 +48062,7 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 - name: review_id description: review_id parameter in: path @@ -47893,7 +48071,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -47952,8 +48130,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true body: type: string @@ -47979,7 +48157,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 _links: type: object properties: @@ -48119,7 +48297,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48150,7 +48328,7 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 - name: review_id description: review_id parameter in: path @@ -48219,7 +48397,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed content: *103 @@ -48251,7 +48429,7 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 - name: review_id description: review_id parameter in: path @@ -48296,13 +48474,13 @@ paths: value: *279 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed content: *103 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48332,7 +48510,7 @@ paths: - name: pull_number in: path required: true - schema: *270 + schema: *269 requestBody: content: application/json: @@ -48368,13 +48546,13 @@ paths: url: https://github.com/repos/octocat/Hello-World/pulls/53 '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -48430,7 +48608,7 @@ paths: required: *281 examples: default: - value: + value: &282 type: file encoding: base64 size: 5362 @@ -48448,10 +48626,72 @@ paths: html: https://github.com/octokit/octokit.rb/blob/master/README.md '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository-readme + parameters: + - name: owner + in: path + required: true + schema: *133 + - name: repo + in: path + required: true + schema: *134 + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + title: Content File + description: Content File + type: object + properties: *280 + required: *281 + examples: + default: + value: *282 + '404': + description: Resource Not Found + content: *24 + '422': + description: Validation Failed + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48483,7 +48723,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -48499,7 +48739,7 @@ paths: title: Release description: A release. type: object - properties: &282 + properties: &283 url: type: string format: uri @@ -48559,8 +48799,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true assets: type: array @@ -48568,7 +48808,7 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: &284 + properties: &285 url: type: string format: uri @@ -48610,10 +48850,10 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true - required: &285 + required: &286 - id - name - content_type @@ -48631,7 +48871,7 @@ paths: type: string body_text: type: string - required: &283 + required: &284 - assets_url - upload_url - tarball_url @@ -48726,7 +48966,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48803,11 +49043,11 @@ paths: title: Release description: A release. type: object - properties: *282 - required: *283 + properties: *283 + required: *284 examples: default: - value: &288 + value: &289 url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 assets_url: https://api.github.com/repos/octocat/Hello-World/releases/1/assets @@ -48882,7 +49122,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 x-github: triggersNotification: true githubCloudOnly: false @@ -48916,7 +49156,7 @@ paths: description: asset_id parameter in: path required: true - schema: &286 + schema: &287 type: integer responses: '200': @@ -48931,11 +49171,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *284 - required: *285 + properties: *285 + required: *286 examples: default: - value: &287 + value: &288 url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip id: 1 @@ -48969,10 +49209,10 @@ paths: site_admin: false '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '302': description: Found x-github: @@ -49003,7 +49243,7 @@ paths: description: asset_id parameter in: path required: true - schema: *286 + schema: *287 requestBody: content: application/json: @@ -49032,11 +49272,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *284 - required: *285 + properties: *285 + required: *286 examples: default: - value: *287 + value: *288 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49065,7 +49305,7 @@ paths: description: asset_id parameter in: path required: true - schema: *286 + schema: *287 responses: '204': description: Empty response @@ -49106,11 +49346,11 @@ paths: title: Release description: A release. type: object - properties: *282 - required: *283 + properties: *283 + required: *284 examples: default: - value: *288 + value: *289 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49137,7 +49377,7 @@ paths: required: true schema: *134 - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -49152,14 +49392,14 @@ paths: title: Release description: A release. type: object - properties: *282 - required: *283 + properties: *283 + required: *284 examples: default: - value: *288 + value: *289 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49190,7 +49430,7 @@ paths: description: release_id parameter in: path required: true - schema: &289 + schema: &290 type: integer responses: '200': @@ -49202,14 +49442,14 @@ paths: title: Release description: A release. type: object - properties: *282 - required: *283 + properties: *283 + required: *284 examples: default: - value: *288 + value: *289 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49238,7 +49478,7 @@ paths: description: release_id parameter in: path required: true - schema: *289 + schema: *290 requestBody: content: application/json: @@ -49284,11 +49524,11 @@ paths: title: Release description: A release. type: object - properties: *282 - required: *283 + properties: *283 + required: *284 examples: default: - value: *288 + value: *289 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49317,7 +49557,7 @@ paths: description: release_id parameter in: path required: true - schema: *289 + schema: *290 responses: '204': description: Empty response @@ -49350,11 +49590,11 @@ paths: description: release_id parameter in: path required: true - schema: *289 + schema: *290 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -49370,8 +49610,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *284 - required: *285 + properties: *285 + required: *286 examples: default: value: @@ -49468,7 +49708,7 @@ paths: description: release_id parameter in: path required: true - schema: *289 + schema: *290 - name: name in: query schema: @@ -49492,8 +49732,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *284 - required: *285 + properties: *285 + required: *286 examples: response-for-successful-upload: value: @@ -49559,7 +49799,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -49575,8 +49815,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default-response: @@ -49617,8 +49857,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true required: - starred_at @@ -49654,7 +49894,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49693,7 +49933,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: &290 + items: &291 type: integer examples: default: @@ -49828,8 +50068,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true total: type: integer @@ -50043,7 +50283,7 @@ paths: - 3 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50089,7 +50329,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: *290 + items: *291 examples: default: value: @@ -50183,8 +50423,8 @@ paths: title: Status description: The status of a commit. type: object - properties: *291 - required: *292 + properties: *292 + required: *293 examples: default: value: @@ -50250,7 +50490,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -50266,8 +50506,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -50312,7 +50552,7 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: &293 + properties: &294 subscribed: description: Determines if notifications should be received from this repository. @@ -50337,7 +50577,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/example - required: &294 + required: &295 - created_at - ignored - reason @@ -50357,7 +50597,7 @@ paths: description: Response if you don't subscribe to the repository '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -50410,8 +50650,8 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: *293 - required: *294 + properties: *294 + required: *295 examples: default: value: @@ -50478,7 +50718,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -50610,7 +50850,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -50662,6 +50902,14 @@ paths: in: path required: true schema: *134 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *30 responses: '200': description: response @@ -50671,16 +50919,16 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: &295 + properties: &296 names: type: array items: type: string - required: &296 + required: &297 - names examples: default: - value: &297 + value: &298 names: - octocat - atom @@ -50688,10 +50936,10 @@ paths: - api '415': description: Preview Header Missing - content: *28 + content: *29 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50754,17 +51002,17 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: *295 - required: *296 + properties: *296 + required: *297 examples: default: - value: *297 + value: *298 '415': description: Preview Header Missing - content: *28 + content: *29 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed content: *103 @@ -50836,8 +51084,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: value: *204 @@ -51036,8 +51284,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: value: @@ -51297,7 +51545,7 @@ paths: type: string '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified x-github: @@ -51362,7 +51610,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: &298 + schema: &299 type: string enum: - desc @@ -51371,7 +51619,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -51440,7 +51688,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: &299 + items: &300 type: object properties: object_url: @@ -51557,10 +51805,10 @@ paths: content: *196 '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51613,11 +51861,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *298 + schema: *299 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -51717,8 +51965,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true committer: nullable: true @@ -51751,7 +51999,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *299 + items: *300 required: - sha - node_id @@ -51884,7 +52132,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51962,11 +52210,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *298 + schema: *299 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -52030,8 +52278,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true nullable: true user: @@ -52040,8 +52288,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true labels: type: array @@ -52071,8 +52319,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true milestone: nullable: true @@ -52080,8 +52328,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *66 - required: *67 + properties: *67 + required: *68 comments: type: integer created_at: @@ -52097,7 +52345,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *299 + items: *300 pull_request: type: object properties: @@ -52135,15 +52383,15 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *51 + enum: *52 draft: type: boolean repository: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 body_html: type: string body_text: @@ -52161,8 +52409,8 @@ paths: They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *19 - required: *20 + properties: *20 + required: *21 additionalProperties: true required: - assignee @@ -52283,12 +52531,12 @@ paths: content: *196 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52345,7 +52593,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *298 + schema: *299 responses: '200': description: response @@ -52390,7 +52638,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *299 + items: *300 required: - id - node_id @@ -52426,13 +52674,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52493,11 +52741,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *298 + schema: *299 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -52539,8 +52787,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true private: type: boolean @@ -52716,8 +52964,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *70 - required: *71 + properties: *71 + required: *72 permissions: type: object properties: @@ -52734,7 +52982,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *299 + items: *300 temp_clone_token: type: string allow_merge_commit: @@ -52931,7 +53179,7 @@ paths: content: *196 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified x-github: @@ -53038,7 +53286,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *299 + items: *300 related: type: array nullable: true @@ -53183,7 +53431,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53246,11 +53494,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *298 + schema: *299 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -53358,7 +53606,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *299 + items: *300 blog: type: string nullable: true @@ -53421,7 +53669,7 @@ paths: content: *196 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53530,7 +53778,7 @@ paths: application/json: schema: type: object - properties: &300 + properties: &301 status: type: string scheduled_time: @@ -53549,7 +53797,7 @@ paths: - number examples: default: - value: &301 + value: &302 status: scheduled scheduled_time: Tuesday, January 22 at 15:34 -0800 connection_services: @@ -53584,10 +53832,10 @@ paths: application/json: schema: type: object - properties: *300 + properties: *301 examples: default: - value: *301 + value: *302 requestBody: content: application/json: @@ -54097,14 +54345,14 @@ paths: type: array items: type: object - properties: &302 + properties: &303 key: type: string pretty-print: type: string examples: default: - value: &303 + value: &304 - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64 - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... @@ -54133,7 +54381,7 @@ paths: type: array items: type: object - properties: *302 + properties: *303 examples: default: value: @@ -54178,10 +54426,10 @@ paths: type: array items: type: object - properties: *302 + properties: *303 examples: default: - value: *303 + value: *304 requestBody: content: application/json: @@ -54312,7 +54560,7 @@ paths: value: *112 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54406,13 +54654,13 @@ paths: value: *112 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54446,10 +54694,10 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54481,11 +54729,11 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *94 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -54506,7 +54754,7 @@ paths: required: *115 examples: default: - value: *304 + value: *305 headers: Link: example: ; rel="next", ; @@ -54715,7 +54963,7 @@ paths: required: *115 examples: default: - value: *305 + value: *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54794,11 +55042,11 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *94 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -54818,7 +55066,7 @@ paths: required: *119 examples: default: - value: *306 + value: *307 headers: Link: example: ; rel="next", ; @@ -55023,7 +55271,7 @@ paths: required: *119 examples: default: - value: *307 + value: *308 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55125,7 +55373,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -55294,7 +55542,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -55452,7 +55700,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -55468,8 +55716,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -55481,7 +55729,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55607,7 +55855,7 @@ paths: resource: TeamMember '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55698,16 +55946,16 @@ paths: examples: response-if-user-has-an-active-membership-with-team: summary: Response if user has an active membership with team - value: *308 + value: *309 response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer - value: *309 + value: *310 response-if-user-has-a-pending-membership-with-team: summary: Response if user has a pending membership with team - value: *310 + value: *311 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55777,10 +56025,10 @@ paths: examples: response-if-users-membership-with-team-is-now-active: summary: Response if user's membership with team is now active - value: *311 + value: *312 response-if-users-membership-with-team-is-now-pending: summary: Response if user's membership with team is now pending - value: *312 + value: *313 '403': description: Response if team synchronization is set up '422': @@ -55816,7 +56064,7 @@ paths: resource: TeamMember '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55886,7 +56134,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -55906,7 +56154,7 @@ paths: required: *130 examples: default: - value: *313 + value: *314 headers: Link: example: ; rel="next", ; @@ -55914,10 +56162,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55969,12 +56217,12 @@ paths: required: *130 examples: default: - value: *314 + value: *315 '404': description: Response if project is not managed by this team '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56055,13 +56303,13 @@ paths: documentation_url: https://docs.github.com/enterprise-server@2.21/rest/reference/teams#add-or-update-team-project-permissions '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56104,13 +56352,13 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56141,7 +56389,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -56169,7 +56417,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56216,8 +56464,8 @@ paths: title: Team Repository description: A team's access to a repository. type: object - properties: *315 - required: *316 + properties: *316 + required: *317 examples: alternative-response-with-extra-repository-information: value: @@ -56516,10 +56764,10 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56587,7 +56835,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -56608,7 +56856,7 @@ paths: required: *136 examples: response-if-child-teams-exist: - value: *317 + value: *318 headers: Link: example: ; rel="next", ; @@ -56616,13 +56864,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56656,7 +56904,7 @@ paths: - title: Private User description: Private User type: object - properties: &318 + properties: &319 login: type: string example: octocat @@ -56809,7 +57057,7 @@ paths: type: boolean ldap_dn: type: string - required: &319 + required: &320 - avatar_url - events_url - followers_url @@ -56850,7 +57098,7 @@ paths: - title: Public User description: Public User type: object - properties: &334 + properties: &335 login: type: string id: @@ -56967,7 +57215,7 @@ paths: collaborators: type: integer example: 3 - required: &335 + required: &336 - avatar_url - events_url - followers_url @@ -57084,10 +57332,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57153,8 +57401,8 @@ paths: title: Private User description: Private User type: object - properties: *318 - required: *319 + properties: *319 + required: *320 examples: default: value: @@ -57204,16 +57452,16 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57235,7 +57483,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57251,7 +57499,7 @@ paths: title: Email description: Email type: object - properties: &320 + properties: &321 email: type: string format: email @@ -57266,14 +57514,14 @@ paths: type: string example: public nullable: true - required: &321 + required: &322 - email - primary - verified - visibility examples: default: - value: &331 + value: &332 - email: octocat@github.com verified: true primary: true @@ -57287,13 +57535,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57352,8 +57600,8 @@ paths: title: Email description: Email type: object - properties: *320 - required: *321 + properties: *321 + required: *322 examples: default: value: @@ -57371,18 +57619,18 @@ paths: visibility: '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57437,16 +57685,16 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57467,7 +57715,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57483,8 +57731,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -57498,10 +57746,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57522,7 +57770,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57538,8 +57786,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -57553,10 +57801,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57590,15 +57838,15 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57629,13 +57877,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57664,13 +57912,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57692,7 +57940,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -57708,7 +57956,7 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: &322 + properties: &323 id: type: integer example: 3 @@ -57802,7 +58050,7 @@ paths: raw_key: type: string nullable: true - required: &323 + required: &324 - id - primary_key_id - key_id @@ -57818,7 +58066,7 @@ paths: - subkeys examples: default: - value: &336 + value: &337 - id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -57855,13 +58103,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57900,11 +58148,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *322 - required: *323 + properties: *323 + required: *324 examples: default: - value: &324 + value: &325 id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -57936,18 +58184,18 @@ paths: PGP PUBLIC KEY BLOCK-----"' '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57970,7 +58218,7 @@ paths: description: gpg_key_id parameter in: path required: true - schema: &325 + schema: &326 type: integer responses: '200': @@ -57981,22 +58229,22 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *322 - required: *323 + properties: *323 + required: *324 examples: default: - value: *324 + value: *325 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58019,24 +58267,24 @@ paths: description: gpg_key_id parameter in: path required: true - schema: *325 + schema: *326 responses: '204': description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58071,7 +58319,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58096,8 +58344,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: @@ -58188,13 +58436,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '415': description: Preview Header Missing - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58236,11 +58484,11 @@ paths: description: installation_id parameter in: path required: true - schema: *24 + schema: *25 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58267,8 +58515,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: value: @@ -58387,10 +58635,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '304': description: Not Modified x-github: @@ -58430,23 +58678,23 @@ paths: description: installation_id parameter in: path required: true - schema: *24 + schema: *25 - name: repository_id in: path required: true - schema: &326 + schema: &327 type: integer responses: '204': description: Empty response '403': description: Forbidden - content: *30 + content: *31 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58476,22 +58724,22 @@ paths: description: installation_id parameter in: path required: true - schema: *24 + schema: *25 - name: repository_id in: path required: true - schema: *326 + schema: *327 responses: '204': description: Empty response '403': description: Forbidden - content: *30 + content: *31 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58536,6 +58784,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -58554,7 +58803,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *93 + schema: *94 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -58571,18 +58820,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *94 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58611,7 +58860,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified x-github: @@ -58643,7 +58892,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -58659,7 +58908,7 @@ paths: title: Key description: Key type: object - properties: &327 + properties: &328 key_id: type: string key: @@ -58677,7 +58926,7 @@ paths: type: boolean read_only: type: boolean - required: &328 + required: &329 - key_id - key - id @@ -58714,13 +58963,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58764,11 +59013,11 @@ paths: title: Key description: Key type: object - properties: *327 - required: *328 + properties: *328 + required: *329 examples: default: - value: &329 + value: &330 key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -58779,18 +59028,18 @@ paths: read_only: false '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58824,22 +59073,22 @@ paths: title: Key description: Key type: object - properties: *327 - required: *328 + properties: *328 + required: *329 examples: default: - value: *329 + value: *330 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58870,13 +59119,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58908,7 +59157,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -59010,13 +59259,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -59037,7 +59286,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 responses: '200': description: response @@ -59090,10 +59339,10 @@ paths: site_admin: false '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -59113,7 +59362,7 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 requestBody: content: application/json: @@ -59182,13 +59431,13 @@ paths: site_admin: false '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -59214,7 +59463,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -59230,11 +59479,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *81 - required: *82 + properties: *82 + required: *83 examples: default: - value: *330 + value: *331 headers: Link: example: ; rel="next", ; @@ -59244,10 +59493,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -59332,13 +59581,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed content: *103 @@ -59371,7 +59620,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -59387,11 +59636,11 @@ paths: title: Email description: Email type: object - properties: *320 - required: *321 + properties: *321 + required: *322 examples: default: - value: *331 + value: *332 headers: Link: example: ; rel="next", ; @@ -59401,13 +59650,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -59493,7 +59742,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -59504,7 +59753,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -59523,12 +59772,12 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: summary: Default response - value: &333 + value: &334 - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World @@ -59637,15 +59886,15 @@ paths: anonymous_access_enabled: false '422': description: Validation Failed - content: *35 + content: *36 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -59767,8 +60016,8 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: value: *204 @@ -59779,18 +60028,18 @@ paths: type: string '401': description: Requires Authentication - content: *31 + content: *32 '304': description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '422': description: Validation Failed - content: *35 + content: *36 '400': description: Bad Request content: *203 @@ -59832,7 +60081,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -59853,7 +60102,7 @@ paths: required: *222 examples: default: - value: *332 + value: *333 headers: Link: example: ; rel="next", ; @@ -59863,13 +60112,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -59897,13 +60146,13 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '409': description: Conflict content: *184 '404': description: Resource Not Found - content: *23 + content: *24 '304': description: Not Modified x-github: @@ -59937,10 +60186,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -59966,16 +60215,16 @@ paths: (when it was last pushed to). in: query required: false - schema: *263 + schema: *270 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *94 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -59991,12 +60240,12 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default-response: summary: Default response - value: *333 + value: *334 application/vnd.github.v3.star+json: schema: type: array @@ -60004,7 +60253,7 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: &337 + properties: &338 starred_at: type: string format: date-time @@ -60012,15 +60261,15 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 - required: &338 + properties: *50 + required: *51 + required: &339 - starred_at - repo examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: &339 + value: &340 - starred_at: '2011-01-16T19:06:43Z' repo: id: 1296269 @@ -60138,10 +60387,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -60178,15 +60427,15 @@ paths: title: Basic Error description: Basic Error type: object - properties: *27 + properties: *28 '401': description: Requires Authentication - content: *31 + content: *32 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -60217,13 +60466,13 @@ paths: description: Empty response '403': description: Forbidden - content: *30 + content: *31 '404': description: Resource Not Found - content: *23 + content: *24 '401': description: Requires Authentication - content: *31 + content: *32 '304': description: Not Modified x-github: @@ -60255,15 +60504,15 @@ paths: description: Empty response '404': description: Resource Not Found - content: *23 + content: *24 '401': description: Requires Authentication - content: *31 + content: *32 '304': description: Not Modified '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -60284,7 +60533,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -60314,10 +60563,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *30 + content: *31 '401': description: Requires Authentication - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -60341,7 +60590,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -60416,10 +60665,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *23 + content: *24 '403': description: Forbidden - content: *30 + content: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -60449,7 +60698,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 responses: '200': description: response @@ -60461,8 +60710,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -60512,13 +60761,13 @@ paths: - title: Private User description: Private User type: object - properties: *318 - required: *319 + properties: *319 + required: *320 - title: Public User description: Public User type: object - properties: *334 - required: *335 + properties: *335 + required: *336 additionalProperties: false examples: default-response: @@ -60598,7 +60847,7 @@ paths: private_repos: 9999 '404': description: Resource Not Found - content: *23 + content: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60624,7 +60873,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -60640,8 +60889,8 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60667,11 +60916,11 @@ paths: - name: org in: path required: true - schema: *83 + schema: *84 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -60687,8 +60936,8 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -60713,7 +60962,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -60729,8 +60978,8 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60755,7 +61004,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -60771,8 +61020,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -60806,7 +61055,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -60822,8 +61071,8 @@ paths: title: Simple User description: Simple User type: object - properties: *15 - required: *16 + properties: *16 + required: *17 nullable: true examples: default: @@ -60891,11 +61140,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *54 + schema: *55 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -60911,11 +61160,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *55 - required: *56 + properties: *56 + required: *57 examples: default: - value: *57 + value: *58 headers: Link: example: ; rel="next", ; @@ -60923,7 +61172,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -60949,7 +61198,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -60965,11 +61214,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *322 - required: *323 + properties: *323 + required: *324 examples: default: - value: *336 + value: *337 headers: Link: example: ; rel="next", ; @@ -61056,10 +61305,10 @@ paths: octicon: repo '404': description: Resource Not Found - content: *23 + content: *24 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -61100,8 +61349,8 @@ paths: title: Installation description: Installation type: object - properties: *21 - required: *22 + properties: *22 + required: *23 examples: default: value: *220 @@ -61135,7 +61384,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -61196,7 +61445,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -61212,11 +61461,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *81 - required: *82 + properties: *82 + required: *83 examples: default: - value: *330 + value: *331 headers: Link: example: ; rel="next", ; @@ -61258,7 +61507,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -61318,10 +61567,10 @@ paths: schema: *6 '415': description: Preview Header Missing - content: *28 + content: *29 '422': description: Validation Failed - content: *35 + content: *36 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -61355,7 +61604,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -61371,8 +61620,8 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61397,7 +61646,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -61413,8 +61662,8 @@ paths: title: Event description: Event type: object - properties: *73 - required: *74 + properties: *74 + required: *75 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61473,7 +61722,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -61585,16 +61834,16 @@ paths: (when it was last pushed to). in: query required: false - schema: *263 + schema: *270 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *94 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query @@ -61610,12 +61859,12 @@ paths: title: Repository description: A git repository type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default-response: summary: Default response - value: *333 + value: *334 application/vnd.github.v3.star+json: schema: type: array @@ -61623,12 +61872,12 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: *337 - required: *338 + properties: *338 + required: *339 examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: *339 + value: *340 headers: Link: example: ; rel="next", ; @@ -61658,7 +61907,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *29 + schema: *30 - name: page description: Page number of the results to fetch. in: query diff --git a/descriptions/ghes-2.21/ghes-2.21.json b/descriptions/ghes-2.21/ghes-2.21.json index 8be1ccbcc6..16569720a9 100644 --- a/descriptions/ghes-2.21/ghes-2.21.json +++ b/descriptions/ghes-2.21/ghes-2.21.json @@ -824,6 +824,32 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1280,6 +1306,23 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -1790,6 +1833,24 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -2893,6 +2954,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -3547,6 +3617,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -6137,6 +6216,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -6291,6 +6371,9 @@ }, { "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -8026,6 +8109,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -8713,6 +8797,24 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -9931,6 +10033,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { @@ -18353,6 +18464,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -18727,9 +18858,15 @@ { "$ref": "#/components/parameters/repo" }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -18796,7 +18933,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -18829,6 +18966,14 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -18904,7 +19049,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -19005,13 +19150,19 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -19066,7 +19217,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -19211,7 +19362,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -19312,7 +19463,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -19492,7 +19643,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -19740,7 +19891,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -20543,7 +20695,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -20553,6 +20706,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -20610,6 +20783,26 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -20617,6 +20810,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -21047,7 +21241,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -21119,7 +21313,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -21270,7 +21464,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -21356,7 +21550,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -21730,7 +21924,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -26846,6 +27041,23 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -27515,7 +27727,17 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/sort" + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "created_at" + ] + } }, { "name": "direction", @@ -29849,6 +30071,79 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content-file" + }, + "examples": { + "default": { + "$ref": "#/components/examples/content-file" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -30262,7 +30557,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -31484,6 +31779,12 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" } ], "responses": { @@ -36754,6 +37055,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -39814,6 +40116,20 @@ "type": "integer" } }, + "direction": { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, "key-ids": { "name": "key_ids", "in": "path", @@ -39967,20 +40283,6 @@ "type": "string" } }, - "direction": { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, "owner": { "name": "owner", "in": "path", diff --git a/descriptions/ghes-2.21/ghes-2.21.yaml b/descriptions/ghes-2.21/ghes-2.21.yaml index 8cf01e1bf7..1bf49b884c 100644 --- a/descriptions/ghes-2.21/ghes-2.21.yaml +++ b/descriptions/ghes-2.21/ghes-2.21.yaml @@ -600,6 +600,23 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string responses: '200': description: response @@ -897,6 +914,17 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1287,6 +1315,19 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: One of `created` (when the repository was starred) or `updated` + (when it was last pushed to) or `name`. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -2085,6 +2126,12 @@ paths: parameters: - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -2554,6 +2601,12 @@ paths: parameters: - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -4361,6 +4414,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -4463,6 +4517,7 @@ paths: schema: type: boolean - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -5690,6 +5745,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -6162,6 +6218,18 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: The sort order for the response collection. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -7105,6 +7173,12 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: pinned + in: query + required: false + description: Pinned discussions only filter + schema: + type: string responses: '200': description: response @@ -13330,6 +13404,20 @@ paths: type: string - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -13622,8 +13710,10 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -13668,7 +13758,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -13689,6 +13779,11 @@ paths: default: latest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -13742,7 +13837,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -13817,12 +13912,14 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -13858,7 +13955,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -14016,7 +14113,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -14077,7 +14174,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -14213,7 +14310,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -14381,6 +14478,7 @@ paths: schema: type: string default: none + nullable: true - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" responses: @@ -15071,9 +15169,24 @@ paths: - newest - oldest - stargazers + - watchers default: newest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -15112,11 +15225,26 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -15495,7 +15623,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -15541,7 +15669,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -15640,7 +15768,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -15697,7 +15825,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -16026,6 +16154,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -19478,6 +19607,17 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -19979,7 +20119,15 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/sort" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -21669,6 +21817,56 @@ paths: previews: [] category: repos subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository-readme + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/content-file" + examples: + default: + "$ref": "#/components/examples/content-file" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents "/repos/{owner}/{repo}/releases": get: summary: List releases @@ -21948,7 +22146,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -22772,6 +22970,8 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" responses: '200': description: response @@ -26730,6 +26930,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -28793,6 +28994,17 @@ components: required: true schema: type: integer + direction: + name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc key-ids: name: key_ids in: path @@ -28912,17 +29124,6 @@ components: required: false schema: type: string - direction: - name: direction - description: One of `asc` (ascending) or `desc` (descending). - in: query - required: false - schema: - type: string - enum: - - asc - - desc - default: desc owner: name: owner in: path diff --git a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json index a5ca44119e..ebf7fa61ea 100644 --- a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json +++ b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.json @@ -1140,6 +1140,43 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1899,6 +1936,34 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -2746,6 +2811,35 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -9028,6 +9122,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -13534,6 +13637,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -34838,6 +34950,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -37537,6 +37650,15 @@ "type": "integer", "default": 30 } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -46801,6 +46923,24 @@ "schema": { "type": "integer" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -51412,6 +51552,24 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -58187,6 +58345,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -62647,6 +62806,35 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -69501,6 +69689,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { @@ -132525,7 +132722,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. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "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. GitHub Apps must have the `security_events` read permission to use\nthis 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).", "tags": [ "code-scanning" ], @@ -132597,7 +132794,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } }, { @@ -132610,6 +132807,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -132665,6 +132863,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -132860,7 +133059,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -132875,6 +133074,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -133222,6 +133422,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -133432,7 +133633,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -133447,6 +133648,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -133798,6 +134000,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -134008,7 +134211,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -134023,6 +134226,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -134316,7 +134520,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } }, { @@ -134344,7 +134548,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "commit_sha": { "description": "The SHA of the commit to which the analysis you are uploading relates.", @@ -134559,7 +134763,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -134601,7 +134805,7 @@ }, "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "sarif": { "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@2.22/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning).\"", @@ -139688,6 +139892,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -145408,9 +145632,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -146155,7 +146397,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -146217,6 +146459,14 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -147208,7 +147458,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -149510,13 +149760,31 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -151278,7 +151546,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -153513,7 +153781,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -154228,7 +154496,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -154920,7 +155188,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -155643,7 +155911,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -162594,7 +162863,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -162616,6 +162886,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -164336,6 +164626,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -164343,6 +164653,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -166823,7 +167134,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -166985,7 +167296,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -167345,7 +167656,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -167560,7 +167871,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -168576,7 +168887,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -211024,6 +211336,34 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -219506,16 +219846,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -239728,6 +240067,279 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -242215,7 +242827,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -247032,6 +247644,24 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -278885,6 +279515,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" diff --git a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml index ddbcececba..6c9a886cbc 100644 --- a/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml +++ b/descriptions/ghes-2.22/dereferenced/ghes-2.22.deref.yaml @@ -742,6 +742,32 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: &9 + type: string + enum: + - asc + - desc + default: desc + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string responses: '200': description: response @@ -1100,7 +1126,7 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: &53 + properties: &54 login: type: string example: github @@ -1141,7 +1167,7 @@ paths: type: string example: A great organization nullable: true - required: &54 + required: &55 - login - url - id @@ -1211,7 +1237,7 @@ paths: - name: org in: path required: true - schema: &95 + schema: &96 type: string responses: '202': @@ -1267,6 +1293,21 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1276,7 +1317,7 @@ paths: type: array items: type: object - properties: &9 + properties: &10 id: type: integer name: @@ -1367,10 +1408,10 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default: - value: &10 + value: &11 id: 2 name: DevTools Hook Env image_url: https://my_file_server/path/to/devtools_env.tar.gz @@ -1432,7 +1473,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: &11 + schema: &12 type: integer responses: '200': @@ -1441,10 +1482,10 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default: - value: *10 + value: *11 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -1475,7 +1516,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *11 + schema: *12 responses: '200': description: response @@ -1483,7 +1524,7 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default-response: value: @@ -1576,7 +1617,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *11 + schema: *12 responses: '204': description: Empty response @@ -1646,7 +1687,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *11 + schema: *12 responses: '202': description: response @@ -1654,7 +1695,7 @@ paths: application/json: schema: type: object - properties: &12 + properties: &13 url: type: string state: @@ -1733,7 +1774,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *11 + schema: *12 responses: '200': description: response @@ -1741,7 +1782,7 @@ paths: application/json: schema: type: object - properties: *12 + properties: *13 examples: default: value: @@ -1784,6 +1825,23 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + description: One of `created` (when the repository was starred) or `updated` + (when it was last pushed to) or `name`. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1793,7 +1851,7 @@ paths: type: array items: type: object - properties: &13 + properties: &14 id: type: integer name: @@ -1906,10 +1964,10 @@ paths: application/json: schema: type: object - properties: *13 + properties: *14 examples: default: - value: &14 + value: &15 id: 1 name: Check Commits enforcement: disabled @@ -2007,7 +2065,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: &15 + schema: &16 type: integer responses: '200': @@ -2016,10 +2074,10 @@ paths: application/json: schema: type: object - properties: *13 + properties: *14 examples: default: - value: *14 + value: *15 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -2049,7 +2107,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -2057,7 +2115,7 @@ paths: application/json: schema: type: object - properties: *13 + properties: *14 examples: default: value: @@ -2148,7 +2206,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '204': description: Empty response @@ -2199,7 +2257,7 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: &18 + properties: &19 id: type: integer url: @@ -2255,7 +2313,7 @@ paths: - title: Simple User description: Simple User type: object - properties: &16 + properties: &17 login: type: string example: octocat @@ -2321,7 +2379,7 @@ paths: starred_at: type: string example: '"2020-07-09T00:17:55Z"' - required: &17 + required: &18 - avatar_url - events_url - followers_url @@ -2352,7 +2410,7 @@ paths: type: object description: The permissions granted to the user-to-server access token. - properties: &26 + properties: &27 actions: type: string description: 'The level of permission to grant the @@ -2601,7 +2659,7 @@ paths: enum: - read - write - example: &27 + example: &28 contents: read issues: read deployments: write @@ -2635,8 +2693,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true required: - permissions @@ -2644,7 +2702,7 @@ paths: - single_file_name - repositories_url - account - required: &19 + required: &20 - app - id - note @@ -2659,7 +2717,7 @@ paths: - updated_at examples: default: - value: &41 + value: &42 - id: 2 url: https://enterprise.octocat.com/api/v3/authorizations/2 app: @@ -2751,8 +2809,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -2901,11 +2959,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: &42 + value: &43 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -2989,7 +3047,7 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: &20 + properties: &21 id: description: Unique identifier of the GitHub app example: 37 @@ -3007,8 +3065,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true name: description: The name of the GitHub app @@ -3079,7 +3137,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &21 + required: &22 - id - node_id - owner @@ -3094,7 +3152,7 @@ paths: additionalProperties: true examples: default: - value: &40 + value: &41 id: 1 slug: octoapp node_id: MDExOkludGVncmF0aW9uMQ== @@ -3170,8 +3228,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true - type: object properties: @@ -3261,13 +3319,13 @@ paths: -----END RSA PRIVATE KEY----- '404': description: Resource Not Found - content: &24 + content: &25 application/json: schema: title: Basic Error description: Basic Error type: object - properties: &28 + properties: &29 message: type: string documentation_url: @@ -3280,10 +3338,10 @@ paths: title: Validation Error Simple description: Validation Error Simple type: object - required: &100 + required: &101 - message - documentation_url - properties: &101 + properties: &102 message: type: string documentation_url: @@ -3315,7 +3373,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: &30 + schema: &31 type: integer default: 30 - name: page @@ -3328,7 +3386,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: &68 + schema: &69 type: string - name: outdated in: query @@ -3347,7 +3405,7 @@ paths: title: Installation description: Installation type: object - properties: &22 + properties: &23 id: description: The ID of the installation. type: integer @@ -3358,8 +3416,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true - title: Enterprise description: An enterprise account @@ -3491,8 +3549,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true suspended_at: type: string @@ -3502,7 +3560,7 @@ paths: type: string example: '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' nullable: true - required: &23 + required: &24 - id - app_id - app_slug @@ -3588,7 +3646,7 @@ paths: description: installation_id parameter in: path required: true - schema: &25 + schema: &26 type: integer responses: '200': @@ -3599,8 +3657,8 @@ paths: title: Installation description: Installation type: object - properties: *22 - required: *23 + properties: *23 + required: *24 examples: default: value: @@ -3644,10 +3702,10 @@ paths: app_slug: github-actions '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: &29 + content: &30 application/json: schema: type: object @@ -3682,13 +3740,13 @@ paths: description: installation_id parameter in: path required: true - schema: *25 + schema: *26 responses: '204': description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -3713,7 +3771,7 @@ paths: description: installation_id parameter in: path required: true - schema: *25 + schema: *26 requestBody: content: application/json: @@ -3740,8 +3798,8 @@ paths: type: object description: The permissions granted to the user-to-server access token. - properties: *26 - example: *27 + properties: *27 + example: *28 responses: '201': description: response @@ -3781,7 +3839,7 @@ paths: title: Repository description: A git repository type: object - properties: &59 + properties: &60 id: description: Unique identifier of the repository example: 42 @@ -3802,7 +3860,7 @@ paths: - title: License Simple description: License Simple type: object - properties: &84 + properties: &85 key: type: string example: mit @@ -3824,7 +3882,7 @@ paths: html_url: type: string format: uri - required: &85 + required: &86 - key - name - url @@ -3855,8 +3913,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true private: description: Whether the repository is private or public. @@ -4347,7 +4405,7 @@ paths: starred_at: type: string example: '"2020-07-09T00:17:42Z"' - required: &60 + required: &61 - archive_url - assignees_url - blobs_url @@ -4565,40 +4623,40 @@ paths: watchers: 1 '403': description: Forbidden - content: &31 + content: &32 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 '415': description: Preview Header Missing - content: *29 + content: *30 '401': description: Requires Authentication - content: &32 + content: &33 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: &36 + content: &37 application/json: schema: title: Validation Error description: Validation Error type: object - required: &98 + required: &99 - message - documentation_url - properties: &99 + properties: &100 message: type: string documentation_url: @@ -4654,13 +4712,13 @@ paths: description: installation_id parameter in: path required: true - schema: *25 + schema: *26 responses: '204': description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4684,13 +4742,13 @@ paths: description: installation_id parameter in: path required: true - schema: *25 + schema: *26 responses: '204': description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4714,11 +4772,17 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -4730,7 +4794,7 @@ paths: title: Application Grant description: The authorization associated with an OAuth Access. type: object - properties: &33 + properties: &34 id: type: integer example: 1 @@ -4772,10 +4836,10 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true - required: &34 + required: &35 - app - id - scopes @@ -4804,13 +4868,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4841,7 +4905,7 @@ paths: description: grant_id parameter in: path required: true - schema: &35 + schema: &36 type: integer responses: '200': @@ -4852,8 +4916,8 @@ paths: title: Application Grant description: The authorization associated with an OAuth Access. type: object - properties: *33 - required: *34 + properties: *34 + required: *35 examples: default: value: @@ -4871,10 +4935,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4901,7 +4965,7 @@ paths: description: grant_id parameter in: path required: true - schema: *35 + schema: *36 responses: '204': description: Empty response @@ -4909,10 +4973,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4939,7 +5003,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: &37 + schema: &38 type: string requestBody: content: @@ -4958,7 +5022,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4985,11 +5049,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *37 + schema: *38 - name: access_token in: path required: true - schema: &39 + schema: &40 type: string responses: '204': @@ -5024,7 +5088,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *37 + schema: *38 requestBody: content: application/json: @@ -5046,11 +5110,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: &38 + value: &39 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -5089,10 +5153,10 @@ paths: site_admin: false '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5119,7 +5183,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *37 + schema: *38 requestBody: content: application/json: @@ -5141,14 +5205,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *38 + value: *39 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5172,7 +5236,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *37 + schema: *38 requestBody: content: application/json: @@ -5192,7 +5256,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5217,11 +5281,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *37 + schema: *38 - name: access_token in: path required: true - schema: *39 + schema: *40 responses: '200': description: response @@ -5234,14 +5298,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *38 + value: *39 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5268,11 +5332,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *37 + schema: *38 - name: access_token in: path required: true - schema: *39 + schema: *40 responses: '200': description: response @@ -5283,11 +5347,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *38 + value: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5314,11 +5378,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *37 + schema: *38 - name: access_token in: path required: true - schema: *39 + schema: *40 responses: '204': description: Empty response @@ -5363,21 +5427,21 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true examples: default: - value: *40 + value: *41 '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -5404,11 +5468,17 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -5421,11 +5491,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *41 + value: *42 headers: Link: example: ; rel="next", ; @@ -5435,13 +5505,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5517,11 +5587,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *42 + value: *43 headers: Location: example: https://api.github.com/authorizations/1 @@ -5529,24 +5599,24 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 '410': description: Gone - content: &47 + content: &48 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5580,7 +5650,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *37 + schema: *38 requestBody: content: application/json: @@ -5624,8 +5694,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: response-if-returning-an-existing-token: value: @@ -5666,11 +5736,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *42 + value: *43 headers: Location: example: https://api.github.com/authorizations/1 @@ -5678,15 +5748,15 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5718,7 +5788,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *37 + schema: *38 - name: fingerprint in: path required: true @@ -5763,8 +5833,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: response-if-returning-an-existing-token: value: @@ -5798,8 +5868,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: value: @@ -5826,7 +5896,7 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5857,7 +5927,7 @@ paths: description: authorization_id parameter in: path required: true - schema: &43 + schema: &44 type: integer responses: '200': @@ -5869,11 +5939,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: &44 + value: &45 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -5894,10 +5964,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5926,7 +5996,7 @@ paths: description: authorization_id parameter in: path required: true - schema: *43 + schema: *44 requestBody: content: application/json: @@ -5973,14 +6043,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *44 + value: *45 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -6010,7 +6080,7 @@ paths: description: authorization_id parameter in: path required: true - schema: *43 + schema: *44 responses: '204': description: Empty response @@ -6018,10 +6088,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -6053,7 +6123,7 @@ paths: title: Code Of Conduct description: Code Of Conduct type: object - properties: &45 + properties: &46 key: type: string example: contributor_covenant @@ -6119,7 +6189,7 @@ paths: type: string format: uri nullable: true - required: &46 + required: &47 - url - html_url - key @@ -6139,7 +6209,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6180,8 +6250,8 @@ paths: title: Code Of Conduct description: Code Of Conduct type: object - properties: *45 - required: *46 + properties: *46 + required: *47 examples: default: value: @@ -6240,12 +6310,12 @@ paths: html_url: http://contributor-covenant.org/version/1/4/ '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6350,21 +6420,21 @@ paths: self.save() '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *47 + content: *48 '415': description: Preview Header Missing - content: *29 + content: *30 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6662,12 +6732,12 @@ paths: this value with the enterprise id. in: path required: true - schema: &48 + schema: &49 type: string - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -6686,7 +6756,7 @@ paths: type: array items: type: object - properties: &49 + properties: &50 id: type: number name: @@ -6701,7 +6771,7 @@ paths: type: string allows_public_repositories: type: boolean - required: &50 + required: &51 - id - name - visibility @@ -6759,7 +6829,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 requestBody: content: application/json: @@ -6807,11 +6877,11 @@ paths: application/json: schema: type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: - value: &51 + value: &52 id: 2 name: octo-runner-group visibility: selected @@ -6844,12 +6914,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: &52 + schema: &53 type: integer responses: '200': @@ -6858,11 +6928,11 @@ paths: application/json: schema: type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: - value: *51 + value: *52 x-github: enabledForGitHubApps: false githubCloudOnly: false @@ -6887,12 +6957,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 requestBody: content: application/json: @@ -6920,8 +6990,8 @@ paths: application/json: schema: type: object - properties: *49 - required: *50 + properties: *50 + required: *51 examples: default: value: @@ -6956,12 +7026,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 responses: '204': description: Empty response @@ -6990,16 +7060,16 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -7020,8 +7090,8 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *53 - required: *54 + properties: *54 + required: *55 required: - total_count - organizations @@ -7066,12 +7136,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 requestBody: content: application/json: @@ -7119,17 +7189,17 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 - name: org_id description: Unique identifier of an organization. in: path required: true - schema: &55 + schema: &56 type: integer responses: '204': @@ -7158,17 +7228,17 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 - name: org_id description: Unique identifier of an organization. in: path required: true - schema: *55 + schema: *56 responses: '204': description: Empty response @@ -7197,16 +7267,16 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -7225,7 +7295,7 @@ paths: type: array items: type: object - properties: &57 + properties: &58 id: type: number name: @@ -7241,7 +7311,7 @@ paths: - runners examples: default: - value: &58 + value: &59 total_count: 2 runners: - id: 23 @@ -7283,12 +7353,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 requestBody: content: application/json: @@ -7336,17 +7406,17 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: &56 + schema: &57 type: integer responses: '204': @@ -7375,17 +7445,17 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *56 + schema: *57 responses: '204': description: Empty response @@ -7414,11 +7484,11 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -7437,10 +7507,10 @@ paths: type: array items: type: object - properties: *57 + properties: *58 examples: default: - value: *58 + value: *59 headers: Link: example: ; rel="next", ; @@ -7471,7 +7541,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 responses: '200': description: response @@ -7483,7 +7553,7 @@ paths: title: Runner Application description: Runner Application type: object - properties: &106 + properties: &107 os: type: string architecture: @@ -7492,14 +7562,14 @@ paths: type: string filename: type: string - required: &107 + required: &108 - os - architecture - download_url - filename examples: default: - value: &108 + value: &109 - os: osx architecture: x64 download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz @@ -7553,7 +7623,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 responses: '201': description: response @@ -7563,7 +7633,7 @@ paths: title: Authentication Token description: Authentication Token type: object - properties: &61 + properties: &62 token: description: The token used for authentication type: string @@ -7585,8 +7655,8 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 single_file: type: string example: config.yaml @@ -7598,12 +7668,12 @@ paths: enum: - all - selected - required: &62 + required: &63 - token - expires_at examples: default: - value: &109 + value: &110 token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' x-github: @@ -7640,7 +7710,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 responses: '201': description: response @@ -7650,11 +7720,11 @@ paths: title: Authentication Token description: Authentication Token type: object - properties: *61 - required: *62 + properties: *62 + required: *63 examples: default: - value: &110 + value: &111 token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' x-github: @@ -7682,12 +7752,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *56 + schema: *57 responses: '200': description: response @@ -7695,10 +7765,10 @@ paths: application/json: schema: type: object - properties: *57 + properties: *58 examples: default: - value: &111 + value: &112 id: 23 name: mac_runner os: macos @@ -7728,12 +7798,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *48 + schema: *49 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *56 + schema: *57 responses: '204': description: Empty response @@ -7759,7 +7829,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -7775,7 +7845,7 @@ paths: title: Event description: Event type: object - properties: &87 + properties: &88 id: type: string type: @@ -7785,7 +7855,7 @@ paths: title: Actor description: Actor type: object - properties: &63 + properties: &64 id: type: integer login: @@ -7801,7 +7871,7 @@ paths: avatar_url: type: string format: uri - required: &64 + required: &65 - id - login - gravatar_id @@ -7825,8 +7895,8 @@ paths: title: Actor description: Actor type: object - properties: *63 - required: *64 + properties: *64 + required: *65 payload: type: object properties: @@ -7884,8 +7954,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true labels: type: array @@ -7936,8 +8006,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assignees: type: array @@ -7945,8 +8015,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true milestone: @@ -7956,7 +8026,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &80 + properties: &81 url: type: string format: uri @@ -8001,8 +8071,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true open_issues: type: integer @@ -8028,7 +8098,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &81 + required: &82 - closed_issues - creator - description @@ -8100,7 +8170,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: &65 + enum: &66 - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER @@ -8120,8 +8190,8 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 performed_via_github_app: nullable: true allOf: @@ -8133,8 +8203,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true required: &284 - assignee @@ -8193,8 +8263,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -8212,7 +8282,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *65 + enum: *66 performed_via_github_app: nullable: true allOf: @@ -8224,13 +8294,13 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true reactions: title: Reaction Rollup type: object - properties: &82 + properties: &83 url: type: string format: uri @@ -8252,7 +8322,7 @@ paths: type: integer rocket: type: integer - required: &83 + required: &84 - url - total_count - "+1" @@ -8299,7 +8369,7 @@ paths: type: string format: date-time nullable: true - required: &88 + required: &89 - id - type - actor @@ -8311,7 +8381,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '503': description: Service Unavailable content: &229 @@ -8395,58 +8465,58 @@ paths: title: Link With Type description: Hypermedia Link with Type type: object - properties: &66 + properties: &67 href: type: string type: type: string - required: &67 + required: &68 - href - type user: title: Link With Type description: Hypermedia Link with Type type: object - properties: *66 - required: *67 + properties: *67 + required: *68 security_advisories: title: Link With Type description: Hypermedia Link with Type type: object - properties: *66 - required: *67 + properties: *67 + required: *68 current_user: title: Link With Type description: Hypermedia Link with Type type: object - properties: *66 - required: *67 + properties: *67 + required: *68 current_user_public: title: Link With Type description: Hypermedia Link with Type type: object - properties: *66 - required: *67 + properties: *67 + required: *68 current_user_actor: title: Link With Type description: Hypermedia Link with Type type: object - properties: *66 - required: *67 + properties: *67 + required: *68 current_user_organization: title: Link With Type description: Hypermedia Link with Type type: object - properties: *66 - required: *67 + properties: *67 + required: *68 current_user_organizations: type: array items: title: Link With Type description: Hypermedia Link with Type type: object - properties: *66 - required: *67 + properties: *67 + required: *68 required: - timeline - user @@ -8511,11 +8581,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -8531,7 +8601,7 @@ paths: title: Base Gist description: Base Gist type: object - properties: &69 + properties: &70 url: type: string format: uri @@ -8588,8 +8658,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true comments_url: type: string @@ -8600,8 +8670,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true truncated: type: boolean @@ -8611,7 +8681,7 @@ paths: history: type: array items: {} - required: &70 + required: &71 - id - node_id - url @@ -8630,7 +8700,7 @@ paths: - updated_at examples: default: - value: &71 + value: &72 - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits @@ -8682,7 +8752,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8750,7 +8820,7 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: &72 + properties: &73 url: type: string forks_url: @@ -8807,14 +8877,14 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true truncated: type: boolean examples: default: - value: &73 + value: &74 url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits @@ -8835,15 +8905,15 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8870,11 +8940,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -8890,11 +8960,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *69 - required: *70 + properties: *70 + required: *71 examples: default: - value: *71 + value: *72 headers: Link: example: ; rel="next", ; @@ -8902,12 +8972,12 @@ paths: schema: *6 '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8931,11 +9001,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -8951,11 +9021,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *69 - required: *70 + properties: *70 + required: *71 examples: default: - value: *71 + value: *72 headers: Link: example: ; rel="next", ; @@ -8963,12 +9033,12 @@ paths: schema: *6 '401': description: Requires Authentication - content: *32 + content: *33 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8990,7 +9060,7 @@ paths: description: gist_id parameter in: path required: true - schema: &74 + schema: &75 type: string responses: '200': @@ -9001,13 +9071,13 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *72 + properties: *73 examples: default: - value: *73 + value: *74 '403': description: Forbidden Gist - content: &78 + content: &79 application/json: schema: type: object @@ -9028,7 +9098,7 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified x-github: @@ -9053,7 +9123,7 @@ paths: description: gist_id parameter in: path required: true - schema: *74 + schema: *75 requestBody: content: application/json: @@ -9104,16 +9174,16 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *72 + properties: *73 examples: default: - value: *73 + value: *74 '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9134,18 +9204,18 @@ paths: description: gist_id parameter in: path required: true - schema: *74 + schema: *75 responses: '204': description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9167,11 +9237,11 @@ paths: description: gist_id parameter in: path required: true - schema: *74 + schema: *75 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -9187,7 +9257,7 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: &75 + properties: &76 id: type: integer example: 1 @@ -9209,8 +9279,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -9225,8 +9295,8 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *65 - required: &76 + enum: *66 + required: &77 - url - id - node_id @@ -9273,10 +9343,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9297,7 +9367,7 @@ paths: description: gist_id parameter in: path required: true - schema: *74 + schema: *75 requestBody: content: application/json: @@ -9320,11 +9390,11 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *75 - required: *76 + properties: *76 + required: *77 examples: default: - value: &77 + value: &78 id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== url: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 @@ -9360,10 +9430,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9385,12 +9455,12 @@ paths: description: gist_id parameter in: path required: true - schema: *74 + schema: *75 - name: comment_id description: comment_id parameter in: path required: true - schema: &79 + schema: &80 type: integer responses: '200': @@ -9401,19 +9471,19 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *75 - required: *76 + properties: *76 + required: *77 examples: default: - value: *77 + value: *78 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden Gist - content: *78 + content: *79 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9434,12 +9504,12 @@ paths: description: gist_id parameter in: path required: true - schema: *74 + schema: *75 - name: comment_id description: comment_id parameter in: path required: true - schema: *79 + schema: *80 requestBody: content: application/json: @@ -9462,14 +9532,14 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *75 - required: *76 + properties: *76 + required: *77 examples: default: - value: *77 + value: *78 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9490,12 +9560,12 @@ paths: description: gist_id parameter in: path required: true - schema: *74 + schema: *75 - name: comment_id description: comment_id parameter in: path required: true - schema: *79 + schema: *80 responses: '204': description: Empty response @@ -9503,10 +9573,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9528,11 +9598,11 @@ paths: description: gist_id parameter in: path required: true - schema: *74 + schema: *75 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -9562,8 +9632,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true change_status: type: object @@ -9620,12 +9690,12 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9647,11 +9717,11 @@ paths: description: gist_id parameter in: path required: true - schema: *74 + schema: *75 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -9667,7 +9737,7 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *72 + properties: *73 examples: default: value: @@ -9719,12 +9789,12 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9745,7 +9815,7 @@ paths: description: gist_id parameter in: path required: true - schema: *74 + schema: *75 responses: '201': description: response @@ -9755,8 +9825,8 @@ paths: title: Base Gist description: Base Gist type: object - properties: *69 - required: *70 + properties: *70 + required: *71 examples: default: value: @@ -9809,15 +9879,15 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9839,7 +9909,7 @@ paths: description: gist_id parameter in: path required: true - schema: *74 + schema: *75 responses: '204': description: Response if gist is starred @@ -9855,7 +9925,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9877,18 +9947,18 @@ paths: description: gist_id parameter in: path required: true - schema: *74 + schema: *75 responses: '204': description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9909,7 +9979,7 @@ paths: description: gist_id parameter in: path required: true - schema: *74 + schema: *75 responses: '204': description: Empty response @@ -9917,10 +9987,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9942,7 +10012,7 @@ paths: description: gist_id parameter in: path required: true - schema: *74 + schema: *75 - name: sha in: path required: true @@ -9957,19 +10027,19 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *72 + properties: *73 examples: default: - value: *73 + value: *74 '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10114,7 +10184,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -10138,8 +10208,8 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 repository_selection: type: string example: selected @@ -10267,12 +10337,12 @@ paths: schema: *6 '403': description: Forbidden - content: *31 + content: *32 '304': description: Not Modified '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -10346,6 +10416,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -10364,7 +10435,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: &120 + schema: &121 type: string - name: sort description: What to sort results by. Can be either `created`, `updated`, @@ -10382,19 +10453,14 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: &121 - type: string - enum: - - asc - - desc - default: desc + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: collab in: query required: false @@ -10418,7 +10484,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -10484,8 +10550,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true labels: description: Labels to associate with this issue; pass one or @@ -10525,8 +10591,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assignees: type: array @@ -10534,8 +10600,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true milestone: @@ -10544,8 +10610,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *80 - required: *81 + properties: *81 + required: *82 locked: type: boolean active_lock_reason: @@ -10597,8 +10663,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body_html: type: string @@ -10611,8 +10677,8 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 performed_via_github_app: nullable: true allOf: @@ -10623,20 +10689,20 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true author_association: title: author_association type: string example: OWNER description: How the author is associated with the repository. - enum: *65 + enum: *66 reactions: title: Reaction Rollup type: object - properties: *82 - required: *83 + properties: *83 + required: *84 required: &123 - assignee - closed_at @@ -10910,12 +10976,12 @@ paths: schema: *6 '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10951,7 +11017,11 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 responses: '200': description: response @@ -10963,8 +11033,8 @@ paths: title: License Simple description: License Simple type: object - properties: *84 - required: *85 + properties: *85 + required: *86 examples: default: value: @@ -11189,10 +11259,10 @@ paths: featured: true '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified x-github: @@ -11249,7 +11319,7 @@ paths: type: string X-CommonMarker-Version: example: 0.17.4 - schema: &86 + schema: &87 type: string content: text/html: @@ -11292,7 +11362,7 @@ paths: headers: X-CommonMarker-Version: example: 0.17.4 - schema: *86 + schema: *87 content: text/html: schema: @@ -11371,7 +11441,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -11387,14 +11457,14 @@ paths: title: Event description: Event type: object - properties: *87 - required: *88 + properties: *88 + required: *89 '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '304': description: Not Modified '301': @@ -11438,7 +11508,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -11450,7 +11520,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -11466,14 +11536,14 @@ paths: title: Thread description: Thread type: object - properties: &89 + properties: &90 id: type: string repository: title: Minimal Repository description: Minimal Repository type: object - properties: &115 + properties: &116 id: type: integer example: 1296269 @@ -11493,8 +11563,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true private: type: boolean @@ -11715,8 +11785,8 @@ paths: - title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 temp_clone_token: type: string delete_branch_on_merge: @@ -11748,7 +11818,7 @@ paths: watchers: type: integer example: 0 - required: &116 + required: &117 - archive_url - assignees_url - blobs_url @@ -11825,7 +11895,7 @@ paths: subscription_url: type: string example: https://api.github.com/notifications/threads/2/subscription - required: &90 + required: &91 - id - unread - reason @@ -11926,13 +11996,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11984,10 +12054,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12009,7 +12079,7 @@ paths: description: thread_id parameter in: path required: true - schema: &91 + schema: &92 type: integer responses: '200': @@ -12020,8 +12090,8 @@ paths: title: Thread description: Thread type: object - properties: *89 - required: *90 + properties: *90 + required: *91 examples: default: value: @@ -12108,10 +12178,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12132,7 +12202,7 @@ paths: description: thread_id parameter in: path required: true - schema: *91 + schema: *92 responses: '205': description: response @@ -12140,7 +12210,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12165,7 +12235,7 @@ paths: description: thread_id parameter in: path required: true - schema: *91 + schema: *92 responses: '200': description: response @@ -12175,7 +12245,7 @@ paths: title: Thread Subscription description: Thread Subscription type: object - properties: &92 + properties: &93 subscribed: type: boolean example: true @@ -12201,7 +12271,7 @@ paths: type: string format: uri example: https://api.github.com/repos/1 - required: &93 + required: &94 - created_at - ignored - reason @@ -12209,7 +12279,7 @@ paths: - subscribed examples: default: - value: &94 + value: &95 subscribed: true ignored: false reason: @@ -12220,10 +12290,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12249,7 +12319,7 @@ paths: description: thread_id parameter in: path required: true - schema: *91 + schema: *92 requestBody: content: application/json: @@ -12269,19 +12339,19 @@ paths: title: Thread Subscription description: Thread Subscription type: object - properties: *92 - required: *93 + properties: *93 + required: *94 examples: default: - value: *94 + value: *95 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12306,7 +12376,7 @@ paths: description: thread_id parameter in: path required: true - schema: *91 + schema: *92 responses: '204': description: Empty response @@ -12314,10 +12384,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12374,7 +12444,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 responses: '200': description: response @@ -12386,11 +12456,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *53 - required: *54 + properties: *54 + required: *55 examples: default: - value: &389 + value: &390 - login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= @@ -12433,7 +12503,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 responses: '200': description: response @@ -12443,7 +12513,7 @@ paths: title: Organization Full description: Organization Full type: object - properties: &96 + properties: &97 login: type: string example: github @@ -12606,7 +12676,7 @@ paths: updated_at: type: string format: date-time - required: &97 + required: &98 - login - url - id @@ -12720,7 +12790,7 @@ paths: seats: 5 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12752,7 +12822,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 requestBody: content: application/json: @@ -12882,8 +12952,8 @@ paths: title: Organization Full description: Organization Full type: object - properties: *96 - required: *97 + properties: *97 + required: *98 examples: default: value: @@ -12943,13 +13013,13 @@ paths: - title: Validation Error description: Validation Error type: object - required: *98 - properties: *99 + required: *99 + properties: *100 - title: Validation Error Simple description: Validation Error Simple type: object - required: *100 - properties: *101 + required: *101 + properties: *102 '409': description: Conflict content: &244 @@ -12958,10 +13028,10 @@ paths: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -12993,11 +13063,11 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -13019,7 +13089,7 @@ paths: type: array items: type: object - properties: &102 + properties: &103 id: type: number name: @@ -13041,7 +13111,7 @@ paths: type: boolean allows_public_repositories: type: boolean - required: &103 + required: &104 - id - name - visibility @@ -13100,7 +13170,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 requestBody: content: application/json: @@ -13150,11 +13220,11 @@ paths: application/json: schema: type: object - properties: *102 - required: *103 + properties: *103 + required: *104 examples: default: - value: &104 + value: &105 id: 2 name: octo-runner-group visibility: selected @@ -13185,12 +13255,12 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 responses: '200': description: response @@ -13198,8 +13268,8 @@ paths: application/json: schema: type: object - properties: *102 - required: *103 + properties: *103 + required: *104 examples: default: value: @@ -13232,12 +13302,12 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 requestBody: content: application/json: @@ -13266,11 +13336,11 @@ paths: application/json: schema: type: object - properties: *102 - required: *103 + properties: *103 + required: *104 examples: default: - value: *104 + value: *105 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -13292,12 +13362,12 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 responses: '204': description: Empty response @@ -13326,12 +13396,20 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *31 responses: '200': description: response @@ -13351,11 +13429,11 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: default: - value: &385 + value: &386 total_count: 1 repositories: - id: 1296269 @@ -13495,12 +13573,12 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 requestBody: content: application/json: @@ -13544,16 +13622,16 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 - name: repository_id in: path required: true - schema: &105 + schema: &106 type: integer responses: '204': @@ -13579,16 +13657,16 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 - name: repository_id in: path required: true - schema: *105 + schema: *106 responses: '204': description: Empty response @@ -13614,16 +13692,16 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -13645,10 +13723,10 @@ paths: type: array items: type: object - properties: *57 + properties: *58 examples: default: - value: *58 + value: *59 headers: Link: example: ; rel="next", ; @@ -13675,12 +13753,12 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 requestBody: content: application/json: @@ -13724,17 +13802,17 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *56 + schema: *57 responses: '204': description: Empty response @@ -13759,17 +13837,17 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *52 + schema: *53 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *56 + schema: *57 responses: '204': description: Empty response @@ -13796,11 +13874,11 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -13822,10 +13900,10 @@ paths: type: array items: type: object - properties: *57 + properties: *58 examples: default: - value: *58 + value: *59 headers: Link: example: ; rel="next", ; @@ -13854,7 +13932,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 responses: '200': description: response @@ -13866,11 +13944,11 @@ paths: title: Runner Application description: Runner Application type: object - properties: *106 - required: *107 + properties: *107 + required: *108 examples: default: - value: *108 + value: *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13902,7 +13980,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 responses: '201': description: response @@ -13912,11 +13990,11 @@ paths: title: Authentication Token description: Authentication Token type: object - properties: *61 - required: *62 + properties: *62 + required: *63 examples: default: - value: *109 + value: *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13949,7 +14027,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 responses: '201': description: response @@ -13959,11 +14037,11 @@ paths: title: Authentication Token description: Authentication Token type: object - properties: *61 - required: *62 + properties: *62 + required: *63 examples: default: - value: *110 + value: *111 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13987,12 +14065,12 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *56 + schema: *57 responses: '200': description: response @@ -14000,10 +14078,10 @@ paths: application/json: schema: type: object - properties: *57 + properties: *58 examples: default: - value: *111 + value: *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14026,12 +14104,12 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *56 + schema: *57 responses: '204': description: Empty response @@ -14058,11 +14136,11 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -14086,7 +14164,7 @@ paths: title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object - properties: &112 + properties: &113 name: description: The name of the secret. example: SECRET_TOKEN @@ -14108,7 +14186,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/org/secrets/my_secret/repositories - required: &113 + required: &114 - name - created_at - updated_at @@ -14159,7 +14237,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 responses: '200': description: response @@ -14221,12 +14299,12 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: secret_name description: secret_name parameter in: path required: true - schema: &114 + schema: &115 type: string responses: '200': @@ -14237,8 +14315,8 @@ paths: title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object - properties: *112 - required: *113 + properties: *113 + required: *114 examples: default: value: @@ -14341,12 +14419,12 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: secret_name description: secret_name parameter in: path required: true - schema: *114 + schema: *115 requestBody: content: application/json: @@ -14420,12 +14498,12 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: secret_name description: secret_name parameter in: path required: true - schema: *114 + schema: *115 responses: '204': description: Empty response @@ -14452,12 +14530,20 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: secret_name description: secret_name parameter in: path required: true - schema: *114 + schema: *115 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *31 responses: '200': description: response @@ -14477,8 +14563,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 examples: default: value: @@ -14574,12 +14660,12 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: secret_name description: secret_name parameter in: path required: true - schema: *114 + schema: *115 requestBody: content: application/json: @@ -14628,12 +14714,12 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: secret_name description: secret_name parameter in: path required: true - schema: *114 + schema: *115 - name: repository_id in: path required: true @@ -14668,12 +14754,12 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: secret_name description: secret_name parameter in: path required: true - schema: *114 + schema: *115 - name: repository_id in: path required: true @@ -14704,11 +14790,11 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -14724,8 +14810,8 @@ paths: title: Event description: Event type: object - properties: *87 - required: *88 + properties: *88 + required: *89 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14746,11 +14832,11 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -14766,7 +14852,7 @@ paths: title: Org Hook description: Org Hook type: object - properties: &117 + properties: &118 id: type: integer example: 1 @@ -14816,7 +14902,7 @@ paths: example: '2011-09-06T17:26:27Z' type: type: string - required: &118 + required: &119 - id - url - type @@ -14851,7 +14937,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14872,7 +14958,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 requestBody: content: application/json: @@ -14955,11 +15041,11 @@ paths: title: Org Hook description: Org Hook type: object - properties: *117 - required: *118 + properties: *118 + required: *119 examples: default: - value: &119 + value: &120 id: 1 url: https://api.github.com/orgs/octocat/hooks/1 ping_url: https://api.github.com/orgs/octocat/hooks/1/pings @@ -14981,10 +15067,10 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15006,7 +15092,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: hook_id in: path required: true @@ -15020,14 +15106,14 @@ paths: title: Org Hook description: Org Hook type: object - properties: *117 - required: *118 + properties: *118 + required: *119 examples: default: - value: *119 + value: *120 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15051,7 +15137,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: hook_id in: path required: true @@ -15124,8 +15210,8 @@ paths: title: Org Hook description: Org Hook type: object - properties: *117 - required: *118 + properties: *118 + required: *119 examples: default: value: @@ -15144,10 +15230,10 @@ paths: type: Organization '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15167,7 +15253,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: hook_id in: path required: true @@ -15177,7 +15263,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15199,7 +15285,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: hook_id in: path required: true @@ -15209,7 +15295,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15233,7 +15319,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 responses: '200': description: response @@ -15243,8 +15329,8 @@ paths: title: Installation description: Installation type: object - properties: *22 - required: *23 + properties: *23 + required: *24 examples: default: value: &279 @@ -15308,11 +15394,11 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -15336,8 +15422,8 @@ paths: title: Installation description: Installation type: object - properties: *22 - required: *23 + properties: *23 + required: *24 examples: default: value: @@ -15413,7 +15499,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: filter description: "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you @@ -15429,6 +15515,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -15447,7 +15534,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *120 + schema: *121 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -15464,18 +15551,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *121 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -15504,7 +15591,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -15537,7 +15624,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: filter description: "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -15567,7 +15654,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -15583,8 +15670,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -15621,7 +15708,7 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15642,7 +15729,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: username in: path required: true @@ -15681,7 +15768,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: username in: path required: true @@ -15691,7 +15778,7 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15713,7 +15800,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: username in: path required: true @@ -15746,16 +15833,16 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *53 - required: *54 + properties: *54 + required: *55 user: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true permissions: type: object @@ -15891,10 +15978,10 @@ paths: site_admin: false '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15926,7 +16013,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: username in: path required: true @@ -16039,10 +16126,10 @@ paths: site_admin: false '422': description: Validation Failed - content: *36 + content: *37 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16065,7 +16152,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: username in: path required: true @@ -16075,10 +16162,10 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16099,7 +16186,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: filter description: "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -16115,7 +16202,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -16131,8 +16218,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -16165,7 +16252,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: username in: path required: true @@ -16199,7 +16286,7 @@ paths: documentation_url: https://docs.github.com/enterprise-server@2.22/rest/reference/orgs#convert-member-to-outside-collaborator '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16220,7 +16307,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: username in: path required: true @@ -16268,7 +16355,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: per_page description: Results per page (max 100) in: query @@ -16277,6 +16364,22 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + description: The sort order for the response collection. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -16335,11 +16438,11 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -16386,11 +16489,11 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -16451,11 +16554,11 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -16500,7 +16603,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: state description: Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. @@ -16516,7 +16619,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -16579,8 +16682,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -16688,7 +16791,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 requestBody: content: application/json: @@ -16753,16 +16856,16 @@ paths: updated_at: '2014-03-04T18:58:10Z' '401': description: Requires Authentication - content: *32 + content: *33 '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *47 + content: *48 '422': description: Validation Failed content: *130 @@ -16794,11 +16897,11 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -16814,8 +16917,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -16845,7 +16948,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: username in: path required: true @@ -16877,7 +16980,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: username in: path required: true @@ -16887,7 +16990,7 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -16907,7 +17010,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: username in: path required: true @@ -16935,7 +17038,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: type description: 'Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. @@ -16980,7 +17083,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -16996,8 +17099,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 examples: default: value: &157 @@ -17264,7 +17367,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 requestBody: content: application/json: @@ -17385,8 +17488,8 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: default: value: &263 @@ -17513,10 +17616,10 @@ paths: type: string '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17555,11 +17658,11 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -17706,7 +17809,7 @@ paths: schema: *6 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17729,7 +17832,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 requestBody: content: application/json: @@ -17874,8 +17977,8 @@ paths: title: Organization Full description: Organization Full type: object - properties: *96 - required: *97 + properties: *97 + required: *98 ldap_dn: description: Distinguished Name (DN) that team maps to within LDAP environment @@ -17946,10 +18049,10 @@ paths: ldap_dn: uid=asdf,ou=users,dc=github,dc=com '422': description: Validation Failed - content: *36 + content: *37 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17973,7 +18076,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -17997,7 +18100,7 @@ paths: value: *137 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18020,7 +18123,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -18112,7 +18215,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -18144,7 +18247,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -18154,15 +18257,21 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *121 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: pinned + in: query + required: false + description: Pinned discussions only filter + schema: + type: string responses: '200': description: response @@ -18182,8 +18291,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: description: The main text of the discussion. @@ -18254,8 +18363,8 @@ paths: reactions: title: Reaction Rollup type: object - properties: *82 - required: *83 + properties: *83 + required: *84 required: &140 - author - body @@ -18276,7 +18385,7 @@ paths: - url examples: default: - value: &363 + value: &364 - author: login: octocat id: 1 @@ -18363,7 +18472,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -18490,7 +18599,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -18548,7 +18657,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -18586,7 +18695,7 @@ paths: required: *140 examples: default: - value: &364 + value: &365 author: login: octocat id: 1 @@ -18666,7 +18775,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -18702,7 +18811,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -18716,11 +18825,11 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *121 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -18743,8 +18852,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: description: The main text of the comment. @@ -18794,8 +18903,8 @@ paths: reactions: title: Reaction Rollup type: object - properties: *82 - required: *83 + properties: *83 + required: *84 required: &144 - author - body @@ -18811,7 +18920,7 @@ paths: - url examples: default: - value: &365 + value: &366 - author: login: octocat id: 1 @@ -18892,7 +19001,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -19004,7 +19113,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -19065,7 +19174,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -19105,7 +19214,7 @@ paths: required: *144 examples: default: - value: &366 + value: &367 author: login: octocat id: 1 @@ -19179,7 +19288,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -19219,7 +19328,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -19252,7 +19361,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -19282,8 +19391,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true content: description: The reaction to use @@ -19371,7 +19480,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -19479,7 +19588,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -19534,7 +19643,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -19563,7 +19672,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -19622,7 +19731,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -19703,7 +19812,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -19753,7 +19862,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -19775,7 +19884,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -19791,8 +19900,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -19829,7 +19938,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -19869,19 +19978,19 @@ paths: examples: response-if-user-has-an-active-membership-with-team: summary: Response if user has an active membership with team - value: &367 + value: &368 url: https://api.github.com/teams/1/memberships/octocat role: member state: active response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer - value: &368 + value: &369 url: https://api.github.com/teams/1/memberships/octocat role: maintainer state: active response-if-user-has-a-pending-membership-with-team: summary: Response if user has a pending membership with team - value: &369 + value: &370 url: https://api.github.com/teams/1/memberships/octocat role: member state: pending @@ -19917,7 +20026,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -19958,13 +20067,13 @@ paths: examples: response-if-users-membership-with-team-is-now-active: summary: Response if user's membership with team is now active - value: &370 + value: &371 url: https://api.github.com/teams/1/memberships/octocat role: member state: active response-if-users-membership-with-team-is-now-pending: summary: Response if user's membership with team is now pending - value: &371 + value: &372 url: https://api.github.com/teams/1/memberships/octocat role: member state: pending @@ -20024,7 +20133,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -20062,7 +20171,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -20071,7 +20180,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -20113,8 +20222,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -20158,7 +20267,7 @@ paths: - permissions examples: default: - value: &372 + value: &373 - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 html_url: https://github.com/orgs/api-playground/projects/1 @@ -20231,7 +20340,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -20255,7 +20364,7 @@ paths: required: *155 examples: default: - value: &373 + value: &374 owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 html_url: https://github.com/orgs/api-playground/projects/1 @@ -20324,7 +20433,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -20405,7 +20514,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -20441,7 +20550,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -20450,7 +20559,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -20466,8 +20575,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 examples: default: value: *157 @@ -20503,7 +20612,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -20526,7 +20635,7 @@ paths: title: Team Repository description: A team's access to a repository. type: object - properties: &374 + properties: &375 id: description: Unique identifier of the repository example: 42 @@ -20547,8 +20656,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *84 - required: *85 + properties: *85 + required: *86 forks: type: integer permissions: @@ -20574,8 +20683,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true private: description: Whether the repository is private or public. @@ -20831,8 +20940,8 @@ paths: - title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 temp_clone_token: type: string allow_squash_merge: @@ -20861,7 +20970,7 @@ paths: type: integer master_branch: type: string - required: &375 + required: &376 - archive_url - assignees_url - blobs_url @@ -21197,7 +21306,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -21264,7 +21373,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -21304,7 +21413,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: team_slug description: team_slug parameter in: path @@ -21313,7 +21422,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -21334,7 +21443,7 @@ paths: required: *161 examples: response-if-child-teams-exist: - value: &376 + value: &377 - id: 2 node_id: MDQ6VGVhbTI= url: https://api.github.com/teams/2 @@ -21417,8 +21526,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -21490,13 +21599,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21558,13 +21667,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed content: *130 @@ -21618,10 +21727,10 @@ paths: type: string '401': description: Requires Authentication - content: *32 + content: *33 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21706,7 +21815,7 @@ paths: type: string '401': description: Requires Authentication - content: *32 + content: *33 '503': description: Service Unavailable content: @@ -21731,7 +21840,7 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21827,13 +21936,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21892,10 +22001,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21931,10 +22040,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21979,7 +22088,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -22038,10 +22147,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22119,10 +22228,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '422': description: Validation Failed content: @@ -22132,13 +22241,13 @@ paths: - title: Validation Error description: Validation Error type: object - required: *98 - properties: *99 + required: *99 + properties: *100 - title: Validation Error Simple description: Validation Error Simple type: object - required: *100 - properties: *101 + required: *101 + properties: *102 '503': description: Service Unavailable content: @@ -22216,13 +22325,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed content: *130 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22302,10 +22411,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22403,10 +22512,10 @@ paths: type: string '401': description: Requires Authentication - content: *32 + content: *33 '410': description: Gone - content: *47 + content: *48 '422': description: Validation Failed content: *130 @@ -22460,13 +22569,13 @@ paths: type: string '401': description: Requires Authentication - content: *32 + content: *33 '410': description: Gone - content: *47 + content: *48 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22518,7 +22627,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -22534,8 +22643,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -22547,21 +22656,21 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22615,21 +22724,21 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22669,19 +22778,19 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *36 + content: *37 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22735,8 +22844,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true required: &239 - permission @@ -22766,21 +22875,21 @@ paths: site_admin: false '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22812,7 +22921,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -22850,10 +22959,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22917,13 +23026,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed content: *130 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23060,7 +23169,7 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23092,16 +23201,16 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '410': description: Gone - content: *47 + content: *48 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23171,8 +23280,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true private: type: boolean @@ -23425,8 +23534,8 @@ paths: - title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 temp_clone_token: type: string nullable: true @@ -23451,29 +23560,29 @@ paths: - title: License Simple description: License Simple type: object - properties: *84 - required: *85 + properties: *85 + required: *86 organization: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true parent: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 source: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 forks: type: integer master_branch: @@ -24563,10 +24672,10 @@ paths: url: https://api.github.com/repos/github/docs/community/code_of_conduct '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '301': description: Moved Permanently x-github: @@ -25212,13 +25321,13 @@ paths: watchers: 1 '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25285,7 +25394,7 @@ paths: documentation_url: https://docs.github.com/enterprise-server@2.22/rest/reference/repos#delete-a-repository '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25317,7 +25426,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -25865,7 +25974,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -25887,10 +25996,10 @@ paths: type: array items: type: object - properties: *57 + properties: *58 examples: default: - value: *58 + value: *59 headers: Link: example: ; rel="next", ; @@ -25935,11 +26044,11 @@ paths: title: Runner Application description: Runner Application type: object - properties: *106 - required: *107 + properties: *107 + required: *108 examples: default: - value: *108 + value: *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25979,11 +26088,11 @@ paths: title: Authentication Token description: Authentication Token type: object - properties: *61 - required: *62 + properties: *62 + required: *63 examples: default: - value: *109 + value: *110 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26023,11 +26132,11 @@ paths: title: Authentication Token description: Authentication Token type: object - properties: *61 - required: *62 + properties: *62 + required: *63 examples: default: - value: *110 + value: *111 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26061,7 +26170,7 @@ paths: description: Unique identifier of the self-hosted runner. in: path required: true - schema: *56 + schema: *57 responses: '200': description: response @@ -26069,10 +26178,10 @@ paths: application/json: schema: type: object - properties: *57 + properties: *58 examples: default: - value: *111 + value: *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26105,7 +26214,7 @@ paths: description: Unique identifier of the self-hosted runner. in: path required: true - schema: *56 + schema: *57 responses: '204': description: Empty response @@ -26186,7 +26295,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -26407,14 +26516,14 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 head_repository: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 head_repository_id: type: integer example: 5 @@ -26902,7 +27011,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -27021,7 +27130,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -27273,7 +27382,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -27403,7 +27512,7 @@ paths: description: secret_name parameter in: path required: true - schema: *114 + schema: *115 responses: '200': description: response @@ -27524,7 +27633,7 @@ paths: description: secret_name parameter in: path required: true - schema: *114 + schema: *115 requestBody: content: application/json: @@ -27579,7 +27688,7 @@ paths: description: secret_name parameter in: path required: true - schema: *114 + schema: *115 responses: '204': description: Empty response @@ -27614,7 +27723,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -27911,7 +28020,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -27974,7 +28083,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -27990,8 +28099,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -28003,7 +28112,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28051,7 +28160,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28088,7 +28197,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -28178,8 +28287,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true teams: description: The list of teams with review dismissal @@ -28470,7 +28579,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28621,8 +28730,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true committer: nullable: true @@ -28630,8 +28739,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true parents: type: array @@ -28826,10 +28935,10 @@ paths: protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection '415': description: Preview Header Missing - content: *29 + content: *30 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29007,7 +29116,7 @@ paths: enabled: true '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29269,8 +29378,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true teams: type: array @@ -29348,16 +29457,16 @@ paths: - url '403': description: Forbidden - content: *31 + content: *32 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed content: *130 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29404,7 +29513,7 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29541,7 +29650,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29734,7 +29843,7 @@ paths: value: *209 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29781,7 +29890,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29836,7 +29945,7 @@ paths: enabled: true '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29893,7 +30002,7 @@ paths: value: *210 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29939,7 +30048,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30003,7 +30112,7 @@ paths: contexts_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30072,10 +30181,10 @@ paths: value: *213 '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30161,7 +30270,7 @@ paths: - continuous-integration/travis-ci '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30226,13 +30335,13 @@ paths: - continuous-integration/jenkins '422': description: Validation Failed - content: *36 + content: *37 '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30297,10 +30406,10 @@ paths: - continuous-integration/travis-ci '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30365,10 +30474,10 @@ paths: - continuous-integration/travis-ci '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30489,7 +30598,7 @@ paths: - pull_request '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30575,8 +30684,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true examples: default: @@ -30619,7 +30728,7 @@ paths: - pull_request '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30688,15 +30797,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true examples: default: value: *214 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30766,15 +30875,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true examples: default: value: *214 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30844,15 +30953,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true examples: default: value: *214 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30907,7 +31016,7 @@ paths: value: *215 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30980,7 +31089,7 @@ paths: value: *215 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31054,7 +31163,7 @@ paths: value: *215 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31128,7 +31237,7 @@ paths: value: *215 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31175,15 +31284,15 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: value: *127 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31248,15 +31357,15 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: value: *127 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31322,15 +31431,15 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: value: *127 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31396,15 +31505,15 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: value: *127 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31821,8 +31930,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true pull_requests: items: @@ -31898,8 +32007,8 @@ paths: They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true required: - id @@ -32549,7 +32658,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -32753,15 +32862,15 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true repository: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 created_at: type: string format: date-time @@ -33185,8 +33294,8 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: default: value: @@ -33440,7 +33549,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -33620,7 +33729,7 @@ paths: The response includes a `most_recent_instance` object. This provides details of the most recent instance of this alert - for the the default branch or for the specified Git reference + for the default branch or for the specified Git reference (if you used `ref` in the request). tags: - code-scanning @@ -33665,7 +33774,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply @@ -33674,7 +33783,9 @@ paths: required: false schema: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. - name: state description: Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state. @@ -33685,6 +33796,7 @@ paths: description: State of a code scanning alert. enum: &228 - open + - closed - dismissed - fixed responses: @@ -33736,8 +33848,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true dismissed_at: type: string @@ -33805,8 +33917,9 @@ paths: properties: &232 ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. analysis_key: type: string description: Identifies the configuration under which the @@ -33963,10 +34076,10 @@ paths: instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '503': description: Service Unavailable content: *229 @@ -34058,8 +34171,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true dismissed_at: type: string @@ -34200,10 +34313,10 @@ paths: instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '503': description: Service Unavailable content: *229 @@ -34346,10 +34459,10 @@ paths: instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '503': description: Service Unavailable content: *229 @@ -34415,7 +34528,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` @@ -34424,7 +34537,9 @@ paths: required: false schema: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. @@ -34446,8 +34561,9 @@ paths: properties: ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. commit_sha: description: The SHA of the commit to which the analysis you are uploading relates. @@ -34550,10 +34666,10 @@ paths: deletable: true '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '503': description: Service Unavailable content: *229 @@ -34568,6 +34684,10 @@ paths: description: |- Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. + There are two places where you can upload code scanning results. + - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)." + - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." + You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example: ``` @@ -34609,8 +34729,9 @@ paths: pattern: "^[0-9a-fA-F]+$" ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. sarif: description: A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) @@ -34670,10 +34791,10 @@ paths: description: Response if the sarif field is invalid '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '413': description: Response if the sarif field is too large '503': @@ -34724,7 +34845,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -34867,7 +34988,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34990,16 +35111,16 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 invitee: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true inviter: nullable: true @@ -35007,8 +35128,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true permissions: description: The permission associated with the invitation. @@ -35162,10 +35283,10 @@ paths: description: Response when person is already a collaborator '422': description: Validation Failed - content: *36 + content: *37 '403': description: Forbidden - content: *31 + content: *32 x-github: triggersNotification: true githubCloudOnly: false @@ -35264,7 +35385,7 @@ paths: site_admin: false '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35296,7 +35417,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -35342,8 +35463,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -35356,12 +35477,12 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *65 + enum: *66 reactions: title: Reaction Rollup type: object - properties: *82 - required: *83 + properties: *83 + required: *84 required: &241 - url - html_url @@ -35454,7 +35575,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 responses: '200': description: response @@ -35502,7 +35623,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35541,7 +35662,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 requestBody: content: application/json: @@ -35602,7 +35723,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35631,13 +35752,13 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 responses: '204': description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35667,7 +35788,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. @@ -35687,7 +35808,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -35716,10 +35837,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35760,7 +35881,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 requestBody: content: application/json: @@ -35815,10 +35936,10 @@ paths: value: *150 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35861,7 +35982,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 - name: reaction_id in: path required: true @@ -35957,7 +36078,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: until description: 'Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -35968,11 +36089,25 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -36068,7 +36203,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 '400': description: Bad Request content: &262 @@ -36077,7 +36212,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 application/scim+json: schema: title: Scim Error @@ -36104,7 +36239,7 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 '409': description: Conflict content: *244 @@ -36183,10 +36318,10 @@ paths: protected: false '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36229,7 +36364,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -36345,10 +36480,10 @@ paths: type: string '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *36 + content: *37 x-github: triggersNotification: true githubCloudOnly: false @@ -36390,7 +36525,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -36470,8 +36605,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: type: string @@ -36502,8 +36637,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *80 - required: *81 + properties: *81 + required: *82 active_lock_reason: type: string example: too heated @@ -36536,8 +36671,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assignees: type: array @@ -36545,8 +36680,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true requested_reviewers: @@ -36555,8 +36690,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true requested_teams: @@ -36581,8 +36716,8 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 sha: type: string user: @@ -36591,8 +36726,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true required: - label @@ -36611,8 +36746,8 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 sha: type: string user: @@ -36621,8 +36756,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true required: - label @@ -36698,7 +36833,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *65 + enum: *66 draft: description: Indicates whether or not the pull request is a draft. @@ -37216,7 +37351,7 @@ paths: schema: *6 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37285,8 +37420,16 @@ paths: in: path required: true schema: *159 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *31 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -37389,10 +37532,10 @@ paths: ..... '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 '500': description: Internal Error content: *250 @@ -37425,7 +37568,7 @@ paths: required: true schema: *159 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -37456,11 +37599,16 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -37526,7 +37674,7 @@ paths: required: true schema: *159 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -37547,7 +37695,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -37794,12 +37942,20 @@ paths: required: true schema: *159 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - name: per_page + description: Results per page (max 100). + in: query + schema: *31 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 responses: '200': description: response @@ -37867,8 +38023,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 commit_url: type: string format: uri @@ -37981,7 +38137,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38011,7 +38167,7 @@ paths: required: true schema: *159 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -38020,7 +38176,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -38036,7 +38192,7 @@ paths: title: Status description: The status of a commit. type: object - properties: &350 + properties: &351 url: type: string avatar_url: @@ -38062,10 +38218,10 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true - required: &351 + required: &352 - url - avatar_url - id @@ -38557,7 +38713,7 @@ paths: content: *250 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38613,7 +38769,7 @@ paths: required: true schema: *159 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -39095,10 +39251,10 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '302': description: Found x-github: @@ -39126,7 +39282,7 @@ paths: required: true schema: *159 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -39415,10 +39571,10 @@ paths: payload: '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *36 + content: *37 '409': description: Conflict content: *244 @@ -39454,7 +39610,7 @@ paths: required: true schema: *159 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -39548,10 +39704,10 @@ paths: payload: '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 '409': description: Conflict content: *244 @@ -39595,7 +39751,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -39697,10 +39853,10 @@ paths: description: Response if repository is empty '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39755,10 +39911,11 @@ paths: schema: type: string default: none + nullable: true - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -39819,8 +39976,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -39858,8 +40015,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true required: &257 - id @@ -40204,7 +40361,7 @@ paths: message: 'Conflict: Commit status checks failed for topic-branch.' '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40296,7 +40453,7 @@ paths: production_environment: true '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40348,7 +40505,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed content: *130 @@ -40385,7 +40542,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -40430,8 +40587,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true description: description: A short description of the status. @@ -40489,8 +40646,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true required: &260 - id @@ -40546,7 +40703,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40735,7 +40892,7 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40805,10 +40962,10 @@ paths: value: *261 '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40888,7 +41045,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40917,7 +41074,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -40933,8 +41090,8 @@ paths: title: Event description: Event type: object - properties: *87 - required: *88 + properties: *88 + required: *89 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40970,15 +41127,30 @@ paths: - newest - oldest - stargazers + - watchers default: newest - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -40990,8 +41162,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 examples: default: value: @@ -41138,11 +41310,26 @@ paths: in: path required: true schema: *159 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -41157,8 +41344,8 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: default: value: *263 @@ -41167,13 +41354,13 @@ paths: content: *262 '422': description: Validation Failed - content: *36 + content: *37 '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41247,16 +41434,16 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 '409': description: Conflict content: *244 '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41334,13 +41521,13 @@ paths: node_id: Q29udGVudCBvZiB0aGUgYmxvYg== '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *36 + content: *37 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41654,10 +41841,10 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41760,7 +41947,7 @@ paths: payload: '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41794,7 +41981,7 @@ paths: required: true schema: *159 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -41803,7 +41990,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -41901,7 +42088,7 @@ paths: required: true schema: *159 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -41930,7 +42117,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42002,7 +42189,7 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42029,7 +42216,7 @@ paths: required: true schema: *159 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -42071,7 +42258,7 @@ paths: value: *268 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42097,7 +42284,7 @@ paths: required: true schema: *159 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -42108,7 +42295,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42315,7 +42502,7 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42390,7 +42577,7 @@ paths: value: *273 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42576,13 +42763,13 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42616,6 +42803,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -42677,10 +42865,10 @@ paths: truncated: false '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42709,7 +42897,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -42877,7 +43065,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43019,13 +43207,13 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *36 + content: *37 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43072,7 +43260,7 @@ paths: value: *278 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43194,10 +43382,10 @@ paths: value: *278 '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43231,7 +43419,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43267,7 +43455,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43305,7 +43493,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43343,8 +43531,8 @@ paths: title: Installation description: Installation type: object - properties: *22 - required: *23 + properties: *23 + required: *24 examples: default: value: *279 @@ -43352,7 +43540,7 @@ paths: description: Moved Permanently '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -43382,7 +43570,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -43403,7 +43591,7 @@ paths: required: *281 examples: default: - value: &391 + value: &392 - id: 1 repository: id: 1296269 @@ -43802,7 +43990,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *120 + schema: *121 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -43819,18 +44007,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *121 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -43984,10 +44172,10 @@ paths: description: Moved Permanently '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44256,19 +44444,19 @@ paths: type: string '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *36 + content: *37 '503': description: Service Unavailable content: *229 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *47 + content: *48 x-github: triggersNotification: true githubCloudOnly: false @@ -44300,7 +44488,7 @@ paths: (when it was last pushed to). in: query required: false - schema: &322 + schema: &329 type: string enum: - created @@ -44321,11 +44509,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -44382,10 +44570,10 @@ paths: schema: *6 '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44425,7 +44613,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 responses: '200': description: response @@ -44471,7 +44659,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44510,7 +44698,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 requestBody: content: application/json: @@ -44541,7 +44729,7 @@ paths: value: *287 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44570,7 +44758,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 responses: '204': description: Empty response @@ -44603,7 +44791,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. @@ -44623,7 +44811,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -44652,10 +44840,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44696,7 +44884,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 requestBody: content: application/json: @@ -44751,10 +44939,10 @@ paths: value: *150 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44797,7 +44985,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 - name: reaction_id in: path required: true @@ -44843,7 +45031,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -44876,8 +45064,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true event: type: string @@ -44920,8 +45108,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assigner: nullable: true @@ -44929,8 +45117,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true review_requester: nullable: true @@ -44938,8 +45126,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true requested_reviewer: nullable: true @@ -44947,8 +45135,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true requested_team: title: Team @@ -45026,7 +45214,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *65 + enum: *66 lock_reason: type: string nullable: true @@ -45200,7 +45388,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45407,13 +45595,13 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *47 + content: *48 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45484,10 +45672,10 @@ paths: description: Moved Permanently '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *47 + content: *48 '304': description: Not Modified x-github: @@ -45622,21 +45810,21 @@ paths: value: *290 '422': description: Validation Failed - content: *36 + content: *37 '503': description: Service Unavailable content: *229 '403': description: Forbidden - content: *31 + content: *32 '301': description: Moved Permanently '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *47 + content: *48 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45955,11 +46143,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -45988,10 +46176,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *47 + content: *48 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46070,16 +46258,16 @@ paths: type: string '403': description: Forbidden - content: *31 + content: *32 '410': description: Gone - content: *47 + content: *48 '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 x-github: triggersNotification: true githubCloudOnly: false @@ -46114,7 +46302,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -46141,8 +46329,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true event: type: string @@ -46174,7 +46362,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *65 + enum: *66 body: type: string example: '":+1:"' @@ -46234,7 +46422,7 @@ paths: schema: *6 '410': description: Gone - content: *47 + content: *48 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46277,7 +46465,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -46320,7 +46508,7 @@ paths: schema: *6 '410': description: Gone - content: *47 + content: *48 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46389,10 +46577,10 @@ paths: value: *296 '410': description: Gone - content: *47 + content: *48 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46460,10 +46648,10 @@ paths: value: *296 '410': description: Gone - content: *47 + content: *48 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46498,7 +46686,7 @@ paths: description: Empty response '410': description: Gone - content: *47 + content: *48 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46562,10 +46750,10 @@ paths: default: true '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *47 + content: *48 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46621,16 +46809,16 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 '410': description: Gone - content: *47 + content: *48 '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46665,10 +46853,10 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46718,7 +46906,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -46747,13 +46935,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *47 + content: *48 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46835,10 +47023,10 @@ paths: value: *150 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -46932,7 +47120,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -46959,13 +47147,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *47 + content: *48 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47010,7 +47198,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -47143,7 +47331,7 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47191,7 +47379,7 @@ paths: value: *301 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47253,7 +47441,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -47282,7 +47470,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47362,10 +47550,10 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47413,7 +47601,7 @@ paths: value: *303 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47654,8 +47842,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *84 - required: *85 + properties: *85 + required: *86 required: - _links - git_url @@ -47821,10 +48009,10 @@ paths: message: Merge Conflict '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47884,7 +48072,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -47900,8 +48088,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *80 - required: *81 + properties: *81 + required: *82 examples: default: value: @@ -47946,7 +48134,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48010,8 +48198,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *80 - required: *81 + properties: *81 + required: *82 examples: default: value: &305 @@ -48056,10 +48244,10 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48100,14 +48288,14 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *80 - required: *81 + properties: *81 + required: *82 examples: default: value: *305 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48174,8 +48362,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *80 - required: *81 + properties: *81 + required: *82 examples: default: value: *305 @@ -48213,7 +48401,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48247,7 +48435,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -48316,7 +48504,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -48327,7 +48515,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -48343,8 +48531,8 @@ paths: title: Thread description: Thread type: object - properties: *89 - required: *90 + properties: *90 + required: *91 examples: default: value: *310 @@ -48503,7 +48691,7 @@ paths: public: true '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48579,10 +48767,10 @@ paths: value: *313 '422': description: Validation Failed - content: *36 + content: *37 '415': description: Preview Header Missing - content: *29 + content: *30 '409': description: Conflict content: *244 @@ -48681,7 +48869,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *36 + content: *37 '400': description: Bad Request content: *262 @@ -48714,13 +48902,13 @@ paths: description: Empty response '422': description: Validation Failed - content: *36 + content: *37 '415': description: Preview Header Missing - content: *29 + content: *30 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48756,7 +48944,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -48792,8 +48980,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true commit: type: string @@ -49047,6 +49235,21 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -49110,7 +49313,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -49164,7 +49367,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -49231,7 +49434,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: Responds with effective values inherited from owner and/or @@ -49297,7 +49500,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -49357,16 +49560,16 @@ paths: schema: *6 '401': description: Requires Authentication - content: *32 + content: *33 '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *47 + content: *48 '422': description: Validation Failed content: *130 @@ -49437,16 +49640,16 @@ paths: value: *170 '401': description: Requires Authentication - content: *32 + content: *33 '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '410': description: Gone - content: *47 + content: *48 '422': description: Validation Failed content: *130 @@ -49538,7 +49741,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -49568,7 +49771,7 @@ paths: description: Not Modified '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49655,7 +49858,7 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: &326 + properties: &325 url: type: string format: uri @@ -49726,8 +49929,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: type: string @@ -49759,8 +49962,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *80 - required: *81 + properties: *81 + required: *82 active_lock_reason: type: string example: too heated @@ -49793,8 +49996,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assignees: type: array @@ -49802,8 +50005,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true requested_reviewers: @@ -49812,8 +50015,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true requested_teams: @@ -50521,8 +50724,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *84 - required: *85 + properties: *85 + required: *86 pushed_at: type: string format: date-time @@ -50763,7 +50966,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *65 + enum: *66 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -50787,8 +50990,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true comments: type: integer @@ -50813,7 +51016,7 @@ paths: changed_files: type: integer example: 5 - required: &327 + required: &326 - _links - assignee - labels @@ -50857,7 +51060,7 @@ paths: - review_comments examples: default: - value: &328 + value: &327 url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 node_id: MDExOlB1bGxSZXF1ZXN0MQ== @@ -51352,10 +51555,10 @@ paths: type: string '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *36 + content: *37 x-github: triggersNotification: true githubCloudOnly: false @@ -51384,11 +51587,14 @@ paths: required: true schema: *159 - name: sort - description: One of `created` (when the repository was starred) or `updated` - (when it was last pushed to). in: query required: false - schema: *322 + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -51404,11 +51610,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -51425,7 +51631,7 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: &323 + properties: &322 url: description: URL for the pull request review comment example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 @@ -51480,8 +51686,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: description: The text of the comment. @@ -51512,7 +51718,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *65 + enum: *66 _links: type: object properties: @@ -51587,15 +51793,15 @@ paths: reactions: title: Reaction Rollup type: object - properties: *82 - required: *83 + properties: *83 + required: *84 body_html: type: string example: '"

comment body

"' body_text: type: string example: '"comment body"' - required: &324 + required: &323 - url - id - node_id @@ -51731,7 +51937,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 responses: '200': description: response @@ -51742,11 +51948,11 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *323 - required: *324 + properties: *322 + required: *323 examples: default: - value: &325 + value: &324 url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 id: 10 @@ -51798,7 +52004,7 @@ paths: side: RIGHT '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51858,7 +52064,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 requestBody: content: application/json: @@ -51882,11 +52088,11 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *323 - required: *324 + properties: *322 + required: *323 examples: default: - value: *325 + value: *324 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51936,13 +52142,13 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 responses: '204': description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51972,7 +52178,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@2.22/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. @@ -51992,7 +52198,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -52021,10 +52227,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52065,7 +52271,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 requestBody: content: application/json: @@ -52120,10 +52326,10 @@ paths: value: *150 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52166,7 +52372,7 @@ paths: description: comment_id parameter in: path required: true - schema: *79 + schema: *80 - name: reaction_id in: path required: true @@ -52227,7 +52433,7 @@ paths: - name: pull_number in: path required: true - schema: &329 + schema: &328 type: integer responses: '200': @@ -52242,11 +52448,11 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: *326 - required: *327 + properties: *325 + required: *326 examples: default: - value: *328 + value: *327 '304': description: Not Modified '500': @@ -52254,7 +52460,7 @@ paths: content: *250 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52285,7 +52491,7 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 requestBody: content: application/json: @@ -52331,17 +52537,17 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: *326 - required: *327 + properties: *325 + required: *326 examples: default: - value: *328 + value: *327 '422': description: Validation Failed - content: *36 + content: *37 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52371,13 +52577,13 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 - name: sort description: One of `created` (when the repository was starred) or `updated` (when it was last pushed to). in: query required: false - schema: *322 + schema: *329 - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -52393,11 +52599,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -52414,8 +52620,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *323 - required: *324 + properties: *322 + required: *323 examples: default: value: *330 @@ -52490,7 +52696,7 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 requestBody: content: application/json: @@ -52589,8 +52795,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *323 - required: *324 + properties: *322 + required: *323 examples: example-for-a-multi-line-comment: value: @@ -52650,10 +52856,10 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 '403': description: Forbidden - content: *31 + content: *32 x-github: triggersNotification: true githubCloudOnly: false @@ -52707,12 +52913,12 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 - name: comment_id description: comment_id parameter in: path required: true - schema: *79 + schema: *80 requestBody: content: application/json: @@ -52736,8 +52942,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *323 - required: *324 + properties: *322 + required: *323 examples: default: value: @@ -52797,7 +53003,7 @@ paths: type: string '404': description: Resource Not Found - content: *24 + content: *25 x-github: triggersNotification: true githubCloudOnly: false @@ -52830,11 +53036,11 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -52889,11 +53095,11 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -52932,7 +53138,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *36 + content: *37 '500': description: Internal Error content: *250 @@ -52964,7 +53170,7 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 responses: '204': description: Response if pull request has been merged @@ -53001,7 +53207,7 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 requestBody: content: application/json: @@ -53085,13 +53291,13 @@ paths: message: Head branch was modified. Review and try the merge again. '422': description: Validation Failed - content: *36 + content: *37 '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 x-github: triggersNotification: true githubCloudOnly: false @@ -53121,11 +53327,11 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -53146,8 +53352,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true teams: type: array @@ -53232,7 +53438,7 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 requestBody: content: application/json: @@ -53786,7 +53992,7 @@ paths: description: Response if user is not a collaborator '403': description: Forbidden - content: *31 + content: *32 x-github: triggersNotification: true githubCloudOnly: false @@ -53815,7 +54021,7 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 requestBody: content: application/json: @@ -53846,7 +54052,7 @@ paths: description: response '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53875,11 +54081,11 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -53909,8 +54115,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: description: The text of the review. @@ -53963,7 +54169,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *65 + enum: *66 required: &335 - id - node_id @@ -54050,7 +54256,7 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 requestBody: content: application/json: @@ -54176,7 +54382,7 @@ paths: content: *130 '403': description: Forbidden - content: *31 + content: *32 x-github: triggersNotification: true githubCloudOnly: false @@ -54206,7 +54412,7 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 - name: review_id description: review_id parameter in: path @@ -54262,7 +54468,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54290,7 +54496,7 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 - name: review_id description: review_id parameter in: path @@ -54388,7 +54594,7 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 - name: review_id description: review_id parameter in: path @@ -54413,7 +54619,7 @@ paths: content: *130 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54442,7 +54648,7 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 - name: review_id description: review_id parameter in: path @@ -54451,7 +54657,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -54510,8 +54716,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: type: string @@ -54537,7 +54743,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *65 + enum: *66 _links: type: object properties: @@ -54677,7 +54883,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54708,7 +54914,7 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 - name: review_id description: review_id parameter in: path @@ -54777,7 +54983,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed content: *130 @@ -54809,7 +55015,7 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 - name: review_id description: review_id parameter in: path @@ -54854,13 +55060,13 @@ paths: value: *338 '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed content: *130 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54890,7 +55096,7 @@ paths: - name: pull_number in: path required: true - schema: *329 + schema: *328 requestBody: content: application/json: @@ -54926,13 +55132,13 @@ paths: url: https://github.com/repos/octocat/Hello-World/pulls/53 '422': description: Validation Failed - content: *36 + content: *37 '403': description: Forbidden - content: *31 + content: *32 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54988,7 +55194,7 @@ paths: required: *340 examples: default: - value: + value: &341 type: file encoding: base64 size: 5362 @@ -55006,10 +55212,72 @@ paths: html: https://github.com/octokit/octokit.rb/blob/master/README.md '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *36 + content: *37 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository-readme + parameters: + - name: owner + in: path + required: true + schema: *158 + - name: repo + in: path + required: true + schema: *159 + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + title: Content File + description: Content File + type: object + properties: *339 + required: *340 + examples: + default: + value: *341 + '404': + description: Resource Not Found + content: *25 + '422': + description: Validation Failed + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55041,7 +55309,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -55057,7 +55325,7 @@ paths: title: Release description: A release. type: object - properties: &341 + properties: &342 url: type: string format: uri @@ -55117,8 +55385,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assets: type: array @@ -55126,7 +55394,7 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: &343 + properties: &344 url: type: string format: uri @@ -55168,10 +55436,10 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true - required: &344 + required: &345 - id - name - content_type @@ -55189,7 +55457,7 @@ paths: type: string body_text: type: string - required: &342 + required: &343 - assets_url - upload_url - tarball_url @@ -55284,7 +55552,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55361,11 +55629,11 @@ paths: title: Release description: A release. type: object - properties: *341 - required: *342 + properties: *342 + required: *343 examples: default: - value: &347 + value: &348 url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 assets_url: https://api.github.com/repos/octocat/Hello-World/releases/1/assets @@ -55440,7 +55708,7 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 x-github: triggersNotification: true githubCloudOnly: false @@ -55474,7 +55742,7 @@ paths: description: asset_id parameter in: path required: true - schema: &345 + schema: &346 type: integer responses: '200': @@ -55489,11 +55757,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *343 - required: *344 + properties: *344 + required: *345 examples: default: - value: &346 + value: &347 url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip id: 1 @@ -55527,10 +55795,10 @@ paths: site_admin: false '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 '302': description: Found x-github: @@ -55561,7 +55829,7 @@ paths: description: asset_id parameter in: path required: true - schema: *345 + schema: *346 requestBody: content: application/json: @@ -55590,11 +55858,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *343 - required: *344 + properties: *344 + required: *345 examples: default: - value: *346 + value: *347 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55623,7 +55891,7 @@ paths: description: asset_id parameter in: path required: true - schema: *345 + schema: *346 responses: '204': description: Empty response @@ -55664,11 +55932,11 @@ paths: title: Release description: A release. type: object - properties: *341 - required: *342 + properties: *342 + required: *343 examples: default: - value: *347 + value: *348 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55695,7 +55963,7 @@ paths: required: true schema: *159 - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -55710,14 +55978,14 @@ paths: title: Release description: A release. type: object - properties: *341 - required: *342 + properties: *342 + required: *343 examples: default: - value: *347 + value: *348 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55748,7 +56016,7 @@ paths: description: release_id parameter in: path required: true - schema: &348 + schema: &349 type: integer responses: '200': @@ -55760,14 +56028,14 @@ paths: title: Release description: A release. type: object - properties: *341 - required: *342 + properties: *342 + required: *343 examples: default: - value: *347 + value: *348 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55796,7 +56064,7 @@ paths: description: release_id parameter in: path required: true - schema: *348 + schema: *349 requestBody: content: application/json: @@ -55842,11 +56110,11 @@ paths: title: Release description: A release. type: object - properties: *341 - required: *342 + properties: *342 + required: *343 examples: default: - value: *347 + value: *348 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55875,7 +56143,7 @@ paths: description: release_id parameter in: path required: true - schema: *348 + schema: *349 responses: '204': description: Empty response @@ -55908,11 +56176,11 @@ paths: description: release_id parameter in: path required: true - schema: *348 + schema: *349 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -55928,8 +56196,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *343 - required: *344 + properties: *344 + required: *345 examples: default: value: @@ -56026,7 +56294,7 @@ paths: description: release_id parameter in: path required: true - schema: *348 + schema: *349 - name: name in: query schema: @@ -56050,8 +56318,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *343 - required: *344 + properties: *344 + required: *345 examples: response-for-successful-upload: value: @@ -56117,7 +56385,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -56133,8 +56401,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default-response: @@ -56175,8 +56443,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true required: - starred_at @@ -56212,7 +56480,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56251,7 +56519,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: &349 + items: &350 type: integer examples: default: @@ -56386,8 +56654,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true total: type: integer @@ -56601,7 +56869,7 @@ paths: - 3 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56647,7 +56915,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: *349 + items: *350 examples: default: value: @@ -56741,8 +57009,8 @@ paths: title: Status description: The status of a commit. type: object - properties: *350 - required: *351 + properties: *351 + required: *352 examples: default: value: @@ -56808,7 +57076,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -56824,8 +57092,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -56870,7 +57138,7 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: &352 + properties: &353 subscribed: description: Determines if notifications should be received from this repository. @@ -56895,7 +57163,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/example - required: &353 + required: &354 - created_at - ignored - reason @@ -56915,7 +57183,7 @@ paths: description: Response if you don't subscribe to the repository '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56968,8 +57236,8 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: *352 - required: *353 + properties: *353 + required: *354 examples: default: value: @@ -57036,7 +57304,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57168,7 +57436,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57220,6 +57488,14 @@ paths: in: path required: true schema: *159 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *31 responses: '200': description: response @@ -57229,16 +57505,16 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: &354 + properties: &355 names: type: array items: type: string - required: &355 + required: &356 - names examples: default: - value: &356 + value: &357 names: - octocat - atom @@ -57246,10 +57522,10 @@ paths: - api '415': description: Preview Header Missing - content: *29 + content: *30 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57312,17 +57588,17 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: *354 - required: *355 + properties: *355 + required: *356 examples: default: - value: *356 + value: *357 '415': description: Preview Header Missing - content: *29 + content: *30 '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed content: *130 @@ -57394,8 +57670,8 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: default: value: *263 @@ -57594,8 +57870,8 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: default: value: @@ -57775,8 +58051,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 examples: default: value: @@ -57853,7 +58129,7 @@ paths: type: string '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified x-github: @@ -57918,7 +58194,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: &357 + schema: &358 type: string enum: - desc @@ -57927,7 +58203,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -57974,8 +58250,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 score: type: integer file_size: @@ -57996,7 +58272,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: &358 + items: &359 type: object properties: object_url: @@ -58113,10 +58389,10 @@ paths: content: *229 '422': description: Validation Failed - content: *36 + content: *37 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58169,11 +58445,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *357 + schema: *358 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -58273,8 +58549,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true committer: nullable: true @@ -58298,8 +58574,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 score: type: integer node_id: @@ -58307,7 +58583,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *358 + items: *359 required: - sha - node_id @@ -58440,7 +58716,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58518,11 +58794,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *357 + schema: *358 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -58586,8 +58862,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true user: @@ -58596,8 +58872,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true labels: type: array @@ -58627,8 +58903,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true milestone: nullable: true @@ -58636,8 +58912,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *80 - required: *81 + properties: *81 + required: *82 comments: type: integer created_at: @@ -58653,7 +58929,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *358 + items: *359 pull_request: type: object properties: @@ -58691,15 +58967,15 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *65 + enum: *66 draft: type: boolean repository: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 body_html: type: string body_text: @@ -58717,8 +58993,8 @@ paths: They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true required: - assignee @@ -58839,12 +59115,12 @@ paths: content: *229 '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58901,7 +59177,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *357 + schema: *358 responses: '200': description: response @@ -58946,7 +59222,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *358 + items: *359 required: - id - node_id @@ -58982,13 +59258,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59049,11 +59325,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *357 + schema: *358 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -59095,8 +59371,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true private: type: boolean @@ -59272,8 +59548,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *84 - required: *85 + properties: *85 + required: *86 permissions: type: object properties: @@ -59290,7 +59566,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *358 + items: *359 temp_clone_token: type: string allow_merge_commit: @@ -59487,7 +59763,7 @@ paths: content: *229 '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified x-github: @@ -59594,7 +59870,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *358 + items: *359 related: type: array nullable: true @@ -59739,7 +60015,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59802,11 +60078,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *357 + schema: *358 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -59914,7 +60190,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *358 + items: *359 blog: type: string nullable: true @@ -59977,7 +60253,7 @@ paths: content: *229 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60086,7 +60362,7 @@ paths: application/json: schema: type: object - properties: &359 + properties: &360 status: type: string scheduled_time: @@ -60105,7 +60381,7 @@ paths: - number examples: default: - value: &360 + value: &361 status: scheduled scheduled_time: Tuesday, January 22 at 15:34 -0800 connection_services: @@ -60140,10 +60416,10 @@ paths: application/json: schema: type: object - properties: *359 + properties: *360 examples: default: - value: *360 + value: *361 requestBody: content: application/json: @@ -60653,14 +60929,14 @@ paths: type: array items: type: object - properties: &361 + properties: &362 key: type: string pretty-print: type: string examples: default: - value: &362 + value: &363 - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64 - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... @@ -60691,10 +60967,10 @@ paths: type: array items: type: object - properties: *361 + properties: *362 examples: default: - value: *362 + value: *363 requestBody: content: application/json: @@ -60730,10 +61006,10 @@ paths: type: array items: type: object - properties: *361 + properties: *362 examples: default: - value: *362 + value: *363 requestBody: content: application/json: @@ -60864,7 +61140,7 @@ paths: value: *137 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60958,13 +61234,13 @@ paths: value: *137 '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *36 + content: *37 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60998,10 +61274,10 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61033,11 +61309,11 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *121 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -61058,7 +61334,7 @@ paths: required: *140 examples: default: - value: *363 + value: *364 headers: Link: example: ; rel="next", ; @@ -61267,7 +61543,7 @@ paths: required: *140 examples: default: - value: *364 + value: *365 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61346,11 +61622,11 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *121 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -61370,7 +61646,7 @@ paths: required: *144 examples: default: - value: *365 + value: *366 headers: Link: example: ; rel="next", ; @@ -61575,7 +61851,7 @@ paths: required: *144 examples: default: - value: *366 + value: *367 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61677,7 +61953,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -61846,7 +62122,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -62004,7 +62280,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -62020,8 +62296,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -62033,7 +62309,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62159,7 +62435,7 @@ paths: resource: TeamMember '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62250,16 +62526,16 @@ paths: examples: response-if-user-has-an-active-membership-with-team: summary: Response if user has an active membership with team - value: *367 + value: *368 response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer - value: *368 + value: *369 response-if-user-has-a-pending-membership-with-team: summary: Response if user has a pending membership with team - value: *369 + value: *370 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62329,10 +62605,10 @@ paths: examples: response-if-users-membership-with-team-is-now-active: summary: Response if user's membership with team is now active - value: *370 + value: *371 response-if-users-membership-with-team-is-now-pending: summary: Response if user's membership with team is now pending - value: *371 + value: *372 '403': description: Response if team synchronization is set up '422': @@ -62368,7 +62644,7 @@ paths: resource: TeamMember '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62438,7 +62714,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -62458,7 +62734,7 @@ paths: required: *155 examples: default: - value: *372 + value: *373 headers: Link: example: ; rel="next", ; @@ -62466,10 +62742,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62521,12 +62797,12 @@ paths: required: *155 examples: default: - value: *373 + value: *374 '404': description: Response if project is not managed by this team '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62607,13 +62883,13 @@ paths: documentation_url: https://docs.github.com/enterprise-server@2.22/rest/reference/teams#add-or-update-team-project-permissions '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62656,13 +62932,13 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62693,7 +62969,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -62709,8 +62985,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 examples: default: value: *157 @@ -62721,7 +62997,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62768,8 +63044,8 @@ paths: title: Team Repository description: A team's access to a repository. type: object - properties: *374 - required: *375 + properties: *375 + required: *376 examples: alternative-response-with-extra-repository-information: value: @@ -63069,10 +63345,10 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63140,7 +63416,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -63161,7 +63437,7 @@ paths: required: *161 examples: response-if-child-teams-exist: - value: *376 + value: *377 headers: Link: example: ; rel="next", ; @@ -63169,13 +63445,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63209,7 +63485,7 @@ paths: - title: Private User description: Private User type: object - properties: &377 + properties: &378 login: type: string example: octocat @@ -63362,7 +63638,7 @@ paths: type: boolean ldap_dn: type: string - required: &378 + required: &379 - avatar_url - events_url - followers_url @@ -63403,7 +63679,7 @@ paths: - title: Public User description: Public User type: object - properties: &393 + properties: &394 login: type: string id: @@ -63520,7 +63796,7 @@ paths: collaborators: type: integer example: 3 - required: &394 + required: &395 - avatar_url - events_url - followers_url @@ -63637,10 +63913,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63706,8 +63982,8 @@ paths: title: Private User description: Private User type: object - properties: *377 - required: *378 + properties: *378 + required: *379 examples: default: value: @@ -63757,16 +64033,16 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63788,7 +64064,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -63804,7 +64080,7 @@ paths: title: Email description: Email type: object - properties: &379 + properties: &380 email: type: string format: email @@ -63819,14 +64095,14 @@ paths: type: string example: public nullable: true - required: &380 + required: &381 - email - primary - verified - visibility examples: default: - value: &390 + value: &391 - email: octocat@github.com verified: true primary: true @@ -63840,13 +64116,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63905,8 +64181,8 @@ paths: title: Email description: Email type: object - properties: *379 - required: *380 + properties: *380 + required: *381 examples: default: value: @@ -63924,18 +64200,18 @@ paths: visibility: '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63990,16 +64266,16 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64020,7 +64296,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -64036,8 +64312,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -64051,10 +64327,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64075,7 +64351,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -64091,8 +64367,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -64106,10 +64382,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64143,15 +64419,15 @@ paths: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64182,13 +64458,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64217,13 +64493,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64245,7 +64521,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -64261,7 +64537,7 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: &381 + properties: &382 id: type: integer example: 3 @@ -64355,7 +64631,7 @@ paths: raw_key: type: string nullable: true - required: &382 + required: &383 - id - primary_key_id - key_id @@ -64371,7 +64647,7 @@ paths: - subkeys examples: default: - value: &395 + value: &396 - id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -64408,13 +64684,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64453,11 +64729,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *381 - required: *382 + properties: *382 + required: *383 examples: default: - value: &383 + value: &384 id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -64489,18 +64765,18 @@ paths: PGP PUBLIC KEY BLOCK-----"' '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64523,7 +64799,7 @@ paths: description: gpg_key_id parameter in: path required: true - schema: &384 + schema: &385 type: integer responses: '200': @@ -64534,22 +64810,22 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *381 - required: *382 + properties: *382 + required: *383 examples: default: - value: *383 + value: *384 '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64572,24 +64848,24 @@ paths: description: gpg_key_id parameter in: path required: true - schema: *384 + schema: *385 responses: '204': description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64617,7 +64893,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -64642,8 +64918,8 @@ paths: title: Installation description: Installation type: object - properties: *22 - required: *23 + properties: *23 + required: *24 examples: default: value: @@ -64734,13 +65010,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '415': description: Preview Header Missing - content: *29 + content: *30 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64769,11 +65045,11 @@ paths: description: installation_id parameter in: path required: true - schema: *25 + schema: *26 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -64800,11 +65076,11 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: default: - value: *385 + value: *386 headers: Link: example: ; rel="next", ; @@ -64812,10 +65088,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '304': description: Not Modified x-github: @@ -64849,22 +65125,22 @@ paths: description: installation_id parameter in: path required: true - schema: *25 + schema: *26 - name: repository_id in: path required: true - schema: *105 + schema: *106 responses: '204': description: Empty response '403': description: Forbidden - content: *31 + content: *32 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64888,22 +65164,22 @@ paths: description: installation_id parameter in: path required: true - schema: *25 + schema: *26 - name: repository_id in: path required: true - schema: *105 + schema: *106 responses: '204': description: Empty response '403': description: Forbidden - content: *31 + content: *32 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64942,6 +65218,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -64960,7 +65237,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *120 + schema: *121 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -64977,18 +65254,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *121 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -65017,7 +65294,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified x-github: @@ -65052,7 +65329,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -65068,7 +65345,7 @@ paths: title: Key description: Key type: object - properties: &386 + properties: &387 key_id: type: string key: @@ -65086,7 +65363,7 @@ paths: type: boolean read_only: type: boolean - required: &387 + required: &388 - key_id - key - id @@ -65123,13 +65400,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65173,11 +65450,11 @@ paths: title: Key description: Key type: object - properties: *386 - required: *387 + properties: *387 + required: *388 examples: default: - value: &388 + value: &389 key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -65188,18 +65465,18 @@ paths: read_only: false '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65233,22 +65510,22 @@ paths: title: Key description: Key type: object - properties: *386 - required: *387 + properties: *387 + required: *388 examples: default: - value: *388 + value: *389 '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65279,13 +65556,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65317,7 +65594,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -65419,13 +65696,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65446,7 +65723,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 responses: '200': description: response @@ -65499,10 +65776,10 @@ paths: site_admin: false '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65522,7 +65799,7 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 requestBody: content: application/json: @@ -65591,13 +65868,13 @@ paths: site_admin: false '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65623,7 +65900,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -65639,11 +65916,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *53 - required: *54 + properties: *54 + required: *55 examples: default: - value: *389 + value: *390 headers: Link: example: ; rel="next", ; @@ -65653,10 +65930,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65741,13 +66018,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed content: *130 @@ -65780,7 +66057,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -65796,11 +66073,11 @@ paths: title: Email description: Email type: object - properties: *379 - required: *380 + properties: *380 + required: *381 examples: default: - value: *390 + value: *391 headers: Link: example: ; rel="next", ; @@ -65810,13 +66087,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65902,7 +66179,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -65913,7 +66190,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -65932,12 +66209,12 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: default: summary: Default response - value: &392 + value: &393 - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World @@ -66056,15 +66333,15 @@ paths: watchers: 1 '422': description: Validation Failed - content: *36 + content: *37 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66186,8 +66463,8 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: default: value: *263 @@ -66198,18 +66475,18 @@ paths: type: string '401': description: Requires Authentication - content: *32 + content: *33 '304': description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '422': description: Validation Failed - content: *36 + content: *37 '400': description: Bad Request content: *262 @@ -66251,7 +66528,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -66272,7 +66549,7 @@ paths: required: *281 examples: default: - value: *391 + value: *392 headers: Link: example: ; rel="next", ; @@ -66282,13 +66559,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66316,13 +66593,13 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 '409': description: Conflict content: *244 '404': description: Resource Not Found - content: *24 + content: *25 '304': description: Not Modified x-github: @@ -66356,10 +66633,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66385,16 +66662,16 @@ paths: (when it was last pushed to). in: query required: false - schema: *322 + schema: *329 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *121 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -66410,12 +66687,12 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: default-response: summary: Default response - value: *392 + value: *393 application/vnd.github.v3.star+json: schema: type: array @@ -66423,7 +66700,7 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: &396 + properties: &397 starred_at: type: string format: date-time @@ -66431,15 +66708,15 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 - required: &397 + properties: *60 + required: *61 + required: &398 - starred_at - repo examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: &398 + value: &399 - starred_at: '2011-01-16T19:06:43Z' repo: id: 1296269 @@ -66567,10 +66844,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66607,15 +66884,15 @@ paths: title: Basic Error description: Basic Error type: object - properties: *28 + properties: *29 '401': description: Requires Authentication - content: *32 + content: *33 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66646,13 +66923,13 @@ paths: description: Empty response '403': description: Forbidden - content: *31 + content: *32 '404': description: Resource Not Found - content: *24 + content: *25 '401': description: Requires Authentication - content: *32 + content: *33 '304': description: Not Modified x-github: @@ -66684,15 +66961,15 @@ paths: description: Empty response '404': description: Resource Not Found - content: *24 + content: *25 '401': description: Requires Authentication - content: *32 + content: *33 '304': description: Not Modified '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66713,7 +66990,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -66729,8 +67006,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 examples: default: value: *157 @@ -66743,10 +67020,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *31 + content: *32 '401': description: Requires Authentication - content: *32 + content: *33 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66770,7 +67047,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -66845,10 +67122,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *24 + content: *25 '403': description: Forbidden - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66878,7 +67155,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 responses: '200': description: response @@ -66890,8 +67167,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -66941,13 +67218,13 @@ paths: - title: Private User description: Private User type: object - properties: *377 - required: *378 + properties: *378 + required: *379 - title: Public User description: Public User type: object - properties: *393 - required: *394 + properties: *394 + required: *395 additionalProperties: false examples: default-response: @@ -67027,7 +67304,7 @@ paths: private_repos: 9999 '404': description: Resource Not Found - content: *24 + content: *25 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67053,7 +67330,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -67069,8 +67346,8 @@ paths: title: Event description: Event type: object - properties: *87 - required: *88 + properties: *88 + required: *89 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67096,11 +67373,11 @@ paths: - name: org in: path required: true - schema: *95 + schema: *96 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -67116,8 +67393,8 @@ paths: title: Event description: Event type: object - properties: *87 - required: *88 + properties: *88 + required: *89 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67142,7 +67419,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -67158,8 +67435,8 @@ paths: title: Event description: Event type: object - properties: *87 - required: *88 + properties: *88 + required: *89 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67184,7 +67461,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -67200,8 +67477,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -67235,7 +67512,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -67251,8 +67528,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -67320,11 +67597,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *68 + schema: *69 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -67340,11 +67617,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *69 - required: *70 + properties: *70 + required: *71 examples: default: - value: *71 + value: *72 headers: Link: example: ; rel="next", ; @@ -67352,7 +67629,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67378,7 +67655,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -67394,11 +67671,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *381 - required: *382 + properties: *382 + required: *383 examples: default: - value: *395 + value: *396 headers: Link: example: ; rel="next", ; @@ -67485,10 +67762,10 @@ paths: octicon: repo '404': description: Resource Not Found - content: *24 + content: *25 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67522,8 +67799,8 @@ paths: title: Installation description: Installation type: object - properties: *22 - required: *23 + properties: *23 + required: *24 examples: default: value: *279 @@ -67552,7 +67829,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -67613,7 +67890,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -67629,11 +67906,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *53 - required: *54 + properties: *54 + required: *55 examples: default: - value: *389 + value: *390 headers: Link: example: ; rel="next", ; @@ -67675,7 +67952,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -67735,10 +68012,10 @@ paths: schema: *6 '415': description: Preview Header Missing - content: *29 + content: *30 '422': description: Validation Failed - content: *36 + content: *37 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67772,7 +68049,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -67788,8 +68065,8 @@ paths: title: Event description: Event type: object - properties: *87 - required: *88 + properties: *88 + required: *89 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67814,7 +68091,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -67830,8 +68107,8 @@ paths: title: Event description: Event type: object - properties: *87 - required: *88 + properties: *88 + required: *89 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67890,7 +68167,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -67906,8 +68183,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 examples: default: value: *157 @@ -68002,16 +68279,16 @@ paths: (when it was last pushed to). in: query required: false - schema: *322 + schema: *329 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *121 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -68027,12 +68304,12 @@ paths: title: Repository description: A git repository type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: default-response: summary: Default response - value: *392 + value: *393 application/vnd.github.v3.star+json: schema: type: array @@ -68040,12 +68317,12 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: *396 - required: *397 + properties: *397 + required: *398 examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: *398 + value: *399 headers: Link: example: ; rel="next", ; @@ -68075,7 +68352,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *30 + schema: *31 - name: page description: Page number of the results to fetch. in: query @@ -68091,8 +68368,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *115 - required: *116 + properties: *116 + required: *117 examples: default: value: *157 diff --git a/descriptions/ghes-2.22/ghes-2.22.json b/descriptions/ghes-2.22/ghes-2.22.json index af24a32ebc..f95fc7e7a8 100644 --- a/descriptions/ghes-2.22/ghes-2.22.json +++ b/descriptions/ghes-2.22/ghes-2.22.json @@ -824,6 +824,32 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1284,6 +1310,23 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -1794,6 +1837,24 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -2923,6 +2984,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -3574,6 +3644,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -7174,6 +7253,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -7329,6 +7409,9 @@ }, { "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -8754,6 +8837,12 @@ }, { "$ref": "#/components/parameters/runner_group_id" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" } ], "responses": { @@ -9738,6 +9827,12 @@ }, { "$ref": "#/components/parameters/secret_name" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" } ], "responses": { @@ -10555,6 +10650,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -11243,6 +11339,24 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -12461,6 +12575,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { @@ -21727,7 +21850,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. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "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. GitHub Apps must have the `security_events` read permission to use\nthis 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).", "tags": [ "code-scanning" ], @@ -22041,7 +22164,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -22984,6 +23107,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -23358,9 +23501,15 @@ { "$ref": "#/components/parameters/repo" }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -23427,7 +23576,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -23460,6 +23609,14 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -23535,7 +23692,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -23636,13 +23793,19 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -23697,7 +23860,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -23842,7 +24005,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -23943,7 +24106,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -24123,7 +24286,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -24371,7 +24534,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -25164,7 +25328,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -25174,6 +25339,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -25231,6 +25416,26 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -25238,6 +25443,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -25668,7 +25874,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -25740,7 +25946,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -25891,7 +26097,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -25977,7 +26183,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -26351,7 +26557,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -31433,6 +31640,23 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -32096,7 +32320,17 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/sort" + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "created_at" + ] + } }, { "name": "direction", @@ -34427,6 +34661,79 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content-file" + }, + "examples": { + "default": { + "$ref": "#/components/examples/content-file" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -34840,7 +35147,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -36062,6 +36369,12 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" } ], "responses": { @@ -41295,6 +41608,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -44343,6 +44657,20 @@ "type": "integer" } }, + "direction": { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, "key-ids": { "name": "key_ids", "in": "path", @@ -44532,20 +44860,6 @@ "type": "string" } }, - "direction": { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, "owner": { "name": "owner", "in": "path", @@ -54389,13 +54703,14 @@ }, "code-scanning-ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "code-scanning-alert-state": { "type": "string", "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] diff --git a/descriptions/ghes-2.22/ghes-2.22.yaml b/descriptions/ghes-2.22/ghes-2.22.yaml index 5a80f258e5..1ba013e181 100644 --- a/descriptions/ghes-2.22/ghes-2.22.yaml +++ b/descriptions/ghes-2.22/ghes-2.22.yaml @@ -600,6 +600,23 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string responses: '200': description: response @@ -904,6 +921,17 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1294,6 +1322,19 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: One of `created` (when the repository was starred) or `updated` + (when it was last pushed to) or `name`. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -2097,6 +2138,12 @@ paths: parameters: - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -2561,6 +2608,12 @@ paths: parameters: - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -5065,6 +5118,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -5170,6 +5224,7 @@ paths: schema: type: boolean - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -6188,6 +6243,8 @@ paths: parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner_group_id" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" responses: '200': description: response @@ -6947,6 +7004,8 @@ paths: parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret_name" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" responses: '200': description: response @@ -7510,6 +7569,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -7985,6 +8045,18 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: The sort order for the response collection. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -8928,6 +9000,12 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: pinned + in: query + required: false + description: Pinned discussions only filter + schema: + type: string responses: '200': description: response @@ -15719,7 +15797,7 @@ paths: The response includes a `most_recent_instance` object. This provides details of the most recent instance of this alert - for the the default branch or for the specified Git reference + for the default branch or for the specified Git reference (if you used `ref` in the request). tags: - code-scanning @@ -15933,6 +16011,10 @@ paths: description: |- Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. + There are two places where you can upload code scanning results. + - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)." + - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." + You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example: ``` @@ -16637,6 +16719,20 @@ paths: type: string - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -16929,8 +17025,10 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -16975,7 +17073,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -16996,6 +17094,11 @@ paths: default: latest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -17049,7 +17152,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -17124,12 +17227,14 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -17165,7 +17270,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -17323,7 +17428,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -17384,7 +17489,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -17520,7 +17625,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -17688,6 +17793,7 @@ paths: schema: type: string default: none + nullable: true - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" responses: @@ -18362,9 +18468,24 @@ paths: - newest - oldest - stargazers + - watchers default: newest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -18403,11 +18524,26 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -18786,7 +18922,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -18832,7 +18968,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -18931,7 +19067,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -18988,7 +19124,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -19317,6 +19453,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -22726,6 +22863,17 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -23216,7 +23364,15 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/sort" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -24900,6 +25056,56 @@ paths: previews: [] category: repos subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository-readme + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/content-file" + examples: + default: + "$ref": "#/components/examples/content-file" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents "/repos/{owner}/{repo}/releases": get: summary: List releases @@ -25179,7 +25385,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -26003,6 +26209,8 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" responses: '200': description: response @@ -29923,6 +30131,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -31977,6 +32186,17 @@ components: required: true schema: type: integer + direction: + name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc key-ids: name: key_ids in: path @@ -32125,17 +32345,6 @@ components: required: false schema: type: string - direction: - name: direction - description: One of `asc` (ascending) or `desc` (descending). - in: query - required: false - schema: - type: string - enum: - - asc - - desc - default: desc owner: name: owner in: path @@ -39679,12 +39888,15 @@ components: if provided in the uploaded SARIF data. code-scanning-ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. code-scanning-alert-state: type: string description: State of a code scanning alert. enum: - open + - closed - dismissed - fixed alert-number: diff --git a/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.json b/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.json index 663a6c26ed..2fff74101d 100644 --- a/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.json +++ b/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.json @@ -1140,6 +1140,43 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1899,6 +1936,34 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -2746,6 +2811,35 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -9242,6 +9336,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -14916,6 +15019,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -37262,6 +37374,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -39961,6 +40074,15 @@ "type": "integer", "default": 30 } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -50858,6 +50980,24 @@ "schema": { "type": "integer" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -55695,6 +55835,24 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -62720,6 +62878,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -67180,6 +67339,35 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -74034,6 +74222,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { @@ -137615,7 +137812,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. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "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. GitHub Apps must have the `security_events` read permission to use\nthis 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).", "tags": [ "code-scanning" ], @@ -137687,7 +137884,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } }, { @@ -137700,6 +137897,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -137755,6 +137953,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -137950,7 +138149,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -137965,6 +138164,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -138312,6 +138512,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -138522,7 +138723,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -138537,6 +138738,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -138888,6 +139090,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -139098,7 +139301,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -139113,6 +139316,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -139406,7 +139610,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } }, { @@ -139434,7 +139638,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "commit_sha": { "description": "The SHA of the commit to which the analysis you are uploading relates.", @@ -139649,7 +139853,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -139691,7 +139895,7 @@ }, "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "sarif": { "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.0/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning).\"", @@ -144778,6 +144982,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -150498,9 +150722,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -151245,7 +151487,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -151307,6 +151549,14 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -152294,7 +152544,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -154592,13 +154842,31 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -156360,7 +156628,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -158595,7 +158863,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -159310,7 +159578,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -160002,7 +160270,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -160725,7 +160993,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -167676,7 +167945,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -167698,6 +167968,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -169418,6 +169708,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -169425,6 +169735,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -171905,7 +172216,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -172067,7 +172378,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -172427,7 +172738,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -172642,7 +172953,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -173658,7 +173969,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -216353,6 +216665,34 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -224835,16 +225175,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -245057,6 +245396,279 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -247544,7 +248156,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -252361,6 +252973,24 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -284238,6 +284868,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" diff --git a/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.yaml b/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.yaml index a428b46820..f707eb6235 100644 --- a/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.yaml +++ b/descriptions/ghes-3.0/dereferenced/ghes-3.0.deref.yaml @@ -742,6 +742,32 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: &9 + type: string + enum: + - asc + - desc + default: desc + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string responses: '200': description: response @@ -1100,7 +1126,7 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: &56 + properties: &57 login: type: string example: github @@ -1141,7 +1167,7 @@ paths: type: string example: A great organization nullable: true - required: &57 + required: &58 - login - url - id @@ -1211,7 +1237,7 @@ paths: - name: org in: path required: true - schema: &107 + schema: &108 type: string responses: '202': @@ -1267,6 +1293,21 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1276,7 +1317,7 @@ paths: type: array items: type: object - properties: &9 + properties: &10 id: type: integer name: @@ -1367,10 +1408,10 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default: - value: &10 + value: &11 id: 2 name: DevTools Hook Env image_url: https://my_file_server/path/to/devtools_env.tar.gz @@ -1432,7 +1473,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: &11 + schema: &12 type: integer responses: '200': @@ -1441,10 +1482,10 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default: - value: *10 + value: *11 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -1475,7 +1516,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *11 + schema: *12 responses: '200': description: response @@ -1483,7 +1524,7 @@ paths: application/json: schema: type: object - properties: *9 + properties: *10 examples: default-response: value: @@ -1576,7 +1617,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *11 + schema: *12 responses: '204': description: Empty response @@ -1646,7 +1687,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *11 + schema: *12 responses: '202': description: response @@ -1654,7 +1695,7 @@ paths: application/json: schema: type: object - properties: &12 + properties: &13 url: type: string state: @@ -1733,7 +1774,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *11 + schema: *12 responses: '200': description: response @@ -1741,7 +1782,7 @@ paths: application/json: schema: type: object - properties: *12 + properties: *13 examples: default: value: @@ -1784,6 +1825,23 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + description: One of `created` (when the repository was starred) or `updated` + (when it was last pushed to) or `name`. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1793,7 +1851,7 @@ paths: type: array items: type: object - properties: &13 + properties: &14 id: type: integer name: @@ -1906,10 +1964,10 @@ paths: application/json: schema: type: object - properties: *13 + properties: *14 examples: default: - value: &14 + value: &15 id: 1 name: Check Commits enforcement: disabled @@ -2007,7 +2065,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: &15 + schema: &16 type: integer responses: '200': @@ -2016,10 +2074,10 @@ paths: application/json: schema: type: object - properties: *13 + properties: *14 examples: default: - value: *14 + value: *15 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -2049,7 +2107,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -2057,7 +2115,7 @@ paths: application/json: schema: type: object - properties: *13 + properties: *14 examples: default: value: @@ -2148,7 +2206,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '204': description: Empty response @@ -2199,7 +2257,7 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: &18 + properties: &19 id: type: integer url: @@ -2255,7 +2313,7 @@ paths: - title: Simple User description: Simple User type: object - properties: &16 + properties: &17 login: type: string example: octocat @@ -2321,7 +2379,7 @@ paths: starred_at: type: string example: '"2020-07-09T00:17:55Z"' - required: &17 + required: &18 - avatar_url - events_url - followers_url @@ -2352,7 +2410,7 @@ paths: type: object description: The permissions granted to the user-to-server access token. - properties: &28 + properties: &29 actions: type: string description: 'The level of permission to grant the @@ -2601,7 +2659,7 @@ paths: enum: - read - write - example: &29 + example: &30 contents: read issues: read deployments: write @@ -2635,8 +2693,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true required: - permissions @@ -2644,7 +2702,7 @@ paths: - single_file_name - repositories_url - account - required: &19 + required: &20 - app - id - note @@ -2659,7 +2717,7 @@ paths: - updated_at examples: default: - value: &43 + value: &44 - id: 2 url: https://enterprise.octocat.com/api/v3/authorizations/2 app: @@ -2751,8 +2809,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -2901,11 +2959,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: &44 + value: &45 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -2989,7 +3047,7 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: &20 + properties: &21 id: description: Unique identifier of the GitHub app example: 37 @@ -3007,8 +3065,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true name: description: The name of the GitHub app @@ -3079,7 +3137,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &21 + required: &22 - id - node_id - owner @@ -3094,7 +3152,7 @@ paths: additionalProperties: true examples: default: - value: &42 + value: &43 id: 1 slug: octoapp node_id: MDExOkludGVncmF0aW9uMQ== @@ -3170,8 +3228,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true - type: object properties: @@ -3261,13 +3319,13 @@ paths: -----END RSA PRIVATE KEY----- '404': description: Resource Not Found - content: &26 + content: &27 application/json: schema: title: Basic Error description: Basic Error type: object - properties: &30 + properties: &31 message: type: string documentation_url: @@ -3280,10 +3338,10 @@ paths: title: Validation Error Simple description: Validation Error Simple type: object - required: &112 + required: &113 - message - documentation_url - properties: &113 + properties: &114 message: type: string documentation_url: @@ -3320,7 +3378,7 @@ paths: title: Webhook Configuration description: Configuration object of the webhook type: object - properties: &22 + properties: &23 url: type: string description: The URL to which the payloads will be delivered. @@ -3348,7 +3406,7 @@ paths: example: '"0"' examples: default: - value: &23 + value: &24 content_type: json insecure_ssl: '0' secret: "********" @@ -3416,10 +3474,10 @@ paths: title: Webhook Configuration description: Configuration object of the webhook type: object - properties: *22 + properties: *23 examples: default: - value: *23 + value: *24 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -3443,7 +3501,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: &32 + schema: &33 type: integer default: 30 - name: page @@ -3456,7 +3514,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: &80 + schema: &81 type: string - name: outdated in: query @@ -3475,7 +3533,7 @@ paths: title: Installation description: Installation type: object - properties: &24 + properties: &25 id: description: The ID of the installation. type: integer @@ -3486,8 +3544,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true - title: Enterprise description: An enterprise account @@ -3629,8 +3687,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true suspended_at: type: string @@ -3640,7 +3698,7 @@ paths: type: string example: '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' nullable: true - required: &25 + required: &26 - id - app_id - app_slug @@ -3730,7 +3788,7 @@ paths: description: installation_id parameter in: path required: true - schema: &27 + schema: &28 type: integer responses: '200': @@ -3741,8 +3799,8 @@ paths: title: Installation description: Installation type: object - properties: *24 - required: *25 + properties: *25 + required: *26 examples: default: value: @@ -3790,10 +3848,10 @@ paths: app_slug: github-actions '404': description: Resource Not Found - content: *26 + content: *27 '415': description: Preview Header Missing - content: &31 + content: &32 application/json: schema: type: object @@ -3828,13 +3886,13 @@ paths: description: installation_id parameter in: path required: true - schema: *27 + schema: *28 responses: '204': description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -3859,7 +3917,7 @@ paths: description: installation_id parameter in: path required: true - schema: *27 + schema: *28 requestBody: content: application/json: @@ -3886,8 +3944,8 @@ paths: type: object description: The permissions granted to the user-to-server access token. - properties: *28 - example: *29 + properties: *29 + example: *30 responses: '201': description: response @@ -3927,7 +3985,7 @@ paths: title: Repository description: A git repository type: object - properties: &71 + properties: &72 id: description: Unique identifier of the repository example: 42 @@ -3948,7 +4006,7 @@ paths: - title: License Simple description: License Simple type: object - properties: &96 + properties: &97 key: type: string example: mit @@ -3970,7 +4028,7 @@ paths: html_url: type: string format: uri - required: &97 + required: &98 - key - name - url @@ -4001,8 +4059,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true private: description: Whether the repository is private or public. @@ -4493,7 +4551,7 @@ paths: starred_at: type: string example: '"2020-07-09T00:17:42Z"' - required: &72 + required: &73 - archive_url - assignees_url - blobs_url @@ -4711,40 +4769,40 @@ paths: watchers: 1 '403': description: Forbidden - content: &33 + content: &34 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *30 + properties: *31 '415': description: Preview Header Missing - content: *31 + content: *32 '401': description: Requires Authentication - content: &34 + content: &35 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *30 + properties: *31 '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: &38 + content: &39 application/json: schema: title: Validation Error description: Validation Error type: object - required: &110 + required: &111 - message - documentation_url - properties: &111 + properties: &112 message: type: string documentation_url: @@ -4800,13 +4858,13 @@ paths: description: installation_id parameter in: path required: true - schema: *27 + schema: *28 responses: '204': description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4830,13 +4888,13 @@ paths: description: installation_id parameter in: path required: true - schema: *27 + schema: *28 responses: '204': description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4860,11 +4918,17 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -4876,7 +4940,7 @@ paths: title: Application Grant description: The authorization associated with an OAuth Access. type: object - properties: &35 + properties: &36 id: type: integer example: 1 @@ -4918,10 +4982,10 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true - required: &36 + required: &37 - app - id - scopes @@ -4950,13 +5014,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4987,7 +5051,7 @@ paths: description: grant_id parameter in: path required: true - schema: &37 + schema: &38 type: integer responses: '200': @@ -4998,8 +5062,8 @@ paths: title: Application Grant description: The authorization associated with an OAuth Access. type: object - properties: *35 - required: *36 + properties: *36 + required: *37 examples: default: value: @@ -5017,10 +5081,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5047,7 +5111,7 @@ paths: description: grant_id parameter in: path required: true - schema: *37 + schema: *38 responses: '204': description: Empty response @@ -5055,10 +5119,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5085,7 +5149,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: &39 + schema: &40 type: string requestBody: content: @@ -5104,7 +5168,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5131,11 +5195,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *39 + schema: *40 - name: access_token in: path required: true - schema: &41 + schema: &42 type: string responses: '204': @@ -5170,7 +5234,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *39 + schema: *40 requestBody: content: application/json: @@ -5192,11 +5256,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: &40 + value: &41 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -5235,10 +5299,10 @@ paths: site_admin: false '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5265,7 +5329,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *39 + schema: *40 requestBody: content: application/json: @@ -5287,14 +5351,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *40 + value: *41 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5318,7 +5382,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *39 + schema: *40 requestBody: content: application/json: @@ -5338,7 +5402,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5366,7 +5430,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *39 + schema: *40 requestBody: content: application/json: @@ -5410,8 +5474,8 @@ paths: type: object description: The permissions granted to the user-to-server access token. - properties: *28 - example: *29 + properties: *29 + example: *30 required: - access_token responses: @@ -5424,8 +5488,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: value: @@ -5495,16 +5559,16 @@ paths: single_file_paths: [] '401': description: Requires Authentication - content: *34 + content: *35 '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5529,11 +5593,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *39 + schema: *40 - name: access_token in: path required: true - schema: *41 + schema: *42 responses: '200': description: response @@ -5546,14 +5610,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *40 + value: *41 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5580,11 +5644,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *39 + schema: *40 - name: access_token in: path required: true - schema: *41 + schema: *42 responses: '200': description: response @@ -5595,11 +5659,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *40 + value: *41 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5626,11 +5690,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *39 + schema: *40 - name: access_token in: path required: true - schema: *41 + schema: *42 responses: '204': description: Empty response @@ -5675,21 +5739,21 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true examples: default: - value: *42 + value: *43 '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -5716,11 +5780,17 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -5733,11 +5803,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *43 + value: *44 headers: Link: example: ; rel="next", ; @@ -5747,13 +5817,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5829,11 +5899,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *44 + value: *45 headers: Location: example: https://api.github.com/authorizations/1 @@ -5841,24 +5911,24 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 '410': description: Gone - content: &49 + content: &50 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *30 + properties: *31 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5892,7 +5962,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *39 + schema: *40 requestBody: content: application/json: @@ -5936,8 +6006,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: response-if-returning-an-existing-token: value: @@ -5978,11 +6048,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *44 + value: *45 headers: Location: example: https://api.github.com/authorizations/1 @@ -5990,15 +6060,15 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -6030,7 +6100,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *39 + schema: *40 - name: fingerprint in: path required: true @@ -6075,8 +6145,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: response-if-returning-an-existing-token: value: @@ -6110,8 +6180,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: value: @@ -6138,7 +6208,7 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -6169,7 +6239,7 @@ paths: description: authorization_id parameter in: path required: true - schema: &45 + schema: &46 type: integer responses: '200': @@ -6181,11 +6251,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: &46 + value: &47 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -6206,10 +6276,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -6238,7 +6308,7 @@ paths: description: authorization_id parameter in: path required: true - schema: *45 + schema: *46 requestBody: content: application/json: @@ -6285,14 +6355,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *18 - required: *19 + properties: *19 + required: *20 examples: default: - value: *46 + value: *47 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -6322,7 +6392,7 @@ paths: description: authorization_id parameter in: path required: true - schema: *45 + schema: *46 responses: '204': description: Empty response @@ -6330,10 +6400,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -6365,7 +6435,7 @@ paths: title: Code Of Conduct description: Code Of Conduct type: object - properties: &47 + properties: &48 key: type: string example: contributor_covenant @@ -6431,7 +6501,7 @@ paths: type: string format: uri nullable: true - required: &48 + required: &49 - url - html_url - key @@ -6451,7 +6521,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6492,8 +6562,8 @@ paths: title: Code Of Conduct description: Code Of Conduct type: object - properties: *47 - required: *48 + properties: *48 + required: *49 examples: default: value: @@ -6552,12 +6622,12 @@ paths: html_url: http://contributor-covenant.org/version/1/4/ '404': description: Resource Not Found - content: *26 + content: *27 '304': description: Not Modified '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6662,21 +6732,21 @@ paths: self.save() '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 '410': description: Gone - content: *49 + content: *50 '415': description: Preview Header Missing - content: *31 + content: *32 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6738,7 +6808,7 @@ paths: title: Enterprise Announcement description: Enterprise global announcement type: object - properties: &50 + properties: &51 announcement: type: string description: The announcement text in GitHub Flavored Markdown. @@ -6754,12 +6824,12 @@ paths: it to an empty string.' example: '"2021-01-01T00:00:00.000-07:00"' nullable: true - required: &51 + required: &52 - announcement examples: default: summary: Default response - value: &52 + value: &53 announcement: Very **important** announcement about _nothing_. expires_at: '2021-01-01T00:00:00.000+00:00' x-github: @@ -6785,8 +6855,8 @@ paths: title: Enterprise Announcement description: Enterprise global announcement type: object - properties: *50 - required: *51 + properties: *51 + required: *52 responses: '200': description: response @@ -6796,12 +6866,12 @@ paths: title: Enterprise Announcement description: Enterprise global announcement type: object - properties: *50 - required: *51 + properties: *51 + required: *52 examples: default: summary: Default response - value: *52 + value: *53 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7082,7 +7152,7 @@ paths: this value with the enterprise id. in: path required: true - schema: &53 + schema: &54 type: string responses: '200': @@ -7097,7 +7167,7 @@ paths: description: 'The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.' - enum: &54 + enum: &55 - all - none - selected @@ -7111,7 +7181,7 @@ paths: description: 'The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.' - enum: &55 + enum: &56 - all - local_only - selected @@ -7152,7 +7222,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 responses: '204': description: Empty response @@ -7167,12 +7237,12 @@ paths: description: 'The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.' - enum: *54 + enum: *55 allowed_actions: type: string description: 'The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.' - enum: *55 + enum: *56 required: - enabled_organizations example: @@ -7203,11 +7273,11 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -7228,14 +7298,14 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *56 - required: *57 + properties: *57 + required: *58 required: - total_count - organizations examples: default: - value: &66 + value: &67 total_count: 1 organizations: - login: octocat @@ -7274,7 +7344,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 responses: '204': description: Empty response @@ -7321,12 +7391,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: org_id description: Unique identifier of an organization. in: path required: true - schema: &58 + schema: &59 type: integer responses: '204': @@ -7355,12 +7425,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: org_id description: Unique identifier of an organization. in: path required: true - schema: *58 + schema: *59 responses: '204': description: Empty response @@ -7389,7 +7459,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 responses: '200': description: response @@ -7397,7 +7467,7 @@ paths: application/json: schema: type: object - properties: &59 + properties: &60 github_owned_allowed: type: boolean description: Whether GitHub-owned actions are allowed. For example, @@ -7409,12 +7479,12 @@ paths: example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." items: type: string - required: &60 + required: &61 - github_owned_allowed - patterns_allowed examples: default: - value: &61 + value: &62 github_owned_allowed: true verified_allowed: false patterns_allowed: @@ -7444,7 +7514,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 responses: '204': description: Empty response @@ -7453,11 +7523,11 @@ paths: application/json: schema: type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: selected_actions: - value: *61 + value: *62 x-github: enabledForGitHubApps: false githubCloudOnly: false @@ -7483,11 +7553,11 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -7506,7 +7576,7 @@ paths: type: array items: type: object - properties: &62 + properties: &63 id: type: number name: @@ -7521,7 +7591,7 @@ paths: type: string allows_public_repositories: type: boolean - required: &63 + required: &64 - id - name - visibility @@ -7579,7 +7649,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 requestBody: content: application/json: @@ -7627,11 +7697,11 @@ paths: application/json: schema: type: object - properties: *62 - required: *63 + properties: *63 + required: *64 examples: default: - value: &64 + value: &65 id: 2 name: octo-runner-group visibility: selected @@ -7664,12 +7734,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: &65 + schema: &66 type: integer responses: '200': @@ -7678,11 +7748,11 @@ paths: application/json: schema: type: object - properties: *62 - required: *63 + properties: *63 + required: *64 examples: default: - value: *64 + value: *65 x-github: enabledForGitHubApps: false githubCloudOnly: false @@ -7707,12 +7777,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -7740,8 +7810,8 @@ paths: application/json: schema: type: object - properties: *62 - required: *63 + properties: *63 + required: *64 examples: default: value: @@ -7776,12 +7846,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 responses: '204': description: Empty response @@ -7810,16 +7880,16 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -7840,14 +7910,14 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *56 - required: *57 + properties: *57 + required: *58 required: - total_count - organizations examples: default: - value: *66 + value: *67 x-github: enabledForGitHubApps: false githubCloudOnly: false @@ -7872,12 +7942,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -7925,17 +7995,17 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 - name: org_id description: Unique identifier of an organization. in: path required: true - schema: *58 + schema: *59 responses: '204': description: Empty response @@ -7963,17 +8033,17 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 - name: org_id description: Unique identifier of an organization. in: path required: true - schema: *58 + schema: *59 responses: '204': description: Empty response @@ -8002,16 +8072,16 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -8032,7 +8102,7 @@ paths: title: Self hosted runners description: A self hosted runner type: object - properties: &68 + properties: &69 id: description: The id of the runner. type: integer @@ -8069,7 +8139,7 @@ paths: enum: - read-only - custom - required: &69 + required: &70 - id - name - os @@ -8081,7 +8151,7 @@ paths: - runners examples: default: - value: &70 + value: &71 total_count: 2 runners: - id: 23 @@ -8146,12 +8216,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -8199,17 +8269,17 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: &67 + schema: &68 type: integer responses: '204': @@ -8238,17 +8308,17 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *67 + schema: *68 responses: '204': description: Empty response @@ -8277,11 +8347,11 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -8302,11 +8372,11 @@ paths: title: Self hosted runners description: A self hosted runner type: object - properties: *68 - required: *69 + properties: *69 + required: *70 examples: default: - value: *70 + value: *71 headers: Link: example: ; rel="next", ; @@ -8337,7 +8407,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 responses: '200': description: response @@ -8349,7 +8419,7 @@ paths: title: Runner Application description: Runner Application type: object - properties: &120 + properties: &121 os: type: string architecture: @@ -8358,14 +8428,14 @@ paths: type: string filename: type: string - required: &121 + required: &122 - os - architecture - download_url - filename examples: default: - value: &122 + value: &123 - os: osx architecture: x64 download_url: https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz @@ -8419,7 +8489,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 responses: '201': description: response @@ -8429,7 +8499,7 @@ paths: title: Authentication Token description: Authentication Token type: object - properties: &73 + properties: &74 token: description: The token used for authentication type: string @@ -8451,8 +8521,8 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 single_file: type: string example: config.yaml @@ -8464,12 +8534,12 @@ paths: enum: - all - selected - required: &74 + required: &75 - token - expires_at examples: default: - value: &123 + value: &124 token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' x-github: @@ -8506,7 +8576,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 responses: '201': description: response @@ -8516,11 +8586,11 @@ paths: title: Authentication Token description: Authentication Token type: object - properties: *73 - required: *74 + properties: *74 + required: *75 examples: default: - value: &124 + value: &125 token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' x-github: @@ -8548,12 +8618,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *67 + schema: *68 responses: '200': description: response @@ -8563,11 +8633,11 @@ paths: title: Self hosted runners description: A self hosted runner type: object - properties: *68 - required: *69 + properties: *69 + required: *70 examples: default: - value: &125 + value: &126 id: 23 name: MBP os: macos @@ -8610,12 +8680,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *53 + schema: *54 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *67 + schema: *68 responses: '204': description: Empty response @@ -8641,7 +8711,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -8657,7 +8727,7 @@ paths: title: Event description: Event type: object - properties: &99 + properties: &100 id: type: string type: @@ -8667,7 +8737,7 @@ paths: title: Actor description: Actor type: object - properties: &75 + properties: &76 id: type: integer login: @@ -8683,7 +8753,7 @@ paths: avatar_url: type: string format: uri - required: &76 + required: &77 - id - login - gravatar_id @@ -8707,8 +8777,8 @@ paths: title: Actor description: Actor type: object - properties: *75 - required: *76 + properties: *76 + required: *77 payload: type: object properties: @@ -8766,8 +8836,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true labels: type: array @@ -8818,8 +8888,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assignees: type: array @@ -8827,8 +8897,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true milestone: @@ -8838,7 +8908,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &92 + properties: &93 url: type: string format: uri @@ -8883,8 +8953,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true open_issues: type: integer @@ -8910,7 +8980,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &93 + required: &94 - closed_issues - creator - description @@ -8982,7 +9052,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: &77 + enum: &78 - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER @@ -9002,8 +9072,8 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 performed_via_github_app: nullable: true allOf: @@ -9015,8 +9085,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true required: &300 - assignee @@ -9075,8 +9145,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -9094,7 +9164,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *77 + enum: *78 performed_via_github_app: nullable: true allOf: @@ -9106,13 +9176,13 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true reactions: title: Reaction Rollup type: object - properties: &94 + properties: &95 url: type: string format: uri @@ -9134,7 +9204,7 @@ paths: type: integer rocket: type: integer - required: &95 + required: &96 - url - total_count - "+1" @@ -9181,7 +9251,7 @@ paths: type: string format: date-time nullable: true - required: &100 + required: &101 - id - type - actor @@ -9193,7 +9263,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '503': description: Service Unavailable content: &243 @@ -9277,58 +9347,58 @@ paths: title: Link With Type description: Hypermedia Link with Type type: object - properties: &78 + properties: &79 href: type: string type: type: string - required: &79 + required: &80 - href - type user: title: Link With Type description: Hypermedia Link with Type type: object - properties: *78 - required: *79 + properties: *79 + required: *80 security_advisories: title: Link With Type description: Hypermedia Link with Type type: object - properties: *78 - required: *79 + properties: *79 + required: *80 current_user: title: Link With Type description: Hypermedia Link with Type type: object - properties: *78 - required: *79 + properties: *79 + required: *80 current_user_public: title: Link With Type description: Hypermedia Link with Type type: object - properties: *78 - required: *79 + properties: *79 + required: *80 current_user_actor: title: Link With Type description: Hypermedia Link with Type type: object - properties: *78 - required: *79 + properties: *79 + required: *80 current_user_organization: title: Link With Type description: Hypermedia Link with Type type: object - properties: *78 - required: *79 + properties: *79 + required: *80 current_user_organizations: type: array items: title: Link With Type description: Hypermedia Link with Type type: object - properties: *78 - required: *79 + properties: *79 + required: *80 required: - timeline - user @@ -9393,11 +9463,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -9413,7 +9483,7 @@ paths: title: Base Gist description: Base Gist type: object - properties: &81 + properties: &82 url: type: string format: uri @@ -9470,8 +9540,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true comments_url: type: string @@ -9482,8 +9552,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true truncated: type: boolean @@ -9493,7 +9563,7 @@ paths: history: type: array items: {} - required: &82 + required: &83 - id - node_id - url @@ -9512,7 +9582,7 @@ paths: - updated_at examples: default: - value: &83 + value: &84 - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits @@ -9564,7 +9634,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9632,7 +9702,7 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: &84 + properties: &85 url: type: string forks_url: @@ -9689,14 +9759,14 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true truncated: type: boolean examples: default: - value: &85 + value: &86 url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits @@ -9717,15 +9787,15 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9752,11 +9822,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -9772,11 +9842,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *81 - required: *82 + properties: *82 + required: *83 examples: default: - value: *83 + value: *84 headers: Link: example: ; rel="next", ; @@ -9784,12 +9854,12 @@ paths: schema: *6 '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9813,11 +9883,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -9833,11 +9903,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *81 - required: *82 + properties: *82 + required: *83 examples: default: - value: *83 + value: *84 headers: Link: example: ; rel="next", ; @@ -9845,12 +9915,12 @@ paths: schema: *6 '401': description: Requires Authentication - content: *34 + content: *35 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9872,7 +9942,7 @@ paths: description: gist_id parameter in: path required: true - schema: &86 + schema: &87 type: string responses: '200': @@ -9883,13 +9953,13 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *84 + properties: *85 examples: default: - value: *85 + value: *86 '403': description: Forbidden Gist - content: &90 + content: &91 application/json: schema: type: object @@ -9910,7 +9980,7 @@ paths: type: string '404': description: Resource Not Found - content: *26 + content: *27 '304': description: Not Modified x-github: @@ -9935,7 +10005,7 @@ paths: description: gist_id parameter in: path required: true - schema: *86 + schema: *87 requestBody: content: application/json: @@ -9986,16 +10056,16 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *84 + properties: *85 examples: default: - value: *85 + value: *86 '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10016,18 +10086,18 @@ paths: description: gist_id parameter in: path required: true - schema: *86 + schema: *87 responses: '204': description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10049,11 +10119,11 @@ paths: description: gist_id parameter in: path required: true - schema: *86 + schema: *87 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -10069,7 +10139,7 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: &87 + properties: &88 id: type: integer example: 1 @@ -10091,8 +10161,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -10107,8 +10177,8 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *77 - required: &88 + enum: *78 + required: &89 - url - id - node_id @@ -10155,10 +10225,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10179,7 +10249,7 @@ paths: description: gist_id parameter in: path required: true - schema: *86 + schema: *87 requestBody: content: application/json: @@ -10202,11 +10272,11 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *87 - required: *88 + properties: *88 + required: *89 examples: default: - value: &89 + value: &90 id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== url: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 @@ -10242,10 +10312,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10267,12 +10337,12 @@ paths: description: gist_id parameter in: path required: true - schema: *86 + schema: *87 - name: comment_id description: comment_id parameter in: path required: true - schema: &91 + schema: &92 type: integer responses: '200': @@ -10283,19 +10353,19 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *87 - required: *88 + properties: *88 + required: *89 examples: default: - value: *89 + value: *90 '304': description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden Gist - content: *90 + content: *91 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10316,12 +10386,12 @@ paths: description: gist_id parameter in: path required: true - schema: *86 + schema: *87 - name: comment_id description: comment_id parameter in: path required: true - schema: *91 + schema: *92 requestBody: content: application/json: @@ -10344,14 +10414,14 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *87 - required: *88 + properties: *88 + required: *89 examples: default: - value: *89 + value: *90 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10372,12 +10442,12 @@ paths: description: gist_id parameter in: path required: true - schema: *86 + schema: *87 - name: comment_id description: comment_id parameter in: path required: true - schema: *91 + schema: *92 responses: '204': description: Empty response @@ -10385,10 +10455,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10410,11 +10480,11 @@ paths: description: gist_id parameter in: path required: true - schema: *86 + schema: *87 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -10444,8 +10514,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true change_status: type: object @@ -10502,12 +10572,12 @@ paths: type: string '404': description: Resource Not Found - content: *26 + content: *27 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10529,11 +10599,11 @@ paths: description: gist_id parameter in: path required: true - schema: *86 + schema: *87 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -10549,7 +10619,7 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *84 + properties: *85 examples: default: value: @@ -10601,12 +10671,12 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10627,7 +10697,7 @@ paths: description: gist_id parameter in: path required: true - schema: *86 + schema: *87 responses: '201': description: response @@ -10637,8 +10707,8 @@ paths: title: Base Gist description: Base Gist type: object - properties: *81 - required: *82 + properties: *82 + required: *83 examples: default: value: @@ -10691,15 +10761,15 @@ paths: type: string '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10721,7 +10791,7 @@ paths: description: gist_id parameter in: path required: true - schema: *86 + schema: *87 responses: '204': description: Response if gist is starred @@ -10737,7 +10807,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10759,18 +10829,18 @@ paths: description: gist_id parameter in: path required: true - schema: *86 + schema: *87 responses: '204': description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10791,7 +10861,7 @@ paths: description: gist_id parameter in: path required: true - schema: *86 + schema: *87 responses: '204': description: Empty response @@ -10799,10 +10869,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10824,7 +10894,7 @@ paths: description: gist_id parameter in: path required: true - schema: *86 + schema: *87 - name: sha in: path required: true @@ -10839,19 +10909,19 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *84 + properties: *85 examples: default: - value: *85 + value: *86 '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10996,7 +11066,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -11020,8 +11090,8 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 repository_selection: type: string example: selected @@ -11149,12 +11219,12 @@ paths: schema: *6 '403': description: Forbidden - content: *33 + content: *34 '304': description: Not Modified '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11228,6 +11298,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -11246,7 +11317,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: &134 + schema: &135 type: string - name: sort description: What to sort results by. Can be either `created`, `updated`, @@ -11264,19 +11335,14 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: &135 - type: string - enum: - - asc - - desc - default: desc + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: collab in: query required: false @@ -11300,7 +11366,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -11366,8 +11432,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true labels: description: Labels to associate with this issue; pass one or @@ -11407,8 +11473,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assignees: type: array @@ -11416,8 +11482,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true milestone: @@ -11426,8 +11492,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *92 - required: *93 + properties: *93 + required: *94 locked: type: boolean active_lock_reason: @@ -11479,8 +11545,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body_html: type: string @@ -11493,8 +11559,8 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 performed_via_github_app: nullable: true allOf: @@ -11505,20 +11571,20 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true author_association: title: author_association type: string example: OWNER description: How the author is associated with the repository. - enum: *77 + enum: *78 reactions: title: Reaction Rollup type: object - properties: *94 - required: *95 + properties: *95 + required: *96 required: &137 - assignee - closed_at @@ -11792,12 +11858,12 @@ paths: schema: *6 '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11833,7 +11899,11 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 responses: '200': description: response @@ -11845,8 +11915,8 @@ paths: title: License Simple description: License Simple type: object - properties: *96 - required: *97 + properties: *97 + required: *98 examples: default: value: @@ -12071,10 +12141,10 @@ paths: featured: true '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 '304': description: Not Modified x-github: @@ -12131,7 +12201,7 @@ paths: type: string X-CommonMarker-Version: example: 0.17.4 - schema: &98 + schema: &99 type: string content: text/html: @@ -12174,7 +12244,7 @@ paths: headers: X-CommonMarker-Version: example: 0.17.4 - schema: *98 + schema: *99 content: text/html: schema: @@ -12253,7 +12323,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -12269,14 +12339,14 @@ paths: title: Event description: Event type: object - properties: *99 - required: *100 + properties: *100 + required: *101 '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '304': description: Not Modified '301': @@ -12320,7 +12390,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -12332,7 +12402,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -12348,14 +12418,14 @@ paths: title: Thread description: Thread type: object - properties: &101 + properties: &102 id: type: string repository: title: Minimal Repository description: Minimal Repository type: object - properties: &129 + properties: &130 id: type: integer example: 1296269 @@ -12375,8 +12445,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true private: type: boolean @@ -12597,8 +12667,8 @@ paths: - title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 temp_clone_token: type: string delete_branch_on_merge: @@ -12630,7 +12700,7 @@ paths: watchers: type: integer example: 0 - required: &130 + required: &131 - archive_url - assignees_url - blobs_url @@ -12707,7 +12777,7 @@ paths: subscription_url: type: string example: https://api.github.com/notifications/threads/2/subscription - required: &102 + required: &103 - id - unread - reason @@ -12808,13 +12878,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12866,10 +12936,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12891,7 +12961,7 @@ paths: description: thread_id parameter in: path required: true - schema: &103 + schema: &104 type: integer responses: '200': @@ -12902,8 +12972,8 @@ paths: title: Thread description: Thread type: object - properties: *101 - required: *102 + properties: *102 + required: *103 examples: default: value: @@ -12990,10 +13060,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -13014,7 +13084,7 @@ paths: description: thread_id parameter in: path required: true - schema: *103 + schema: *104 responses: '205': description: response @@ -13022,7 +13092,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -13047,7 +13117,7 @@ paths: description: thread_id parameter in: path required: true - schema: *103 + schema: *104 responses: '200': description: response @@ -13057,7 +13127,7 @@ paths: title: Thread Subscription description: Thread Subscription type: object - properties: &104 + properties: &105 subscribed: type: boolean example: true @@ -13083,7 +13153,7 @@ paths: type: string format: uri example: https://api.github.com/repos/1 - required: &105 + required: &106 - created_at - ignored - reason @@ -13091,7 +13161,7 @@ paths: - subscribed examples: default: - value: &106 + value: &107 subscribed: true ignored: false reason: @@ -13102,10 +13172,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -13131,7 +13201,7 @@ paths: description: thread_id parameter in: path required: true - schema: *103 + schema: *104 requestBody: content: application/json: @@ -13151,19 +13221,19 @@ paths: title: Thread Subscription description: Thread Subscription type: object - properties: *104 - required: *105 + properties: *105 + required: *106 examples: default: - value: *106 + value: *107 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -13188,7 +13258,7 @@ paths: description: thread_id parameter in: path required: true - schema: *103 + schema: *104 responses: '204': description: Empty response @@ -13196,10 +13266,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -13256,7 +13326,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 responses: '200': description: response @@ -13268,11 +13338,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *56 - required: *57 + properties: *57 + required: *58 examples: default: - value: &404 + value: &405 - login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= @@ -13315,7 +13385,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 responses: '200': description: response @@ -13325,7 +13395,7 @@ paths: title: Organization Full description: Organization Full type: object - properties: &108 + properties: &109 login: type: string example: github @@ -13488,7 +13558,7 @@ paths: updated_at: type: string format: date-time - required: &109 + required: &110 - login - url - id @@ -13602,7 +13672,7 @@ paths: seats: 5 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13634,7 +13704,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 requestBody: content: application/json: @@ -13772,8 +13842,8 @@ paths: title: Organization Full description: Organization Full type: object - properties: *108 - required: *109 + properties: *109 + required: *110 examples: default: value: @@ -13833,13 +13903,13 @@ paths: - title: Validation Error description: Validation Error type: object - required: *110 - properties: *111 + required: *111 + properties: *112 - title: Validation Error Simple description: Validation Error Simple type: object - required: *112 - properties: *113 + required: *113 + properties: *114 '409': description: Conflict content: &260 @@ -13848,10 +13918,10 @@ paths: title: Basic Error description: Basic Error type: object - properties: *30 + properties: *31 '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13884,7 +13954,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 responses: '200': description: response @@ -13898,7 +13968,7 @@ paths: description: 'The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.' - enum: &114 + enum: &115 - all - none - selected @@ -13912,7 +13982,7 @@ paths: description: 'The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.' - enum: *55 + enum: *56 selected_actions_url: type: string description: The API URL to use to get or set the actions that @@ -13950,7 +14020,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 responses: '204': description: Empty response @@ -13965,12 +14035,12 @@ paths: description: 'The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.' - enum: *114 + enum: *115 allowed_actions: type: string description: 'The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.' - enum: *55 + enum: *56 required: - enabled_repositories example: @@ -13999,11 +14069,11 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -14027,11 +14097,11 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 examples: default: - value: &119 + value: &120 total_count: 1 repositories: - id: 1296269 @@ -14172,7 +14242,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 responses: '204': description: Empty response @@ -14217,11 +14287,11 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: repository_id in: path required: true - schema: &115 + schema: &116 type: integer responses: '204': @@ -14248,11 +14318,11 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: repository_id in: path required: true - schema: *115 + schema: *116 responses: '204': description: Empty response @@ -14279,7 +14349,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 responses: '200': description: response @@ -14287,11 +14357,11 @@ paths: application/json: schema: type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: default: - value: *61 + value: *62 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -14318,7 +14388,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 responses: '204': description: Empty response @@ -14327,11 +14397,11 @@ paths: application/json: schema: type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: selected_actions: - value: *61 + value: *62 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -14354,11 +14424,11 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -14380,7 +14450,7 @@ paths: type: array items: type: object - properties: &116 + properties: &117 id: type: number name: @@ -14402,7 +14472,7 @@ paths: type: boolean allows_public_repositories: type: boolean - required: &117 + required: &118 - id - name - visibility @@ -14461,7 +14531,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 requestBody: content: application/json: @@ -14511,11 +14581,11 @@ paths: application/json: schema: type: object - properties: *116 - required: *117 + properties: *117 + required: *118 examples: default: - value: &118 + value: &119 id: 2 name: octo-runner-group visibility: selected @@ -14546,12 +14616,12 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 responses: '200': description: response @@ -14559,8 +14629,8 @@ paths: application/json: schema: type: object - properties: *116 - required: *117 + properties: *117 + required: *118 examples: default: value: @@ -14593,12 +14663,12 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -14627,11 +14697,11 @@ paths: application/json: schema: type: object - properties: *116 - required: *117 + properties: *117 + required: *118 examples: default: - value: *118 + value: *119 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -14653,12 +14723,12 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 responses: '204': description: Empty response @@ -14687,12 +14757,20 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *33 responses: '200': description: response @@ -14712,11 +14790,11 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 examples: default: - value: *119 + value: *120 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -14738,12 +14816,12 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -14787,16 +14865,16 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 - name: repository_id in: path required: true - schema: *115 + schema: *116 responses: '204': description: Empty response @@ -14821,16 +14899,16 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 - name: repository_id in: path required: true - schema: *115 + schema: *116 responses: '204': description: Empty response @@ -14856,16 +14934,16 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -14889,11 +14967,11 @@ paths: title: Self hosted runners description: A self hosted runner type: object - properties: *68 - required: *69 + properties: *69 + required: *70 examples: default: - value: *70 + value: *71 headers: Link: example: ; rel="next", ; @@ -14920,12 +14998,12 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 requestBody: content: application/json: @@ -14969,17 +15047,17 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *67 + schema: *68 responses: '204': description: Empty response @@ -15004,17 +15082,17 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *65 + schema: *66 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *67 + schema: *68 responses: '204': description: Empty response @@ -15041,11 +15119,11 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -15069,11 +15147,11 @@ paths: title: Self hosted runners description: A self hosted runner type: object - properties: *68 - required: *69 + properties: *69 + required: *70 examples: default: - value: *70 + value: *71 headers: Link: example: ; rel="next", ; @@ -15102,7 +15180,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 responses: '200': description: response @@ -15114,11 +15192,11 @@ paths: title: Runner Application description: Runner Application type: object - properties: *120 - required: *121 + properties: *121 + required: *122 examples: default: - value: *122 + value: *123 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15150,7 +15228,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 responses: '201': description: response @@ -15160,11 +15238,11 @@ paths: title: Authentication Token description: Authentication Token type: object - properties: *73 - required: *74 + properties: *74 + required: *75 examples: default: - value: *123 + value: *124 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15197,7 +15275,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 responses: '201': description: response @@ -15207,11 +15285,11 @@ paths: title: Authentication Token description: Authentication Token type: object - properties: *73 - required: *74 + properties: *74 + required: *75 examples: default: - value: *124 + value: *125 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15235,12 +15313,12 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *67 + schema: *68 responses: '200': description: response @@ -15250,11 +15328,11 @@ paths: title: Self hosted runners description: A self hosted runner type: object - properties: *68 - required: *69 + properties: *69 + required: *70 examples: default: - value: *125 + value: *126 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15277,12 +15355,12 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *67 + schema: *68 responses: '204': description: Empty response @@ -15309,11 +15387,11 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -15337,7 +15415,7 @@ paths: title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object - properties: &126 + properties: &127 name: description: The name of the secret. example: SECRET_TOKEN @@ -15359,7 +15437,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/org/secrets/my_secret/repositories - required: &127 + required: &128 - name - created_at - updated_at @@ -15410,7 +15488,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 responses: '200': description: response @@ -15472,12 +15550,12 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: secret_name description: secret_name parameter in: path required: true - schema: &128 + schema: &129 type: string responses: '200': @@ -15488,8 +15566,8 @@ paths: title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object - properties: *126 - required: *127 + properties: *127 + required: *128 examples: default: value: @@ -15592,12 +15670,12 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: secret_name description: secret_name parameter in: path required: true - schema: *128 + schema: *129 requestBody: content: application/json: @@ -15671,12 +15749,12 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: secret_name description: secret_name parameter in: path required: true - schema: *128 + schema: *129 responses: '204': description: Empty response @@ -15703,12 +15781,20 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: secret_name description: secret_name parameter in: path required: true - schema: *128 + schema: *129 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *33 responses: '200': description: response @@ -15728,8 +15814,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 examples: default: value: @@ -15825,12 +15911,12 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: secret_name description: secret_name parameter in: path required: true - schema: *128 + schema: *129 requestBody: content: application/json: @@ -15879,12 +15965,12 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: secret_name description: secret_name parameter in: path required: true - schema: *128 + schema: *129 - name: repository_id in: path required: true @@ -15919,12 +16005,12 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: secret_name description: secret_name parameter in: path required: true - schema: *128 + schema: *129 - name: repository_id in: path required: true @@ -15955,11 +16041,11 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -15975,8 +16061,8 @@ paths: title: Event description: Event type: object - properties: *99 - required: *100 + properties: *100 + required: *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15997,11 +16083,11 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -16017,7 +16103,7 @@ paths: title: Org Hook description: Org Hook type: object - properties: &131 + properties: &132 id: type: integer example: 1 @@ -16067,7 +16153,7 @@ paths: example: '2011-09-06T17:26:27Z' type: type: string - required: &132 + required: &133 - id - url - type @@ -16102,7 +16188,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16123,7 +16209,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 requestBody: content: application/json: @@ -16206,11 +16292,11 @@ paths: title: Org Hook description: Org Hook type: object - properties: *131 - required: *132 + properties: *132 + required: *133 examples: default: - value: &133 + value: &134 id: 1 url: https://api.github.com/orgs/octocat/hooks/1 ping_url: https://api.github.com/orgs/octocat/hooks/1/pings @@ -16232,10 +16318,10 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16257,7 +16343,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: hook_id in: path required: true @@ -16271,14 +16357,14 @@ paths: title: Org Hook description: Org Hook type: object - properties: *131 - required: *132 + properties: *132 + required: *133 examples: default: - value: *133 + value: *134 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16302,7 +16388,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: hook_id in: path required: true @@ -16375,8 +16461,8 @@ paths: title: Org Hook description: Org Hook type: object - properties: *131 - required: *132 + properties: *132 + required: *133 examples: default: value: @@ -16395,10 +16481,10 @@ paths: type: Organization '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16418,7 +16504,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: hook_id in: path required: true @@ -16428,7 +16514,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16452,7 +16538,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: hook_id in: path required: true @@ -16466,10 +16552,10 @@ paths: title: Webhook Configuration description: Configuration object of the webhook type: object - properties: *22 + properties: *23 examples: default: - value: *23 + value: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16492,7 +16578,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: hook_id in: path required: true @@ -16542,10 +16628,10 @@ paths: title: Webhook Configuration description: Configuration object of the webhook type: object - properties: *22 + properties: *23 examples: default: - value: *23 + value: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16567,7 +16653,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: hook_id in: path required: true @@ -16577,7 +16663,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16601,7 +16687,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 responses: '200': description: response @@ -16611,8 +16697,8 @@ paths: title: Installation description: Installation type: object - properties: *24 - required: *25 + properties: *25 + required: *26 examples: default: value: &295 @@ -16680,11 +16766,11 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -16708,8 +16794,8 @@ paths: title: Installation description: Installation type: object - properties: *24 - required: *25 + properties: *25 + required: *26 examples: default: value: @@ -16789,7 +16875,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: filter description: "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you @@ -16805,6 +16891,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -16823,7 +16910,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *134 + schema: *135 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -16840,18 +16927,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *135 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -16880,7 +16967,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -16913,7 +17000,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: filter description: "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -16943,7 +17030,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -16959,8 +17046,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -16997,7 +17084,7 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17018,7 +17105,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: username in: path required: true @@ -17057,7 +17144,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: username in: path required: true @@ -17067,7 +17154,7 @@ paths: description: Empty response '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17089,7 +17176,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: username in: path required: true @@ -17122,16 +17209,16 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *56 - required: *57 + properties: *57 + required: *58 user: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true permissions: type: object @@ -17267,10 +17354,10 @@ paths: site_admin: false '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17302,7 +17389,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: username in: path required: true @@ -17415,10 +17502,10 @@ paths: site_admin: false '422': description: Validation Failed - content: *38 + content: *39 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17441,7 +17528,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: username in: path required: true @@ -17451,10 +17538,10 @@ paths: description: Empty response '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17475,7 +17562,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: filter description: "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -17491,7 +17578,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -17507,8 +17594,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -17541,7 +17628,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: username in: path required: true @@ -17575,7 +17662,7 @@ paths: documentation_url: https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#convert-member-to-outside-collaborator '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17596,7 +17683,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: username in: path required: true @@ -17644,7 +17731,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: per_page description: Results per page (max 100) in: query @@ -17653,6 +17740,22 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + description: The sort order for the response collection. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -17711,11 +17814,11 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -17762,11 +17865,11 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -17827,11 +17930,11 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -17876,7 +17979,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: state description: Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. @@ -17892,7 +17995,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -17955,8 +18058,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -18064,7 +18167,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 requestBody: content: application/json: @@ -18129,16 +18232,16 @@ paths: updated_at: '2014-03-04T18:58:10Z' '401': description: Requires Authentication - content: *34 + content: *35 '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 '410': description: Gone - content: *49 + content: *50 '422': description: Validation Failed content: *144 @@ -18170,11 +18273,11 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -18190,8 +18293,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -18221,7 +18324,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: username in: path required: true @@ -18253,7 +18356,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: username in: path required: true @@ -18263,7 +18366,7 @@ paths: description: Empty response '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -18283,7 +18386,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: username in: path required: true @@ -18311,7 +18414,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: type description: 'Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. @@ -18356,7 +18459,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -18372,8 +18475,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 examples: default: value: &171 @@ -18640,7 +18743,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 requestBody: content: application/json: @@ -18761,8 +18864,8 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 examples: default: value: &279 @@ -18889,10 +18992,10 @@ paths: type: string '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18931,11 +19034,11 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -19082,7 +19185,7 @@ paths: schema: *6 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19105,7 +19208,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 requestBody: content: application/json: @@ -19250,8 +19353,8 @@ paths: title: Organization Full description: Organization Full type: object - properties: *108 - required: *109 + properties: *109 + required: *110 ldap_dn: description: Distinguished Name (DN) that team maps to within LDAP environment @@ -19322,10 +19425,10 @@ paths: ldap_dn: uid=asdf,ou=users,dc=github,dc=com '422': description: Validation Failed - content: *38 + content: *39 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19349,7 +19452,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -19373,7 +19476,7 @@ paths: value: *151 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19396,7 +19499,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -19488,7 +19591,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -19520,7 +19623,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -19530,15 +19633,21 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *135 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: pinned + in: query + required: false + description: Pinned discussions only filter + schema: + type: string responses: '200': description: response @@ -19558,8 +19667,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: description: The main text of the discussion. @@ -19630,8 +19739,8 @@ paths: reactions: title: Reaction Rollup type: object - properties: *94 - required: *95 + properties: *95 + required: *96 required: &154 - author - body @@ -19652,7 +19761,7 @@ paths: - url examples: default: - value: &379 + value: &380 - author: login: octocat id: 1 @@ -19739,7 +19848,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -19866,7 +19975,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -19924,7 +20033,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -19962,7 +20071,7 @@ paths: required: *154 examples: default: - value: &380 + value: &381 author: login: octocat id: 1 @@ -20042,7 +20151,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -20078,7 +20187,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -20092,11 +20201,11 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *135 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -20119,8 +20228,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: description: The main text of the comment. @@ -20170,8 +20279,8 @@ paths: reactions: title: Reaction Rollup type: object - properties: *94 - required: *95 + properties: *95 + required: *96 required: &158 - author - body @@ -20187,7 +20296,7 @@ paths: - url examples: default: - value: &381 + value: &382 - author: login: octocat id: 1 @@ -20268,7 +20377,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -20380,7 +20489,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -20441,7 +20550,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -20481,7 +20590,7 @@ paths: required: *158 examples: default: - value: &382 + value: &383 author: login: octocat id: 1 @@ -20555,7 +20664,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -20595,7 +20704,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -20628,7 +20737,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -20658,8 +20767,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true content: description: The reaction to use @@ -20747,7 +20856,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -20855,7 +20964,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -20910,7 +21019,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -20939,7 +21048,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -20998,7 +21107,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -21079,7 +21188,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -21129,7 +21238,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -21151,7 +21260,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -21167,8 +21276,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -21205,7 +21314,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -21245,19 +21354,19 @@ paths: examples: response-if-user-has-an-active-membership-with-team: summary: Response if user has an active membership with team - value: &383 + value: &384 url: https://api.github.com/teams/1/memberships/octocat role: member state: active response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer - value: &384 + value: &385 url: https://api.github.com/teams/1/memberships/octocat role: maintainer state: active response-if-user-has-a-pending-membership-with-team: summary: Response if user has a pending membership with team - value: &385 + value: &386 url: https://api.github.com/teams/1/memberships/octocat role: member state: pending @@ -21293,7 +21402,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -21334,13 +21443,13 @@ paths: examples: response-if-users-membership-with-team-is-now-active: summary: Response if user's membership with team is now active - value: &386 + value: &387 url: https://api.github.com/teams/1/memberships/octocat role: member state: active response-if-users-membership-with-team-is-now-pending: summary: Response if user's membership with team is now pending - value: &387 + value: &388 url: https://api.github.com/teams/1/memberships/octocat role: member state: pending @@ -21400,7 +21509,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -21438,7 +21547,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -21447,7 +21556,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -21489,8 +21598,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -21534,7 +21643,7 @@ paths: - permissions examples: default: - value: &388 + value: &389 - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 html_url: https://github.com/orgs/api-playground/projects/1 @@ -21607,7 +21716,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -21631,7 +21740,7 @@ paths: required: *169 examples: default: - value: &389 + value: &390 owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 html_url: https://github.com/orgs/api-playground/projects/1 @@ -21700,7 +21809,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -21781,7 +21890,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -21817,7 +21926,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -21826,7 +21935,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -21842,8 +21951,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 examples: default: value: *171 @@ -21879,7 +21988,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -21902,7 +22011,7 @@ paths: title: Team Repository description: A team's access to a repository. type: object - properties: &390 + properties: &391 id: description: Unique identifier of the repository example: 42 @@ -21923,8 +22032,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *96 - required: *97 + properties: *97 + required: *98 forks: type: integer permissions: @@ -21950,8 +22059,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true private: description: Whether the repository is private or public. @@ -22207,8 +22316,8 @@ paths: - title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 temp_clone_token: type: string allow_squash_merge: @@ -22237,7 +22346,7 @@ paths: type: integer master_branch: type: string - required: &391 + required: &392 - archive_url - assignees_url - blobs_url @@ -22573,7 +22682,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -22640,7 +22749,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -22680,7 +22789,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: team_slug description: team_slug parameter in: path @@ -22689,7 +22798,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -22710,7 +22819,7 @@ paths: required: *175 examples: response-if-child-teams-exist: - value: &392 + value: &393 - id: 2 node_id: MDQ6VGVhbTI= url: https://api.github.com/teams/2 @@ -22793,8 +22902,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -22866,13 +22975,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22934,13 +23043,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed content: *144 @@ -22994,10 +23103,10 @@ paths: type: string '401': description: Requires Authentication - content: *34 + content: *35 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23082,7 +23191,7 @@ paths: type: string '401': description: Requires Authentication - content: *34 + content: *35 '503': description: Service Unavailable content: @@ -23107,7 +23216,7 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23203,13 +23312,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23268,10 +23377,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23307,10 +23416,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23355,7 +23464,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -23414,10 +23523,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23495,10 +23604,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 '422': description: Validation Failed content: @@ -23508,13 +23617,13 @@ paths: - title: Validation Error description: Validation Error type: object - required: *110 - properties: *111 + required: *111 + properties: *112 - title: Validation Error Simple description: Validation Error Simple type: object - required: *112 - properties: *113 + required: *113 + properties: *114 '503': description: Service Unavailable content: @@ -23592,13 +23701,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed content: *144 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23678,10 +23787,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23779,10 +23888,10 @@ paths: type: string '401': description: Requires Authentication - content: *34 + content: *35 '410': description: Gone - content: *49 + content: *50 '422': description: Validation Failed content: *144 @@ -23836,13 +23945,13 @@ paths: type: string '401': description: Requires Authentication - content: *34 + content: *35 '410': description: Gone - content: *49 + content: *50 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23894,7 +24003,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -23910,8 +24019,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -23923,21 +24032,21 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 '415': description: Preview Header Missing - content: *31 + content: *32 '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23991,21 +24100,21 @@ paths: description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 '415': description: Preview Header Missing - content: *31 + content: *32 '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24045,19 +24154,19 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '415': description: Preview Header Missing - content: *31 + content: *32 '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *38 + content: *39 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24111,8 +24220,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true required: &255 - permission @@ -24142,21 +24251,21 @@ paths: site_admin: false '404': description: Resource Not Found - content: *26 + content: *27 '415': description: Preview Header Missing - content: *31 + content: *32 '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24188,7 +24297,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -24226,10 +24335,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24293,13 +24402,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed content: *144 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24436,7 +24545,7 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24468,16 +24577,16 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 '410': description: Gone - content: *49 + content: *50 '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24547,8 +24656,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true private: type: boolean @@ -24801,8 +24910,8 @@ paths: - title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 temp_clone_token: type: string nullable: true @@ -24827,29 +24936,29 @@ paths: - title: License Simple description: License Simple type: object - properties: *96 - required: *97 + properties: *97 + required: *98 organization: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true parent: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 source: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 forks: type: integer master_branch: @@ -25939,10 +26048,10 @@ paths: url: https://api.github.com/repos/github/docs/community/code_of_conduct '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 '301': description: Moved Permanently x-github: @@ -26588,13 +26697,13 @@ paths: watchers: 1 '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26661,7 +26770,7 @@ paths: documentation_url: https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-a-repository '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26693,7 +26802,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -27257,7 +27366,7 @@ paths: description: 'The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.' - enum: *55 + enum: *56 selected_actions_url: type: string description: The API URL to use to get or set the actions that @@ -27316,7 +27425,7 @@ paths: type: string description: 'The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.' - enum: *55 + enum: *56 required: - enabled example: @@ -27357,11 +27466,11 @@ paths: application/json: schema: type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: default: - value: *61 + value: *62 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -27401,11 +27510,11 @@ paths: application/json: schema: type: object - properties: *59 - required: *60 + properties: *60 + required: *61 examples: selected_actions: - value: *61 + value: *62 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -27435,7 +27544,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -27459,11 +27568,11 @@ paths: title: Self hosted runners description: A self hosted runner type: object - properties: *68 - required: *69 + properties: *69 + required: *70 examples: default: - value: *70 + value: *71 headers: Link: example: ; rel="next", ; @@ -27508,11 +27617,11 @@ paths: title: Runner Application description: Runner Application type: object - properties: *120 - required: *121 + properties: *121 + required: *122 examples: default: - value: *122 + value: *123 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27552,11 +27661,11 @@ paths: title: Authentication Token description: Authentication Token type: object - properties: *73 - required: *74 + properties: *74 + required: *75 examples: default: - value: *123 + value: *124 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27596,11 +27705,11 @@ paths: title: Authentication Token description: Authentication Token type: object - properties: *73 - required: *74 + properties: *74 + required: *75 examples: default: - value: *124 + value: *125 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27634,7 +27743,7 @@ paths: description: Unique identifier of the self-hosted runner. in: path required: true - schema: *67 + schema: *68 responses: '200': description: response @@ -27644,11 +27753,11 @@ paths: title: Self hosted runners description: A self hosted runner type: object - properties: *68 - required: *69 + properties: *69 + required: *70 examples: default: - value: *125 + value: *126 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27681,7 +27790,7 @@ paths: description: Unique identifier of the self-hosted runner. in: path required: true - schema: *67 + schema: *68 responses: '204': description: Empty response @@ -27762,7 +27871,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -27983,14 +28092,14 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 head_repository: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 head_repository_id: type: integer example: 5 @@ -28478,7 +28587,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -28597,7 +28706,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -28849,7 +28958,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -28979,7 +29088,7 @@ paths: description: secret_name parameter in: path required: true - schema: *128 + schema: *129 responses: '200': description: response @@ -29100,7 +29209,7 @@ paths: description: secret_name parameter in: path required: true - schema: *128 + schema: *129 requestBody: content: application/json: @@ -29155,7 +29264,7 @@ paths: description: secret_name parameter in: path required: true - schema: *128 + schema: *129 responses: '204': description: Empty response @@ -29190,7 +29299,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -29561,7 +29670,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -29624,7 +29733,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -29640,8 +29749,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -29653,7 +29762,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29701,7 +29810,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *30 + properties: *31 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29738,7 +29847,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -29828,8 +29937,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true teams: description: The list of teams with review dismissal @@ -30120,7 +30229,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30271,8 +30380,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true committer: nullable: true @@ -30280,8 +30389,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true parents: type: array @@ -30476,10 +30585,10 @@ paths: protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection '415': description: Preview Header Missing - content: *31 + content: *32 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30657,7 +30766,7 @@ paths: enabled: true '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30919,8 +31028,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true teams: type: array @@ -30998,16 +31107,16 @@ paths: - url '403': description: Forbidden - content: *33 + content: *34 '415': description: Preview Header Missing - content: *31 + content: *32 '422': description: Validation Failed content: *144 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31054,7 +31163,7 @@ paths: description: Empty response '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31191,7 +31300,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31384,7 +31493,7 @@ paths: value: *223 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31431,7 +31540,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31486,7 +31595,7 @@ paths: enabled: true '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31543,7 +31652,7 @@ paths: value: *224 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31589,7 +31698,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31653,7 +31762,7 @@ paths: contexts_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31722,10 +31831,10 @@ paths: value: *227 '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31811,7 +31920,7 @@ paths: - continuous-integration/travis-ci '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31876,13 +31985,13 @@ paths: - continuous-integration/jenkins '422': description: Validation Failed - content: *38 + content: *39 '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31947,10 +32056,10 @@ paths: - continuous-integration/travis-ci '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32015,10 +32124,10 @@ paths: - continuous-integration/travis-ci '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32139,7 +32248,7 @@ paths: - pull_request '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32225,8 +32334,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true examples: default: @@ -32269,7 +32378,7 @@ paths: - pull_request '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32338,15 +32447,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true examples: default: value: *228 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32416,15 +32525,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true examples: default: value: *228 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32494,15 +32603,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true examples: default: value: *228 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32557,7 +32666,7 @@ paths: value: *229 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32630,7 +32739,7 @@ paths: value: *229 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32704,7 +32813,7 @@ paths: value: *229 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32778,7 +32887,7 @@ paths: value: *229 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32825,15 +32934,15 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: value: *141 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32898,15 +33007,15 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: value: *141 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32972,15 +33081,15 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: value: *141 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33046,15 +33155,15 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: value: *141 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33471,8 +33580,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true pull_requests: items: @@ -33548,8 +33657,8 @@ paths: They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true required: - id @@ -34178,7 +34287,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -34375,15 +34484,15 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true repository: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 created_at: type: string format: date-time @@ -34800,8 +34909,8 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 examples: default: value: @@ -35041,7 +35150,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -35207,7 +35316,7 @@ paths: The response includes a `most_recent_instance` object. This provides details of the most recent instance of this alert - for the the default branch or for the specified Git reference + for the default branch or for the specified Git reference (if you used `ref` in the request). tags: - code-scanning @@ -35252,7 +35361,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply @@ -35261,7 +35370,9 @@ paths: required: false schema: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. - name: state description: Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state. @@ -35272,6 +35383,7 @@ paths: description: State of a code scanning alert. enum: &242 - open + - closed - dismissed - fixed responses: @@ -35323,8 +35435,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true dismissed_at: type: string @@ -35392,8 +35504,9 @@ paths: properties: &246 ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. analysis_key: type: string description: Identifies the configuration under which the @@ -35557,10 +35670,10 @@ paths: title: Basic Error description: Basic Error type: object - properties: *30 + properties: *31 '404': description: Resource Not Found - content: *26 + content: *27 '503': description: Service Unavailable content: *243 @@ -35652,8 +35765,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true dismissed_at: type: string @@ -35798,7 +35911,7 @@ paths: content: *247 '404': description: Resource Not Found - content: *26 + content: *27 '503': description: Service Unavailable content: *243 @@ -35948,10 +36061,10 @@ paths: title: Basic Error description: Basic Error type: object - properties: *30 + properties: *31 '404': description: Resource Not Found - content: *26 + content: *27 '503': description: Service Unavailable content: *243 @@ -36017,7 +36130,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` @@ -36026,7 +36139,9 @@ paths: required: false schema: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. @@ -36048,8 +36163,9 @@ paths: properties: ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. commit_sha: description: The SHA of the commit to which the analysis you are uploading relates. @@ -36156,7 +36272,7 @@ paths: content: *247 '404': description: Resource Not Found - content: *26 + content: *27 '503': description: Service Unavailable content: *243 @@ -36171,6 +36287,10 @@ paths: description: |- Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. + There are two places where you can upload code scanning results. + - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)." + - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." + You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example: ``` @@ -36212,8 +36332,9 @@ paths: pattern: "^[0-9a-fA-F]+$" ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. sarif: description: A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) @@ -36277,7 +36398,7 @@ paths: content: *253 '404': description: Resource Not Found - content: *26 + content: *27 '413': description: Response if the sarif field is too large '503': @@ -36328,7 +36449,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -36471,7 +36592,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36594,16 +36715,16 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 invitee: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true inviter: nullable: true @@ -36611,8 +36732,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true permissions: description: The permission associated with the invitation. @@ -36766,10 +36887,10 @@ paths: description: Response when person is already a collaborator '422': description: Validation Failed - content: *38 + content: *39 '403': description: Forbidden - content: *33 + content: *34 x-github: triggersNotification: true githubCloudOnly: false @@ -36868,7 +36989,7 @@ paths: site_admin: false '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36900,7 +37021,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -36946,8 +37067,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -36960,12 +37081,12 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *77 + enum: *78 reactions: title: Reaction Rollup type: object - properties: *94 - required: *95 + properties: *95 + required: *96 required: &257 - url - html_url @@ -37058,7 +37179,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 responses: '200': description: response @@ -37106,7 +37227,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37145,7 +37266,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 requestBody: content: application/json: @@ -37206,7 +37327,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37235,13 +37356,13 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 responses: '204': description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37271,7 +37392,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. @@ -37291,7 +37412,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -37320,10 +37441,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37364,7 +37485,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 requestBody: content: application/json: @@ -37419,10 +37540,10 @@ paths: value: *164 '415': description: Preview Header Missing - content: *31 + content: *32 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37465,7 +37586,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 - name: reaction_id in: path required: true @@ -37561,7 +37682,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: until description: 'Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -37572,11 +37693,25 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -37672,7 +37807,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *30 + properties: *31 '400': description: Bad Request content: &278 @@ -37681,7 +37816,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *30 + properties: *31 application/scim+json: schema: title: Scim Error @@ -37708,7 +37843,7 @@ paths: type: string '404': description: Resource Not Found - content: *26 + content: *27 '409': description: Conflict content: *260 @@ -37787,10 +37922,10 @@ paths: protected: false '415': description: Preview Header Missing - content: *31 + content: *32 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37833,7 +37968,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -37949,10 +38084,10 @@ paths: type: string '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *38 + content: *39 x-github: triggersNotification: true githubCloudOnly: false @@ -37994,7 +38129,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -38074,8 +38209,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: type: string @@ -38106,8 +38241,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *92 - required: *93 + properties: *93 + required: *94 active_lock_reason: type: string example: too heated @@ -38140,8 +38275,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assignees: type: array @@ -38149,8 +38284,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true requested_reviewers: @@ -38159,8 +38294,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true requested_teams: @@ -38185,8 +38320,8 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 sha: type: string user: @@ -38195,8 +38330,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true required: - label @@ -38215,8 +38350,8 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 sha: type: string user: @@ -38225,8 +38360,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true required: - label @@ -38302,7 +38437,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *77 + enum: *78 draft: description: Indicates whether or not the pull request is a draft. @@ -38820,7 +38955,7 @@ paths: schema: *6 '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38889,8 +39024,16 @@ paths: in: path required: true schema: *173 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *33 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -38993,10 +39136,10 @@ paths: ..... '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 '500': description: Internal Error content: *266 @@ -39029,7 +39172,7 @@ paths: required: true schema: *173 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -39060,11 +39203,16 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -39123,7 +39271,7 @@ paths: required: true schema: *173 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -39144,7 +39292,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -39384,12 +39532,20 @@ paths: required: true schema: *173 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - name: per_page + description: Results per page (max 100). + in: query + schema: *33 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 responses: '200': description: response @@ -39457,8 +39613,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 commit_url: type: string format: uri @@ -39571,7 +39727,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39601,7 +39757,7 @@ paths: required: true schema: *173 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -39610,7 +39766,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -39626,7 +39782,7 @@ paths: title: Status description: The status of a commit. type: object - properties: &366 + properties: &367 url: type: string avatar_url: @@ -39652,10 +39808,10 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true - required: &367 + required: &368 - url - avatar_url - id @@ -40147,7 +40303,7 @@ paths: content: *266 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40203,7 +40359,7 @@ paths: required: true schema: *173 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -40685,10 +40841,10 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '302': description: Found x-github: @@ -40716,7 +40872,7 @@ paths: required: true schema: *173 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -41005,10 +41161,10 @@ paths: payload: '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: *38 + content: *39 '409': description: Conflict content: *260 @@ -41044,7 +41200,7 @@ paths: required: true schema: *173 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -41138,10 +41294,10 @@ paths: payload: '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 '409': description: Conflict content: *260 @@ -41185,7 +41341,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -41287,10 +41443,10 @@ paths: description: Response if repository is empty '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41345,10 +41501,11 @@ paths: schema: type: string default: none + nullable: true - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -41409,8 +41566,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true created_at: type: string @@ -41448,8 +41605,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true required: &273 - id @@ -41794,7 +41951,7 @@ paths: message: 'Conflict: Commit status checks failed for topic-branch.' '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41886,7 +42043,7 @@ paths: production_environment: true '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41938,7 +42095,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed content: *144 @@ -41975,7 +42132,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -42020,8 +42177,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true description: description: A short description of the status. @@ -42079,8 +42236,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true required: &276 - id @@ -42136,7 +42293,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42325,7 +42482,7 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42395,10 +42552,10 @@ paths: value: *277 '404': description: Resource Not Found - content: *26 + content: *27 '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42478,7 +42635,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42507,7 +42664,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -42523,8 +42680,8 @@ paths: title: Event description: Event type: object - properties: *99 - required: *100 + properties: *100 + required: *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42560,15 +42717,30 @@ paths: - newest - oldest - stargazers + - watchers default: newest - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -42580,8 +42752,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 examples: default: value: @@ -42728,11 +42900,26 @@ paths: in: path required: true schema: *173 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -42747,8 +42934,8 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 examples: default: value: *279 @@ -42757,13 +42944,13 @@ paths: content: *278 '422': description: Validation Failed - content: *38 + content: *39 '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42837,16 +43024,16 @@ paths: type: string '404': description: Resource Not Found - content: *26 + content: *27 '409': description: Conflict content: *260 '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42924,13 +43111,13 @@ paths: node_id: Q29udGVudCBvZiB0aGUgYmxvYg== '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: *38 + content: *39 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43244,10 +43431,10 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43350,7 +43537,7 @@ paths: payload: '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43384,7 +43571,7 @@ paths: required: true schema: *173 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -43393,7 +43580,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -43491,7 +43678,7 @@ paths: required: true schema: *173 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -43520,7 +43707,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43592,7 +43779,7 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43619,7 +43806,7 @@ paths: required: true schema: *173 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -43661,7 +43848,7 @@ paths: value: *284 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43687,7 +43874,7 @@ paths: required: true schema: *173 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -43698,7 +43885,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43905,7 +44092,7 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43980,7 +44167,7 @@ paths: value: *289 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44166,13 +44353,13 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44206,6 +44393,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -44267,10 +44455,10 @@ paths: truncated: false '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44299,7 +44487,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -44467,7 +44655,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44609,13 +44797,13 @@ paths: type: string '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: *38 + content: *39 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44662,7 +44850,7 @@ paths: value: *294 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44784,10 +44972,10 @@ paths: value: *294 '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44821,7 +45009,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44863,10 +45051,10 @@ paths: title: Webhook Configuration description: Configuration object of the webhook type: object - properties: *22 + properties: *23 examples: default: - value: *23 + value: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44943,10 +45131,10 @@ paths: title: Webhook Configuration description: Configuration object of the webhook type: object - properties: *22 + properties: *23 examples: default: - value: *23 + value: *24 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44982,7 +45170,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45020,7 +45208,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45058,8 +45246,8 @@ paths: title: Installation description: Installation type: object - properties: *24 - required: *25 + properties: *25 + required: *26 examples: default: value: *295 @@ -45067,7 +45255,7 @@ paths: description: Moved Permanently '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -45097,7 +45285,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -45118,7 +45306,7 @@ paths: required: *297 examples: default: - value: &406 + value: &407 - id: 1 repository: id: 1296269 @@ -45517,7 +45705,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *134 + schema: *135 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -45534,18 +45722,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *135 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -45699,10 +45887,10 @@ paths: description: Moved Permanently '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45971,19 +46159,19 @@ paths: type: string '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *38 + content: *39 '503': description: Service Unavailable content: *243 '404': description: Resource Not Found - content: *26 + content: *27 '410': description: Gone - content: *49 + content: *50 x-github: triggersNotification: true githubCloudOnly: false @@ -46015,7 +46203,7 @@ paths: (when it was last pushed to). in: query required: false - schema: &338 + schema: &345 type: string enum: - created @@ -46036,11 +46224,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -46097,10 +46285,10 @@ paths: schema: *6 '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46140,7 +46328,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 responses: '200': description: response @@ -46186,7 +46374,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46225,7 +46413,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 requestBody: content: application/json: @@ -46256,7 +46444,7 @@ paths: value: *303 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46285,7 +46473,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 responses: '204': description: Empty response @@ -46318,7 +46506,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. @@ -46338,7 +46526,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -46367,10 +46555,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46411,7 +46599,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 requestBody: content: application/json: @@ -46466,10 +46654,10 @@ paths: value: *164 '415': description: Preview Header Missing - content: *31 + content: *32 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46512,7 +46700,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 - name: reaction_id in: path required: true @@ -46558,7 +46746,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -46591,8 +46779,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true event: type: string @@ -46635,8 +46823,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assigner: nullable: true @@ -46644,8 +46832,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true review_requester: nullable: true @@ -46653,8 +46841,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true requested_reviewer: nullable: true @@ -46662,8 +46850,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true requested_team: title: Team @@ -46741,7 +46929,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *77 + enum: *78 lock_reason: type: string nullable: true @@ -46915,7 +47103,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47122,13 +47310,13 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *26 + content: *27 '410': description: Gone - content: *49 + content: *50 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47199,10 +47387,10 @@ paths: description: Moved Permanently '404': description: Resource Not Found - content: *26 + content: *27 '410': description: Gone - content: *49 + content: *50 '304': description: Not Modified x-github: @@ -47337,21 +47525,21 @@ paths: value: *306 '422': description: Validation Failed - content: *38 + content: *39 '503': description: Service Unavailable content: *243 '403': description: Forbidden - content: *33 + content: *34 '301': description: Moved Permanently '404': description: Resource Not Found - content: *26 + content: *27 '410': description: Gone - content: *49 + content: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47670,11 +47858,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -47703,10 +47891,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 '410': description: Gone - content: *49 + content: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47785,16 +47973,16 @@ paths: type: string '403': description: Forbidden - content: *33 + content: *34 '410': description: Gone - content: *49 + content: *50 '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 x-github: triggersNotification: true githubCloudOnly: false @@ -47829,7 +48017,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -47856,8 +48044,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true event: type: string @@ -47889,7 +48077,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *77 + enum: *78 body: type: string example: '":+1:"' @@ -47949,7 +48137,7 @@ paths: schema: *6 '410': description: Gone - content: *49 + content: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47992,7 +48180,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -48035,7 +48223,7 @@ paths: schema: *6 '410': description: Gone - content: *49 + content: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48104,10 +48292,10 @@ paths: value: *312 '410': description: Gone - content: *49 + content: *50 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48175,10 +48363,10 @@ paths: value: *312 '410': description: Gone - content: *49 + content: *50 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48213,7 +48401,7 @@ paths: description: Empty response '410': description: Gone - content: *49 + content: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48277,10 +48465,10 @@ paths: default: true '404': description: Resource Not Found - content: *26 + content: *27 '410': description: Gone - content: *49 + content: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48336,16 +48524,16 @@ paths: description: Empty response '403': description: Forbidden - content: *33 + content: *34 '410': description: Gone - content: *49 + content: *50 '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48380,10 +48568,10 @@ paths: description: Empty response '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48433,7 +48621,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -48462,13 +48650,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 '410': description: Gone - content: *49 + content: *50 '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48550,10 +48738,10 @@ paths: value: *164 '415': description: Preview Header Missing - content: *31 + content: *32 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -48647,7 +48835,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -48674,13 +48862,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 '410': description: Gone - content: *49 + content: *50 '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48725,7 +48913,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -48858,7 +49046,7 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48906,7 +49094,7 @@ paths: value: *317 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48968,7 +49156,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -48997,7 +49185,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49077,10 +49265,10 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49128,7 +49316,7 @@ paths: value: *319 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49369,8 +49557,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *96 - required: *97 + properties: *97 + required: *98 required: - _links - git_url @@ -49536,10 +49724,10 @@ paths: message: Merge Conflict '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49599,7 +49787,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -49615,8 +49803,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *92 - required: *93 + properties: *93 + required: *94 examples: default: value: @@ -49661,7 +49849,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49725,8 +49913,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *92 - required: *93 + properties: *93 + required: *94 examples: default: value: &321 @@ -49771,10 +49959,10 @@ paths: type: string '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49815,14 +50003,14 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *92 - required: *93 + properties: *93 + required: *94 examples: default: value: *321 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49889,8 +50077,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *92 - required: *93 + properties: *93 + required: *94 examples: default: value: *321 @@ -49928,7 +50116,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49962,7 +50150,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -50031,7 +50219,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -50042,7 +50230,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -50058,8 +50246,8 @@ paths: title: Thread description: Thread type: object - properties: *101 - required: *102 + properties: *102 + required: *103 examples: default: value: *326 @@ -50218,7 +50406,7 @@ paths: public: true '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50294,10 +50482,10 @@ paths: value: *329 '422': description: Validation Failed - content: *38 + content: *39 '415': description: Preview Header Missing - content: *31 + content: *32 '409': description: Conflict content: *260 @@ -50396,7 +50584,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *38 + content: *39 '400': description: Bad Request content: *278 @@ -50429,13 +50617,13 @@ paths: description: Empty response '422': description: Validation Failed - content: *38 + content: *39 '415': description: Preview Header Missing - content: *31 + content: *32 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50471,7 +50659,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -50507,8 +50695,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true commit: type: string @@ -50762,6 +50950,21 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *9 + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -50825,7 +51028,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -50879,7 +51082,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: response @@ -50946,7 +51149,7 @@ paths: - name: pre_receive_hook_id in: path required: true - schema: *15 + schema: *16 responses: '200': description: Responds with effective values inherited from owner and/or @@ -51012,7 +51215,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -51072,16 +51275,16 @@ paths: schema: *6 '401': description: Requires Authentication - content: *34 + content: *35 '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 '410': description: Gone - content: *49 + content: *50 '422': description: Validation Failed content: *144 @@ -51152,16 +51355,16 @@ paths: value: *184 '401': description: Requires Authentication - content: *34 + content: *35 '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 '410': description: Gone - content: *49 + content: *50 '422': description: Validation Failed content: *144 @@ -51253,7 +51456,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -51283,7 +51486,7 @@ paths: description: Not Modified '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51370,7 +51573,7 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: &342 + properties: &341 url: type: string format: uri @@ -51441,8 +51644,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: type: string @@ -51474,8 +51677,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *92 - required: *93 + properties: *93 + required: *94 active_lock_reason: type: string example: too heated @@ -51508,8 +51711,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assignees: type: array @@ -51517,8 +51720,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true requested_reviewers: @@ -51527,8 +51730,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true requested_teams: @@ -52236,8 +52439,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *96 - required: *97 + properties: *97 + required: *98 pushed_at: type: string format: date-time @@ -52478,7 +52681,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *77 + enum: *78 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -52502,8 +52705,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true comments: type: integer @@ -52528,7 +52731,7 @@ paths: changed_files: type: integer example: 5 - required: &343 + required: &342 - _links - assignee - labels @@ -52572,7 +52775,7 @@ paths: - review_comments examples: default: - value: &344 + value: &343 url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 node_id: MDExOlB1bGxSZXF1ZXN0MQ== @@ -53067,10 +53270,10 @@ paths: type: string '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *38 + content: *39 x-github: triggersNotification: true githubCloudOnly: false @@ -53099,11 +53302,14 @@ paths: required: true schema: *173 - name: sort - description: One of `created` (when the repository was starred) or `updated` - (when it was last pushed to). in: query required: false - schema: *338 + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -53119,11 +53325,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -53140,7 +53346,7 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: &339 + properties: &338 url: description: URL for the pull request review comment example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 @@ -53195,8 +53401,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: description: The text of the comment. @@ -53227,7 +53433,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *77 + enum: *78 _links: type: object properties: @@ -53302,15 +53508,15 @@ paths: reactions: title: Reaction Rollup type: object - properties: *94 - required: *95 + properties: *95 + required: *96 body_html: type: string example: '"

comment body

"' body_text: type: string example: '"comment body"' - required: &340 + required: &339 - url - id - node_id @@ -53446,7 +53652,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 responses: '200': description: response @@ -53457,11 +53663,11 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *339 - required: *340 + properties: *338 + required: *339 examples: default: - value: &341 + value: &340 url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 id: 10 @@ -53513,7 +53719,7 @@ paths: side: RIGHT '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53573,7 +53779,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 requestBody: content: application/json: @@ -53597,11 +53803,11 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *339 - required: *340 + properties: *338 + required: *339 examples: default: - value: *341 + value: *340 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53651,13 +53857,13 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 responses: '204': description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53687,7 +53893,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 - name: content description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. @@ -53707,7 +53913,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -53736,10 +53942,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53780,7 +53986,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 requestBody: content: application/json: @@ -53835,10 +54041,10 @@ paths: value: *164 '415': description: Preview Header Missing - content: *31 + content: *32 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53881,7 +54087,7 @@ paths: description: comment_id parameter in: path required: true - schema: *91 + schema: *92 - name: reaction_id in: path required: true @@ -53942,7 +54148,7 @@ paths: - name: pull_number in: path required: true - schema: &345 + schema: &344 type: integer responses: '200': @@ -53957,11 +54163,11 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: *342 - required: *343 + properties: *341 + required: *342 examples: default: - value: *344 + value: *343 '304': description: Not Modified '500': @@ -53969,7 +54175,7 @@ paths: content: *266 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54000,7 +54206,7 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 requestBody: content: application/json: @@ -54046,17 +54252,17 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: *342 - required: *343 + properties: *341 + required: *342 examples: default: - value: *344 + value: *343 '422': description: Validation Failed - content: *38 + content: *39 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54086,13 +54292,13 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 - name: sort description: One of `created` (when the repository was starred) or `updated` (when it was last pushed to). in: query required: false - schema: *338 + schema: *345 - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -54108,11 +54314,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -54129,8 +54335,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *339 - required: *340 + properties: *338 + required: *339 examples: default: value: *346 @@ -54205,7 +54411,7 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 requestBody: content: application/json: @@ -54304,8 +54510,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *339 - required: *340 + properties: *338 + required: *339 examples: example-for-a-multi-line-comment: value: @@ -54365,10 +54571,10 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 '403': description: Forbidden - content: *33 + content: *34 x-github: triggersNotification: true githubCloudOnly: false @@ -54422,12 +54628,12 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 - name: comment_id description: comment_id parameter in: path required: true - schema: *91 + schema: *92 requestBody: content: application/json: @@ -54451,8 +54657,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *339 - required: *340 + properties: *338 + required: *339 examples: default: value: @@ -54512,7 +54718,7 @@ paths: type: string '404': description: Resource Not Found - content: *26 + content: *27 x-github: triggersNotification: true githubCloudOnly: false @@ -54545,11 +54751,11 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -54604,11 +54810,11 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -54647,7 +54853,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *38 + content: *39 '500': description: Internal Error content: *266 @@ -54679,7 +54885,7 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 responses: '204': description: Response if pull request has been merged @@ -54716,7 +54922,7 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 requestBody: content: application/json: @@ -54800,13 +55006,13 @@ paths: message: Head branch was modified. Review and try the merge again. '422': description: Validation Failed - content: *38 + content: *39 '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 x-github: triggersNotification: true githubCloudOnly: false @@ -54836,11 +55042,11 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -54861,8 +55067,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true teams: type: array @@ -54947,7 +55153,7 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 requestBody: content: application/json: @@ -55501,7 +55707,7 @@ paths: description: Response if user is not a collaborator '403': description: Forbidden - content: *33 + content: *34 x-github: triggersNotification: true githubCloudOnly: false @@ -55530,7 +55736,7 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 requestBody: content: application/json: @@ -55561,7 +55767,7 @@ paths: description: response '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55590,11 +55796,11 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -55624,8 +55830,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: description: The text of the review. @@ -55678,7 +55884,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *77 + enum: *78 required: &351 - id - node_id @@ -55765,7 +55971,7 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 requestBody: content: application/json: @@ -55891,7 +56097,7 @@ paths: content: *144 '403': description: Forbidden - content: *33 + content: *34 x-github: triggersNotification: true githubCloudOnly: false @@ -55921,7 +56127,7 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 - name: review_id description: review_id parameter in: path @@ -55977,7 +56183,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56005,7 +56211,7 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 - name: review_id description: review_id parameter in: path @@ -56103,7 +56309,7 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 - name: review_id description: review_id parameter in: path @@ -56128,7 +56334,7 @@ paths: content: *144 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56157,7 +56363,7 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 - name: review_id description: review_id parameter in: path @@ -56166,7 +56372,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -56225,8 +56431,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true body: type: string @@ -56252,7 +56458,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *77 + enum: *78 _links: type: object properties: @@ -56392,7 +56598,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56423,7 +56629,7 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 - name: review_id description: review_id parameter in: path @@ -56492,7 +56698,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed content: *144 @@ -56524,7 +56730,7 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 - name: review_id description: review_id parameter in: path @@ -56569,13 +56775,13 @@ paths: value: *354 '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed content: *144 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56605,7 +56811,7 @@ paths: - name: pull_number in: path required: true - schema: *345 + schema: *344 requestBody: content: application/json: @@ -56641,13 +56847,13 @@ paths: url: https://github.com/repos/octocat/Hello-World/pulls/53 '422': description: Validation Failed - content: *38 + content: *39 '403': description: Forbidden - content: *33 + content: *34 '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56703,7 +56909,7 @@ paths: required: *356 examples: default: - value: + value: &357 type: file encoding: base64 size: 5362 @@ -56721,10 +56927,72 @@ paths: html: https://github.com/octokit/octokit.rb/blob/master/README.md '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: *38 + content: *39 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository-readme + parameters: + - name: owner + in: path + required: true + schema: *172 + - name: repo + in: path + required: true + schema: *173 + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + title: Content File + description: Content File + type: object + properties: *355 + required: *356 + examples: + default: + value: *357 + '404': + description: Resource Not Found + content: *27 + '422': + description: Validation Failed + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56756,7 +57024,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -56772,7 +57040,7 @@ paths: title: Release description: A release. type: object - properties: &357 + properties: &358 url: type: string format: uri @@ -56832,8 +57100,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true assets: type: array @@ -56841,7 +57109,7 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: &359 + properties: &360 url: type: string format: uri @@ -56883,10 +57151,10 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true - required: &360 + required: &361 - id - name - content_type @@ -56904,7 +57172,7 @@ paths: type: string body_text: type: string - required: &358 + required: &359 - assets_url - upload_url - tarball_url @@ -56999,7 +57267,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57076,11 +57344,11 @@ paths: title: Release description: A release. type: object - properties: *357 - required: *358 + properties: *358 + required: *359 examples: default: - value: &363 + value: &364 url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 assets_url: https://api.github.com/repos/octocat/Hello-World/releases/1/assets @@ -57155,7 +57423,7 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 x-github: triggersNotification: true githubCloudOnly: false @@ -57189,7 +57457,7 @@ paths: description: asset_id parameter in: path required: true - schema: &361 + schema: &362 type: integer responses: '200': @@ -57204,11 +57472,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *359 - required: *360 + properties: *360 + required: *361 examples: default: - value: &362 + value: &363 url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip id: 1 @@ -57242,10 +57510,10 @@ paths: site_admin: false '404': description: Resource Not Found - content: *26 + content: *27 '415': description: Preview Header Missing - content: *31 + content: *32 '302': description: Found x-github: @@ -57276,7 +57544,7 @@ paths: description: asset_id parameter in: path required: true - schema: *361 + schema: *362 requestBody: content: application/json: @@ -57305,11 +57573,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *359 - required: *360 + properties: *360 + required: *361 examples: default: - value: *362 + value: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57338,7 +57606,7 @@ paths: description: asset_id parameter in: path required: true - schema: *361 + schema: *362 responses: '204': description: Empty response @@ -57379,11 +57647,11 @@ paths: title: Release description: A release. type: object - properties: *357 - required: *358 + properties: *358 + required: *359 examples: default: - value: *363 + value: *364 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57410,7 +57678,7 @@ paths: required: true schema: *173 - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -57425,14 +57693,14 @@ paths: title: Release description: A release. type: object - properties: *357 - required: *358 + properties: *358 + required: *359 examples: default: - value: *363 + value: *364 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57463,7 +57731,7 @@ paths: description: release_id parameter in: path required: true - schema: &364 + schema: &365 type: integer responses: '200': @@ -57475,14 +57743,14 @@ paths: title: Release description: A release. type: object - properties: *357 - required: *358 + properties: *358 + required: *359 examples: default: - value: *363 + value: *364 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57511,7 +57779,7 @@ paths: description: release_id parameter in: path required: true - schema: *364 + schema: *365 requestBody: content: application/json: @@ -57557,11 +57825,11 @@ paths: title: Release description: A release. type: object - properties: *357 - required: *358 + properties: *358 + required: *359 examples: default: - value: *363 + value: *364 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57590,7 +57858,7 @@ paths: description: release_id parameter in: path required: true - schema: *364 + schema: *365 responses: '204': description: Empty response @@ -57623,11 +57891,11 @@ paths: description: release_id parameter in: path required: true - schema: *364 + schema: *365 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -57643,8 +57911,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *359 - required: *360 + properties: *360 + required: *361 examples: default: value: @@ -57741,7 +58009,7 @@ paths: description: release_id parameter in: path required: true - schema: *364 + schema: *365 - name: name in: query schema: @@ -57765,8 +58033,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *359 - required: *360 + properties: *360 + required: *361 examples: response-for-successful-upload: value: @@ -57832,7 +58100,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -57848,8 +58116,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default-response: @@ -57890,8 +58158,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true required: - starred_at @@ -57927,7 +58195,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57966,7 +58234,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: &365 + items: &366 type: integer examples: default: @@ -58101,8 +58369,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true total: type: integer @@ -58316,7 +58584,7 @@ paths: - 3 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58362,7 +58630,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: *365 + items: *366 examples: default: value: @@ -58456,8 +58724,8 @@ paths: title: Status description: The status of a commit. type: object - properties: *366 - required: *367 + properties: *367 + required: *368 examples: default: value: @@ -58523,7 +58791,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -58539,8 +58807,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -58585,7 +58853,7 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: &368 + properties: &369 subscribed: description: Determines if notifications should be received from this repository. @@ -58610,7 +58878,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/example - required: &369 + required: &370 - created_at - ignored - reason @@ -58630,7 +58898,7 @@ paths: description: Response if you don't subscribe to the repository '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58683,8 +58951,8 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: *368 - required: *369 + properties: *369 + required: *370 examples: default: value: @@ -58751,7 +59019,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -58883,7 +59151,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -58935,6 +59203,14 @@ paths: in: path required: true schema: *173 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *33 responses: '200': description: response @@ -58944,16 +59220,16 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: &370 + properties: &371 names: type: array items: type: string - required: &371 + required: &372 - names examples: default: - value: &372 + value: &373 names: - octocat - atom @@ -58961,10 +59237,10 @@ paths: - api '415': description: Preview Header Missing - content: *31 + content: *32 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59027,17 +59303,17 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: *370 - required: *371 + properties: *371 + required: *372 examples: default: - value: *372 + value: *373 '415': description: Preview Header Missing - content: *31 + content: *32 '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed content: *144 @@ -59109,8 +59385,8 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 examples: default: value: *279 @@ -59309,8 +59585,8 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 examples: default: value: @@ -59490,8 +59766,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 examples: default: value: @@ -59568,7 +59844,7 @@ paths: type: string '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified x-github: @@ -59633,7 +59909,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: &373 + schema: &374 type: string enum: - desc @@ -59642,7 +59918,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -59689,8 +59965,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 score: type: integer file_size: @@ -59711,7 +59987,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: &374 + items: &375 type: object properties: object_url: @@ -59828,10 +60104,10 @@ paths: content: *243 '422': description: Validation Failed - content: *38 + content: *39 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59884,11 +60160,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *373 + schema: *374 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -59988,8 +60264,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true committer: nullable: true @@ -60013,8 +60289,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 score: type: integer node_id: @@ -60022,7 +60298,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *374 + items: *375 required: - sha - node_id @@ -60155,7 +60431,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60233,11 +60509,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *373 + schema: *374 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -60301,8 +60577,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true nullable: true user: @@ -60311,8 +60587,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true labels: type: array @@ -60342,8 +60618,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true milestone: nullable: true @@ -60351,8 +60627,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *92 - required: *93 + properties: *93 + required: *94 comments: type: integer created_at: @@ -60368,7 +60644,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *374 + items: *375 pull_request: type: object properties: @@ -60406,15 +60682,15 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *77 + enum: *78 draft: type: boolean repository: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 body_html: type: string body_text: @@ -60432,8 +60708,8 @@ paths: They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *20 - required: *21 + properties: *21 + required: *22 additionalProperties: true required: - assignee @@ -60554,12 +60830,12 @@ paths: content: *243 '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60616,7 +60892,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *373 + schema: *374 responses: '200': description: response @@ -60661,7 +60937,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *374 + items: *375 required: - id - node_id @@ -60697,13 +60973,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60764,11 +61040,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *373 + schema: *374 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -60810,8 +61086,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true private: type: boolean @@ -60987,8 +61263,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *96 - required: *97 + properties: *97 + required: *98 permissions: type: object properties: @@ -61005,7 +61281,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *374 + items: *375 temp_clone_token: type: string allow_merge_commit: @@ -61202,7 +61478,7 @@ paths: content: *243 '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified x-github: @@ -61309,7 +61585,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *374 + items: *375 related: type: array nullable: true @@ -61454,7 +61730,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61517,11 +61793,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *373 + schema: *374 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -61629,7 +61905,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *374 + items: *375 blog: type: string nullable: true @@ -61692,7 +61968,7 @@ paths: content: *243 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61801,7 +62077,7 @@ paths: application/json: schema: type: object - properties: &375 + properties: &376 status: type: string scheduled_time: @@ -61820,7 +62096,7 @@ paths: - number examples: default: - value: &376 + value: &377 status: scheduled scheduled_time: Tuesday, January 22 at 15:34 -0800 connection_services: @@ -61855,10 +62131,10 @@ paths: application/json: schema: type: object - properties: *375 + properties: *376 examples: default: - value: *376 + value: *377 requestBody: content: application/json: @@ -62368,14 +62644,14 @@ paths: type: array items: type: object - properties: &377 + properties: &378 key: type: string pretty-print: type: string examples: default: - value: &378 + value: &379 - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64 - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... @@ -62406,10 +62682,10 @@ paths: type: array items: type: object - properties: *377 + properties: *378 examples: default: - value: *378 + value: *379 requestBody: content: application/json: @@ -62445,10 +62721,10 @@ paths: type: array items: type: object - properties: *377 + properties: *378 examples: default: - value: *378 + value: *379 requestBody: content: application/json: @@ -62579,7 +62855,7 @@ paths: value: *151 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62673,13 +62949,13 @@ paths: value: *151 '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: *38 + content: *39 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62713,10 +62989,10 @@ paths: description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62748,11 +63024,11 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *135 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -62773,7 +63049,7 @@ paths: required: *154 examples: default: - value: *379 + value: *380 headers: Link: example: ; rel="next", ; @@ -62982,7 +63258,7 @@ paths: required: *154 examples: default: - value: *380 + value: *381 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63061,11 +63337,11 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *135 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -63085,7 +63361,7 @@ paths: required: *158 examples: default: - value: *381 + value: *382 headers: Link: example: ; rel="next", ; @@ -63290,7 +63566,7 @@ paths: required: *158 examples: default: - value: *382 + value: *383 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63392,7 +63668,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -63561,7 +63837,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -63719,7 +63995,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -63735,8 +64011,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -63748,7 +64024,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63874,7 +64150,7 @@ paths: resource: TeamMember '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63965,16 +64241,16 @@ paths: examples: response-if-user-has-an-active-membership-with-team: summary: Response if user has an active membership with team - value: *383 + value: *384 response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer - value: *384 + value: *385 response-if-user-has-a-pending-membership-with-team: summary: Response if user has a pending membership with team - value: *385 + value: *386 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64044,10 +64320,10 @@ paths: examples: response-if-users-membership-with-team-is-now-active: summary: Response if user's membership with team is now active - value: *386 + value: *387 response-if-users-membership-with-team-is-now-pending: summary: Response if user's membership with team is now pending - value: *387 + value: *388 '403': description: Response if team synchronization is set up '422': @@ -64083,7 +64359,7 @@ paths: resource: TeamMember '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64153,7 +64429,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -64173,7 +64449,7 @@ paths: required: *169 examples: default: - value: *388 + value: *389 headers: Link: example: ; rel="next", ; @@ -64181,10 +64457,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64236,12 +64512,12 @@ paths: required: *169 examples: default: - value: *389 + value: *390 '404': description: Response if project is not managed by this team '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64322,13 +64598,13 @@ paths: documentation_url: https://docs.github.com/enterprise-server@3.0/rest/reference/teams#add-or-update-team-project-permissions '404': description: Resource Not Found - content: *26 + content: *27 '415': description: Preview Header Missing - content: *31 + content: *32 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64371,13 +64647,13 @@ paths: description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 '415': description: Preview Header Missing - content: *31 + content: *32 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64408,7 +64684,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -64424,8 +64700,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 examples: default: value: *171 @@ -64436,7 +64712,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64483,8 +64759,8 @@ paths: title: Team Repository description: A team's access to a repository. type: object - properties: *390 - required: *391 + properties: *391 + required: *392 examples: alternative-response-with-extra-repository-information: value: @@ -64784,10 +65060,10 @@ paths: description: Empty response '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64855,7 +65131,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -64876,7 +65152,7 @@ paths: required: *175 examples: response-if-child-teams-exist: - value: *392 + value: *393 headers: Link: example: ; rel="next", ; @@ -64884,13 +65160,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64924,7 +65200,7 @@ paths: - title: Private User description: Private User type: object - properties: &393 + properties: &394 login: type: string example: octocat @@ -65077,7 +65353,7 @@ paths: type: boolean ldap_dn: type: string - required: &394 + required: &395 - avatar_url - events_url - followers_url @@ -65118,7 +65394,7 @@ paths: - title: Public User description: Public User type: object - properties: &408 + properties: &409 login: type: string id: @@ -65235,7 +65511,7 @@ paths: collaborators: type: integer example: 3 - required: &409 + required: &410 - avatar_url - events_url - followers_url @@ -65352,10 +65628,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65421,8 +65697,8 @@ paths: title: Private User description: Private User type: object - properties: *393 - required: *394 + properties: *394 + required: *395 examples: default: value: @@ -65472,16 +65748,16 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65503,7 +65779,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -65519,7 +65795,7 @@ paths: title: Email description: Email type: object - properties: &395 + properties: &396 email: type: string format: email @@ -65534,14 +65810,14 @@ paths: type: string example: public nullable: true - required: &396 + required: &397 - email - primary - verified - visibility examples: default: - value: &405 + value: &406 - email: octocat@github.com verified: true primary: true @@ -65555,13 +65831,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65620,8 +65896,8 @@ paths: title: Email description: Email type: object - properties: *395 - required: *396 + properties: *396 + required: *397 examples: default: value: @@ -65639,18 +65915,18 @@ paths: visibility: '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65705,16 +65981,16 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65735,7 +66011,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -65751,8 +66027,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -65766,10 +66042,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65790,7 +66066,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -65806,8 +66082,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -65821,10 +66097,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65858,15 +66134,15 @@ paths: title: Basic Error description: Basic Error type: object - properties: *30 + properties: *31 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65897,13 +66173,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65932,13 +66208,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65960,7 +66236,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -65976,7 +66252,7 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: &397 + properties: &398 id: type: integer example: 3 @@ -66070,7 +66346,7 @@ paths: raw_key: type: string nullable: true - required: &398 + required: &399 - id - primary_key_id - key_id @@ -66086,7 +66362,7 @@ paths: - subkeys examples: default: - value: &410 + value: &411 - id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -66123,13 +66399,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66168,11 +66444,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *397 - required: *398 + properties: *398 + required: *399 examples: default: - value: &399 + value: &400 id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -66204,18 +66480,18 @@ paths: PGP PUBLIC KEY BLOCK-----"' '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66238,7 +66514,7 @@ paths: description: gpg_key_id parameter in: path required: true - schema: &400 + schema: &401 type: integer responses: '200': @@ -66249,22 +66525,22 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *397 - required: *398 + properties: *398 + required: *399 examples: default: - value: *399 + value: *400 '404': description: Resource Not Found - content: *26 + content: *27 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66287,24 +66563,24 @@ paths: description: gpg_key_id parameter in: path required: true - schema: *400 + schema: *401 responses: '204': description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66332,7 +66608,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -66357,8 +66633,8 @@ paths: title: Installation description: Installation type: object - properties: *24 - required: *25 + properties: *25 + required: *26 examples: default: value: @@ -66457,13 +66733,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 '415': description: Preview Header Missing - content: *31 + content: *32 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66492,11 +66768,11 @@ paths: description: installation_id parameter in: path required: true - schema: *27 + schema: *28 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -66523,11 +66799,11 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 examples: default: - value: *119 + value: *120 headers: Link: example: ; rel="next", ; @@ -66535,10 +66811,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '304': description: Not Modified x-github: @@ -66572,22 +66848,22 @@ paths: description: installation_id parameter in: path required: true - schema: *27 + schema: *28 - name: repository_id in: path required: true - schema: *115 + schema: *116 responses: '204': description: Empty response '403': description: Forbidden - content: *33 + content: *34 '304': description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66611,22 +66887,22 @@ paths: description: installation_id parameter in: path required: true - schema: *27 + schema: *28 - name: repository_id in: path required: true - schema: *115 + schema: *116 responses: '204': description: Empty response '403': description: Forbidden - content: *33 + content: *34 '304': description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66665,6 +66941,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -66683,7 +66960,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *134 + schema: *135 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -66700,18 +66977,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *135 + schema: *9 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -66740,7 +67017,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *26 + content: *27 '304': description: Not Modified x-github: @@ -66775,7 +67052,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -66791,7 +67068,7 @@ paths: title: Key description: Key type: object - properties: &401 + properties: &402 key_id: type: string key: @@ -66809,7 +67086,7 @@ paths: type: boolean read_only: type: boolean - required: &402 + required: &403 - key_id - key - id @@ -66846,13 +67123,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66896,11 +67173,11 @@ paths: title: Key description: Key type: object - properties: *401 - required: *402 + properties: *402 + required: *403 examples: default: - value: &403 + value: &404 key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -66911,18 +67188,18 @@ paths: read_only: false '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66956,22 +67233,22 @@ paths: title: Key description: Key type: object - properties: *401 - required: *402 + properties: *402 + required: *403 examples: default: - value: *403 + value: *404 '404': description: Resource Not Found - content: *26 + content: *27 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67002,13 +67279,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67040,7 +67317,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -67142,13 +67419,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67169,7 +67446,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 responses: '200': description: response @@ -67222,10 +67499,10 @@ paths: site_admin: false '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67245,7 +67522,7 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 requestBody: content: application/json: @@ -67314,13 +67591,13 @@ paths: site_admin: false '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67346,7 +67623,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -67362,11 +67639,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *56 - required: *57 + properties: *57 + required: *58 examples: default: - value: *404 + value: *405 headers: Link: example: ; rel="next", ; @@ -67376,10 +67653,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67464,13 +67741,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 '415': description: Preview Header Missing - content: *31 + content: *32 '422': description: Validation Failed content: *144 @@ -67503,7 +67780,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -67519,11 +67796,11 @@ paths: title: Email description: Email type: object - properties: *395 - required: *396 + properties: *396 + required: *397 examples: default: - value: *405 + value: *406 headers: Link: example: ; rel="next", ; @@ -67533,13 +67810,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67625,7 +67902,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -67636,7 +67913,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -67655,12 +67932,12 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 examples: default: summary: Default response - value: &407 + value: &408 - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World @@ -67779,15 +68056,15 @@ paths: watchers: 1 '422': description: Validation Failed - content: *38 + content: *39 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -67909,8 +68186,8 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 examples: default: value: *279 @@ -67921,18 +68198,18 @@ paths: type: string '401': description: Requires Authentication - content: *34 + content: *35 '304': description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *38 + content: *39 '400': description: Bad Request content: *278 @@ -67974,7 +68251,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -67995,7 +68272,7 @@ paths: required: *297 examples: default: - value: *406 + value: *407 headers: Link: example: ; rel="next", ; @@ -68005,13 +68282,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -68039,13 +68316,13 @@ paths: description: Empty response '403': description: Forbidden - content: *33 + content: *34 '409': description: Conflict content: *260 '404': description: Resource Not Found - content: *26 + content: *27 '304': description: Not Modified x-github: @@ -68079,10 +68356,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -68108,16 +68385,16 @@ paths: (when it was last pushed to). in: query required: false - schema: *338 + schema: *345 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *135 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -68133,12 +68410,12 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 examples: default-response: summary: Default response - value: *407 + value: *408 application/vnd.github.v3.star+json: schema: type: array @@ -68146,7 +68423,7 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: &411 + properties: &412 starred_at: type: string format: date-time @@ -68154,15 +68431,15 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 - required: &412 + properties: *72 + required: *73 + required: &413 - starred_at - repo examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: &413 + value: &414 - starred_at: '2011-01-16T19:06:43Z' repo: id: 1296269 @@ -68290,10 +68567,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -68330,15 +68607,15 @@ paths: title: Basic Error description: Basic Error type: object - properties: *30 + properties: *31 '401': description: Requires Authentication - content: *34 + content: *35 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -68369,13 +68646,13 @@ paths: description: Empty response '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *26 + content: *27 '401': description: Requires Authentication - content: *34 + content: *35 '304': description: Not Modified x-github: @@ -68407,15 +68684,15 @@ paths: description: Empty response '404': description: Resource Not Found - content: *26 + content: *27 '401': description: Requires Authentication - content: *34 + content: *35 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -68436,7 +68713,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -68452,8 +68729,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 examples: default: value: *171 @@ -68466,10 +68743,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *34 + content: *35 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -68493,7 +68770,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -68568,10 +68845,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *26 + content: *27 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -68601,7 +68878,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 responses: '200': description: response @@ -68613,8 +68890,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -68664,13 +68941,13 @@ paths: - title: Private User description: Private User type: object - properties: *393 - required: *394 + properties: *394 + required: *395 - title: Public User description: Public User type: object - properties: *408 - required: *409 + properties: *409 + required: *410 additionalProperties: false examples: default-response: @@ -68750,7 +69027,7 @@ paths: private_repos: 9999 '404': description: Resource Not Found - content: *26 + content: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68776,7 +69053,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -68792,8 +69069,8 @@ paths: title: Event description: Event type: object - properties: *99 - required: *100 + properties: *100 + required: *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68819,11 +69096,11 @@ paths: - name: org in: path required: true - schema: *107 + schema: *108 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -68839,8 +69116,8 @@ paths: title: Event description: Event type: object - properties: *99 - required: *100 + properties: *100 + required: *101 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -68865,7 +69142,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -68881,8 +69158,8 @@ paths: title: Event description: Event type: object - properties: *99 - required: *100 + properties: *100 + required: *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68907,7 +69184,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -68923,8 +69200,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -68958,7 +69235,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -68974,8 +69251,8 @@ paths: title: Simple User description: Simple User type: object - properties: *16 - required: *17 + properties: *17 + required: *18 nullable: true examples: default: @@ -69043,11 +69320,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *80 + schema: *81 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -69063,11 +69340,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *81 - required: *82 + properties: *82 + required: *83 examples: default: - value: *83 + value: *84 headers: Link: example: ; rel="next", ; @@ -69075,7 +69352,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -69101,7 +69378,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -69117,11 +69394,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *397 - required: *398 + properties: *398 + required: *399 examples: default: - value: *410 + value: *411 headers: Link: example: ; rel="next", ; @@ -69208,10 +69485,10 @@ paths: octicon: repo '404': description: Resource Not Found - content: *26 + content: *27 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -69245,8 +69522,8 @@ paths: title: Installation description: Installation type: object - properties: *24 - required: *25 + properties: *25 + required: *26 examples: default: value: *295 @@ -69275,7 +69552,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -69336,7 +69613,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -69352,11 +69629,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *56 - required: *57 + properties: *57 + required: *58 examples: default: - value: *404 + value: *405 headers: Link: example: ; rel="next", ; @@ -69398,7 +69675,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -69458,10 +69735,10 @@ paths: schema: *6 '415': description: Preview Header Missing - content: *31 + content: *32 '422': description: Validation Failed - content: *38 + content: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -69495,7 +69772,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -69511,8 +69788,8 @@ paths: title: Event description: Event type: object - properties: *99 - required: *100 + properties: *100 + required: *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69537,7 +69814,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -69553,8 +69830,8 @@ paths: title: Event description: Event type: object - properties: *99 - required: *100 + properties: *100 + required: *101 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69613,7 +69890,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -69629,8 +69906,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 examples: default: value: *171 @@ -69725,16 +70002,16 @@ paths: (when it was last pushed to). in: query required: false - schema: *338 + schema: *345 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *135 + schema: *9 - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -69750,12 +70027,12 @@ paths: title: Repository description: A git repository type: object - properties: *71 - required: *72 + properties: *72 + required: *73 examples: default-response: summary: Default response - value: *407 + value: *408 application/vnd.github.v3.star+json: schema: type: array @@ -69763,12 +70040,12 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: *411 - required: *412 + properties: *412 + required: *413 examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: *413 + value: *414 headers: Link: example: ; rel="next", ; @@ -69798,7 +70075,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *32 + schema: *33 - name: page description: Page number of the results to fetch. in: query @@ -69814,8 +70091,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *129 - required: *130 + properties: *130 + required: *131 examples: default: value: *171 diff --git a/descriptions/ghes-3.0/ghes-3.0.json b/descriptions/ghes-3.0/ghes-3.0.json index 2e5e764522..4171710cf5 100644 --- a/descriptions/ghes-3.0/ghes-3.0.json +++ b/descriptions/ghes-3.0/ghes-3.0.json @@ -824,6 +824,32 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1284,6 +1310,23 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -1794,6 +1837,24 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -3030,6 +3091,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -3788,6 +3858,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "client_id", + "in": "query", + "required": false, + "description": "The client ID of your GitHub app.", + "schema": { + "type": "string" + } } ], "responses": { @@ -7886,6 +7965,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -8041,6 +8121,9 @@ }, { "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -9856,6 +9939,12 @@ }, { "$ref": "#/components/parameters/runner_group_id" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" } ], "responses": { @@ -10840,6 +10929,12 @@ }, { "$ref": "#/components/parameters/secret_name" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" } ], "responses": { @@ -11780,6 +11875,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -12468,6 +12564,24 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "description": "The sort order for the response collection.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -13686,6 +13800,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { @@ -23196,7 +23319,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. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "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. GitHub Apps must have the `security_events` read permission to use\nthis 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).", "tags": [ "code-scanning" ], @@ -23510,7 +23633,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -24453,6 +24576,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -24827,9 +24970,15 @@ { "$ref": "#/components/parameters/repo" }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -24896,7 +25045,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -24929,6 +25078,14 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -25000,7 +25157,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -25097,13 +25254,19 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -25158,7 +25321,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -25303,7 +25466,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -25404,7 +25567,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -25584,7 +25747,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -25832,7 +25995,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -26625,7 +26789,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -26635,6 +26800,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -26692,6 +26877,26 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -26699,6 +26904,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -27129,7 +27335,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -27201,7 +27407,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -27352,7 +27558,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -27438,7 +27644,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -27812,7 +28018,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -33023,6 +33230,23 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -33686,7 +33910,17 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/sort" + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "created_at" + ] + } }, { "name": "direction", @@ -36017,6 +36251,79 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content-file" + }, + "examples": { + "default": { + "$ref": "#/components/examples/content-file" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -36430,7 +36737,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -37652,6 +37959,12 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" } ], "responses": { @@ -42885,6 +43198,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -45933,6 +46247,20 @@ "type": "integer" } }, + "direction": { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, "key-ids": { "name": "key_ids", "in": "path", @@ -46122,20 +46450,6 @@ "type": "string" } }, - "direction": { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, "owner": { "name": "owner", "in": "path", @@ -56198,13 +56512,14 @@ }, "code-scanning-ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "code-scanning-alert-state": { "type": "string", "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] diff --git a/descriptions/ghes-3.0/ghes-3.0.yaml b/descriptions/ghes-3.0/ghes-3.0.yaml index 5eab8f70d8..662cdc3a37 100644 --- a/descriptions/ghes-3.0/ghes-3.0.yaml +++ b/descriptions/ghes-3.0/ghes-3.0.yaml @@ -600,6 +600,23 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string responses: '200': description: response @@ -904,6 +921,17 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1294,6 +1322,19 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: One of `created` (when the repository was starred) or `updated` + (when it was last pushed to) or `name`. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -2173,6 +2214,12 @@ paths: parameters: - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -2721,6 +2768,12 @@ paths: parameters: - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string responses: '200': description: response @@ -5565,6 +5618,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -5670,6 +5724,7 @@ paths: schema: type: boolean - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -6966,6 +7021,8 @@ paths: parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/runner_group_id" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" responses: '200': description: response @@ -7725,6 +7782,8 @@ paths: parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret_name" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" responses: '200': description: response @@ -8370,6 +8429,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -8845,6 +8905,18 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: The sort order for the response collection. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -9788,6 +9860,12 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: pinned + in: query + required: false + description: Pinned discussions only filter + schema: + type: string responses: '200': description: response @@ -16710,7 +16788,7 @@ paths: The response includes a `most_recent_instance` object. This provides details of the most recent instance of this alert - for the the default branch or for the specified Git reference + for the default branch or for the specified Git reference (if you used `ref` in the request). tags: - code-scanning @@ -16924,6 +17002,10 @@ paths: description: |- Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. + There are two places where you can upload code scanning results. + - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)." + - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." + You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example: ``` @@ -17628,6 +17710,20 @@ paths: type: string - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -17920,8 +18016,10 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -17966,7 +18064,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -17987,6 +18085,11 @@ paths: default: latest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -18033,7 +18136,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -18101,12 +18204,14 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -18142,7 +18247,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -18300,7 +18405,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -18361,7 +18466,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -18497,7 +18602,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -18665,6 +18770,7 @@ paths: schema: type: string default: none + nullable: true - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" responses: @@ -19339,9 +19445,24 @@ paths: - newest - oldest - stargazers + - watchers default: newest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -19380,11 +19501,26 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -19763,7 +19899,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -19809,7 +19945,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -19908,7 +20044,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -19965,7 +20101,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -20294,6 +20430,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -23787,6 +23924,17 @@ paths: - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -24277,7 +24425,15 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/sort" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -25961,6 +26117,56 @@ paths: previews: [] category: repos subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository-readme + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/content-file" + examples: + default: + "$ref": "#/components/examples/content-file" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents "/repos/{owner}/{repo}/releases": get: summary: List releases @@ -26240,7 +26446,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -27064,6 +27270,8 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" responses: '200': description: response @@ -30984,6 +31192,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -33038,6 +33247,17 @@ components: required: true schema: type: integer + direction: + name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc key-ids: name: key_ids in: path @@ -33186,17 +33406,6 @@ components: required: false schema: type: string - direction: - name: direction - description: One of `asc` (ascending) or `desc` (descending). - in: query - required: false - schema: - type: string - enum: - - asc - - desc - default: desc owner: name: owner in: path @@ -40916,12 +41125,15 @@ components: if provided in the uploaded SARIF data. code-scanning-ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. code-scanning-alert-state: type: string description: State of a code scanning alert. enum: - open + - closed - dismissed - fixed alert-number: diff --git a/descriptions/github.ae/dereferenced/github.ae.deref.json b/descriptions/github.ae/dereferenced/github.ae.deref.json index 4fb966764a..c8fe35b941 100644 --- a/descriptions/github.ae/dereferenced/github.ae.deref.json +++ b/descriptions/github.ae/dereferenced/github.ae.deref.json @@ -1140,6 +1140,43 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1519,6 +1556,34 @@ "type": "integer", "default": 1 } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -25369,6 +25434,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -28068,6 +28134,15 @@ "type": "integer", "default": 30 } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -39355,6 +39430,24 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -46380,6 +46473,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -57323,6 +57417,15 @@ "type": "integer", "default": 1 } + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { @@ -120070,7 +120173,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. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "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. GitHub Apps must have the `security_events` read permission to use\nthis 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).", "tags": [ "code-scanning" ], @@ -120142,7 +120245,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } }, { @@ -120155,6 +120258,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -120210,6 +120314,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -120405,7 +120510,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -120420,6 +120525,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -120767,6 +120873,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -120977,7 +121084,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -120992,6 +121099,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -121343,6 +121451,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -121553,7 +121662,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -121568,6 +121677,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -121852,7 +121962,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } } ], @@ -121868,7 +121978,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "analysis_key": { "type": "string", @@ -121883,6 +121993,7 @@ "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -122137,7 +122248,7 @@ "required": false, "schema": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." } }, { @@ -122165,7 +122276,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "commit_sha": { "description": "The SHA of the commit to which the analysis you are uploading relates.", @@ -122426,7 +122537,7 @@ "properties": { "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "commit_sha": { "description": "The SHA of the commit to which the analysis you are uploading relates.", @@ -122620,7 +122731,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -122662,7 +122773,7 @@ }, "ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "sarif": { "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/github-ae@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning).\"", @@ -127880,6 +127991,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -133745,9 +133876,27 @@ "type": "string" } }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -134492,7 +134641,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -134554,6 +134703,14 @@ "type": "integer", "default": 1 } + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -135541,7 +135698,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -137839,13 +137996,31 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } } ], "responses": { @@ -139607,7 +139782,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -141842,7 +142017,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -142557,7 +142732,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -143249,7 +143424,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -143972,7 +144147,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -152404,7 +152580,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -152426,6 +152603,26 @@ "type": "integer", "default": 1 } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -154146,6 +154343,26 @@ "schema": { "type": "string" } + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -154153,6 +154370,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -156633,7 +156851,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -156795,7 +157013,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -157155,7 +157373,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -157370,7 +157588,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -158386,7 +158604,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -209468,16 +209687,15 @@ }, { "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "created", - "updated" - ], - "default": "created" + "updated", + "created_at" + ] } }, { @@ -230125,6 +230343,279 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Content File", + "description": "Content File", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "git_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "download_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html": { + "type": "string", + "format": "uri", + "nullable": true + }, + "self": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "git", + "html", + "self" + ] + }, + "target": { + "type": "string", + "example": "\"actual/actual.md\"" + }, + "submodule_git_url": { + "type": "string", + "example": "\"git://example.com/defunkt/dotjs.git\"" + } + }, + "required": [ + "_links", + "git_url", + "html_url", + "download_url", + "name", + "path", + "sha", + "size", + "type", + "url", + "content", + "encoding" + ] + }, + "examples": { + "default": { + "value": { + "type": "file", + "encoding": "base64", + "size": 5362, + "name": "README.md", + "path": "README.md", + "content": "encoded content ...", + "sha": "3d21ec53a331a6f037a91c368710b99387d012c1", + "url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md", + "download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md", + "_links": { + "git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1", + "self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md", + "html": "https://github.com/octokit/octokit.rb/blob/master/README.md" + } + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -232612,7 +233103,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -237429,6 +237920,24 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } } ], "responses": { @@ -242371,6 +242880,1022 @@ } } }, + "/scim/v2/enterprises/{enterprise}/Groups": { + "get": { + "summary": "List provisioned SCIM groups for an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/list-provisioned-groups-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-provisioned-scim-groups-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "startIndex", + "description": "Used for pagination: the index of the first result to return.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "count", + "description": "Used for pagination: the number of results to return.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + { + "name": "filter", + "description": "filter results", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "excludedAttributes", + "description": "attributes to exclude", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "totalResults": { + "type": "number" + }, + "itemsPerPage": { + "type": "number" + }, + "startIndex": { + "type": "number" + }, + "Resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + }, + "required": [ + "schemas", + "id" + ] + } + } + }, + "required": [ + "schemas", + "totalResults", + "itemsPerPage", + "startIndex", + "Resources" + ] + }, + "examples": { + "default": { + "value": { + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "totalResults": 2, + "itemsPerPage": 2, + "startIndex": 1, + "Resources": [ + { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "display": "hubot@example.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:00", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + }, + { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "5e75bbbb-aa1a-11ea-8644-75ff655cdddd", + "externalId": null, + "displayName": "octo-docs-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T16:28:01.000+10:00", + "lastModified": "2020-06-09T16:28:01.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/5e75bbbb-aa1a-11ea-8644-75ff655cdddd" + } + } + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "post": { + "summary": "Provision a SCIM enterprise group and invite users", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nProvision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.", + "operationId": "enterprise-admin/provision-and-invite-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { + "type": "string" + } + }, + "displayName": { + "type": "string", + "description": "The name of the SCIM group. This must match the GitHub organization that the group maps to." + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The SCIM user ID for a user." + } + }, + "required": [ + "value" + ] + } + } + }, + "required": [ + "schemas", + "displayName" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + }, + "required": [ + "schemas", + "id" + ] + }, + "examples": { + "default": { + "value": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "display": "hubot@example.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:0", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + } + }, + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + "get": { + "summary": "Get SCIM provisioning information for an enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-group" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "scim_group_id", + "description": "Identifier generated by the GitHub SCIM endpoint.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "excludedAttributes", + "description": "Attributes to exclude.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + }, + "required": [ + "schemas", + "id" + ] + }, + "examples": { + "default": { + "value": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "display": "hubot@example.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:0", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "put": { + "summary": "Set SCIM information for a provisioned enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nReplaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-group" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "scim_group_id", + "description": "Identifier generated by the GitHub SCIM endpoint.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { + "type": "string" + } + }, + "displayName": { + "type": "string", + "description": "The name of the SCIM group. This must match the GitHub organization that the group maps to." + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The SCIM user ID for a user." + } + }, + "required": [ + "value" + ] + } + } + }, + "required": [ + "schemas", + "displayName" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + }, + "required": [ + "schemas", + "id" + ] + }, + "examples": { + "default": { + "value": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "display": "hubot@example.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:0", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "patch": { + "summary": "Update an attribute for a SCIM enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nAllows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "operationId": "enterprise-admin/update-attribute-for-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-group" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "scim_group_id", + "description": "Identifier generated by the GitHub SCIM endpoint.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { + "type": "string" + } + }, + "Operations": { + "type": "array", + "description": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "op": { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ] + }, + "path": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ] + } + }, + "required": [ + "op" + ] + } + } + }, + "required": [ + "schemas", + "Operations" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "Operations": [ + { + "op": "remove", + "path": "members", + "value": [ + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + }, + "required": [ + "schemas", + "id" + ] + }, + "examples": { + "default": { + "value": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:00", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "delete": { + "summary": "Delete a SCIM group from an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/delete-scim-group-from-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-a-scim-group-from-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "scim_group_id", + "description": "Identifier generated by the GitHub SCIM endpoint.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + } + }, "/search/code": { "get": { "summary": "Search code", @@ -267853,6 +269378,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" diff --git a/descriptions/github.ae/dereferenced/github.ae.deref.yaml b/descriptions/github.ae/dereferenced/github.ae.deref.yaml index 226d2b1af7..23efe1bf47 100644 --- a/descriptions/github.ae/dereferenced/github.ae.deref.yaml +++ b/descriptions/github.ae/dereferenced/github.ae.deref.yaml @@ -742,6 +742,32 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: &7 + type: string + enum: + - asc + - desc + default: desc + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string responses: '200': description: response @@ -834,7 +860,7 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: &44 + properties: &45 login: type: string example: github @@ -875,7 +901,7 @@ paths: type: string example: A great organization nullable: true - required: &45 + required: &46 - login - url - id @@ -945,7 +971,7 @@ paths: - name: org in: path required: true - schema: &93 + schema: &94 type: string responses: '202': @@ -1001,6 +1027,21 @@ paths: description: Page number of the results to fetch. in: query schema: *5 + - name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: *7 + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -1010,7 +1051,7 @@ paths: type: array items: type: object - properties: &7 + properties: &8 id: type: integer name: @@ -1101,10 +1142,10 @@ paths: application/json: schema: type: object - properties: *7 + properties: *8 examples: default: - value: &8 + value: &9 id: 2 name: DevTools Hook Env image_url: https://my_file_server/path/to/devtools_env.tar.gz @@ -1166,7 +1207,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: &9 + schema: &10 type: integer responses: '200': @@ -1175,10 +1216,10 @@ paths: application/json: schema: type: object - properties: *7 + properties: *8 examples: default: - value: *8 + value: *9 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -1209,7 +1250,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *9 + schema: *10 responses: '200': description: response @@ -1217,7 +1258,7 @@ paths: application/json: schema: type: object - properties: *7 + properties: *8 examples: default-response: value: @@ -1310,7 +1351,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *9 + schema: *10 responses: '204': description: Empty response @@ -1380,7 +1421,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *9 + schema: *10 responses: '202': description: response @@ -1388,7 +1429,7 @@ paths: application/json: schema: type: object - properties: &10 + properties: &11 url: type: string state: @@ -1467,7 +1508,7 @@ paths: - name: pre_receive_environment_id in: path required: true - schema: *9 + schema: *10 responses: '200': description: response @@ -1475,7 +1516,7 @@ paths: application/json: schema: type: object - properties: *10 + properties: *11 examples: default: value: @@ -1530,7 +1571,7 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: &14 + properties: &15 id: type: integer url: @@ -1586,7 +1627,7 @@ paths: - title: Simple User description: Simple User type: object - properties: &11 + properties: &12 login: type: string example: octocat @@ -1652,7 +1693,7 @@ paths: starred_at: type: string example: '"2020-07-09T00:17:55Z"' - required: &12 + required: &13 - avatar_url - events_url - followers_url @@ -1683,7 +1724,7 @@ paths: type: object description: The permissions granted to the user-to-server access token. - properties: &24 + properties: &25 actions: type: string description: 'The level of permission to grant the @@ -1932,7 +1973,7 @@ paths: enum: - read - write - example: &25 + example: &26 contents: read issues: read deployments: write @@ -1966,8 +2007,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true required: - permissions @@ -1975,7 +2016,7 @@ paths: - single_file_name - repositories_url - account - required: &15 + required: &16 - app - id - note @@ -2063,7 +2104,7 @@ paths: - name: username in: path required: true - schema: &13 + schema: &14 type: string responses: '204': @@ -2088,7 +2129,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '201': description: response @@ -2099,8 +2140,8 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *14 - required: *15 + properties: *15 + required: *16 examples: default: value: @@ -2150,7 +2191,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response @@ -2187,7 +2228,7 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: &16 + properties: &17 id: description: Unique identifier of the GitHub app example: 37 @@ -2205,8 +2246,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true name: description: The name of the GitHub app @@ -2277,7 +2318,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &17 + required: &18 - id - node_id - owner @@ -2292,7 +2333,7 @@ paths: additionalProperties: true examples: default: - value: &32 + value: &33 id: 1 slug: octoapp node_id: MDExOkludGVncmF0aW9uMQ== @@ -2368,8 +2409,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *16 - required: *17 + properties: *17 + required: *18 additionalProperties: true - type: object properties: @@ -2459,13 +2500,13 @@ paths: -----END RSA PRIVATE KEY----- '404': description: Resource Not Found - content: &22 + content: &23 application/json: schema: title: Basic Error description: Basic Error type: object - properties: &26 + properties: &27 message: type: string documentation_url: @@ -2478,10 +2519,10 @@ paths: title: Validation Error Simple description: Validation Error Simple type: object - required: &98 + required: &99 - message - documentation_url - properties: &99 + properties: &100 message: type: string documentation_url: @@ -2518,7 +2559,7 @@ paths: title: Webhook Configuration description: Configuration object of the webhook type: object - properties: &18 + properties: &19 url: type: string description: The URL to which the payloads will be delivered. @@ -2546,7 +2587,7 @@ paths: example: '"0"' examples: default: - value: &19 + value: &20 content_type: json insecure_ssl: '0' secret: "********" @@ -2614,10 +2655,10 @@ paths: title: Webhook Configuration description: Configuration object of the webhook type: object - properties: *18 + properties: *19 examples: default: - value: *19 + value: *20 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -2641,7 +2682,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: &43 + schema: &44 type: integer default: 30 - name: page @@ -2654,7 +2695,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: &65 + schema: &66 type: string - name: outdated in: query @@ -2673,7 +2714,7 @@ paths: title: Installation description: Installation type: object - properties: &20 + properties: &21 id: description: The ID of the installation. type: integer @@ -2684,8 +2725,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true - title: Enterprise description: An enterprise account @@ -2827,8 +2868,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true suspended_at: type: string @@ -2838,7 +2879,7 @@ paths: type: string example: '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' nullable: true - required: &21 + required: &22 - id - app_id - app_slug @@ -2928,7 +2969,7 @@ paths: description: installation_id parameter in: path required: true - schema: &23 + schema: &24 type: integer responses: '200': @@ -2939,8 +2980,8 @@ paths: title: Installation description: Installation type: object - properties: *20 - required: *21 + properties: *21 + required: *22 examples: default: value: @@ -2988,10 +3029,10 @@ paths: app_slug: github-actions '404': description: Resource Not Found - content: *22 + content: *23 '415': description: Preview Header Missing - content: &27 + content: &28 application/json: schema: type: object @@ -3026,13 +3067,13 @@ paths: description: installation_id parameter in: path required: true - schema: *23 + schema: *24 responses: '204': description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -3057,7 +3098,7 @@ paths: description: installation_id parameter in: path required: true - schema: *23 + schema: *24 requestBody: content: application/json: @@ -3084,8 +3125,8 @@ paths: type: object description: The permissions granted to the user-to-server access token. - properties: *24 - example: *25 + properties: *25 + example: *26 responses: '201': description: response @@ -3125,7 +3166,7 @@ paths: title: Repository description: A git repository type: object - properties: &60 + properties: &61 id: description: Unique identifier of the repository example: 42 @@ -3146,7 +3187,7 @@ paths: - title: License Simple description: License Simple type: object - properties: &82 + properties: &83 key: type: string example: mit @@ -3168,7 +3209,7 @@ paths: html_url: type: string format: uri - required: &83 + required: &84 - key - name - url @@ -3199,8 +3240,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true private: description: Whether the repository is private or public. @@ -3691,7 +3732,7 @@ paths: starred_at: type: string example: '"2020-07-09T00:17:42Z"' - required: &61 + required: &62 - archive_url - assignees_url - blobs_url @@ -3909,40 +3950,40 @@ paths: watchers: 1 '403': description: Forbidden - content: &33 + content: &34 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *26 + properties: *27 '415': description: Preview Header Missing - content: *27 + content: *28 '401': description: Requires Authentication - content: &69 + content: &70 application/json: schema: title: Basic Error description: Basic Error type: object - properties: *26 + properties: *27 '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed - content: &28 + content: &29 application/json: schema: title: Validation Error description: Validation Error type: object - required: &96 + required: &97 - message - documentation_url - properties: &97 + properties: &98 message: type: string documentation_url: @@ -3998,13 +4039,13 @@ paths: description: installation_id parameter in: path required: true - schema: *23 + schema: *24 responses: '204': description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4028,13 +4069,13 @@ paths: description: installation_id parameter in: path required: true - schema: *23 + schema: *24 responses: '204': description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4058,7 +4099,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: &29 + schema: &30 type: string requestBody: content: @@ -4077,7 +4118,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4104,11 +4145,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *29 + schema: *30 - name: access_token in: path required: true - schema: &31 + schema: &32 type: string responses: '204': @@ -4143,7 +4184,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *29 + schema: *30 requestBody: content: application/json: @@ -4165,11 +4206,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *14 - required: *15 + properties: *15 + required: *16 examples: default: - value: &30 + value: &31 id: 1 url: https://api.github.com/authorizations/1 scopes: @@ -4208,10 +4249,10 @@ paths: site_admin: false '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4238,7 +4279,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *29 + schema: *30 requestBody: content: application/json: @@ -4260,14 +4301,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *14 - required: *15 + properties: *15 + required: *16 examples: default: - value: *30 + value: *31 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4291,7 +4332,7 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *29 + schema: *30 requestBody: content: application/json: @@ -4311,7 +4352,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4336,11 +4377,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *29 + schema: *30 - name: access_token in: path required: true - schema: *31 + schema: *32 responses: '200': description: response @@ -4353,14 +4394,14 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *14 - required: *15 + properties: *15 + required: *16 examples: default: - value: *30 + value: *31 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4387,11 +4428,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *29 + schema: *30 - name: access_token in: path required: true - schema: *31 + schema: *32 responses: '200': description: response @@ -4402,11 +4443,11 @@ paths: description: The authorization for an OAuth app, GitHub App, or a Personal Access Token. type: object - properties: *14 - required: *15 + properties: *15 + required: *16 examples: default: - value: *30 + value: *31 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -4433,11 +4474,11 @@ paths: in: path required: true description: The client ID of your GitHub app. - schema: *29 + schema: *30 - name: access_token in: path required: true - schema: *31 + schema: *32 responses: '204': description: Empty response @@ -4482,21 +4523,21 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *16 - required: *17 + properties: *17 + required: *18 additionalProperties: true examples: default: - value: *32 + value: *33 '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -4525,7 +4566,7 @@ paths: title: Code Of Conduct description: Code Of Conduct type: object - properties: &34 + properties: &35 key: type: string example: contributor_covenant @@ -4591,7 +4632,7 @@ paths: type: string format: uri nullable: true - required: &35 + required: &36 - url - html_url - key @@ -4611,7 +4652,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -4652,8 +4693,8 @@ paths: title: Code Of Conduct description: Code Of Conduct type: object - properties: *34 - required: *35 + properties: *35 + required: *36 examples: default: value: @@ -4712,12 +4753,12 @@ paths: html_url: http://contributor-covenant.org/version/1/4/ '404': description: Resource Not Found - content: *22 + content: *23 '304': description: Not Modified '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -4822,10 +4863,10 @@ paths: self.save() '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 '410': description: Gone content: &124 @@ -4834,15 +4875,15 @@ paths: title: Basic Error description: Basic Error type: object - properties: *26 + properties: *27 '415': description: Preview Header Missing - content: *27 + content: *28 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -4904,7 +4945,7 @@ paths: title: Enterprise Announcement description: Enterprise global announcement type: object - properties: &36 + properties: &37 announcement: type: string description: The announcement text in GitHub Flavored Markdown. @@ -4920,12 +4961,12 @@ paths: it to an empty string.' example: '"2021-01-01T00:00:00.000-07:00"' nullable: true - required: &37 + required: &38 - announcement examples: default: summary: Default response - value: &38 + value: &39 announcement: Very **important** announcement about _nothing_. expires_at: '2021-01-01T00:00:00.000+00:00' x-github: @@ -4951,8 +4992,8 @@ paths: title: Enterprise Announcement description: Enterprise global announcement type: object - properties: *36 - required: *37 + properties: *37 + required: *38 responses: '200': description: response @@ -4962,12 +5003,12 @@ paths: title: Enterprise Announcement description: Enterprise global announcement type: object - properties: *36 - required: *37 + properties: *37 + required: *38 examples: default: summary: Default response - value: *38 + value: *39 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -5091,7 +5132,7 @@ paths: application/json: schema: type: object - properties: &39 + properties: &40 message: type: string description: A message indicating the action being taken on the @@ -5137,7 +5178,7 @@ paths: application/json: schema: type: object - properties: *39 + properties: *40 example: message: Started disabling encryption at rest. status_url: https://octocoders.github.io/api/v3/enterprise/encryption/status/db8ef711-ef82-464b-9013-5e0a1bb0031e @@ -5455,7 +5496,7 @@ paths: this value with the enterprise id. in: path required: true - schema: &40 + schema: &41 type: string responses: '200': @@ -5470,7 +5511,7 @@ paths: description: 'The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.' - enum: &41 + enum: &42 - all - none - selected @@ -5484,7 +5525,7 @@ paths: description: 'The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.' - enum: &42 + enum: &43 - all - local_only - selected @@ -5525,7 +5566,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 responses: '204': description: Empty response @@ -5540,12 +5581,12 @@ paths: description: 'The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.' - enum: *41 + enum: *42 allowed_actions: type: string description: 'The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.' - enum: *42 + enum: *43 required: - enabled_organizations example: @@ -5576,11 +5617,11 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -5601,8 +5642,8 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *44 - required: *45 + properties: *45 + required: *46 required: - total_count - organizations @@ -5647,7 +5688,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 responses: '204': description: Empty response @@ -5694,12 +5735,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 - name: org_id description: Unique identifier of an organization. in: path required: true - schema: &46 + schema: &47 type: integer responses: '204': @@ -5728,12 +5769,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 - name: org_id description: Unique identifier of an organization. in: path required: true - schema: *46 + schema: *47 responses: '204': description: Empty response @@ -5762,7 +5803,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 responses: '200': description: response @@ -5770,7 +5811,7 @@ paths: application/json: schema: type: object - properties: &47 + properties: &48 github_owned_allowed: type: boolean description: Whether GitHub-owned actions are allowed. For example, @@ -5787,13 +5828,13 @@ paths: example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`." items: type: string - required: &48 + required: &49 - github_owned_allowed - patterns_allowed - verified_allowed examples: default: - value: &49 + value: &50 github_owned_allowed: true verified_allowed: false patterns_allowed: @@ -5823,7 +5864,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 responses: '204': description: Empty response @@ -5832,11 +5873,11 @@ paths: application/json: schema: type: object - properties: *47 - required: *48 + properties: *48 + required: *49 examples: selected_actions: - value: *49 + value: *50 x-github: enabledForGitHubApps: false githubCloudOnly: false @@ -5862,11 +5903,11 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -5885,7 +5926,7 @@ paths: type: array items: type: object - properties: &50 + properties: &51 id: type: number name: @@ -5900,7 +5941,7 @@ paths: type: string allows_public_repositories: type: boolean - required: &51 + required: &52 - id - name - visibility @@ -5958,7 +5999,7 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 requestBody: content: application/json: @@ -6006,11 +6047,11 @@ paths: application/json: schema: type: object - properties: *50 - required: *51 + properties: *51 + required: *52 examples: default: - value: &52 + value: &53 id: 2 name: octo-runner-group visibility: selected @@ -6043,12 +6084,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: &53 + schema: &54 type: integer responses: '200': @@ -6057,11 +6098,11 @@ paths: application/json: schema: type: object - properties: *50 - required: *51 + properties: *51 + required: *52 examples: default: - value: *52 + value: *53 x-github: enabledForGitHubApps: false githubCloudOnly: false @@ -6086,12 +6127,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *53 + schema: *54 requestBody: content: application/json: @@ -6119,8 +6160,8 @@ paths: application/json: schema: type: object - properties: *50 - required: *51 + properties: *51 + required: *52 examples: default: value: @@ -6155,12 +6196,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *53 + schema: *54 responses: '204': description: Empty response @@ -6189,16 +6230,16 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *53 + schema: *54 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -6219,7 +6260,7 @@ paths: title: Self hosted runners description: A self hosted runner type: object - properties: &55 + properties: &56 id: description: The id of the runner. type: integer @@ -6256,7 +6297,7 @@ paths: enum: - read-only - custom - required: &56 + required: &57 - id - name - os @@ -6268,7 +6309,7 @@ paths: - runners examples: default: - value: &57 + value: &58 total_count: 2 runners: - id: 23 @@ -6333,12 +6374,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *53 + schema: *54 requestBody: content: application/json: @@ -6386,17 +6427,17 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *53 + schema: *54 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: &54 + schema: &55 type: integer responses: '204': @@ -6425,17 +6466,17 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *53 + schema: *54 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *54 + schema: *55 responses: '204': description: Empty response @@ -6464,11 +6505,11 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -6489,11 +6530,11 @@ paths: title: Self hosted runners description: A self hosted runner type: object - properties: *55 - required: *56 + properties: *56 + required: *57 examples: default: - value: *57 + value: *58 headers: Link: example: ; rel="next", ; @@ -6524,12 +6565,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *54 + schema: *55 responses: '200': description: response @@ -6539,8 +6580,8 @@ paths: title: Self hosted runners description: A self hosted runner type: object - properties: *55 - required: *56 + properties: *56 + required: *57 examples: default: value: @@ -6586,12 +6627,12 @@ paths: this value with the enterprise id. in: path required: true - schema: *40 + schema: *41 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *54 + schema: *55 responses: '204': description: Empty response @@ -6617,7 +6658,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -6633,7 +6674,7 @@ paths: title: Event description: Event type: object - properties: &85 + properties: &86 id: type: string type: @@ -6643,7 +6684,7 @@ paths: title: Actor description: Actor type: object - properties: &58 + properties: &59 id: type: integer login: @@ -6659,7 +6700,7 @@ paths: avatar_url: type: string format: uri - required: &59 + required: &60 - id - login - gravatar_id @@ -6683,8 +6724,8 @@ paths: title: Actor description: Actor type: object - properties: *58 - required: *59 + properties: *59 + required: *60 payload: type: object properties: @@ -6742,8 +6783,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true labels: type: array @@ -6794,8 +6835,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true assignees: type: array @@ -6803,8 +6844,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true nullable: true milestone: @@ -6814,7 +6855,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &78 + properties: &79 url: type: string format: uri @@ -6859,8 +6900,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true open_issues: type: integer @@ -6886,7 +6927,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &79 + required: &80 - closed_issues - creator - description @@ -6958,7 +6999,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: &62 + enum: &63 - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER @@ -6978,8 +7019,8 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 performed_via_github_app: nullable: true allOf: @@ -6991,8 +7032,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *16 - required: *17 + properties: *17 + required: *18 additionalProperties: true required: &289 - assignee @@ -7051,8 +7092,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true created_at: type: string @@ -7070,7 +7111,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *62 + enum: *63 performed_via_github_app: nullable: true allOf: @@ -7082,13 +7123,13 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *16 - required: *17 + properties: *17 + required: *18 additionalProperties: true reactions: title: Reaction Rollup type: object - properties: &80 + properties: &81 url: type: string format: uri @@ -7110,7 +7151,7 @@ paths: type: integer rocket: type: integer - required: &81 + required: &82 - url - total_count - "+1" @@ -7157,7 +7198,7 @@ paths: type: string format: date-time nullable: true - required: &86 + required: &87 - id - type - actor @@ -7169,7 +7210,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '503': description: Service Unavailable content: &221 @@ -7256,58 +7297,58 @@ paths: title: Link With Type description: Hypermedia Link with Type type: object - properties: &63 + properties: &64 href: type: string type: type: string - required: &64 + required: &65 - href - type user: title: Link With Type description: Hypermedia Link with Type type: object - properties: *63 - required: *64 + properties: *64 + required: *65 security_advisories: title: Link With Type description: Hypermedia Link with Type type: object - properties: *63 - required: *64 + properties: *64 + required: *65 current_user: title: Link With Type description: Hypermedia Link with Type type: object - properties: *63 - required: *64 + properties: *64 + required: *65 current_user_public: title: Link With Type description: Hypermedia Link with Type type: object - properties: *63 - required: *64 + properties: *64 + required: *65 current_user_actor: title: Link With Type description: Hypermedia Link with Type type: object - properties: *63 - required: *64 + properties: *64 + required: *65 current_user_organization: title: Link With Type description: Hypermedia Link with Type type: object - properties: *63 - required: *64 + properties: *64 + required: *65 current_user_organizations: type: array items: title: Link With Type description: Hypermedia Link with Type type: object - properties: *63 - required: *64 + properties: *64 + required: *65 required: - timeline - user @@ -7376,11 +7417,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -7396,7 +7437,7 @@ paths: title: Base Gist description: Base Gist type: object - properties: &66 + properties: &67 url: type: string format: uri @@ -7453,8 +7494,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true comments_url: type: string @@ -7465,8 +7506,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true truncated: type: boolean @@ -7476,7 +7517,7 @@ paths: history: type: array items: {} - required: &67 + required: &68 - id - node_id - url @@ -7495,7 +7536,7 @@ paths: - updated_at examples: default: - value: &68 + value: &69 - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits @@ -7547,7 +7588,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7615,7 +7656,7 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: &70 + properties: &71 url: type: string forks_url: @@ -7672,14 +7713,14 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true truncated: type: boolean examples: default: - value: &71 + value: &72 url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks commits_url: https://api.github.com/gists/aa5a315d61ae9438b18d/commits @@ -7700,15 +7741,15 @@ paths: type: string '422': description: Validation Failed - content: *28 + content: *29 '304': description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7735,11 +7776,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -7755,11 +7796,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *66 - required: *67 + properties: *67 + required: *68 examples: default: - value: *68 + value: *69 headers: Link: example: ; rel="next", ; @@ -7767,12 +7808,12 @@ paths: schema: *6 '422': description: Validation Failed - content: *28 + content: *29 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7796,11 +7837,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -7816,11 +7857,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *66 - required: *67 + properties: *67 + required: *68 examples: default: - value: *68 + value: *69 headers: Link: example: ; rel="next", ; @@ -7828,12 +7869,12 @@ paths: schema: *6 '401': description: Requires Authentication - content: *69 + content: *70 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7855,7 +7896,7 @@ paths: description: gist_id parameter in: path required: true - schema: &72 + schema: &73 type: string responses: '200': @@ -7866,13 +7907,13 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *70 + properties: *71 examples: default: - value: *71 + value: *72 '403': description: Forbidden Gist - content: &76 + content: &77 application/json: schema: type: object @@ -7893,7 +7934,7 @@ paths: type: string '404': description: Resource Not Found - content: *22 + content: *23 '304': description: Not Modified x-github: @@ -7918,7 +7959,7 @@ paths: description: gist_id parameter in: path required: true - schema: *72 + schema: *73 requestBody: content: application/json: @@ -7969,16 +8010,16 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *70 + properties: *71 examples: default: - value: *71 + value: *72 '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -7999,18 +8040,18 @@ paths: description: gist_id parameter in: path required: true - schema: *72 + schema: *73 responses: '204': description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8032,11 +8073,11 @@ paths: description: gist_id parameter in: path required: true - schema: *72 + schema: *73 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -8052,7 +8093,7 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: &73 + properties: &74 id: type: integer example: 1 @@ -8074,8 +8115,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true created_at: type: string @@ -8090,8 +8131,8 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *62 - required: &74 + enum: *63 + required: &75 - url - id - node_id @@ -8138,10 +8179,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8162,7 +8203,7 @@ paths: description: gist_id parameter in: path required: true - schema: *72 + schema: *73 requestBody: content: application/json: @@ -8185,11 +8226,11 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *73 - required: *74 + properties: *74 + required: *75 examples: default: - value: &75 + value: &76 id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== url: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 @@ -8225,10 +8266,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8250,12 +8291,12 @@ paths: description: gist_id parameter in: path required: true - schema: *72 + schema: *73 - name: comment_id description: comment_id parameter in: path required: true - schema: &77 + schema: &78 type: integer responses: '200': @@ -8266,19 +8307,19 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *73 - required: *74 + properties: *74 + required: *75 examples: default: - value: *75 + value: *76 '304': description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden Gist - content: *76 + content: *77 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8299,12 +8340,12 @@ paths: description: gist_id parameter in: path required: true - schema: *72 + schema: *73 - name: comment_id description: comment_id parameter in: path required: true - schema: *77 + schema: *78 requestBody: content: application/json: @@ -8327,14 +8368,14 @@ paths: title: Gist Comment description: A comment made to a gist. type: object - properties: *73 - required: *74 + properties: *74 + required: *75 examples: default: - value: *75 + value: *76 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8355,12 +8396,12 @@ paths: description: gist_id parameter in: path required: true - schema: *72 + schema: *73 - name: comment_id description: comment_id parameter in: path required: true - schema: *77 + schema: *78 responses: '204': description: Empty response @@ -8368,10 +8409,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8393,11 +8434,11 @@ paths: description: gist_id parameter in: path required: true - schema: *72 + schema: *73 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -8427,8 +8468,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true change_status: type: object @@ -8485,12 +8526,12 @@ paths: type: string '404': description: Resource Not Found - content: *22 + content: *23 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8512,11 +8553,11 @@ paths: description: gist_id parameter in: path required: true - schema: *72 + schema: *73 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -8532,7 +8573,7 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *70 + properties: *71 examples: default: value: @@ -8584,12 +8625,12 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8610,7 +8651,7 @@ paths: description: gist_id parameter in: path required: true - schema: *72 + schema: *73 responses: '201': description: response @@ -8620,8 +8661,8 @@ paths: title: Base Gist description: Base Gist type: object - properties: *66 - required: *67 + properties: *67 + required: *68 examples: default: value: @@ -8674,15 +8715,15 @@ paths: type: string '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed - content: *28 + content: *29 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8704,7 +8745,7 @@ paths: description: gist_id parameter in: path required: true - schema: *72 + schema: *73 responses: '204': description: Response if gist is starred @@ -8720,7 +8761,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8742,18 +8783,18 @@ paths: description: gist_id parameter in: path required: true - schema: *72 + schema: *73 responses: '204': description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8774,7 +8815,7 @@ paths: description: gist_id parameter in: path required: true - schema: *72 + schema: *73 responses: '204': description: Empty response @@ -8782,10 +8823,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8807,7 +8848,7 @@ paths: description: gist_id parameter in: path required: true - schema: *72 + schema: *73 - name: sha in: path required: true @@ -8822,19 +8863,19 @@ paths: title: Gist Simple description: Gist Simple type: object - properties: *70 + properties: *71 examples: default: - value: *71 + value: *72 '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8979,7 +9020,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -9003,8 +9044,8 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 repository_selection: type: string example: selected @@ -9132,12 +9173,12 @@ paths: schema: *6 '403': description: Forbidden - content: *33 + content: *34 '304': description: Not Modified '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -9211,6 +9252,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -9229,7 +9271,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: &113 + schema: &114 type: string - name: sort description: What to sort results by. Can be either `created`, `updated`, @@ -9247,19 +9289,14 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: &114 - type: string - enum: - - asc - - desc - default: desc + schema: *7 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: collab in: query required: false @@ -9283,7 +9320,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -9349,8 +9386,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true labels: description: Labels to associate with this issue; pass one or @@ -9390,8 +9427,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true assignees: type: array @@ -9399,8 +9436,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true nullable: true milestone: @@ -9409,8 +9446,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *78 - required: *79 + properties: *79 + required: *80 locked: type: boolean active_lock_reason: @@ -9462,8 +9499,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true body_html: type: string @@ -9476,8 +9513,8 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 performed_via_github_app: nullable: true allOf: @@ -9488,20 +9525,20 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *16 - required: *17 + properties: *17 + required: *18 additionalProperties: true author_association: title: author_association type: string example: OWNER description: How the author is associated with the repository. - enum: *62 + enum: *63 reactions: title: Reaction Rollup type: object - properties: *80 - required: *81 + properties: *81 + required: *82 required: &116 - assignee - closed_at @@ -9775,12 +9812,12 @@ paths: schema: *6 '422': description: Validation Failed - content: *28 + content: *29 '304': description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9816,7 +9853,11 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 responses: '200': description: response @@ -9828,8 +9869,8 @@ paths: title: License Simple description: License Simple type: object - properties: *82 - required: *83 + properties: *83 + required: *84 examples: default: value: @@ -10054,10 +10095,10 @@ paths: featured: true '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 '304': description: Not Modified x-github: @@ -10114,7 +10155,7 @@ paths: type: string X-CommonMarker-Version: example: 0.17.4 - schema: &84 + schema: &85 type: string content: text/html: @@ -10157,7 +10198,7 @@ paths: headers: X-CommonMarker-Version: example: 0.17.4 - schema: *84 + schema: *85 content: text/html: schema: @@ -10309,7 +10350,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -10325,14 +10366,14 @@ paths: title: Event description: Event type: object - properties: *85 - required: *86 + properties: *86 + required: *87 '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 '304': description: Not Modified '301': @@ -10376,7 +10417,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -10388,7 +10429,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -10404,14 +10445,14 @@ paths: title: Thread description: Thread type: object - properties: &87 + properties: &88 id: type: string repository: title: Minimal Repository description: Minimal Repository type: object - properties: &108 + properties: &109 id: type: integer example: 1296269 @@ -10431,8 +10472,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true private: type: boolean @@ -10653,8 +10694,8 @@ paths: - title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 temp_clone_token: type: string delete_branch_on_merge: @@ -10686,7 +10727,7 @@ paths: watchers: type: integer example: 0 - required: &109 + required: &110 - archive_url - assignees_url - blobs_url @@ -10763,7 +10804,7 @@ paths: subscription_url: type: string example: https://api.github.com/notifications/threads/2/subscription - required: &88 + required: &89 - id - unread - reason @@ -10864,13 +10905,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10922,10 +10963,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10947,7 +10988,7 @@ paths: description: thread_id parameter in: path required: true - schema: &89 + schema: &90 type: integer responses: '200': @@ -10958,8 +10999,8 @@ paths: title: Thread description: Thread type: object - properties: *87 - required: *88 + properties: *88 + required: *89 examples: default: value: @@ -11046,10 +11087,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11070,7 +11111,7 @@ paths: description: thread_id parameter in: path required: true - schema: *89 + schema: *90 responses: '205': description: response @@ -11078,7 +11119,7 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11103,7 +11144,7 @@ paths: description: thread_id parameter in: path required: true - schema: *89 + schema: *90 responses: '200': description: response @@ -11113,7 +11154,7 @@ paths: title: Thread Subscription description: Thread Subscription type: object - properties: &90 + properties: &91 subscribed: type: boolean example: true @@ -11139,7 +11180,7 @@ paths: type: string format: uri example: https://api.github.com/repos/1 - required: &91 + required: &92 - created_at - ignored - reason @@ -11147,7 +11188,7 @@ paths: - subscribed examples: default: - value: &92 + value: &93 subscribed: true ignored: false reason: @@ -11158,10 +11199,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11187,7 +11228,7 @@ paths: description: thread_id parameter in: path required: true - schema: *89 + schema: *90 requestBody: content: application/json: @@ -11207,19 +11248,19 @@ paths: title: Thread Subscription description: Thread Subscription type: object - properties: *90 - required: *91 + properties: *91 + required: *92 examples: default: - value: *92 + value: *93 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11244,7 +11285,7 @@ paths: description: thread_id parameter in: path required: true - schema: *89 + schema: *90 responses: '204': description: Empty response @@ -11252,10 +11293,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11312,7 +11353,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 responses: '200': description: response @@ -11324,11 +11365,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *44 - required: *45 + properties: *45 + required: *46 examples: default: - value: &391 + value: &396 - login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= @@ -11371,7 +11412,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 responses: '200': description: response @@ -11381,7 +11422,7 @@ paths: title: Organization Full description: Organization Full type: object - properties: &94 + properties: &95 login: type: string example: github @@ -11544,7 +11585,7 @@ paths: updated_at: type: string format: date-time - required: &95 + required: &96 - login - url - id @@ -11658,7 +11699,7 @@ paths: seats: 5 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11690,7 +11731,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 requestBody: content: application/json: @@ -11844,8 +11885,8 @@ paths: title: Organization Full description: Organization Full type: object - properties: *94 - required: *95 + properties: *95 + required: *96 examples: default: value: @@ -11905,13 +11946,13 @@ paths: - title: Validation Error description: Validation Error type: object - required: *96 - properties: *97 + required: *97 + properties: *98 - title: Validation Error Simple description: Validation Error Simple type: object - required: *98 - properties: *99 + required: *99 + properties: *100 '409': description: Conflict content: &241 @@ -11920,10 +11961,10 @@ paths: title: Basic Error description: Basic Error type: object - properties: *26 + properties: *27 '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11956,7 +11997,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 responses: '200': description: response @@ -11970,7 +12011,7 @@ paths: description: 'The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.' - enum: &100 + enum: &101 - all - none - selected @@ -11984,7 +12025,7 @@ paths: description: 'The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.' - enum: *42 + enum: *43 selected_actions_url: type: string description: The API URL to use to get or set the actions that @@ -12022,7 +12063,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 responses: '204': description: Empty response @@ -12037,12 +12078,12 @@ paths: description: 'The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.' - enum: *100 + enum: *101 allowed_actions: type: string description: 'The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.' - enum: *42 + enum: *43 required: - enabled_repositories example: @@ -12071,11 +12112,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -12099,11 +12140,11 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 examples: default: - value: &387 + value: &392 total_count: 1 repositories: - id: 1296269 @@ -12244,7 +12285,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 responses: '204': description: Empty response @@ -12289,11 +12330,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: repository_id in: path required: true - schema: &101 + schema: &102 type: integer responses: '204': @@ -12320,11 +12361,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: repository_id in: path required: true - schema: *101 + schema: *102 responses: '204': description: Empty response @@ -12351,7 +12392,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 responses: '200': description: response @@ -12359,11 +12400,11 @@ paths: application/json: schema: type: object - properties: *47 - required: *48 + properties: *48 + required: *49 examples: default: - value: *49 + value: *50 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -12390,7 +12431,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 responses: '204': description: Empty response @@ -12399,11 +12440,11 @@ paths: application/json: schema: type: object - properties: *47 - required: *48 + properties: *48 + required: *49 examples: selected_actions: - value: *49 + value: *50 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -12429,7 +12470,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 requestBody: content: application/json: @@ -12479,7 +12520,7 @@ paths: application/json: schema: type: object - properties: &102 + properties: &103 id: type: number name: @@ -12500,7 +12541,7 @@ paths: type: boolean allows_public_repositories: type: boolean - required: &103 + required: &104 - id - name - visibility @@ -12510,7 +12551,7 @@ paths: - allows_public_repositories examples: default: - value: &104 + value: &105 id: 2 name: octo-runner-group visibility: selected @@ -12544,12 +12585,12 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *53 + schema: *54 requestBody: content: application/json: @@ -12578,11 +12619,11 @@ paths: application/json: schema: type: object - properties: *102 - required: *103 + properties: *103 + required: *104 examples: default: - value: *104 + value: *105 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -12607,12 +12648,12 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path required: true - schema: *53 + schema: *54 responses: '204': description: Empty response @@ -12639,12 +12680,12 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: runner_id description: Unique identifier of the self-hosted runner. in: path required: true - schema: *54 + schema: *55 responses: '204': description: Empty response @@ -12671,11 +12712,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -12699,7 +12740,7 @@ paths: title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object - properties: &105 + properties: &106 name: description: The name of the secret. example: SECRET_TOKEN @@ -12721,7 +12762,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/org/secrets/my_secret/repositories - required: &106 + required: &107 - name - created_at - updated_at @@ -12772,7 +12813,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 responses: '200': description: response @@ -12834,12 +12875,12 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: secret_name description: secret_name parameter in: path required: true - schema: &107 + schema: &108 type: string responses: '200': @@ -12850,8 +12891,8 @@ paths: title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object - properties: *105 - required: *106 + properties: *106 + required: *107 examples: default: value: @@ -12954,12 +12995,12 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: secret_name description: secret_name parameter in: path required: true - schema: *107 + schema: *108 requestBody: content: application/json: @@ -13033,12 +13074,12 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: secret_name description: secret_name parameter in: path required: true - schema: *107 + schema: *108 responses: '204': description: Empty response @@ -13065,12 +13106,20 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: secret_name description: secret_name parameter in: path required: true - schema: *107 + schema: *108 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *44 responses: '200': description: response @@ -13090,8 +13139,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 examples: default: value: @@ -13187,12 +13236,12 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: secret_name description: secret_name parameter in: path required: true - schema: *107 + schema: *108 requestBody: content: application/json: @@ -13241,12 +13290,12 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: secret_name description: secret_name parameter in: path required: true - schema: *107 + schema: *108 - name: repository_id in: path required: true @@ -13281,12 +13330,12 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: secret_name description: secret_name parameter in: path required: true - schema: *107 + schema: *108 - name: repository_id in: path required: true @@ -13317,11 +13366,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -13337,8 +13386,8 @@ paths: title: Event description: Event type: object - properties: *85 - required: *86 + properties: *86 + required: *87 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13359,11 +13408,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -13379,7 +13428,7 @@ paths: title: Org Hook description: Org Hook type: object - properties: &110 + properties: &111 id: type: integer example: 1 @@ -13429,7 +13478,7 @@ paths: example: '2011-09-06T17:26:27Z' type: type: string - required: &111 + required: &112 - id - url - type @@ -13464,7 +13513,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13485,7 +13534,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 requestBody: content: application/json: @@ -13568,11 +13617,11 @@ paths: title: Org Hook description: Org Hook type: object - properties: *110 - required: *111 + properties: *111 + required: *112 examples: default: - value: &112 + value: &113 id: 1 url: https://api.github.com/orgs/octocat/hooks/1 ping_url: https://api.github.com/orgs/octocat/hooks/1/pings @@ -13594,10 +13643,10 @@ paths: type: string '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13619,7 +13668,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: hook_id in: path required: true @@ -13633,14 +13682,14 @@ paths: title: Org Hook description: Org Hook type: object - properties: *110 - required: *111 + properties: *111 + required: *112 examples: default: - value: *112 + value: *113 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13664,7 +13713,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: hook_id in: path required: true @@ -13737,8 +13786,8 @@ paths: title: Org Hook description: Org Hook type: object - properties: *110 - required: *111 + properties: *111 + required: *112 examples: default: value: @@ -13757,10 +13806,10 @@ paths: type: Organization '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13780,7 +13829,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: hook_id in: path required: true @@ -13790,7 +13839,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13814,7 +13863,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: hook_id in: path required: true @@ -13828,10 +13877,10 @@ paths: title: Webhook Configuration description: Configuration object of the webhook type: object - properties: *18 + properties: *19 examples: default: - value: *19 + value: *20 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13854,7 +13903,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: hook_id in: path required: true @@ -13904,10 +13953,10 @@ paths: title: Webhook Configuration description: Configuration object of the webhook type: object - properties: *18 + properties: *19 examples: default: - value: *19 + value: *20 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13929,7 +13978,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: hook_id in: path required: true @@ -13939,7 +13988,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -13963,7 +14012,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 responses: '200': description: response @@ -13973,8 +14022,8 @@ paths: title: Installation description: Installation type: object - properties: *20 - required: *21 + properties: *21 + required: *22 examples: default: value: &284 @@ -14042,11 +14091,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -14070,8 +14119,8 @@ paths: title: Installation description: Installation type: object - properties: *20 - required: *21 + properties: *21 + required: *22 examples: default: value: @@ -14151,7 +14200,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: filter description: "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you @@ -14167,6 +14216,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -14185,7 +14235,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *113 + schema: *114 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -14202,18 +14252,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *114 + schema: *7 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -14242,7 +14292,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14275,7 +14325,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: filter description: "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -14305,7 +14355,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -14321,8 +14371,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: @@ -14359,7 +14409,7 @@ paths: type: string '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14380,11 +14430,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Response if requester is an organization member and user is @@ -14419,17 +14469,17 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14451,11 +14501,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: username in: path required: true - schema: *13 + schema: *14 responses: '200': description: response @@ -14484,16 +14534,16 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *44 - required: *45 + properties: *45 + required: *46 user: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true permissions: type: object @@ -14629,10 +14679,10 @@ paths: site_admin: false '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14664,11 +14714,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: username in: path required: true - schema: *13 + schema: *14 requestBody: content: application/json: @@ -14777,10 +14827,10 @@ paths: site_admin: false '422': description: Validation Failed - content: *28 + content: *29 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14803,20 +14853,20 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14837,7 +14887,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: filter description: "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -14853,7 +14903,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -14869,8 +14919,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: @@ -14903,11 +14953,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: username in: path required: true - schema: *13 + schema: *14 responses: '202': description: User is getting converted asynchronously @@ -14937,7 +14987,7 @@ paths: documentation_url: https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-member-to-outside-collaborator '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -14958,11 +15008,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response @@ -15006,7 +15056,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: state description: Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. @@ -15022,7 +15072,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -15085,8 +15135,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true created_at: type: string @@ -15194,7 +15244,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 requestBody: content: application/json: @@ -15259,13 +15309,13 @@ paths: updated_at: '2014-03-04T18:58:10Z' '401': description: Requires Authentication - content: *69 + content: *70 '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 '410': description: Gone content: *124 @@ -15300,11 +15350,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -15320,8 +15370,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: @@ -15351,11 +15401,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Response if user is a public member @@ -15383,17 +15433,17 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -15413,11 +15463,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response @@ -15441,7 +15491,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: type description: 'Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. @@ -15486,7 +15536,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -15502,8 +15552,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 examples: default: value: &149 @@ -15770,7 +15820,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 requestBody: content: application/json: @@ -15891,8 +15941,8 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 examples: default: value: &268 @@ -16019,10 +16069,10 @@ paths: type: string '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16061,11 +16111,11 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -16212,7 +16262,7 @@ paths: schema: *6 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16235,7 +16285,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 requestBody: content: application/json: @@ -16380,8 +16430,8 @@ paths: title: Organization Full description: Organization Full type: object - properties: *94 - required: *95 + properties: *95 + required: *96 ldap_dn: description: Distinguished Name (DN) that team maps to within LDAP environment @@ -16453,10 +16503,10 @@ paths: type: Organization '422': description: Validation Failed - content: *28 + content: *29 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16480,7 +16530,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -16504,7 +16554,7 @@ paths: value: *129 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16527,7 +16577,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -16619,7 +16669,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -16651,7 +16701,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -16661,15 +16711,21 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *114 + schema: *7 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: pinned + in: query + required: false + description: Pinned discussions only filter + schema: + type: string responses: '200': description: response @@ -16689,8 +16745,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true body: description: The main text of the discussion. @@ -16761,8 +16817,8 @@ paths: reactions: title: Reaction Rollup type: object - properties: *80 - required: *81 + properties: *81 + required: *82 required: &132 - author - body @@ -16783,7 +16839,7 @@ paths: - url examples: default: - value: &367 + value: &372 - author: login: octocat id: 1 @@ -16870,7 +16926,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -16997,7 +17053,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -17055,7 +17111,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -17093,7 +17149,7 @@ paths: required: *132 examples: default: - value: &368 + value: &373 author: login: octocat id: 1 @@ -17173,7 +17229,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -17209,7 +17265,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -17223,11 +17279,11 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *114 + schema: *7 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -17250,8 +17306,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true body: description: The main text of the comment. @@ -17301,8 +17357,8 @@ paths: reactions: title: Reaction Rollup type: object - properties: *80 - required: *81 + properties: *81 + required: *82 required: &136 - author - body @@ -17318,7 +17374,7 @@ paths: - url examples: default: - value: &369 + value: &374 - author: login: octocat id: 1 @@ -17399,7 +17455,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -17511,7 +17567,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -17572,7 +17628,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -17612,7 +17668,7 @@ paths: required: *136 examples: default: - value: &370 + value: &375 author: login: octocat id: 1 @@ -17686,7 +17742,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -17726,7 +17782,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -17759,7 +17815,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -17789,8 +17845,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true content: description: The reaction to use @@ -17878,7 +17934,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -17986,7 +18042,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -18041,7 +18097,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -18070,7 +18126,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -18129,7 +18185,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -18210,7 +18266,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -18260,7 +18316,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -18282,7 +18338,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -18298,8 +18354,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: @@ -18336,7 +18392,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -18345,7 +18401,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '200': description: response @@ -18376,19 +18432,19 @@ paths: examples: response-if-user-has-an-active-membership-with-team: summary: Response if user has an active membership with team - value: &371 + value: &376 url: https://api.github.com/teams/1/memberships/octocat role: member state: active response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer - value: &372 + value: &377 url: https://api.github.com/teams/1/memberships/octocat role: maintainer state: active response-if-user-has-a-pending-membership-with-team: summary: Response if user has a pending membership with team - value: &373 + value: &378 url: https://api.github.com/teams/1/memberships/octocat role: member state: pending @@ -18424,7 +18480,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -18433,7 +18489,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 requestBody: content: application/json: @@ -18465,13 +18521,13 @@ paths: examples: response-if-users-membership-with-team-is-now-active: summary: Response if user's membership with team is now active - value: &374 + value: &379 url: https://api.github.com/teams/1/memberships/octocat role: member state: active response-if-users-membership-with-team-is-now-pending: summary: Response if user's membership with team is now pending - value: &375 + value: &380 url: https://api.github.com/teams/1/memberships/octocat role: member state: pending @@ -18531,7 +18587,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -18540,7 +18596,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response @@ -18569,7 +18625,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -18578,7 +18634,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -18620,8 +18676,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true created_at: type: string @@ -18665,7 +18721,7 @@ paths: - permissions examples: default: - value: &376 + value: &381 - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 html_url: https://github.com/orgs/api-playground/projects/1 @@ -18738,7 +18794,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -18762,7 +18818,7 @@ paths: required: *147 examples: default: - value: &377 + value: &382 owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 html_url: https://github.com/orgs/api-playground/projects/1 @@ -18831,7 +18887,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -18912,7 +18968,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -18948,7 +19004,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -18957,7 +19013,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -18973,8 +19029,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 examples: default: value: *149 @@ -19010,7 +19066,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -19033,7 +19089,7 @@ paths: title: Team Repository description: A team's access to a repository. type: object - properties: &378 + properties: &383 id: description: Unique identifier of the repository example: 42 @@ -19054,8 +19110,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *82 - required: *83 + properties: *83 + required: *84 forks: type: integer permissions: @@ -19081,8 +19137,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true private: description: Whether the repository is private or public. @@ -19338,8 +19394,8 @@ paths: - title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 temp_clone_token: type: string allow_squash_merge: @@ -19368,7 +19424,7 @@ paths: type: integer master_branch: type: string - required: &379 + required: &384 - archive_url - assignees_url - blobs_url @@ -19704,7 +19760,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -19771,7 +19827,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -19811,7 +19867,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 - name: team_slug description: team_slug parameter in: path @@ -19820,7 +19876,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -19841,7 +19897,7 @@ paths: required: *153 examples: response-if-child-teams-exist: - value: &380 + value: &385 - id: 2 node_id: MDQ6VGVhbTI= url: https://api.github.com/teams/2 @@ -19924,8 +19980,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true created_at: type: string @@ -19997,13 +20053,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20065,13 +20121,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed content: *121 @@ -20125,10 +20181,10 @@ paths: type: string '401': description: Requires Authentication - content: *69 + content: *70 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20213,7 +20269,7 @@ paths: type: string '401': description: Requires Authentication - content: *69 + content: *70 '503': description: Service Unavailable content: @@ -20238,7 +20294,7 @@ paths: type: string '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20334,13 +20390,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20399,10 +20455,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20438,10 +20494,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20486,7 +20542,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -20545,10 +20601,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20626,10 +20682,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 '422': description: Validation Failed content: @@ -20639,13 +20695,13 @@ paths: - title: Validation Error description: Validation Error type: object - required: *96 - properties: *97 + required: *97 + properties: *98 - title: Validation Error Simple description: Validation Error Simple type: object - required: *98 - properties: *99 + required: *99 + properties: *100 '503': description: Service Unavailable content: @@ -20723,13 +20779,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed content: *121 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20809,10 +20865,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20910,7 +20966,7 @@ paths: type: string '401': description: Requires Authentication - content: *69 + content: *70 '410': description: Gone content: *124 @@ -20967,13 +21023,13 @@ paths: type: string '401': description: Requires Authentication - content: *69 + content: *70 '410': description: Gone content: *124 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21025,7 +21081,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -21041,8 +21097,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: @@ -21054,21 +21110,21 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 '415': description: Preview Header Missing - content: *27 + content: *28 '422': description: Validation Failed - content: *28 + content: *29 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21101,7 +21157,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 requestBody: content: application/json: @@ -21122,21 +21178,21 @@ paths: description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 '415': description: Preview Header Missing - content: *27 + content: *28 '422': description: Validation Failed - content: *28 + content: *29 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21168,7 +21224,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response @@ -21176,19 +21232,19 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '415': description: Preview Header Missing - content: *27 + content: *28 '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *28 + content: *29 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21223,7 +21279,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '200': description: response @@ -21242,8 +21298,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true required: &236 - permission @@ -21273,21 +21329,21 @@ paths: site_admin: false '404': description: Resource Not Found - content: *22 + content: *23 '415': description: Preview Header Missing - content: *27 + content: *28 '422': description: Validation Failed - content: *28 + content: *29 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21319,7 +21375,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -21357,10 +21413,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21424,13 +21480,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed content: *121 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21567,7 +21623,7 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21599,16 +21655,16 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 '410': description: Gone content: *124 '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21678,8 +21734,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true private: type: boolean @@ -21932,8 +21988,8 @@ paths: - title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 temp_clone_token: type: string nullable: true @@ -21958,29 +22014,29 @@ paths: - title: License Simple description: License Simple type: object - properties: *82 - required: *83 + properties: *83 + required: *84 organization: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true parent: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 source: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 forks: type: integer master_branch: @@ -23070,10 +23126,10 @@ paths: url: https://api.github.com/repos/github/docs/community/code_of_conduct '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 '301': description: Moved Permanently x-github: @@ -23719,13 +23775,13 @@ paths: watchers: 1 '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23792,7 +23848,7 @@ paths: documentation_url: https://docs.github.com/github-ae@latest/rest/reference/repos#delete-a-repository '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23824,7 +23880,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -24388,7 +24444,7 @@ paths: description: 'The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.' - enum: *42 + enum: *43 selected_actions_url: type: string description: The API URL to use to get or set the actions that @@ -24447,7 +24503,7 @@ paths: type: string description: 'The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.' - enum: *42 + enum: *43 required: - enabled example: @@ -24488,11 +24544,11 @@ paths: application/json: schema: type: object - properties: *47 - required: *48 + properties: *48 + required: *49 examples: default: - value: *49 + value: *50 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -24532,11 +24588,11 @@ paths: application/json: schema: type: object - properties: *47 - required: *48 + properties: *48 + required: *49 examples: selected_actions: - value: *49 + value: *50 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -24566,7 +24622,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -24590,11 +24646,11 @@ paths: title: Self hosted runners description: A self hosted runner type: object - properties: *55 - required: *56 + properties: *56 + required: *57 examples: default: - value: *57 + value: *58 headers: Link: example: ; rel="next", ; @@ -24633,7 +24689,7 @@ paths: description: Unique identifier of the self-hosted runner. in: path required: true - schema: *54 + schema: *55 responses: '204': description: Empty response @@ -24714,7 +24770,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -24935,14 +24991,14 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 head_repository: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 head_repository_id: type: integer example: 5 @@ -25486,8 +25542,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true comment: type: string @@ -25566,7 +25622,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -25685,7 +25741,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -25975,8 +26031,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true - title: Team Simple description: Groups of organization members that gives @@ -26156,8 +26212,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true created_at: type: string @@ -26195,8 +26251,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *16 - required: *17 + properties: *17 + required: *18 additionalProperties: true required: &254 - id @@ -26412,7 +26468,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -26453,7 +26509,7 @@ paths: - updated_at examples: default: - value: &362 + value: &363 total_count: 2 secrets: - name: GH_TOKEN @@ -26542,7 +26598,7 @@ paths: description: secret_name parameter in: path required: true - schema: *107 + schema: *108 responses: '200': description: response @@ -26556,7 +26612,7 @@ paths: required: *181 examples: default: - value: &363 + value: &364 name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' @@ -26663,7 +26719,7 @@ paths: description: secret_name parameter in: path required: true - schema: *107 + schema: *108 requestBody: content: application/json: @@ -26718,7 +26774,7 @@ paths: description: secret_name parameter in: path required: true - schema: *107 + schema: *108 responses: '204': description: Empty response @@ -26753,7 +26809,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -27124,7 +27180,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -27261,7 +27317,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -27277,8 +27333,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: @@ -27290,7 +27346,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27338,7 +27394,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *26 + properties: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27375,7 +27431,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -27465,8 +27521,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true teams: description: The list of teams with review dismissal @@ -27757,7 +27813,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27908,8 +27964,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true committer: nullable: true @@ -27917,8 +27973,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true parents: type: array @@ -28113,10 +28169,10 @@ paths: protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection '415': description: Preview Header Missing - content: *27 + content: *28 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28294,7 +28350,7 @@ paths: enabled: true '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28556,8 +28612,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true teams: type: array @@ -28635,16 +28691,16 @@ paths: - url '403': description: Forbidden - content: *33 + content: *34 '415': description: Preview Header Missing - content: *27 + content: *28 '422': description: Validation Failed content: *121 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28691,7 +28747,7 @@ paths: description: Empty response '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28828,7 +28884,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29021,7 +29077,7 @@ paths: value: *201 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29068,7 +29124,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29123,7 +29179,7 @@ paths: enabled: true '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29180,7 +29236,7 @@ paths: value: *202 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29226,7 +29282,7 @@ paths: description: No Content '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29290,7 +29346,7 @@ paths: contexts_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29359,10 +29415,10 @@ paths: value: *205 '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29448,7 +29504,7 @@ paths: - continuous-integration/travis-ci '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29513,13 +29569,13 @@ paths: - continuous-integration/jenkins '422': description: Validation Failed - content: *28 + content: *29 '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29584,10 +29640,10 @@ paths: - continuous-integration/travis-ci '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29652,10 +29708,10 @@ paths: - continuous-integration/travis-ci '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29776,7 +29832,7 @@ paths: - pull_request '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29862,8 +29918,8 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *16 - required: *17 + properties: *17 + required: *18 additionalProperties: true examples: default: @@ -29906,7 +29962,7 @@ paths: - pull_request '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29975,15 +30031,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *16 - required: *17 + properties: *17 + required: *18 additionalProperties: true examples: default: value: *206 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30053,15 +30109,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *16 - required: *17 + properties: *17 + required: *18 additionalProperties: true examples: default: value: *206 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30131,15 +30187,15 @@ paths: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *16 - required: *17 + properties: *17 + required: *18 additionalProperties: true examples: default: value: *206 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30194,7 +30250,7 @@ paths: value: *207 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30267,7 +30323,7 @@ paths: value: *207 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30341,7 +30397,7 @@ paths: value: *207 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30415,7 +30471,7 @@ paths: value: *207 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30462,15 +30518,15 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: value: *120 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30535,15 +30591,15 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: value: *120 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30609,15 +30665,15 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: value: *120 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30683,15 +30739,15 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: value: *120 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31108,8 +31164,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *16 - required: *17 + properties: *17 + required: *18 additionalProperties: true pull_requests: items: @@ -31185,8 +31241,8 @@ paths: They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *16 - required: *17 + properties: *17 + required: *18 additionalProperties: true required: - id @@ -31815,7 +31871,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -32012,15 +32068,15 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *16 - required: *17 + properties: *17 + required: *18 additionalProperties: true repository: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 created_at: type: string format: date-time @@ -32437,8 +32493,8 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 examples: default: value: @@ -32678,7 +32734,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -32844,7 +32900,7 @@ paths: The response includes a `most_recent_instance` object. This provides details of the most recent instance of this alert - for the the default branch or for the specified Git reference + for the default branch or for the specified Git reference (if you used `ref` in the request). tags: - code-scanning @@ -32889,7 +32945,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply @@ -32898,7 +32954,9 @@ paths: required: false schema: &229 type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. - name: state description: Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state. @@ -32909,6 +32967,7 @@ paths: description: State of a code scanning alert. enum: &220 - open + - closed - dismissed - fixed responses: @@ -32960,8 +33019,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true dismissed_at: type: string @@ -33029,8 +33088,9 @@ paths: properties: &224 ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. analysis_key: type: string description: Identifies the configuration under which the @@ -33194,10 +33254,10 @@ paths: title: Basic Error description: Basic Error type: object - properties: *26 + properties: *27 '404': description: Resource Not Found - content: *22 + content: *23 '503': description: Service Unavailable content: *221 @@ -33289,8 +33349,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true dismissed_at: type: string @@ -33435,7 +33495,7 @@ paths: content: *225 '404': description: Resource Not Found - content: *22 + content: *23 '503': description: Service Unavailable content: *221 @@ -33585,10 +33645,10 @@ paths: title: Basic Error description: Basic Error type: object - properties: *26 + properties: *27 '404': description: Resource Not Found - content: *22 + content: *23 '503': description: Service Unavailable content: *221 @@ -33633,7 +33693,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: ref description: The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply @@ -33691,7 +33751,7 @@ paths: content: *225 '404': description: Resource Not Found - content: *22 + content: *23 '503': description: Service Unavailable content: *221 @@ -33758,7 +33818,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: ref in: query description: The Git reference for the analyses you want to list. The `ref` @@ -33767,7 +33827,9 @@ paths: required: false schema: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. @@ -33789,8 +33851,9 @@ paths: properties: &232 ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. commit_sha: description: The SHA of the commit to which the analysis you are uploading relates. @@ -33897,7 +33960,7 @@ paths: content: *225 '404': description: Resource Not Found - content: *22 + content: *23 '503': description: Service Unavailable content: *221 @@ -33989,7 +34052,7 @@ paths: content: *225 '404': description: Resource Not Found - content: *22 + content: *23 '503': description: Service Unavailable content: *221 @@ -34004,6 +34067,10 @@ paths: description: |- Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. + There are two places where you can upload code scanning results. + - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)." + - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." + You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example: ``` @@ -34045,8 +34112,9 @@ paths: pattern: "^[0-9a-fA-F]+$" ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. sarif: description: A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) @@ -34110,7 +34178,7 @@ paths: content: *234 '404': description: Resource Not Found - content: *22 + content: *23 '413': description: Response if the sarif field is too large '503': @@ -34234,7 +34302,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -34377,7 +34445,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34409,7 +34477,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Response if user is a collaborator @@ -34453,7 +34521,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 requestBody: content: application/json: @@ -34500,16 +34568,16 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 invitee: nullable: true allOf: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true inviter: nullable: true @@ -34517,8 +34585,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true permissions: description: The permission associated with the invitation. @@ -34672,10 +34740,10 @@ paths: description: Response when person is already a collaborator '422': description: Validation Failed - content: *28 + content: *29 '403': description: Forbidden - content: *33 + content: *34 x-github: triggersNotification: true githubCloudOnly: false @@ -34704,7 +34772,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response @@ -34737,7 +34805,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '200': description: Response if user has admin permissions @@ -34774,7 +34842,7 @@ paths: site_admin: false '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34806,7 +34874,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -34852,8 +34920,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true created_at: type: string @@ -34866,12 +34934,12 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *62 + enum: *63 reactions: title: Reaction Rollup type: object - properties: *80 - required: *81 + properties: *81 + required: *82 required: &238 - url - html_url @@ -34964,7 +35032,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 responses: '200': description: response @@ -35012,7 +35080,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35051,7 +35119,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 requestBody: content: application/json: @@ -35112,7 +35180,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35141,13 +35209,13 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 responses: '204': description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35177,7 +35245,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 - name: content description: Returns a single [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment. @@ -35197,7 +35265,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -35226,10 +35294,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35270,7 +35338,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 requestBody: content: application/json: @@ -35325,10 +35393,10 @@ paths: value: *142 '415': description: Preview Header Missing - content: *27 + content: *28 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35371,7 +35439,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 - name: reaction_id in: path required: true @@ -35467,7 +35535,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: until description: 'Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -35478,11 +35546,25 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -35578,7 +35660,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *26 + properties: *27 '400': description: Bad Request content: &267 @@ -35587,7 +35669,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *26 + properties: *27 application/scim+json: schema: title: Scim Error @@ -35614,7 +35696,7 @@ paths: type: string '404': description: Resource Not Found - content: *22 + content: *23 '409': description: Conflict content: *241 @@ -35693,10 +35775,10 @@ paths: protected: false '415': description: Preview Header Missing - content: *27 + content: *28 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35739,7 +35821,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -35855,10 +35937,10 @@ paths: type: string '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *28 + content: *29 x-github: triggersNotification: true githubCloudOnly: false @@ -35900,7 +35982,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -35980,8 +36062,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true body: type: string @@ -36012,8 +36094,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *78 - required: *79 + properties: *79 + required: *80 active_lock_reason: type: string example: too heated @@ -36046,8 +36128,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true assignees: type: array @@ -36055,8 +36137,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true nullable: true requested_reviewers: @@ -36065,8 +36147,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true nullable: true requested_teams: @@ -36091,8 +36173,8 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 sha: type: string user: @@ -36101,8 +36183,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true required: - label @@ -36121,8 +36203,8 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 sha: type: string user: @@ -36131,8 +36213,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true required: - label @@ -36208,7 +36290,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *62 + enum: *63 auto_merge: title: Auto merge description: The status of auto merging a pull request. @@ -36218,8 +36300,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true merge_method: type: string @@ -36759,7 +36841,7 @@ paths: schema: *6 '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36828,8 +36910,16 @@ paths: in: path required: true schema: *151 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *44 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -36932,10 +37022,10 @@ paths: ..... '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 '500': description: Internal Error content: *247 @@ -36968,7 +37058,7 @@ paths: required: true schema: *151 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -36999,11 +37089,16 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -37062,7 +37157,7 @@ paths: required: true schema: *151 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -37083,7 +37178,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -37323,12 +37418,20 @@ paths: required: true schema: *151 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - name: per_page + description: Results per page (max 100). + in: query + schema: *44 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 responses: '200': description: response @@ -37396,8 +37499,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 commit_url: type: string format: uri @@ -37510,7 +37613,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37540,7 +37643,7 @@ paths: required: true schema: *151 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -37549,7 +37652,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -37565,7 +37668,7 @@ paths: title: Status description: The status of a commit. type: object - properties: &355 + properties: &356 url: type: string avatar_url: @@ -37591,10 +37694,10 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true - required: &356 + required: &357 - url - avatar_url - id @@ -38086,7 +38189,7 @@ paths: content: *247 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38142,7 +38245,7 @@ paths: required: true schema: *151 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -38624,10 +38727,10 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 '302': description: Found x-github: @@ -38655,7 +38758,7 @@ paths: required: true schema: *151 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -38944,10 +39047,10 @@ paths: payload: '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed - content: *28 + content: *29 '409': description: Conflict content: *241 @@ -38983,7 +39086,7 @@ paths: required: true schema: *151 - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -39077,10 +39180,10 @@ paths: payload: '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 '409': description: Conflict content: *241 @@ -39124,7 +39227,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -39226,10 +39329,10 @@ paths: description: Response if repository is empty '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39284,10 +39387,11 @@ paths: schema: type: string default: none + nullable: true - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -39599,7 +39703,7 @@ paths: message: 'Conflict: Commit status checks failed for topic-branch.' '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39691,7 +39795,7 @@ paths: production_environment: true '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39743,7 +39847,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed content: *121 @@ -39780,7 +39884,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -39825,8 +39929,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true description: description: A short description of the status. @@ -39884,8 +39988,8 @@ paths: granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *16 - required: *17 + properties: *17 + required: *18 additionalProperties: true required: &258 - id @@ -39941,7 +40045,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40130,7 +40234,7 @@ paths: type: string '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40200,10 +40304,10 @@ paths: value: *259 '404': description: Resource Not Found - content: *22 + content: *23 '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40356,8 +40460,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true - title: Team Simple description: Groups of organization members @@ -40681,7 +40785,7 @@ paths: title: Basic Error description: Basic Error type: object - properties: *26 + properties: *27 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40743,7 +40847,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -40759,8 +40863,8 @@ paths: title: Event description: Event type: object - properties: *85 - required: *86 + properties: *86 + required: *87 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40796,15 +40900,30 @@ paths: - newest - oldest - stargazers + - watchers default: newest - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query schema: *5 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -40816,8 +40935,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 examples: default: value: @@ -40964,11 +41083,26 @@ paths: in: path required: true schema: *151 + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -40983,8 +41117,8 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 examples: default: value: *268 @@ -40993,13 +41127,13 @@ paths: content: *267 '422': description: Validation Failed - content: *28 + content: *29 '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41073,16 +41207,16 @@ paths: type: string '404': description: Resource Not Found - content: *22 + content: *23 '409': description: Conflict content: *241 '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41160,13 +41294,13 @@ paths: node_id: Q29udGVudCBvZiB0aGUgYmxvYg== '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed - content: *28 + content: *29 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41480,10 +41614,10 @@ paths: type: string '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41586,7 +41720,7 @@ paths: payload: '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41620,7 +41754,7 @@ paths: required: true schema: *151 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -41629,7 +41763,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -41727,7 +41861,7 @@ paths: required: true schema: *151 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -41756,7 +41890,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41828,7 +41962,7 @@ paths: type: string '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41855,7 +41989,7 @@ paths: required: true schema: *151 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -41897,7 +42031,7 @@ paths: value: *273 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41923,7 +42057,7 @@ paths: required: true schema: *151 - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -41934,7 +42068,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42141,7 +42275,7 @@ paths: type: string '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42216,7 +42350,7 @@ paths: value: *278 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42402,13 +42536,13 @@ paths: type: string '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42442,6 +42576,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -42503,10 +42638,10 @@ paths: truncated: false '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42535,7 +42670,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -42703,7 +42838,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42845,13 +42980,13 @@ paths: type: string '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed - content: *28 + content: *29 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42898,7 +43033,7 @@ paths: value: *283 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43020,10 +43155,10 @@ paths: value: *283 '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43057,7 +43192,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43099,10 +43234,10 @@ paths: title: Webhook Configuration description: Configuration object of the webhook type: object - properties: *18 + properties: *19 examples: default: - value: *19 + value: *20 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43179,10 +43314,10 @@ paths: title: Webhook Configuration description: Configuration object of the webhook type: object - properties: *18 + properties: *19 examples: default: - value: *19 + value: *20 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43218,7 +43353,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43256,7 +43391,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43294,8 +43429,8 @@ paths: title: Installation description: Installation type: object - properties: *20 - required: *21 + properties: *21 + required: *22 examples: default: value: *284 @@ -43303,7 +43438,7 @@ paths: description: Moved Permanently '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -43333,7 +43468,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -43354,7 +43489,7 @@ paths: required: *286 examples: default: - value: &392 + value: &397 - id: 1 repository: id: 1296269 @@ -43753,7 +43888,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *113 + schema: *114 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -43770,18 +43905,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *114 + schema: *7 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -43935,10 +44070,10 @@ paths: description: Moved Permanently '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44207,16 +44342,16 @@ paths: type: string '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *28 + content: *29 '503': description: Service Unavailable content: *221 '404': description: Resource Not Found - content: *22 + content: *23 '410': description: Gone content: *124 @@ -44251,7 +44386,7 @@ paths: (when it was last pushed to). in: query required: false - schema: &327 + schema: &334 type: string enum: - created @@ -44272,11 +44407,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -44333,10 +44468,10 @@ paths: schema: *6 '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44376,7 +44511,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 responses: '200': description: response @@ -44422,7 +44557,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44461,7 +44596,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 requestBody: content: application/json: @@ -44492,7 +44627,7 @@ paths: value: *292 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44521,7 +44656,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 responses: '204': description: Empty response @@ -44554,7 +44689,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 - name: content description: Returns a single [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment. @@ -44574,7 +44709,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -44603,10 +44738,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44647,7 +44782,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 requestBody: content: application/json: @@ -44702,10 +44837,10 @@ paths: value: *142 '415': description: Preview Header Missing - content: *27 + content: *28 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44748,7 +44883,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 - name: reaction_id in: path required: true @@ -44794,7 +44929,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -44827,8 +44962,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true event: type: string @@ -44871,8 +45006,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true assigner: nullable: true @@ -44880,8 +45015,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true review_requester: nullable: true @@ -44889,8 +45024,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true requested_reviewer: nullable: true @@ -44898,8 +45033,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true requested_team: title: Team @@ -44977,7 +45112,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *62 + enum: *63 lock_reason: type: string nullable: true @@ -45151,7 +45286,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45358,13 +45493,13 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *22 + content: *23 '410': description: Gone content: *124 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45435,7 +45570,7 @@ paths: description: Moved Permanently '404': description: Resource Not Found - content: *22 + content: *23 '410': description: Gone content: *124 @@ -45573,18 +45708,18 @@ paths: value: *295 '422': description: Validation Failed - content: *28 + content: *29 '503': description: Service Unavailable content: *221 '403': description: Forbidden - content: *33 + content: *34 '301': description: Moved Permanently '404': description: Resource Not Found - content: *22 + content: *23 '410': description: Gone content: *124 @@ -45906,11 +46041,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -45939,7 +46074,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 '410': description: Gone content: *124 @@ -46021,16 +46156,16 @@ paths: type: string '403': description: Forbidden - content: *33 + content: *34 '410': description: Gone content: *124 '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 x-github: triggersNotification: true githubCloudOnly: false @@ -46065,7 +46200,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -46092,8 +46227,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true event: type: string @@ -46125,7 +46260,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *62 + enum: *63 body: type: string example: '":+1:"' @@ -46228,7 +46363,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -46343,7 +46478,7 @@ paths: content: *124 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46414,7 +46549,7 @@ paths: content: *124 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46513,7 +46648,7 @@ paths: default: true '404': description: Resource Not Found - content: *22 + content: *23 '410': description: Gone content: *124 @@ -46572,16 +46707,16 @@ paths: description: Empty response '403': description: Forbidden - content: *33 + content: *34 '410': description: Gone content: *124 '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46616,10 +46751,10 @@ paths: description: Empty response '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46669,7 +46804,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -46698,13 +46833,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 '410': description: Gone content: *124 '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46786,10 +46921,10 @@ paths: value: *142 '415': description: Preview Header Missing - content: *27 + content: *28 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -46883,7 +47018,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -46910,13 +47045,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 '410': description: Gone content: *124 '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46961,7 +47096,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -47094,7 +47229,7 @@ paths: type: string '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47142,7 +47277,7 @@ paths: value: *306 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47204,7 +47339,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -47233,7 +47368,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47313,10 +47448,10 @@ paths: type: string '422': description: Validation Failed - content: *28 + content: *29 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47364,7 +47499,7 @@ paths: value: *308 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47605,8 +47740,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *82 - required: *83 + properties: *83 + required: *84 required: - _links - git_url @@ -47772,10 +47907,10 @@ paths: message: Merge Conflict '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47835,7 +47970,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -47851,8 +47986,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *78 - required: *79 + properties: *79 + required: *80 examples: default: value: @@ -47897,7 +48032,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47961,8 +48096,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *78 - required: *79 + properties: *79 + required: *80 examples: default: value: &310 @@ -48007,10 +48142,10 @@ paths: type: string '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48051,14 +48186,14 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *78 - required: *79 + properties: *79 + required: *80 examples: default: value: *310 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48125,8 +48260,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *78 - required: *79 + properties: *79 + required: *80 examples: default: value: *310 @@ -48164,7 +48299,7 @@ paths: description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48198,7 +48333,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -48267,7 +48402,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -48278,7 +48413,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -48294,8 +48429,8 @@ paths: title: Thread description: Thread type: object - properties: *87 - required: *88 + properties: *88 + required: *89 examples: default: value: *315 @@ -48454,7 +48589,7 @@ paths: public: true '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48530,10 +48665,10 @@ paths: value: *318 '422': description: Validation Failed - content: *28 + content: *29 '415': description: Preview Header Missing - content: *27 + content: *28 '409': description: Conflict content: *241 @@ -48632,7 +48767,7 @@ paths: description: Empty response '422': description: Validation Failed - content: *28 + content: *29 '400': description: Bad Request content: *267 @@ -48665,13 +48800,13 @@ paths: description: Empty response '422': description: Validation Failed - content: *28 + content: *29 '415': description: Preview Header Missing - content: *27 + content: *28 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48707,7 +48842,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -48743,8 +48878,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true commit: type: string @@ -49005,7 +49140,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -49065,13 +49200,13 @@ paths: schema: *6 '401': description: Requires Authentication - content: *69 + content: *70 '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 '410': description: Gone content: *124 @@ -49145,13 +49280,13 @@ paths: value: *162 '401': description: Requires Authentication - content: *69 + content: *70 '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 '410': description: Gone content: *124 @@ -49246,7 +49381,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -49276,7 +49411,7 @@ paths: description: Not Modified '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49363,7 +49498,7 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: &331 + properties: &330 url: type: string format: uri @@ -49434,8 +49569,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true body: type: string @@ -49467,8 +49602,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *78 - required: *79 + properties: *79 + required: *80 active_lock_reason: type: string example: too heated @@ -49501,8 +49636,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true assignees: type: array @@ -49510,8 +49645,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true nullable: true requested_reviewers: @@ -49520,8 +49655,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true nullable: true requested_teams: @@ -50229,8 +50364,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *82 - required: *83 + properties: *83 + required: *84 pushed_at: type: string format: date-time @@ -50471,7 +50606,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *62 + enum: *63 auto_merge: title: Auto merge description: The status of auto merging a pull request. @@ -50502,8 +50637,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true comments: type: integer @@ -50528,7 +50663,7 @@ paths: changed_files: type: integer example: 5 - required: &332 + required: &331 - _links - assignee - labels @@ -50573,7 +50708,7 @@ paths: - review_comments examples: default: - value: &333 + value: &332 url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 node_id: MDExOlB1bGxSZXF1ZXN0MQ== @@ -51069,10 +51204,10 @@ paths: type: string '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *28 + content: *29 x-github: triggersNotification: true githubCloudOnly: false @@ -51101,11 +51236,14 @@ paths: required: true schema: *151 - name: sort - description: One of `created` (when the repository was starred) or `updated` - (when it was last pushed to). in: query required: false - schema: *327 + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -51121,11 +51259,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -51142,7 +51280,7 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: &328 + properties: &327 url: description: URL for the pull request review comment example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 @@ -51197,8 +51335,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true body: description: The text of the comment. @@ -51229,7 +51367,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *62 + enum: *63 _links: type: object properties: @@ -51304,15 +51442,15 @@ paths: reactions: title: Reaction Rollup type: object - properties: *80 - required: *81 + properties: *81 + required: *82 body_html: type: string example: '"

comment body

"' body_text: type: string example: '"comment body"' - required: &329 + required: &328 - url - id - node_id @@ -51448,7 +51586,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 responses: '200': description: response @@ -51459,11 +51597,11 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *328 - required: *329 + properties: *327 + required: *328 examples: default: - value: &330 + value: &329 url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 id: 10 @@ -51515,7 +51653,7 @@ paths: side: RIGHT '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51575,7 +51713,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 requestBody: content: application/json: @@ -51599,11 +51737,11 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *328 - required: *329 + properties: *327 + required: *328 examples: default: - value: *330 + value: *329 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51653,13 +51791,13 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 responses: '204': description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51689,7 +51827,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 - name: content description: Returns a single [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment. @@ -51709,7 +51847,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -51738,10 +51876,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51782,7 +51920,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 requestBody: content: application/json: @@ -51837,10 +51975,10 @@ paths: value: *142 '415': description: Preview Header Missing - content: *27 + content: *28 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51883,7 +52021,7 @@ paths: description: comment_id parameter in: path required: true - schema: *77 + schema: *78 - name: reaction_id in: path required: true @@ -51944,7 +52082,7 @@ paths: - name: pull_number in: path required: true - schema: &334 + schema: &333 type: integer responses: '200': @@ -51959,11 +52097,11 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: *331 - required: *332 + properties: *330 + required: *331 examples: default: - value: *333 + value: *332 '304': description: Not Modified '500': @@ -51971,7 +52109,7 @@ paths: content: *247 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52002,7 +52140,7 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 requestBody: content: application/json: @@ -52048,17 +52186,17 @@ paths: pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. - properties: *331 - required: *332 + properties: *330 + required: *331 examples: default: - value: *333 + value: *332 '422': description: Validation Failed - content: *28 + content: *29 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52088,13 +52226,13 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 - name: sort description: One of `created` (when the repository was starred) or `updated` (when it was last pushed to). in: query required: false - schema: *327 + schema: *334 - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -52110,11 +52248,11 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -52131,8 +52269,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *328 - required: *329 + properties: *327 + required: *328 examples: default: value: *335 @@ -52207,7 +52345,7 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 requestBody: content: application/json: @@ -52306,8 +52444,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *328 - required: *329 + properties: *327 + required: *328 examples: example-for-a-multi-line-comment: value: @@ -52367,10 +52505,10 @@ paths: type: string '422': description: Validation Failed - content: *28 + content: *29 '403': description: Forbidden - content: *33 + content: *34 x-github: triggersNotification: true githubCloudOnly: false @@ -52424,12 +52562,12 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 - name: comment_id description: comment_id parameter in: path required: true - schema: *77 + schema: *78 requestBody: content: application/json: @@ -52453,8 +52591,8 @@ paths: description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object - properties: *328 - required: *329 + properties: *327 + required: *328 examples: default: value: @@ -52514,7 +52652,7 @@ paths: type: string '404': description: Resource Not Found - content: *22 + content: *23 x-github: triggersNotification: true githubCloudOnly: false @@ -52547,11 +52685,11 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -52606,11 +52744,11 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -52649,7 +52787,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *28 + content: *29 '500': description: Internal Error content: *247 @@ -52681,7 +52819,7 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 responses: '204': description: Response if pull request has been merged @@ -52718,7 +52856,7 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 requestBody: content: application/json: @@ -52802,13 +52940,13 @@ paths: message: Head branch was modified. Review and try the merge again. '422': description: Validation Failed - content: *28 + content: *29 '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 x-github: triggersNotification: true githubCloudOnly: false @@ -52838,11 +52976,11 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -52863,8 +53001,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true teams: type: array @@ -52949,7 +53087,7 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 requestBody: content: application/json: @@ -53504,7 +53642,7 @@ paths: description: Response if user is not a collaborator '403': description: Forbidden - content: *33 + content: *34 x-github: triggersNotification: true githubCloudOnly: false @@ -53533,7 +53671,7 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 requestBody: content: application/json: @@ -53564,7 +53702,7 @@ paths: description: response '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53593,11 +53731,11 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -53627,8 +53765,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true body: description: The text of the review. @@ -53681,7 +53819,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *62 + enum: *63 required: &340 - id - node_id @@ -53768,7 +53906,7 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 requestBody: content: application/json: @@ -53894,7 +54032,7 @@ paths: content: *121 '403': description: Forbidden - content: *33 + content: *34 x-github: triggersNotification: true githubCloudOnly: false @@ -53924,7 +54062,7 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 - name: review_id description: review_id parameter in: path @@ -53980,7 +54118,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54008,7 +54146,7 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 - name: review_id description: review_id parameter in: path @@ -54106,7 +54244,7 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 - name: review_id description: review_id parameter in: path @@ -54131,7 +54269,7 @@ paths: content: *121 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54160,7 +54298,7 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 - name: review_id description: review_id parameter in: path @@ -54169,7 +54307,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -54228,8 +54366,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true body: type: string @@ -54255,7 +54393,7 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *62 + enum: *63 _links: type: object properties: @@ -54395,7 +54533,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54426,7 +54564,7 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 - name: review_id description: review_id parameter in: path @@ -54495,7 +54633,7 @@ paths: author_association: COLLABORATOR '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed content: *121 @@ -54527,7 +54665,7 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 - name: review_id description: review_id parameter in: path @@ -54572,13 +54710,13 @@ paths: value: *343 '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed content: *121 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54608,7 +54746,7 @@ paths: - name: pull_number in: path required: true - schema: *334 + schema: *333 requestBody: content: application/json: @@ -54644,13 +54782,13 @@ paths: url: https://github.com/repos/octocat/Hello-World/pulls/53 '422': description: Validation Failed - content: *28 + content: *29 '403': description: Forbidden - content: *33 + content: *34 '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54706,7 +54844,7 @@ paths: required: *345 examples: default: - value: + value: &346 type: file encoding: base64 size: 5362 @@ -54724,10 +54862,72 @@ paths: html: https://github.com/octokit/octokit.rb/blob/master/README.md '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed - content: *28 + content: *29 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository-readme + parameters: + - name: owner + in: path + required: true + schema: *150 + - name: repo + in: path + required: true + schema: *151 + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + title: Content File + description: Content File + type: object + properties: *344 + required: *345 + examples: + default: + value: *346 + '404': + description: Resource Not Found + content: *23 + '422': + description: Validation Failed + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54759,7 +54959,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -54775,7 +54975,7 @@ paths: title: Release description: A release. type: object - properties: &346 + properties: &347 url: type: string format: uri @@ -54835,8 +55035,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true assets: type: array @@ -54844,7 +55044,7 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: &348 + properties: &349 url: type: string format: uri @@ -54886,10 +55086,10 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true - required: &349 + required: &350 - id - name - content_type @@ -54907,7 +55107,7 @@ paths: type: string body_text: type: string - required: &347 + required: &348 - assets_url - upload_url - tarball_url @@ -55002,7 +55202,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55079,11 +55279,11 @@ paths: title: Release description: A release. type: object - properties: *346 - required: *347 + properties: *347 + required: *348 examples: default: - value: &352 + value: &353 url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 assets_url: https://api.github.com/repos/octocat/Hello-World/releases/1/assets @@ -55158,7 +55358,7 @@ paths: type: string '422': description: Validation Failed - content: *28 + content: *29 x-github: triggersNotification: true githubCloudOnly: false @@ -55192,7 +55392,7 @@ paths: description: asset_id parameter in: path required: true - schema: &350 + schema: &351 type: integer responses: '200': @@ -55207,11 +55407,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *348 - required: *349 + properties: *349 + required: *350 examples: default: - value: &351 + value: &352 url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip id: 1 @@ -55245,10 +55445,10 @@ paths: site_admin: false '404': description: Resource Not Found - content: *22 + content: *23 '415': description: Preview Header Missing - content: *27 + content: *28 '302': description: Found x-github: @@ -55279,7 +55479,7 @@ paths: description: asset_id parameter in: path required: true - schema: *350 + schema: *351 requestBody: content: application/json: @@ -55308,11 +55508,11 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *348 - required: *349 + properties: *349 + required: *350 examples: default: - value: *351 + value: *352 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55341,7 +55541,7 @@ paths: description: asset_id parameter in: path required: true - schema: *350 + schema: *351 responses: '204': description: Empty response @@ -55382,11 +55582,11 @@ paths: title: Release description: A release. type: object - properties: *346 - required: *347 + properties: *347 + required: *348 examples: default: - value: *352 + value: *353 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55413,7 +55613,7 @@ paths: required: true schema: *151 - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -55428,14 +55628,14 @@ paths: title: Release description: A release. type: object - properties: *346 - required: *347 + properties: *347 + required: *348 examples: default: - value: *352 + value: *353 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55466,7 +55666,7 @@ paths: description: release_id parameter in: path required: true - schema: &353 + schema: &354 type: integer responses: '200': @@ -55478,14 +55678,14 @@ paths: title: Release description: A release. type: object - properties: *346 - required: *347 + properties: *347 + required: *348 examples: default: - value: *352 + value: *353 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55514,7 +55714,7 @@ paths: description: release_id parameter in: path required: true - schema: *353 + schema: *354 requestBody: content: application/json: @@ -55560,11 +55760,11 @@ paths: title: Release description: A release. type: object - properties: *346 - required: *347 + properties: *347 + required: *348 examples: default: - value: *352 + value: *353 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55593,7 +55793,7 @@ paths: description: release_id parameter in: path required: true - schema: *353 + schema: *354 responses: '204': description: Empty response @@ -55626,11 +55826,11 @@ paths: description: release_id parameter in: path required: true - schema: *353 + schema: *354 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -55646,8 +55846,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *348 - required: *349 + properties: *349 + required: *350 examples: default: value: @@ -55743,7 +55943,7 @@ paths: description: release_id parameter in: path required: true - schema: *353 + schema: *354 - name: name in: query schema: @@ -55767,8 +55967,8 @@ paths: title: Release Asset description: Data related to a release. type: object - properties: *348 - required: *349 + properties: *349 + required: *350 examples: response-for-successful-upload: value: @@ -55834,7 +56034,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -55850,8 +56050,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default-response: @@ -55892,8 +56092,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true required: - starred_at @@ -55929,7 +56129,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55968,7 +56168,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: &354 + items: &355 type: integer examples: default: @@ -56103,8 +56303,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true total: type: integer @@ -56318,7 +56518,7 @@ paths: - 3 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56364,7 +56564,7 @@ paths: title: Code Frequency Stat description: Code Frequency Stat type: array - items: *354 + items: *355 examples: default: value: @@ -56458,8 +56658,8 @@ paths: title: Status description: The status of a commit. type: object - properties: *355 - required: *356 + properties: *356 + required: *357 examples: default: value: @@ -56525,7 +56725,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -56541,8 +56741,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: @@ -56587,7 +56787,7 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: &357 + properties: &358 subscribed: description: Determines if notifications should be received from this repository. @@ -56612,7 +56812,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/example - required: &358 + required: &359 - created_at - ignored - reason @@ -56632,7 +56832,7 @@ paths: description: Response if you don't subscribe to the repository '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56685,8 +56885,8 @@ paths: description: Repository invitations let you manage who you collaborate with. type: object - properties: *357 - required: *358 + properties: *358 + required: *359 examples: default: value: @@ -56753,7 +56953,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -56885,7 +57085,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -56937,6 +57137,14 @@ paths: in: path required: true schema: *151 + - name: page + description: Page number of the results to fetch. + in: query + schema: *5 + - name: per_page + description: Results per page (max 100). + in: query + schema: *44 responses: '200': description: response @@ -56946,16 +57154,16 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: &359 + properties: &360 names: type: array items: type: string - required: &360 + required: &361 - names examples: default: - value: &361 + value: &362 names: - octocat - atom @@ -56963,10 +57171,10 @@ paths: - api '415': description: Preview Header Missing - content: *27 + content: *28 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57029,17 +57237,17 @@ paths: title: Topic description: A topic aggregates entities that are related to a subject. type: object - properties: *359 - required: *360 + properties: *360 + required: *361 examples: default: - value: *361 + value: *362 '415': description: Preview Header Missing - content: *27 + content: *28 '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed content: *121 @@ -57111,8 +57319,8 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 examples: default: value: *268 @@ -57311,8 +57519,8 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 examples: default: value: @@ -57478,8 +57686,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 examples: default: value: @@ -57556,7 +57764,7 @@ paths: type: string '422': description: Validation Failed - content: *28 + content: *29 '304': description: Not Modified x-github: @@ -57582,7 +57790,7 @@ paths: - name: repository_id in: path required: true - schema: *101 + schema: *102 - name: environment_name in: path required: true @@ -57591,7 +57799,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -57619,7 +57827,7 @@ paths: required: *181 examples: default: - value: *362 + value: *363 headers: Link: example: ; rel="next", ; @@ -57650,7 +57858,7 @@ paths: - name: repository_id in: path required: true - schema: *101 + schema: *102 - name: environment_name in: path required: true @@ -57693,7 +57901,7 @@ paths: - name: repository_id in: path required: true - schema: *101 + schema: *102 - name: environment_name in: path required: true @@ -57703,7 +57911,7 @@ paths: description: secret_name parameter in: path required: true - schema: *107 + schema: *108 responses: '200': description: response @@ -57717,7 +57925,7 @@ paths: required: *181 examples: default: - value: *363 + value: *364 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57812,7 +58020,7 @@ paths: - name: repository_id in: path required: true - schema: *101 + schema: *102 - name: environment_name in: path required: true @@ -57822,7 +58030,7 @@ paths: description: secret_name parameter in: path required: true - schema: *107 + schema: *108 requestBody: content: application/json: @@ -57868,7 +58076,7 @@ paths: - name: repository_id in: path required: true - schema: *101 + schema: *102 - name: environment_name in: path required: true @@ -57878,7 +58086,7 @@ paths: description: secret_name parameter in: path required: true - schema: *107 + schema: *108 responses: '204': description: Empty response @@ -57888,6 +58096,542 @@ paths: previews: [] category: actions subcategory: secrets + "/scim/v2/enterprises/{enterprise}/Groups": + get: + summary: List provisioned SCIM groups for an enterprise + description: "**Note:** The SCIM API endpoints for enterprise accounts are currently + in beta and are subject to change." + operationId: enterprise-admin/list-provisioned-groups-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-provisioned-scim-groups-for-an-enterprise + parameters: + - name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: *41 + - name: startIndex + description: 'Used for pagination: the index of the first result to return.' + in: query + required: false + schema: + type: integer + - name: count + description: 'Used for pagination: the number of results to return.' + in: query + required: false + schema: + type: integer + - name: filter + description: filter results + in: query + required: false + schema: + type: string + - name: excludedAttributes + description: attributes to exclude + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + items: + type: string + totalResults: + type: number + itemsPerPage: + type: number + startIndex: + type: number + Resources: + type: array + items: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + externalId: + type: string + nullable: true + displayName: + type: string + members: + type: array + items: + type: object + properties: + value: + type: string + "$ref": + type: string + display: + type: string + meta: + type: object + properties: + resourceType: + type: string + created: + type: string + lastModified: + type: string + location: + type: string + required: + - schemas + - id + required: + - schemas + - totalResults + - itemsPerPage + - startIndex + - Resources + examples: + default: + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: 2 + itemsPerPage: 2 + startIndex: 1 + Resources: + - schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc + externalId: + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + display: octocat@github.com + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + display: hubot@example.com + meta: + resourceType: Group + created: '2020-06-09T03:10:17.000+10:00' + lastModified: '2020-06-09T03:10:17.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc + - schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: 5e75bbbb-aa1a-11ea-8644-75ff655cdddd + externalId: + displayName: octo-docs-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + display: octocat@github.com + meta: + resourceType: Group + created: '2020-06-09T16:28:01.000+10:00' + lastModified: '2020-06-09T16:28:01.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Groups/5e75bbbb-aa1a-11ea-8644-75ff655cdddd + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + post: + summary: Provision a SCIM enterprise group and invite users + description: |- + **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + + Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. + operationId: enterprise-admin/provision-and-invite-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users + parameters: + - name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: *41 + requestBody: + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + description: The SCIM schema URIs. + items: + type: string + displayName: + type: string + description: The name of the SCIM group. This must match the GitHub + organization that the group maps to. + members: + type: array + items: + type: object + properties: + value: + type: string + description: The SCIM user ID for a user. + required: + - value + required: + - schemas + - displayName + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + responses: + '201': + description: response + content: + application/json: + schema: + type: object + properties: &365 + schemas: + type: array + items: + type: string + id: + type: string + externalId: + type: string + nullable: true + displayName: + type: string + members: + type: array + items: + type: object + properties: + value: + type: string + "$ref": + type: string + display: + type: string + meta: + type: object + properties: + resourceType: + type: string + created: + type: string + lastModified: + type: string + location: + type: string + required: &366 + - schemas + - id + examples: + default: + value: &367 + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc + externalId: + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + display: octocat@github.com + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + display: hubot@example.com + meta: + resourceType: Group + created: 2020-06-09T03:10:17.000+10:0 + lastModified: '2020-06-09T03:10:17.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": + get: + summary: Get SCIM provisioning information for an enterprise group + description: "**Note:** The SCIM API endpoints for enterprise accounts are currently + in beta and are subject to change." + operationId: enterprise-admin/get-provisioning-information-for-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-group + parameters: + - name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: *41 + - name: scim_group_id + description: Identifier generated by the GitHub SCIM endpoint. + in: path + required: true + schema: &368 + type: string + - name: excludedAttributes + description: Attributes to exclude. + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: *365 + required: *366 + examples: + default: + value: *367 + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + put: + summary: Set SCIM information for a provisioned enterprise group + description: |- + **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + + Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. + operationId: enterprise-admin/set-information-for-provisioned-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-group + parameters: + - name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: *41 + - name: scim_group_id + description: Identifier generated by the GitHub SCIM endpoint. + in: path + required: true + schema: *368 + requestBody: + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + description: The SCIM schema URIs. + items: + type: string + displayName: + type: string + description: The name of the SCIM group. This must match the GitHub + organization that the group maps to. + members: + type: array + items: + type: object + properties: + value: + type: string + description: The SCIM user ID for a user. + required: + - value + required: + - schemas + - displayName + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: *365 + required: *366 + examples: + default: + value: *367 + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + patch: + summary: Update an attribute for a SCIM enterprise group + description: |- + **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + + Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + operationId: enterprise-admin/update-attribute-for-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-group + parameters: + - name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: *41 + - name: scim_group_id + description: Identifier generated by the GitHub SCIM endpoint. + in: path + required: true + schema: *368 + requestBody: + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + description: The SCIM schema URIs. + items: + type: string + Operations: + type: array + description: Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). + minItems: 1 + items: + type: object + properties: + op: + type: string + enum: + - add + - Add + - remove + - Remove + - replace + - Replace + path: + type: string + value: + oneOf: + - type: string + - type: object + - type: array + required: + - op + required: + - schemas + - Operations + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: remove + path: members + value: + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + responses: + '200': + description: response + content: + application/json: + schema: + type: object + properties: *365 + required: *366 + examples: + default: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc + externalId: + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + display: octocat@github.com + meta: + resourceType: Group + created: '2020-06-09T03:10:17.000+10:00' + lastModified: '2020-06-09T03:10:17.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + delete: + summary: Delete a SCIM group from an enterprise + description: "**Note:** The SCIM API endpoints for enterprise accounts are currently + in beta and are subject to change." + operationId: enterprise-admin/delete-scim-group-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-a-scim-group-from-an-enterprise + parameters: + - name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: *41 + - name: scim_group_id + description: Identifier generated by the GitHub SCIM endpoint. + in: path + required: true + schema: *368 + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim "/search/code": get: summary: Search code @@ -57944,7 +58688,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: &364 + schema: &369 type: string enum: - desc @@ -57953,7 +58697,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -58000,8 +58744,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 score: type: integer file_size: @@ -58022,7 +58766,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: &365 + items: &370 type: object properties: object_url: @@ -58139,10 +58883,10 @@ paths: content: *221 '422': description: Validation Failed - content: *28 + content: *29 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58195,11 +58939,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *364 + schema: *369 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -58299,8 +59043,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true committer: nullable: true @@ -58324,8 +59068,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 score: type: integer node_id: @@ -58333,7 +59077,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *365 + items: *370 required: - sha - node_id @@ -58466,7 +59210,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58544,11 +59288,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *364 + schema: *369 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -58612,8 +59356,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true nullable: true user: @@ -58622,8 +59366,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true labels: type: array @@ -58653,8 +59397,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true milestone: nullable: true @@ -58662,8 +59406,8 @@ paths: - title: Milestone description: A collection of related issues and pull requests. type: object - properties: *78 - required: *79 + properties: *79 + required: *80 comments: type: integer created_at: @@ -58679,7 +59423,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *365 + items: *370 pull_request: type: object properties: @@ -58717,15 +59461,15 @@ paths: type: string example: OWNER description: How the author is associated with the repository. - enum: *62 + enum: *63 draft: type: boolean repository: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 body_html: type: string body_text: @@ -58743,8 +59487,8 @@ paths: They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object - properties: *16 - required: *17 + properties: *17 + required: *18 additionalProperties: true required: - assignee @@ -58865,12 +59609,12 @@ paths: content: *221 '422': description: Validation Failed - content: *28 + content: *29 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58927,7 +59671,7 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *364 + schema: *369 responses: '200': description: response @@ -58972,7 +59716,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *365 + items: *370 required: - id - node_id @@ -59008,13 +59752,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59075,11 +59819,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *364 + schema: *369 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -59121,8 +59865,8 @@ paths: - title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true private: type: boolean @@ -59298,8 +60042,8 @@ paths: - title: License Simple description: License Simple type: object - properties: *82 - required: *83 + properties: *83 + required: *84 permissions: type: object properties: @@ -59316,7 +60060,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *365 + items: *370 temp_clone_token: type: string allow_merge_commit: @@ -59513,7 +60257,7 @@ paths: content: *221 '422': description: Validation Failed - content: *28 + content: *29 '304': description: Not Modified x-github: @@ -59620,7 +60364,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *365 + items: *370 related: type: array nullable: true @@ -59765,7 +60509,7 @@ paths: description: Not Modified '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59827,11 +60571,11 @@ paths: is ignored unless you provide `sort`. in: query required: false - schema: *364 + schema: *369 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -59939,7 +60683,7 @@ paths: text_matches: title: Search Result Text Matches type: array - items: *365 + items: *370 blog: type: string nullable: true @@ -60002,7 +60746,7 @@ paths: content: *221 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60026,7 +60770,7 @@ paths: - name: team_id in: path required: true - schema: &366 + schema: &371 type: integer responses: '200': @@ -60045,7 +60789,7 @@ paths: value: *129 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60073,7 +60817,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 requestBody: content: application/json: @@ -60139,13 +60883,13 @@ paths: value: *129 '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed - content: *28 + content: *29 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60173,16 +60917,16 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 responses: '204': description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60209,16 +60953,16 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *114 + schema: *7 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -60239,7 +60983,7 @@ paths: required: *132 examples: default: - value: *367 + value: *372 headers: Link: example: ; rel="next", ; @@ -60282,7 +61026,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 requestBody: content: application/json: @@ -60360,7 +61104,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: discussion_number in: path required: true @@ -60415,7 +61159,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: discussion_number in: path required: true @@ -60448,7 +61192,7 @@ paths: required: *132 examples: default: - value: *368 + value: *373 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60484,7 +61228,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: discussion_number in: path required: true @@ -60518,7 +61262,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: discussion_number in: path required: true @@ -60527,11 +61271,11 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *114 + schema: *7 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -60551,7 +61295,7 @@ paths: required: *136 examples: default: - value: *369 + value: *374 headers: Link: example: ; rel="next", ; @@ -60594,7 +61338,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: discussion_number in: path required: true @@ -60663,7 +61407,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: discussion_number in: path required: true @@ -60721,7 +61465,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: discussion_number in: path required: true @@ -60756,7 +61500,7 @@ paths: required: *136 examples: default: - value: *370 + value: *375 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60792,7 +61536,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: discussion_number in: path required: true @@ -60830,7 +61574,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: discussion_number in: path required: true @@ -60858,7 +61602,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -60920,7 +61664,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: discussion_number in: path required: true @@ -61003,7 +61747,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: discussion_number in: path required: true @@ -61027,7 +61771,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -61089,7 +61833,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: discussion_number in: path required: true @@ -61168,7 +61912,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: role description: "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - @@ -61185,7 +61929,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -61201,8 +61945,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: @@ -61214,7 +61958,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61243,11 +61987,11 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Response if user is a member @@ -61286,11 +62030,11 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response @@ -61340,7 +62084,7 @@ paths: resource: TeamMember '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61372,11 +62116,11 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response @@ -61412,11 +62156,11 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: username in: path required: true - schema: *13 + schema: *14 responses: '200': description: response @@ -61431,16 +62175,16 @@ paths: examples: response-if-user-has-an-active-membership-with-team: summary: Response if user has an active membership with team - value: *371 + value: *376 response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer - value: *372 + value: *377 response-if-user-has-a-pending-membership-with-team: summary: Response if user has a pending membership with team - value: *373 + value: *378 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61474,11 +62218,11 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: username in: path required: true - schema: *13 + schema: *14 requestBody: content: application/json: @@ -61510,10 +62254,10 @@ paths: examples: response-if-users-membership-with-team-is-now-active: summary: Response if user's membership with team is now active - value: *374 + value: *379 response-if-users-membership-with-team-is-now-pending: summary: Response if user's membership with team is now pending - value: *375 + value: *380 '403': description: Response if team synchronization is set up '422': @@ -61549,7 +62293,7 @@ paths: resource: TeamMember '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61579,11 +62323,11 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response @@ -61615,11 +62359,11 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -61639,7 +62383,7 @@ paths: required: *147 examples: default: - value: *376 + value: *381 headers: Link: example: ; rel="next", ; @@ -61647,10 +62391,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61684,7 +62428,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: project_id in: path required: true @@ -61702,12 +62446,12 @@ paths: required: *147 examples: default: - value: *377 + value: *382 '404': description: Response if project is not managed by this team '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61740,7 +62484,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: project_id in: path required: true @@ -61788,13 +62532,13 @@ paths: documentation_url: https://docs.github.com/github-ae@latest/rest/reference/teams#add-or-update-team-project-permissions '404': description: Resource Not Found - content: *22 + content: *23 '415': description: Preview Header Missing - content: *27 + content: *28 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61827,7 +62571,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: project_id in: path required: true @@ -61837,13 +62581,13 @@ paths: description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 '415': description: Preview Header Missing - content: *27 + content: *28 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61870,11 +62614,11 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -61890,8 +62634,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 examples: default: value: *149 @@ -61902,7 +62646,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61931,7 +62675,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: owner in: path required: true @@ -61949,8 +62693,8 @@ paths: title: Team Repository description: A team's access to a repository. type: object - properties: *378 - required: *379 + properties: *383 + required: *384 examples: alternative-response-with-extra-repository-information: value: @@ -62216,7 +62960,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: owner in: path required: true @@ -62250,10 +62994,10 @@ paths: description: Empty response '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62279,7 +63023,7 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: owner in: path required: true @@ -62317,11 +63061,11 @@ paths: - name: team_id in: path required: true - schema: *366 + schema: *371 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -62342,7 +63086,7 @@ paths: required: *153 examples: response-if-child-teams-exist: - value: *380 + value: *385 headers: Link: example: ; rel="next", ; @@ -62350,13 +63094,13 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62390,7 +63134,7 @@ paths: - title: Private User description: Private User type: object - properties: &381 + properties: &386 login: type: string example: octocat @@ -62547,7 +63291,7 @@ paths: type: boolean ldap_dn: type: string - required: &382 + required: &387 - avatar_url - events_url - followers_url @@ -62588,7 +63332,7 @@ paths: - title: Public User description: Public User type: object - properties: &394 + properties: &399 login: type: string id: @@ -62708,7 +63452,7 @@ paths: collaborators: type: integer example: 3 - required: &395 + required: &400 - avatar_url - events_url - followers_url @@ -62827,10 +63571,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -62896,8 +63640,8 @@ paths: title: Private User description: Private User type: object - properties: *381 - required: *382 + properties: *386 + required: *387 examples: default: value: @@ -62948,16 +63692,16 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -62978,7 +63722,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -62994,8 +63738,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: @@ -63009,10 +63753,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63033,7 +63777,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -63049,8 +63793,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: @@ -63064,10 +63808,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63088,7 +63832,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Response if the person is followed by the authenticated user @@ -63101,15 +63845,15 @@ paths: title: Basic Error description: Basic Error type: object - properties: *26 + properties: *27 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63132,7 +63876,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response @@ -63140,13 +63884,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63167,7 +63911,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response @@ -63175,13 +63919,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63203,7 +63947,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -63219,7 +63963,7 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: &383 + properties: &388 id: type: integer example: 3 @@ -63313,7 +64057,7 @@ paths: raw_key: type: string nullable: true - required: &384 + required: &389 - id - primary_key_id - key_id @@ -63329,7 +64073,7 @@ paths: - subkeys examples: default: - value: &396 + value: &401 - id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -63366,13 +64110,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63411,11 +64155,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *383 - required: *384 + properties: *388 + required: *389 examples: default: - value: &385 + value: &390 id: 3 primary_key_id: 2 key_id: 3262EFF25BA0D270 @@ -63447,18 +64191,18 @@ paths: PGP PUBLIC KEY BLOCK-----"' '422': description: Validation Failed - content: *28 + content: *29 '304': description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63481,7 +64225,7 @@ paths: description: gpg_key_id parameter in: path required: true - schema: &386 + schema: &391 type: integer responses: '200': @@ -63492,22 +64236,22 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *383 - required: *384 + properties: *388 + required: *389 examples: default: - value: *385 + value: *390 '404': description: Resource Not Found - content: *22 + content: *23 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63530,24 +64274,24 @@ paths: description: gpg_key_id parameter in: path required: true - schema: *386 + schema: *391 responses: '204': description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed - content: *28 + content: *29 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63575,7 +64319,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -63600,8 +64344,8 @@ paths: title: Installation description: Installation type: object - properties: *20 - required: *21 + properties: *21 + required: *22 examples: default: value: @@ -63700,13 +64444,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 '415': description: Preview Header Missing - content: *27 + content: *28 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63735,11 +64479,11 @@ paths: description: installation_id parameter in: path required: true - schema: *23 + schema: *24 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -63766,11 +64510,11 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 examples: default: - value: *387 + value: *392 headers: Link: example: ; rel="next", ; @@ -63778,10 +64522,10 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 '304': description: Not Modified x-github: @@ -63815,22 +64559,22 @@ paths: description: installation_id parameter in: path required: true - schema: *23 + schema: *24 - name: repository_id in: path required: true - schema: *101 + schema: *102 responses: '204': description: Empty response '403': description: Forbidden - content: *33 + content: *34 '304': description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63854,22 +64598,22 @@ paths: description: installation_id parameter in: path required: true - schema: *23 + schema: *24 - name: repository_id in: path required: true - schema: *101 + schema: *102 responses: '204': description: Empty response '403': description: Forbidden - content: *33 + content: *34 '304': description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63908,6 +64652,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -63926,7 +64671,7 @@ paths: description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false - schema: *113 + schema: *114 - name: sort description: What to sort results by. Can be either `created`, `updated`, `comments`. @@ -63943,18 +64688,18 @@ paths: description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *114 + schema: *7 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -63983,7 +64728,7 @@ paths: schema: *6 '404': description: Resource Not Found - content: *22 + content: *23 '304': description: Not Modified x-github: @@ -64018,7 +64763,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -64034,7 +64779,7 @@ paths: title: Key description: Key type: object - properties: &388 + properties: &393 key_id: type: string key: @@ -64052,7 +64797,7 @@ paths: type: boolean read_only: type: boolean - required: &389 + required: &394 - key_id - key - id @@ -64089,13 +64834,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64139,11 +64884,11 @@ paths: title: Key description: Key type: object - properties: *388 - required: *389 + properties: *393 + required: *394 examples: default: - value: &390 + value: &395 key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -64154,18 +64899,18 @@ paths: read_only: false '422': description: Validation Failed - content: *28 + content: *29 '304': description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64199,22 +64944,22 @@ paths: title: Key description: Key type: object - properties: *388 - required: *389 + properties: *393 + required: *394 examples: default: - value: *390 + value: *395 '404': description: Resource Not Found - content: *22 + content: *23 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64245,13 +64990,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64283,7 +65028,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -64385,13 +65130,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64412,7 +65157,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 responses: '200': description: response @@ -64465,10 +65210,10 @@ paths: site_admin: false '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64488,7 +65233,7 @@ paths: - name: org in: path required: true - schema: *93 + schema: *94 requestBody: content: application/json: @@ -64557,13 +65302,13 @@ paths: site_admin: false '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64589,7 +65334,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -64605,11 +65350,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *44 - required: *45 + properties: *45 + required: *46 examples: default: - value: *391 + value: *396 headers: Link: example: ; rel="next", ; @@ -64619,10 +65364,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -64707,13 +65452,13 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 '415': description: Preview Header Missing - content: *27 + content: *28 '422': description: Validation Failed content: *121 @@ -64809,7 +65554,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -64820,7 +65565,7 @@ paths: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -64839,12 +65584,12 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 examples: default: summary: Default response - value: &393 + value: &398 - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World @@ -64963,15 +65708,15 @@ paths: watchers: 1 '422': description: Validation Failed - content: *28 + content: *29 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65093,8 +65838,8 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 examples: default: value: *268 @@ -65105,18 +65850,18 @@ paths: type: string '401': description: Requires Authentication - content: *69 + content: *70 '304': description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 '422': description: Validation Failed - content: *28 + content: *29 '400': description: Bad Request content: *267 @@ -65158,7 +65903,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -65179,7 +65924,7 @@ paths: required: *286 examples: default: - value: *392 + value: *397 headers: Link: example: ; rel="next", ; @@ -65189,13 +65934,13 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65223,13 +65968,13 @@ paths: description: Empty response '403': description: Forbidden - content: *33 + content: *34 '409': description: Conflict content: *241 '404': description: Resource Not Found - content: *22 + content: *23 '304': description: Not Modified x-github: @@ -65263,10 +66008,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65292,16 +66037,16 @@ paths: (when it was last pushed to). in: query required: false - schema: *327 + schema: *334 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *114 + schema: *7 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -65317,12 +66062,12 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 examples: default-response: summary: Default response - value: *393 + value: *398 application/vnd.github.v3.star+json: schema: type: array @@ -65330,7 +66075,7 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: &397 + properties: &402 starred_at: type: string format: date-time @@ -65338,15 +66083,15 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 - required: &398 + properties: *61 + required: *62 + required: &403 - starred_at - repo examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: &399 + value: &404 - starred_at: '2011-01-16T19:06:43Z' repo: id: 1296269 @@ -65474,10 +66219,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65514,15 +66259,15 @@ paths: title: Basic Error description: Basic Error type: object - properties: *26 + properties: *27 '401': description: Requires Authentication - content: *69 + content: *70 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65553,13 +66298,13 @@ paths: description: Empty response '403': description: Forbidden - content: *33 + content: *34 '404': description: Resource Not Found - content: *22 + content: *23 '401': description: Requires Authentication - content: *69 + content: *70 '304': description: Not Modified x-github: @@ -65591,15 +66336,15 @@ paths: description: Empty response '404': description: Resource Not Found - content: *22 + content: *23 '401': description: Requires Authentication - content: *69 + content: *70 '304': description: Not Modified '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65620,7 +66365,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -65636,8 +66381,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 examples: default: value: *149 @@ -65650,10 +66395,10 @@ paths: description: Not Modified '403': description: Forbidden - content: *33 + content: *34 '401': description: Requires Authentication - content: *69 + content: *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65677,7 +66422,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -65753,10 +66498,10 @@ paths: description: Not Modified '404': description: Resource Not Found - content: *22 + content: *23 '403': description: Forbidden - content: *33 + content: *34 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65786,7 +66531,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 responses: '200': description: response @@ -65798,8 +66543,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: @@ -65838,7 +66583,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '200': description: response @@ -65849,13 +66594,13 @@ paths: - title: Private User description: Private User type: object - properties: *381 - required: *382 + properties: *386 + required: *387 - title: Public User description: Public User type: object - properties: *394 - required: *395 + properties: *399 + required: *400 additionalProperties: false examples: default-response: @@ -65935,7 +66680,7 @@ paths: private_repos: 9999 '404': description: Resource Not Found - content: *22 + content: *23 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65957,11 +66702,11 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -65977,8 +66722,8 @@ paths: title: Event description: Event type: object - properties: *85 - required: *86 + properties: *86 + required: *87 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66000,15 +66745,15 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: org in: path required: true - schema: *93 + schema: *94 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -66024,8 +66769,8 @@ paths: title: Event description: Event type: object - properties: *85 - required: *86 + properties: *86 + required: *87 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66046,11 +66791,11 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -66066,8 +66811,8 @@ paths: title: Event description: Event type: object - properties: *85 - required: *86 + properties: *86 + required: *87 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66088,11 +66833,11 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -66108,8 +66853,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: @@ -66139,11 +66884,11 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -66159,8 +66904,8 @@ paths: title: Simple User description: Simple User type: object - properties: *11 - required: *12 + properties: *12 + required: *13 nullable: true examples: default: @@ -66190,7 +66935,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: target_user in: path required: true @@ -66221,18 +66966,18 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: since description: 'Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false - schema: *65 + schema: *66 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -66248,11 +66993,11 @@ paths: title: Base Gist description: Base Gist type: object - properties: *66 - required: *67 + properties: *67 + required: *68 examples: default: - value: *68 + value: *69 headers: Link: example: ; rel="next", ; @@ -66260,7 +67005,7 @@ paths: schema: *6 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66282,11 +67027,11 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -66302,11 +67047,11 @@ paths: title: GPG Key description: A unique encryption key type: object - properties: *383 - required: *384 + properties: *388 + required: *389 examples: default: - value: *396 + value: *401 headers: Link: example: ; rel="next", ; @@ -66340,7 +67085,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -66393,10 +67138,10 @@ paths: octicon: repo '404': description: Resource Not Found - content: *22 + content: *23 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66420,7 +67165,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '200': description: response @@ -66430,8 +67175,8 @@ paths: title: Installation description: Installation type: object - properties: *20 - required: *21 + properties: *21 + required: *22 examples: default: value: *284 @@ -66456,11 +67201,11 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -66517,11 +67262,11 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -66537,11 +67282,11 @@ paths: title: Organization Simple description: Organization Simple type: object - properties: *44 - required: *45 + properties: *45 + required: *46 examples: default: - value: *391 + value: *396 headers: Link: example: ; rel="next", ; @@ -66567,7 +67312,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: state description: Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`. @@ -66583,7 +67328,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -66643,10 +67388,10 @@ paths: schema: *6 '415': description: Preview Header Missing - content: *27 + content: *28 '422': description: Validation Failed - content: *28 + content: *29 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -66676,11 +67421,11 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -66696,8 +67441,8 @@ paths: title: Event description: Event type: object - properties: *85 - required: *86 + properties: *86 + required: *87 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66718,11 +67463,11 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -66738,8 +67483,8 @@ paths: title: Event description: Event type: object - properties: *85 - required: *86 + properties: *86 + required: *87 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66761,7 +67506,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: type description: Can be one of `all`, `owner`, `member`. in: query @@ -66798,7 +67543,7 @@ paths: - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -66814,8 +67559,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 examples: default: value: *149 @@ -66856,22 +67601,22 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: sort description: One of `created` (when the repository was starred) or `updated` (when it was last pushed to). in: query required: false - schema: *327 + schema: *334 - name: direction description: One of `asc` (ascending) or `desc` (descending). in: query required: false - schema: *114 + schema: *7 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -66887,12 +67632,12 @@ paths: title: Repository description: A git repository type: object - properties: *60 - required: *61 + properties: *61 + required: *62 examples: default-response: summary: Default response - value: *393 + value: *398 application/vnd.github.v3.star+json: schema: type: array @@ -66900,12 +67645,12 @@ paths: title: Starred Repository description: Starred Repository type: object - properties: *397 - required: *398 + properties: *402 + required: *403 examples: alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps - value: *399 + value: *404 headers: Link: example: ; rel="next", ; @@ -66931,11 +67676,11 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 - name: per_page description: Results per page (max 100). in: query - schema: *43 + schema: *44 - name: page description: Page number of the results to fetch. in: query @@ -66951,8 +67696,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *108 - required: *109 + properties: *109 + required: *110 examples: default: value: *149 @@ -66986,7 +67731,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response @@ -67025,7 +67770,7 @@ paths: - name: username in: path required: true - schema: *13 + schema: *14 responses: '204': description: Empty response diff --git a/descriptions/github.ae/github.ae.json b/descriptions/github.ae/github.ae.json index 75ea30fa73..b397e1993d 100644 --- a/descriptions/github.ae/github.ae.json +++ b/descriptions/github.ae/github.ae.json @@ -824,6 +824,32 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "accessed" + ], + "default": "created" + } + }, + { + "name": "since", + "description": "Only show public keys accessed after the given time.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1058,6 +1084,23 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/direction" + }, + { + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "name" + ], + "default": "created" + } } ], "responses": { @@ -6104,6 +6147,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -6259,6 +6303,9 @@ }, { "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -8290,6 +8337,12 @@ }, { "$ref": "#/components/parameters/secret_name" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" } ], "responses": { @@ -9230,6 +9283,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -10903,6 +10957,15 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "pinned", + "in": "query", + "required": false, + "description": "Pinned discussions only filter", + "schema": { + "type": "string" + } } ], "responses": { @@ -20521,7 +20584,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. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "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. GitHub Apps must have the `security_events` read permission to use\nthis 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).", "tags": [ "code-scanning" ], @@ -20972,7 +21035,7 @@ "/repos/{owner}/{repo}/code-scanning/sarifs": { "post": { "summary": "Upload an analysis as SARIF data", - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", "operationId": "code-scanning/upload-sarif", "tags": [ "code-scanning" @@ -21980,6 +22043,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "top", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "last_sha", + "description": "legacy parameter for pagination.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -22354,9 +22437,15 @@ { "$ref": "#/components/parameters/repo" }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per_page" + }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -22423,7 +22512,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -22456,6 +22545,14 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "app_id", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } } ], "responses": { @@ -22527,7 +22624,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -22624,13 +22721,19 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { "type": "string" }, "x-multi-segment": true + }, + { + "$ref": "#/components/parameters/per_page" + }, + { + "$ref": "#/components/parameters/page" } ], "responses": { @@ -22685,7 +22788,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -22830,7 +22933,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -22931,7 +23034,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -23111,7 +23214,7 @@ }, { "name": "path", - "description": "path+ parameter", + "description": "path parameter", "in": "path", "required": true, "schema": { @@ -23359,7 +23462,8 @@ "required": false, "schema": { "type": "string", - "default": "none" + "default": "none", + "nullable": true } }, { @@ -24328,7 +24432,8 @@ "enum": [ "newest", "oldest", - "stargazers" + "stargazers", + "watchers" ], "default": "newest" } @@ -24338,6 +24443,26 @@ }, { "$ref": "#/components/parameters/page" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -24395,6 +24520,26 @@ }, { "$ref": "#/components/parameters/repo" + }, + { + "name": "org", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "organization", + "description": "legacy query parameter for specifying the org.", + "in": "query", + "deprecated": true, + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { @@ -24402,6 +24547,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "organization": { "type": "string", @@ -24832,7 +24978,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -24904,7 +25050,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -25055,7 +25201,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -25141,7 +25287,7 @@ }, { "name": "ref", - "description": "ref+ parameter", + "description": "ref parameter", "in": "path", "required": true, "schema": { @@ -25515,7 +25661,8 @@ "required": true, "schema": { "type": "string" - } + }, + "x-multi-segment": true }, { "name": "recursive", @@ -31149,7 +31296,17 @@ "$ref": "#/components/parameters/repo" }, { - "$ref": "#/components/parameters/sort" + "name": "sort", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "created_at" + ] + } }, { "name": "direction", @@ -33480,6 +33637,79 @@ } } }, + "/repos/{owner}/{repo}/readme/{dir}": { + "get": { + "summary": "Get a repository README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", + "tags": [ + "repos" + ], + "operationId": "repos/get-readme-from-alt-path", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository-readme" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "dir", + "description": "The alternate path to look for a README file", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/content-file" + }, + "examples": { + "default": { + "$ref": "#/components/examples/content-file" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "contents" + } + } + }, "/repos/{owner}/{repo}/releases": { "get": { "summary": "List releases", @@ -33893,7 +34123,7 @@ }, { "name": "tag", - "description": "tag+ parameter", + "description": "tag parameter", "in": "path", "required": true, "schema": { @@ -35115,93 +35345,99 @@ }, { "$ref": "#/components/parameters/repo" - } - ], - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/topic" - }, - "examples": { - "default": { - "$ref": "#/components/examples/topic" - } - } - } - } }, - "415": { - "$ref": "#/components/responses/preview_header_missing" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" - } - ], - "category": "repos", - "subcategory": null - } - }, - "put": { - "summary": "Replace all repository topics", - "description": "", - "tags": [ - "repos" - ], - "operationId": "repos/replace-all-topics", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#replace-all-repository-topics" - }, - "parameters": [ { - "$ref": "#/components/parameters/owner" + "$ref": "#/components/parameters/page" }, { - "$ref": "#/components/parameters/repo" + "$ref": "#/components/parameters/per_page" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "names": { - "type": "array", - "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", - "items": { - "type": "string" - } - } - }, - "required": [ - "names" - ] - }, - "example": { - "names": [ - "octocat", - "atom", - "electron", - "api" - ] - } - } - } - }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/topic" + }, + "examples": { + "default": { + "$ref": "#/components/examples/topic" + } + } + } + } + }, + "415": { + "$ref": "#/components/responses/preview_header_missing" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "mercy", + "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + } + }, + "put": { + "summary": "Replace all repository topics", + "description": "", + "tags": [ + "repos" + ], + "operationId": "repos/replace-all-topics", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#replace-all-repository-topics" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "names": { + "type": "array", + "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", + "items": { + "type": "string" + } + } + }, + "required": [ + "names" + ] + }, + "example": { + "names": [ + "octocat", + "atom", + "electron", + "api" + ] + } + } + } + }, "responses": { "200": { "description": "response", @@ -35902,6 +36138,489 @@ } } }, + "/scim/v2/enterprises/{enterprise}/Groups": { + "get": { + "summary": "List provisioned SCIM groups for an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/list-provisioned-groups-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-provisioned-scim-groups-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/start_index" + }, + { + "$ref": "#/components/parameters/count" + }, + { + "name": "filter", + "description": "filter results", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "excludedAttributes", + "description": "attributes to exclude", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-group-list-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-group-list" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "post": { + "summary": "Provision a SCIM enterprise group and invite users", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nProvision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.", + "operationId": "enterprise-admin/provision-and-invite-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { + "type": "string" + } + }, + "displayName": { + "type": "string", + "description": "The name of the SCIM group. This must match the GitHub organization that the group maps to." + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The SCIM user ID for a user." + } + }, + "required": [ + "value" + ] + } + } + }, + "required": [ + "schemas", + "displayName" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-group" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + } + }, + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + "get": { + "summary": "Get SCIM provisioning information for an enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/get-provisioning-information-for-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-group" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/scim_group_id" + }, + { + "name": "excludedAttributes", + "description": "Attributes to exclude.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-group" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "put": { + "summary": "Set SCIM information for a provisioned enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nReplaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "operationId": "enterprise-admin/set-information-for-provisioned-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-group" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/scim_group_id" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { + "type": "string" + } + }, + "displayName": { + "type": "string", + "description": "The name of the SCIM group. This must match the GitHub organization that the group maps to." + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The SCIM user ID for a user." + } + }, + "required": [ + "value" + ] + } + } + }, + "required": [ + "schemas", + "displayName" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-group" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "patch": { + "summary": "Update an attribute for a SCIM enterprise group", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nAllows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "operationId": "enterprise-admin/update-attribute-for-enterprise-group", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-group" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/scim_group_id" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "description": "The SCIM schema URIs.", + "items": { + "type": "string" + } + }, + "Operations": { + "type": "array", + "description": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "op": { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ] + }, + "path": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ] + } + }, + "required": [ + "op" + ] + } + } + }, + "required": [ + "schemas", + "Operations" + ] + }, + "example": { + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:PatchOp" + ], + "Operations": [ + { + "op": "remove", + "path": "members", + "value": [ + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/scim-enterprise-group" + }, + "examples": { + "default": { + "$ref": "#/components/examples/scim-enterprise-group-2" + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + }, + "delete": { + "summary": "Delete a SCIM group from an enterprise", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "operationId": "enterprise-admin/delete-scim-group-from-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-a-scim-group-from-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/scim_group_id" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": true, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "scim" + } + } + }, "/search/code": { "get": { "summary": "Search code", @@ -39838,6 +40557,7 @@ "created", "mentioned", "subscribed", + "repos", "all" ], "default": "assigned" @@ -42754,6 +43474,20 @@ "type": "integer" } }, + "direction": { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, "key-ids": { "name": "key_ids", "in": "path", @@ -42918,20 +43652,6 @@ "type": "string" } }, - "direction": { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, "owner": { "name": "owner", "in": "path", @@ -43374,6 +44094,33 @@ "type": "integer" } }, + "start_index": { + "name": "startIndex", + "description": "Used for pagination: the index of the first result to return.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "count": { + "name": "count", + "description": "Used for pagination: the number of results to return.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + } + }, + "scim_group_id": { + "name": "scim_group_id", + "description": "Identifier generated by the GitHub SCIM endpoint.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "order": { "name": "order", "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", @@ -53187,13 +53934,14 @@ }, "code-scanning-ref": { "type": "string", - "description": "The full Git reference, formatted as `refs/heads/`." + "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`." }, "code-scanning-alert-state": { "type": "string", "description": "State of a code scanning alert.", "enum": [ "open", + "closed", "dismissed", "fixed" ] @@ -59392,6 +60140,154 @@ "names" ] }, + "scim-group-list-enterprise": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "totalResults": { + "type": "number" + }, + "itemsPerPage": { + "type": "number" + }, + "startIndex": { + "type": "number" + }, + "Resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + }, + "required": [ + "schemas", + "id" + ] + } + } + }, + "required": [ + "schemas", + "totalResults", + "itemsPerPage", + "startIndex", + "Resources" + ] + }, + "scim-enterprise-group": { + "type": "object", + "properties": { + "schemas": { + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "type": "string" + }, + "externalId": { + "type": "string", + "nullable": true + }, + "displayName": { + "type": "string" + }, + "members": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "$ref": { + "type": "string" + }, + "display": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "properties": { + "resourceType": { + "type": "string" + }, + "created": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "location": { + "type": "string" + } + } + } + }, + "required": [ + "schemas", + "id" + ] + }, "search-result-text-matches": { "title": "Search Result Text Matches", "type": "array", @@ -76096,6 +76992,116 @@ } ] }, + "scim-enterprise-group-list": { + "value": { + "schemas": [ + "urn:ietf:params:scim:api:messages:2.0:ListResponse" + ], + "totalResults": 2, + "itemsPerPage": 2, + "startIndex": 1, + "Resources": [ + { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "display": "hubot@example.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:00", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + }, + { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "5e75bbbb-aa1a-11ea-8644-75ff655cdddd", + "externalId": null, + "displayName": "octo-docs-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T16:28:01.000+10:00", + "lastModified": "2020-06-09T16:28:01.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/5e75bbbb-aa1a-11ea-8644-75ff655cdddd" + } + } + ] + } + }, + "scim-enterprise-group": { + "value": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + }, + { + "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5", + "display": "hubot@example.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:0", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + } + }, + "scim-enterprise-group-2": { + "value": { + "schemas": [ + "urn:ietf:params:scim:schemas:core:2.0:Group" + ], + "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc", + "externalId": null, + "displayName": "octo-org", + "members": [ + { + "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc", + "display": "octocat@github.com" + } + ], + "meta": { + "resourceType": "Group", + "created": "2020-06-09T03:10:17.000+10:00", + "lastModified": "2020-06-09T03:10:17.000+10:00", + "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc" + } + } + }, "code-search-result-item-paginated": { "value": { "total_count": 7, diff --git a/descriptions/github.ae/github.ae.yaml b/descriptions/github.ae/github.ae.yaml index 7a2849a80f..ab76aa5530 100644 --- a/descriptions/github.ae/github.ae.yaml +++ b/descriptions/github.ae/github.ae.yaml @@ -600,6 +600,23 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string responses: '200': description: response @@ -750,6 +767,17 @@ paths: parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created responses: '200': description: response @@ -4253,6 +4281,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -4358,6 +4387,7 @@ paths: schema: type: boolean - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -5908,6 +5938,8 @@ paths: parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/secret_name" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" responses: '200': description: response @@ -6553,6 +6585,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -7795,6 +7828,12 @@ paths: - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: pinned + in: query + required: false + description: Pinned discussions only filter + schema: + type: string responses: '200': description: response @@ -14782,7 +14821,7 @@ paths: The response includes a `most_recent_instance` object. This provides details of the most recent instance of this alert - for the the default branch or for the specified Git reference + for the default branch or for the specified Git reference (if you used `ref` in the request). tags: - code-scanning @@ -15102,6 +15141,10 @@ paths: description: |- Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. + There are two places where you can upload code scanning results. + - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests)." + - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see "[Managing code scanning alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)." + You must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example: ``` @@ -15852,6 +15895,20 @@ paths: type: string - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: top + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string + - name: last_sha + description: legacy parameter for pagination. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -16144,8 +16201,10 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -16190,7 +16249,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -16211,6 +16270,11 @@ paths: default: latest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: app_id + in: query + required: false + schema: + type: integer responses: '200': description: response @@ -16257,7 +16321,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -16325,12 +16389,14 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: type: string x-multi-segment: true + - "$ref": "#/components/parameters/per_page" + - "$ref": "#/components/parameters/page" responses: '200': description: response @@ -16366,7 +16432,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -16524,7 +16590,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -16585,7 +16651,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -16721,7 +16787,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: path - description: path+ parameter + description: path parameter in: path required: true schema: @@ -16889,6 +16955,7 @@ paths: schema: type: string default: none + nullable: true - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" responses: @@ -17678,9 +17745,24 @@ paths: - newest - oldest - stargazers + - watchers default: newest - "$ref": "#/components/parameters/per_page" - "$ref": "#/components/parameters/page" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string responses: '200': description: response @@ -17719,11 +17801,26 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - name: org + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string + - name: organization + description: legacy query parameter for specifying the org. + in: query + deprecated: true + required: false + schema: + type: string requestBody: content: application/json: schema: type: object + nullable: true properties: organization: type: string @@ -18102,7 +18199,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -18148,7 +18245,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -18247,7 +18344,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -18304,7 +18401,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref+ parameter + description: ref parameter in: path required: true schema: @@ -18633,6 +18730,7 @@ paths: required: true schema: type: string + x-multi-segment: true - name: recursive description: 'Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` @@ -22436,7 +22534,15 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/sort" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - created_at - name: direction description: Can be either `asc` or `desc`. Ignored without `sort` parameter. in: query @@ -24120,6 +24226,56 @@ paths: previews: [] category: repos subcategory: contents + "/repos/{owner}/{repo}/readme/{dir}": + get: + summary: Get a repository README + description: |- + Gets the preferred README for a repository. + + READMEs support [custom media types](https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML. + tags: + - repos + operationId: repos/get-readme-from-alt-path + externalDocs: + description: API method documentation + url: https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository-readme + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: dir + description: The alternate path to look for a README file + in: path + required: true + schema: + type: string + x-multi-segment: true + - name: ref + description: 'The name of the commit/branch/tag. Default: the repository’s + default branch (usually `master`)' + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/content-file" + examples: + default: + "$ref": "#/components/examples/content-file" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: repos + subcategory: contents "/repos/{owner}/{repo}/releases": get: summary: List releases @@ -24399,7 +24555,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: tag - description: tag+ parameter + description: tag parameter in: path required: true schema: @@ -25222,6 +25378,8 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per_page" responses: '200': description: response @@ -25859,6 +26017,316 @@ paths: previews: [] category: actions subcategory: secrets + "/scim/v2/enterprises/{enterprise}/Groups": + get: + summary: List provisioned SCIM groups for an enterprise + description: "**Note:** The SCIM API endpoints for enterprise accounts are currently + in beta and are subject to change." + operationId: enterprise-admin/list-provisioned-groups-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-provisioned-scim-groups-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/start_index" + - "$ref": "#/components/parameters/count" + - name: filter + description: filter results + in: query + required: false + schema: + type: string + - name: excludedAttributes + description: attributes to exclude + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/scim-group-list-enterprise" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-group-list" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + post: + summary: Provision a SCIM enterprise group and invite users + description: |- + **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + + Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to. + operationId: enterprise-admin/provision-and-invite-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + description: The SCIM schema URIs. + items: + type: string + displayName: + type: string + description: The name of the SCIM group. This must match the GitHub + organization that the group maps to. + members: + type: array + items: + type: object + properties: + value: + type: string + description: The SCIM user ID for a user. + required: + - value + required: + - schemas + - displayName + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + responses: + '201': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-group" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": + get: + summary: Get SCIM provisioning information for an enterprise group + description: "**Note:** The SCIM API endpoints for enterprise accounts are currently + in beta and are subject to change." + operationId: enterprise-admin/get-provisioning-information-for-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-group + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/scim_group_id" + - name: excludedAttributes + description: Attributes to exclude. + in: query + required: false + schema: + type: string + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-group" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + put: + summary: Set SCIM information for a provisioned enterprise group + description: |- + **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + + Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. + operationId: enterprise-admin/set-information-for-provisioned-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-group + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/scim_group_id" + requestBody: + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + description: The SCIM schema URIs. + items: + type: string + displayName: + type: string + description: The name of the SCIM group. This must match the GitHub + organization that the group maps to. + members: + type: array + items: + type: object + properties: + value: + type: string + description: The SCIM user ID for a user. + required: + - value + required: + - schemas + - displayName + example: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-group" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + patch: + summary: Update an attribute for a SCIM enterprise group + description: |- + **Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change. + + Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + operationId: enterprise-admin/update-attribute-for-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-group + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/scim_group_id" + requestBody: + content: + application/json: + schema: + type: object + properties: + schemas: + type: array + description: The SCIM schema URIs. + items: + type: string + Operations: + type: array + description: Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2). + minItems: 1 + items: + type: object + properties: + op: + type: string + enum: + - add + - Add + - remove + - Remove + - replace + - Replace + path: + type: string + value: + oneOf: + - type: string + - type: object + - type: array + required: + - op + required: + - schemas + - Operations + example: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: remove + path: members + value: + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + responses: + '200': + description: response + content: + application/json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-group-2" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim + delete: + summary: Delete a SCIM group from an enterprise + description: "**Note:** The SCIM API endpoints for enterprise accounts are currently + in beta and are subject to change." + operationId: enterprise-admin/delete-scim-group-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-a-scim-group-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/scim_group_id" + responses: + '204': + description: Empty response + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + previews: [] + category: enterprise-admin + subcategory: scim "/search/code": get: summary: Search code @@ -28850,6 +29318,7 @@ paths: - created - mentioned - subscribed + - repos - all default: assigned - name: state @@ -30818,6 +31287,17 @@ components: required: true schema: type: integer + direction: + name: direction + description: One of `asc` (ascending) or `desc` (descending). + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc key-ids: name: key_ids in: path @@ -30948,17 +31428,6 @@ components: required: false schema: type: string - direction: - name: direction - description: One of `asc` (ascending) or `desc` (descending). - in: query - required: false - schema: - type: string - enum: - - asc - - desc - default: desc owner: name: owner in: path @@ -31327,6 +31796,27 @@ components: required: false schema: type: integer + start_index: + name: startIndex + description: 'Used for pagination: the index of the first result to return.' + in: query + required: false + schema: + type: integer + count: + name: count + description: 'Used for pagination: the number of results to return.' + in: query + required: false + schema: + type: integer + scim_group_id: + name: scim_group_id + description: Identifier generated by the GitHub SCIM endpoint. + in: path + required: true + schema: + type: string order: name: order description: Determines whether the first search result returned is the highest @@ -38846,12 +39336,15 @@ components: if provided in the uploaded SARIF data. code-scanning-ref: type: string - description: The full Git reference, formatted as `refs/heads/`. + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. code-scanning-alert-state: type: string description: State of a code scanning alert. enum: - open + - closed - dismissed - fixed alert-number: @@ -43516,6 +44009,105 @@ components: type: string required: - names + scim-group-list-enterprise: + type: object + properties: + schemas: + type: array + items: + type: string + totalResults: + type: number + itemsPerPage: + type: number + startIndex: + type: number + Resources: + type: array + items: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + externalId: + type: string + nullable: true + displayName: + type: string + members: + type: array + items: + type: object + properties: + value: + type: string + "$ref": + type: string + display: + type: string + meta: + type: object + properties: + resourceType: + type: string + created: + type: string + lastModified: + type: string + location: + type: string + required: + - schemas + - id + required: + - schemas + - totalResults + - itemsPerPage + - startIndex + - Resources + scim-enterprise-group: + type: object + properties: + schemas: + type: array + items: + type: string + id: + type: string + externalId: + type: string + nullable: true + displayName: + type: string + members: + type: array + items: + type: object + properties: + value: + type: string + "$ref": + type: string + display: + type: string + meta: + type: object + properties: + resourceType: + type: string + created: + type: string + lastModified: + type: string + location: + type: string + required: + - schemas + - id search-result-text-matches: title: Search Result Text Matches type: array @@ -58097,6 +58689,80 @@ components: teams_url: https://api.github.com/repos/octocat/Hello-World/teams trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks + scim-enterprise-group-list: + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: 2 + itemsPerPage: 2 + startIndex: 1 + Resources: + - schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc + externalId: + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + display: octocat@github.com + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + display: hubot@example.com + meta: + resourceType: Group + created: '2020-06-09T03:10:17.000+10:00' + lastModified: '2020-06-09T03:10:17.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc + - schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: 5e75bbbb-aa1a-11ea-8644-75ff655cdddd + externalId: + displayName: octo-docs-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + display: octocat@github.com + meta: + resourceType: Group + created: '2020-06-09T16:28:01.000+10:00' + lastModified: '2020-06-09T16:28:01.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Groups/5e75bbbb-aa1a-11ea-8644-75ff655cdddd + scim-enterprise-group: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc + externalId: + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + display: octocat@github.com + - value: aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5 + display: hubot@example.com + meta: + resourceType: Group + created: 2020-06-09T03:10:17.000+10:0 + lastModified: '2020-06-09T03:10:17.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc + scim-enterprise-group-2: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc + externalId: + displayName: octo-org + members: + - value: 92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + "$ref": https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc + display: octocat@github.com + meta: + resourceType: Group + created: '2020-06-09T03:10:17.000+10:00' + lastModified: '2020-06-09T03:10:17.000+10:00' + location: https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc code-search-result-item-paginated: value: total_count: 7