diff --git a/lib/rest/static/apps/enabled-for-apps.json b/lib/rest/static/apps/enabled-for-apps.json index b535855212..d6d03c236b 100644 --- a/lib/rest/static/apps/enabled-for-apps.json +++ b/lib/rest/static/apps/enabled-for-apps.json @@ -246,6 +246,11 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs" }, + { + "slug": "re-run-a-job-from-a-workflow-run", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun" + }, { "slug": "get-github-actions-permissions-for-a-repository", "verb": "get", @@ -406,6 +411,11 @@ "verb": "post", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments" }, + { + "slug": "re-run-failed-jobs-from-a-workflow-run", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs" + }, { "slug": "list-repository-secrets", "verb": "get", diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index ae93a9b95f..80370e7448 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -8613,6 +8613,74 @@ } ], "workflow-runs": [ + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "job_id", + "description": "job_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

job_id parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/jobs/42/rerun" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun', {\n owner: 'octocat',\n repo: 'hello-world',\n job_id: 42\n})" + } + ], + "summary": "Re-run a job from a workflow run", + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "re-run-a-job-from-a-workflow-run", + "category": "actions", + "subcategory": "workflow-runs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "

Response

" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "

Forbidden

" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs", @@ -9703,6 +9771,69 @@ } ] }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the workflow run.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/rerun-failed-jobs" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})" + } + ], + "summary": "Re-run failed jobs from a workflow run", + "x-github": { + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "re-run-failed-jobs-from-a-workflow-run", + "category": "actions", + "subcategory": "workflow-runs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Re-run all of the failed jobs and their dependent jobs in a workflow run using the id of the workflow run. You must authenticate using an access token with the repo scope to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "

Response

" + } + ] + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/timing", @@ -25795,7 +25926,13 @@ "httpStatusCode": "201", "httpStatusMessage": "Created", "description": "Response for completed conclusion", - "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" + "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"42\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" + }, + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response for completed conclusion", + "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"42\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"in_progress\",\n \"conclusion\": null,\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": null,\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" } ], "bodyParameters": [ @@ -29311,8 +29448,12 @@ "head_sha" ] }, - "example": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + "examples": { + "default": { + "value": { + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + } + } } } } @@ -29331,7 +29472,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

when the suite already existed

", + "description": "

Response when the suite already exists

", "payload": "{\n \"id\": 5,\n \"node_id\": \"MDEwOkNoZWNrU3VpdGU1\",\n \"head_branch\": \"master\",\n \"head_sha\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-suites/5\",\n \"before\": \"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\n \"after\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"pull_requests\": [],\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"template_repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World-Template\",\n \"full_name\": \"octocat/Hello-World-Template\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks\": 9,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues\": 0,\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"visibility\": \"public\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n \"allow_squash_merge\": true,\n \"allow_auto_merge\": false,\n \"delete_branch_on_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0\n },\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": false,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"visibility\": \"public\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n \"delete_branch_on_merge\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0\n },\n \"head_commit\": {\n \"id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"tree_id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"message\": \"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\n \"timestamp\": \"2016-10-10T00:00:00Z\",\n \"author\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n },\n \"committer\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n }\n },\n \"latest_check_runs_count\": 1,\n \"check_runs_url\": \"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"\n}" }, { @@ -31367,9 +31508,13 @@ } } }, - "example": { - "repository_id": 1, - "ref": "main" + "examples": { + "default": { + "value": { + "repository_id": 1, + "ref": "main" + } + } } } } @@ -31568,9 +31713,13 @@ } } }, - "example": { - "repository_id": 1, - "ref": "main" + "examples": { + "default": { + "value": { + "repository_id": 1, + "ref": "main" + } + } } } } @@ -32008,10 +32157,14 @@ } ] }, - "example": { - "repository_id": 1, - "ref": "main", - "location": "WestUs2" + "examples": { + "default": { + "value": { + "repository_id": 1, + "ref": "main", + "location": "WestUs2" + } + } } } } @@ -52898,20 +53051,28 @@ }, "vcs": { "type": "string", + "description": "

The type of version control system you are migrating from.

", + "enum": [ + "subversion", + "tfvc", + "git", + "mercurial" + ], "example": "\"git\"", "name": "vcs", "in": "body", "rawType": "string", - "description": "", + "rawDescription": "The type of version control system you are migrating from.", "childParamsGroups": [] }, "tfvc_project": { "type": "string", + "description": "

For a tfvc import, the name of the project that is being imported.

", "example": "\"project1\"", "name": "tfvc_project", "in": "body", "rawType": "string", - "description": "", + "rawDescription": "For a tfvc import, the name of the project that is being imported.", "childParamsGroups": [] } }, @@ -52919,11 +53080,22 @@ }, "examples": { "example-1": { - "summary": "Example 1", + "summary": "Update authentication for an import", "value": { "vcs_username": "octocat", "vcs_password": "secret" } + }, + "example-2": { + "summary": "Updating the project choice", + "value": { + "vcs": "tfvc", + "tfvc_project": "project1", + "human_name": "project1 (tfs)" + } + }, + "example-3": { + "summary": "Restarting an import" } } } @@ -52938,7 +53110,7 @@ "category": "migrations", "subcategory": "source-imports", "notes": [], - "descriptionHTML": "

An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.

", + "descriptionHTML": "

An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.

\n

Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status detection_found_multiple and the Import Progress response will include a project_choices array.\nYou can select the project to import by providing one of the objects in the project_choices array in the update request.

", "responses": [ { "httpStatusCode": "200", @@ -52980,20 +53152,28 @@ }, { "type": "string", + "description": "

The type of version control system you are migrating from.

", + "enum": [ + "subversion", + "tfvc", + "git", + "mercurial" + ], "example": "\"git\"", "name": "vcs", "in": "body", "rawType": "string", - "description": "", + "rawDescription": "The type of version control system you are migrating from.", "childParamsGroups": [] }, { "type": "string", + "description": "

For a tfvc import, the name of the project that is being imported.

", "example": "\"project1\"", "name": "tfvc_project", "in": "body", "rawType": "string", - "description": "", + "rawDescription": "For a tfvc import, the name of the project that is being imported.", "childParamsGroups": [] } ] @@ -67124,16 +67304,6 @@ ] }, "examples": { - "example-for-a-single-line-comment": { - "summary": "Example for a single-line comment", - "value": { - "body": "Let's add this deleted line back.", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "path": "file1.txt", - "line": 5, - "side": "LEFT" - } - }, "example-for-a-multi-line-comment": { "summary": "Example for a multi-line comment", "value": { @@ -69233,8 +69403,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -69252,7 +69426,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

Response

", + "description": "

Response when the reaction type has already been added to this team discussion comment

", "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}" }, { @@ -69545,8 +69719,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -69854,7 +70032,11 @@ ] }, "example": { - "content": "heart" + "default": { + "value": { + "content": "heart" + } + } } } } @@ -70171,8 +70353,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -70489,8 +70675,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -70802,8 +70992,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -71116,8 +71310,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -83471,10 +83669,14 @@ "name" ] }, - "example": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" + } + } } } } @@ -83495,7 +83697,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

Response

", + "description": "

Response when the updated information already exists

", "payload": "{\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null,\n \"members_count\": 3,\n \"repos_count\": 10,\n \"created_at\": \"2017-07-14T16:53:42Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"type\": \"Organization\"\n }\n}" }, { diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 347b319b1c..30fe55c5ce 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -21733,7 +21733,13 @@ "httpStatusCode": "201", "httpStatusMessage": "Created", "description": "Response for completed conclusion", - "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" + "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"42\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" + }, + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response for completed conclusion", + "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"42\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"in_progress\",\n \"conclusion\": null,\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": null,\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" } ], "bodyParameters": [ @@ -25171,8 +25177,12 @@ "head_sha" ] }, - "example": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + "examples": { + "default": { + "value": { + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + } + } } } } @@ -25191,7 +25201,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

when the suite already existed

", + "description": "

Response when the suite already exists

", "payload": "{\n \"id\": 5,\n \"node_id\": \"MDEwOkNoZWNrU3VpdGU1\",\n \"head_branch\": \"master\",\n \"head_sha\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-suites/5\",\n \"before\": \"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\n \"after\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"pull_requests\": [],\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"template_repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World-Template\",\n \"full_name\": \"octocat/Hello-World-Template\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n \"homepage\": \"https://github.com\",\n \"forks\": 9,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues\": 0,\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"visibility\": \"public\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n \"allow_squash_merge\": true,\n \"delete_branch_on_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0\n },\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": false,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"visibility\": \"public\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n \"delete_branch_on_merge\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0\n },\n \"head_commit\": {\n \"id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"tree_id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"message\": \"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\n \"timestamp\": \"2016-10-10T00:00:00Z\",\n \"author\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n },\n \"committer\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n }\n },\n \"latest_check_runs_count\": 1,\n \"check_runs_url\": \"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"\n}" }, { @@ -46700,7 +46710,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"twitter_username\": \"github\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"type\": \"Organization\",\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"private_gists\": 81,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"billing_email\": \"mona@github.com\",\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20,\n \"filled_seats\": 4,\n \"seats\": 5\n },\n \"default_repository_permission\": \"read\",\n \"members_can_create_repositories\": true,\n \"two_factor_requirement_enabled\": true,\n \"members_allowed_repository_creation_type\": \"all\",\n \"members_can_create_public_repositories\": false,\n \"members_can_create_private_repositories\": false,\n \"members_can_create_internal_repositories\": false,\n \"members_can_create_pages\": true,\n \"members_can_fork_private_repositories\": false\n}" + "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"twitter_username\": \"github\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"type\": \"Organization\",\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"private_gists\": 81,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"billing_email\": \"mona@github.com\",\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20,\n \"filled_seats\": 4,\n \"seats\": 5\n },\n \"default_repository_permission\": \"read\",\n \"members_can_create_repositories\": true,\n \"two_factor_requirement_enabled\": true,\n \"members_allowed_repository_creation_type\": \"all\",\n \"members_can_create_public_repositories\": false,\n \"members_can_create_private_repositories\": false,\n \"members_can_create_internal_repositories\": false,\n \"members_can_create_pages\": true\n}" }, { "httpStatusCode": "404", @@ -46900,16 +46910,6 @@ "rawDescription": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.", "childParamsGroups": [] }, - "members_can_fork_private_repositories": { - "type": "boolean", - "description": "

Toggles whether organization members can fork private organization repositories. Can be one of:
\n* true - all organization members can fork private repositories within the organization.
\n* false - no organization members can fork private repositories within the organization.

", - "default": false, - "name": "members_can_fork_private_repositories", - "in": "body", - "rawType": "boolean", - "rawDescription": "Toggles whether organization members can fork private organization repositories. Can be one of: \n\\* `true` - all organization members can fork private repositories within the organization. \n\\* `false` - no organization members can fork private repositories within the organization.", - "childParamsGroups": [] - }, "blog": { "type": "string", "example": "\"http://github.blog\"", @@ -46955,7 +46955,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "

Response

", - "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"twitter_username\": \"github\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"type\": \"Organization\",\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"private_gists\": 81,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"billing_email\": \"mona@github.com\",\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20\n },\n \"default_repository_permission\": \"read\",\n \"members_can_create_repositories\": true,\n \"two_factor_requirement_enabled\": true,\n \"members_allowed_repository_creation_type\": \"all\",\n \"members_can_create_public_repositories\": false,\n \"members_can_create_private_repositories\": false,\n \"members_can_create_internal_repositories\": false,\n \"members_can_create_pages\": true,\n \"members_can_create_public_pages\": true,\n \"members_can_create_private_pages\": true,\n \"members_can_fork_private_repositories\": false,\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n}" + "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"twitter_username\": \"github\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"type\": \"Organization\",\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"private_gists\": 81,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"billing_email\": \"mona@github.com\",\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20\n },\n \"default_repository_permission\": \"read\",\n \"members_can_create_repositories\": true,\n \"two_factor_requirement_enabled\": true,\n \"members_allowed_repository_creation_type\": \"all\",\n \"members_can_create_public_repositories\": false,\n \"members_can_create_private_repositories\": false,\n \"members_can_create_internal_repositories\": false,\n \"members_can_create_pages\": true,\n \"members_can_create_public_pages\": true,\n \"members_can_create_private_pages\": true,\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n}" }, { "httpStatusCode": "409", @@ -47127,16 +47127,6 @@ "rawDescription": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.", "childParamsGroups": [] }, - { - "type": "boolean", - "description": "

Toggles whether organization members can fork private organization repositories. Can be one of:
\n* true - all organization members can fork private repositories within the organization.
\n* false - no organization members can fork private repositories within the organization.

", - "default": false, - "name": "members_can_fork_private_repositories", - "in": "body", - "rawType": "boolean", - "rawDescription": "Toggles whether organization members can fork private organization repositories. Can be one of: \n\\* `true` - all organization members can fork private repositories within the organization. \n\\* `false` - no organization members can fork private repositories within the organization.", - "childParamsGroups": [] - }, { "type": "string", "example": "\"http://github.blog\"", @@ -55209,16 +55199,6 @@ ] }, "examples": { - "example-for-a-single-line-comment": { - "summary": "Example for a single-line comment", - "value": { - "body": "Let's add this deleted line back.", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "path": "file1.txt", - "line": 5, - "side": "LEFT" - } - }, "example-for-a-multi-line-comment": { "summary": "Example for a multi-line comment", "value": { @@ -57329,8 +57309,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -57353,7 +57337,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

Response

", + "description": "

Response when the reaction type has already been added to this team discussion comment

", "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}" }, { @@ -57656,8 +57640,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -58052,7 +58040,11 @@ ] }, "example": { - "content": "heart" + "default": { + "value": { + "content": "heart" + } + } } } } @@ -58384,8 +58376,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -58717,8 +58713,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -59045,8 +59045,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -67871,10 +67875,14 @@ "name" ] }, - "example": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" + } + } } } } @@ -67895,7 +67903,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

Response

", + "description": "

Response when the updated information already exists

", "payload": "{\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"members_count\": 3,\n \"repos_count\": 10,\n \"created_at\": \"2017-07-14T16:53:42Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"type\": \"Organization\"\n },\n \"ldap_dn\": \"uid=asdf,ou=users,dc=github,dc=com\"\n}" }, { diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index de168835d4..f43770ffbe 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -22587,7 +22587,13 @@ "httpStatusCode": "201", "httpStatusMessage": "Created", "description": "Response for completed conclusion", - "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" + "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"42\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" + }, + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response for completed conclusion", + "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"42\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"in_progress\",\n \"conclusion\": null,\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": null,\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" } ], "bodyParameters": [ @@ -26025,8 +26031,12 @@ "head_sha" ] }, - "example": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + "examples": { + "default": { + "value": { + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + } + } } } } @@ -26045,7 +26055,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

when the suite already existed

", + "description": "

Response when the suite already exists

", "payload": "{\n \"id\": 5,\n \"node_id\": \"MDEwOkNoZWNrU3VpdGU1\",\n \"head_branch\": \"master\",\n \"head_sha\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-suites/5\",\n \"before\": \"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\n \"after\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"pull_requests\": [],\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"template_repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World-Template\",\n \"full_name\": \"octocat/Hello-World-Template\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks\": 9,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues\": 0,\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"visibility\": \"public\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n \"allow_squash_merge\": true,\n \"allow_auto_merge\": false,\n \"delete_branch_on_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0\n },\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": false,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"visibility\": \"public\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n \"delete_branch_on_merge\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0\n },\n \"head_commit\": {\n \"id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"tree_id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"message\": \"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\n \"timestamp\": \"2016-10-10T00:00:00Z\",\n \"author\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n },\n \"committer\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n }\n },\n \"latest_check_runs_count\": 1,\n \"check_runs_url\": \"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"\n}" }, { @@ -48123,7 +48133,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"twitter_username\": \"github\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"type\": \"Organization\",\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"private_gists\": 81,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"billing_email\": \"mona@github.com\",\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20,\n \"filled_seats\": 4,\n \"seats\": 5\n },\n \"default_repository_permission\": \"read\",\n \"members_can_create_repositories\": true,\n \"two_factor_requirement_enabled\": true,\n \"members_allowed_repository_creation_type\": \"all\",\n \"members_can_create_public_repositories\": false,\n \"members_can_create_private_repositories\": false,\n \"members_can_create_internal_repositories\": false,\n \"members_can_create_pages\": true,\n \"members_can_fork_private_repositories\": false\n}" + "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"twitter_username\": \"github\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"type\": \"Organization\",\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"private_gists\": 81,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"billing_email\": \"mona@github.com\",\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20,\n \"filled_seats\": 4,\n \"seats\": 5\n },\n \"default_repository_permission\": \"read\",\n \"members_can_create_repositories\": true,\n \"two_factor_requirement_enabled\": true,\n \"members_allowed_repository_creation_type\": \"all\",\n \"members_can_create_public_repositories\": false,\n \"members_can_create_private_repositories\": false,\n \"members_can_create_internal_repositories\": false,\n \"members_can_create_pages\": true\n}" }, { "httpStatusCode": "404", @@ -48323,16 +48333,6 @@ "rawDescription": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.", "childParamsGroups": [] }, - "members_can_fork_private_repositories": { - "type": "boolean", - "description": "

Toggles whether organization members can fork private organization repositories. Can be one of:
\n* true - all organization members can fork private repositories within the organization.
\n* false - no organization members can fork private repositories within the organization.

", - "default": false, - "name": "members_can_fork_private_repositories", - "in": "body", - "rawType": "boolean", - "rawDescription": "Toggles whether organization members can fork private organization repositories. Can be one of: \n\\* `true` - all organization members can fork private repositories within the organization. \n\\* `false` - no organization members can fork private repositories within the organization.", - "childParamsGroups": [] - }, "blog": { "type": "string", "example": "\"http://github.blog\"", @@ -48378,7 +48378,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "

Response

", - "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"twitter_username\": \"github\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"type\": \"Organization\",\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"private_gists\": 81,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"billing_email\": \"mona@github.com\",\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20\n },\n \"default_repository_permission\": \"read\",\n \"members_can_create_repositories\": true,\n \"two_factor_requirement_enabled\": true,\n \"members_allowed_repository_creation_type\": \"all\",\n \"members_can_create_public_repositories\": false,\n \"members_can_create_private_repositories\": false,\n \"members_can_create_internal_repositories\": false,\n \"members_can_create_pages\": true,\n \"members_can_create_public_pages\": true,\n \"members_can_create_private_pages\": true,\n \"members_can_fork_private_repositories\": false,\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n}" + "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"twitter_username\": \"github\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"type\": \"Organization\",\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"private_gists\": 81,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"billing_email\": \"mona@github.com\",\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20\n },\n \"default_repository_permission\": \"read\",\n \"members_can_create_repositories\": true,\n \"two_factor_requirement_enabled\": true,\n \"members_allowed_repository_creation_type\": \"all\",\n \"members_can_create_public_repositories\": false,\n \"members_can_create_private_repositories\": false,\n \"members_can_create_internal_repositories\": false,\n \"members_can_create_pages\": true,\n \"members_can_create_public_pages\": true,\n \"members_can_create_private_pages\": true,\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n}" }, { "httpStatusCode": "409", @@ -48550,16 +48550,6 @@ "rawDescription": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.", "childParamsGroups": [] }, - { - "type": "boolean", - "description": "

Toggles whether organization members can fork private organization repositories. Can be one of:
\n* true - all organization members can fork private repositories within the organization.
\n* false - no organization members can fork private repositories within the organization.

", - "default": false, - "name": "members_can_fork_private_repositories", - "in": "body", - "rawType": "boolean", - "rawDescription": "Toggles whether organization members can fork private organization repositories. Can be one of: \n\\* `true` - all organization members can fork private repositories within the organization. \n\\* `false` - no organization members can fork private repositories within the organization.", - "childParamsGroups": [] - }, { "type": "string", "example": "\"http://github.blog\"", @@ -56861,16 +56851,6 @@ ] }, "examples": { - "example-for-a-single-line-comment": { - "summary": "Example for a single-line comment", - "value": { - "body": "Let's add this deleted line back.", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "path": "file1.txt", - "line": 5, - "side": "LEFT" - } - }, "example-for-a-multi-line-comment": { "summary": "Example for a multi-line comment", "value": { @@ -58981,8 +58961,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -59005,7 +58989,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

Response

", + "description": "

Response when the reaction type has already been added to this team discussion comment

", "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}" }, { @@ -59308,8 +59292,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -59704,7 +59692,11 @@ ] }, "example": { - "content": "heart" + "default": { + "value": { + "content": "heart" + } + } } } } @@ -60036,8 +60028,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -60369,8 +60365,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -60697,8 +60697,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -61026,8 +61030,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -70465,10 +70473,14 @@ "name" ] }, - "example": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" + } + } } } } @@ -70489,7 +70501,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

Response

", + "description": "

Response when the updated information already exists

", "payload": "{\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"members_count\": 3,\n \"repos_count\": 10,\n \"created_at\": \"2017-07-14T16:53:42Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"type\": \"Organization\"\n },\n \"ldap_dn\": \"uid=asdf,ou=users,dc=github,dc=com\"\n}" }, { diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index 0fab584b6b..7291d01640 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -22634,7 +22634,13 @@ "httpStatusCode": "201", "httpStatusMessage": "Created", "description": "Response for completed conclusion", - "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" + "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"42\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" + }, + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response for completed conclusion", + "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"42\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"in_progress\",\n \"conclusion\": null,\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": null,\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" } ], "bodyParameters": [ @@ -26156,8 +26162,12 @@ "head_sha" ] }, - "example": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + "examples": { + "default": { + "value": { + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + } + } } } } @@ -26176,7 +26186,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

when the suite already existed

", + "description": "

Response when the suite already exists

", "payload": "{\n \"id\": 5,\n \"node_id\": \"MDEwOkNoZWNrU3VpdGU1\",\n \"head_branch\": \"master\",\n \"head_sha\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-suites/5\",\n \"before\": \"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\n \"after\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"pull_requests\": [],\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"template_repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World-Template\",\n \"full_name\": \"octocat/Hello-World-Template\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks\": 9,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues\": 0,\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"visibility\": \"public\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n \"allow_squash_merge\": true,\n \"allow_auto_merge\": false,\n \"delete_branch_on_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0\n },\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": false,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"visibility\": \"public\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n \"delete_branch_on_merge\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0\n },\n \"head_commit\": {\n \"id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"tree_id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"message\": \"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\n \"timestamp\": \"2016-10-10T00:00:00Z\",\n \"author\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n },\n \"committer\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n }\n },\n \"latest_check_runs_count\": 1,\n \"check_runs_url\": \"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"\n}" }, { @@ -47992,7 +48002,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"twitter_username\": \"github\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"type\": \"Organization\",\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"private_gists\": 81,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"billing_email\": \"mona@github.com\",\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20,\n \"filled_seats\": 4,\n \"seats\": 5\n },\n \"default_repository_permission\": \"read\",\n \"members_can_create_repositories\": true,\n \"two_factor_requirement_enabled\": true,\n \"members_allowed_repository_creation_type\": \"all\",\n \"members_can_create_public_repositories\": false,\n \"members_can_create_private_repositories\": false,\n \"members_can_create_internal_repositories\": false,\n \"members_can_create_pages\": true,\n \"members_can_fork_private_repositories\": false\n}" + "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"twitter_username\": \"github\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2014-03-03T18:58:10Z\",\n \"type\": \"Organization\",\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"private_gists\": 81,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"billing_email\": \"mona@github.com\",\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20,\n \"filled_seats\": 4,\n \"seats\": 5\n },\n \"default_repository_permission\": \"read\",\n \"members_can_create_repositories\": true,\n \"two_factor_requirement_enabled\": true,\n \"members_allowed_repository_creation_type\": \"all\",\n \"members_can_create_public_repositories\": false,\n \"members_can_create_private_repositories\": false,\n \"members_can_create_internal_repositories\": false,\n \"members_can_create_pages\": true\n}" }, { "httpStatusCode": "404", @@ -48192,16 +48202,6 @@ "rawDescription": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.", "childParamsGroups": [] }, - "members_can_fork_private_repositories": { - "type": "boolean", - "description": "

Toggles whether organization members can fork private organization repositories. Can be one of:
\n* true - all organization members can fork private repositories within the organization.
\n* false - no organization members can fork private repositories within the organization.

", - "default": false, - "name": "members_can_fork_private_repositories", - "in": "body", - "rawType": "boolean", - "rawDescription": "Toggles whether organization members can fork private organization repositories. Can be one of: \n\\* `true` - all organization members can fork private repositories within the organization. \n\\* `false` - no organization members can fork private repositories within the organization.", - "childParamsGroups": [] - }, "blog": { "type": "string", "example": "\"http://github.blog\"", @@ -48242,7 +48242,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "

Response

", - "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"twitter_username\": \"github\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"type\": \"Organization\",\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"private_gists\": 81,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"billing_email\": \"mona@github.com\",\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20\n },\n \"default_repository_permission\": \"read\",\n \"members_can_create_repositories\": true,\n \"two_factor_requirement_enabled\": true,\n \"members_allowed_repository_creation_type\": \"all\",\n \"members_can_create_public_repositories\": false,\n \"members_can_create_private_repositories\": false,\n \"members_can_create_internal_repositories\": false,\n \"members_can_create_pages\": true,\n \"members_can_create_public_pages\": true,\n \"members_can_create_private_pages\": true,\n \"members_can_fork_private_repositories\": false,\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n}" + "payload": "{\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"twitter_username\": \"github\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"type\": \"Organization\",\n \"total_private_repos\": 100,\n \"owned_private_repos\": 100,\n \"private_gists\": 81,\n \"disk_usage\": 10000,\n \"collaborators\": 8,\n \"billing_email\": \"mona@github.com\",\n \"plan\": {\n \"name\": \"Medium\",\n \"space\": 400,\n \"private_repos\": 20\n },\n \"default_repository_permission\": \"read\",\n \"members_can_create_repositories\": true,\n \"two_factor_requirement_enabled\": true,\n \"members_allowed_repository_creation_type\": \"all\",\n \"members_can_create_public_repositories\": false,\n \"members_can_create_private_repositories\": false,\n \"members_can_create_internal_repositories\": false,\n \"members_can_create_pages\": true,\n \"members_can_create_public_pages\": true,\n \"members_can_create_private_pages\": true,\n \"updated_at\": \"2014-03-03T18:58:10Z\"\n}" }, { "httpStatusCode": "409", @@ -48414,16 +48414,6 @@ "rawDescription": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.", "childParamsGroups": [] }, - { - "type": "boolean", - "description": "

Toggles whether organization members can fork private organization repositories. Can be one of:
\n* true - all organization members can fork private repositories within the organization.
\n* false - no organization members can fork private repositories within the organization.

", - "default": false, - "name": "members_can_fork_private_repositories", - "in": "body", - "rawType": "boolean", - "rawDescription": "Toggles whether organization members can fork private organization repositories. Can be one of: \n\\* `true` - all organization members can fork private repositories within the organization. \n\\* `false` - no organization members can fork private repositories within the organization.", - "childParamsGroups": [] - }, { "type": "string", "example": "\"http://github.blog\"", @@ -56640,16 +56630,6 @@ ] }, "examples": { - "example-for-a-single-line-comment": { - "summary": "Example for a single-line comment", - "value": { - "body": "Let's add this deleted line back.", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "path": "file1.txt", - "line": 5, - "side": "LEFT" - } - }, "example-for-a-multi-line-comment": { "summary": "Example for a multi-line comment", "value": { @@ -58749,8 +58729,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -58768,7 +58752,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

Response

", + "description": "

Response when the reaction type has already been added to this team discussion comment

", "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}" }, { @@ -59061,8 +59045,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -59437,7 +59425,11 @@ ] }, "example": { - "content": "heart" + "default": { + "value": { + "content": "heart" + } + } } } } @@ -59754,8 +59746,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -60072,8 +60068,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -60385,8 +60385,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -60699,8 +60703,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -70835,10 +70843,14 @@ "name" ] }, - "example": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" + } + } } } } @@ -70859,7 +70871,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

Response

", + "description": "

Response when the updated information already exists

", "payload": "{\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"members_count\": 3,\n \"repos_count\": 10,\n \"created_at\": \"2017-07-14T16:53:42Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"type\": \"Organization\"\n },\n \"ldap_dn\": \"uid=asdf,ou=users,dc=github,dc=com\"\n}" }, { diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index d93e88a35c..982d09a8f8 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -24098,7 +24098,13 @@ "httpStatusCode": "201", "httpStatusMessage": "Created", "description": "Response for completed conclusion", - "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" + "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"42\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" + }, + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response for completed conclusion", + "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"42\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"in_progress\",\n \"conclusion\": null,\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": null,\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" } ], "bodyParameters": [ @@ -27614,8 +27620,12 @@ "head_sha" ] }, - "example": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + "examples": { + "default": { + "value": { + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + } + } } } } @@ -27634,7 +27644,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

when the suite already existed

", + "description": "

Response when the suite already exists

", "payload": "{\n \"id\": 5,\n \"node_id\": \"MDEwOkNoZWNrU3VpdGU1\",\n \"head_branch\": \"master\",\n \"head_sha\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-suites/5\",\n \"before\": \"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\n \"after\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"pull_requests\": [],\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"template_repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World-Template\",\n \"full_name\": \"octocat/Hello-World-Template\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks\": 9,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues\": 0,\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"visibility\": \"public\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n \"allow_squash_merge\": true,\n \"allow_auto_merge\": false,\n \"delete_branch_on_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0\n },\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": false,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"visibility\": \"public\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n \"delete_branch_on_merge\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0\n },\n \"head_commit\": {\n \"id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"tree_id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"message\": \"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\n \"timestamp\": \"2016-10-10T00:00:00Z\",\n \"author\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n },\n \"committer\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n }\n },\n \"latest_check_runs_count\": 1,\n \"check_runs_url\": \"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"\n}" }, { @@ -60185,16 +60195,6 @@ ] }, "examples": { - "example-for-a-single-line-comment": { - "summary": "Example for a single-line comment", - "value": { - "body": "Let's add this deleted line back.", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "path": "file1.txt", - "line": 5, - "side": "LEFT" - } - }, "example-for-a-multi-line-comment": { "summary": "Example for a multi-line comment", "value": { @@ -62294,8 +62294,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -62313,7 +62317,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

Response

", + "description": "

Response when the reaction type has already been added to this team discussion comment

", "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}" }, { @@ -62606,8 +62610,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -62982,7 +62990,11 @@ ] }, "example": { - "content": "heart" + "default": { + "value": { + "content": "heart" + } + } } } } @@ -63299,8 +63311,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -63617,8 +63633,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -63930,8 +63950,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -64244,8 +64268,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -74584,10 +74612,14 @@ "name" ] }, - "example": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" + } + } } } } @@ -74608,7 +74640,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

Response

", + "description": "

Response when the updated information already exists

", "payload": "{\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"members_count\": 3,\n \"repos_count\": 10,\n \"created_at\": \"2017-07-14T16:53:42Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"type\": \"Organization\"\n },\n \"ldap_dn\": \"uid=asdf,ou=users,dc=github,dc=com\"\n}" }, { diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 1a25a07267..5ef4c06a82 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -19308,7 +19308,13 @@ "httpStatusCode": "201", "httpStatusMessage": "Created", "description": "Response for completed conclusion", - "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" + "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"42\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": \"2018-05-04T01:14:52Z\",\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" + }, + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response for completed conclusion", + "payload": "{\n \"id\": 4,\n \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n \"node_id\": \"MDg6Q2hlY2tSdW40\",\n \"external_id\": \"42\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n \"details_url\": \"https://example.com\",\n \"status\": \"in_progress\",\n \"conclusion\": null,\n \"started_at\": \"2018-05-04T01:14:52Z\",\n \"completed_at\": null,\n \"output\": {\n \"title\": \"Mighty Readme report\",\n \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n \"annotations_count\": 2,\n \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n },\n \"name\": \"mighty_readme\",\n \"check_suite\": {\n \"id\": 5\n },\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"pull_requests\": [\n {\n \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n \"id\": 1934,\n \"number\": 3956,\n \"head\": {\n \"ref\": \"say-hello\",\n \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n },\n \"base\": {\n \"ref\": \"master\",\n \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n \"repo\": {\n \"id\": 526,\n \"url\": \"https://api.github.com/repos/github/hello-world\",\n \"name\": \"hello-world\"\n }\n }\n }\n ]\n}" } ], "bodyParameters": [ @@ -22824,8 +22830,12 @@ "head_sha" ] }, - "example": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + "examples": { + "default": { + "value": { + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + } + } } } } @@ -22844,7 +22854,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

when the suite already existed

", + "description": "

Response when the suite already exists

", "payload": "{\n \"id\": 5,\n \"node_id\": \"MDEwOkNoZWNrU3VpdGU1\",\n \"head_branch\": \"master\",\n \"head_sha\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"status\": \"completed\",\n \"conclusion\": \"neutral\",\n \"url\": \"https://api.github.com/repos/github/hello-world/check-suites/5\",\n \"before\": \"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\n \"after\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n \"pull_requests\": [],\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"app\": {\n \"id\": 1,\n \"slug\": \"octoapp\",\n \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n \"owner\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": true\n },\n \"name\": \"Octocat App\",\n \"description\": \"\",\n \"external_url\": \"https://example.com\",\n \"html_url\": \"https://github.com/apps/octoapp\",\n \"created_at\": \"2017-07-08T16:18:44-04:00\",\n \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n \"permissions\": {\n \"metadata\": \"read\",\n \"contents\": \"read\",\n \"issues\": \"write\",\n \"single_file\": \"write\"\n },\n \"events\": [\n \"push\",\n \"pull_request\"\n ]\n },\n \"repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"template_repository\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World-Template\",\n \"full_name\": \"octocat/Hello-World-Template\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks\": 9,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues\": 0,\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"visibility\": \"public\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n \"allow_squash_merge\": true,\n \"allow_auto_merge\": false,\n \"delete_branch_on_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0\n },\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"master\",\n \"open_issues_count\": 0,\n \"is_template\": false,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"visibility\": \"public\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n \"delete_branch_on_merge\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0\n },\n \"head_commit\": {\n \"id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"tree_id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n \"message\": \"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\n \"timestamp\": \"2016-10-10T00:00:00Z\",\n \"author\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n },\n \"committer\": {\n \"name\": \"The Octocat\",\n \"email\": \"octocat@nowhere.com\"\n }\n },\n \"latest_check_runs_count\": 1,\n \"check_runs_url\": \"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"\n}" }, { @@ -50513,16 +50523,6 @@ ] }, "examples": { - "example-for-a-single-line-comment": { - "summary": "Example for a single-line comment", - "value": { - "body": "Let's add this deleted line back.", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "path": "file1.txt", - "line": 5, - "side": "LEFT" - } - }, "example-for-a-multi-line-comment": { "summary": "Example for a multi-line comment", "value": { @@ -52627,8 +52627,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -52651,7 +52655,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

Response

", + "description": "

Response when the reaction type has already been added to this team discussion comment

", "payload": "{\n \"id\": 1,\n \"node_id\": \"MDg6UmVhY3Rpb24x\",\n \"user\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"content\": \"heart\",\n \"created_at\": \"2016-05-20T20:09:31Z\"\n}" }, { @@ -52954,8 +52958,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -53278,7 +53286,11 @@ ] }, "example": { - "content": "heart" + "default": { + "value": { + "content": "heart" + } + } } } } @@ -53610,8 +53622,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -53943,8 +53959,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -54271,8 +54291,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -54600,8 +54624,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -63902,10 +63930,14 @@ "name" ] }, - "example": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" + } + } } } } @@ -63926,7 +63958,7 @@ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "

Response

", + "description": "

Response when the updated information already exists

", "payload": "{\n \"id\": 1,\n \"node_id\": \"MDQ6VGVhbTE=\",\n \"url\": \"https://api.github.com/teams/1\",\n \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n \"name\": \"Justice League\",\n \"slug\": \"justice-league\",\n \"description\": \"A great team.\",\n \"privacy\": \"closed\",\n \"permission\": \"admin\",\n \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n \"parent\": null,\n \"members_count\": 3,\n \"repos_count\": 10,\n \"created_at\": \"2017-07-14T16:53:42Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"organization\": {\n \"login\": \"github\",\n \"id\": 1,\n \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n \"url\": \"https://api.github.com/orgs/github\",\n \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n \"events_url\": \"https://api.github.com/orgs/github/events\",\n \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"description\": \"A great organization\",\n \"name\": \"github\",\n \"company\": \"GitHub\",\n \"blog\": \"https://github.com/blog\",\n \"location\": \"San Francisco\",\n \"email\": \"octocat@github.com\",\n \"is_verified\": true,\n \"has_organization_projects\": true,\n \"has_repository_projects\": true,\n \"public_repos\": 2,\n \"public_gists\": 1,\n \"followers\": 20,\n \"following\": 0,\n \"html_url\": \"https://github.com/octocat\",\n \"created_at\": \"2008-01-14T04:33:35Z\",\n \"updated_at\": \"2017-08-17T12:37:15Z\",\n \"type\": \"Organization\"\n }\n}" }, { diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 31fe3d0202..c415e06dce 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -111781,15 +111781,19 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } }, "responses": { "200": { - "description": "Response", + "description": "Response when the reaction type has already been added to this team discussion comment", "content": { "application/json": { "schema": { @@ -112624,8 +112628,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -135754,6 +135762,96 @@ } } }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { + "post": { + "summary": "Re-run a job from a workflow run", + "description": "Re-run a job and its dependent jobs in a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/re-run-job-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#re-run-job-for-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "job_id", + "description": "job_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": { + }, + "additionalProperties": false + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, "/repos/{owner}/{repo}/actions/permissions": { "get": { "summary": "Get GitHub Actions permissions for a repository", @@ -155747,6 +155845,70 @@ "deprecated": true } }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": { + "post": { + "summary": "Re-run failed jobs from a workflow run", + "description": "Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/re-run-workflow-failed-jobs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/actions#re-run-workflow-failed-jobs" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": { + }, + "additionalProperties": false + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { "get": { "summary": "Get workflow run usage", @@ -179314,7 +179476,7 @@ "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "", + "external_id": "42", "url": "https://api.github.com/repos/github/hello-world/check-runs/4", "html_url": "https://github.com/github/hello-world/runs/4", "details_url": "https://example.com", @@ -179400,6 +179562,99 @@ } ] } + }, + "example-of-in-progress-conclusion": { + "summary": "Response for completed conclusion", + "value": { + "id": 4, + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "node_id": "MDg6Q2hlY2tSdW40", + "external_id": "42", + "url": "https://api.github.com/repos/github/hello-world/check-runs/4", + "html_url": "https://github.com/github/hello-world/runs/4", + "details_url": "https://example.com", + "status": "in_progress", + "conclusion": null, + "started_at": "2018-05-04T01:14:52Z", + "completed_at": null, + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notice.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations_count": 2, + "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" + }, + "name": "mighty_readme", + "check_suite": { + "id": 5 + }, + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/github/hello-world/pulls/1", + "id": 1934, + "number": 3956, + "head": { + "ref": "say-hello", + "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + }, + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + } } } } @@ -181944,15 +182199,19 @@ "head_sha" ] }, - "example": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + "examples": { + "default": { + "value": { + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + } + } } } } }, "responses": { "200": { - "description": "when the suite already existed", + "description": "Response when the suite already exists", "content": { "application/json": { "schema": { @@ -198803,9 +199062,13 @@ } } }, - "example": { - "repository_id": 1, - "ref": "main" + "examples": { + "default": { + "value": { + "repository_id": 1, + "ref": "main" + } + } } } } @@ -208316,7 +208579,11 @@ ] }, "example": { - "content": "heart" + "default": { + "value": { + "content": "heart" + } + } } } } @@ -249356,7 +249623,7 @@ }, "patch": { "summary": "Update an import", - "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.", + "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.", "tags": [ "migrations" ], @@ -249400,10 +249667,18 @@ }, "vcs": { "type": "string", + "description": "The type of version control system you are migrating from.", + "enum": [ + "subversion", + "tfvc", + "git", + "mercurial" + ], "example": "\"git\"" }, "tfvc_project": { "type": "string", + "description": "For a tfvc import, the name of the project that is being imported.", "example": "\"project1\"" } }, @@ -249411,11 +249686,22 @@ }, "examples": { "example-1": { - "summary": "Example 1", + "summary": "Update authentication for an import", "value": { "vcs_username": "octocat", "vcs_password": "secret" } + }, + "example-2": { + "summary": "Updating the project choice", + "value": { + "vcs": "tfvc", + "tfvc_project": "project1", + "human_name": "project1 (tfs)" + } + }, + "example-3": { + "summary": "Restarting an import" } } } @@ -249590,7 +249876,7 @@ "repository_url": "https://api.github.com/repos/octocat/socm" } }, - "response": { + "example-3": { "summary": "Response", "value": { "vcs": "subversion", @@ -263950,8 +264236,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -293714,8 +294004,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -325926,8 +326220,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -333255,9 +333553,13 @@ } } }, - "example": { - "repository_id": 1, - "ref": "main" + "examples": { + "default": { + "value": { + "repository_id": 1, + "ref": "main" + } + } } } } @@ -338656,16 +338958,6 @@ ] }, "examples": { - "example-for-a-single-line-comment": { - "summary": "Example for a single-line comment", - "value": { - "body": "Let's add this deleted line back.", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "path": "file1.txt", - "line": 5, - "side": "LEFT" - } - }, "example-for-a-multi-line-comment": { "summary": "Example for a multi-line comment", "value": { @@ -360049,8 +360341,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -386001,17 +386297,21 @@ "name" ] }, - "example": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" + } + } } } } }, "responses": { "200": { - "description": "Response", + "description": "Response when the updated information already exists", "content": { "application/json": { "schema": { @@ -403341,10 +403641,14 @@ } ] }, - "example": { - "repository_id": 1, - "ref": "main", - "location": "WestUs2" + "examples": { + "default": { + "value": { + "repository_id": 1, + "ref": "main", + "location": "WestUs2" + } + } } } } diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index eebd7b6146..d1b183f0a6 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -55227,11 +55227,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -55315,8 +55310,7 @@ "members_can_create_public_repositories": false, "members_can_create_private_repositories": false, "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_fork_private_repositories": false + "members_can_create_pages": true } } } @@ -55468,11 +55462,6 @@ "description": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.", "default": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "description": "Toggles whether organization members can fork private organization repositories. Can be one of: \n\\* `true` - all organization members can fork private repositories within the organization. \n\\* `false` - no organization members can fork private repositories within the organization.", - "default": false - }, "blog": { "type": "string", "example": "\"http://github.blog\"" @@ -55721,11 +55710,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -55808,7 +55792,6 @@ "members_can_create_pages": true, "members_can_create_public_pages": true, "members_can_create_private_pages": true, - "members_can_fork_private_repositories": false, "updated_at": "2014-03-03T18:58:10Z" } } @@ -82454,11 +82437,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -83088,11 +83066,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -83699,11 +83672,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -87514,15 +87482,19 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } }, "responses": { "200": { - "description": "Response", + "description": "Response when the reaction type has already been added to this team discussion comment", "content": { "application/json": { "schema": { @@ -88372,8 +88344,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -143275,7 +143251,7 @@ "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "", + "external_id": "42", "url": "https://api.github.com/repos/github/hello-world/check-runs/4", "html_url": "https://github.com/github/hello-world/runs/4", "details_url": "https://example.com", @@ -143361,6 +143337,99 @@ } ] } + }, + "example-of-in-progress-conclusion": { + "summary": "Response for completed conclusion", + "value": { + "id": 4, + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "node_id": "MDg6Q2hlY2tSdW40", + "external_id": "42", + "url": "https://api.github.com/repos/github/hello-world/check-runs/4", + "html_url": "https://github.com/github/hello-world/runs/4", + "details_url": "https://example.com", + "status": "in_progress", + "conclusion": null, + "started_at": "2018-05-04T01:14:52Z", + "completed_at": null, + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notice.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations_count": 2, + "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" + }, + "name": "mighty_readme", + "check_suite": { + "id": 5 + }, + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/github/hello-world/pulls/1", + "id": 1934, + "number": 3956, + "head": { + "ref": "say-hello", + "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + }, + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + } } } } @@ -145765,15 +145834,19 @@ "head_sha" ] }, - "example": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + "examples": { + "default": { + "value": { + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + } + } } } } }, "responses": { "200": { - "description": "when the suite already existed", + "description": "Response when the suite already exists", "content": { "application/json": { "schema": { @@ -164094,7 +164167,11 @@ ] }, "example": { - "content": "heart" + "default": { + "value": { + "content": "heart" + } + } } } } @@ -214471,8 +214548,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -244225,8 +244306,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -276304,8 +276389,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -284255,16 +284344,6 @@ ] }, "examples": { - "example-for-a-single-line-comment": { - "summary": "Example for a single-line comment", - "value": { - "body": "Let's add this deleted line back.", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "path": "file1.txt", - "line": 5, - "side": "LEFT" - } - }, "example-for-a-multi-line-comment": { "summary": "Example for a multi-line comment", "value": { @@ -324542,11 +324621,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -324756,17 +324830,21 @@ "name" ] }, - "example": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" + } + } } } } }, "responses": { "200": { - "description": "Response", + "description": "Response when the updated information already exists", "content": { "application/json": { "schema": { @@ -325150,11 +325228,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -325648,11 +325721,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -359654,11 +359722,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index 0619a825c6..3a7d18b4d5 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -56210,11 +56210,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -56298,8 +56293,7 @@ "members_can_create_public_repositories": false, "members_can_create_private_repositories": false, "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_fork_private_repositories": false + "members_can_create_pages": true } } } @@ -56451,11 +56445,6 @@ "description": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.", "default": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "description": "Toggles whether organization members can fork private organization repositories. Can be one of: \n\\* `true` - all organization members can fork private repositories within the organization. \n\\* `false` - no organization members can fork private repositories within the organization.", - "default": false - }, "blog": { "type": "string", "example": "\"http://github.blog\"" @@ -56704,11 +56693,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -56791,7 +56775,6 @@ "members_can_create_pages": true, "members_can_create_public_pages": true, "members_can_create_private_pages": true, - "members_can_fork_private_repositories": false, "updated_at": "2014-03-03T18:58:10Z" } } @@ -84409,11 +84392,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -85043,11 +85021,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -85654,11 +85627,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -89469,15 +89437,19 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } }, "responses": { "200": { - "description": "Response", + "description": "Response when the reaction type has already been added to this team discussion comment", "content": { "application/json": { "schema": { @@ -90327,8 +90299,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -146930,7 +146906,7 @@ "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "", + "external_id": "42", "url": "https://api.github.com/repos/github/hello-world/check-runs/4", "html_url": "https://github.com/github/hello-world/runs/4", "details_url": "https://example.com", @@ -147016,6 +146992,99 @@ } ] } + }, + "example-of-in-progress-conclusion": { + "summary": "Response for completed conclusion", + "value": { + "id": 4, + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "node_id": "MDg6Q2hlY2tSdW40", + "external_id": "42", + "url": "https://api.github.com/repos/github/hello-world/check-runs/4", + "html_url": "https://github.com/github/hello-world/runs/4", + "details_url": "https://example.com", + "status": "in_progress", + "conclusion": null, + "started_at": "2018-05-04T01:14:52Z", + "completed_at": null, + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notice.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations_count": 2, + "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" + }, + "name": "mighty_readme", + "check_suite": { + "id": 5 + }, + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/github/hello-world/pulls/1", + "id": 1934, + "number": 3956, + "head": { + "ref": "say-hello", + "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + }, + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + } } } } @@ -149420,15 +149489,19 @@ "head_sha" ] }, - "example": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + "examples": { + "default": { + "value": { + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + } + } } } } }, "responses": { "200": { - "description": "when the suite already existed", + "description": "Response when the suite already exists", "content": { "application/json": { "schema": { @@ -167828,7 +167901,11 @@ ] }, "example": { - "content": "heart" + "default": { + "value": { + "content": "heart" + } + } } } } @@ -221198,8 +221275,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -251006,8 +251087,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -283123,8 +283208,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -291074,16 +291163,6 @@ ] }, "examples": { - "example-for-a-single-line-comment": { - "summary": "Example for a single-line comment", - "value": { - "body": "Let's add this deleted line back.", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "path": "file1.txt", - "line": 5, - "side": "LEFT" - } - }, "example-for-a-multi-line-comment": { "summary": "Example for a multi-line comment", "value": { @@ -312249,8 +312328,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -332908,11 +332991,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -333122,17 +333200,21 @@ "name" ] }, - "example": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" + } + } } } } }, "responses": { "200": { - "description": "Response", + "description": "Response when the updated information already exists", "content": { "application/json": { "schema": { @@ -333516,11 +333598,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -334014,11 +334091,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -368125,11 +368197,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 0b416ccd60..1695f69175 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -56445,11 +56445,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -56533,8 +56528,7 @@ "members_can_create_public_repositories": false, "members_can_create_private_repositories": false, "members_can_create_internal_repositories": false, - "members_can_create_pages": true, - "members_can_fork_private_repositories": false + "members_can_create_pages": true } } } @@ -56681,11 +56675,6 @@ "description": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.", "default": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "description": "Toggles whether organization members can fork private organization repositories. Can be one of: \n\\* `true` - all organization members can fork private repositories within the organization. \n\\* `false` - no organization members can fork private repositories within the organization.", - "default": false - }, "blog": { "type": "string", "example": "\"http://github.blog\"" @@ -56934,11 +56923,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -57021,7 +57005,6 @@ "members_can_create_pages": true, "members_can_create_public_pages": true, "members_can_create_private_pages": true, - "members_can_fork_private_repositories": false, "updated_at": "2014-03-03T18:58:10Z" } } @@ -87478,11 +87461,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -88112,11 +88090,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -88723,11 +88696,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -92485,15 +92453,19 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } }, "responses": { "200": { - "description": "Response", + "description": "Response when the reaction type has already been added to this team discussion comment", "content": { "application/json": { "schema": { @@ -93328,8 +93300,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -149798,7 +149774,7 @@ "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "", + "external_id": "42", "url": "https://api.github.com/repos/github/hello-world/check-runs/4", "html_url": "https://github.com/github/hello-world/runs/4", "details_url": "https://example.com", @@ -149884,6 +149860,99 @@ } ] } + }, + "example-of-in-progress-conclusion": { + "summary": "Response for completed conclusion", + "value": { + "id": 4, + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "node_id": "MDg6Q2hlY2tSdW40", + "external_id": "42", + "url": "https://api.github.com/repos/github/hello-world/check-runs/4", + "html_url": "https://github.com/github/hello-world/runs/4", + "details_url": "https://example.com", + "status": "in_progress", + "conclusion": null, + "started_at": "2018-05-04T01:14:52Z", + "completed_at": null, + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notice.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations_count": 2, + "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" + }, + "name": "mighty_readme", + "check_suite": { + "id": 5 + }, + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/github/hello-world/pulls/1", + "id": 1934, + "number": 3956, + "head": { + "ref": "say-hello", + "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + }, + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + } } } } @@ -152434,15 +152503,19 @@ "head_sha" ] }, - "example": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + "examples": { + "default": { + "value": { + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + } + } } } } }, "responses": { "200": { - "description": "when the suite already existed", + "description": "Response when the suite already exists", "content": { "application/json": { "schema": { @@ -170815,7 +170888,11 @@ ] }, "example": { - "content": "heart" + "default": { + "value": { + "content": "heart" + } + } } } } @@ -224075,8 +224152,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -253839,8 +253920,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -286058,8 +286143,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -293989,16 +294078,6 @@ ] }, "examples": { - "example-for-a-single-line-comment": { - "summary": "Example for a single-line comment", - "value": { - "body": "Let's add this deleted line back.", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "path": "file1.txt", - "line": 5, - "side": "LEFT" - } - }, "example-for-a-multi-line-comment": { "summary": "Example for a multi-line comment", "value": { @@ -315292,8 +315371,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -336087,11 +336170,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -336301,17 +336379,21 @@ "name" ] }, - "example": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" + } + } } } } }, "responses": { "200": { - "description": "Response", + "description": "Response when the updated information already exists", "content": { "application/json": { "schema": { @@ -336695,11 +336777,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -337193,11 +337270,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" @@ -371201,11 +371273,6 @@ "type": "boolean", "example": true }, - "members_can_fork_private_repositories": { - "type": "boolean", - "example": false, - "nullable": true - }, "updated_at": { "type": "string", "format": "date-time" diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index 4a3c569c26..3b17b2d209 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -102709,15 +102709,19 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } }, "responses": { "200": { - "description": "Response", + "description": "Response when the reaction type has already been added to this team discussion comment", "content": { "application/json": { "schema": { @@ -103552,8 +103556,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -163206,7 +163214,7 @@ "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "", + "external_id": "42", "url": "https://api.github.com/repos/github/hello-world/check-runs/4", "html_url": "https://github.com/github/hello-world/runs/4", "details_url": "https://example.com", @@ -163292,6 +163300,99 @@ } ] } + }, + "example-of-in-progress-conclusion": { + "summary": "Response for completed conclusion", + "value": { + "id": 4, + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "node_id": "MDg6Q2hlY2tSdW40", + "external_id": "42", + "url": "https://api.github.com/repos/github/hello-world/check-runs/4", + "html_url": "https://github.com/github/hello-world/runs/4", + "details_url": "https://example.com", + "status": "in_progress", + "conclusion": null, + "started_at": "2018-05-04T01:14:52Z", + "completed_at": null, + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notice.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations_count": 2, + "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" + }, + "name": "mighty_readme", + "check_suite": { + "id": 5 + }, + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/github/hello-world/pulls/1", + "id": 1934, + "number": 3956, + "head": { + "ref": "say-hello", + "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + }, + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + } } } } @@ -165836,15 +165937,19 @@ "head_sha" ] }, - "example": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + "examples": { + "default": { + "value": { + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + } + } } } } }, "responses": { "200": { - "description": "when the suite already existed", + "description": "Response when the suite already exists", "content": { "application/json": { "schema": { @@ -184323,7 +184428,11 @@ ] }, "example": { - "content": "heart" + "default": { + "value": { + "content": "heart" + } + } } } } @@ -237704,8 +237813,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -267468,8 +267581,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -299687,8 +299804,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -307618,16 +307739,6 @@ ] }, "examples": { - "example-for-a-single-line-comment": { - "summary": "Example for a single-line comment", - "value": { - "body": "Let's add this deleted line back.", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "path": "file1.txt", - "line": 5, - "side": "LEFT" - } - }, "example-for-a-multi-line-comment": { "summary": "Example for a multi-line comment", "value": { @@ -328921,8 +329032,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -350127,17 +350242,21 @@ "name" ] }, - "example": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" + } + } } } } }, "responses": { "200": { - "description": "Response", + "description": "Response when the updated information already exists", "content": { "application/json": { "schema": { diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index e6e2d60cf6..2df8027364 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -70505,15 +70505,19 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } }, "responses": { "200": { - "description": "Response", + "description": "Response when the reaction type has already been added to this team discussion comment", "content": { "application/json": { "schema": { @@ -71363,8 +71367,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -132858,7 +132866,7 @@ "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "", + "external_id": "42", "url": "https://api.github.com/repos/github/hello-world/check-runs/4", "html_url": "https://github.com/github/hello-world/runs/4", "details_url": "https://example.com", @@ -132944,6 +132952,99 @@ } ] } + }, + "example-of-in-progress-conclusion": { + "summary": "Response for completed conclusion", + "value": { + "id": 4, + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "node_id": "MDg6Q2hlY2tSdW40", + "external_id": "42", + "url": "https://api.github.com/repos/github/hello-world/check-runs/4", + "html_url": "https://github.com/github/hello-world/runs/4", + "details_url": "https://example.com", + "status": "in_progress", + "conclusion": null, + "started_at": "2018-05-04T01:14:52Z", + "completed_at": null, + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notice.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations_count": 2, + "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" + }, + "name": "mighty_readme", + "check_suite": { + "id": 5 + }, + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/github/hello-world/pulls/1", + "id": 1934, + "number": 3956, + "head": { + "ref": "say-hello", + "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + }, + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + } } } } @@ -135488,15 +135589,19 @@ "head_sha" ] }, - "example": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + "examples": { + "default": { + "value": { + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + } + } } } } }, "responses": { "200": { - "description": "when the suite already existed", + "description": "Response when the suite already exists", "content": { "application/json": { "schema": { @@ -154033,7 +154138,11 @@ ] }, "example": { - "content": "heart" + "default": { + "value": { + "content": "heart" + } + } } } } @@ -205092,8 +205201,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -234871,8 +234984,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -266724,8 +266841,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -274665,16 +274786,6 @@ ] }, "examples": { - "example-for-a-single-line-comment": { - "summary": "Example for a single-line comment", - "value": { - "body": "Let's add this deleted line back.", - "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e", - "path": "file1.txt", - "line": 5, - "side": "LEFT" - } - }, "example-for-a-multi-line-comment": { "summary": "Example for a multi-line comment", "value": { @@ -295859,8 +295970,12 @@ "content" ] }, - "example": { - "content": "heart" + "examples": { + "default": { + "value": { + "content": "heart" + } + } } } } @@ -314028,17 +314143,21 @@ "name" ] }, - "example": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" + "examples": { + "default": { + "value": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" + } + } } } } }, "responses": { "200": { - "description": "Response", + "description": "Response when the updated information already exists", "content": { "application/json": { "schema": {