Skip to content

Commit

Permalink
Add decorated OpenAPI schema files
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-openapi-bot
github-openapi-bot committed Aug 18, 2022
1 parent a20fa8f commit bcdc696
Show file tree
Hide file tree
Showing 7 changed files with 16,427 additions and 25 deletions.
8,674 changes: 8,655 additions & 19 deletions lib/rest/static/decorated/api.github.com.json
View file

Large diffs are not rendered by default.

138 changes: 138 additions & 0 deletions lib/rest/static/decorated/ghes-3.2.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -374624,6 +374624,52 @@
"name": "use_squash_pr_title_as_default",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
],
"description": "<p>The default value for a squash merge commit title:</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>COMMIT_OR_PR_TITLE</code> - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).</li>\n</ul>",
"name": "squash_merge_commit_title",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
],
"description": "<p>The default value for a squash merge commit message:</p>\n<ul>\n<li><code>PR_BODY</code> - default to the pull request's body.</li>\n<li><code>COMMIT_MESSAGES</code> - default to the branch's commit messages.</li>\n<li><code>BLANK</code> - default to a blank commit message.</li>\n</ul>",
"name": "squash_merge_commit_message",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
],
"description": "<p>The default value for a merge commit title.</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>MERGE_MESSAGE</code> - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).</li>\n</ul>",
"name": "merge_commit_title",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
],
"description": "<p>The default value for a merge commit message.</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>PR_BODY</code> - default to the pull request's body.</li>\n<li><code>BLANK</code> - default to a blank commit message.</li>\n</ul>",
"name": "merge_commit_message",
"in": "body",
"isRequired": false
}
],
"enabledForGitHubApps": true,
Expand Down Expand Up @@ -388063,6 +388109,52 @@
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
],
"description": "<p>The default value for a squash merge commit title:</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>COMMIT_OR_PR_TITLE</code> - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).</li>\n</ul>",
"name": "squash_merge_commit_title",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
],
"description": "<p>The default value for a squash merge commit message:</p>\n<ul>\n<li><code>PR_BODY</code> - default to the pull request's body.</li>\n<li><code>COMMIT_MESSAGES</code> - default to the branch's commit messages.</li>\n<li><code>BLANK</code> - default to a blank commit message.</li>\n</ul>",
"name": "squash_merge_commit_message",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
],
"description": "<p>The default value for a merge commit title.</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>MERGE_MESSAGE</code> - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).</li>\n</ul>",
"name": "merge_commit_title",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
],
"description": "<p>The default value for a merge commit message.</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>PR_BODY</code> - default to the pull request's body.</li>\n<li><code>BLANK</code> - default to a blank commit message.</li>\n</ul>",
"name": "merge_commit_message",
"in": "body",
"isRequired": false
},
{
"type": "boolean",
"description": "<p><code>true</code> to archive this repository. <strong>Note</strong>: You cannot unarchive repositories through the API.</p>",
Expand Down Expand Up @@ -402949,6 +403041,52 @@
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
],
"description": "<p>The default value for a squash merge commit title:</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>COMMIT_OR_PR_TITLE</code> - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).</li>\n</ul>",
"name": "squash_merge_commit_title",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
],
"description": "<p>The default value for a squash merge commit message:</p>\n<ul>\n<li><code>PR_BODY</code> - default to the pull request's body.</li>\n<li><code>COMMIT_MESSAGES</code> - default to the branch's commit messages.</li>\n<li><code>BLANK</code> - default to a blank commit message.</li>\n</ul>",
"name": "squash_merge_commit_message",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
],
"description": "<p>The default value for a merge commit title.</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>MERGE_MESSAGE</code> - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).</li>\n</ul>",
"name": "merge_commit_title",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
],
"description": "<p>The default value for a merge commit message.</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>PR_BODY</code> - default to the pull request's body.</li>\n<li><code>BLANK</code> - default to a blank commit message.</li>\n</ul>",
"name": "merge_commit_message",
"in": "body",
"isRequired": false
},
{
"description": "<p>Whether downloads are enabled.</p>",
"default": true,
Expand Down
138 changes: 138 additions & 0 deletions lib/rest/static/decorated/ghes-3.3.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -376309,6 +376309,52 @@
"name": "use_squash_pr_title_as_default",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
],
"description": "<p>The default value for a squash merge commit title:</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>COMMIT_OR_PR_TITLE</code> - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).</li>\n</ul>",
"name": "squash_merge_commit_title",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
],
"description": "<p>The default value for a squash merge commit message:</p>\n<ul>\n<li><code>PR_BODY</code> - default to the pull request's body.</li>\n<li><code>COMMIT_MESSAGES</code> - default to the branch's commit messages.</li>\n<li><code>BLANK</code> - default to a blank commit message.</li>\n</ul>",
"name": "squash_merge_commit_message",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
],
"description": "<p>The default value for a merge commit title.</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>MERGE_MESSAGE</code> - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).</li>\n</ul>",
"name": "merge_commit_title",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
],
"description": "<p>The default value for a merge commit message.</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>PR_BODY</code> - default to the pull request's body.</li>\n<li><code>BLANK</code> - default to a blank commit message.</li>\n</ul>",
"name": "merge_commit_message",
"in": "body",
"isRequired": false
}
],
"enabledForGitHubApps": true,
Expand Down Expand Up @@ -384089,6 +384135,52 @@
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
],
"description": "<p>The default value for a squash merge commit title:</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>COMMIT_OR_PR_TITLE</code> - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).</li>\n</ul>",
"name": "squash_merge_commit_title",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
],
"description": "<p>The default value for a squash merge commit message:</p>\n<ul>\n<li><code>PR_BODY</code> - default to the pull request's body.</li>\n<li><code>COMMIT_MESSAGES</code> - default to the branch's commit messages.</li>\n<li><code>BLANK</code> - default to a blank commit message.</li>\n</ul>",
"name": "squash_merge_commit_message",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
],
"description": "<p>The default value for a merge commit title.</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>MERGE_MESSAGE</code> - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).</li>\n</ul>",
"name": "merge_commit_title",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
],
"description": "<p>The default value for a merge commit message.</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>PR_BODY</code> - default to the pull request's body.</li>\n<li><code>BLANK</code> - default to a blank commit message.</li>\n</ul>",
"name": "merge_commit_message",
"in": "body",
"isRequired": false
},
{
"type": "boolean",
"description": "<p><code>true</code> to archive this repository. <strong>Note</strong>: You cannot unarchive repositories through the API.</p>",
Expand Down Expand Up @@ -399067,6 +399159,52 @@
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
],
"description": "<p>The default value for a squash merge commit title:</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>COMMIT_OR_PR_TITLE</code> - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).</li>\n</ul>",
"name": "squash_merge_commit_title",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
],
"description": "<p>The default value for a squash merge commit message:</p>\n<ul>\n<li><code>PR_BODY</code> - default to the pull request's body.</li>\n<li><code>COMMIT_MESSAGES</code> - default to the branch's commit messages.</li>\n<li><code>BLANK</code> - default to a blank commit message.</li>\n</ul>",
"name": "squash_merge_commit_message",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
],
"description": "<p>The default value for a merge commit title.</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>MERGE_MESSAGE</code> - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).</li>\n</ul>",
"name": "merge_commit_title",
"in": "body",
"isRequired": false
},
{
"type": "string",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
],
"description": "<p>The default value for a merge commit message.</p>\n<ul>\n<li><code>PR_TITLE</code> - default to the pull request's title.</li>\n<li><code>PR_BODY</code> - default to the pull request's body.</li>\n<li><code>BLANK</code> - default to a blank commit message.</li>\n</ul>",
"name": "merge_commit_message",
"in": "body",
"isRequired": false
},
{
"description": "<p>Whether downloads are enabled.</p>",
"default": true,
Expand Down
Loading

0 comments on commit bcdc696

Please sign in to comment.