{ "basePath": "/", "definitions": { "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_20PATCH.body": { "properties": { "allow_merge_commit": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to allow merging pull requests with a merge commit, or ```false``` to prevent merging pull requests with merge commits. Default: ```true```" ] }, "allow_rebase_merge": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to allow rebase-merging pull requests, or ```false``` to prevent rebase-merging. Default: ```true```" ] }, "allow_squash_merge": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to allow squash-merging pull requests, or ```false``` to prevent squash-merging. Default: ```true```" ] }, "archived": { "default": false, "type": "boolean", "x-swgg-descriptionLineList": [ "```true``` to archive this repository. **Note**: You cannot unarchive repositories through the API. Default: ```false```" ] }, "default_branch": { "type": "string", "x-swgg-descriptionLineList": [ "Updates the default branch for this repository." ] }, "description": { "default": "This is your first repository", "type": "string", "x-swgg-descriptionLineList": [ "A short description of the repository." ] }, "has_issues": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to enable issues for this repository or ```false``` to disable them. Default: ```true```." ] }, "has_projects": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to enable projects for this repository or ```false``` to disable them. Default: ```true```. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is ```false```, and if you pass ```true```, the API returns an error." ] }, "has_wiki": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to enable the wiki for this repository or ```false``` to disable it. Default: ```true```." ] }, "homepage": { "default": "https://github.com", "type": "string", "x-swgg-descriptionLineList": [ "A URL with more information about the repository." ] }, "name": { "default": "Hello-World", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The name of the repository." ] }, "private": { "default": false, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to make the repository private or ```false``` to make it public. Creating private repositories requires a paid GitHub account. Default: ```false```.", "**Note**: You will get a ```422``` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private." ] } }, "required": [ "name" ], "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT.body": { "properties": { "enforce_admins": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "**Required**. Enforce all configured restrictions for administrators. Set to ```true``` to enforce required status checks for repository administrators. Set to ```null``` to disable." ] }, "required_pull_request_reviews": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT.body.required_pull_request_reviews", "type": "object", "x-swgg-descriptionLineList": [ "**Required**. Require at least one approving review on a pull request, before merging. Set to ```null``` to disable." ] }, "required_status_checks": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT.body.required_status_checks", "type": "object", "x-swgg-descriptionLineList": [ "**Required**. Require status checks to pass before merging. Set to ```null``` to disable." ] }, "restrictions": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT.body.restrictions", "type": "object", "x-swgg-descriptionLineList": [ "**Required**. Restrict who can push to this branch. Team and user ```restrictions``` are only available for organization-owned repositories. Set to ```null``` to disable." ] } }, "required": [ "required_status_checks", "enforce_admins", "required_pull_request_reviews", "restrictions" ], "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT.body.required_pull_request_reviews": { "properties": { "dismiss_stale_reviews": { "default": true, "type": "boolean" }, "dismissal_restrictions": { "default": { "teams": [ "justice-league" ], "users": [ "octocat" ] }, "type": "object" }, "require_code_owner_reviews": { "default": true, "type": "boolean" }, "required_approving_review_count": { "default": 2, "type": "number" } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT.body.required_status_checks": { "properties": { "contexts": { "default": [ "continuous-integration/travis-ci" ], "items": { "type": "string" }, "type": "array" }, "strict": { "default": true, "type": "boolean" } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT.body.restrictions": { "properties": { "teams": { "default": [ "justice-league" ], "items": { "type": "string" }, "type": "array" }, "users": { "default": [ "octocat" ], "items": { "type": "string" }, "type": "array" } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_pull_request_reviews_20PATCH.body": { "properties": { "dismiss_stale_reviews": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Set to ```true``` if you want to automatically dismiss approving reviews when someone pushes a new commit." ] }, "dismissal_restrictions": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_pull_request_reviews_20PATCH.body.dismissal_restrictions", "type": "object", "x-swgg-descriptionLineList": [ "Specify which users and teams can dismiss pull request reviews. Pass an empty ```dismissal_restrictions``` object to disable. User and team ```dismissal_restrictions``` are only available for organization-owned repositories. Omit this parameter for personal repositories." ] }, "require_code_owner_reviews": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Blocks merging pull requests until code owners have reviewed." ] }, "required_approving_review_count": { "default": 2, "type": "integer", "x-swgg-descriptionLineList": [ "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6." ] } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_pull_request_reviews_20PATCH.body.dismissal_restrictions": { "properties": { "teams": { "default": [ "justice-league" ], "items": { "type": "string" }, "type": "array" }, "users": { "default": [ "octocat" ], "items": { "type": "string" }, "type": "array" } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_status_checks_20PATCH.body": { "properties": { "contexts": { "default": [ "continuous-integration/travis-ci" ], "items": { "type": "string" }, "type": "array", "x-swgg-descriptionLineList": [ "The list of status checks to require in order to merge into this branch" ] }, "strict": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Require branches to be up to date before merging." ] } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcomments_2F_7Bid_7D_20PATCH.body": { "properties": { "body": { "default": "Nice change", "type": "string" } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcommits_2F_7Bsha_7D_2Fcomments_20POST.body": { "properties": { "body": { "default": "Great stuff", "type": "string" }, "line": { "default": null, "type": "integer", "x-swgg-descriptionLineList": [ "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on." ] }, "path": { "default": "file1.txt", "type": "string", "x-swgg-descriptionLineList": [ "Relative path of the file to comment on." ] }, "position": { "default": 4, "type": "integer", "x-swgg-descriptionLineList": [ "Line index in the diff to comment on." ] } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20DELETE.body": { "properties": { "branch": { "default": "master", "type": "string", "x-swgg-descriptionLineList": [ "The branch name. Default: the repository’s default branch (usually ```master```)" ] }, "committer": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20DELETE.body.committer" }, "message": { "default": "my commit message", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The commit message." ] }, "sha": { "default": "329688480d39049927147c162b9d2deaf885005f", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The blob SHA of the file being replaced." ] } }, "required": [ "message", "sha" ], "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20DELETE.body.committer": { "properties": { "email": { "default": "schacon@gmail.com", "type": "string" }, "name": { "default": "Scott Chacon", "type": "string" } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20PUT.body": { "properties": { "branch": { "default": "master", "type": "string", "x-swgg-descriptionLineList": [ "The branch name. Default: the repository’s default branch (usually ```master```)" ] }, "committer": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20PUT.body.committer" }, "content": { "default": "bXkgbmV3IGZpbGUgY29udGVudHM=", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The new file content, Base64 encoded." ] }, "message": { "default": "my commit message", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The commit message." ] } }, "required": [ "message", "content" ], "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20PUT.body.committer": { "properties": { "email": { "default": "schacon@gmail.com", "type": "string" }, "name": { "default": "Scott Chacon", "type": "string" } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_231_20PUT.body": { "properties": { "branch": { "default": "master", "type": "string", "x-swgg-descriptionLineList": [ "The branch name. Default: the repository’s default branch (usually ```master```)" ] }, "committer": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_231_20PUT.body.committer" }, "content": { "default": "bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The updated file content, Base64 encoded." ] }, "message": { "default": "my commit message", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The commit message." ] }, "sha": { "default": "329688480d39049927147c162b9d2deaf885005f", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The blob SHA of the file being replaced." ] } }, "required": [ "message", "content", "sha" ], "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_231_20PUT.body.committer": { "properties": { "email": { "default": "schacon@gmail.com", "type": "string" }, "name": { "default": "Scott Chacon", "type": "string" } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fdeployments_2F_7Bid_7D_2Fstatuses_20POST.body": { "properties": { "auto_inactive": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Adds a new ```inactive``` status to all non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. Default: ```true``` **This parameter requires a custom media type to be specified. Please see more in the alert below.**" ] }, "description": { "default": "Deployment finished successfully.", "type": "string", "x-swgg-descriptionLineList": [ "A short description of the status. Maximum length of 140 characters. Default: ```\"\"```" ] }, "environment_url": { "type": "string", "x-swgg-descriptionLineList": [ "Sets the URL for accessing your environment. Default: ```\"\"``` **This parameter requires a custom media type to be specified. Please see more in the alert below.**" ] }, "log_url": { "type": "string", "x-swgg-descriptionLineList": [ "This is functionally equivalent to ```target_url```. We will continue accept ```target_url``` to support legacy uses, but we recommend modifying this to the new name to avoid confusion. Default: ```\"\"``` **This parameter requires a custom media type to be specified. Please see more in the alert below.**" ] }, "state": { "default": "success", "enum": [ "error", "failure", "inactive", "pending", "success" ], "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The state of the status. Can be one of ```error```, ```failure```, ```inactive```, ```pending```, or ```success```. **The ```inactive``` state requires a custom media type to be specified. Please see more in the alert below.**" ] }, "target_url": { "default": "https://example.com/deployment/42/output", "type": "string", "x-swgg-descriptionLineList": [ "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Default: ```\"\"```" ] } }, "required": [ "state" ], "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_20POST.body": { "properties": { "active": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Determines if notifications are sent when the webhook is triggered. Set to ```true``` to send notifications. Default: ```true```." ] }, "config": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_20POST.body.config", "type": "object", "x-swgg-descriptionLineList": [ "**Required**. Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params)." ] }, "events": { "default": [ "push" ], "items": { "type": "string" }, "type": "array", "x-swgg-descriptionLineList": [ "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. Default: ```[\"push\"]```" ] }, "name": { "default": "web", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. Must be passed as \"web\"." ] } }, "required": [ "name", "config" ], "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_20POST.body.config": { "properties": { "content_type": { "default": "json", "type": "string" }, "url": { "default": "http://example.com/webhook", "type": "string" } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_2F_7Bid_7D_20PATCH.body": { "properties": { "active": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Determines if notifications are sent when the webhook is triggered. Set to ```true``` to send notifications. Default: ```true```." ] }, "add_events": { "default": [ "pull_request" ], "items": { "type": "string" }, "type": "array", "x-swgg-descriptionLineList": [ "Determines a list of events to be added to the list of events that the Hook triggers for." ] }, "config": { "type": "object", "x-swgg-descriptionLineList": [ "**Required**. Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params)." ] }, "events": { "default": [ "push" ], "items": { "type": "string" }, "type": "array", "x-swgg-descriptionLineList": [ "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events. Default: ```[\"push\"]```" ] }, "remove_events": { "items": { "type": "string" }, "type": "array", "x-swgg-descriptionLineList": [ "Determines a list of events to be removed from the list of events that the Hook triggers for." ] } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fkeys_20POST.body": { "properties": { "key": { "default": "ssh-rsa AAA...", "type": "string", "x-swgg-descriptionLineList": [ "The contents of the key." ] }, "read_only": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "If ```true```, the key will only be able to read repository contents. Otherwise, the key will be able to read and write." ] }, "title": { "default": "octocat@octomac", "type": "string", "x-swgg-descriptionLineList": [ "A name for the key." ] } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_20POST.body": { "properties": { "body": { "default": "Description of the release", "type": "string" }, "draft": { "default": false, "type": "boolean", "x-swgg-descriptionLineList": [ "```true``` to create a draft (unpublished) release, ```false``` to create a published one. Default: ```false```" ] }, "name": { "default": "v1.0.0", "type": "string", "x-swgg-descriptionLineList": [ "The name of the release." ] }, "prerelease": { "default": false, "type": "boolean", "x-swgg-descriptionLineList": [ "```true``` to identify the release as a prerelease. ```false``` to identify the release as a full release. Default: ```false```" ] }, "tag_name": { "default": "v1.0.0", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The name of the tag." ] }, "target_commitish": { "default": "master", "type": "string", "x-swgg-descriptionLineList": [ "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually ```master```)." ] } }, "required": [ "tag_name" ], "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2F_7Bid_7D_20PATCH.body": { "properties": { "body": { "default": "Description of the release", "type": "string" }, "draft": { "default": false, "type": "boolean", "x-swgg-descriptionLineList": [ "```true``` makes the release a draft, and ```false``` publishes the release." ] }, "name": { "default": "v1.0.0", "type": "string", "x-swgg-descriptionLineList": [ "The name of the release." ] }, "prerelease": { "default": false, "type": "boolean", "x-swgg-descriptionLineList": [ "```true``` to identify the release as a prerelease, ```false``` to identify the release as a full release." ] }, "tag_name": { "default": "v1.0.0", "type": "string", "x-swgg-descriptionLineList": [ "The name of the tag." ] }, "target_commitish": { "default": "master", "type": "string", "x-swgg-descriptionLineList": [ "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually ```master```)." ] } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2Fassets_2F_7Bid_7D_20PATCH.body": { "properties": { "label": { "default": "Mac binary", "type": "string", "x-swgg-descriptionLineList": [ "An alternate short description of the asset. Used in place of the filename." ] }, "name": { "default": "foo-1.0.0-osx.zip", "type": "string", "x-swgg-descriptionLineList": [ "The file name of the asset." ] } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fstatuses_2F_7Bsha_7D_20POST.body": { "properties": { "context": { "default": "default", "type": "string", "x-swgg-descriptionLineList": [ "A string label to differentiate this status from the status of other systems. Default: ```default```" ] }, "description": { "default": "The build succeeded!", "type": "string", "x-swgg-descriptionLineList": [ "A short description of the status." ] }, "state": { "default": "success", "enum": [ "error", "failure", "pending", "success" ], "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The state of the status. Can be one of ```error```, ```failure```, ```pending```, or ```success```." ] }, "target_url": { "default": "https://example.com/build/status", "type": "string", "x-swgg-descriptionLineList": [ "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status.", "For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA:", "```http://ci.example.com/user/repo/build/sha```" ] } }, "required": [ "state" ], "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Ftopics_20PUT.body": { "properties": { "names": { "default": [ "octocat", "atom", "electron", "API" ], "items": { "type": "string" }, "type": "array" } }, "x-swgg-tags0": "github-repos" }, "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Ftransfer_20POST.body": { "properties": { "new_owner": { "default": "github", "type": "string", "x-swgg-descriptionLineList": [ "**Required:** The username or organization name the repository will be transferred to." ] }, "team_id": { "default": [ 12, 345 ], "items": { "type": "number" }, "type": "array" } }, "x-swgg-tags0": "github-repos" }, "_2Fuser_2Frepos_20POST.body": { "properties": { "allow_merge_commit": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to allow merging pull requests with a merge commit, or ```false``` to prevent merging pull requests with merge commits. Default: ```true```" ] }, "allow_rebase_merge": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to allow rebase-merging pull requests, or ```false``` to prevent rebase-merging. Default: ```true```" ] }, "allow_squash_merge": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to allow squash-merging pull requests, or ```false``` to prevent squash-merging. Default: ```true```" ] }, "auto_init": { "default": false, "type": "boolean", "x-swgg-descriptionLineList": [ "Pass ```true``` to create an initial commit with empty README. Default: ```false```." ] }, "description": { "default": "This is your first repository", "type": "string", "x-swgg-descriptionLineList": [ "A short description of the repository." ] }, "gitignore_template": { "type": "string", "x-swgg-descriptionLineList": [ "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\"." ] }, "has_issues": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to enable issues for this repository or ```false``` to disable them. Default: ```true```." ] }, "has_projects": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to enable projects for this repository or ```false``` to disable them. Default: ```true```. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is ```false```, and if you pass ```true```, the API returns an error." ] }, "has_wiki": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to enable the wiki for this repository or ```false``` to disable it. Default: ```true```." ] }, "homepage": { "default": "https://github.com", "type": "string", "x-swgg-descriptionLineList": [ "A URL with more information about the repository." ] }, "license_template": { "type": "string", "x-swgg-descriptionLineList": [ "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the ```license_template``` string. For example, \"mit\" or \"mpl-2.0\"." ] }, "name": { "default": "Hello-World", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The name of the repository." ] }, "private": { "default": false, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to create a private repository or ```false``` to create a public one. Creating private repositories requires a paid GitHub account. Default: ```false```." ] }, "team_id": { "type": "integer", "x-swgg-descriptionLineList": [ "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization." ] } }, "required": [ "name" ], "x-swgg-tags0": "github-repos" } }, "info": { "title": "swgg-github-repos", "version": "2018.3.28", "x-swgg-description": "this zero-dependency package will provide a (nodejs-compatible) swagger-client for github-repos's web-apis, with a working web-demo", "x-swgg-homepage": "https://github.com/kaizhu256/node-swgg-github-repos" }, "parameters": { "github-all.key": { "default": "xxxxxxxx", "in": "query", "name": "access_token", "type": "string", "x-swgg-apiKey": true, "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/#authentication", "", "OAuth2 token (sent as a parameter)" ] }, "github-all.user-agent": { "default": "Awesome-Octocat-App", "in": "header", "name": "user-agent", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/index.html#user-agent-required", "", "All API requests MUST include a valid ```User-Agent``` header. Requests with no ```User-Agent``` header will be rejected. We request that you use your GitHub username, or the name of your application, for the ```User-Agent``` header value. This allows us to contact you if there are problems." ] } }, "paths": { "/<upload_url>/repos/{owner}/{repo}/releases/{id}/assets": { "post": { "operationId": "_2F_26lt_3Bupload_url_26gt_3B_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2F_7Bid_7D_2Fassets_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.jean-grey-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" }, { "default": "foo.zip", "in": "query", "name": "name", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The file name of the asset. This should be set in a URI query parameter." ] }, { "in": "query", "name": "Content-Type", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The content type of the asset. This should be set in the Header. Example:", "```", "application/zip", "```", ". For a list of acceptable types, refer this list of [media types](https://www.iana.org/assignments/media-types/media-types.xhtml)." ] }, { "in": "query", "name": "label", "type": "string", "x-swgg-descriptionLineList": [ "An alternate short description of the asset. Used in place of the filename. This should be set in a URI query parameter." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Releases](https://developer.github.com/v3/repos/releases/#upload-a-release-asset) - Upload a release asset", "", "This endpoint makes use of [a Hypermedia relation](https://developer.github.com/v3/#hypermedia) to determine which URL to access. This endpoint is provided by a URI template in [the release's API response](https://developer.github.com/v3/repos/releases/#get-a-single-release). You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.", "", "The asset data is expected in its raw binary form, rather than JSON. Everything else about the endpoint is the same as the rest of the API. For example, you'll still need to pass your authentication to be able to upload an asset." ], "x-swgg-host": "", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Releases](https://developer.github.com/v3/repos/releases/#upload-a-release-asset) - Upload a release asset", "x-swgg-tags0": "github-repos" } }, "/orgs/{org}/repos": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Frepos_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.nightshade-preview+json" ], "enum": [ "application/vnd.github.mercy-preview+json", "application/vnd.github.nightshade-preview+json", "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "org", "in": "path", "name": "org", "required": true, "type": "string" }, { "default": "all", "enum": [ "all", "public", "private", "forks", "sources", "member" ], "in": "query", "name": "type", "type": "string", "x-swgg-descriptionLineList": [ "Can be one of ```all```, ```public```, ```private```, ```forks```, ```sources```, ```member```. Default: ```all```" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repositories](https://developer.github.com/v3/repos/#list-organization-repositories) - List organization repositories", "", "List repositories for the specified org." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repositories](https://developer.github.com/v3/repos/#list-organization-repositories) - List organization repositories", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{name}/community/profile": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Bname_7D_2Fcommunity_2Fprofile_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.black-panther-preview+json" ], "enum": [ "application/vnd.github.black-panther-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "name", "in": "path", "name": "name", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Community](https://developer.github.com/v3/repos/community/#retrieve-community-profile-metrics) - Retrieve community profile metrics" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Community](https://developer.github.com/v3/repos/community/#retrieve-community-profile-metrics) - Retrieve community profile metrics", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.nightshade-preview+json" ], "enum": [ "application/vnd.github.mercy-preview+json", "application/vnd.github.nightshade-preview+json", "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repositories](https://developer.github.com/v3/repos/#delete-a-repository) - Delete a repository", "", "Deleting a repository requires admin access. If OAuth is used, the ```delete_repo``` scope is required." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repositories](https://developer.github.com/v3/repos/#delete-a-repository) - Delete a repository", "x-swgg-tags0": "github-repos" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.nightshade-preview+json" ], "enum": [ "application/vnd.github.mercy-preview+json", "application/vnd.github.nightshade-preview+json", "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_20PATCH.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repositories](https://developer.github.com/v3/repos/#edit) - Edit" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repositories](https://developer.github.com/v3/repos/#edit) - Edit", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}#1": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_231_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.nightshade-preview+json" ], "enum": [ "application/vnd.github.mercy-preview+json", "application/vnd.github.nightshade-preview+json", "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repositories](https://developer.github.com/v3/repos/#get) - Get" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repositories](https://developer.github.com/v3/repos/#get) - Get", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/branches": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "query", "name": "protected", "type": "boolean", "x-swgg-descriptionLineList": [ "Setting to ```true``` returns only protected branches." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#list-branches) - List branches" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#list-branches) - List branches", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/branches/{branch}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#get-branch) - Get branch" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#get-branch) - Get branch", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/branches/{branch}/protection": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#remove-branch-protection) - Remove branch protection" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#remove-branch-protection) - Remove branch protection", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#get-branch-protection) - Get branch protection", "", "**Note:** The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.luke-cage-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#get-branch-protection) - Get branch protection", "x-swgg-tags0": "github-repos" }, "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_20PUT.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#update-branch-protection) - Update branch protection", "", "**Note:** The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.luke-cage-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "Protecting a branch requires admin or owner permissions to the repository." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#update-branch-protection) - Update branch protection", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Fenforce_admins_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#remove-admin-enforcement-of-protected-branch) - Remove admin enforcement of protected branch", "", "Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#remove-admin-enforcement-of-protected-branch) - Remove admin enforcement of protected branch", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Fenforce_admins_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#get-admin-enforcement-of-protected-branch) - Get admin enforcement of protected branch" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#get-admin-enforcement-of-protected-branch) - Get admin enforcement of protected branch", "x-swgg-tags0": "github-repos" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Fenforce_admins_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#add-admin-enforcement-of-protected-branch) - Add admin enforcement of protected branch", "", "Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#add-admin-enforcement-of-protected-branch) - Add admin enforcement of protected branch", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_pull_request_reviews_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#remove-pull-request-review-enforcement-of-protected-branch) - Remove pull request review enforcement of protected branch" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#remove-pull-request-review-enforcement-of-protected-branch) - Remove pull request review enforcement of protected branch", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_pull_request_reviews_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#get-pull-request-review-enforcement-of-protected-branch) - Get pull request review enforcement of protected branch", "", "**Note:** The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.luke-cage-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#get-pull-request-review-enforcement-of-protected-branch) - Get pull request review enforcement of protected branch", "x-swgg-tags0": "github-repos" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_pull_request_reviews_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_pull_request_reviews_20PATCH.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch) - Update pull request review enforcement of protected branch", "", "**Note:** The Protected Branches API now has a setting for requiring a specified number of approving pull request reviews before merging. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-03-16-protected-branches-required-approving-reviews) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.luke-cage-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch) - Update pull request review enforcement of protected branch", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_signatures_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#remove-required-signatures-of-protected-branch) - Remove required signatures of protected branch", "", "**Note:** Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.zzzax-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#remove-required-signatures-of-protected-branch) - Remove required signatures of protected branch", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_signatures_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#get-required-signatures-of-protected-branch) - Get required signatures of protected branch", "", "**Note:** Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.zzzax-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of ```true``` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help.", "", "**Note**: You must enable branch protection to require signed commits." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#get-required-signatures-of-protected-branch) - Get required signatures of protected branch", "x-swgg-tags0": "github-repos" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_signatures_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#add-required-signatures-of-protected-branch) - Add required signatures of protected branch", "", "**Note:** Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.zzzax-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#add-required-signatures-of-protected-branch) - Add required signatures of protected branch", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_status_checks_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#remove-required-status-checks-of-protected-branch) - Remove required status checks of protected branch" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#remove-required-status-checks-of-protected-branch) - Remove required status checks of protected branch", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_status_checks_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#get-required-status-checks-of-protected-branch) - Get required status checks of protected branch" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#get-required-status-checks-of-protected-branch) - Get required status checks of protected branch", "x-swgg-tags0": "github-repos" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_status_checks_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_status_checks_20PATCH.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#update-required-status-checks-of-protected-branch) - Update required status checks of protected branch", "", "Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#update-required-status-checks-of-protected-branch) - Update required status checks of protected branch", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_status_checks_2Fcontexts_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#remove-required-status-checks-contexts-of-protected-branch) - Remove required status checks contexts of protected branch" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#remove-required-status-checks-contexts-of-protected-branch) - Remove required status checks contexts of protected branch", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_status_checks_2Fcontexts_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#list-required-status-checks-contexts-of-protected-branch) - List required status checks contexts of protected branch" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#list-required-status-checks-contexts-of-protected-branch) - List required status checks contexts of protected branch", "x-swgg-tags0": "github-repos" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_status_checks_2Fcontexts_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#add-required-status-checks-contexts-of-protected-branch) - Add required status checks contexts of protected branch" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#add-required-status-checks-contexts-of-protected-branch) - Add required status checks contexts of protected branch", "x-swgg-tags0": "github-repos" }, "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frequired_status_checks_2Fcontexts_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#replace-required-status-checks-contexts-of-protected-branch) - Replace required status checks contexts of protected branch" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#replace-required-status-checks-contexts-of-protected-branch) - Replace required status checks contexts of protected branch", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frestrictions_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#remove-restrictions-of-protected-branch) - Remove restrictions of protected branch" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#remove-restrictions-of-protected-branch) - Remove restrictions of protected branch", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frestrictions_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#get-restrictions-of-protected-branch) - Get restrictions of protected branch", "", "**Note**: Teams and users ```restrictions``` are only available for organization-owned repositories." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#get-restrictions-of-protected-branch) - Get restrictions of protected branch", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frestrictions_2Fteams_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#remove-team-restrictions-of-protected-branch) - Remove team restrictions of protected branch", "", "**Note:** The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.hellcat-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#remove-team-restrictions-of-protected-branch) - Remove team restrictions of protected branch", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frestrictions_2Fteams_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#list-team-restrictions-of-protected-branch) - List team restrictions of protected branch", "", "**Note:** The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.hellcat-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#list-team-restrictions-of-protected-branch) - List team restrictions of protected branch", "x-swgg-tags0": "github-repos" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frestrictions_2Fteams_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#add-team-restrictions-of-protected-branch) - Add team restrictions of protected branch", "", "**Note:** The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.hellcat-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#add-team-restrictions-of-protected-branch) - Add team restrictions of protected branch", "x-swgg-tags0": "github-repos" }, "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frestrictions_2Fteams_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#replace-team-restrictions-of-protected-branch) - Replace team restrictions of protected branch", "", "**Note:** The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.hellcat-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#replace-team-restrictions-of-protected-branch) - Replace team restrictions of protected branch", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frestrictions_2Fusers_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#remove-user-restrictions-of-protected-branch) - Remove user restrictions of protected branch" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#remove-user-restrictions-of-protected-branch) - Remove user restrictions of protected branch", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frestrictions_2Fusers_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#list-user-restrictions-of-protected-branch) - List user restrictions of protected branch" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#list-user-restrictions-of-protected-branch) - List user restrictions of protected branch", "x-swgg-tags0": "github-repos" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frestrictions_2Fusers_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#add-user-restrictions-of-protected-branch) - Add user restrictions of protected branch" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#add-user-restrictions-of-protected-branch) - Add user restrictions of protected branch", "x-swgg-tags0": "github-repos" }, "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fbranches_2F_7Bbranch_7D_2Fprotection_2Frestrictions_2Fusers_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.luke-cage-preview+json", "application/vnd.github.zzzax-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "branch", "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Branches](https://developer.github.com/v3/repos/branches/#replace-user-restrictions-of-protected-branch) - Replace user restrictions of protected branch" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Branches](https://developer.github.com/v3/repos/branches/#replace-user-restrictions-of-protected-branch) - Replace user restrictions of protected branch", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/collaborators": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcollaborators_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "enum": [ "outside", "direct", "all" ], "in": "query", "name": "affiliation", "type": "string", "x-swgg-descriptionLineList": [ "Filter collaborators returned by their affiliation. Can be one of:", "* ```outside```: All outside collaborators of an organization-owned repository.", "* ```direct```: All collaborators with permissions to an organization-owned repository, regardless of organization membership status.", "* ```all```: All collaborators the authenticated user can see.", "Default: ```all```" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Collaborators](https://developer.github.com/v3/repos/collaborators/#list-collaborators) - List collaborators", "", "**Note:** The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.hellcat-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.", "", "If you pass the ```hellcat-preview``` media type, team members will include the members of child teams." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Collaborators](https://developer.github.com/v3/repos/collaborators/#list-collaborators) - List collaborators", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/collaborators/{username}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcollaborators_2F_7Busername_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "username", "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Collaborators](https://developer.github.com/v3/repos/collaborators/#remove-user-as-a-collaborator) - Remove user as a collaborator" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Collaborators](https://developer.github.com/v3/repos/collaborators/#remove-user-as-a-collaborator) - Remove user as a collaborator", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcollaborators_2F_7Busername_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "username", "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Collaborators](https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator) - Check if a user is a collaborator", "", "**Note:** The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.hellcat-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.", "", "If you pass the ```hellcat-preview``` media type, team members will include the members of child teams." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Collaborators](https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator) - Check if a user is a collaborator", "x-swgg-tags0": "github-repos" }, "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcollaborators_2F_7Busername_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "username", "in": "path", "name": "username", "required": true, "type": "string" }, { "enum": [ "pull", "push", "admin" ], "in": "query", "name": "permission", "type": "string", "x-swgg-descriptionLineList": [ "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of:", "* ```pull``` - can pull, but not push to or administer this repository.", "* ```push``` - can pull and push, but not administer this repository.", "* ```admin``` - can pull, push and administer this repository.", "Default: ```push```" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Collaborators](https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator) - Add user as a collaborator" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Collaborators](https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator) - Add user as a collaborator", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/collaborators/{username}/permission": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcollaborators_2F_7Busername_7D_2Fpermission_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.hellcat-preview+json" ], "enum": [ "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "username", "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Collaborators](https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level) - Review a user's permission level" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Collaborators](https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level) - Review a user's permission level", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/comments": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcomments_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.squirrel-girl-preview" ], "enum": [ "application/vnd.github.squirrel-girl-preview", "application/vnd.github-commitcomment.raw+json", "application/vnd.github-commitcomment.text+json", "application/vnd.github-commitcomment.html+json", "application/vnd.github-commitcomment.full+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Comments](https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository) - List commit comments for a repository", "", "Commit Comments use [these custom media types](https://developer.github.com/v3/repos/comments/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "", "Comments are ordered by ascending ID." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Comments](https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository) - List commit comments for a repository", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/comments/{id}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcomments_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.squirrel-girl-preview" ], "enum": [ "application/vnd.github.squirrel-girl-preview", "application/vnd.github-commitcomment.raw+json", "application/vnd.github-commitcomment.text+json", "application/vnd.github-commitcomment.html+json", "application/vnd.github-commitcomment.full+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Comments](https://developer.github.com/v3/repos/comments/#delete-a-commit-comment) - Delete a commit comment" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Comments](https://developer.github.com/v3/repos/comments/#delete-a-commit-comment) - Delete a commit comment", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcomments_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.squirrel-girl-preview" ], "enum": [ "application/vnd.github.squirrel-girl-preview", "application/vnd.github-commitcomment.raw+json", "application/vnd.github-commitcomment.text+json", "application/vnd.github-commitcomment.html+json", "application/vnd.github-commitcomment.full+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Comments](https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment) - Get a single commit comment" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Comments](https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment) - Get a single commit comment", "x-swgg-tags0": "github-repos" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcomments_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.squirrel-girl-preview" ], "enum": [ "application/vnd.github.squirrel-girl-preview", "application/vnd.github-commitcomment.raw+json", "application/vnd.github-commitcomment.text+json", "application/vnd.github-commitcomment.html+json", "application/vnd.github-commitcomment.full+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcomments_2F_7Bid_7D_20PATCH.body" }, "x-swgg-descriptionLineList": [ "**Required**. The contents of the comment" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Comments](https://developer.github.com/v3/repos/comments/#update-a-commit-comment) - Update a commit comment" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Comments](https://developer.github.com/v3/repos/comments/#update-a-commit-comment) - Update a commit comment", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/commits": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcommits_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3.sha", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "master", "in": "query", "name": "sha", "type": "string", "x-swgg-descriptionLineList": [ "SHA or branch to start listing commits from. Default: the repository’s default branch (usually ```master```)." ] }, { "in": "query", "name": "path", "type": "string", "x-swgg-descriptionLineList": [ "Only commits containing this file path will be returned." ] }, { "in": "query", "name": "author", "type": "string", "x-swgg-descriptionLineList": [ "GitHub login or email address by which to filter by commit author." ] }, { "in": "query", "name": "since", "type": "string", "x-swgg-descriptionLineList": [ "Only commits after this date will be returned. This is a timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```." ] }, { "in": "query", "name": "until", "type": "string", "x-swgg-descriptionLineList": [ "Only commits before this date will be returned. This is a timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Commits](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository) - List commits on a repository" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Commits](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository) - List commits on a repository", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/commits/{ref}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcommits_2F_7Bref_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3.sha", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "ref", "in": "path", "name": "ref", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Commits](https://developer.github.com/v3/repos/commits/#get-the-sha-1-of-a-commit-reference) - Get the SHA-1 of a commit reference", "", "Users with read access can get the SHA-1 of a commit reference:" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Commits](https://developer.github.com/v3/repos/commits/#get-the-sha-1-of-a-commit-reference) - Get the SHA-1 of a commit reference", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/commits/{ref}/comments": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcommits_2F_7Bref_7D_2Fcomments_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.squirrel-girl-preview" ], "enum": [ "application/vnd.github.squirrel-girl-preview", "application/vnd.github-commitcomment.raw+json", "application/vnd.github-commitcomment.text+json", "application/vnd.github-commitcomment.html+json", "application/vnd.github-commitcomment.full+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "ref", "in": "path", "name": "ref", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Comments](https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit) - List comments for a single commit" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Comments](https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit) - List comments for a single commit", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/commits/{ref}/status": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcommits_2F_7Bref_7D_2Fstatus_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.jean-grey-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "ref", "in": "path", "name": "ref", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. Ref to fetch the status for. It can be a SHA, a branch name, or a tag name." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Statuses](https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref) - Get the combined status for a specific ref", "", "Users with pull access can access a combined view of commit statuses for a given ref." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Statuses](https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref) - Get the combined status for a specific ref", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/commits/{ref}/statuses": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcommits_2F_7Bref_7D_2Fstatuses_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.jean-grey-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "ref", "in": "path", "name": "ref", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. Ref to list the statuses from. It can be a SHA, a branch name, or a tag name." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Statuses](https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref) - List statuses for a specific ref", "", "Users with pull access can view commit statuses for a given ref:" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Statuses](https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref) - List statuses for a specific ref", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/commits/{sha}#1": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcommits_2F_7Bsha_7D_231_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3.sha", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "sha", "in": "path", "name": "sha", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Commits](https://developer.github.com/v3/repos/commits/#get-a-single-commit) - Get a single commit" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Commits](https://developer.github.com/v3/repos/commits/#get-a-single-commit) - Get a single commit", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/commits/{sha}/comments#1": { "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcommits_2F_7Bsha_7D_2Fcomments_231_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.squirrel-girl-preview" ], "enum": [ "application/vnd.github.squirrel-girl-preview", "application/vnd.github-commitcomment.raw+json", "application/vnd.github-commitcomment.text+json", "application/vnd.github-commitcomment.html+json", "application/vnd.github-commitcomment.full+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "sha", "in": "path", "name": "sha", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcommits_2F_7Bsha_7D_2Fcomments_20POST.body" }, "x-swgg-descriptionLineList": [ "**Required**. The contents of the comment." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Comments](https://developer.github.com/v3/repos/comments/#create-a-commit-comment) - Create a commit comment" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Comments](https://developer.github.com/v3/repos/comments/#create-a-commit-comment) - Create a commit comment", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/compare/{base}...{head}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcompare_2F_7Bbase_7D..._7Bhead_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3.sha", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "base", "in": "path", "name": "base", "required": true, "type": "string" }, { "default": "head", "in": "path", "name": "head", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Commits](https://developer.github.com/v3/repos/commits/#compare-two-commits) - Compare two commits" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Commits](https://developer.github.com/v3/repos/commits/#compare-two-commits) - Compare two commits", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/contents/{path}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3.raw", "application/vnd.github.v3.html", "application/vnd.github.v3.object", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "path", "in": "path", "name": "path", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The content path." ] }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20DELETE.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Contents](https://developer.github.com/v3/repos/contents/#delete-a-file) - Delete a file", "", "This method deletes a file in a repository" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Contents](https://developer.github.com/v3/repos/contents/#delete-a-file) - Delete a file", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3.raw", "application/vnd.github.v3.html", "application/vnd.github.v3.object", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "path", "in": "path", "name": "path", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "The content path." ] }, { "default": "master", "in": "query", "name": "ref", "type": "string", "x-swgg-descriptionLineList": [ "The name of the commit/branch/tag. Default: the repository’s default branch (usually ```master```)" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Contents](https://developer.github.com/v3/repos/contents/#get-contents) - Get contents", "", "This method returns the contents of a file or directory in a repository." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Contents](https://developer.github.com/v3/repos/contents/#get-contents) - Get contents", "x-swgg-tags0": "github-repos" }, "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3.raw", "application/vnd.github.v3.html", "application/vnd.github.v3.object", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "path", "in": "path", "name": "path", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The content path." ] }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_20PUT.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Contents](https://developer.github.com/v3/repos/contents/#create-a-file) - Create a file", "", "This method creates a new file in a repository" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Contents](https://developer.github.com/v3/repos/contents/#create-a-file) - Create a file", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/contents/{path}#1": { "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_231_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3.raw", "application/vnd.github.v3.html", "application/vnd.github.v3.object", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "path", "in": "path", "name": "path", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The content path." ] }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_231_20PUT.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Contents](https://developer.github.com/v3/repos/contents/#update-a-file) - Update a file", "", "This method updates a file in a repository" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Contents](https://developer.github.com/v3/repos/contents/#update-a-file) - Update a file", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/contributors": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontributors_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.nightshade-preview+json" ], "enum": [ "application/vnd.github.mercy-preview+json", "application/vnd.github.nightshade-preview+json", "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "query", "name": "anon", "type": "string", "x-swgg-descriptionLineList": [ "Set to ```1``` or ```true``` to include anonymous contributors in results." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repositories](https://developer.github.com/v3/repos/#list-contributors) - List contributors", "", "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.", "", "GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repositories](https://developer.github.com/v3/repos/#list-contributors) - List contributors", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/deployments": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fdeployments_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.ant-man-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.machine-man-preview", "application/vnd.github.ant-man-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "none", "in": "query", "name": "sha", "type": "string", "x-swgg-descriptionLineList": [ "The SHA that was recorded at creation time. Default: ```none```" ] }, { "default": "none", "in": "query", "name": "ref", "type": "string", "x-swgg-descriptionLineList": [ "The name of the ref. This can be a branch, tag, or SHA. Default: ```none```" ] }, { "default": "none", "in": "query", "name": "task", "type": "string", "x-swgg-descriptionLineList": [ "The name of the task for the deployment (e.g., ```deploy``` or ```deploy:migrations```). Default: ```none```" ] }, { "default": "none", "in": "query", "name": "environment", "type": "string", "x-swgg-descriptionLineList": [ "The name of the environment that was deployed to (e.g., ```staging``` or ```production```). Default: ```none```" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Deployments](https://developer.github.com/v3/repos/deployments/#list-deployments) - List deployments", "", "Simple filtering of deployments is available via query parameters:" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Deployments](https://developer.github.com/v3/repos/deployments/#list-deployments) - List deployments", "x-swgg-tags0": "github-repos" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fdeployments_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.ant-man-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.machine-man-preview", "application/vnd.github.ant-man-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "query", "name": "ref", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The ref to deploy. This can be a branch, tag, or SHA." ] }, { "default": "deploy", "in": "query", "name": "task", "type": "string", "x-swgg-descriptionLineList": [ "Specifies a task to execute (e.g., ```deploy``` or ```deploy:migrations```). Default: ```deploy```" ] }, { "default": true, "in": "query", "name": "auto_merge", "type": "boolean", "x-swgg-descriptionLineList": [ "Attempts to automatically merge the default branch into the requested ref, if it is behind the default branch. Default: ```true```" ] }, { "in": "query", "items": { "type": "string" }, "name": "required_contexts", "type": "array", "x-swgg-descriptionLineList": [ "The status contexts to verify against commit status checks. If this parameter is omitted, then all unique contexts will be verified before a deployment is created. To bypass checking entirely pass an empty array. Defaults to all unique contexts." ] }, { "in": "query", "name": "payload", "type": "string", "x-swgg-descriptionLineList": [ "JSON payload with extra information about the deployment. Default: ```\"\"```" ] }, { "default": "production", "in": "query", "name": "environment", "type": "string", "x-swgg-descriptionLineList": [ "Name for the target deployment environment (e.g., ```production```, ```staging```, ```qa```). Default: ```production```" ] }, { "in": "query", "name": "description", "type": "string", "x-swgg-descriptionLineList": [ "Short description of the deployment. Default: ```\"\"```" ] }, { "default": false, "in": "query", "name": "transient_environment", "type": "boolean", "x-swgg-descriptionLineList": [ "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: ```false``` **This parameter requires a custom media type to be specified. Please see more in the alert below.**" ] }, { "default": true, "in": "query", "name": "production_environment", "type": "boolean", "x-swgg-descriptionLineList": [ "Specifies if the given environment is one that end-users directly interact with. Default: ```true``` when ```environment``` is ```production``` and ```false``` otherwise. **This parameter requires a custom media type to be specified. Please see more in the alert below.**" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Deployments](https://developer.github.com/v3/repos/deployments/#create-a-deployment) - Create a deployment", "", "Deployments offer a few configurable parameters with sane defaults.", "", "The ```ref``` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them before we merge a pull request.", "", "The ```environment``` parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as ```production```, ```staging```, and ```qa```. This allows for easy tracking of which environments had deployments requested. The default environment is ```production```.", "", "The ```auto_merge``` parameter is used to ensure that the requested ref is not behind the repository's default branch. If the ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response.", "", "By default, [commit statuses](https://developer.github.com/v3/repos/statuses) for every submitted context must be in a ```success``` state. The ```required_contexts``` parameter allows you to specify a subset of contexts that must be ```success```, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed.", "", "The ```payload``` parameter is available for any extra information that a deployment system might need. It is a JSON text field that will be passed on when a deployment event is dispatched.", "", "The ```task``` parameter is used by the deployment system to allow different execution paths. In the web world this might be ```deploy:migrations``` to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled.", "", "Users with ```repo``` or ```repo_deployment``` scopes can create a deployment for a given ref:" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Deployments](https://developer.github.com/v3/repos/deployments/#create-a-deployment) - Create a deployment", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/deployments/{id}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fdeployments_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.ant-man-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.machine-man-preview", "application/vnd.github.ant-man-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Deployments](https://developer.github.com/v3/repos/deployments/#get-a-single-deployment) - Get a single deployment" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Deployments](https://developer.github.com/v3/repos/deployments/#get-a-single-deployment) - Get a single deployment", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/deployments/{id}/statuses": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fdeployments_2F_7Bid_7D_2Fstatuses_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.ant-man-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.machine-man-preview", "application/vnd.github.ant-man-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The deployment ID to list the statuses from." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Deployments](https://developer.github.com/v3/repos/deployments/#list-deployment-statuses) - List deployment statuses", "", "Users with pull access can view deployment statuses for a deployment:" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Deployments](https://developer.github.com/v3/repos/deployments/#list-deployment-statuses) - List deployment statuses", "x-swgg-tags0": "github-repos" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fdeployments_2F_7Bid_7D_2Fstatuses_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.ant-man-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.machine-man-preview", "application/vnd.github.ant-man-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fdeployments_2F_7Bid_7D_2Fstatuses_20POST.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Deployments](https://developer.github.com/v3/repos/deployments/#create-a-deployment-status) - Create a deployment status", "", "Users with push access can create deployment statuses for a given deployment:" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Deployments](https://developer.github.com/v3/repos/deployments/#create-a-deployment-status) - Create a deployment status", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/deployments/{id}/statuses/{status_id}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fdeployments_2F_7Bid_7D_2Fstatuses_2F_7Bstatus_id_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.ant-man-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.machine-man-preview", "application/vnd.github.ant-man-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The deployment ID to list the statuses from." ] }, { "default": "status_id", "in": "path", "name": "status_id", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The deployment status ID." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Deployments](https://developer.github.com/v3/repos/deployments/#get-a-single-deployment-status) - Get a single deployment status", "", "This endpoint is part of the deployment and deployment status enhancement. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-04-06-deployment-and-deployment-status-enhancements) for full details.", "", "To access the API during the Early Access period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.ant-man-preview+json", "```", "", "Users with pull access can view a deployment status for a deployment:" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Deployments](https://developer.github.com/v3/repos/deployments/#get-a-single-deployment-status) - Get a single deployment status", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/downloads": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fdownloads_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Downloads](https://developer.github.com/v3/repos/downloads/#list-downloads-for-a-repository) - List downloads for a repository" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Downloads](https://developer.github.com/v3/repos/downloads/#list-downloads-for-a-repository) - List downloads for a repository", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/downloads/{id}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fdownloads_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Downloads](https://developer.github.com/v3/repos/downloads/#delete-a-download) - Delete a download" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Downloads](https://developer.github.com/v3/repos/downloads/#delete-a-download) - Delete a download", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fdownloads_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Downloads](https://developer.github.com/v3/repos/downloads/#get-a-single-download) - Get a single download" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Downloads](https://developer.github.com/v3/repos/downloads/#get-a-single-download) - Get a single download", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/forks": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fforks_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "newest", "in": "query", "name": "sort", "type": "string", "x-swgg-descriptionLineList": [ "The sort order. Can be either ```newest```, ```oldest```, or ```stargazers```. Default: ```newest```" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Forks](https://developer.github.com/v3/repos/forks/#list-forks) - List forks" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Forks](https://developer.github.com/v3/repos/forks/#list-forks) - List forks", "x-swgg-tags0": "github-repos" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fforks_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "query", "name": "organization", "type": "string", "x-swgg-descriptionLineList": [ "Optional parameter to specify the organization name if forking into an organization." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Forks](https://developer.github.com/v3/repos/forks/#create-a-fork) - Create a fork", "", "Create a fork for the authenticated user." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Forks](https://developer.github.com/v3/repos/forks/#create-a-fork) - Create a fork", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/hooks": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repository Webhooks](https://developer.github.com/v3/repos/hooks/#list-hooks) - List hooks" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repository Webhooks](https://developer.github.com/v3/repos/hooks/#list-hooks) - List hooks", "x-swgg-tags0": "github-repos" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_20POST.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repository Webhooks](https://developer.github.com/v3/repos/hooks/#create-a-hook) - Create a hook" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repository Webhooks](https://developer.github.com/v3/repos/hooks/#create-a-hook) - Create a hook", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/hooks/{id}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repository Webhooks](https://developer.github.com/v3/repos/hooks/#delete-a-hook) - Delete a hook" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repository Webhooks](https://developer.github.com/v3/repos/hooks/#delete-a-hook) - Delete a hook", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repository Webhooks](https://developer.github.com/v3/repos/hooks/#get-single-hook) - Get single hook" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repository Webhooks](https://developer.github.com/v3/repos/hooks/#get-single-hook) - Get single hook", "x-swgg-tags0": "github-repos" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_2F_7Bid_7D_20PATCH.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repository Webhooks](https://developer.github.com/v3/repos/hooks/#edit-a-hook) - Edit a hook" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repository Webhooks](https://developer.github.com/v3/repos/hooks/#edit-a-hook) - Edit a hook", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/hooks/{id}/pings": { "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_2F_7Bid_7D_2Fpings_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repository Webhooks](https://developer.github.com/v3/repos/hooks/#ping-a-hook) - Ping a hook", "", "This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repository Webhooks](https://developer.github.com/v3/repos/hooks/#ping-a-hook) - Ping a hook", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/hooks/{id}/tests": { "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fhooks_2F_7Bid_7D_2Ftests_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repository Webhooks](https://developer.github.com/v3/repos/hooks/#test-a-push-hook) - Test a", "", "This will trigger the hook with the latest push to the current repository if the hook is subscribed to ```push``` events. If the hook is not subscribed to ```push``` events, the server will respond with 204 but no test POST will be generated." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repository Webhooks](https://developer.github.com/v3/repos/hooks/#test-a-push-hook) - Test a", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/invitations": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Finvitations_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repository Invitations](https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository) - List invitations for a repository" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repository Invitations](https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository) - List invitations for a repository", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/invitations/{invitation_id}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Finvitations_2F_7Binvitation_id_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "invitation_id", "in": "path", "name": "invitation_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repository Invitations](https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation) - Delete a repository invitation" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repository Invitations](https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation) - Delete a repository invitation", "x-swgg-tags0": "github-repos" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Finvitations_2F_7Binvitation_id_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "invitation_id", "in": "path", "name": "invitation_id", "required": true, "type": "string" }, { "in": "query", "name": "permissions", "type": "string", "x-swgg-descriptionLineList": [ "The permissions that the associated user will have on the repository. Valid values are ```read```, ```write```, and ```admin```." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repository Invitations](https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation) - Update a repository invitation" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repository Invitations](https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation) - Update a repository invitation", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/keys": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fkeys_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Deploy Keys](https://developer.github.com/v3/repos/keys/#list-deploy-keys) - List deploy keys" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Deploy Keys](https://developer.github.com/v3/repos/keys/#list-deploy-keys) - List deploy keys", "x-swgg-tags0": "github-repos" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fkeys_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fkeys_20POST.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Deploy Keys](https://developer.github.com/v3/repos/keys/#add-a-new-deploy-key) - Add a new deploy key" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Deploy Keys](https://developer.github.com/v3/repos/keys/#add-a-new-deploy-key) - Add a new deploy key", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/keys/{id}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fkeys_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Deploy Keys](https://developer.github.com/v3/repos/keys/#remove-a-deploy-key) - Remove a deploy key" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Deploy Keys](https://developer.github.com/v3/repos/keys/#remove-a-deploy-key) - Remove a deploy key", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fkeys_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Deploy Keys](https://developer.github.com/v3/repos/keys/#get-a-deploy-key) - Get a deploy key" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Deploy Keys](https://developer.github.com/v3/repos/keys/#get-a-deploy-key) - Get a deploy key", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/languages": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Flanguages_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.nightshade-preview+json" ], "enum": [ "application/vnd.github.mercy-preview+json", "application/vnd.github.nightshade-preview+json", "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repositories](https://developer.github.com/v3/repos/#list-languages) - List languages", "", "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repositories](https://developer.github.com/v3/repos/#list-languages) - List languages", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/merges": { "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fmerges_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "query", "name": "base", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The name of the base branch that the head will be merged into." ] }, { "in": "query", "name": "head", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The head to merge. This can be a branch name or a commit SHA1." ] }, { "in": "query", "name": "commit_message", "type": "string", "x-swgg-descriptionLineList": [ "Commit message to use for the merge commit. If omitted, a default message will be used." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Merging](https://developer.github.com/v3/repos/merging/#perform-a-merge) - Perform a merge" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Merging](https://developer.github.com/v3/repos/merging/#perform-a-merge) - Perform a merge", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/pages": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpages_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.mister-fantastic-preview+json" ], "enum": [ "application/vnd.github.mister-fantastic-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Pages](https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site) - Get information about a Pages site" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Pages](https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site) - Get information about a Pages site", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/pages/builds": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpages_2Fbuilds_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.mister-fantastic-preview+json" ], "enum": [ "application/vnd.github.mister-fantastic-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Pages](https://developer.github.com/v3/repos/pages/#list-pages-builds) - List Pages builds" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Pages](https://developer.github.com/v3/repos/pages/#list-pages-builds) - List Pages builds", "x-swgg-tags0": "github-repos" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpages_2Fbuilds_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.mister-fantastic-preview+json" ], "enum": [ "application/vnd.github.mister-fantastic-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Pages](https://developer.github.com/v3/repos/pages/#request-a-page-build) - Request a page build" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Pages](https://developer.github.com/v3/repos/pages/#request-a-page-build) - Request a page build", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/pages/builds/latest": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpages_2Fbuilds_2Flatest_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.mister-fantastic-preview+json" ], "enum": [ "application/vnd.github.mister-fantastic-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Pages](https://developer.github.com/v3/repos/pages/#list-latest-pages-build) - List latest Pages build" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Pages](https://developer.github.com/v3/repos/pages/#list-latest-pages-build) - List latest Pages build", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/pages/builds/{id}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpages_2Fbuilds_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.mister-fantastic-preview+json" ], "enum": [ "application/vnd.github.mister-fantastic-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Pages](https://developer.github.com/v3/repos/pages/#list-a-specific-pages-build) - List a specific Pages build" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Pages](https://developer.github.com/v3/repos/pages/#list-a-specific-pages-build) - List a specific Pages build", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/readme": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freadme_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3.raw", "application/vnd.github.v3.html", "application/vnd.github.v3.object", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "master", "in": "query", "name": "ref", "type": "string", "x-swgg-descriptionLineList": [ "The name of the commit/branch/tag. Default: the repository’s default branch (usually ```master```)" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Contents](https://developer.github.com/v3/repos/contents/#get-the-readme) - Get the README", "", "This method returns the preferred README for a repository." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Contents](https://developer.github.com/v3/repos/contents/#get-the-readme) - Get the README", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/releases": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.jean-grey-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Releases](https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository) - List releases for a repository", "", "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://developer.github.com/v3/repos/#list-tags).", "", "Information about published releases are available to everyone. Only users with push access will receive listings for draft releases." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Releases](https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository) - List releases for a repository", "x-swgg-tags0": "github-repos" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.jean-grey-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_20POST.body" }, "x-swgg-descriptionLineList": [ "Text describing the contents of the tag." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Releases](https://developer.github.com/v3/repos/releases/#create-a-release) - Create a release", "", "Users with push access to the repository can create a release." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Releases](https://developer.github.com/v3/repos/releases/#create-a-release) - Create a release", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/releases/assets/{id}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2Fassets_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.jean-grey-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Releases](https://developer.github.com/v3/repos/releases/#delete-a-release-asset) - Delete a release asset" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Releases](https://developer.github.com/v3/repos/releases/#delete-a-release-asset) - Delete a release asset", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2Fassets_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.jean-grey-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Releases](https://developer.github.com/v3/repos/releases/#get-a-single-release-asset) - Get a single release asset" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Releases](https://developer.github.com/v3/repos/releases/#get-a-single-release-asset) - Get a single release asset", "x-swgg-tags0": "github-repos" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2Fassets_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.jean-grey-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2Fassets_2F_7Bid_7D_20PATCH.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Releases](https://developer.github.com/v3/repos/releases/#edit-a-release-asset) - Edit a release asset", "", "Users with push access to the repository can edit a release asset." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Releases](https://developer.github.com/v3/repos/releases/#edit-a-release-asset) - Edit a release asset", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/releases/latest": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2Flatest_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.jean-grey-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Releases](https://developer.github.com/v3/repos/releases/#get-the-latest-release) - Get the latest release", "", "View the latest published full release for the repository. Draft releases and prereleases are not returned by this endpoint." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Releases](https://developer.github.com/v3/repos/releases/#get-the-latest-release) - Get the latest release", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/releases/tags/{tag}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2Ftags_2F_7Btag_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.jean-grey-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "tag", "in": "path", "name": "tag", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Releases](https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name) - Get a release by tag name", "", "Get a published release with the specified tag." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Releases](https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name) - Get a release by tag name", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/releases/{id}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.jean-grey-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Releases](https://developer.github.com/v3/repos/releases/#delete-a-release) - Delete a release", "", "Users with push access to the repository can delete a release." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Releases](https://developer.github.com/v3/repos/releases/#delete-a-release) - Delete a release", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.jean-grey-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Releases](https://developer.github.com/v3/repos/releases/#get-a-single-release) - Get a single release" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Releases](https://developer.github.com/v3/repos/releases/#get-a-single-release) - Get a single release", "x-swgg-tags0": "github-repos" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.jean-grey-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2F_7Bid_7D_20PATCH.body" }, "x-swgg-descriptionLineList": [ "Text describing the contents of the tag." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Releases](https://developer.github.com/v3/repos/releases/#edit-a-release) - Edit a release", "", "Users with push access to the repository can edit a release." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Releases](https://developer.github.com/v3/repos/releases/#edit-a-release) - Edit a release", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/releases/{id}/assets": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Freleases_2F_7Bid_7D_2Fassets_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.jean-grey-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "id", "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Releases](https://developer.github.com/v3/repos/releases/#list-assets-for-a-release) - List assets for a release" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Releases](https://developer.github.com/v3/repos/releases/#list-assets-for-a-release) - List assets for a release", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/stats/code_frequency": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fstats_2Fcode_frequency_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Statistics](https://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week) - Get the number of additions and deletions per week" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Statistics](https://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week) - Get the number of additions and deletions per week", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/stats/commit_activity": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fstats_2Fcommit_activity_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Statistics](https://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data) - Get the last year of commit activity data", "", "Returns the last year of commit activity grouped by week. The ```days``` array is a group of commits per day, starting on ```Sunday```." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Statistics](https://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data) - Get the last year of commit activity data", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/stats/contributors": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fstats_2Fcontributors_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Statistics](https://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts) - Get contributors list with additions, deletions, and commit counts" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Statistics](https://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts) - Get contributors list with additions, deletions, and commit counts", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/stats/participation": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fstats_2Fparticipation_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Statistics](https://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repository-owner-and-everyone-else) - Get the weekly commit count for the repository owner and everyone else" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Statistics](https://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repository-owner-and-everyone-else) - Get the weekly commit count for the repository owner and everyone else", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/stats/punch_card": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fstats_2Fpunch_card_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Statistics](https://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day) - Get the number of commits per hour in each day" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Statistics](https://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day) - Get the number of commits per hour in each day", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/statuses/{sha}": { "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fstatuses_2F_7Bsha_7D_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.jean-grey-preview+json" ], "enum": [ "application/vnd.github.jean-grey-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "sha", "in": "path", "name": "sha", "required": true, "type": "string" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fstatuses_2F_7Bsha_7D_20POST.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Statuses](https://developer.github.com/v3/repos/statuses/#create-a-status) - Create a status", "", "Users with push access can create commit statuses for a given ref:" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Statuses](https://developer.github.com/v3/repos/statuses/#create-a-status) - Create a status", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/tags": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Ftags_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.nightshade-preview+json" ], "enum": [ "application/vnd.github.mercy-preview+json", "application/vnd.github.nightshade-preview+json", "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repositories](https://developer.github.com/v3/repos/#list-tags) - List tags" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repositories](https://developer.github.com/v3/repos/#list-tags) - List tags", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/teams": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fteams_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.nightshade-preview+json" ], "enum": [ "application/vnd.github.mercy-preview+json", "application/vnd.github.nightshade-preview+json", "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repositories](https://developer.github.com/v3/repos/#list-teams) - List teams", "", "**Note:** The Nested Teams API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2017-08-30-preview-nested-teams) for full details. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.hellcat-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repositories](https://developer.github.com/v3/repos/#list-teams) - List teams", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/topics": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Ftopics_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.nightshade-preview+json" ], "enum": [ "application/vnd.github.mercy-preview+json", "application/vnd.github.nightshade-preview+json", "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repositories](https://developer.github.com/v3/repos/#list-all-topics-for-a-repository) - List all topics for a repository", "", "**Note:** The ```topics``` property for repositories on GitHub is currently available for developers to preview. To view the ```topics``` property in calls that return repository results, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.mercy-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repositories](https://developer.github.com/v3/repos/#list-all-topics-for-a-repository) - List all topics for a repository", "x-swgg-tags0": "github-repos" }, "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Ftopics_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.nightshade-preview+json" ], "enum": [ "application/vnd.github.mercy-preview+json", "application/vnd.github.nightshade-preview+json", "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Ftopics_20PUT.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repositories](https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository) - Replace all topics for a repository", "", "**Note:** The ```topics``` property for repositories on GitHub is currently available for developers to preview. To view the ```topics``` property in calls that return repository results, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.mercy-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repositories](https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository) - Replace all topics for a repository", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/traffic/clones": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Ftraffic_2Fclones_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Traffic](https://developer.github.com/v3/repos/traffic/#clones) - Clones", "", "Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Traffic](https://developer.github.com/v3/repos/traffic/#clones) - Clones", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/traffic/popular/paths": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Ftraffic_2Fpopular_2Fpaths_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Traffic](https://developer.github.com/v3/repos/traffic/#list-paths) - List paths", "", "Get the top 10 popular contents over the last 14 days." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Traffic](https://developer.github.com/v3/repos/traffic/#list-paths) - List paths", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/traffic/popular/referrers": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Ftraffic_2Fpopular_2Freferrers_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Traffic](https://developer.github.com/v3/repos/traffic/#list-referrers) - List referrers", "", "Get the top 10 referrers over the last 14 days." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Traffic](https://developer.github.com/v3/repos/traffic/#list-referrers) - List referrers", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/traffic/views": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Ftraffic_2Fviews_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Traffic](https://developer.github.com/v3/repos/traffic/#views) - Views", "", "Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Traffic](https://developer.github.com/v3/repos/traffic/#views) - Views", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/transfer": { "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Ftransfer_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.nightshade-preview+json" ], "enum": [ "application/vnd.github.mercy-preview+json", "application/vnd.github.nightshade-preview+json", "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Ftransfer_20POST.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repositories](https://developer.github.com/v3/repos/#transfer-a-repository) - Transfer a repository", "", "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original ```owner```, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/).", "", "**Note:** The [Repository Transfer API](https://developer.github.com/changes/2017-11-09-repository-transfer-api-preview) is currently available for developers to preview. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.nightshade-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repositories](https://developer.github.com/v3/repos/#transfer-a-repository) - Transfer a repository", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/{archive_format}/{ref}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2F_7Barchive_format_7D_2F_7Bref_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3.raw", "application/vnd.github.v3.html", "application/vnd.github.v3.object", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "owner", "in": "path", "name": "owner", "required": true, "type": "string" }, { "default": "repo", "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "archive_format", "in": "path", "name": "archive_format", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "Can be either ```tarball``` or ```zipball```. Default: ```tarball```" ] }, { "default": "ref", "in": "path", "name": "ref", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "A valid Git reference. Default: the repository’s default branch (usually ```master```)" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Contents](https://developer.github.com/v3/repos/contents/#get-archive-link) - Get archive link", "", "This method will return a ```302``` to a URL to download a tarball or zipball archive for a repository. Please make sure your HTTP framework is configured to follow redirects or you will need to use the ```Location``` header to make a second ```GET``` request.", "", "Note: For private repositories, these links are temporary and expire after five minutes." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Contents](https://developer.github.com/v3/repos/contents/#get-archive-link) - Get archive link", "x-swgg-tags0": "github-repos" } }, "/repositories": { "get": { "operationId": "_2Frepositories_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.nightshade-preview+json" ], "enum": [ "application/vnd.github.mercy-preview+json", "application/vnd.github.nightshade-preview+json", "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "in": "query", "name": "since", "type": "string", "x-swgg-descriptionLineList": [ "The integer ID of the last Repository that you've seen." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repositories](https://developer.github.com/v3/repos/#list-all-public-repositories) - List all public repositories", "", "This provides a dump of every public repository, in the order that they were created.", "", "Note: Pagination is powered exclusively by the ```since``` parameter. Use the [Link header](https://developer.github.com/v3/#link-header) to get the URL for the next page of repositories." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repositories](https://developer.github.com/v3/repos/#list-all-public-repositories) - List all public repositories", "x-swgg-tags0": "github-repos" } }, "/user/repos": { "get": { "operationId": "_2Fuser_2Frepos_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.nightshade-preview+json" ], "enum": [ "application/vnd.github.mercy-preview+json", "application/vnd.github.nightshade-preview+json", "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "all", "enum": [ "all", "public", "private" ], "in": "query", "name": "visibility", "type": "string", "x-swgg-descriptionLineList": [ "Can be one of ```all```, ```public```, or ```private```. Default: ```all```" ] }, { "enum": [ "owner", "collaborator", "organization_member" ], "in": "query", "items": { "type": "string" }, "name": "affiliation", "type": "array", "x-swgg-descriptionLineList": [ "Comma-separated list of values. Can include:", "* ```owner```: Repositories that are owned by the authenticated user.", "* ```collaborator```: Repositories that the user has been added to as a collaborator.", "* ```organization_member```: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.", "", "Default: ```owner,collaborator,organization_member```" ] }, { "default": "all", "enum": [ "422", "all", "owner", "public", "private", "member" ], "in": "query", "name": "type", "type": "string", "x-swgg-descriptionLineList": [ "Can be one of ```all```, ```owner```, ```public```, ```private```, ```member```. Default: ```all```", "", "Will cause a ```422``` error if used in the same request as **visibility** or **affiliation**." ] }, { "default": "full_name", "enum": [ "created", "updated", "pushed", "full_name" ], "in": "query", "name": "sort", "type": "string", "x-swgg-descriptionLineList": [ "Can be one of ```created```, ```updated```, ```pushed```, ```full_name```. Default: ```full_name```" ] }, { "default": "full_name", "enum": [ "asc", "desc", "full_name" ], "in": "query", "name": "direction", "type": "string", "x-swgg-descriptionLineList": [ "Can be one of ```asc``` or ```desc```. Default: when using ```full_name```: ```asc```; otherwise ```desc```" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repositories](https://developer.github.com/v3/repos/#list-your-repositories) - List your repositories", "", "List repositories that are accessible to the authenticated user.", "", "This includes repositories owned by the authenticated user, repositories where the authenticated user is a collaborator, and repositories that the authenticated user has access to through an organization membership." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repositories](https://developer.github.com/v3/repos/#list-your-repositories) - List your repositories", "x-swgg-tags0": "github-repos" }, "post": { "operationId": "_2Fuser_2Frepos_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.nightshade-preview+json" ], "enum": [ "application/vnd.github.mercy-preview+json", "application/vnd.github.nightshade-preview+json", "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "in": "body", "name": "body", "schema": { "$ref": "#/definitions/_2Fuser_2Frepos_20POST.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repositories](https://developer.github.com/v3/repos/#create) - Create", "", "Create a new repository for the authenticated user.", "", "**Note**: There are two endpoints for creating a repository: one to create a repository on a user account, and one to create a repository in an organization. The organization endpoint is fully enabled for [GitHub Apps](https://developer.github.com/v3/apps/available-endpoints/), whereas the user endpoint is enabled only for [user-to-server requests](https://developer.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#user-to-server-requests)." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repositories](https://developer.github.com/v3/repos/#create) - Create", "x-swgg-tags0": "github-repos" } }, "/user/repository_invitations": { "get": { "operationId": "_2Fuser_2Frepository_invitations_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repository Invitations](https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations) - List a user's repository invitations" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repository Invitations](https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations) - List a user's repository invitations", "x-swgg-tags0": "github-repos" } }, "/user/repository_invitations/{invitation_id}": { "delete": { "operationId": "_2Fuser_2Frepository_invitations_2F_7Binvitation_id_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "invitation_id", "in": "path", "name": "invitation_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repository Invitations](https://developer.github.com/v3/repos/invitations/#decline-a-repository-invitation) - Decline a repository invitation" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repository Invitations](https://developer.github.com/v3/repos/invitations/#decline-a-repository-invitation) - Decline a repository invitation", "x-swgg-tags0": "github-repos" }, "patch": { "operationId": "_2Fuser_2Frepository_invitations_2F_7Binvitation_id_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "enum": [ "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "invitation_id", "in": "path", "name": "invitation_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repository Invitations](https://developer.github.com/v3/repos/invitations/#accept-a-repository-invitation) - Accept a repository invitation" ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repository Invitations](https://developer.github.com/v3/repos/invitations/#accept-a-repository-invitation) - Accept a repository invitation", "x-swgg-tags0": "github-repos" } }, "/users/{username}/repos": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Frepos_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "collectionFormat": "csv", "default": [ "application/vnd.github.nightshade-preview+json" ], "enum": [ "application/vnd.github.mercy-preview+json", "application/vnd.github.nightshade-preview+json", "application/vnd.github.jean-grey-preview+json", "application/vnd.github.hellcat-preview+json", "application/vnd.github.v3+json" ], "in": "header", "items": { "type": "string" }, "name": "accept", "required": true, "type": "array", "x-swgg-descriptionLineList": [ "https://developer.github.com/v3/media/", "", "Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't." ] }, { "default": "username", "in": "path", "name": "username", "required": true, "type": "string" }, { "default": "owner", "enum": [ "all", "owner", "member" ], "in": "query", "name": "type", "type": "string", "x-swgg-descriptionLineList": [ "Can be one of ```all```, ```owner```, ```member```. Default: ```owner```" ] }, { "default": "full_name", "enum": [ "created", "updated", "pushed", "full_name" ], "in": "query", "name": "sort", "type": "string", "x-swgg-descriptionLineList": [ "Can be one of ```created```, ```updated```, ```pushed```, ```full_name```. Default: ```full_name```" ] }, { "default": "full_name", "enum": [ "asc", "desc", "full_name" ], "in": "query", "name": "direction", "type": "string", "x-swgg-descriptionLineList": [ "Can be one of ```asc``` or ```desc```. Default: when using ```full_name```: ```asc```, otherwise ```desc```" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "[Repositories](https://developer.github.com/v3/repos/#list-user-repositories) - List user repositories", "", "List public repositories for the specified user." ], "x-swgg-host": "api.github.com", "x-swgg-schemes": [ "https" ], "x-swgg-sortValue": "[Repositories](https://developer.github.com/v3/repos/#list-user-repositories) - List user repositories", "x-swgg-tags0": "github-repos" } } }, "schemes": [ "https" ], "swagger": "2.0", "tags": [ { "name": "github-activity", "x-swgg-descriptionLineList": [ "# [Activity](https://developer.github.com/v3/activity/)", "", "Serving up the 'social' in Social Coding, the Activity APIs provide access to notifications, subscriptions, and timelines.", "", "# [Event Types & Payloads](https://developer.github.com/v3/activity/events/types/)", "", "Each event has a similar JSON schema, but a unique ```payload``` object that is determined by its event type.", "", "Event names are used by [repository webhooks](https://developer.github.com/v3/repos/hooks/) to specify which events the webhook should receive. The included payloads below are from webhook deliveries but match events returned by the [Events API](https://developer.github.com/v3/activity/events/) (except where noted). The Events API uses the CamelCased name (e.g. ```CommitCommentEvent```) in the ```type``` field of an event object and does not include the ```repository``` or ```sender``` fields in the event payload object.", "", "**Note:** Some of these events may not be rendered in timelines, they're only created for various internal and webhook purposes.", "- [CommitCommentEvent](https://developer.github.com/v3/activity/events/types/#commitcommentevent)", "- [CreateEvent](https://developer.github.com/v3/activity/events/types/#createevent)", "- [DeleteEvent](https://developer.github.com/v3/activity/events/types/#deleteevent)", "- [DeploymentEvent](https://developer.github.com/v3/activity/events/types/#deploymentevent)", "- [DeploymentStatusEvent](https://developer.github.com/v3/activity/events/types/#deploymentstatusevent)", "- [DownloadEvent](https://developer.github.com/v3/activity/events/types/#downloadevent)", "- [FollowEvent](https://developer.github.com/v3/activity/events/types/#followevent)", "- [ForkEvent](https://developer.github.com/v3/activity/events/types/#forkevent)", "- [ForkApplyEvent](https://developer.github.com/v3/activity/events/types/#forkapplyevent)", "- [GistEvent](https://developer.github.com/v3/activity/events/types/#gistevent)", "- [GollumEvent](https://developer.github.com/v3/activity/events/types/#gollumevent)", "- [InstallationEvent](https://developer.github.com/v3/activity/events/types/#installationevent)", "- [InstallationRepositoriesEvent](https://developer.github.com/v3/activity/events/types/#installationrepositoriesevent)", "- [IssueCommentEvent](https://developer.github.com/v3/activity/events/types/#issuecommentevent)", "- [IssuesEvent](https://developer.github.com/v3/activity/events/types/#issuesevent)", "- [LabelEvent](https://developer.github.com/v3/activity/events/types/#labelevent)", "- [MarketplacePurchaseEvent](https://developer.github.com/v3/activity/events/types/#marketplacepurchaseevent)", "- [MemberEvent](https://developer.github.com/v3/activity/events/types/#memberevent)", "- [MembershipEvent](https://developer.github.com/v3/activity/events/types/#membershipevent)", "- [MilestoneEvent](https://developer.github.com/v3/activity/events/types/#milestoneevent)", "- [OrganizationEvent](https://developer.github.com/v3/activity/events/types/#organizationevent)", "- [OrgBlockEvent](https://developer.github.com/v3/activity/events/types/#orgblockevent)", "- [PageBuildEvent](https://developer.github.com/v3/activity/events/types/#pagebuildevent)", "- [ProjectCardEvent](https://developer.github.com/v3/activity/events/types/#projectcardevent)", "- [ProjectColumnEvent](https://developer.github.com/v3/activity/events/types/#projectcolumnevent)", "- [ProjectEvent](https://developer.github.com/v3/activity/events/types/#projectevent)", "- [PublicEvent](https://developer.github.com/v3/activity/events/types/#publicevent)", "- [PullRequestEvent](https://developer.github.com/v3/activity/events/types/#pullrequestevent)", "- [PullRequestReviewEvent](https://developer.github.com/v3/activity/events/types/#pullrequestreviewevent)", "- [PullRequestReviewCommentEvent](https://developer.github.com/v3/activity/events/types/#pullrequestreviewcommentevent)", "- [PushEvent](https://developer.github.com/v3/activity/events/types/#pushevent)", "- [ReleaseEvent](https://developer.github.com/v3/activity/events/types/#releaseevent)", "- [RepositoryEvent](https://developer.github.com/v3/activity/events/types/#repositoryevent)", "- [StatusEvent](https://developer.github.com/v3/activity/events/types/#statusevent)", "- [TeamEvent](https://developer.github.com/v3/activity/events/types/#teamevent)", "- [TeamAddEvent](https://developer.github.com/v3/activity/events/types/#teamaddevent)", "- [WatchEvent](https://developer.github.com/v3/activity/events/types/#watchevent)", "", "# [Events](https://developer.github.com/v3/activity/events/)", "", "This is a read-only API to the GitHub events. These events power the various activity streams on the site.", "- [List public events](https://developer.github.com/v3/activity/events/#list-public-events)", "- [List repository events](https://developer.github.com/v3/activity/events/#list-repository-events)", "- [List issue events for a repository](https://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository)", "- [List public events for a network of repositories](https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories)", "- [List public events for an organization](https://developer.github.com/v3/activity/events/#list-public-events-for-an-organization)", "- [List events that a user has received](https://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received)", "- [List public events that a user has received](https://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received)", "- [List events performed by a user](https://developer.github.com/v3/activity/events/#list-events-performed-by-a-user)", "- [List public events performed by a user](https://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user)", "- [List events for an organization](https://developer.github.com/v3/activity/events/#list-events-for-an-organization)", "", "Events are optimized for polling with the \"ETag\" header. If no new events have been triggered, you will see a \"304 Not Modified\" response, and your current rate limit will be untouched. There is also an \"X-Poll-Interval\" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header.", "```", "curl -I https://api.github.com/users/tater/events", "HTTP/1.1 200 OK", "X-Poll-Interval: 60", "ETag: \"a18c3bded88eb5dbb5c849a489412bf3\"", "# The quotes around the ETag value are important", "curl -I https://api.github.com/users/tater/events \\", " -H 'If-None-Match: \"a18c3bded88eb5dbb5c849a489412bf3\"'", "HTTP/1.1 304 Not Modified", "X-Poll-Interval: 60", "```", "", "", "Events support [pagination](https://developer.github.com/v3/#pagination), however the ```per_page``` option is unsupported. The fixed page size is 30 items. Fetching up to ten pages is supported, for a total of 300 events.", "", "Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300).", "", "All Events have the same response format:", "```", "Status: 200 OK", "Link: <https://api.github.com/resource?page=2>; rel=\"next\",", " <https://api.github.com/resource?page=5>; rel=\"last\"", "```", "", "```", "[", " {", " \"type\": \"Event\",", " \"public\": true,", " \"payload\": {", " },", " \"repo\": {", " \"id\": 3,", " \"name\": \"octocat/Hello-World\",", " \"url\": \"https://api.github.com/repos/octocat/Hello-World\"", " },", " \"actor\": {", " \"id\": 1,", " \"login\": \"octocat\",", " \"gravatar_id\": \"\",", " \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",", " \"url\": \"https://api.github.com/users/octocat\"", " },", " \"org\": {", " \"id\": 1,", " \"login\": \"github\",", " \"gravatar_id\": \"\",", " \"url\": \"https://api.github.com/orgs/github\",", " \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\"", " },", " \"created_at\": \"2011-09-06T17:26:27Z\",", " \"id\": \"12345\"", " }", "]", "```", "", "# [Feeds](https://developer.github.com/v3/activity/feeds/)", "", "no description", "", "# [Notifications](https://developer.github.com/v3/activity/notifications/)", "", "Users receive notifications for conversations in repositories they watch including:", "- Issues and their comments", "- Pull Requests and their comments", "- Comments on any commits", "", "Notifications are also sent for conversations in unwatched repositories when the user is involved including:", "- **@mentions**", "- Issue assignments", "- Commits the user authors or commits", "- Any discussion in which the user actively participates", "", "All Notification API calls require the ```notifications``` or ```repo``` API scopes. Doing this will give read-only access to some Issue/Commit content. You will still need the \"repo\" scope to access Issues and Commits from their respective endpoints.", "", "Notifications come back as \"threads\". A Thread contains information about the current discussion of an Issue/PullRequest/Commit.", "", "Notifications are optimized for polling with the \"Last-Modified\" header. If there are no new notifications, you will see a \"304 Not Modified\" response, leaving your current rate limit untouched. There is an \"X-Poll-Interval\" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header.", "```", "# Add authentication to your requests", "curl -I https://api.github.com/notifications", "HTTP/1.1 200 OK", "Last-Modified: Thu, 25 Oct 2012 15:16:27 GMT", "X-Poll-Interval: 60", "# Pass the Last-Modified header exactly", "curl -I https://api.github.com/notifications", " -H \"If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT\"", "HTTP/1.1 304 Not Modified", "X-Poll-Interval: 60", "```", "", "# [Starring](https://developer.github.com/v3/activity/starring/)", "", "Repository Starring is a feature that lets users bookmark repositories. Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed. For that, see [Repository Watching](https://developer.github.com/v3/activity/watching).", "", "#### Starring vs. Watching", "", "In August 2012, we [changed the way watching works](https://github.com/blog/1204-notifications-stars) on GitHub. Many API client applications may be using the original \"watcher\" endpoints for accessing this data. You can now start using the \"star\" endpoints instead (described below). Check out the [Watcher API Change post](https://developer.github.com/changes/2012-09-05-watcher-api/) for more details.", "", "# [Watching](https://developer.github.com/v3/activity/watching/)", "", "Watching a Repository registers the user to receive notifications on new discussions, as well as events in the user's activity feed. See [Repository Starring](https://developer.github.com/v3/activity/starring) for simple repository bookmarks.", "", "#### Watching vs. Starring", "", "In August 2012, we [changed the way watching works](https://github.com/blog/1204-notifications-stars) on GitHub. At the time of that change, many API clients were already using the existing \"watcher\" endpoints to access starring data. To avoid breaking those applications, the legacy \"watcher\" endpoints continue to provide starring data.", "", "To provide access to watching data, the v3 Watcher API uses the \"subscription\" endpoints described below. Check out the [Watcher API Change post](https://developer.github.com/changes/2012-09-05-watcher-api/) for more details." ] }, { "name": "github-apps", "x-swgg-descriptionLineList": [ "# [GitHub Apps](https://developer.github.com/v3/apps/)", "", "For information on how to authenticate as a GitHub App, see \"[Authentication Options for GitHub Apps](https://developer.github.com/apps/building-github-apps/authentication-options-for-github-apps#authenticating-as-a-github-app).\"", "", "**Note:** To access the API with your integration, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` Header for your requests.", "", "```", "application/vnd.github.machine-man-preview+json", "```", "", "# [GitHub App Permissions](https://developer.github.com/v3/apps/permissions/)", "", "**Note:** To access the API with your integration, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` Header for your requests.", "", "```", "application/vnd.github.machine-man-preview+json", "```", "", "GitHub Apps are created with a set of permissions. These define what resources the GitHub App can access via the API. For more information, see \"[Permissions for GitHub Apps](https://developer.github.com/apps/building-github-apps/permissions-for-github-apps/).\"", "", "# [GitHub Apps: Available Endpoints](https://developer.github.com/v3/apps/available-endpoints/)", "", "**Note:** To access the API with your integration, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` Header for your requests.", "", "```", "application/vnd.github.machine-man-preview+json", "```", "", "The following endpoints are available for use by GitHub Apps. For more information, see \"[GitHub Apps](https://developer.github.com/apps/building-github-apps/).\"", "", "#### Members", "- [Members list](https://developer.github.com/v3/orgs/members/#members-list)", "- [Check membership](https://developer.github.com/v3/orgs/members/#check-membership)", "- [Remove a member](https://developer.github.com/v3/orgs/members/#remove-a-member)", "- [Get organization membership](https://developer.github.com/v3/orgs/members/#get-organization-membership)", "- [Add or update organization membership](https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership)", "- [Remove organization membership](https://developer.github.com/v3/orgs/members/#remove-organization-membership)", "", "#### Outside Collaborators", "- [List outside collaborators](https://developer.github.com/v3/orgs/outside_collaborators/#list-outside-collaborators)", "- [Remove outside collaborator](https://developer.github.com/v3/orgs/outside_collaborators/#remove-outside-collaborator)", "- [Convert member to outside collaborator](https://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator)", "", "#### Projects", "- [List repository projects](https://developer.github.com/v3/projects/#list-repository-projects)", "- [List organization projects](https://developer.github.com/v3/projects/#list-organization-projects)", "- [Get a project](https://developer.github.com/v3/projects/#get-a-project)", "- [Create a repository project](https://developer.github.com/v3/projects/#create-a-repository-project)", "- [Create an organization project](https://developer.github.com/v3/projects/#create-an-organization-project)", "- [Update a project](https://developer.github.com/v3/projects/#update-a-project)", "- [Delete a project](https://developer.github.com/v3/projects/#delete-a-project)", "", "#### Teams", "- [List teams](https://developer.github.com/v3/teams/#list-teams)", "- [Get team](https://developer.github.com/v3/teams/#get-team)", "- [Edit team](https://developer.github.com/v3/teams/#edit-team)", "- [Delete team](https://developer.github.com/v3/teams/#delete-team)", "- [List child teams](https://developer.github.com/v3/teams/#list-child-teams)", "- [List team repos](https://developer.github.com/v3/teams/#list-team-repos)", "", "#### Users", "- [Get a single user](https://developer.github.com/v3/users/#get-a-single-user)", "- [Get all users](https://developer.github.com/v3/users/#get-all-users)", "", "#### Overview", "- [Root endpoint](https://developer.github.com/v3/#root-endpoint)", "", "#### Review Comments", "- [List comments on a pull request](https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request)", "- [List comments in a repository](https://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository)", "- [Get a single comment](https://developer.github.com/v3/pulls/comments/#get-a-single-comment)", "- [Create a comment](https://developer.github.com/v3/pulls/comments/#create-a-comment)", "- [Edit a comment](https://developer.github.com/v3/pulls/comments/#edit-a-comment)", "- [Delete a comment](https://developer.github.com/v3/pulls/comments/#delete-a-comment)", "", "#### Reviews", "- [Get a single review](https://developer.github.com/v3/pulls/reviews/#get-a-single-review)", "- [Get comments for a single review](https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review)", "- [Create a pull request review](https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review)", "", "#### Team Discussion Comments", "- [List comments](https://developer.github.com/v3/teams/discussion_comments/#list-comments)", "- [Get a single comment](https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment)", "- [Create a comment](https://developer.github.com/v3/teams/discussion_comments/#create-a-comment)", "- [Edit a comment](https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment)", "- [Delete a comment](https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment)", "", "#### Team Discussions", "- [List discussions](https://developer.github.com/v3/teams/discussions/#list-discussions)", "- [Get a single discussion](https://developer.github.com/v3/teams/discussions/#get-a-single-discussion)", "- [Create a discussion](https://developer.github.com/v3/teams/discussions/#create-a-discussion)", "- [Edit a discussion](https://developer.github.com/v3/teams/discussions/#edit-a-discussion)", "- [Delete a discussion](https://developer.github.com/v3/teams/discussions/#delete-a-discussion)", "", "#### Team Members", "- [List team members](https://developer.github.com/v3/teams/members/#list-team-members)", "- [Get team member](https://developer.github.com/v3/teams/members/#get-team-member)", "- [Get team membership](https://developer.github.com/v3/teams/members/#get-team-membership)", "- [Add or update team membership](https://developer.github.com/v3/teams/members/#add-or-update-team-membership)", "- [Remove team membership](https://developer.github.com/v3/teams/members/#remove-team-membership)", "- [List pending team invitations](https://developer.github.com/v3/teams/members/#list-pending-team-invitations)", "", "#### Feeds", "- [List Feeds](https://developer.github.com/v3/activity/feeds/#list-feeds)", "", "#### Starring", "- [List Stargazers](https://developer.github.com/v3/activity/starring/#list-stargazers)", "", "#### Events", "- [List public events](https://developer.github.com/v3/activity/events/#list-public-events)", "- [List repository events](https://developer.github.com/v3/activity/events/#list-repository-events)", "- [List public events for a network of repositories](https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories)", "- [List public events for an organization](https://developer.github.com/v3/activity/events/#list-public-events-for-an-organization)", "- [List events that a user has received](https://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received)", "- [List public events that a user has received](https://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received)", "- [List events performed by a user](https://developer.github.com/v3/activity/events/#list-events-performed-by-a-user)", "- [List public events performed by a user](https://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user)", "- [List events for an issue](https://developer.github.com/v3/issues/events/#list-events-for-an-issue)", "- [List events for a repository](https://developer.github.com/v3/issues/events/#list-events-for-a-repository)", "- [Get a single event](https://developer.github.com/v3/issues/events/#get-a-single-event)", "", "#### Watching", "- [List watchers](https://developer.github.com/v3/activity/watching/#list-watchers)", "", "#### References", "- [Get a Reference](https://developer.github.com/v3/git/refs/#get-a-reference)", "- [Get all References](https://developer.github.com/v3/git/refs/#get-all-references)", "- [Create a Reference](https://developer.github.com/v3/git/refs/#create-a-reference)", "- [Update a Reference](https://developer.github.com/v3/git/refs/#update-a-reference)", "- [Delete a Reference](https://developer.github.com/v3/git/refs/#delete-a-reference)", "", "#### Commits", "- [Get a Commit](https://developer.github.com/v3/git/commits/#get-a-commit)", "- [Create a Commit](https://developer.github.com/v3/git/commits/#create-a-commit)", "- [List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)", "- [Get a single commit](https://developer.github.com/v3/repos/commits/#get-a-single-commit)", "- [Get the SHA-1 of a commit reference](https://developer.github.com/v3/repos/commits/#get-the-sha-1-of-a-commit-reference)", "", "#### Trees", "- [Get a Tree](https://developer.github.com/v3/git/trees/#get-a-tree)", "- [Create a Tree](https://developer.github.com/v3/git/trees/#create-a-tree)", "", "#### Blobs", "- [Get a Blob](https://developer.github.com/v3/git/blobs/#get-a-blob)", "- [Create a Blob](https://developer.github.com/v3/git/blobs/#create-a-blob)", "", "#### Tags", "- [Get a Tag](https://developer.github.com/v3/git/tags/#get-a-tag)", "- [Create a Tag Object](https://developer.github.com/v3/git/tags/#create-a-tag-object)", "", "#### Miscellaneous", "- [Emojis](https://developer.github.com/v3/misc/#emojis)", "", "#### Pull Requests", "- [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)", "- [Get a single pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request)", "- [Create a pull request](https://developer.github.com/v3/pulls/#create-a-pull-request)", "- [Update a pull request](https://developer.github.com/v3/pulls/#update-a-pull-request)", "- [List commits on a pull request](https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request)", "- [List pull requests files](https://developer.github.com/v3/pulls/#list-pull-requests-files)", "- [Get if a pull request has been merged](https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged)", "", "#### Issues", "- [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository)", "- [Get a single issue](https://developer.github.com/v3/issues/#get-a-single-issue)", "- [Create an issue](https://developer.github.com/v3/issues/#create-an-issue)", "- [Edit an issue](https://developer.github.com/v3/issues/#edit-an-issue)", "- [Lock an issue](https://developer.github.com/v3/issues/#lock-an-issue)", "- [Unlock an issue](https://developer.github.com/v3/issues/#unlock-an-issue)", "", "#### Organizations", "- [List all organizations](https://developer.github.com/v3/orgs/#list-all-organizations)", "- [List user organizations](https://developer.github.com/v3/orgs/#list-user-organizations)", "", "#### Rate Limit", "- [Get your current rate limit status](https://developer.github.com/v3/rate_limit/#get-your-current-rate-limit-status)", "", "#### Source Imports", "- [Start an import](https://developer.github.com/v3/migration/source_imports/#start-an-import)", "- [Get import progress](https://developer.github.com/v3/migration/source_imports/#get-import-progress)", "- [Update existing import](https://developer.github.com/v3/migration/source_imports/#update-existing-import)", "- [Get commit authors](https://developer.github.com/v3/migration/source_imports/#get-commit-authors)", "- [Map a commit author](https://developer.github.com/v3/migration/source_imports/#map-a-commit-author)", "- [Set Git LFS preference](https://developer.github.com/v3/migration/source_imports/#set-git-lfs-preference)", "- [Get large files](https://developer.github.com/v3/migration/source_imports/#get-large-files)", "- [Cancel an import](https://developer.github.com/v3/migration/source_imports/#cancel-an-import)", "", "#### Repositories", "- [List user repositories](https://developer.github.com/v3/repos/#list-user-repositories)", "- [List all public repositories](https://developer.github.com/v3/repos/#list-all-public-repositories)", "- [Create](https://developer.github.com/v3/repos/#create)", "- [Get](https://developer.github.com/v3/repos/#get)", "- [Edit](https://developer.github.com/v3/repos/#edit)", "- [List all topics for a repository](https://developer.github.com/v3/repos/#list-all-topics-for-a-repository)", "- [Replace all topics for a repository](https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository)", "- [List contributors](https://developer.github.com/v3/repos/#list-contributors)", "- [List languages](https://developer.github.com/v3/repos/#list-languages)", "- [List teams](https://developer.github.com/v3/repos/#list-teams)", "- [List tags](https://developer.github.com/v3/repos/#list-tags)", "- [Delete a repository](https://developer.github.com/v3/repos/#delete-a-repository)", "", "#### Project columns", "- [Get a project column](https://developer.github.com/v3/projects/columns/#get-a-project-column)", "- [Create a project column](https://developer.github.com/v3/projects/columns/#create-a-project-column)", "- [Update a project column](https://developer.github.com/v3/projects/columns/#update-a-project-column)", "- [Delete a project column](https://developer.github.com/v3/projects/columns/#delete-a-project-column)", "- [Move a project column](https://developer.github.com/v3/projects/columns/#move-a-project-column)", "", "#### Project cards", "- [List project cards](https://developer.github.com/v3/projects/cards/#list-project-cards)", "- [Get a project card](https://developer.github.com/v3/projects/cards/#get-a-project-card)", "- [Create a project card](https://developer.github.com/v3/projects/cards/#create-a-project-card)", "- [Update a project card](https://developer.github.com/v3/projects/cards/#update-a-project-card)", "- [Delete a project card](https://developer.github.com/v3/projects/cards/#delete-a-project-card)", "- [Move a project card](https://developer.github.com/v3/projects/cards/#move-a-project-card)", "", "#### Branches", "- [List branches](https://developer.github.com/v3/repos/branches/#list-branches)", "- [Get branch](https://developer.github.com/v3/repos/branches/#get-branch)", "- [Get branch protection](https://developer.github.com/v3/repos/branches/#get-branch-protection)", "- [Update branch protection](https://developer.github.com/v3/repos/branches/#update-branch-protection)", "- [Remove branch protection](https://developer.github.com/v3/repos/branches/#remove-branch-protection)", "- [Get required status checks of protected branch](https://developer.github.com/v3/repos/branches/#get-required-status-checks-of-protected-branch)", "- [Update required status checks of protected branch](https://developer.github.com/v3/repos/branches/#update-required-status-checks-of-protected-branch)", "- [Remove required status checks of protected branch](https://developer.github.com/v3/repos/branches/#remove-required-status-checks-of-protected-branch)", "- [List required status checks contexts of protected branch](https://developer.github.com/v3/repos/branches/#list-required-status-checks-contexts-of-protected-branch)", "- [Replace required status checks contexts of protected branch](https://developer.github.com/v3/repos/branches/#replace-required-status-checks-contexts-of-protected-branch)", "- [Add required status checks contexts of protected branch](https://developer.github.com/v3/repos/branches/#add-required-status-checks-contexts-of-protected-branch)", "- [Remove required status checks contexts of protected branch](https://developer.github.com/v3/repos/branches/#remove-required-status-checks-contexts-of-protected-branch)", "- [Get pull request review enforcement of protected branch](https://developer.github.com/v3/repos/branches/#get-pull-request-review-enforcement-of-protected-branch)", "- [Update pull request review enforcement of protected branch](https://developer.github.com/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch)", "- [Remove pull request review enforcement of protected branch](https://developer.github.com/v3/repos/branches/#remove-pull-request-review-enforcement-of-protected-branch)", "- [Get required signatures of protected branch](https://developer.github.com/v3/repos/branches/#get-required-signatures-of-protected-branch)", "- [Add required signatures of protected branch](https://developer.github.com/v3/repos/branches/#add-required-signatures-of-protected-branch)", "- [Remove required signatures of protected branch](https://developer.github.com/v3/repos/branches/#remove-required-signatures-of-protected-branch)", "- [Get admin enforcement of protected branch](https://developer.github.com/v3/repos/branches/#get-admin-enforcement-of-protected-branch)", "- [Add admin enforcement of protected branch](https://developer.github.com/v3/repos/branches/#add-admin-enforcement-of-protected-branch)", "- [Remove admin enforcement of protected branch](https://developer.github.com/v3/repos/branches/#remove-admin-enforcement-of-protected-branch)", "- [Get restrictions of protected branch](https://developer.github.com/v3/repos/branches/#get-restrictions-of-protected-branch)", "- [Remove restrictions of protected branch](https://developer.github.com/v3/repos/branches/#remove-restrictions-of-protected-branch)", "- [List team restrictions of protected branch](https://developer.github.com/v3/repos/branches/#list-team-restrictions-of-protected-branch)", "- [Replace team restrictions of protected branch](https://developer.github.com/v3/repos/branches/#replace-team-restrictions-of-protected-branch)", "- [Add team restrictions of protected branch](https://developer.github.com/v3/repos/branches/#add-team-restrictions-of-protected-branch)", "- [Remove team restrictions of protected branch](https://developer.github.com/v3/repos/branches/#remove-team-restrictions-of-protected-branch)", "- [List user restrictions of protected branch](https://developer.github.com/v3/repos/branches/#list-user-restrictions-of-protected-branch)", "- [Replace user restrictions of protected branch](https://developer.github.com/v3/repos/branches/#replace-user-restrictions-of-protected-branch)", "- [Add user restrictions of protected branch](https://developer.github.com/v3/repos/branches/#add-user-restrictions-of-protected-branch)", "- [Remove user restrictions of protected branch](https://developer.github.com/v3/repos/branches/#remove-user-restrictions-of-protected-branch)", "", "#### Forks", "- [List forks](https://developer.github.com/v3/repos/forks/#list-forks)", "- [Create a fork](https://developer.github.com/v3/repos/forks/#create-a-fork)", "", "#### Comments", "- [List commit comments for a repository](https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository)", "- [List comments for a single commit](https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit)", "- [Create a commit comment](https://developer.github.com/v3/repos/comments/#create-a-commit-comment)", "- [Get a single commit comment](https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment)", "- [Update a commit comment](https://developer.github.com/v3/repos/comments/#update-a-commit-comment)", "- [Delete a commit comment](https://developer.github.com/v3/repos/comments/#delete-a-commit-comment)", "- [List comments on an issue](https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue)", "- [List comments in a repository](https://developer.github.com/v3/issues/comments/#list-comments-in-a-repository)", "- [Get a single comment](https://developer.github.com/v3/issues/comments/#get-a-single-comment)", "- [Create a comment](https://developer.github.com/v3/issues/comments/#create-a-comment)", "- [Edit a comment](https://developer.github.com/v3/issues/comments/#edit-a-comment)", "- [Delete a comment](https://developer.github.com/v3/issues/comments/#delete-a-comment)", "", "#### Merging", "- [Perform a merge](https://developer.github.com/v3/repos/merging/#perform-a-merge)", "", "#### Contents", "- [Get the README](https://developer.github.com/v3/repos/contents/#get-the-readme)", "- [Get contents](https://developer.github.com/v3/repos/contents/#get-contents)", "- [Create a file](https://developer.github.com/v3/repos/contents/#create-a-file)", "- [Update a file](https://developer.github.com/v3/repos/contents/#update-a-file)", "- [Delete a file](https://developer.github.com/v3/repos/contents/#delete-a-file)", "- [Get archive link](https://developer.github.com/v3/repos/contents/#get-archive-link)", "", "#### Statuses", "- [Create a status](https://developer.github.com/v3/repos/statuses/#create-a-status)", "- [List statuses for a specific ref](https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref)", "- [Get the combined status for a specific ref](https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref)", "", "#### Pages", "- [Get information about a Pages site](https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site)", "- [Request a page build](https://developer.github.com/v3/repos/pages/#request-a-page-build)", "- [List Pages builds](https://developer.github.com/v3/repos/pages/#list-pages-builds)", "- [List latest Pages build](https://developer.github.com/v3/repos/pages/#list-latest-pages-build)", "- [List a specific Pages build](https://developer.github.com/v3/repos/pages/#list-a-specific-pages-build)", "", "#### Community Profile", "- [Retrieve community profile metrics](https://developer.github.com/v3/repos/community/#retrieve-community-profile-metrics)", "", "#### Deployments", "- [List deployments](https://developer.github.com/v3/repos/deployments/#list-deployments)", "- [Get a single deployment](https://developer.github.com/v3/repos/deployments/#get-a-single-deployment)", "- [Create a deployment](https://developer.github.com/v3/repos/deployments/#create-a-deployment)", "- [List deployment statuses](https://developer.github.com/v3/repos/deployments/#list-deployment-statuses)", "- [Get a single deployment status](https://developer.github.com/v3/repos/deployments/#get-a-single-deployment-status)", "- [Create a deployment status](https://developer.github.com/v3/repos/deployments/#create-a-deployment-status)", "", "#### Deploy Keys", "- [List deploy keys](https://developer.github.com/v3/repos/keys/#list-deploy-keys)", "- [Get a deploy key](https://developer.github.com/v3/repos/keys/#get-a-deploy-key)", "- [Add a new deploy key](https://developer.github.com/v3/repos/keys/#add-a-new-deploy-key)", "- [Remove a deploy key](https://developer.github.com/v3/repos/keys/#remove-a-deploy-key)", "", "#### Statistics", "- [Get contributors list with additions, deletions, and commit counts](https://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts)", "- [Get the last year of commit activity data](https://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data)", "- [Get the number of additions and deletions per week](https://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week)", "- [Get the weekly commit count for the repository owner and everyone else](https://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repository-owner-and-everyone-else)", "- [Get the number of commits per hour in each day](https://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day)", "", "#### Releases", "- [List releases for a repository](https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository)", "- [Get a single release](https://developer.github.com/v3/repos/releases/#get-a-single-release)", "- [Get the latest release](https://developer.github.com/v3/repos/releases/#get-the-latest-release)", "- [Get a release by tag name](https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name)", "- [Create a release](https://developer.github.com/v3/repos/releases/#create-a-release)", "- [Edit a release](https://developer.github.com/v3/repos/releases/#edit-a-release)", "- [Delete a release](https://developer.github.com/v3/repos/releases/#delete-a-release)", "- [List assets for a release](https://developer.github.com/v3/repos/releases/#list-assets-for-a-release)", "- [Upload a release asset](https://developer.github.com/v3/repos/releases/#upload-a-release-asset)", "- [Get a single release asset](https://developer.github.com/v3/repos/releases/#get-a-single-release-asset)", "- [Edit a release asset](https://developer.github.com/v3/repos/releases/#edit-a-release-asset)", "- [Delete a release asset](https://developer.github.com/v3/repos/releases/#delete-a-release-asset)", "", "#### Collaborators", "- [List collaborators](https://developer.github.com/v3/repos/collaborators/#list-collaborators)", "- [Check if a user is a collaborator](https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator)", "- [Review a user's permission level](https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level)", "- [Add user as a collaborator](https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator)", "- [Remove user as a collaborator](https://developer.github.com/v3/repos/collaborators/#remove-user-as-a-collaborator)", "", "#### Search", "- [Search repositories](https://developer.github.com/v3/search/#search-repositories)", "- [Search commits](https://developer.github.com/v3/search/#search-commits)", "- [Search code](https://developer.github.com/v3/search/#search-code)", "- [Search issues](https://developer.github.com/v3/search/#search-issues)", "- [Search users](https://developer.github.com/v3/search/#search-users)", "- [Search topics](https://developer.github.com/v3/search/#search-topics)", "- [Search labels](https://developer.github.com/v3/search/#search-labels)", "", "#### Meta", "- [Meta](https://developer.github.com/v3/meta/#meta)", "", "#### Codes of Conduct", "- [List all codes of conduct](https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct)", "- [Get an individual code of conduct](https://developer.github.com/v3/codes_of_conduct/#get-an-individual-code-of-conduct)", "- [Get a repository's code of conduct](https://developer.github.com/v3/codes_of_conduct/#get-a-repositorys-code-of-conduct)", "", "#### Public Keys", "- [List public keys for a user](https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user)", "", "#### GitHub Apps", "- [Get a single GitHub App](https://developer.github.com/v3/apps/#get-a-single-github-app)", "- [Get the authenticated GitHub App](https://developer.github.com/v3/apps/#get-the-authenticated-github-app)", "- [Find installations](https://developer.github.com/v3/apps/#find-installations)", "- [Get a single installation](https://developer.github.com/v3/apps/#get-a-single-installation)", "- [Create a new installation token](https://developer.github.com/v3/apps/#create-a-new-installation-token)", "", "#### Installations", "- [List repositories](https://developer.github.com/v3/apps/installations/#list-repositories)", "", "#### Licenses", "- [List all licenses](https://developer.github.com/v3/licenses/#list-all-licenses)", "- [Get an individual license](https://developer.github.com/v3/licenses/#get-an-individual-license)", "", "#### Reactions", "- [List reactions for a commit comment](https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment)", "- [List reactions for an issue](https://developer.github.com/v3/reactions/#list-reactions-for-an-issue)", "- [List reactions for an issue comment](https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment)", "- [List reactions for a pull request review comment](https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment)", "- [List reactions for a team discussion](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion)", "- [List reactions for a team discussion comment](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment)", "", "#### Markdown", "- [Render an arbitrary Markdown document](https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document)", "- [Render a Markdown document in raw mode](https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode)", "", "#### Milestones", "- [List milestones for a repository](https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository)", "- [Get a single milestone](https://developer.github.com/v3/issues/milestones/#get-a-single-milestone)", "- [Create a milestone](https://developer.github.com/v3/issues/milestones/#create-a-milestone)", "- [Update a milestone](https://developer.github.com/v3/issues/milestones/#update-a-milestone)", "- [Delete a milestone](https://developer.github.com/v3/issues/milestones/#delete-a-milestone)", "", "#### Labels", "- [List all labels for this repository](https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository)", "- [Get a single label](https://developer.github.com/v3/issues/labels/#get-a-single-label)", "- [Create a label](https://developer.github.com/v3/issues/labels/#create-a-label)", "- [Update a label](https://developer.github.com/v3/issues/labels/#update-a-label)", "- [Delete a label](https://developer.github.com/v3/issues/labels/#delete-a-label)", "- [List labels on an issue](https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue)", "- [Add labels to an issue](https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue)", "- [Remove a label from an issue](https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue)", "- [Replace all labels for an issue](https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue)", "- [Remove all labels from an issue](https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue)", "- [Get labels for every issue in a milestone](https://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone)", "", "#### Timeline", "- [List events for an issue](https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue)", "", "#### Assignees", "- [List assignees](https://developer.github.com/v3/issues/assignees/#list-assignees)", "- [Check assignee](https://developer.github.com/v3/issues/assignees/#check-assignee)", "- [Add assignees to an issue](https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue)", "- [Remove assignees from an issue](https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue)", "", "# [GitHub Marketplace](https://developer.github.com/v3/apps/marketplace/)", "", "**Note:** The The GitHub Marketplace API on GitHub is currently available for developers to preview. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.valkyrie-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "For more information about GitHub Marketplace, see \"[GitHub Marketplace](https://developer.github.com/apps/marketplace/).\"", "", "**Note:** This preview includes methods for testing with **stubbed data**. Stubbed data is fake data that's useful for testing your GitHub Apps. Stubbed data is hard-coded and will not change based on actual subscriptions.", "", "To test with stubbed data, use a stubbed endpoint in place of its production counterpart. This allows you to test whether API logic succeeds before listing GitHub Apps on GitHub Marketplace.", "", "Be sure to replace stubbed endpoints with production endpoints before deploying your GitHub App.", "", "Endpoints for ```/marketplace_listing/*``` and ```/user/marketplace_purchases``` are only accessible by OAuth Apps using ```client_id``` and ```secret``` basic authentication or by [GitHub Apps using a JWT](https://developer.github.com/apps/building-github-apps/authentication-options-for-github-apps/#authenticating-as-a-github-app).", "-", "", "For API authentication for GitHub Marketplace listings associated with an OAuth App, see \"[Authorization options for OAuth Apps](https://developer.github.com/apps/building-oauth-apps/authorization-options-for-oauth-apps/).\"", "-", "", "For API authentication for GitHub Marketplace listings associated with a GitHub App, see \"[Authentication options for GitHub Apps](https://developer.github.com/apps/building-github-apps/authentication-options-for-github-apps/).\"", "", "# [Installations](https://developer.github.com/v3/apps/installations/)", "", "For information on how to authenticate as an installation, see \"[Authentication Options for GitHub Apps](https://developer.github.com/apps/building-github-apps/authentication-options-for-github-apps#authenticating-as-an-installation).\"", "", "**Note:** To access the API with your integration, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` Header for your requests.", "", "```", "application/vnd.github.machine-man-preview+json", "```" ] }, { "name": "github-gists", "x-swgg-descriptionLineList": [ "# [Gists](https://developer.github.com/v3/gists/)", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "Custom media types", "", "The following media types are supported when fetching gist contents. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/vnd.github.VERSION.raw", "application/vnd.github.VERSION.base64", "```", "", "# [Gist Comments](https://developer.github.com/v3/gists/comments/)", "", "Gist Comments use [these custom media types](https://developer.github.com/v3/gists/comments/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "", "Custom media types", "", "These are the supported media types for gist comments. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/vnd.github.VERSION.raw+json", "application/vnd.github.VERSION.text+json", "application/vnd.github.VERSION.html+json", "application/vnd.github.VERSION.full+json", "```" ] }, { "name": "github-git", "x-swgg-descriptionLineList": [ "# [Git Data](https://developer.github.com/v3/git/)", "", "The Git Database API gives you access to read and write raw Git objects to your Git database on GitHub and to list and update your references (branch heads and tags).", "", "This basically allows you to reimplement a lot of Git functionality over our API - by creating raw objects directly into the database and updating branch references you could technically do just about anything that Git can do without having Git installed.", "", "Git DB API functions will return a ```409 Conflict``` if the git repository for a Repository is empty or unavailable. This typically means it is being created still. Contact [GitHub support](https://github.com/contact) if this response status persists.", "", "For more information on the Git object database, please read the [Git Internals](http://git-scm.com/book/en/v1/Git-Internals) chapter of the Pro Git book.", "", "As an example, if you wanted to commit a change to a file in your repository, you would:", "- get the current commit object", "- retrieve the tree it points to", "- retrieve the content of the blob object that tree has for that particular file path", "- change the content somehow and post a new blob object with that new content, getting a blob SHA back", "- post a new tree object with that file path pointer replaced with your new blob SHA getting a tree SHA back", "- create a new commit object with the current commit SHA as the parent and the new tree SHA, getting a commit SHA back", "- update the reference of your branch to point to the new commit SHA", "", "It might seem complex, but it's actually pretty simple when you understand the model and it opens up a ton of things you could potentially do with the API.", "", "# [Git Blobs](https://developer.github.com/v3/git/blobs/)", "", "Blobs leverage [these custom media types](https://developer.github.com/v3/git/blobs/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "Custom media types", "", "These are the supported media types for blobs. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/json", "application/vnd.github.VERSION.raw", "```", "", "# [Git Commits](https://developer.github.com/v3/git/commits/)", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Git Refs](https://developer.github.com/v3/git/refs/)", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Git Tags](https://developer.github.com/v3/git/tags/)", "", "This tags API only deals with tag objects - so only annotated tags, not lightweight tags.", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Git Trees](https://developer.github.com/v3/git/trees/)", "", "no description" ] }, { "name": "github-issues", "x-swgg-descriptionLineList": [ "# [Issues](https://developer.github.com/v3/issues/)", "", "Issues use [these custom media types](https://developer.github.com/v3/issues/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "Custom media types", "", "These are the supported media types for issues. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/vnd.github.VERSION.raw+json", "application/vnd.github.VERSION.text+json", "application/vnd.github.VERSION.html+json", "application/vnd.github.VERSION.full+json", "```", "", "# [Issue Assignees](https://developer.github.com/v3/issues/assignees/)", "", "no description", "", "# [Issue Comments](https://developer.github.com/v3/issues/comments/)", "", "The Issue Comments API supports listing, viewing, editing, and creating comments on issues and pull requests.", "", "Issue Comments use [these custom media types](https://developer.github.com/v3/issues/comments/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "", "Custom media types", "", "These are the supported media types for issue comments. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/vnd.github.VERSION.raw+json", "application/vnd.github.VERSION.text+json", "application/vnd.github.VERSION.html+json", "application/vnd.github.VERSION.full+json", "```", "", "# [Issue Events](https://developer.github.com/v3/issues/events/)", "", "Records various events that occur around an issue or pull request. This is useful both for display on issue/pull request information pages and also to determine who should be notified of comments.", "", "#### Attributes", "- id - The Integer ID of the event.", "- url - The API URL for fetching the event.", "- actor - The User object that generated the event.", "- commit_id - The String SHA of a commit that referenced this Issue", "- commit_url - The GitHub API link to a commit that referenced this Issue", "- event - Identifies the actual type of Event that occurred.", "- created_at - The timestamp indicating when the event occurred.", "- labels - The Labels object, including `name` and `color` attributes. Only provided for `labeled` and `unlabeled` events.", "- assignee - The User object which was assigned to (or unassigned from) this Issue. Only provided for 'assigned' and 'unassigned' events.", "- assigner - The User object that performed the assignment (or unassignment) for this Issue. Only provided for 'assigned' and 'unassigned' events.", "- review_requester - The User who requested a review. Only provided for 'review_requested' and 'review_request_removed' events.", "- requested_reviewers - The Users whose reviews were requested. Only provided for 'review_requested' and 'review_request_removed' events.", "- lock_reason - The reason an issue or pull request conversation was locked, if one was provided. Only provided for `locked` events.", "- dismissed_review - A `dismissed_review` object that includes the `state`, `review_id`, `dismissal_message`, and `dismissal_commit_id` (the ID of the commit that dismissed the review) if one exists. Possible `state` strings include `commented`, `approved`, or `changes_requested`. Only provided for `review_dismissed` events.", "- milestone - The Milestone object including a `title` attribute. Only provided for `milestoned` and `demilestoned` events.", "- rename - An object containing rename details including `from` and `to` attributes. Only provided for `renamed` events.", "", "#### Events", "- closed - The issue was closed by the actor. When the commit_id is present, it identifies the commit that closed the issue using \"closes / fixes #NN\" syntax.", "- reopened - The issue was reopened by the actor.", "- subscribed - The actor subscribed to receive notifications for an issue.", "- merged - The issue was merged by the actor. The `commit_id` attribute is the SHA1 of the HEAD commit that was merged.", "- referenced - The issue was referenced from a commit message. The `commit_id` attribute is the commit SHA1 of where that happened.", "- mentioned - The actor was @mentioned in an issue body.", "- assigned - The issue was assigned to the actor.", "- unassigned - The actor was unassigned from the issue.", "- labeled - A label was added to the issue.", "- unlabeled - A label was removed from the issue.", "- milestoned - The issue was added to a milestone.", "- demilestoned - The issue was removed from a milestone.", "- renamed - The issue title was changed.", "- locked - The issue was locked by the actor.", "- unlocked - The issue was unlocked by the actor.", "- head_ref_deleted - The pull request's branch was deleted.", "- head_ref_restored - The pull request's branch was restored.", "- review_dismissed - The actor dismissed a review from the pull request.", "- review_requested - The actor requested review from the subject on this pull request.", "- review_request_removed - The actor removed the review request for the subject on this pull request.", "- marked_as_duplicate - A user with write permissions marked an issue as a duplicate of another issue or a pull request as a duplicate of another pull request.", "- unmarked_as_duplicate - An issue that a user had previously marked as a duplicate of another issue is no longer considered a duplicate, or a pull request that a user had previously marked as a duplicate of another pull request is no longer considered a duplicate.", "- added_to_project - The issue was added to a project board.", "- moved_columns_in_project - The issue was moved between columns in a project board.", "- removed_from_project - The issue was removed from a project board.", "- converted_note_to_issue - The issue was created by converting a note in a project board to an issue.", "", "**Note**: The project-related events ```added_to_project```, ```moved_columns_in_project```, ```removed_from_project```, and ```converted_note_to_issue``` will not be included in the response if project boards have been [disabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) in the repository.", "", "# [Issue Labels](https://developer.github.com/v3/issues/labels/)", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Issue Milestones](https://developer.github.com/v3/issues/milestones/)", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Issue Timeline](https://developer.github.com/v3/issues/timeline/)", "", "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details.", "", "To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.mockingbird-preview", "```", "", "#### Timeline", "- [List events for an issue](https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue)", "", "Records various events that occur around an issue or pull request. This is useful both for display on issue and pull request information pages, as well as to determine who should be notified of comments.", "", "#### Attributes", "- id - The Integer ID of the event.", "- url - The API URL for fetching the event.", "- actor - The User object that generated the event.", "- commit_id - The String SHA of a commit that referenced this Issue.", "- event - Identifies the actual type of Event that occurred.", "- created_at - The timestamp indicating when the event occurred.", "- label - The Label object including `name` and `color` attributes. Only provided for `labeled` and `unlabeled` events.", "- assignee - The User object which was assigned to (or unassigned from) this Issue. Only provided for `assigned` and `unassigned` events.", "- dismissed_review - A `dismissed_review` object that includes the `state`, `review_id`, `dismissal_message`, and `dismissal_commit_id` (the ID of the commit that dismissed the review) if one exists. Possible `state` strings include `commented`, `approved`, or `changes_requested`. Only provided for `review_dismissed` events.", "- milestone - The Milestone object including a `title` attribute. Only provided for `milestoned` and `demilestoned` events.", "- source - The `id`, `actor`, and `url` for the source of a reference from another issue. Only provided for `cross-referenced` events.", "- rename - An object containing rename details including `from` and `to` attributes. Only provided for `renamed` events.", "", "#### Events", "- added_to_project - The issue was added to a project board.", "- assigned - The issue was assigned to the assignee.", "- closed - The issue was closed by the actor. When the commit_id is present, it identifies the commit that closed the issue using \"closes / fixes #NN\" syntax.", "- commented - A comment was added to the issue.", "- committed - A commit was added to the pull request's `HEAD` branch. Only provided for pull requests.", "- converted_note_to_issue - The issue was created by converting a note in a project board to an issue.", "- cross-referenced - The issue was referenced from another issue. The `source` attribute contains the `id`, `actor`, and `url` of the reference's source.", "- demilestoned - The issue was removed from a milestone.", "- head_ref_deleted - The pull request's branch was deleted.", "- head_ref_restored - The pull request's branch was restored.", "- labeled - A label was added to the issue.", "- locked - The issue was locked by the actor.", "- marked_as_duplicate - A user with write permissions marked an issue as a duplicate of another issue or a pull request as a duplicate of another pull request.", "- mentioned - The actor was @mentioned in an issue body.", "- merged - The issue was merged by the actor. The `commit_id` attribute is the SHA1 of the HEAD commit that was merged.", "- milestoned - The issue was added to a milestone.", "- moved_columns_in_project - The issue was moved between columns in a project board.", "- referenced - The issue was referenced from a commit message. The `commit_id` attribute is the commit SHA1 of where that happened.", "- removed_from_project - The issue was removed from a project board.", "- renamed - The issue title was changed.", "- reopened - The issue was reopened by the actor.", "- review_dismissed - The actor dismissed a review from the pull request.", "- review_requested - The actor requested a review from the subject on this pull request.", "- review_request_removed - The actor removed the review request for the subject on this pull request.", "- subscribed - The actor subscribed to receive notifications for an issue.", "- unassigned - The assignee was unassigned from the issue.", "- unlabeled - A label was removed from the issue.", "- unlocked - The issue was unlocked by the actor.", "- unmarked_as_duplicate - An issue that a user had previously marked as a duplicate of another issue is no longer considered a duplicate, or a pull request that a user had previously marked as a duplicate of another pull request is no longer considered a duplicate.", "- unsubscribed - The actor unsubscribed to stop receiving notifications for an issue.", "", "**Note**: The project-related events ```added_to_project```, ```moved_columns_in_project```, ```removed_from_project```, and ```converted_note_to_issue``` will not be included in the response if project boards have been [disabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) in the repository." ] }, { "name": "github-migration", "x-swgg-descriptionLineList": [ "# [Migration](https://developer.github.com/v3/migration/)", "", "These APIs help you move projects to or from GitHub.", "", "# [Migrations](https://developer.github.com/v3/migration/migrations/)", "", "The Migrations API is only available to [authenticated](https://developer.github.com/v3/#authentication) organization [owners](https://help.github.com/articles/permission-levels-for-an-organization/).", "", "To access the Migrations API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.wyandotte-preview+json", "```", "", "# [Source Imports](https://developer.github.com/v3/migration/source_imports/)", "", "The source import APIs are currently in public preview. During this period, the APIs may change in a backwards-incompatible way. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.barred-rock-preview", "```", "", "The Source Import API lets you start an import from a Git, Subversion, Mercurial, or Team Foundation Server source repository. This is the same functionality as [the GitHub Importer](https://help.github.com/articles/importing-from-other-version-control-systems-to-github/).", "", "A typical source import would [start the import](https://developer.github.com/v3/migration/source_imports/#start-an-import) and then (optionally) [update the authors](https://developer.github.com/v3/migration/source_imports/#map-a-commit-author) and/or [set the preference](https://developer.github.com/v3/migration/source_imports/#set-git-lfs-preference) for using Git LFS if large files exist in the import. A more detailed example can be seen in this diagram:", "```", "+---------+ +--------+ +---------------------+", "| Tooling | | GitHub | | Original Repository |", "+---------+ +--------+ +---------------------+", " | | |", " | Start import | |", " |----------------------------->| |", " | | |", " | | Download source data |", " | |--------------------------------------------->|", " | | Begin streaming data |", " | |<---------------------------------------------|", " | | |", " | Get import progress | |", " |----------------------------->| |", " | \"status\": \"importing\" | |", " |<-----------------------------| |", " | | |", " | Get commit authors | |", " |----------------------------->| |", " | | |", " | Map a commit author | |", " |----------------------------->| |", " | | |", " | | |", " | | Finish streaming data |", " | |<---------------------------------------------|", " | | |", " | | Rewrite commits with mapped authors |", " | |------+ |", " | | | |", " | |<-----+ |", " | | |", " | | Update repository on GitHub |", " | |------+ |", " | | | |", " | |<-----+ |", " | | |", " | Map a commit author | |", " |----------------------------->| |", " | | Rewrite commits with mapped authors |", " | |------+ |", " | | | |", " | |<-----+ |", " | | |", " | | Update repository on GitHub |", " | |------+ |", " | | | |", " | |<-----+ |", " | | |", " | Get large files | |", " |----------------------------->| |", " | | |", " | opt_in to Git LFS | |", " |----------------------------->| |", " | | Rewrite commits for large files |", " | |------+ |", " | | | |", " | |<-----+ |", " | | |", " | | Update repository on GitHub |", " | |------+ |", " | | | |", " | |<-----+ |", " | | |", " | Get import progress | |", " |----------------------------->| |", " | \"status\": \"complete\" | |", " |<-----------------------------| |", " | | |", " | | |", "```" ] }, { "name": "github-misc", "x-swgg-descriptionLineList": [ "# [Miscellaneous](https://developer.github.com/v3/misc/)", "", "This is a miscellaneous set of APIs which provide access to top level GitHub resources and info.", "", "# [Codes of Conduct](https://developer.github.com/v3/codes_of_conduct/)", "", "The Codes of Conduct API is currently available for developers to preview. During the preview period, the API may change without advance notice.", "", "To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.scarlet-witch-preview+json", "```", "", "# [Emojis](https://developer.github.com/v3/emojis/)", "", "Lists all the emojis available to use on GitHub.", "", "# [Gitignore](https://developer.github.com/v3/gitignore/)", "", "When you create a new GitHub repository via the API, you can specify a [.gitignore template](https://help.github.com/articles/ignoring-files) to apply to the repository upon creation. The .gitignore Templates API lists and fetches templates from the [GitHub .gitignore repository](https://github.com/github/gitignore).", "", "# [Licenses](https://developer.github.com/v3/licenses/)", "", "The Licenses API returns metadata about popular open source licenses and information about a particular project's license file.", "", "The Licenses API uses [the open source Ruby Gem Licensee](https://github.com/benbalter/licensee) to attempt to identify the project's license. Licensee matches the contents of a project's ```LICENSE``` file (if it exists) against a short list of known licenses. As a result, the API does not take into account the licenses of project dependencies or other means of documenting a project's license such as references to the license name in the documentation.", "", "If a license is matched, the license key and name returned conforms to the [SPDX specification](https://spdx.org/).", "", "**Note:** These endpoints will also return a repository's license information:", "- [Get a repository](https://developer.github.com/v3/repos/#get)", "- [List user repositories](https://developer.github.com/v3/repos/#list-user-repositories)", "- [List organization repositories](https://developer.github.com/v3/repos/#list-organization-repositories)", "- [List forks](https://developer.github.com/v3/repos/forks/#list-forks)", "- [List repositories being watched](https://developer.github.com/v3/activity/watching/#list-repositories-being-watched)", "- [List team repos](https://developer.github.com/v3/teams/#list-team-repos)", "", "GitHub is a lot of things, but it’s not a law firm. As such, GitHub does not provide legal advice. Using the Licenses API or sending us an email about it does not constitute legal advice nor does it create an attorney-client relationship. If you have any questions about what you can and can't do with a particular license, you should consult with your own legal counsel before moving forward. In fact, you should always consult with your own lawyer before making any decisions that might have legal ramifications or that may impact your legal rights.", "", "GitHub created the License API to help users get information about open source licenses and the projects that use them. We hope it helps, but please keep in mind that we’re not lawyers (at least not most of us aren't) and that we make mistakes like everyone else. For that reason, GitHub provides the API on an “as-is” basis and makes no warranties regarding any information or licenses provided on or through it, and disclaims liability for damages resulting from using the API.", "", "# [Markdown](https://developer.github.com/v3/markdown/)", "", "no description", "", "# [Meta](https://developer.github.com/v3/meta/)", "", "This endpoint provides information about GitHub.com, the service.", "", "# [Rate Limit](https://developer.github.com/v3/rate_limit/)", "", "The overview documentation describes the [rate limit rules](https://developer.github.com/v3/#rate-limiting). You can check your current rate limit status at any time using the Rate Limit API described below." ] }, { "name": "github-orgs", "x-swgg-descriptionLineList": [ "# [Organizations](https://developer.github.com/v3/orgs/)", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Blocking Organization Users](https://developer.github.com/v3/orgs/blocking/)", "", "**Note:** The User Blocking API on GitHub is currently available for developers to preview. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.giant-sentry-fist-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "The token used to authenticate the call must have the ```admin:org``` scope in order to make any blocking calls for an organization. Otherwise, the response returns ```HTTP 404```.", "", "# [Organization Members](https://developer.github.com/v3/orgs/members/)", "", "no description", "", "# [Organization Outside Collaborators](https://developer.github.com/v3/orgs/outside_collaborators/)", "", "no description", "", "# [Organization Webhooks](https://developer.github.com/v3/orgs/hooks/)", "", "Organization webhooks allow you to receive HTTP ```POST``` payloads whenever certain events happen within the organization. Subscribing to these events makes it possible to build integrations that react to actions on GitHub.com. For more information on actions you can subscribe to, check out our [Events documentation](https://developer.github.com/webhooks/#events)." ] }, { "name": "github-projects", "x-swgg-descriptionLineList": [ "# [Projects](https://developer.github.com/v3/projects/)", "", "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.inertia-preview+json", "```", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Project cards](https://developer.github.com/v3/projects/cards/)", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Project collaborators](https://developer.github.com/v3/projects/collaborators/)", "", "This API allows you to interact with an organization's projects.", "", "# [Project columns](https://developer.github.com/v3/projects/columns/)", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ] }, { "name": "github-pulls", "x-swgg-descriptionLineList": [ "# [Pull Requests](https://developer.github.com/v3/pulls/)", "", "The Pull Request API allows you to list, view, edit, create, and even merge pull requests. Comments on pull requests can be managed via the [Issue Comments API](https://developer.github.com/v3/issues/comments/).", "", "Pull Requests use [these custom media types](https://developer.github.com/v3/pulls/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "Custom media types", "", "These are the supported media types for pull requests. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/vnd.github.VERSION.raw+json", "application/vnd.github.VERSION.text+json", "application/vnd.github.VERSION.html+json", "application/vnd.github.VERSION.full+json", "application/vnd.github.VERSION.diff", "application/vnd.github.VERSION.patch", "```", "", "# [Review Comments](https://developer.github.com/v3/pulls/comments/)", "", "Pull Request review comments are comments on a portion of the unified diff. These are separate from Commit Comments (which are applied directly to a commit, outside of the Pull Request view), and Issue Comments (which do not reference a portion of the unified diff).", "", "Pull Request review comments use [these custom media types](https://developer.github.com/v3/pulls/comments/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "", "Custom media types", "", "These are the supported media types for pull request review comments. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/vnd.github.VERSION.raw+json", "application/vnd.github.VERSION.text+json", "application/vnd.github.VERSION.html+json", "application/vnd.github.VERSION.full+json", "```", "", "# [Review Requests](https://developer.github.com/v3/pulls/review_requests/)", "", "Pull request authors and repository owners and collaborators can request a pull request review from anyone with write access to the repository. Each requested reviewer will receive a notification asking them to review the pull request.", "", "# [Reviews](https://developer.github.com/v3/pulls/reviews/)", "", "Pull Request Reviews are groups of Pull Request Review Comments on the Pull Request, grouped together with a state and optional body comment.", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ] }, { "name": "github-reactions", "x-swgg-descriptionLineList": [ "# [Reactions](https://developer.github.com/v3/reactions/)", "", "**Note:** APIs for managing reactions are currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.squirrel-girl-preview+json", "```", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ] }, { "name": "github-repos", "x-swgg-descriptionLineList": [ "# [Repositories](https://developer.github.com/v3/repos/)", "", "**Note:** The ```topics``` property for repositories on GitHub is currently available for developers to preview. To view the ```topics``` property in calls that return repository results, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.mercy-preview+json", "```", "", "**Note:** The [Repository Transfer API](https://developer.github.com/changes/2017-11-09-repository-transfer-api-preview) is currently available for developers to preview. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.nightshade-preview+json", "```", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Branches](https://developer.github.com/v3/repos/branches/)", "", "no description", "", "# [Collaborators](https://developer.github.com/v3/repos/collaborators/)", "", "no description", "", "# [Comments](https://developer.github.com/v3/repos/comments/)", "", "Custom media types", "", "These are the supported media types for commit comments. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/vnd.github-commitcomment.raw+json", "application/vnd.github-commitcomment.text+json", "application/vnd.github-commitcomment.html+json", "application/vnd.github-commitcomment.full+json", "```", "", "# [Commits](https://developer.github.com/v3/repos/commits/)", "", "The Repo Commits API supports listing, viewing, and comparing commits in a repository.", "", "# [Community](https://developer.github.com/v3/repos/community/)", "", "We're currently offering a preview of the Community Profile API (also known as community health).", "", "To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.black-panther-preview+json", "```", "", "# [Contents](https://developer.github.com/v3/repos/contents/)", "", "These API methods let you retrieve the contents of files within a repository as Base64 encoded content. See [media types](https://developer.github.com/v3/repos/contents/#custom-media-types) for requesting the raw format or rendered HTML (when supported).", "", "Custom media types", "", "[READMEs](https://developer.github.com/v3/repos/contents/#get-the-readme), [files](https://developer.github.com/v3/repos/contents/#get-contents), and [symlinks](https://developer.github.com/v3/repos/contents/#get-contents) support the following custom media types:", "```", "application/vnd.github.VERSION.raw", "application/vnd.github.VERSION.html", "```", "", "# [Deploy Keys](https://developer.github.com/v3/repos/keys/)", "", "no description", "", "# [Deployments](https://developer.github.com/v3/repos/deployments/)", "", "Deployments are a request for a specific ref (branch, SHA, tag) to be deployed. GitHub then dispatches deployment events that external services can listen for and act on. This enables developers and organizations to build loosely-coupled tooling around deployments, without having to worry about implementation details of delivering different types of applications (e.g., web, native).", "", "Deployment statuses allow external services to mark deployments with an ```error```, ```failure```, ```pending```, or ```success``` state, which can then be consumed by any system listening for ```deployment_status``` events.", "", "Deployment statuses can also include an optional ```description``` and ```target_url```, and we highly recommend providing them as they make deployment statuses much more useful. The ```target_url``` would be the full URL to the deployment output, and the ```description``` would be the high level summary of what happened with the deployment.", "", "Deployments and deployment statuses both have associated [repository events](https://developer.github.com/v3/activity/events/types/#deploymentevent) when they're created. This allows webhooks and 3rd party integrations to respond to deployment requests as well as update the status of a deployment as progress is made.", "", "Below is a simple sequence diagram for how these interactions would work.", "```", "+---------+ +--------+ +-----------+ +-------------+", "| Tooling | | GitHub | | 3rd Party | | Your Server |", "+---------+ +--------+ +-----------+ +-------------+", " | | | |", " | Create Deployment | | |", " |--------------------->| | |", " | | | |", " | Deployment Created | | |", " |<---------------------| | |", " | | | |", " | | Deployment Event | |", " | |---------------------->| |", " | | | SSH+Deploys |", " | | |-------------------->|", " | | | |", " | | Deployment Status | |", " | |<----------------------| |", " | | | |", " | | | Deploy Completed |", " | | |<--------------------|", " | | | |", " | | Deployment Status | |", " | |<----------------------| |", " | | | |", "```", "", "", "Keep in mind that GitHub is never actually accessing your servers. It's up to your 3rd party integration to interact with deployment events. This allows for [GitHub integrations](https://github.com/integrations) as well as running your own systems depending on your use case. Multiple systems can listen for deployment events, and it's up to each of those systems to decide whether or not they're responsible for pushing the code out to your servers, building native code, etc.", "", "Note that the ```repo_deployment``` [OAuth scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/) grants targeted access to deployments and deployment statuses **without** granting access to repository code, while the ```repo``` scope grants permission to code as well.", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Downloads](https://developer.github.com/v3/repos/downloads/)", "", "The Downloads API (described below) was [deprecated on December 11, 2012](https://github.com/blog/1302-goodbye-uploads). It will be removed at a future date.", "", "We recommend using [Releases](https://developer.github.com/v3/repos/releases/) instead.", "", "The downloads API is for package downloads only. If you want to get source tarballs you should use [this](https://developer.github.com/v3/repos/contents/#get-archive-link) instead.", "", "# [Forks](https://developer.github.com/v3/repos/forks/)", "", "no description", "", "# [Merging](https://developer.github.com/v3/repos/merging/)", "", "The Repo Merging API supports merging branches in a repository. This accomplishes essentially the same thing as merging one branch into another in a local repository and then pushing to GitHub. The benefit is that the merge is done on the server side and a local repository is not needed. This makes it more appropriate for automation and other tools where maintaining local repositories would be cumbersome and inefficient.", "", "The authenticated user will be the author of any merges done through this endpoint.", "", "# [Pages](https://developer.github.com/v3/repos/pages/)", "", "The GitHub Pages API retrieves information about your GitHub Pages configuration, and the statuses of your builds. Information about the site and the builds can only be accessed by authenticated owners, even though the websites are public.", "", "In JSON responses, ```status``` can be one of:", "- ```null```, which means the site has yet to be built", "- ```queued```, which means the build has been requested but not yet begun", "- ```building```, which means the build is in progress", "- ```built```, which means the site has been built", "- ```errored```, which indicates an error occurred during the build", "", "# [Releases](https://developer.github.com/v3/repos/releases/)", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Repository Invitations](https://developer.github.com/v3/repos/invitations/)", "", "The Repository Invitations API allows users or external services to invite other users to collaborate on a repo. The invited users (or external services on behalf of invited users) can choose to accept or decline the invitations.", "", "Note that the ```repo:invite``` [OAuth scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/) grants targeted access to invitations **without** also granting access to repository code, while the ```repo``` scope grants permission to code as well as invitations.", "", "# [Repository Webhooks](https://developer.github.com/v3/repos/hooks/)", "", "The Repository Webhooks API allows repository admins to manage the post-receive hooks for a repository. Webhooks can be managed using the JSON HTTP API, or the [PubSubHubbub API](https://developer.github.com/v3/repos/hooks/#pubsubhubbub).", "", "If you would like to set up a single webhook to receive events from all of your organization's repositories, check out our [API documentation for Organization Webhooks](https://developer.github.com/v3/orgs/hooks/).", "", "# [Statistics](https://developer.github.com/v3/repos/statistics/)", "", "The Repository Statistics API allows you to fetch the data that GitHub uses for visualizing different types of repository activity.", "", "#### A word about caching", "", "Computing repository statistics is an expensive operation, so we try to return cached data whenever possible. If the data hasn't been cached when you query a repository's statistics, you'll receive a ```202``` response; a background job is also fired to start compiling these statistics. Give the job a few moments to complete, and then submit the request again. If the job has completed, that request will receive a ```200``` response with the statistics in the response body.", "", "Repository statistics are cached by the SHA of the repository's default branch, which is usually master; pushing to the default branch resets the statistics cache.", "", "#### Statistics exclude some types of commits", "", "The statistics exposed by the API match the statistics shown by [different repository graphs](https://help.github.com/articles/about-repository-graphs/).", "", "To summarize:", "- All statistics exclude merge commits.", "- Contributor statistics also exclude empty commits.", "", "# [Statuses](https://developer.github.com/v3/repos/statuses/)", "", "The status API allows external services to mark commits with an ```error```, ```failure```, ```pending```, or ```success``` state, which is then reflected in pull requests involving those commits.", "", "Statuses can also include an optional ```description``` and ```target_url```, and we highly recommend providing them as they make statuses much more useful in the GitHub UI.", "", "As an example, one common use is for continuous integration services to mark commits as passing or failing builds using status. The ```target_url``` would be the full URL to the build output, and the ```description``` would be the high level summary of what happened with the build.", "", "Statuses can include a ```context``` to indicate what service is providing that status. For example, you may have your continuous integration service push statuses with a context of ```ci```, and a security audit tool push statuses with a context of ```security```. You can then use the [combined status endpoint](https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref) to retrieve the whole status for a commit.", "", "Note that the ```repo:status``` [OAuth scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/) grants targeted access to statuses **without** also granting access to repository code, while the ```repo``` scope grants permission to code as well as statuses.", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Traffic](https://developer.github.com/v3/repos/traffic/)", "", "For repositories that you have push access to, the traffic API provides access to the information provided in the [graphs section](https://help.github.com/articles/about-repository-graphs/#traffic)." ] }, { "name": "github-scim", "x-swgg-descriptionLineList": [ "# [SCIM](https://developer.github.com/v3/scim/)", "", "no description" ] }, { "name": "github-search", "x-swgg-descriptionLineList": [ "# [Search](https://developer.github.com/v3/search/)", "", "**Note:** The ```topics``` property for repositories on GitHub is currently available for developers to preview. To view the ```topics``` property in calls that return repository results, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.mercy-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "#### About the search API", "", "The Search API is optimized to help you find the specific item you're looking for (e.g., a specific user, a specific file in a repository, etc.). Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the GitHub Search API provides **up to 1,000 results for each search**.", "", "#### Ranking search results", "", "Unless another sort option is provided as a query parameter, results are sorted by best match, as indicated by the ```score``` field for each item returned. This is a computed value representing the relevance of an item relative to the other items in the result set. Multiple factors are combined to boost the most relevant item to the top of the result list.", "", "#### Rate limit", "", "The Search API has a custom rate limit. For requests using [Basic Authentication](https://developer.github.com/v3/#authentication), [OAuth](https://developer.github.com/v3/#authentication), or [client ID and secret](https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications), you can make up to 30 requests per minute. For unauthenticated requests, the rate limit allows you to make up to 10 requests per minute.", "", "See the [rate limit documentation](https://developer.github.com/v3/#rate-limiting) for details on determining your current rate limit status.", "", "#### Timeouts and incomplete results", "", "To keep the Search API fast for everyone, we limit how long any individual query can run. For queries that [exceed the time limit](https://developer.github.com/changes/2014-04-07-understanding-search-results-and-potential-timeouts/), the API returns the matches that were already found prior to the timeout, and the response has the ```incomplete_results``` property set to ```true```.", "", "Reaching a timeout does not necessarily mean that search results are incomplete. More results might have been found, but also might not.", "", "# [Legacy Search](https://developer.github.com/v3/search/legacy/)", "", "This is a listing of the Legacy Search API features from API v2 that have been ported to API v3. There should be no changes, other than the new URL and JSON output format.", "", "#### Legacy Search API is Deprecated", "", "The Legacy Search API (described below) is deprecated. We recommend using the [v3 Search API](https://developer.github.com/v3/search/) instead. It contains new endpoints and much more functionality." ] }, { "name": "github-teams", "x-swgg-descriptionLineList": [ "# [Organization Teams](https://developer.github.com/v3/teams/)", "", "This API is only available to authenticated members of the team's [organization](https://developer.github.com/v3/orgs). OAuth access tokens require the ```read:org``` [scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/).", "", "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.inertia-preview+json", "```", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Team Discussion Comments](https://developer.github.com/v3/teams/discussion_comments/)", "", "The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](https://developer.github.com/v3/teams/discussions) post. Any member of the team's [organization](https://developer.github.com/v3/orgs) can create and read comments on a public discussion. For more details, see \"[About team discussions](https://help.github.com/articles/about-team-discussions/).\" This API is only available to authenticated members of the team's organization.", "", "# [Team Discussions](https://developer.github.com/v3/teams/discussions/)", "", "The team discussions API allows you to get, create, edit, and delete discussion posts on a team's page. You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](https://developer.github.com/v3/orgs) can create and read public discussion posts. For more details, see \"[About team discussions](https://help.github.com/articles/about-team-discussions/).\" To learn more about commenting on a discussion post, see the [team discussion comments API](https://developer.github.com/v3/teams/discussion_comments). This API is only available to authenticated members of the team's organization.", "", "# [Team Members](https://developer.github.com/v3/teams/members/)", "", "This API is only available to authenticated members of the team's organization. OAuth access tokens require the ```read:org``` [scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/).", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ] }, { "name": "github-users", "x-swgg-descriptionLineList": [ "# [Users](https://developer.github.com/v3/users/)", "", "Many of the resources on the users API provide a shortcut for getting information about the currently authenticated user. If a request URL does not include a ```:username``` parameter then the response will be for the logged in user (and you must pass [authentication information](https://developer.github.com/v3/#authentication) with your request). Additional private information, such as whether a user has two-factor authentication enabled, is included when authenticated through basic auth or OAuth with the ```user``` scope.", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Block Another User](https://developer.github.com/v3/users/blocking/)", "", "**Note:** The User Blocking API on GitHub is currently available for developers to preview. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.giant-sentry-fist-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [User Emails](https://developer.github.com/v3/users/emails/)", "", "Management of email addresses via the API requires that you are authenticated through basic auth or OAuth with the user scope.", "", "# [User Followers](https://developer.github.com/v3/users/followers/)", "", "no description", "", "# [User GPG Keys](https://developer.github.com/v3/users/gpg_keys/)", "", "The data returned in the ```public_key``` response field is not a GPG formatted key. When a user uploads a GPG key, it is parsed and the cryptographic public key is extracted and stored. This cryptographic key is what is returned by the APIs on this page. This key is not suitable to be used directly by programs like GPG.", "", "# [User Public Keys](https://developer.github.com/v3/users/keys/)", "", "no description" ] } ], "x-swgg-corsForwardProxyHost": "disabled", "x-swgg-descriptionLineList": [ "# [Repositories](https://developer.github.com/v3/repos/)", "", "**Note:** The ```topics``` property for repositories on GitHub is currently available for developers to preview. To view the ```topics``` property in calls that return repository results, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.mercy-preview+json", "```", "", "**Note:** The [Repository Transfer API](https://developer.github.com/changes/2017-11-09-repository-transfer-api-preview) is currently available for developers to preview. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.nightshade-preview+json", "```", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Branches](https://developer.github.com/v3/repos/branches/)", "", "no description", "", "# [Collaborators](https://developer.github.com/v3/repos/collaborators/)", "", "no description", "", "# [Comments](https://developer.github.com/v3/repos/comments/)", "", "Custom media types", "", "These are the supported media types for commit comments. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/vnd.github-commitcomment.raw+json", "application/vnd.github-commitcomment.text+json", "application/vnd.github-commitcomment.html+json", "application/vnd.github-commitcomment.full+json", "```", "", "# [Commits](https://developer.github.com/v3/repos/commits/)", "", "The Repo Commits API supports listing, viewing, and comparing commits in a repository.", "", "# [Community](https://developer.github.com/v3/repos/community/)", "", "We're currently offering a preview of the Community Profile API (also known as community health).", "", "To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.black-panther-preview+json", "```", "", "# [Contents](https://developer.github.com/v3/repos/contents/)", "", "These API methods let you retrieve the contents of files within a repository as Base64 encoded content. See [media types](https://developer.github.com/v3/repos/contents/#custom-media-types) for requesting the raw format or rendered HTML (when supported).", "", "Custom media types", "", "[READMEs](https://developer.github.com/v3/repos/contents/#get-the-readme), [files](https://developer.github.com/v3/repos/contents/#get-contents), and [symlinks](https://developer.github.com/v3/repos/contents/#get-contents) support the following custom media types:", "```", "application/vnd.github.VERSION.raw", "application/vnd.github.VERSION.html", "```", "", "# [Deploy Keys](https://developer.github.com/v3/repos/keys/)", "", "no description", "", "# [Deployments](https://developer.github.com/v3/repos/deployments/)", "", "Deployments are a request for a specific ref (branch, SHA, tag) to be deployed. GitHub then dispatches deployment events that external services can listen for and act on. This enables developers and organizations to build loosely-coupled tooling around deployments, without having to worry about implementation details of delivering different types of applications (e.g., web, native).", "", "Deployment statuses allow external services to mark deployments with an ```error```, ```failure```, ```pending```, or ```success``` state, which can then be consumed by any system listening for ```deployment_status``` events.", "", "Deployment statuses can also include an optional ```description``` and ```target_url```, and we highly recommend providing them as they make deployment statuses much more useful. The ```target_url``` would be the full URL to the deployment output, and the ```description``` would be the high level summary of what happened with the deployment.", "", "Deployments and deployment statuses both have associated [repository events](https://developer.github.com/v3/activity/events/types/#deploymentevent) when they're created. This allows webhooks and 3rd party integrations to respond to deployment requests as well as update the status of a deployment as progress is made.", "", "Below is a simple sequence diagram for how these interactions would work.", "```", "+---------+ +--------+ +-----------+ +-------------+", "| Tooling | | GitHub | | 3rd Party | | Your Server |", "+---------+ +--------+ +-----------+ +-------------+", " | | | |", " | Create Deployment | | |", " |--------------------->| | |", " | | | |", " | Deployment Created | | |", " |<---------------------| | |", " | | | |", " | | Deployment Event | |", " | |---------------------->| |", " | | | SSH+Deploys |", " | | |-------------------->|", " | | | |", " | | Deployment Status | |", " | |<----------------------| |", " | | | |", " | | | Deploy Completed |", " | | |<--------------------|", " | | | |", " | | Deployment Status | |", " | |<----------------------| |", " | | | |", "```", "", "", "Keep in mind that GitHub is never actually accessing your servers. It's up to your 3rd party integration to interact with deployment events. This allows for [GitHub integrations](https://github.com/integrations) as well as running your own systems depending on your use case. Multiple systems can listen for deployment events, and it's up to each of those systems to decide whether or not they're responsible for pushing the code out to your servers, building native code, etc.", "", "Note that the ```repo_deployment``` [OAuth scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/) grants targeted access to deployments and deployment statuses **without** granting access to repository code, while the ```repo``` scope grants permission to code as well.", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Downloads](https://developer.github.com/v3/repos/downloads/)", "", "The Downloads API (described below) was [deprecated on December 11, 2012](https://github.com/blog/1302-goodbye-uploads). It will be removed at a future date.", "", "We recommend using [Releases](https://developer.github.com/v3/repos/releases/) instead.", "", "The downloads API is for package downloads only. If you want to get source tarballs you should use [this](https://developer.github.com/v3/repos/contents/#get-archive-link) instead.", "", "# [Forks](https://developer.github.com/v3/repos/forks/)", "", "no description", "", "# [Merging](https://developer.github.com/v3/repos/merging/)", "", "The Repo Merging API supports merging branches in a repository. This accomplishes essentially the same thing as merging one branch into another in a local repository and then pushing to GitHub. The benefit is that the merge is done on the server side and a local repository is not needed. This makes it more appropriate for automation and other tools where maintaining local repositories would be cumbersome and inefficient.", "", "The authenticated user will be the author of any merges done through this endpoint.", "", "# [Pages](https://developer.github.com/v3/repos/pages/)", "", "The GitHub Pages API retrieves information about your GitHub Pages configuration, and the statuses of your builds. Information about the site and the builds can only be accessed by authenticated owners, even though the websites are public.", "", "In JSON responses, ```status``` can be one of:", "- ```null```, which means the site has yet to be built", "- ```queued```, which means the build has been requested but not yet begun", "- ```building```, which means the build is in progress", "- ```built```, which means the site has been built", "- ```errored```, which indicates an error occurred during the build", "", "# [Releases](https://developer.github.com/v3/repos/releases/)", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Repository Invitations](https://developer.github.com/v3/repos/invitations/)", "", "The Repository Invitations API allows users or external services to invite other users to collaborate on a repo. The invited users (or external services on behalf of invited users) can choose to accept or decline the invitations.", "", "Note that the ```repo:invite``` [OAuth scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/) grants targeted access to invitations **without** also granting access to repository code, while the ```repo``` scope grants permission to code as well as invitations.", "", "# [Repository Webhooks](https://developer.github.com/v3/repos/hooks/)", "", "The Repository Webhooks API allows repository admins to manage the post-receive hooks for a repository. Webhooks can be managed using the JSON HTTP API, or the [PubSubHubbub API](https://developer.github.com/v3/repos/hooks/#pubsubhubbub).", "", "If you would like to set up a single webhook to receive events from all of your organization's repositories, check out our [API documentation for Organization Webhooks](https://developer.github.com/v3/orgs/hooks/).", "", "# [Statistics](https://developer.github.com/v3/repos/statistics/)", "", "The Repository Statistics API allows you to fetch the data that GitHub uses for visualizing different types of repository activity.", "", "#### A word about caching", "", "Computing repository statistics is an expensive operation, so we try to return cached data whenever possible. If the data hasn't been cached when you query a repository's statistics, you'll receive a ```202``` response; a background job is also fired to start compiling these statistics. Give the job a few moments to complete, and then submit the request again. If the job has completed, that request will receive a ```200``` response with the statistics in the response body.", "", "Repository statistics are cached by the SHA of the repository's default branch, which is usually master; pushing to the default branch resets the statistics cache.", "", "#### Statistics exclude some types of commits", "", "The statistics exposed by the API match the statistics shown by [different repository graphs](https://help.github.com/articles/about-repository-graphs/).", "", "To summarize:", "- All statistics exclude merge commits.", "- Contributor statistics also exclude empty commits.", "", "# [Statuses](https://developer.github.com/v3/repos/statuses/)", "", "The status API allows external services to mark commits with an ```error```, ```failure```, ```pending```, or ```success``` state, which is then reflected in pull requests involving those commits.", "", "Statuses can also include an optional ```description``` and ```target_url```, and we highly recommend providing them as they make statuses much more useful in the GitHub UI.", "", "As an example, one common use is for continuous integration services to mark commits as passing or failing builds using status. The ```target_url``` would be the full URL to the build output, and the ```description``` would be the high level summary of what happened with the build.", "", "Statuses can include a ```context``` to indicate what service is providing that status. For example, you may have your continuous integration service push statuses with a context of ```ci```, and a security audit tool push statuses with a context of ```security```. You can then use the [combined status endpoint](https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref) to retrieve the whole status for a commit.", "", "Note that the ```repo:status``` [OAuth scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/) grants targeted access to statuses **without** also granting access to repository code, while the ```repo``` scope grants permission to code as well as statuses.", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Traffic](https://developer.github.com/v3/repos/traffic/)", "", "For repositories that you have push access to, the traffic API provides access to the information provided in the [graphs section](https://help.github.com/articles/about-repository-graphs/#traffic)." ], "x-swgg-downloadStandaloneApp": "https://kaizhu256.github.io/node-swgg-github-repos/build..beta..travis-ci.org/app/assets.app.js", "x-swgg-fixErrorSemanticUniquePath": true, "x-swgg-operationIdFromPath": true, "x-swgg-tags0-override": { "github-activity": { "x-swgg-descriptionLineList": [ "# [Activity](https://developer.github.com/v3/activity/)", "", "Serving up the 'social' in Social Coding, the Activity APIs provide access to notifications, subscriptions, and timelines.", "", "# [Event Types & Payloads](https://developer.github.com/v3/activity/events/types/)", "", "Each event has a similar JSON schema, but a unique ```payload``` object that is determined by its event type.", "", "Event names are used by [repository webhooks](https://developer.github.com/v3/repos/hooks/) to specify which events the webhook should receive. The included payloads below are from webhook deliveries but match events returned by the [Events API](https://developer.github.com/v3/activity/events/) (except where noted). The Events API uses the CamelCased name (e.g. ```CommitCommentEvent```) in the ```type``` field of an event object and does not include the ```repository``` or ```sender``` fields in the event payload object.", "", "**Note:** Some of these events may not be rendered in timelines, they're only created for various internal and webhook purposes.", "- [CommitCommentEvent](https://developer.github.com/v3/activity/events/types/#commitcommentevent)", "- [CreateEvent](https://developer.github.com/v3/activity/events/types/#createevent)", "- [DeleteEvent](https://developer.github.com/v3/activity/events/types/#deleteevent)", "- [DeploymentEvent](https://developer.github.com/v3/activity/events/types/#deploymentevent)", "- [DeploymentStatusEvent](https://developer.github.com/v3/activity/events/types/#deploymentstatusevent)", "- [DownloadEvent](https://developer.github.com/v3/activity/events/types/#downloadevent)", "- [FollowEvent](https://developer.github.com/v3/activity/events/types/#followevent)", "- [ForkEvent](https://developer.github.com/v3/activity/events/types/#forkevent)", "- [ForkApplyEvent](https://developer.github.com/v3/activity/events/types/#forkapplyevent)", "- [GistEvent](https://developer.github.com/v3/activity/events/types/#gistevent)", "- [GollumEvent](https://developer.github.com/v3/activity/events/types/#gollumevent)", "- [InstallationEvent](https://developer.github.com/v3/activity/events/types/#installationevent)", "- [InstallationRepositoriesEvent](https://developer.github.com/v3/activity/events/types/#installationrepositoriesevent)", "- [IssueCommentEvent](https://developer.github.com/v3/activity/events/types/#issuecommentevent)", "- [IssuesEvent](https://developer.github.com/v3/activity/events/types/#issuesevent)", "- [LabelEvent](https://developer.github.com/v3/activity/events/types/#labelevent)", "- [MarketplacePurchaseEvent](https://developer.github.com/v3/activity/events/types/#marketplacepurchaseevent)", "- [MemberEvent](https://developer.github.com/v3/activity/events/types/#memberevent)", "- [MembershipEvent](https://developer.github.com/v3/activity/events/types/#membershipevent)", "- [MilestoneEvent](https://developer.github.com/v3/activity/events/types/#milestoneevent)", "- [OrganizationEvent](https://developer.github.com/v3/activity/events/types/#organizationevent)", "- [OrgBlockEvent](https://developer.github.com/v3/activity/events/types/#orgblockevent)", "- [PageBuildEvent](https://developer.github.com/v3/activity/events/types/#pagebuildevent)", "- [ProjectCardEvent](https://developer.github.com/v3/activity/events/types/#projectcardevent)", "- [ProjectColumnEvent](https://developer.github.com/v3/activity/events/types/#projectcolumnevent)", "- [ProjectEvent](https://developer.github.com/v3/activity/events/types/#projectevent)", "- [PublicEvent](https://developer.github.com/v3/activity/events/types/#publicevent)", "- [PullRequestEvent](https://developer.github.com/v3/activity/events/types/#pullrequestevent)", "- [PullRequestReviewEvent](https://developer.github.com/v3/activity/events/types/#pullrequestreviewevent)", "- [PullRequestReviewCommentEvent](https://developer.github.com/v3/activity/events/types/#pullrequestreviewcommentevent)", "- [PushEvent](https://developer.github.com/v3/activity/events/types/#pushevent)", "- [ReleaseEvent](https://developer.github.com/v3/activity/events/types/#releaseevent)", "- [RepositoryEvent](https://developer.github.com/v3/activity/events/types/#repositoryevent)", "- [StatusEvent](https://developer.github.com/v3/activity/events/types/#statusevent)", "- [TeamEvent](https://developer.github.com/v3/activity/events/types/#teamevent)", "- [TeamAddEvent](https://developer.github.com/v3/activity/events/types/#teamaddevent)", "- [WatchEvent](https://developer.github.com/v3/activity/events/types/#watchevent)", "", "# [Events](https://developer.github.com/v3/activity/events/)", "", "This is a read-only API to the GitHub events. These events power the various activity streams on the site.", "- [List public events](https://developer.github.com/v3/activity/events/#list-public-events)", "- [List repository events](https://developer.github.com/v3/activity/events/#list-repository-events)", "- [List issue events for a repository](https://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository)", "- [List public events for a network of repositories](https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories)", "- [List public events for an organization](https://developer.github.com/v3/activity/events/#list-public-events-for-an-organization)", "- [List events that a user has received](https://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received)", "- [List public events that a user has received](https://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received)", "- [List events performed by a user](https://developer.github.com/v3/activity/events/#list-events-performed-by-a-user)", "- [List public events performed by a user](https://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user)", "- [List events for an organization](https://developer.github.com/v3/activity/events/#list-events-for-an-organization)", "", "Events are optimized for polling with the \"ETag\" header. If no new events have been triggered, you will see a \"304 Not Modified\" response, and your current rate limit will be untouched. There is also an \"X-Poll-Interval\" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header.", "```", "curl -I https://api.github.com/users/tater/events", "HTTP/1.1 200 OK", "X-Poll-Interval: 60", "ETag: \"a18c3bded88eb5dbb5c849a489412bf3\"", "# The quotes around the ETag value are important", "curl -I https://api.github.com/users/tater/events \\", " -H 'If-None-Match: \"a18c3bded88eb5dbb5c849a489412bf3\"'", "HTTP/1.1 304 Not Modified", "X-Poll-Interval: 60", "```", "", "", "Events support [pagination](https://developer.github.com/v3/#pagination), however the ```per_page``` option is unsupported. The fixed page size is 30 items. Fetching up to ten pages is supported, for a total of 300 events.", "", "Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300).", "", "All Events have the same response format:", "```", "Status: 200 OK", "Link: <https://api.github.com/resource?page=2>; rel=\"next\",", " <https://api.github.com/resource?page=5>; rel=\"last\"", "```", "", "```", "[", " {", " \"type\": \"Event\",", " \"public\": true,", " \"payload\": {", " },", " \"repo\": {", " \"id\": 3,", " \"name\": \"octocat/Hello-World\",", " \"url\": \"https://api.github.com/repos/octocat/Hello-World\"", " },", " \"actor\": {", " \"id\": 1,", " \"login\": \"octocat\",", " \"gravatar_id\": \"\",", " \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",", " \"url\": \"https://api.github.com/users/octocat\"", " },", " \"org\": {", " \"id\": 1,", " \"login\": \"github\",", " \"gravatar_id\": \"\",", " \"url\": \"https://api.github.com/orgs/github\",", " \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\"", " },", " \"created_at\": \"2011-09-06T17:26:27Z\",", " \"id\": \"12345\"", " }", "]", "```", "", "# [Feeds](https://developer.github.com/v3/activity/feeds/)", "", "no description", "", "# [Notifications](https://developer.github.com/v3/activity/notifications/)", "", "Users receive notifications for conversations in repositories they watch including:", "- Issues and their comments", "- Pull Requests and their comments", "- Comments on any commits", "", "Notifications are also sent for conversations in unwatched repositories when the user is involved including:", "- **@mentions**", "- Issue assignments", "- Commits the user authors or commits", "- Any discussion in which the user actively participates", "", "All Notification API calls require the ```notifications``` or ```repo``` API scopes. Doing this will give read-only access to some Issue/Commit content. You will still need the \"repo\" scope to access Issues and Commits from their respective endpoints.", "", "Notifications come back as \"threads\". A Thread contains information about the current discussion of an Issue/PullRequest/Commit.", "", "Notifications are optimized for polling with the \"Last-Modified\" header. If there are no new notifications, you will see a \"304 Not Modified\" response, leaving your current rate limit untouched. There is an \"X-Poll-Interval\" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header.", "```", "# Add authentication to your requests", "curl -I https://api.github.com/notifications", "HTTP/1.1 200 OK", "Last-Modified: Thu, 25 Oct 2012 15:16:27 GMT", "X-Poll-Interval: 60", "# Pass the Last-Modified header exactly", "curl -I https://api.github.com/notifications", " -H \"If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT\"", "HTTP/1.1 304 Not Modified", "X-Poll-Interval: 60", "```", "", "# [Starring](https://developer.github.com/v3/activity/starring/)", "", "Repository Starring is a feature that lets users bookmark repositories. Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed. For that, see [Repository Watching](https://developer.github.com/v3/activity/watching).", "", "#### Starring vs. Watching", "", "In August 2012, we [changed the way watching works](https://github.com/blog/1204-notifications-stars) on GitHub. Many API client applications may be using the original \"watcher\" endpoints for accessing this data. You can now start using the \"star\" endpoints instead (described below). Check out the [Watcher API Change post](https://developer.github.com/changes/2012-09-05-watcher-api/) for more details.", "", "# [Watching](https://developer.github.com/v3/activity/watching/)", "", "Watching a Repository registers the user to receive notifications on new discussions, as well as events in the user's activity feed. See [Repository Starring](https://developer.github.com/v3/activity/starring) for simple repository bookmarks.", "", "#### Watching vs. Starring", "", "In August 2012, we [changed the way watching works](https://github.com/blog/1204-notifications-stars) on GitHub. At the time of that change, many API clients were already using the existing \"watcher\" endpoints to access starring data. To avoid breaking those applications, the legacy \"watcher\" endpoints continue to provide starring data.", "", "To provide access to watching data, the v3 Watcher API uses the \"subscription\" endpoints described below. Check out the [Watcher API Change post](https://developer.github.com/changes/2012-09-05-watcher-api/) for more details." ] }, "github-apps": { "x-swgg-descriptionLineList": [ "# [GitHub Apps](https://developer.github.com/v3/apps/)", "", "For information on how to authenticate as a GitHub App, see \"[Authentication Options for GitHub Apps](https://developer.github.com/apps/building-github-apps/authentication-options-for-github-apps#authenticating-as-a-github-app).\"", "", "**Note:** To access the API with your integration, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` Header for your requests.", "", "```", "application/vnd.github.machine-man-preview+json", "```", "", "# [GitHub App Permissions](https://developer.github.com/v3/apps/permissions/)", "", "**Note:** To access the API with your integration, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` Header for your requests.", "", "```", "application/vnd.github.machine-man-preview+json", "```", "", "GitHub Apps are created with a set of permissions. These define what resources the GitHub App can access via the API. For more information, see \"[Permissions for GitHub Apps](https://developer.github.com/apps/building-github-apps/permissions-for-github-apps/).\"", "", "# [GitHub Apps: Available Endpoints](https://developer.github.com/v3/apps/available-endpoints/)", "", "**Note:** To access the API with your integration, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` Header for your requests.", "", "```", "application/vnd.github.machine-man-preview+json", "```", "", "The following endpoints are available for use by GitHub Apps. For more information, see \"[GitHub Apps](https://developer.github.com/apps/building-github-apps/).\"", "", "#### Members", "- [Members list](https://developer.github.com/v3/orgs/members/#members-list)", "- [Check membership](https://developer.github.com/v3/orgs/members/#check-membership)", "- [Remove a member](https://developer.github.com/v3/orgs/members/#remove-a-member)", "- [Get organization membership](https://developer.github.com/v3/orgs/members/#get-organization-membership)", "- [Add or update organization membership](https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership)", "- [Remove organization membership](https://developer.github.com/v3/orgs/members/#remove-organization-membership)", "", "#### Outside Collaborators", "- [List outside collaborators](https://developer.github.com/v3/orgs/outside_collaborators/#list-outside-collaborators)", "- [Remove outside collaborator](https://developer.github.com/v3/orgs/outside_collaborators/#remove-outside-collaborator)", "- [Convert member to outside collaborator](https://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator)", "", "#### Projects", "- [List repository projects](https://developer.github.com/v3/projects/#list-repository-projects)", "- [List organization projects](https://developer.github.com/v3/projects/#list-organization-projects)", "- [Get a project](https://developer.github.com/v3/projects/#get-a-project)", "- [Create a repository project](https://developer.github.com/v3/projects/#create-a-repository-project)", "- [Create an organization project](https://developer.github.com/v3/projects/#create-an-organization-project)", "- [Update a project](https://developer.github.com/v3/projects/#update-a-project)", "- [Delete a project](https://developer.github.com/v3/projects/#delete-a-project)", "", "#### Teams", "- [List teams](https://developer.github.com/v3/teams/#list-teams)", "- [Get team](https://developer.github.com/v3/teams/#get-team)", "- [Edit team](https://developer.github.com/v3/teams/#edit-team)", "- [Delete team](https://developer.github.com/v3/teams/#delete-team)", "- [List child teams](https://developer.github.com/v3/teams/#list-child-teams)", "- [List team repos](https://developer.github.com/v3/teams/#list-team-repos)", "", "#### Users", "- [Get a single user](https://developer.github.com/v3/users/#get-a-single-user)", "- [Get all users](https://developer.github.com/v3/users/#get-all-users)", "", "#### Overview", "- [Root endpoint](https://developer.github.com/v3/#root-endpoint)", "", "#### Review Comments", "- [List comments on a pull request](https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request)", "- [List comments in a repository](https://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository)", "- [Get a single comment](https://developer.github.com/v3/pulls/comments/#get-a-single-comment)", "- [Create a comment](https://developer.github.com/v3/pulls/comments/#create-a-comment)", "- [Edit a comment](https://developer.github.com/v3/pulls/comments/#edit-a-comment)", "- [Delete a comment](https://developer.github.com/v3/pulls/comments/#delete-a-comment)", "", "#### Reviews", "- [Get a single review](https://developer.github.com/v3/pulls/reviews/#get-a-single-review)", "- [Get comments for a single review](https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review)", "- [Create a pull request review](https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review)", "", "#### Team Discussion Comments", "- [List comments](https://developer.github.com/v3/teams/discussion_comments/#list-comments)", "- [Get a single comment](https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment)", "- [Create a comment](https://developer.github.com/v3/teams/discussion_comments/#create-a-comment)", "- [Edit a comment](https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment)", "- [Delete a comment](https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment)", "", "#### Team Discussions", "- [List discussions](https://developer.github.com/v3/teams/discussions/#list-discussions)", "- [Get a single discussion](https://developer.github.com/v3/teams/discussions/#get-a-single-discussion)", "- [Create a discussion](https://developer.github.com/v3/teams/discussions/#create-a-discussion)", "- [Edit a discussion](https://developer.github.com/v3/teams/discussions/#edit-a-discussion)", "- [Delete a discussion](https://developer.github.com/v3/teams/discussions/#delete-a-discussion)", "", "#### Team Members", "- [List team members](https://developer.github.com/v3/teams/members/#list-team-members)", "- [Get team member](https://developer.github.com/v3/teams/members/#get-team-member)", "- [Get team membership](https://developer.github.com/v3/teams/members/#get-team-membership)", "- [Add or update team membership](https://developer.github.com/v3/teams/members/#add-or-update-team-membership)", "- [Remove team membership](https://developer.github.com/v3/teams/members/#remove-team-membership)", "- [List pending team invitations](https://developer.github.com/v3/teams/members/#list-pending-team-invitations)", "", "#### Feeds", "- [List Feeds](https://developer.github.com/v3/activity/feeds/#list-feeds)", "", "#### Starring", "- [List Stargazers](https://developer.github.com/v3/activity/starring/#list-stargazers)", "", "#### Events", "- [List public events](https://developer.github.com/v3/activity/events/#list-public-events)", "- [List repository events](https://developer.github.com/v3/activity/events/#list-repository-events)", "- [List public events for a network of repositories](https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories)", "- [List public events for an organization](https://developer.github.com/v3/activity/events/#list-public-events-for-an-organization)", "- [List events that a user has received](https://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received)", "- [List public events that a user has received](https://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received)", "- [List events performed by a user](https://developer.github.com/v3/activity/events/#list-events-performed-by-a-user)", "- [List public events performed by a user](https://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user)", "- [List events for an issue](https://developer.github.com/v3/issues/events/#list-events-for-an-issue)", "- [List events for a repository](https://developer.github.com/v3/issues/events/#list-events-for-a-repository)", "- [Get a single event](https://developer.github.com/v3/issues/events/#get-a-single-event)", "", "#### Watching", "- [List watchers](https://developer.github.com/v3/activity/watching/#list-watchers)", "", "#### References", "- [Get a Reference](https://developer.github.com/v3/git/refs/#get-a-reference)", "- [Get all References](https://developer.github.com/v3/git/refs/#get-all-references)", "- [Create a Reference](https://developer.github.com/v3/git/refs/#create-a-reference)", "- [Update a Reference](https://developer.github.com/v3/git/refs/#update-a-reference)", "- [Delete a Reference](https://developer.github.com/v3/git/refs/#delete-a-reference)", "", "#### Commits", "- [Get a Commit](https://developer.github.com/v3/git/commits/#get-a-commit)", "- [Create a Commit](https://developer.github.com/v3/git/commits/#create-a-commit)", "- [List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)", "- [Get a single commit](https://developer.github.com/v3/repos/commits/#get-a-single-commit)", "- [Get the SHA-1 of a commit reference](https://developer.github.com/v3/repos/commits/#get-the-sha-1-of-a-commit-reference)", "", "#### Trees", "- [Get a Tree](https://developer.github.com/v3/git/trees/#get-a-tree)", "- [Create a Tree](https://developer.github.com/v3/git/trees/#create-a-tree)", "", "#### Blobs", "- [Get a Blob](https://developer.github.com/v3/git/blobs/#get-a-blob)", "- [Create a Blob](https://developer.github.com/v3/git/blobs/#create-a-blob)", "", "#### Tags", "- [Get a Tag](https://developer.github.com/v3/git/tags/#get-a-tag)", "- [Create a Tag Object](https://developer.github.com/v3/git/tags/#create-a-tag-object)", "", "#### Miscellaneous", "- [Emojis](https://developer.github.com/v3/misc/#emojis)", "", "#### Pull Requests", "- [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)", "- [Get a single pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request)", "- [Create a pull request](https://developer.github.com/v3/pulls/#create-a-pull-request)", "- [Update a pull request](https://developer.github.com/v3/pulls/#update-a-pull-request)", "- [List commits on a pull request](https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request)", "- [List pull requests files](https://developer.github.com/v3/pulls/#list-pull-requests-files)", "- [Get if a pull request has been merged](https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged)", "", "#### Issues", "- [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository)", "- [Get a single issue](https://developer.github.com/v3/issues/#get-a-single-issue)", "- [Create an issue](https://developer.github.com/v3/issues/#create-an-issue)", "- [Edit an issue](https://developer.github.com/v3/issues/#edit-an-issue)", "- [Lock an issue](https://developer.github.com/v3/issues/#lock-an-issue)", "- [Unlock an issue](https://developer.github.com/v3/issues/#unlock-an-issue)", "", "#### Organizations", "- [List all organizations](https://developer.github.com/v3/orgs/#list-all-organizations)", "- [List user organizations](https://developer.github.com/v3/orgs/#list-user-organizations)", "", "#### Rate Limit", "- [Get your current rate limit status](https://developer.github.com/v3/rate_limit/#get-your-current-rate-limit-status)", "", "#### Source Imports", "- [Start an import](https://developer.github.com/v3/migration/source_imports/#start-an-import)", "- [Get import progress](https://developer.github.com/v3/migration/source_imports/#get-import-progress)", "- [Update existing import](https://developer.github.com/v3/migration/source_imports/#update-existing-import)", "- [Get commit authors](https://developer.github.com/v3/migration/source_imports/#get-commit-authors)", "- [Map a commit author](https://developer.github.com/v3/migration/source_imports/#map-a-commit-author)", "- [Set Git LFS preference](https://developer.github.com/v3/migration/source_imports/#set-git-lfs-preference)", "- [Get large files](https://developer.github.com/v3/migration/source_imports/#get-large-files)", "- [Cancel an import](https://developer.github.com/v3/migration/source_imports/#cancel-an-import)", "", "#### Repositories", "- [List user repositories](https://developer.github.com/v3/repos/#list-user-repositories)", "- [List all public repositories](https://developer.github.com/v3/repos/#list-all-public-repositories)", "- [Create](https://developer.github.com/v3/repos/#create)", "- [Get](https://developer.github.com/v3/repos/#get)", "- [Edit](https://developer.github.com/v3/repos/#edit)", "- [List all topics for a repository](https://developer.github.com/v3/repos/#list-all-topics-for-a-repository)", "- [Replace all topics for a repository](https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository)", "- [List contributors](https://developer.github.com/v3/repos/#list-contributors)", "- [List languages](https://developer.github.com/v3/repos/#list-languages)", "- [List teams](https://developer.github.com/v3/repos/#list-teams)", "- [List tags](https://developer.github.com/v3/repos/#list-tags)", "- [Delete a repository](https://developer.github.com/v3/repos/#delete-a-repository)", "", "#### Project columns", "- [Get a project column](https://developer.github.com/v3/projects/columns/#get-a-project-column)", "- [Create a project column](https://developer.github.com/v3/projects/columns/#create-a-project-column)", "- [Update a project column](https://developer.github.com/v3/projects/columns/#update-a-project-column)", "- [Delete a project column](https://developer.github.com/v3/projects/columns/#delete-a-project-column)", "- [Move a project column](https://developer.github.com/v3/projects/columns/#move-a-project-column)", "", "#### Project cards", "- [List project cards](https://developer.github.com/v3/projects/cards/#list-project-cards)", "- [Get a project card](https://developer.github.com/v3/projects/cards/#get-a-project-card)", "- [Create a project card](https://developer.github.com/v3/projects/cards/#create-a-project-card)", "- [Update a project card](https://developer.github.com/v3/projects/cards/#update-a-project-card)", "- [Delete a project card](https://developer.github.com/v3/projects/cards/#delete-a-project-card)", "- [Move a project card](https://developer.github.com/v3/projects/cards/#move-a-project-card)", "", "#### Branches", "- [List branches](https://developer.github.com/v3/repos/branches/#list-branches)", "- [Get branch](https://developer.github.com/v3/repos/branches/#get-branch)", "- [Get branch protection](https://developer.github.com/v3/repos/branches/#get-branch-protection)", "- [Update branch protection](https://developer.github.com/v3/repos/branches/#update-branch-protection)", "- [Remove branch protection](https://developer.github.com/v3/repos/branches/#remove-branch-protection)", "- [Get required status checks of protected branch](https://developer.github.com/v3/repos/branches/#get-required-status-checks-of-protected-branch)", "- [Update required status checks of protected branch](https://developer.github.com/v3/repos/branches/#update-required-status-checks-of-protected-branch)", "- [Remove required status checks of protected branch](https://developer.github.com/v3/repos/branches/#remove-required-status-checks-of-protected-branch)", "- [List required status checks contexts of protected branch](https://developer.github.com/v3/repos/branches/#list-required-status-checks-contexts-of-protected-branch)", "- [Replace required status checks contexts of protected branch](https://developer.github.com/v3/repos/branches/#replace-required-status-checks-contexts-of-protected-branch)", "- [Add required status checks contexts of protected branch](https://developer.github.com/v3/repos/branches/#add-required-status-checks-contexts-of-protected-branch)", "- [Remove required status checks contexts of protected branch](https://developer.github.com/v3/repos/branches/#remove-required-status-checks-contexts-of-protected-branch)", "- [Get pull request review enforcement of protected branch](https://developer.github.com/v3/repos/branches/#get-pull-request-review-enforcement-of-protected-branch)", "- [Update pull request review enforcement of protected branch](https://developer.github.com/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch)", "- [Remove pull request review enforcement of protected branch](https://developer.github.com/v3/repos/branches/#remove-pull-request-review-enforcement-of-protected-branch)", "- [Get required signatures of protected branch](https://developer.github.com/v3/repos/branches/#get-required-signatures-of-protected-branch)", "- [Add required signatures of protected branch](https://developer.github.com/v3/repos/branches/#add-required-signatures-of-protected-branch)", "- [Remove required signatures of protected branch](https://developer.github.com/v3/repos/branches/#remove-required-signatures-of-protected-branch)", "- [Get admin enforcement of protected branch](https://developer.github.com/v3/repos/branches/#get-admin-enforcement-of-protected-branch)", "- [Add admin enforcement of protected branch](https://developer.github.com/v3/repos/branches/#add-admin-enforcement-of-protected-branch)", "- [Remove admin enforcement of protected branch](https://developer.github.com/v3/repos/branches/#remove-admin-enforcement-of-protected-branch)", "- [Get restrictions of protected branch](https://developer.github.com/v3/repos/branches/#get-restrictions-of-protected-branch)", "- [Remove restrictions of protected branch](https://developer.github.com/v3/repos/branches/#remove-restrictions-of-protected-branch)", "- [List team restrictions of protected branch](https://developer.github.com/v3/repos/branches/#list-team-restrictions-of-protected-branch)", "- [Replace team restrictions of protected branch](https://developer.github.com/v3/repos/branches/#replace-team-restrictions-of-protected-branch)", "- [Add team restrictions of protected branch](https://developer.github.com/v3/repos/branches/#add-team-restrictions-of-protected-branch)", "- [Remove team restrictions of protected branch](https://developer.github.com/v3/repos/branches/#remove-team-restrictions-of-protected-branch)", "- [List user restrictions of protected branch](https://developer.github.com/v3/repos/branches/#list-user-restrictions-of-protected-branch)", "- [Replace user restrictions of protected branch](https://developer.github.com/v3/repos/branches/#replace-user-restrictions-of-protected-branch)", "- [Add user restrictions of protected branch](https://developer.github.com/v3/repos/branches/#add-user-restrictions-of-protected-branch)", "- [Remove user restrictions of protected branch](https://developer.github.com/v3/repos/branches/#remove-user-restrictions-of-protected-branch)", "", "#### Forks", "- [List forks](https://developer.github.com/v3/repos/forks/#list-forks)", "- [Create a fork](https://developer.github.com/v3/repos/forks/#create-a-fork)", "", "#### Comments", "- [List commit comments for a repository](https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository)", "- [List comments for a single commit](https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit)", "- [Create a commit comment](https://developer.github.com/v3/repos/comments/#create-a-commit-comment)", "- [Get a single commit comment](https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment)", "- [Update a commit comment](https://developer.github.com/v3/repos/comments/#update-a-commit-comment)", "- [Delete a commit comment](https://developer.github.com/v3/repos/comments/#delete-a-commit-comment)", "- [List comments on an issue](https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue)", "- [List comments in a repository](https://developer.github.com/v3/issues/comments/#list-comments-in-a-repository)", "- [Get a single comment](https://developer.github.com/v3/issues/comments/#get-a-single-comment)", "- [Create a comment](https://developer.github.com/v3/issues/comments/#create-a-comment)", "- [Edit a comment](https://developer.github.com/v3/issues/comments/#edit-a-comment)", "- [Delete a comment](https://developer.github.com/v3/issues/comments/#delete-a-comment)", "", "#### Merging", "- [Perform a merge](https://developer.github.com/v3/repos/merging/#perform-a-merge)", "", "#### Contents", "- [Get the README](https://developer.github.com/v3/repos/contents/#get-the-readme)", "- [Get contents](https://developer.github.com/v3/repos/contents/#get-contents)", "- [Create a file](https://developer.github.com/v3/repos/contents/#create-a-file)", "- [Update a file](https://developer.github.com/v3/repos/contents/#update-a-file)", "- [Delete a file](https://developer.github.com/v3/repos/contents/#delete-a-file)", "- [Get archive link](https://developer.github.com/v3/repos/contents/#get-archive-link)", "", "#### Statuses", "- [Create a status](https://developer.github.com/v3/repos/statuses/#create-a-status)", "- [List statuses for a specific ref](https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref)", "- [Get the combined status for a specific ref](https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref)", "", "#### Pages", "- [Get information about a Pages site](https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site)", "- [Request a page build](https://developer.github.com/v3/repos/pages/#request-a-page-build)", "- [List Pages builds](https://developer.github.com/v3/repos/pages/#list-pages-builds)", "- [List latest Pages build](https://developer.github.com/v3/repos/pages/#list-latest-pages-build)", "- [List a specific Pages build](https://developer.github.com/v3/repos/pages/#list-a-specific-pages-build)", "", "#### Community Profile", "- [Retrieve community profile metrics](https://developer.github.com/v3/repos/community/#retrieve-community-profile-metrics)", "", "#### Deployments", "- [List deployments](https://developer.github.com/v3/repos/deployments/#list-deployments)", "- [Get a single deployment](https://developer.github.com/v3/repos/deployments/#get-a-single-deployment)", "- [Create a deployment](https://developer.github.com/v3/repos/deployments/#create-a-deployment)", "- [List deployment statuses](https://developer.github.com/v3/repos/deployments/#list-deployment-statuses)", "- [Get a single deployment status](https://developer.github.com/v3/repos/deployments/#get-a-single-deployment-status)", "- [Create a deployment status](https://developer.github.com/v3/repos/deployments/#create-a-deployment-status)", "", "#### Deploy Keys", "- [List deploy keys](https://developer.github.com/v3/repos/keys/#list-deploy-keys)", "- [Get a deploy key](https://developer.github.com/v3/repos/keys/#get-a-deploy-key)", "- [Add a new deploy key](https://developer.github.com/v3/repos/keys/#add-a-new-deploy-key)", "- [Remove a deploy key](https://developer.github.com/v3/repos/keys/#remove-a-deploy-key)", "", "#### Statistics", "- [Get contributors list with additions, deletions, and commit counts](https://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts)", "- [Get the last year of commit activity data](https://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data)", "- [Get the number of additions and deletions per week](https://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week)", "- [Get the weekly commit count for the repository owner and everyone else](https://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repository-owner-and-everyone-else)", "- [Get the number of commits per hour in each day](https://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day)", "", "#### Releases", "- [List releases for a repository](https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository)", "- [Get a single release](https://developer.github.com/v3/repos/releases/#get-a-single-release)", "- [Get the latest release](https://developer.github.com/v3/repos/releases/#get-the-latest-release)", "- [Get a release by tag name](https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name)", "- [Create a release](https://developer.github.com/v3/repos/releases/#create-a-release)", "- [Edit a release](https://developer.github.com/v3/repos/releases/#edit-a-release)", "- [Delete a release](https://developer.github.com/v3/repos/releases/#delete-a-release)", "- [List assets for a release](https://developer.github.com/v3/repos/releases/#list-assets-for-a-release)", "- [Upload a release asset](https://developer.github.com/v3/repos/releases/#upload-a-release-asset)", "- [Get a single release asset](https://developer.github.com/v3/repos/releases/#get-a-single-release-asset)", "- [Edit a release asset](https://developer.github.com/v3/repos/releases/#edit-a-release-asset)", "- [Delete a release asset](https://developer.github.com/v3/repos/releases/#delete-a-release-asset)", "", "#### Collaborators", "- [List collaborators](https://developer.github.com/v3/repos/collaborators/#list-collaborators)", "- [Check if a user is a collaborator](https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator)", "- [Review a user's permission level](https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level)", "- [Add user as a collaborator](https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator)", "- [Remove user as a collaborator](https://developer.github.com/v3/repos/collaborators/#remove-user-as-a-collaborator)", "", "#### Search", "- [Search repositories](https://developer.github.com/v3/search/#search-repositories)", "- [Search commits](https://developer.github.com/v3/search/#search-commits)", "- [Search code](https://developer.github.com/v3/search/#search-code)", "- [Search issues](https://developer.github.com/v3/search/#search-issues)", "- [Search users](https://developer.github.com/v3/search/#search-users)", "- [Search topics](https://developer.github.com/v3/search/#search-topics)", "- [Search labels](https://developer.github.com/v3/search/#search-labels)", "", "#### Meta", "- [Meta](https://developer.github.com/v3/meta/#meta)", "", "#### Codes of Conduct", "- [List all codes of conduct](https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct)", "- [Get an individual code of conduct](https://developer.github.com/v3/codes_of_conduct/#get-an-individual-code-of-conduct)", "- [Get a repository's code of conduct](https://developer.github.com/v3/codes_of_conduct/#get-a-repositorys-code-of-conduct)", "", "#### Public Keys", "- [List public keys for a user](https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user)", "", "#### GitHub Apps", "- [Get a single GitHub App](https://developer.github.com/v3/apps/#get-a-single-github-app)", "- [Get the authenticated GitHub App](https://developer.github.com/v3/apps/#get-the-authenticated-github-app)", "- [Find installations](https://developer.github.com/v3/apps/#find-installations)", "- [Get a single installation](https://developer.github.com/v3/apps/#get-a-single-installation)", "- [Create a new installation token](https://developer.github.com/v3/apps/#create-a-new-installation-token)", "", "#### Installations", "- [List repositories](https://developer.github.com/v3/apps/installations/#list-repositories)", "", "#### Licenses", "- [List all licenses](https://developer.github.com/v3/licenses/#list-all-licenses)", "- [Get an individual license](https://developer.github.com/v3/licenses/#get-an-individual-license)", "", "#### Reactions", "- [List reactions for a commit comment](https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment)", "- [List reactions for an issue](https://developer.github.com/v3/reactions/#list-reactions-for-an-issue)", "- [List reactions for an issue comment](https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment)", "- [List reactions for a pull request review comment](https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment)", "- [List reactions for a team discussion](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion)", "- [List reactions for a team discussion comment](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment)", "", "#### Markdown", "- [Render an arbitrary Markdown document](https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document)", "- [Render a Markdown document in raw mode](https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode)", "", "#### Milestones", "- [List milestones for a repository](https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository)", "- [Get a single milestone](https://developer.github.com/v3/issues/milestones/#get-a-single-milestone)", "- [Create a milestone](https://developer.github.com/v3/issues/milestones/#create-a-milestone)", "- [Update a milestone](https://developer.github.com/v3/issues/milestones/#update-a-milestone)", "- [Delete a milestone](https://developer.github.com/v3/issues/milestones/#delete-a-milestone)", "", "#### Labels", "- [List all labels for this repository](https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository)", "- [Get a single label](https://developer.github.com/v3/issues/labels/#get-a-single-label)", "- [Create a label](https://developer.github.com/v3/issues/labels/#create-a-label)", "- [Update a label](https://developer.github.com/v3/issues/labels/#update-a-label)", "- [Delete a label](https://developer.github.com/v3/issues/labels/#delete-a-label)", "- [List labels on an issue](https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue)", "- [Add labels to an issue](https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue)", "- [Remove a label from an issue](https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue)", "- [Replace all labels for an issue](https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue)", "- [Remove all labels from an issue](https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue)", "- [Get labels for every issue in a milestone](https://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone)", "", "#### Timeline", "- [List events for an issue](https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue)", "", "#### Assignees", "- [List assignees](https://developer.github.com/v3/issues/assignees/#list-assignees)", "- [Check assignee](https://developer.github.com/v3/issues/assignees/#check-assignee)", "- [Add assignees to an issue](https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue)", "- [Remove assignees from an issue](https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue)", "", "# [GitHub Marketplace](https://developer.github.com/v3/apps/marketplace/)", "", "**Note:** The The GitHub Marketplace API on GitHub is currently available for developers to preview. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.valkyrie-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "For more information about GitHub Marketplace, see \"[GitHub Marketplace](https://developer.github.com/apps/marketplace/).\"", "", "**Note:** This preview includes methods for testing with **stubbed data**. Stubbed data is fake data that's useful for testing your GitHub Apps. Stubbed data is hard-coded and will not change based on actual subscriptions.", "", "To test with stubbed data, use a stubbed endpoint in place of its production counterpart. This allows you to test whether API logic succeeds before listing GitHub Apps on GitHub Marketplace.", "", "Be sure to replace stubbed endpoints with production endpoints before deploying your GitHub App.", "", "Endpoints for ```/marketplace_listing/*``` and ```/user/marketplace_purchases``` are only accessible by OAuth Apps using ```client_id``` and ```secret``` basic authentication or by [GitHub Apps using a JWT](https://developer.github.com/apps/building-github-apps/authentication-options-for-github-apps/#authenticating-as-a-github-app).", "-", "", "For API authentication for GitHub Marketplace listings associated with an OAuth App, see \"[Authorization options for OAuth Apps](https://developer.github.com/apps/building-oauth-apps/authorization-options-for-oauth-apps/).\"", "-", "", "For API authentication for GitHub Marketplace listings associated with a GitHub App, see \"[Authentication options for GitHub Apps](https://developer.github.com/apps/building-github-apps/authentication-options-for-github-apps/).\"", "", "# [Installations](https://developer.github.com/v3/apps/installations/)", "", "For information on how to authenticate as an installation, see \"[Authentication Options for GitHub Apps](https://developer.github.com/apps/building-github-apps/authentication-options-for-github-apps#authenticating-as-an-installation).\"", "", "**Note:** To access the API with your integration, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` Header for your requests.", "", "```", "application/vnd.github.machine-man-preview+json", "```" ] }, "github-gists": { "x-swgg-descriptionLineList": [ "# [Gists](https://developer.github.com/v3/gists/)", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "Custom media types", "", "The following media types are supported when fetching gist contents. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/vnd.github.VERSION.raw", "application/vnd.github.VERSION.base64", "```", "", "# [Gist Comments](https://developer.github.com/v3/gists/comments/)", "", "Gist Comments use [these custom media types](https://developer.github.com/v3/gists/comments/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "", "Custom media types", "", "These are the supported media types for gist comments. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/vnd.github.VERSION.raw+json", "application/vnd.github.VERSION.text+json", "application/vnd.github.VERSION.html+json", "application/vnd.github.VERSION.full+json", "```" ] }, "github-git": { "x-swgg-descriptionLineList": [ "# [Git Data](https://developer.github.com/v3/git/)", "", "The Git Database API gives you access to read and write raw Git objects to your Git database on GitHub and to list and update your references (branch heads and tags).", "", "This basically allows you to reimplement a lot of Git functionality over our API - by creating raw objects directly into the database and updating branch references you could technically do just about anything that Git can do without having Git installed.", "", "Git DB API functions will return a ```409 Conflict``` if the git repository for a Repository is empty or unavailable. This typically means it is being created still. Contact [GitHub support](https://github.com/contact) if this response status persists.", "", "For more information on the Git object database, please read the [Git Internals](http://git-scm.com/book/en/v1/Git-Internals) chapter of the Pro Git book.", "", "As an example, if you wanted to commit a change to a file in your repository, you would:", "- get the current commit object", "- retrieve the tree it points to", "- retrieve the content of the blob object that tree has for that particular file path", "- change the content somehow and post a new blob object with that new content, getting a blob SHA back", "- post a new tree object with that file path pointer replaced with your new blob SHA getting a tree SHA back", "- create a new commit object with the current commit SHA as the parent and the new tree SHA, getting a commit SHA back", "- update the reference of your branch to point to the new commit SHA", "", "It might seem complex, but it's actually pretty simple when you understand the model and it opens up a ton of things you could potentially do with the API.", "", "# [Git Blobs](https://developer.github.com/v3/git/blobs/)", "", "Blobs leverage [these custom media types](https://developer.github.com/v3/git/blobs/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "Custom media types", "", "These are the supported media types for blobs. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/json", "application/vnd.github.VERSION.raw", "```", "", "# [Git Commits](https://developer.github.com/v3/git/commits/)", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Git Refs](https://developer.github.com/v3/git/refs/)", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Git Tags](https://developer.github.com/v3/git/tags/)", "", "This tags API only deals with tag objects - so only annotated tags, not lightweight tags.", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Git Trees](https://developer.github.com/v3/git/trees/)", "", "no description" ] }, "github-issues": { "x-swgg-descriptionLineList": [ "# [Issues](https://developer.github.com/v3/issues/)", "", "Issues use [these custom media types](https://developer.github.com/v3/issues/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "Custom media types", "", "These are the supported media types for issues. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/vnd.github.VERSION.raw+json", "application/vnd.github.VERSION.text+json", "application/vnd.github.VERSION.html+json", "application/vnd.github.VERSION.full+json", "```", "", "# [Issue Assignees](https://developer.github.com/v3/issues/assignees/)", "", "no description", "", "# [Issue Comments](https://developer.github.com/v3/issues/comments/)", "", "The Issue Comments API supports listing, viewing, editing, and creating comments on issues and pull requests.", "", "Issue Comments use [these custom media types](https://developer.github.com/v3/issues/comments/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "", "Custom media types", "", "These are the supported media types for issue comments. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/vnd.github.VERSION.raw+json", "application/vnd.github.VERSION.text+json", "application/vnd.github.VERSION.html+json", "application/vnd.github.VERSION.full+json", "```", "", "# [Issue Events](https://developer.github.com/v3/issues/events/)", "", "Records various events that occur around an issue or pull request. This is useful both for display on issue/pull request information pages and also to determine who should be notified of comments.", "", "#### Attributes", "- id - The Integer ID of the event.", "- url - The API URL for fetching the event.", "- actor - The User object that generated the event.", "- commit_id - The String SHA of a commit that referenced this Issue", "- commit_url - The GitHub API link to a commit that referenced this Issue", "- event - Identifies the actual type of Event that occurred.", "- created_at - The timestamp indicating when the event occurred.", "- labels - The Labels object, including `name` and `color` attributes. Only provided for `labeled` and `unlabeled` events.", "- assignee - The User object which was assigned to (or unassigned from) this Issue. Only provided for 'assigned' and 'unassigned' events.", "- assigner - The User object that performed the assignment (or unassignment) for this Issue. Only provided for 'assigned' and 'unassigned' events.", "- review_requester - The User who requested a review. Only provided for 'review_requested' and 'review_request_removed' events.", "- requested_reviewers - The Users whose reviews were requested. Only provided for 'review_requested' and 'review_request_removed' events.", "- lock_reason - The reason an issue or pull request conversation was locked, if one was provided. Only provided for `locked` events.", "- dismissed_review - A `dismissed_review` object that includes the `state`, `review_id`, `dismissal_message`, and `dismissal_commit_id` (the ID of the commit that dismissed the review) if one exists. Possible `state` strings include `commented`, `approved`, or `changes_requested`. Only provided for `review_dismissed` events.", "- milestone - The Milestone object including a `title` attribute. Only provided for `milestoned` and `demilestoned` events.", "- rename - An object containing rename details including `from` and `to` attributes. Only provided for `renamed` events.", "", "#### Events", "- closed - The issue was closed by the actor. When the commit_id is present, it identifies the commit that closed the issue using \"closes / fixes #NN\" syntax.", "- reopened - The issue was reopened by the actor.", "- subscribed - The actor subscribed to receive notifications for an issue.", "- merged - The issue was merged by the actor. The `commit_id` attribute is the SHA1 of the HEAD commit that was merged.", "- referenced - The issue was referenced from a commit message. The `commit_id` attribute is the commit SHA1 of where that happened.", "- mentioned - The actor was @mentioned in an issue body.", "- assigned - The issue was assigned to the actor.", "- unassigned - The actor was unassigned from the issue.", "- labeled - A label was added to the issue.", "- unlabeled - A label was removed from the issue.", "- milestoned - The issue was added to a milestone.", "- demilestoned - The issue was removed from a milestone.", "- renamed - The issue title was changed.", "- locked - The issue was locked by the actor.", "- unlocked - The issue was unlocked by the actor.", "- head_ref_deleted - The pull request's branch was deleted.", "- head_ref_restored - The pull request's branch was restored.", "- review_dismissed - The actor dismissed a review from the pull request.", "- review_requested - The actor requested review from the subject on this pull request.", "- review_request_removed - The actor removed the review request for the subject on this pull request.", "- marked_as_duplicate - A user with write permissions marked an issue as a duplicate of another issue or a pull request as a duplicate of another pull request.", "- unmarked_as_duplicate - An issue that a user had previously marked as a duplicate of another issue is no longer considered a duplicate, or a pull request that a user had previously marked as a duplicate of another pull request is no longer considered a duplicate.", "- added_to_project - The issue was added to a project board.", "- moved_columns_in_project - The issue was moved between columns in a project board.", "- removed_from_project - The issue was removed from a project board.", "- converted_note_to_issue - The issue was created by converting a note in a project board to an issue.", "", "**Note**: The project-related events ```added_to_project```, ```moved_columns_in_project```, ```removed_from_project```, and ```converted_note_to_issue``` will not be included in the response if project boards have been [disabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) in the repository.", "", "# [Issue Labels](https://developer.github.com/v3/issues/labels/)", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Issue Milestones](https://developer.github.com/v3/issues/milestones/)", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Issue Timeline](https://developer.github.com/v3/issues/timeline/)", "", "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details.", "", "To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.mockingbird-preview", "```", "", "#### Timeline", "- [List events for an issue](https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue)", "", "Records various events that occur around an issue or pull request. This is useful both for display on issue and pull request information pages, as well as to determine who should be notified of comments.", "", "#### Attributes", "- id - The Integer ID of the event.", "- url - The API URL for fetching the event.", "- actor - The User object that generated the event.", "- commit_id - The String SHA of a commit that referenced this Issue.", "- event - Identifies the actual type of Event that occurred.", "- created_at - The timestamp indicating when the event occurred.", "- label - The Label object including `name` and `color` attributes. Only provided for `labeled` and `unlabeled` events.", "- assignee - The User object which was assigned to (or unassigned from) this Issue. Only provided for `assigned` and `unassigned` events.", "- dismissed_review - A `dismissed_review` object that includes the `state`, `review_id`, `dismissal_message`, and `dismissal_commit_id` (the ID of the commit that dismissed the review) if one exists. Possible `state` strings include `commented`, `approved`, or `changes_requested`. Only provided for `review_dismissed` events.", "- milestone - The Milestone object including a `title` attribute. Only provided for `milestoned` and `demilestoned` events.", "- source - The `id`, `actor`, and `url` for the source of a reference from another issue. Only provided for `cross-referenced` events.", "- rename - An object containing rename details including `from` and `to` attributes. Only provided for `renamed` events.", "", "#### Events", "- added_to_project - The issue was added to a project board.", "- assigned - The issue was assigned to the assignee.", "- closed - The issue was closed by the actor. When the commit_id is present, it identifies the commit that closed the issue using \"closes / fixes #NN\" syntax.", "- commented - A comment was added to the issue.", "- committed - A commit was added to the pull request's `HEAD` branch. Only provided for pull requests.", "- converted_note_to_issue - The issue was created by converting a note in a project board to an issue.", "- cross-referenced - The issue was referenced from another issue. The `source` attribute contains the `id`, `actor`, and `url` of the reference's source.", "- demilestoned - The issue was removed from a milestone.", "- head_ref_deleted - The pull request's branch was deleted.", "- head_ref_restored - The pull request's branch was restored.", "- labeled - A label was added to the issue.", "- locked - The issue was locked by the actor.", "- marked_as_duplicate - A user with write permissions marked an issue as a duplicate of another issue or a pull request as a duplicate of another pull request.", "- mentioned - The actor was @mentioned in an issue body.", "- merged - The issue was merged by the actor. The `commit_id` attribute is the SHA1 of the HEAD commit that was merged.", "- milestoned - The issue was added to a milestone.", "- moved_columns_in_project - The issue was moved between columns in a project board.", "- referenced - The issue was referenced from a commit message. The `commit_id` attribute is the commit SHA1 of where that happened.", "- removed_from_project - The issue was removed from a project board.", "- renamed - The issue title was changed.", "- reopened - The issue was reopened by the actor.", "- review_dismissed - The actor dismissed a review from the pull request.", "- review_requested - The actor requested a review from the subject on this pull request.", "- review_request_removed - The actor removed the review request for the subject on this pull request.", "- subscribed - The actor subscribed to receive notifications for an issue.", "- unassigned - The assignee was unassigned from the issue.", "- unlabeled - A label was removed from the issue.", "- unlocked - The issue was unlocked by the actor.", "- unmarked_as_duplicate - An issue that a user had previously marked as a duplicate of another issue is no longer considered a duplicate, or a pull request that a user had previously marked as a duplicate of another pull request is no longer considered a duplicate.", "- unsubscribed - The actor unsubscribed to stop receiving notifications for an issue.", "", "**Note**: The project-related events ```added_to_project```, ```moved_columns_in_project```, ```removed_from_project```, and ```converted_note_to_issue``` will not be included in the response if project boards have been [disabled](https://help.github.com/articles/disabling-project-boards-in-a-repository) in the repository." ] }, "github-migration": { "x-swgg-descriptionLineList": [ "# [Migration](https://developer.github.com/v3/migration/)", "", "These APIs help you move projects to or from GitHub.", "", "# [Migrations](https://developer.github.com/v3/migration/migrations/)", "", "The Migrations API is only available to [authenticated](https://developer.github.com/v3/#authentication) organization [owners](https://help.github.com/articles/permission-levels-for-an-organization/).", "", "To access the Migrations API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.wyandotte-preview+json", "```", "", "# [Source Imports](https://developer.github.com/v3/migration/source_imports/)", "", "The source import APIs are currently in public preview. During this period, the APIs may change in a backwards-incompatible way. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.barred-rock-preview", "```", "", "The Source Import API lets you start an import from a Git, Subversion, Mercurial, or Team Foundation Server source repository. This is the same functionality as [the GitHub Importer](https://help.github.com/articles/importing-from-other-version-control-systems-to-github/).", "", "A typical source import would [start the import](https://developer.github.com/v3/migration/source_imports/#start-an-import) and then (optionally) [update the authors](https://developer.github.com/v3/migration/source_imports/#map-a-commit-author) and/or [set the preference](https://developer.github.com/v3/migration/source_imports/#set-git-lfs-preference) for using Git LFS if large files exist in the import. A more detailed example can be seen in this diagram:", "```", "+---------+ +--------+ +---------------------+", "| Tooling | | GitHub | | Original Repository |", "+---------+ +--------+ +---------------------+", " | | |", " | Start import | |", " |----------------------------->| |", " | | |", " | | Download source data |", " | |--------------------------------------------->|", " | | Begin streaming data |", " | |<---------------------------------------------|", " | | |", " | Get import progress | |", " |----------------------------->| |", " | \"status\": \"importing\" | |", " |<-----------------------------| |", " | | |", " | Get commit authors | |", " |----------------------------->| |", " | | |", " | Map a commit author | |", " |----------------------------->| |", " | | |", " | | |", " | | Finish streaming data |", " | |<---------------------------------------------|", " | | |", " | | Rewrite commits with mapped authors |", " | |------+ |", " | | | |", " | |<-----+ |", " | | |", " | | Update repository on GitHub |", " | |------+ |", " | | | |", " | |<-----+ |", " | | |", " | Map a commit author | |", " |----------------------------->| |", " | | Rewrite commits with mapped authors |", " | |------+ |", " | | | |", " | |<-----+ |", " | | |", " | | Update repository on GitHub |", " | |------+ |", " | | | |", " | |<-----+ |", " | | |", " | Get large files | |", " |----------------------------->| |", " | | |", " | opt_in to Git LFS | |", " |----------------------------->| |", " | | Rewrite commits for large files |", " | |------+ |", " | | | |", " | |<-----+ |", " | | |", " | | Update repository on GitHub |", " | |------+ |", " | | | |", " | |<-----+ |", " | | |", " | Get import progress | |", " |----------------------------->| |", " | \"status\": \"complete\" | |", " |<-----------------------------| |", " | | |", " | | |", "```" ] }, "github-misc": { "x-swgg-descriptionLineList": [ "# [Miscellaneous](https://developer.github.com/v3/misc/)", "", "This is a miscellaneous set of APIs which provide access to top level GitHub resources and info.", "", "# [Codes of Conduct](https://developer.github.com/v3/codes_of_conduct/)", "", "The Codes of Conduct API is currently available for developers to preview. During the preview period, the API may change without advance notice.", "", "To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.scarlet-witch-preview+json", "```", "", "# [Emojis](https://developer.github.com/v3/emojis/)", "", "Lists all the emojis available to use on GitHub.", "", "# [Gitignore](https://developer.github.com/v3/gitignore/)", "", "When you create a new GitHub repository via the API, you can specify a [.gitignore template](https://help.github.com/articles/ignoring-files) to apply to the repository upon creation. The .gitignore Templates API lists and fetches templates from the [GitHub .gitignore repository](https://github.com/github/gitignore).", "", "# [Licenses](https://developer.github.com/v3/licenses/)", "", "The Licenses API returns metadata about popular open source licenses and information about a particular project's license file.", "", "The Licenses API uses [the open source Ruby Gem Licensee](https://github.com/benbalter/licensee) to attempt to identify the project's license. Licensee matches the contents of a project's ```LICENSE``` file (if it exists) against a short list of known licenses. As a result, the API does not take into account the licenses of project dependencies or other means of documenting a project's license such as references to the license name in the documentation.", "", "If a license is matched, the license key and name returned conforms to the [SPDX specification](https://spdx.org/).", "", "**Note:** These endpoints will also return a repository's license information:", "- [Get a repository](https://developer.github.com/v3/repos/#get)", "- [List user repositories](https://developer.github.com/v3/repos/#list-user-repositories)", "- [List organization repositories](https://developer.github.com/v3/repos/#list-organization-repositories)", "- [List forks](https://developer.github.com/v3/repos/forks/#list-forks)", "- [List repositories being watched](https://developer.github.com/v3/activity/watching/#list-repositories-being-watched)", "- [List team repos](https://developer.github.com/v3/teams/#list-team-repos)", "", "GitHub is a lot of things, but it’s not a law firm. As such, GitHub does not provide legal advice. Using the Licenses API or sending us an email about it does not constitute legal advice nor does it create an attorney-client relationship. If you have any questions about what you can and can't do with a particular license, you should consult with your own legal counsel before moving forward. In fact, you should always consult with your own lawyer before making any decisions that might have legal ramifications or that may impact your legal rights.", "", "GitHub created the License API to help users get information about open source licenses and the projects that use them. We hope it helps, but please keep in mind that we’re not lawyers (at least not most of us aren't) and that we make mistakes like everyone else. For that reason, GitHub provides the API on an “as-is” basis and makes no warranties regarding any information or licenses provided on or through it, and disclaims liability for damages resulting from using the API.", "", "# [Markdown](https://developer.github.com/v3/markdown/)", "", "no description", "", "# [Meta](https://developer.github.com/v3/meta/)", "", "This endpoint provides information about GitHub.com, the service.", "", "# [Rate Limit](https://developer.github.com/v3/rate_limit/)", "", "The overview documentation describes the [rate limit rules](https://developer.github.com/v3/#rate-limiting). You can check your current rate limit status at any time using the Rate Limit API described below." ] }, "github-orgs": { "x-swgg-descriptionLineList": [ "# [Organizations](https://developer.github.com/v3/orgs/)", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Blocking Organization Users](https://developer.github.com/v3/orgs/blocking/)", "", "**Note:** The User Blocking API on GitHub is currently available for developers to preview. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.giant-sentry-fist-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "The token used to authenticate the call must have the ```admin:org``` scope in order to make any blocking calls for an organization. Otherwise, the response returns ```HTTP 404```.", "", "# [Organization Members](https://developer.github.com/v3/orgs/members/)", "", "no description", "", "# [Organization Outside Collaborators](https://developer.github.com/v3/orgs/outside_collaborators/)", "", "no description", "", "# [Organization Webhooks](https://developer.github.com/v3/orgs/hooks/)", "", "Organization webhooks allow you to receive HTTP ```POST``` payloads whenever certain events happen within the organization. Subscribing to these events makes it possible to build integrations that react to actions on GitHub.com. For more information on actions you can subscribe to, check out our [Events documentation](https://developer.github.com/webhooks/#events)." ] }, "github-projects": { "x-swgg-descriptionLineList": [ "# [Projects](https://developer.github.com/v3/projects/)", "", "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.inertia-preview+json", "```", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Project cards](https://developer.github.com/v3/projects/cards/)", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Project collaborators](https://developer.github.com/v3/projects/collaborators/)", "", "This API allows you to interact with an organization's projects.", "", "# [Project columns](https://developer.github.com/v3/projects/columns/)", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ] }, "github-pulls": { "x-swgg-descriptionLineList": [ "# [Pull Requests](https://developer.github.com/v3/pulls/)", "", "The Pull Request API allows you to list, view, edit, create, and even merge pull requests. Comments on pull requests can be managed via the [Issue Comments API](https://developer.github.com/v3/issues/comments/).", "", "Pull Requests use [these custom media types](https://developer.github.com/v3/pulls/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "Custom media types", "", "These are the supported media types for pull requests. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/vnd.github.VERSION.raw+json", "application/vnd.github.VERSION.text+json", "application/vnd.github.VERSION.html+json", "application/vnd.github.VERSION.full+json", "application/vnd.github.VERSION.diff", "application/vnd.github.VERSION.patch", "```", "", "# [Review Comments](https://developer.github.com/v3/pulls/comments/)", "", "Pull Request review comments are comments on a portion of the unified diff. These are separate from Commit Comments (which are applied directly to a commit, outside of the Pull Request view), and Issue Comments (which do not reference a portion of the unified diff).", "", "Pull Request review comments use [these custom media types](https://developer.github.com/v3/pulls/comments/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "", "Custom media types", "", "These are the supported media types for pull request review comments. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/vnd.github.VERSION.raw+json", "application/vnd.github.VERSION.text+json", "application/vnd.github.VERSION.html+json", "application/vnd.github.VERSION.full+json", "```", "", "# [Review Requests](https://developer.github.com/v3/pulls/review_requests/)", "", "Pull request authors and repository owners and collaborators can request a pull request review from anyone with write access to the repository. Each requested reviewer will receive a notification asking them to review the pull request.", "", "# [Reviews](https://developer.github.com/v3/pulls/reviews/)", "", "Pull Request Reviews are groups of Pull Request Review Comments on the Pull Request, grouped together with a state and optional body comment.", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ] }, "github-reactions": { "x-swgg-descriptionLineList": [ "# [Reactions](https://developer.github.com/v3/reactions/)", "", "**Note:** APIs for managing reactions are currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.squirrel-girl-preview+json", "```", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ] }, "github-repos": { "x-swgg-descriptionLineList": [ "# [Repositories](https://developer.github.com/v3/repos/)", "", "**Note:** The ```topics``` property for repositories on GitHub is currently available for developers to preview. To view the ```topics``` property in calls that return repository results, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.mercy-preview+json", "```", "", "**Note:** The [Repository Transfer API](https://developer.github.com/changes/2017-11-09-repository-transfer-api-preview) is currently available for developers to preview. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.nightshade-preview+json", "```", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Branches](https://developer.github.com/v3/repos/branches/)", "", "no description", "", "# [Collaborators](https://developer.github.com/v3/repos/collaborators/)", "", "no description", "", "# [Comments](https://developer.github.com/v3/repos/comments/)", "", "Custom media types", "", "These are the supported media types for commit comments. You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).", "```", "application/vnd.github-commitcomment.raw+json", "application/vnd.github-commitcomment.text+json", "application/vnd.github-commitcomment.html+json", "application/vnd.github-commitcomment.full+json", "```", "", "# [Commits](https://developer.github.com/v3/repos/commits/)", "", "The Repo Commits API supports listing, viewing, and comparing commits in a repository.", "", "# [Community](https://developer.github.com/v3/repos/community/)", "", "We're currently offering a preview of the Community Profile API (also known as community health).", "", "To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.black-panther-preview+json", "```", "", "# [Contents](https://developer.github.com/v3/repos/contents/)", "", "These API methods let you retrieve the contents of files within a repository as Base64 encoded content. See [media types](https://developer.github.com/v3/repos/contents/#custom-media-types) for requesting the raw format or rendered HTML (when supported).", "", "Custom media types", "", "[READMEs](https://developer.github.com/v3/repos/contents/#get-the-readme), [files](https://developer.github.com/v3/repos/contents/#get-contents), and [symlinks](https://developer.github.com/v3/repos/contents/#get-contents) support the following custom media types:", "```", "application/vnd.github.VERSION.raw", "application/vnd.github.VERSION.html", "```", "", "# [Deploy Keys](https://developer.github.com/v3/repos/keys/)", "", "no description", "", "# [Deployments](https://developer.github.com/v3/repos/deployments/)", "", "Deployments are a request for a specific ref (branch, SHA, tag) to be deployed. GitHub then dispatches deployment events that external services can listen for and act on. This enables developers and organizations to build loosely-coupled tooling around deployments, without having to worry about implementation details of delivering different types of applications (e.g., web, native).", "", "Deployment statuses allow external services to mark deployments with an ```error```, ```failure```, ```pending```, or ```success``` state, which can then be consumed by any system listening for ```deployment_status``` events.", "", "Deployment statuses can also include an optional ```description``` and ```target_url```, and we highly recommend providing them as they make deployment statuses much more useful. The ```target_url``` would be the full URL to the deployment output, and the ```description``` would be the high level summary of what happened with the deployment.", "", "Deployments and deployment statuses both have associated [repository events](https://developer.github.com/v3/activity/events/types/#deploymentevent) when they're created. This allows webhooks and 3rd party integrations to respond to deployment requests as well as update the status of a deployment as progress is made.", "", "Below is a simple sequence diagram for how these interactions would work.", "```", "+---------+ +--------+ +-----------+ +-------------+", "| Tooling | | GitHub | | 3rd Party | | Your Server |", "+---------+ +--------+ +-----------+ +-------------+", " | | | |", " | Create Deployment | | |", " |--------------------->| | |", " | | | |", " | Deployment Created | | |", " |<---------------------| | |", " | | | |", " | | Deployment Event | |", " | |---------------------->| |", " | | | SSH+Deploys |", " | | |-------------------->|", " | | | |", " | | Deployment Status | |", " | |<----------------------| |", " | | | |", " | | | Deploy Completed |", " | | |<--------------------|", " | | | |", " | | Deployment Status | |", " | |<----------------------| |", " | | | |", "```", "", "", "Keep in mind that GitHub is never actually accessing your servers. It's up to your 3rd party integration to interact with deployment events. This allows for [GitHub integrations](https://github.com/integrations) as well as running your own systems depending on your use case. Multiple systems can listen for deployment events, and it's up to each of those systems to decide whether or not they're responsible for pushing the code out to your servers, building native code, etc.", "", "Note that the ```repo_deployment``` [OAuth scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/) grants targeted access to deployments and deployment statuses **without** granting access to repository code, while the ```repo``` scope grants permission to code as well.", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Downloads](https://developer.github.com/v3/repos/downloads/)", "", "The Downloads API (described below) was [deprecated on December 11, 2012](https://github.com/blog/1302-goodbye-uploads). It will be removed at a future date.", "", "We recommend using [Releases](https://developer.github.com/v3/repos/releases/) instead.", "", "The downloads API is for package downloads only. If you want to get source tarballs you should use [this](https://developer.github.com/v3/repos/contents/#get-archive-link) instead.", "", "# [Forks](https://developer.github.com/v3/repos/forks/)", "", "no description", "", "# [Merging](https://developer.github.com/v3/repos/merging/)", "", "The Repo Merging API supports merging branches in a repository. This accomplishes essentially the same thing as merging one branch into another in a local repository and then pushing to GitHub. The benefit is that the merge is done on the server side and a local repository is not needed. This makes it more appropriate for automation and other tools where maintaining local repositories would be cumbersome and inefficient.", "", "The authenticated user will be the author of any merges done through this endpoint.", "", "# [Pages](https://developer.github.com/v3/repos/pages/)", "", "The GitHub Pages API retrieves information about your GitHub Pages configuration, and the statuses of your builds. Information about the site and the builds can only be accessed by authenticated owners, even though the websites are public.", "", "In JSON responses, ```status``` can be one of:", "- ```null```, which means the site has yet to be built", "- ```queued```, which means the build has been requested but not yet begun", "- ```building```, which means the build is in progress", "- ```built```, which means the site has been built", "- ```errored```, which indicates an error occurred during the build", "", "# [Releases](https://developer.github.com/v3/repos/releases/)", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Repository Invitations](https://developer.github.com/v3/repos/invitations/)", "", "The Repository Invitations API allows users or external services to invite other users to collaborate on a repo. The invited users (or external services on behalf of invited users) can choose to accept or decline the invitations.", "", "Note that the ```repo:invite``` [OAuth scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/) grants targeted access to invitations **without** also granting access to repository code, while the ```repo``` scope grants permission to code as well as invitations.", "", "# [Repository Webhooks](https://developer.github.com/v3/repos/hooks/)", "", "The Repository Webhooks API allows repository admins to manage the post-receive hooks for a repository. Webhooks can be managed using the JSON HTTP API, or the [PubSubHubbub API](https://developer.github.com/v3/repos/hooks/#pubsubhubbub).", "", "If you would like to set up a single webhook to receive events from all of your organization's repositories, check out our [API documentation for Organization Webhooks](https://developer.github.com/v3/orgs/hooks/).", "", "# [Statistics](https://developer.github.com/v3/repos/statistics/)", "", "The Repository Statistics API allows you to fetch the data that GitHub uses for visualizing different types of repository activity.", "", "#### A word about caching", "", "Computing repository statistics is an expensive operation, so we try to return cached data whenever possible. If the data hasn't been cached when you query a repository's statistics, you'll receive a ```202``` response; a background job is also fired to start compiling these statistics. Give the job a few moments to complete, and then submit the request again. If the job has completed, that request will receive a ```200``` response with the statistics in the response body.", "", "Repository statistics are cached by the SHA of the repository's default branch, which is usually master; pushing to the default branch resets the statistics cache.", "", "#### Statistics exclude some types of commits", "", "The statistics exposed by the API match the statistics shown by [different repository graphs](https://help.github.com/articles/about-repository-graphs/).", "", "To summarize:", "- All statistics exclude merge commits.", "- Contributor statistics also exclude empty commits.", "", "# [Statuses](https://developer.github.com/v3/repos/statuses/)", "", "The status API allows external services to mark commits with an ```error```, ```failure```, ```pending```, or ```success``` state, which is then reflected in pull requests involving those commits.", "", "Statuses can also include an optional ```description``` and ```target_url```, and we highly recommend providing them as they make statuses much more useful in the GitHub UI.", "", "As an example, one common use is for continuous integration services to mark commits as passing or failing builds using status. The ```target_url``` would be the full URL to the build output, and the ```description``` would be the high level summary of what happened with the build.", "", "Statuses can include a ```context``` to indicate what service is providing that status. For example, you may have your continuous integration service push statuses with a context of ```ci```, and a security audit tool push statuses with a context of ```security```. You can then use the [combined status endpoint](https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref) to retrieve the whole status for a commit.", "", "Note that the ```repo:status``` [OAuth scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/) grants targeted access to statuses **without** also granting access to repository code, while the ```repo``` scope grants permission to code as well as statuses.", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Traffic](https://developer.github.com/v3/repos/traffic/)", "", "For repositories that you have push access to, the traffic API provides access to the information provided in the [graphs section](https://help.github.com/articles/about-repository-graphs/#traffic)." ] }, "github-scim": { "x-swgg-descriptionLineList": [ "# [SCIM](https://developer.github.com/v3/scim/)", "", "no description" ] }, "github-search": { "x-swgg-descriptionLineList": [ "# [Search](https://developer.github.com/v3/search/)", "", "**Note:** The ```topics``` property for repositories on GitHub is currently available for developers to preview. To view the ```topics``` property in calls that return repository results, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.mercy-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "#### About the search API", "", "The Search API is optimized to help you find the specific item you're looking for (e.g., a specific user, a specific file in a repository, etc.). Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the GitHub Search API provides **up to 1,000 results for each search**.", "", "#### Ranking search results", "", "Unless another sort option is provided as a query parameter, results are sorted by best match, as indicated by the ```score``` field for each item returned. This is a computed value representing the relevance of an item relative to the other items in the result set. Multiple factors are combined to boost the most relevant item to the top of the result list.", "", "#### Rate limit", "", "The Search API has a custom rate limit. For requests using [Basic Authentication](https://developer.github.com/v3/#authentication), [OAuth](https://developer.github.com/v3/#authentication), or [client ID and secret](https://developer.github.com/v3/#increasing-the-unauthenticated-rate-limit-for-oauth-applications), you can make up to 30 requests per minute. For unauthenticated requests, the rate limit allows you to make up to 10 requests per minute.", "", "See the [rate limit documentation](https://developer.github.com/v3/#rate-limiting) for details on determining your current rate limit status.", "", "#### Timeouts and incomplete results", "", "To keep the Search API fast for everyone, we limit how long any individual query can run. For queries that [exceed the time limit](https://developer.github.com/changes/2014-04-07-understanding-search-results-and-potential-timeouts/), the API returns the matches that were already found prior to the timeout, and the response has the ```incomplete_results``` property set to ```true```.", "", "Reaching a timeout does not necessarily mean that search results are incomplete. More results might have been found, but also might not.", "", "# [Legacy Search](https://developer.github.com/v3/search/legacy/)", "", "This is a listing of the Legacy Search API features from API v2 that have been ported to API v3. There should be no changes, other than the new URL and JSON output format.", "", "#### Legacy Search API is Deprecated", "", "The Legacy Search API (described below) is deprecated. We recommend using the [v3 Search API](https://developer.github.com/v3/search/) instead. It contains new endpoints and much more functionality." ] }, "github-teams": { "x-swgg-descriptionLineList": [ "# [Organization Teams](https://developer.github.com/v3/teams/)", "", "This API is only available to authenticated members of the team's [organization](https://developer.github.com/v3/orgs). OAuth access tokens require the ```read:org``` [scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/).", "", "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.inertia-preview+json", "```", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Team Discussion Comments](https://developer.github.com/v3/teams/discussion_comments/)", "", "The team discussion comments API allows you to get, create, edit, and delete discussion comments on a [team discussion](https://developer.github.com/v3/teams/discussions) post. Any member of the team's [organization](https://developer.github.com/v3/orgs) can create and read comments on a public discussion. For more details, see \"[About team discussions](https://help.github.com/articles/about-team-discussions/).\" This API is only available to authenticated members of the team's organization.", "", "# [Team Discussions](https://developer.github.com/v3/teams/discussions/)", "", "The team discussions API allows you to get, create, edit, and delete discussion posts on a team's page. You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](https://developer.github.com/v3/orgs) can create and read public discussion posts. For more details, see \"[About team discussions](https://help.github.com/articles/about-team-discussions/).\" To learn more about commenting on a discussion post, see the [team discussion comments API](https://developer.github.com/v3/teams/discussion_comments). This API is only available to authenticated members of the team's organization.", "", "# [Team Members](https://developer.github.com/v3/teams/members/)", "", "This API is only available to authenticated members of the team's organization. OAuth access tokens require the ```read:org``` [scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/).", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact)." ] }, "github-users": { "x-swgg-descriptionLineList": [ "# [Users](https://developer.github.com/v3/users/)", "", "Many of the resources on the users API provide a shortcut for getting information about the currently authenticated user. If a request URL does not include a ```:username``` parameter then the response will be for the logged in user (and you must pass [authentication information](https://developer.github.com/v3/#authentication) with your request). Additional private information, such as whether a user has two-factor authentication enabled, is included when authenticated through basic auth or OAuth with the ```user``` scope.", "", "**Note:** To help with migrating from our REST API v3 to GraphQL API v4, we're introducing a preview period to include the [GraphQL ```node_id```](https://developer.github.com/v3/#graphql-global-relay-ids) in the response for many REST API v3 resources. See the [blog post](https://developer.github.com/changes/2017-12-19-graphql-node-id) for full details. To access ```node_id``` during the preview period, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.jean-grey-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [Block Another User](https://developer.github.com/v3/users/blocking/)", "", "**Note:** The User Blocking API on GitHub is currently available for developers to preview. To access the API, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header:", "```", "application/vnd.github.giant-sentry-fist-preview+json", "```", "", "**Warning:** The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact [GitHub support](https://github.com/contact).", "", "# [User Emails](https://developer.github.com/v3/users/emails/)", "", "Management of email addresses via the API requires that you are authenticated through basic auth or OAuth with the user scope.", "", "# [User Followers](https://developer.github.com/v3/users/followers/)", "", "no description", "", "# [User GPG Keys](https://developer.github.com/v3/users/gpg_keys/)", "", "The data returned in the ```public_key``` response field is not a GPG formatted key. When a user uploads a GPG key, it is parsed and the cryptographic public key is extracted and stored. This cryptographic key is what is returned by the APIs on this page. This key is not suitable to be used directly by programs like GPG.", "", "# [User Public Keys](https://developer.github.com/v3/users/keys/)", "", "no description" ] } } }