swgg-github-pulls
Version:
this zero-dependency package will provide a (nodejs-compatible) swagger-client for github-pulls's web-apis, with a working web-demo
1,030 lines • 422 kB
JSON
{
"basePath": "/",
"definitions": {
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_20POST.body": {
"properties": {
"base": {
"default": "master",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository."
]
},
"body": {
"default": "Please pull this in!",
"type": "string"
},
"head": {
"default": "octocat:new-feature",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace ```head``` with a user like this: ```username:branch```."
]
},
"maintainer_can_modify": {
"type": "boolean",
"x-swgg-descriptionLineList": [
"Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request."
]
},
"title": {
"default": "Amazing new feature",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The title of the pull request."
]
}
},
"required": [
"title",
"head",
"base"
],
"x-swgg-tags0": "github-pulls"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_20PATCH.body": {
"properties": {
"base": {
"default": "master",
"type": "string",
"x-swgg-descriptionLineList": [
"The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository."
]
},
"body": {
"default": "updated body",
"type": "string"
},
"maintainer_can_modify": {
"type": "boolean",
"x-swgg-descriptionLineList": [
"Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request."
]
},
"state": {
"default": "open",
"type": "string",
"x-swgg-descriptionLineList": [
"State of this Pull Request. Either ```open``` or ```closed```."
]
},
"title": {
"default": "new title",
"type": "string",
"x-swgg-descriptionLineList": [
"The title of the pull request."
]
}
},
"x-swgg-tags0": "github-pulls"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Fcomments_20POST.body": {
"properties": {
"body": {
"default": "Nice change",
"type": "string"
},
"commit_id": {
"default": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the ```position```."
]
},
"path": {
"default": "file1.txt",
"type": "string",
"x-swgg-descriptionLineList": [
"**Required**. The relative path to the file that necessitates a comment."
]
},
"position": {
"default": 4,
"type": "integer",
"x-swgg-descriptionLineList": [
"**Required**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below."
]
}
},
"required": [
"commit_id",
"path",
"position"
],
"x-swgg-tags0": "github-pulls"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Frequested_reviewers_20DELETE.body": {
"properties": {
"reviewers": {
"default": [
"octocat",
"hubot",
"other_user"
],
"items": {
"type": "string"
},
"type": "array"
},
"team_reviewers": {
"default": [
"justice-league"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"x-swgg-tags0": "github-pulls"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Frequested_reviewers_20POST.body": {
"properties": {
"reviewers": {
"default": [
"octocat",
"hubot",
"other_user"
],
"items": {
"type": "string"
},
"type": "array"
},
"team_reviewers": {
"default": [
"justice-league"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"x-swgg-tags0": "github-pulls"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Freviews_20POST.body": {
"properties": {
"body": {
"default": "This is close to perfect! Please address the suggested inline change.",
"type": "string"
},
"comments": {
"default": [
{
"body": "Please add more information here, and fix this typo.",
"path": "file.md",
"position": 6
}
],
"items": {
"$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Freviews_20POST.body.comments"
},
"type": "array"
},
"commit_id": {
"default": "ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091",
"type": "string",
"x-swgg-descriptionLineList": [
"The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the ```position```. Defaults to the most recent commit in the pull request when you do not specify a value."
]
},
"event": {
"default": "REQUEST_CHANGES",
"type": "string",
"x-swgg-descriptionLineList": [
"The review action you want to perform. The review actions include: ```APPROVE```, ```REQUEST_CHANGES```, or ```COMMENT```. By leaving this blank, you set the review action state to ```PENDING```, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready."
]
}
},
"x-swgg-tags0": "github-pulls"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Freviews_20POST.body.comments": {
"properties": {
"body": {
"default": "Please add more information here, and fix this typo.",
"type": "string"
},
"path": {
"default": "file.md",
"type": "string"
},
"position": {
"default": 6,
"type": "number"
}
},
"x-swgg-tags0": "github-pulls"
},
"_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2Fcomments_2F_7Bid_7D_20PATCH.body": {
"properties": {
"body": {
"default": "Nice change",
"type": "string"
}
},
"x-swgg-tags0": "github-pulls"
}
},
"info": {
"title": "swgg-github-pulls",
"version": "2018.4.21",
"x-swgg-description": "this zero-dependency package will provide a (nodejs-compatible) swagger-client for github-pulls's web-apis, with a working web-demo",
"x-swgg-homepage": "https://github.com/kaizhu256/node-swgg-github-pulls"
},
"parameters": {
"github-all.key": {
"default": "xxxxxxxx",
"in": "query",
"name": "access_token",
"type": "string",
"x-swgg-apiKey": true,
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/#authentication",
"",
"OAuth2 token (sent as a parameter)"
]
},
"github-all.user-agent": {
"default": "Awesome-Octocat-App",
"in": "header",
"name": "user-agent",
"required": true,
"type": "string",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/index.html#user-agent-required",
"",
"All API requests MUST include a valid ```User-Agent``` header. Requests with no ```User-Agent``` header will be rejected. We request that you use your GitHub username, or the name of your application, for the ```User-Agent``` header value. This allows us to contact you if there are problems."
]
}
},
"paths": {
"/repos/{owner}/{repo}/pulls": {
"get": {
"operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_20GET",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.symmetra-preview+json"
],
"enum": [
"application/vnd.github.jean-grey-preview+json",
"application/vnd.github.symmetra-preview+json",
"application/vnd.github.v3.raw+json",
"application/vnd.github.v3.text+json",
"application/vnd.github.v3.html+json",
"application/vnd.github.v3.full+json",
"application/vnd.github.v3.diff",
"application/vnd.github.v3.patch",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "owner",
"in": "path",
"name": "owner",
"required": true,
"type": "string"
},
{
"default": "repo",
"in": "path",
"name": "repo",
"required": true,
"type": "string"
},
{
"default": "open",
"in": "query",
"name": "state",
"type": "string",
"x-swgg-descriptionLineList": [
"Either ```open```, ```closed```, or ```all``` to filter by state. Default: ```open```"
]
},
{
"in": "query",
"name": "head",
"type": "string",
"x-swgg-descriptionLineList": [
"Filter pulls by head user and branch name in the format of ```user:ref-name```. Example: ```github:new-script-format```."
]
},
{
"in": "query",
"name": "base",
"type": "string",
"x-swgg-descriptionLineList": [
"Filter pulls by base branch name. Example: ```gh-pages```."
]
},
{
"default": "created",
"in": "query",
"name": "sort",
"type": "string",
"x-swgg-descriptionLineList": [
"What to sort results by. Can be either ```created```, ```updated```, ```popularity``` (comment count) or ```long-running``` (age, filtering by pulls updated in the last month). Default: ```created```"
]
},
{
"default": "desc",
"in": "query",
"name": "direction",
"type": "string",
"x-swgg-descriptionLineList": [
"The direction of the sort. Can be either ```asc``` or ```desc```. Default: ```desc``` when sort is ```created``` or sort is not specified, otherwise ```asc```."
]
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-pulls"
],
"x-swgg-descriptionLineList": [
"[Pull Requests](https://developer.github.com/v3/pulls/#list-pull-requests) - List pull requests",
"",
"**Note:** You can now use emoji in label names, add descriptions to labels, and search for labels in a repository. See the [blog post](https://developer.github.com/changes/2018-02-22-label-description-search-preview) for full details. To access these features and receive payloads with this data during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:",
"```",
"application/vnd.github.symmetra-preview+json",
"```",
"",
"**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)."
],
"x-swgg-host": "api.github.com",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[Pull Requests](https://developer.github.com/v3/pulls/#list-pull-requests) - List pull requests",
"x-swgg-tags0": "github-pulls"
},
"post": {
"operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_20POST",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.symmetra-preview+json"
],
"enum": [
"application/vnd.github.jean-grey-preview+json",
"application/vnd.github.symmetra-preview+json",
"application/vnd.github.v3.raw+json",
"application/vnd.github.v3.text+json",
"application/vnd.github.v3.html+json",
"application/vnd.github.v3.full+json",
"application/vnd.github.v3.diff",
"application/vnd.github.v3.patch",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "owner",
"in": "path",
"name": "owner",
"required": true,
"type": "string"
},
{
"default": "repo",
"in": "path",
"name": "repo",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_20POST.body"
},
"x-swgg-descriptionLineList": [
"The contents of the pull request."
]
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-pulls"
],
"x-swgg-descriptionLineList": [
"[Pull Requests](https://developer.github.com/v3/pulls/#create-a-pull-request) - Create a pull request",
"",
"**Note:** To open 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 a pull request.",
"",
"**Note:** You can now use emoji in label names, add descriptions to labels, and search for labels in a repository. See the [blog post](https://developer.github.com/changes/2018-02-22-label-description-search-preview) for full details. To access these features and receive payloads with this data during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:",
"```",
"application/vnd.github.symmetra-preview+json",
"```",
"",
"**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)."
],
"x-swgg-host": "api.github.com",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[Pull Requests](https://developer.github.com/v3/pulls/#create-a-pull-request) - Create a pull request",
"x-swgg-tags0": "github-pulls"
}
},
"/repos/{owner}/{repo}/pulls/comments": {
"get": {
"operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2Fcomments_20GET",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.squirrel-girl-preview"
],
"enum": [
"application/vnd.github.squirrel-girl-preview",
"application/vnd.github.v3.diff",
"application/vnd.github.v3.raw+json",
"application/vnd.github.v3.text+json",
"application/vnd.github.v3.html+json",
"application/vnd.github.v3.full+json",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "owner",
"in": "path",
"name": "owner",
"required": true,
"type": "string"
},
{
"default": "repo",
"in": "path",
"name": "repo",
"required": true,
"type": "string"
},
{
"default": "created",
"in": "query",
"name": "sort",
"type": "string",
"x-swgg-descriptionLineList": [
"Can be either ```created``` or ```updated``` comments. Default: ```created```"
]
},
{
"in": "query",
"name": "direction",
"type": "string",
"x-swgg-descriptionLineList": [
"Can be either ```asc``` or ```desc```. Ignored without ```sort``` parameter."
]
},
{
"in": "query",
"name": "since",
"type": "string",
"x-swgg-descriptionLineList": [
"This is a timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```. Only returns comments ```updated``` at or after this time."
]
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-pulls"
],
"x-swgg-descriptionLineList": [
"[Review Comments](https://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository) - List comments in a repository"
],
"x-swgg-host": "api.github.com",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[Review Comments](https://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository) - List comments in a repository",
"x-swgg-tags0": "github-pulls"
}
},
"/repos/{owner}/{repo}/pulls/comments/{id}": {
"delete": {
"operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2Fcomments_2F_7Bid_7D_20DELETE",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.squirrel-girl-preview"
],
"enum": [
"application/vnd.github.squirrel-girl-preview",
"application/vnd.github.v3.diff",
"application/vnd.github.v3.raw+json",
"application/vnd.github.v3.text+json",
"application/vnd.github.v3.html+json",
"application/vnd.github.v3.full+json",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "owner",
"in": "path",
"name": "owner",
"required": true,
"type": "string"
},
{
"default": "repo",
"in": "path",
"name": "repo",
"required": true,
"type": "string"
},
{
"default": "id",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-pulls"
],
"x-swgg-descriptionLineList": [
"[Review Comments](https://developer.github.com/v3/pulls/comments/#delete-a-comment) - Delete a comment"
],
"x-swgg-host": "api.github.com",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[Review Comments](https://developer.github.com/v3/pulls/comments/#delete-a-comment) - Delete a comment",
"x-swgg-tags0": "github-pulls"
},
"get": {
"operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2Fcomments_2F_7Bid_7D_20GET",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.squirrel-girl-preview"
],
"enum": [
"application/vnd.github.squirrel-girl-preview",
"application/vnd.github.v3.diff",
"application/vnd.github.v3.raw+json",
"application/vnd.github.v3.text+json",
"application/vnd.github.v3.html+json",
"application/vnd.github.v3.full+json",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "owner",
"in": "path",
"name": "owner",
"required": true,
"type": "string"
},
{
"default": "repo",
"in": "path",
"name": "repo",
"required": true,
"type": "string"
},
{
"default": "id",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-pulls"
],
"x-swgg-descriptionLineList": [
"[Review Comments](https://developer.github.com/v3/pulls/comments/#get-a-single-comment) - Get a single comment"
],
"x-swgg-host": "api.github.com",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[Review Comments](https://developer.github.com/v3/pulls/comments/#get-a-single-comment) - Get a single comment",
"x-swgg-tags0": "github-pulls"
},
"patch": {
"operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2Fcomments_2F_7Bid_7D_20PATCH",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.squirrel-girl-preview"
],
"enum": [
"application/vnd.github.squirrel-girl-preview",
"application/vnd.github.v3.diff",
"application/vnd.github.v3.raw+json",
"application/vnd.github.v3.text+json",
"application/vnd.github.v3.html+json",
"application/vnd.github.v3.full+json",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "owner",
"in": "path",
"name": "owner",
"required": true,
"type": "string"
},
{
"default": "repo",
"in": "path",
"name": "repo",
"required": true,
"type": "string"
},
{
"default": "id",
"in": "path",
"name": "id",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2Fcomments_2F_7Bid_7D_20PATCH.body"
},
"x-swgg-descriptionLineList": [
"**Required**. The text of the comment."
]
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-pulls"
],
"x-swgg-descriptionLineList": [
"[Review Comments](https://developer.github.com/v3/pulls/comments/#edit-a-comment) - Edit a comment"
],
"x-swgg-host": "api.github.com",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[Review Comments](https://developer.github.com/v3/pulls/comments/#edit-a-comment) - Edit a comment",
"x-swgg-tags0": "github-pulls"
}
},
"/repos/{owner}/{repo}/pulls/{number}": {
"get": {
"operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_20GET",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.symmetra-preview+json"
],
"enum": [
"application/vnd.github.jean-grey-preview+json",
"application/vnd.github.symmetra-preview+json",
"application/vnd.github.v3.raw+json",
"application/vnd.github.v3.text+json",
"application/vnd.github.v3.html+json",
"application/vnd.github.v3.full+json",
"application/vnd.github.v3.diff",
"application/vnd.github.v3.patch",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "owner",
"in": "path",
"name": "owner",
"required": true,
"type": "string"
},
{
"default": "repo",
"in": "path",
"name": "repo",
"required": true,
"type": "string"
},
{
"default": "number",
"in": "path",
"name": "number",
"required": true,
"type": "string"
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-pulls"
],
"x-swgg-descriptionLineList": [
"[Pull Requests](https://developer.github.com/v3/pulls/#get-a-single-pull-request) - Get a single pull request",
"",
"**Note:** You can now use emoji in label names, add descriptions to labels, and search for labels in a repository. See the [blog post](https://developer.github.com/changes/2018-02-22-label-description-search-preview) for full details. To access these features and receive payloads with this data during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:",
"```",
"application/vnd.github.symmetra-preview+json",
"```",
"",
"**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)."
],
"x-swgg-host": "api.github.com",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[Pull Requests](https://developer.github.com/v3/pulls/#get-a-single-pull-request) - Get a single pull request",
"x-swgg-tags0": "github-pulls"
},
"patch": {
"operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_20PATCH",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.symmetra-preview+json"
],
"enum": [
"application/vnd.github.jean-grey-preview+json",
"application/vnd.github.symmetra-preview+json",
"application/vnd.github.v3.raw+json",
"application/vnd.github.v3.text+json",
"application/vnd.github.v3.html+json",
"application/vnd.github.v3.full+json",
"application/vnd.github.v3.diff",
"application/vnd.github.v3.patch",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "owner",
"in": "path",
"name": "owner",
"required": true,
"type": "string"
},
{
"default": "repo",
"in": "path",
"name": "repo",
"required": true,
"type": "string"
},
{
"default": "number",
"in": "path",
"name": "number",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"schema": {
"$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_20PATCH.body"
},
"x-swgg-descriptionLineList": [
"The contents of the pull request."
]
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-pulls"
],
"x-swgg-descriptionLineList": [
"[Pull Requests](https://developer.github.com/v3/pulls/#update-a-pull-request) - Update a pull request",
"",
"**Note:** To open 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 a pull request.",
"",
"**Note:** You can now use emoji in label names, add descriptions to labels, and search for labels in a repository. See the [blog post](https://developer.github.com/changes/2018-02-22-label-description-search-preview) for full details. To access these features and receive payloads with this data during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:",
"```",
"application/vnd.github.symmetra-preview+json",
"```",
"",
"**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)."
],
"x-swgg-host": "api.github.com",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[Pull Requests](https://developer.github.com/v3/pulls/#update-a-pull-request) - Update a pull request",
"x-swgg-tags0": "github-pulls"
}
},
"/repos/{owner}/{repo}/pulls/{number}/comments": {
"get": {
"operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Fcomments_20GET",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.squirrel-girl-preview"
],
"enum": [
"application/vnd.github.squirrel-girl-preview",
"application/vnd.github.v3.diff",
"application/vnd.github.v3.raw+json",
"application/vnd.github.v3.text+json",
"application/vnd.github.v3.html+json",
"application/vnd.github.v3.full+json",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of t