diff options
author | github-openapi-bot <security+github-openapi-bot@github.com> | 2022-08-10 09:39:14 -0700 |
---|---|---|
committer | github-openapi-bot <security+github-openapi-bot@github.com> | 2022-08-10 09:39:14 -0700 |
commit | 92ecb06a586334610b5d3690db23126a952b1587 (patch) | |
tree | 833c6b42c1a5757413f0f0a758a09fccd9bdfc3e /descriptions-next/api.github.com | |
parent | 2434d3c543e83a93bee92e72a08c0e8373b49d5e (diff) | |
download | rest-api-description-92ecb06a586334610b5d3690db23126a952b1587.tar.gz rest-api-description-92ecb06a586334610b5d3690db23126a952b1587.zip |
Update OpenAPI 3.1 Descriptions
Diffstat (limited to 'descriptions-next/api.github.com')
4 files changed, 81 insertions, 77 deletions
diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index b6ea7341e..d65593b3f 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -766,7 +766,7 @@ "examples": { "default": { "value": { - "respoitory": "Hello-World", + "repository": "Hello-World", "permissions": { "issues": "write", "contents": "read" @@ -6274,10 +6274,16 @@ "$ref": "#/components/parameters/before" }, { - "$ref": "#/components/parameters/per-page" + "$ref": "#/components/parameters/page" }, { - "$ref": "#/components/parameters/page" + "name": "per_page", + "description": "The number of results per page (max 50).", + "in": "query", + "schema": { + "type": "integer", + "default": 50 + } } ], "responses": { @@ -32679,9 +32685,10 @@ }, { "name": "ref", - "description": "ref parameter", + "description": "The name of the fully qualified reference to update. For example, `refs/heads/master`. If the value doesn't start with `refs` and have at least two slashes, it will be rejected.", "in": "path", "required": true, + "example": "refs/head/master", "schema": { "type": "string" }, @@ -32984,7 +32991,7 @@ "/repos/{owner}/{repo}/git/trees": { "post": { "summary": "Create a tree", - "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)\" and \"[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference).\"", + "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)\" and \"[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", "tags": [ "git" ], @@ -39801,7 +39808,7 @@ }, "post": { "summary": "Create a pull request", - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -39827,7 +39834,7 @@ "properties": { "title": { "type": "string", - "description": "The title of the new pull request." + "description": "The title of the new pull request. Required unless `issue` is specified." }, "head": { "type": "string", @@ -39851,6 +39858,7 @@ }, "issue": { "type": "integer", + "description": "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.", "examples": [ 1 ] @@ -41299,15 +41307,15 @@ }, "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { - "summary": "List requested reviewers for a pull request", - "description": "Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", + "summary": "Get all requested reviewers for a pull request", + "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", "tags": [ "pulls" ], "operationId": "pulls/list-requested-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/pulls#list-requested-reviewers-for-a-pull-request" + "url": "https://docs.github.com/rest/reference/pulls#get-all-requested-reviewers-for-a-pull-request" }, "parameters": [ { @@ -41318,12 +41326,6 @@ }, { "$ref": "#/components/parameters/pull-number" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" } ], "responses": { @@ -112859,7 +112861,7 @@ }, "workflow-run-status": { "name": "status", - "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run).\"", + "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.", "in": "query", "required": false, "schema": { diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index bca6e2619..ac126ced1 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -517,7 +517,7 @@ paths: examples: default: value: - respoitory: Hello-World + repository: Hello-World permissions: issues: write contents: read @@ -4327,8 +4327,13 @@ paths: - "$ref": "#/components/parameters/participating" - "$ref": "#/components/parameters/since" - "$ref": "#/components/parameters/before" - - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of results per page (max 50). + in: query + schema: + type: integer + default: 50 responses: '200': description: Response @@ -23686,9 +23691,12 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - name: ref - description: ref parameter + description: The name of the fully qualified reference to update. For example, + `refs/heads/master`. If the value doesn't start with `refs` and have at + least two slashes, it will be rejected. in: path required: true + example: refs/head/master schema: type: string x-multi-segment: true @@ -23957,6 +23965,8 @@ paths: The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." + + Returns an error if you try to delete a file that does not exist. tags: - git operationId: git/create-tree @@ -28530,8 +28540,6 @@ paths: To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. - You can create a new pull request. - This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. tags: - pulls @@ -28551,7 +28559,8 @@ paths: properties: title: type: string - description: The title of the new pull request. + description: The title of the new pull request. Required unless + `issue` is specified. head: type: string description: 'The name of the branch where your changes are implemented. @@ -28577,6 +28586,10 @@ paths: in the GitHub Help documentation to learn more. issue: type: integer + description: An issue in the repository to convert to a pull request. + The issue title, body, and comments will become the title, body, + and comments on the new pull request. Required unless `title` + is specified. examples: - 1 required: @@ -29572,8 +29585,8 @@ paths: subcategory: "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": get: - summary: List requested reviewers for a pull request - description: Lists the users or teams whose review is requested for a pull request. + summary: Get all requested reviewers for a pull request + description: Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) @@ -29583,13 +29596,11 @@ paths: operationId: pulls/list-requested-reviewers externalDocs: description: API method documentation - url: https://docs.github.com/rest/reference/pulls#list-requested-reviewers-for-a-pull-request + url: https://docs.github.com/rest/reference/pulls#get-all-requested-reviewers-for-a-pull-request parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/pull-number" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" responses: '200': description: Response @@ -84995,8 +85006,6 @@ components: description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. - For a list of the possible `status` and `conclusion` options, see "[Create - a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." in: query required: false schema: diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 149fd9603..4c187a215 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -4719,7 +4719,7 @@ "examples": { "default": { "value": { - "respoitory": "Hello-World", + "repository": "Hello-World", "permissions": { "issues": "write", "contents": "read" @@ -52581,21 +52581,21 @@ } }, { - "name": "per_page", - "description": "The number of results per page (max 100).", + "name": "page", + "description": "Page number of the results to fetch.", "in": "query", "schema": { "type": "integer", - "default": 30 + "default": 1 } }, { - "name": "page", - "description": "Page number of the results to fetch.", + "name": "per_page", + "description": "The number of results per page (max 50).", "in": "query", "schema": { "type": "integer", - "default": 1 + "default": 50 } } ], @@ -166384,7 +166384,7 @@ }, { "name": "status", - "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run).\"", + "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.", "in": "query", "required": false, "schema": { @@ -187409,7 +187409,7 @@ }, { "name": "status", - "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/rest/reference/checks#create-a-check-run).\"", + "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.", "in": "query", "required": false, "schema": { @@ -299694,9 +299694,10 @@ }, { "name": "ref", - "description": "ref parameter", + "description": "The name of the fully qualified reference to update. For example, `refs/heads/master`. If the value doesn't start with `refs` and have at least two slashes, it will be rejected.", "in": "path", "required": true, + "example": "refs/head/master", "schema": { "type": "string" }, @@ -300605,7 +300606,7 @@ "/repos/{owner}/{repo}/git/trees": { "post": { "summary": "Create a tree", - "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)\" and \"[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference).\"", + "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)\" and \"[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", "tags": [ "git" ], @@ -394497,7 +394498,7 @@ }, "post": { "summary": "Create a pull request", - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "tags": [ "pulls" ], @@ -394535,7 +394536,7 @@ "properties": { "title": { "type": "string", - "description": "The title of the new pull request." + "description": "The title of the new pull request. Required unless `issue` is specified." }, "head": { "type": "string", @@ -394559,6 +394560,7 @@ }, "issue": { "type": "integer", + "description": "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.", "examples": [ 1 ] @@ -419157,15 +419159,15 @@ }, "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { "get": { - "summary": "List requested reviewers for a pull request", - "description": "Lists the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", + "summary": "Get all requested reviewers for a pull request", + "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", "tags": [ "pulls" ], "operationId": "pulls/list-requested-reviewers", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/pulls#list-requested-reviewers-for-a-pull-request" + "url": "https://docs.github.com/rest/reference/pulls#get-all-requested-reviewers-for-a-pull-request" }, "parameters": [ { @@ -419194,24 +419196,6 @@ "schema": { "type": "integer" } - }, - { - "name": "per_page", - "description": "The number of 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": { diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 402fb5965..2e879dc7d 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -1961,7 +1961,7 @@ paths: examples: default: value: - respoitory: Hello-World + repository: Hello-World permissions: issues: write contents: read @@ -13558,8 +13558,13 @@ paths: schema: type: string format: date-time - - *12 - *30 + - name: per_page + description: The number of results per page (max 50). + in: query + schema: + type: integer + default: 50 responses: '200': description: Response @@ -32532,8 +32537,6 @@ paths: description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. - For a list of the possible `status` and `conclusion` options, see "[Create - a check run](https://docs.github.com/rest/reference/checks#create-a-check-run)." in: query required: false schema: @@ -50684,9 +50687,12 @@ paths: - *203 - *204 - name: ref - description: ref parameter + description: The name of the fully qualified reference to update. For example, + `refs/heads/master`. If the value doesn't start with `refs` and have at + least two slashes, it will be rejected. in: path required: true + example: refs/head/master schema: type: string x-multi-segment: true @@ -51028,6 +51034,8 @@ paths: The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/reference/git#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/reference/git#update-a-reference)." + + Returns an error if you try to delete a file that does not exist. tags: - git operationId: git/create-tree @@ -59512,8 +59520,6 @@ paths: To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. - You can create a new pull request. - This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. tags: - pulls @@ -59533,7 +59539,8 @@ paths: properties: title: type: string - description: The title of the new pull request. + description: The title of the new pull request. Required unless + `issue` is specified. head: type: string description: 'The name of the branch where your changes are implemented. @@ -59559,6 +59566,10 @@ paths: in the GitHub Help documentation to learn more. issue: type: integer + description: An issue in the repository to convert to a pull request. + The issue title, body, and comments will become the title, body, + and comments on the new pull request. Required unless `title` + is specified. examples: - 1 required: @@ -62435,8 +62446,8 @@ paths: subcategory: "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": get: - summary: List requested reviewers for a pull request - description: Lists the users or teams whose review is requested for a pull request. + summary: Get all requested reviewers for a pull request + description: Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) @@ -62446,13 +62457,11 @@ paths: operationId: pulls/list-requested-reviewers externalDocs: description: API method documentation - url: https://docs.github.com/rest/reference/pulls#list-requested-reviewers-for-a-pull-request + url: https://docs.github.com/rest/reference/pulls#get-all-requested-reviewers-for-a-pull-request parameters: - *203 - *204 - *387 - - *12 - - *30 responses: '200': description: Response |