Skip to content

Commit 045e283

Browse files
mattpagemattpage
authored
Merge pull request #532 from github/openapi-update-2dbb1bf65d974d8b858e78ba95f8deb201c211d0df7d17d3cb55cbf1bdf78d25
Update OpenAPI Descriptions
2 parents 47a6c03 + 4e79c7d commit 045e283

8 files changed

Lines changed: 698 additions & 0 deletions

File tree

‎descriptions/api.github.com/api.github.com.json‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34739,6 +34739,81 @@
3473934739
}
3474034740
}
3474134741
},
34742+
"/repos/{owner}/{repo}/merge-upstream": {
34743+
"post": {
34744+
"summary": "Sync a fork branch with the upstream repository",
34745+
"description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.",
34746+
"tags": [
34747+
"repos"
34748+
],
34749+
"operationId": "repos/merge-upstream",
34750+
"externalDocs": {
34751+
"description": "API method documentation",
34752+
"url": "https://docs.github.com/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository"
34753+
},
34754+
"parameters": [
34755+
{
34756+
"$ref": "#/components/parameters/owner"
34757+
},
34758+
{
34759+
"$ref": "#/components/parameters/repo"
34760+
}
34761+
],
34762+
"requestBody": {
34763+
"content": {
34764+
"application/json": {
34765+
"schema": {
34766+
"type": "object",
34767+
"properties": {
34768+
"branch": {
34769+
"type": "string",
34770+
"description": "The name of the branch which should be updated to match upstream."
34771+
}
34772+
},
34773+
"required": [
34774+
"branch"
34775+
]
34776+
},
34777+
"example": {
34778+
"branch": "main"
34779+
}
34780+
}
34781+
}
34782+
},
34783+
"responses": {
34784+
"200": {
34785+
"description": "The branch has been successfully synced with the upstream repository",
34786+
"content": {
34787+
"application/json": {
34788+
"schema": {
34789+
"$ref": "#/components/schemas/merged-upstream"
34790+
},
34791+
"examples": {
34792+
"default": {
34793+
"$ref": "#/components/examples/merged-upstream"
34794+
}
34795+
}
34796+
}
34797+
}
34798+
},
34799+
"409": {
34800+
"description": "The branch could not be synced because of a merge conflict"
34801+
},
34802+
"422": {
34803+
"description": "The branch could not be synced for some other reason"
34804+
}
34805+
},
34806+
"x-github": {
34807+
"githubCloudOnly": false,
34808+
"enabledForGitHubApps": true,
34809+
"previews": [
34810+
34811+
],
34812+
"category": "repos",
34813+
"subcategory": "merging-upstream"
34814+
}
34815+
}
34816+
},
3474234817
"/repos/{owner}/{repo}/merges": {
3474334818
"post": {
3474434819
"summary": "Merge a branch",
@@ -69903,6 +69978,27 @@
6990369978
"license"
6990469979
]
6990569980
},
69981+
"merged-upstream": {
69982+
"title": "Merged upstream",
69983+
"description": "Results of a successful merge upstream request",
69984+
"type": "object",
69985+
"properties": {
69986+
"message": {
69987+
"type": "string"
69988+
},
69989+
"merge_type": {
69990+
"type": "string",
69991+
"enum": [
69992+
"merge",
69993+
"fast-forward",
69994+
"none"
69995+
]
69996+
},
69997+
"base_branch": {
69998+
"type": "string"
69999+
}
70000+
}
70001+
},
6990670002
"pages-source-hash": {
6990770003
"title": "Pages Source Hash",
6990870004
"type": "object",
@@ -89199,6 +89295,13 @@
8919989295
}
8920089296
}
8920189297
},
89298+
"merged-upstream": {
89299+
"value": {
89300+
"message": "Successfully fetched and fast-forwarded from upstream defunkt:main",
89301+
"merge_type": "fast-forward",
89302+
"base_branch": "defunkt:main"
89303+
}
89304+
},
8920289305
"milestone-items": {
8920389306
"value": [
8920489307
{

‎descriptions/api.github.com/api.github.com.yaml‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24968,6 +24968,54 @@ paths:
2496824968
previews: []
2496924969
category: licenses
2497024970
subcategory:
24971+
"/repos/{owner}/{repo}/merge-upstream":
24972+
post:
24973+
summary: Sync a fork branch with the upstream repository
24974+
description: Sync a branch of a forked repository to keep it up-to-date with
24975+
the upstream repository.
24976+
tags:
24977+
- repos
24978+
operationId: repos/merge-upstream
24979+
externalDocs:
24980+
description: API method documentation
24981+
url: https://docs.github.com/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository
24982+
parameters:
24983+
- "$ref": "#/components/parameters/owner"
24984+
- "$ref": "#/components/parameters/repo"
24985+
requestBody:
24986+
content:
24987+
application/json:
24988+
schema:
24989+
type: object
24990+
properties:
24991+
branch:
24992+
type: string
24993+
description: The name of the branch which should be updated to match
24994+
upstream.
24995+
required:
24996+
- branch
24997+
example:
24998+
branch: main
24999+
responses:
25000+
'200':
25001+
description: The branch has been successfully synced with the upstream repository
25002+
content:
25003+
application/json:
25004+
schema:
25005+
"$ref": "#/components/schemas/merged-upstream"
25006+
examples:
25007+
default:
25008+
"$ref": "#/components/examples/merged-upstream"
25009+
'409':
25010+
description: The branch could not be synced because of a merge conflict
25011+
'422':
25012+
description: The branch could not be synced for some other reason
25013+
x-github:
25014+
githubCloudOnly: false
25015+
enabledForGitHubApps: true
25016+
previews: []
25017+
category: repos
25018+
subcategory: merging-upstream
2497125019
"/repos/{owner}/{repo}/merges":
2497225020
post:
2497325021
summary: Merge a branch
@@ -50776,6 +50824,21 @@ components:
5077650824
- content
5077750825
- encoding
5077850826
- license
50827+
merged-upstream:
50828+
title: Merged upstream
50829+
description: Results of a successful merge upstream request
50830+
type: object
50831+
properties:
50832+
message:
50833+
type: string
50834+
merge_type:
50835+
type: string
50836+
enum:
50837+
- merge
50838+
- fast-forward
50839+
- none
50840+
base_branch:
50841+
type: string
5077950842
pages-source-hash:
5078050843
title: Pages Source Hash
5078150844
type: object
@@ -67211,6 +67274,11 @@ components:
6721167274
spdx_id: MIT
6721267275
url: https://api.github.com/licenses/mit
6721367276
node_id: MDc6TGljZW5zZW1pdA==
67277+
merged-upstream:
67278+
value:
67279+
message: Successfully fetched and fast-forwarded from upstream defunkt:main
67280+
merge_type: fast-forward
67281+
base_branch: defunkt:main
6721467282
milestone-items:
6721567283
value:
6721667284
- url: https://api.github.com/repos/octocat/Hello-World/milestones/1

‎descriptions/api.github.com/dereferenced/api.github.com.deref.json‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282440,6 +282440,113 @@
282440282440
}
282441282441
}
282442282442
},
282443+
"/repos/{owner}/{repo}/merge-upstream": {
282444+
"post": {
282445+
"summary": "Sync a fork branch with the upstream repository",
282446+
"description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.",
282447+
"tags": [
282448+
"repos"
282449+
],
282450+
"operationId": "repos/merge-upstream",
282451+
"externalDocs": {
282452+
"description": "API method documentation",
282453+
"url": "https://docs.github.com/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository"
282454+
},
282455+
"parameters": [
282456+
{
282457+
"name": "owner",
282458+
"in": "path",
282459+
"required": true,
282460+
"schema": {
282461+
"type": "string"
282462+
}
282463+
},
282464+
{
282465+
"name": "repo",
282466+
"in": "path",
282467+
"required": true,
282468+
"schema": {
282469+
"type": "string"
282470+
}
282471+
}
282472+
],
282473+
"requestBody": {
282474+
"content": {
282475+
"application/json": {
282476+
"schema": {
282477+
"type": "object",
282478+
"properties": {
282479+
"branch": {
282480+
"type": "string",
282481+
"description": "The name of the branch which should be updated to match upstream."
282482+
}
282483+
},
282484+
"required": [
282485+
"branch"
282486+
]
282487+
},
282488+
"example": {
282489+
"branch": "main"
282490+
}
282491+
}
282492+
}
282493+
},
282494+
"responses": {
282495+
"200": {
282496+
"description": "The branch has been successfully synced with the upstream repository",
282497+
"content": {
282498+
"application/json": {
282499+
"schema": {
282500+
"title": "Merged upstream",
282501+
"description": "Results of a successful merge upstream request",
282502+
"type": "object",
282503+
"properties": {
282504+
"message": {
282505+
"type": "string"
282506+
},
282507+
"merge_type": {
282508+
"type": "string",
282509+
"enum": [
282510+
"merge",
282511+
"fast-forward",
282512+
"none"
282513+
]
282514+
},
282515+
"base_branch": {
282516+
"type": "string"
282517+
}
282518+
}
282519+
},
282520+
"examples": {
282521+
"default": {
282522+
"value": {
282523+
"message": "Successfully fetched and fast-forwarded from upstream defunkt:main",
282524+
"merge_type": "fast-forward",
282525+
"base_branch": "defunkt:main"
282526+
}
282527+
}
282528+
}
282529+
}
282530+
}
282531+
},
282532+
"409": {
282533+
"description": "The branch could not be synced because of a merge conflict"
282534+
},
282535+
"422": {
282536+
"description": "The branch could not be synced for some other reason"
282537+
}
282538+
},
282539+
"x-github": {
282540+
"githubCloudOnly": false,
282541+
"enabledForGitHubApps": true,
282542+
"previews": [
282543+
282544+
],
282545+
"category": "repos",
282546+
"subcategory": "merging-upstream"
282547+
}
282548+
}
282549+
},
282443282550
"/repos/{owner}/{repo}/merges": {
282444282551
"post": {
282445282552
"summary": "Merge a branch",

0 commit comments

Comments
 (0)