Skip to content

Commit c7c4839

Browse files
monikakusterivicac
authored andcommitted
3196 docs - generated
1 parent b2d5a66 commit c7c4839

File tree

1 file changed

+120
-0
lines changed

1 file changed

+120
-0
lines changed

docs/content/docs/reference/components/github_v1.mdx

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,126 @@ Type: OBJECT
330330
```
331331

332332

333+
### Create Pull Request
334+
Name: createPullRequest
335+
336+
`Creates a new pull request.`
337+
338+
#### Properties
339+
340+
| Name | Label | Type | Description | Required |
341+
|:---------------:|:--------------:|:------------:|:-------------------:|:--------:|
342+
| owner | User/Organization | STRING | The owner of the repository (user or organization). | true |
343+
| repository | Repository | STRING | Repository where new pull request will be created. | true |
344+
| title | Title | STRING | Title of the new pull request. | false |
345+
| body | Body | STRING | The contents of the pull request. | false |
346+
| head | Head | STRING | 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. | true |
347+
| head_repo | Head Repo | STRING | The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization. | false |
348+
| base | Base | STRING | 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. | true |
349+
| issue | Issue | INTEGER | 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. | false |
350+
| draft | Draft | BOOLEAN <details> <summary> Options </summary> <span>true</span>, <span>false</span> </details> | Indicates whether the pull request is a draft. | true |
351+
352+
#### Example JSON Structure
353+
```json
354+
{
355+
"label" : "Create Pull Request",
356+
"name" : "createPullRequest",
357+
"parameters" : {
358+
"owner" : "",
359+
"repository" : "",
360+
"title" : "",
361+
"body" : "",
362+
"head" : "",
363+
"head_repo" : "",
364+
"base" : "",
365+
"issue" : 1,
366+
"draft" : false
367+
},
368+
"type" : "github/v1/createPullRequest"
369+
}
370+
```
371+
372+
#### Output
373+
374+
375+
376+
Type: OBJECT
377+
378+
379+
#### Properties
380+
381+
| Name | Type | Description |
382+
|:------------:|:------------:|:-------------------:|
383+
| url | STRING | The URL of the created pull request. |
384+
| id | INTEGER | ID of the created pull request. |
385+
| node_id | STRING | |
386+
| html_url | STRING | |
387+
| diff_url | STRING | |
388+
| patch_url | STRING | |
389+
| issue_url | STRING | |
390+
| commits_url | STRING | |
391+
| review_comment_url | STRING | |
392+
| comments_url | STRING | |
393+
| statuses_url | STRING | |
394+
| number | INTEGER | Number uniquely identifying the pull request within its repository. |
395+
| state | STRING | The state of the pull request. Either open or closed. |
396+
| locked | BOOLEAN <details> <summary> Options </summary> <span>true</span>, <span>false</span> </details> | |
397+
| title | STRING | The title of the pull request. |
398+
| user | OBJECT <details> <summary> Properties </summary> &#123;STRING\(login), STRING\(id), STRING\(html_url), STRING\(type)&#125; </details> | A GitHub user. |
399+
| body | STRING | The contents of the pull request. |
400+
| labels | ARRAY <details> <summary> Items </summary> [&#123;STRING\(id), STRING\(name), STRING\(description)&#125;] </details> | |
401+
| comments | INTEGER | The number of comments on the pull request. |
402+
| review_comments | INTEGER | The number of comments for review on the pull request. |
403+
| maintainer_can_modify | BOOLEAN <details> <summary> Options </summary> <span>true</span>, <span>false</span> </details> | Indicates whether maintainers can modify the pull request. |
404+
| commits | INTEGER | The number of commits in the pull request. |
405+
| additions | INTEGER | The number of additions in the pull request. |
406+
| deletions | INTEGER | The number of deletions in the pull request. |
407+
| changed_files | INTEGER | The number of changed files in the pull request. |
408+
409+
410+
411+
412+
#### Output Example
413+
```json
414+
{
415+
"url" : "",
416+
"id" : 1,
417+
"node_id" : "",
418+
"html_url" : "",
419+
"diff_url" : "",
420+
"patch_url" : "",
421+
"issue_url" : "",
422+
"commits_url" : "",
423+
"review_comment_url" : "",
424+
"comments_url" : "",
425+
"statuses_url" : "",
426+
"number" : 1,
427+
"state" : "",
428+
"locked" : false,
429+
"title" : "",
430+
"user" : {
431+
"login" : "",
432+
"id" : "",
433+
"html_url" : "",
434+
"type" : ""
435+
},
436+
"body" : "",
437+
"labels" : [ {
438+
"id" : "",
439+
"name" : "",
440+
"description" : ""
441+
} ],
442+
"comments" : 1,
443+
"review_comments" : 1,
444+
"maintainer_can_modify" : false,
445+
"commits" : 1,
446+
"additions" : 1,
447+
"deletions" : 1,
448+
"changed_files" : 1
449+
}
450+
```
451+
452+
333453
### Get Issue
334454
Name: getIssue
335455

0 commit comments

Comments
 (0)