{ "basePath": "/", "definitions": { "github-activity.notifications-threads-{id}-subscription.put.body": { "properties": { "ignored": { "type": "boolean", "x-swgg-descriptionLineList": [ "Determines if all notifications should be blocked from this thread\n" ] }, "subscribed": { "type": "boolean", "x-swgg-descriptionLineList": [ "Determines if notifications should be received from this thread\n" ] } }, "x-swgg-tags0": "github-activity" }, "github-activity.repos-{owner}-{repo}-subscription.put.body": { "properties": { "ignored": { "type": "boolean", "x-swgg-descriptionLineList": [ "Determines if all notifications should be blocked from this repository.\n" ] }, "subscribed": { "type": "boolean", "x-swgg-descriptionLineList": [ "Determines if notifications should be received from this repository.\n" ] } }, "x-swgg-tags0": "github-activity" }, "github-enterprise.admin-hooks-{id}.patch.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```.\n" ] }, "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/enterprise-admin/global_webhooks/#update-hook-config-params).\n" ] }, "events": { "default": [ "organization" ], "items": { "type": "string" }, "type": "array", "x-swgg-descriptionLineList": [ "The [events](https://developer.github.com/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by ```user``` and ```organization``` events. Default: ```user``` and ```organization```.\n" ] } }, "required": [ "config" ], "x-swgg-tags0": "github-enterprise" }, "github-enterprise.admin-hooks.post.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```.\n" ] }, "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/enterprise-admin/global_webhooks/#create-hook-config-params).\n" ] }, "events": { "default": [ "organization" ], "items": { "type": "string" }, "type": "array", "x-swgg-descriptionLineList": [ "The [events](https://developer.github.com/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by ```user``` and ```organization``` events. Default: ```user``` and ```organization```.\n" ] }, "name": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. Must be passed as \"web\".\n" ] } }, "required": [ "name", "config" ], "x-swgg-tags0": "github-enterprise" }, "github-enterprise.admin-organizations-{org}.patch.body": { "properties": { "login": { "type": "string", "x-swgg-descriptionLineList": [ "**Required.** The organization's new name.\n" ] } }, "x-swgg-tags0": "github-enterprise" }, "github-enterprise.admin-organizations.post.body": { "properties": { "admin": { "type": "string", "x-swgg-descriptionLineList": [ "**Required.** The login of the user who will manage this organization.\n" ] }, "login": { "type": "string", "x-swgg-descriptionLineList": [ "**Required.** The organization's username.\n" ] }, "profile_name": { "type": "string", "x-swgg-descriptionLineList": [ "The organization's display name.\n" ] } }, "x-swgg-tags0": "github-enterprise" }, "github-enterprise.admin-pre-receive-environments-{id}.patch.body": { "properties": { "image_url": { "type": "string", "x-swgg-descriptionLineList": [ "URL from which to download a tarball of this environment.\n" ] }, "name": { "type": "string", "x-swgg-descriptionLineList": [ "This pre-receive environment's new name.\n" ] } }, "x-swgg-tags0": "github-enterprise" }, "github-enterprise.admin-pre-receive-environments.post.body": { "properties": { "image_url": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. URL from which to download a tarball of this environment.\n" ] }, "name": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The new pre-receive environment's name.\n" ] } }, "required": [ "name", "image_url" ], "x-swgg-tags0": "github-enterprise" }, "github-enterprise.admin-pre-receive-hooks.post.body": { "properties": { "environment": { "type": "object", "x-swgg-descriptionLineList": [ "**Required** The pre-receive environment where the script is executed.\n" ] }, "name": { "type": "string", "x-swgg-descriptionLineList": [ "**Required** The name of the hook.\n" ] }, "script": { "type": "string", "x-swgg-descriptionLineList": [ "**Required** The script that the hook runs.\n" ] }, "script_repository": { "type": "object", "x-swgg-descriptionLineList": [ "**Required** The GitHub repository where the script is kept.\n" ] } }, "required": [ "name", "script", "script_repository", "environment" ], "x-swgg-tags0": "github-enterprise" }, "github-enterprise.setup-api-maintenance.post.body": { "properties": { "maintenance": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. A JSON string with the attributes ```enabled``` and ```when```.\n" ] } }, "required": [ "maintenance" ], "x-swgg-tags0": "github-enterprise" }, "github-enterprise.setup-api-settings-authorized-keys.post.body": { "properties": { "authorized_key": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The path to the public SSH key.\n" ] } }, "required": [ "authorized_key" ], "x-swgg-tags0": "github-enterprise" }, "github-enterprise.setup-api-settings.put.body": { "properties": { "settings": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify.\n" ] } }, "required": [ "settings" ], "x-swgg-tags0": "github-enterprise" }, "github-enterprise.setup-api-start.post.body": { "properties": { "license": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The content of your .ghl license file.\n" ] }, "password": { "type": "string", "x-swgg-descriptionLineList": [ "You **must** provide a password only if you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.\n" ] }, "settings": { "type": "string", "x-swgg-descriptionLineList": [ "An optional JSON string containing the installation settings.\n" ] } }, "required": [ "license" ], "x-swgg-tags0": "github-enterprise" }, "github-enterprise.setup-api-upgrade.post.body": { "properties": { "license": { "type": "string", "x-swgg-descriptionLineList": [ "The content of your new .ghl license file.\n" ] } }, "x-swgg-tags0": "github-enterprise" }, "github-enterprise.staff-indexing_jobs.post.body": { "properties": { "target": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. A string representing the item to index.\n" ] } }, "required": [ "target" ], "x-swgg-tags0": "github-enterprise" }, "github-gists.gists-{gist_id}-comments-{id}.patch.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The comment text.\n" ] } }, "required": [ "body" ], "x-swgg-tags0": "github-gists" }, "github-gists.gists-{gist_id}-comments.post.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The comment text.\n" ] } }, "required": [ "body" ], "x-swgg-tags0": "github-gists" }, "github-gists.gists-{id}.patch.body": { "properties": { "content": { "type": "string", "x-swgg-descriptionLineList": [ "Updated file contents.\n" ] }, "description": { "type": "string", "x-swgg-descriptionLineList": [ "A description of the gist.\n" ] }, "filename": { "type": "string", "x-swgg-descriptionLineList": [ "New name for this file.\n" ] }, "files": { "type": "object", "x-swgg-descriptionLineList": [ "Files that make up this gist.\n" ] } }, "x-swgg-tags0": "github-gists" }, "github-gists.gists.post.body": { "properties": { "description": { "type": "string", "x-swgg-descriptionLineList": [ "A description of the gist.\n" ] }, "files": { "type": "object", "x-swgg-descriptionLineList": [ "**Required**. Files that make up this gist.\n" ] } }, "required": [ "files" ], "x-swgg-tags0": "github-gists" }, "github-git.repos-{owner}-{repo}-git-blobs.post.body": { "properties": { "content": { "default": "Content of the blob", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The new blob's content.\n" ] }, "encoding": { "default": "utf-8", "type": "string", "x-swgg-descriptionLineList": [ "The encoding used for ```content```. Currently, ```\"utf-8\"``` and ```\"base64\"``` are supported. Default: ```\"utf-8\"```.\n" ] } }, "required": [ "content" ], "x-swgg-tags0": "github-git" }, "github-git.repos-{owner}-{repo}-git-commits.post.body": { "properties": { "message": { "default": "my commit message", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The commit message\n" ] }, "tree": { "default": "827efc6d56897b048c772eb4087f854f46256132", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The SHA of the tree object this commit points to\n" ] } }, "required": [ "message", "tree" ], "x-swgg-tags0": "github-git" }, "github-git.repos-{owner}-{repo}-git-tags.post.body": { "properties": { "message": { "default": "initial version\n", "type": "string", "x-swgg-descriptionLineList": [ "The tag message\n" ] }, "object": { "default": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", "type": "string", "x-swgg-descriptionLineList": [ "The SHA of the git object this is tagging\n" ] }, "tag": { "default": "v0.0.1", "type": "string", "x-swgg-descriptionLineList": [ "The tag\n" ] }, "tagger": { "default": { "date": "2011-06-17T14:53:35-07:00", "email": "schacon@gmail.com", "name": "Scott Chacon" }, "type": "object", "x-swgg-descriptionLineList": [ "An object with information about the individual creating the tag.\n" ] } }, "x-swgg-tags0": "github-git" }, "github-git.repos-{owner}-{repo}-git-trees.post.body": { "properties": { "base_tree": { "type": "string", "x-swgg-descriptionLineList": [ "The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.\n" ] } }, "x-swgg-tags0": "github-git" }, "github-issues.repos-{owner}-{repo}-issues-comments-{id}.patch.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The contents of the comment.\n" ] } }, "required": [ "body" ], "x-swgg-tags0": "github-issues" }, "github-issues.repos-{owner}-{repo}-issues-{number}-comments.post.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The contents of the comment.\n" ] } }, "required": [ "body" ], "x-swgg-tags0": "github-issues" }, "github-issues.repos-{owner}-{repo}-issues-{number}.patch.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "The contents of the issue.\n" ] }, "state": { "type": "string", "x-swgg-descriptionLineList": [ "State of the issue. Either ```open``` or ```closed```.\n" ] }, "title": { "type": "string", "x-swgg-descriptionLineList": [ "The title of the issue.\n" ] } }, "x-swgg-tags0": "github-issues" }, "github-issues.repos-{owner}-{repo}-issues.post.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "The contents of the issue.\n" ] }, "title": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The title of the issue.\n" ] } }, "required": [ "title" ], "x-swgg-tags0": "github-issues" }, "github-issues.repos-{owner}-{repo}-labels-{name}.patch.body": { "properties": { "color": { "type": "string", "x-swgg-descriptionLineList": [ "A 6 character hex code, without the leading ```#```, identifying the color.\n" ] } }, "x-swgg-tags0": "github-issues" }, "github-issues.repos-{owner}-{repo}-labels.post.body": { "properties": { "color": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. A 6 character hex code, without the leading ```#```, identifying the color.\n" ] } }, "required": [ "color" ], "x-swgg-tags0": "github-issues" }, "github-issues.repos-{owner}-{repo}-milestones-{number}.patch.body": { "properties": { "description": { "type": "string", "x-swgg-descriptionLineList": [ "A description of the milestone.\n" ] }, "due_on": { "type": "string", "x-swgg-descriptionLineList": [ "The milestone due date. This is a timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```.\n" ] }, "title": { "type": "string", "x-swgg-descriptionLineList": [ "The title of the milestone.\n" ] } }, "x-swgg-tags0": "github-issues" }, "github-issues.repos-{owner}-{repo}-milestones.post.body": { "properties": { "description": { "type": "string", "x-swgg-descriptionLineList": [ "A description of the milestone.\n" ] }, "due_on": { "type": "string", "x-swgg-descriptionLineList": [ "The milestone due date. This is a timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```.\n" ] }, "title": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The title of the milestone.\n" ] } }, "required": [ "title" ], "x-swgg-tags0": "github-issues" }, "github-migration.orgs-{org}-migrations.post.body": { "properties": { "exclude_attachments": { "default": false, "type": "boolean", "x-swgg-descriptionLineList": [ "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). Default: ```false```.\n" ] }, "lock_repositories": { "default": false, "type": "boolean", "x-swgg-descriptionLineList": [ "Indicates whether repositories should be locked (to prevent manipulation) while migrating data. Default: ```false```.\n" ] } }, "x-swgg-tags0": "github-migration" }, "github-migration.repos-{owner}-{repo}-import-authors-{author_id}.patch.body": { "properties": { "email": { "type": "string", "x-swgg-descriptionLineList": [ "The new Git author email.\n" ] } }, "x-swgg-tags0": "github-migration" }, "github-migration.repos-{owner}-{repo}-import-lfs.patch.body": { "properties": { "use_lfs": { "type": "string", "x-swgg-descriptionLineList": [ "**Required** Can be one of ```opt_in``` (large files will be stored using Git LFS) or ```opt_out``` (large files will be removed during the import).\n" ] } }, "required": [ "use_lfs" ], "x-swgg-tags0": "github-migration" }, "github-migration.repos-{owner}-{repo}-import.patch.body": { "properties": { "vcs_password": { "type": "string", "x-swgg-descriptionLineList": [ "The password to provide to the originating repository.\n" ] }, "vcs_username": { "type": "string", "x-swgg-descriptionLineList": [ "The username to provide to the originating repository.\n" ] } }, "x-swgg-tags0": "github-migration" }, "github-migration.repos-{owner}-{repo}-import.put.body": { "properties": { "tfvc_project": { "type": "string", "x-swgg-descriptionLineList": [ "For a tfvc import, the name of the project that is being imported.\n" ] }, "vcs": { "type": "string", "x-swgg-descriptionLineList": [ "The originating VCS type. Can be one of ```subversion```, ```git```, ```mercurial```, or ```tfvc```. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.\n" ] }, "vcs_password": { "type": "string", "x-swgg-descriptionLineList": [ "If authentication is required, the password to provide to ```vcs_url```.\n" ] }, "vcs_url": { "type": "string", "x-swgg-descriptionLineList": [ "**Required** The URL of the originating repository.\n" ] }, "vcs_username": { "type": "string", "x-swgg-descriptionLineList": [ "If authentication is required, the username to provide to ```vcs_url```.\n" ] } }, "required": [ "vcs_url" ], "x-swgg-tags0": "github-migration" }, "github-misc.markdown.post.body": { "properties": { "context": { "type": "string", "x-swgg-descriptionLineList": [ "The repository context to use when creating references in ```gfm``` mode. Omit this parameter when using ```markdown``` mode.\n" ] }, "text": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The Markdown text to render in HTML. Markdown content must be 400 KB or less.\n" ] } }, "required": [ "text" ], "x-swgg-tags0": "github-misc" }, "github-orgs.orgs-{org}-hooks-{id}.patch.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```.\n" ] }, "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/orgs/hooks/#update-hook-config-params).\n" ] }, "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\"]```.\n" ] } }, "required": [ "config" ], "x-swgg-tags0": "github-orgs" }, "github-orgs.orgs-{org}-hooks.post.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```.\n" ] }, "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/orgs/hooks/#create-hook-config-params).\n" ] }, "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\"]```.\n" ] } }, "required": [ "config" ], "x-swgg-tags0": "github-orgs" }, "github-orgs.orgs-{org}-invitations.post.body": { "properties": { "email": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. Email address of the person you are inviting, which can be an existing GitHub user. Not required if you provide ```invitee_id```.\n" ] }, "invitee_id": { "type": "integer", "x-swgg-descriptionLineList": [ "**Required**. GitHub user ID for the person you are inviting. Not required if you provide ```email```.\n" ] }, "role": { "type": "string", "x-swgg-descriptionLineList": [ "Specify role for new member. Can be one of: * ```admin``` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. * ```direct_member``` - Non-owner organization members with ability to see other members and join teams by invitation. * ```billing_manager``` - Non-owner organization members with ability to manage the billing settings of your organization. Default: ```direct_member```.\n" ] }, "team_ids": { "default": [ null ], "items": { "type": "string" }, "type": "array", "x-swgg-descriptionLineList": [ "Specify IDs for the teams you want to invite new members to.\n" ] } }, "required": [ "invitee_id", "email" ], "x-swgg-tags0": "github-orgs" }, "github-orgs.orgs-{org}-teams.post.body": { "properties": { "description": { "type": "string", "x-swgg-descriptionLineList": [ "The description of the team.\n" ] }, "parent_team_id": { "type": "integer", "x-swgg-descriptionLineList": [ "The ID of a team to set as the parent team. **Note**: You must pass the ```hellcat-preview``` media type to use this parameter.\n" ] } }, "x-swgg-tags0": "github-orgs" }, "github-orgs.orgs-{org}.patch.body": { "properties": { "billing_email": { "type": "string", "x-swgg-descriptionLineList": [ "Billing email address. This address is not publicized.\n" ] }, "company": { "type": "string", "x-swgg-descriptionLineList": [ "The company name.\n" ] }, "description": { "type": "string", "x-swgg-descriptionLineList": [ "The description of the company.\n" ] }, "email": { "type": "string", "x-swgg-descriptionLineList": [ "The publicly visible email address.\n" ] }, "has_organization_projects": { "type": "boolean", "x-swgg-descriptionLineList": [ "Toggles whether organization projects are enabled for the organization.\n" ] }, "has_repository_projects": { "type": "boolean", "x-swgg-descriptionLineList": [ "Toggles whether repository projects are enabled for repositories that belong to the organization.\n" ] }, "location": { "type": "string", "x-swgg-descriptionLineList": [ "The location.\n" ] } }, "x-swgg-tags0": "github-orgs" }, "github-orgs.teams-{id}-repos-{org}-{repo}.put.body": { "properties": { "permission": { "type": "string", "x-swgg-descriptionLineList": [ "The permission to grant the team on this repository. Can be one of: * ```pull``` - team members can pull, but not push to or administer this repository. * ```push``` - team members can pull and push, but not administer this repository. * ```admin``` - team members can pull, push and administer this repository.If no permission is specified, the team's ```permission``` attribute will be used to determine what permission to grant the team on this repository.**Note**: If you pass the ```hellcat-preview``` media type, you can promote—but not demote—a ```permission``` attribute inherited through a parent team.\n" ] } }, "x-swgg-tags0": "github-orgs" }, "github-orgs.teams-{id}.patch.body": { "properties": { "description": { "type": "string", "x-swgg-descriptionLineList": [ "The description of the team.\n" ] }, "parent_team_id": { "type": "integer", "x-swgg-descriptionLineList": [ "The ID of a team to set as the parent team. **Note**: You must pass the ```hellcat-preview``` media type to use this parameter.\n" ] } }, "x-swgg-tags0": "github-orgs" }, "github-orgs.user-memberships-orgs-{org}.patch.body": { "properties": { "state": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The state that the membership should be in. Only ```\"active\"``` will be accepted.\n" ] } }, "required": [ "state" ], "x-swgg-tags0": "github-orgs" }, "github-projects.orgs-{org}-projects.post.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "The body of the project.\n" ] } }, "x-swgg-tags0": "github-projects" }, "github-projects.projects-columns-cards-{card_id}-moves.post.body": { "properties": { "position": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. Can be one of ```top```, ```bottom```, or ```after:<card_id>```, where ```<card_id>``` is the ```id``` value of a card in the same column, or in the new column specified by ```column_id```.\n" ] } }, "required": [ "position" ], "x-swgg-tags0": "github-projects" }, "github-projects.projects-columns-cards-{card_id}.patch.body": { "properties": { "note": { "type": "string", "x-swgg-descriptionLineList": [ "The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a ```content_id``` and ```content_type```.\n" ] } }, "x-swgg-tags0": "github-projects" }, "github-projects.projects-columns-{column_id}-cards.post.body": { "properties": { "content_id": { "type": "integer", "x-swgg-descriptionLineList": [ "The id of the issue to associate with this card.\n" ] }, "content_type": { "type": "string", "x-swgg-descriptionLineList": [ "**Required if you specify a content_id**. The type of content to associate with this card. Can only be \"Issue\" at this time.\n" ] }, "note": { "type": "string", "x-swgg-descriptionLineList": [ "The card's note content. Only valid for cards without another type of content, so this must be omitted if ```content_id``` and ```content_type``` are specified.\n" ] } }, "x-swgg-tags0": "github-projects" }, "github-projects.projects-columns-{column_id}-moves.post.body": { "properties": { "position": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. Can be one of ```first```, ```last```, or ```after:<column_id>```, where ```<column_id>``` is the ```id``` value of a column in the same project.\n" ] } }, "required": [ "position" ], "x-swgg-tags0": "github-projects" }, "github-projects.projects-{project_id}.patch.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "The body of the project.\n" ] }, "state": { "type": "string", "x-swgg-descriptionLineList": [ "State of the project. Either ```open``` or ```closed```.\n" ] } }, "x-swgg-tags0": "github-projects" }, "github-projects.repos-{owner}-{repo}-projects.post.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "The body of the project.\n" ] } }, "x-swgg-tags0": "github-projects" }, "github-pulls.repos-{owner}-{repo}-pulls-comments-{id}.patch.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The text of the comment.\n" ] } }, "required": [ "body" ], "x-swgg-tags0": "github-pulls" }, "github-pulls.repos-{owner}-{repo}-pulls-{number}-comments.post.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The text of the comment.\n" ] }, "commit_id": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the ```position```.\n" ] }, "path": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The relative path to the file that necessitates a comment.\n" ] }, "position": { "type": "integer", "x-swgg-descriptionLineList": [ "**Required**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.\n" ] } }, "required": [ "body", "commit_id", "path", "position" ], "x-swgg-tags0": "github-pulls" }, "github-pulls.repos-{owner}-{repo}-pulls-{number}-merge.put.body": { "properties": { "commit_message": { "type": "string", "x-swgg-descriptionLineList": [ "Extra detail to append to automatic commit message.\n" ] }, "commit_title": { "type": "string", "x-swgg-descriptionLineList": [ "Title for the automatic commit message.\n" ] }, "merge_method": { "type": "string", "x-swgg-descriptionLineList": [ "Merge method to use. Possible values are ```merge```, ```squash``` or ```rebase```. Default is ```merge```.\n" ] } }, "x-swgg-tags0": "github-pulls" }, "github-pulls.repos-{owner}-{repo}-pulls-{number}-reviews-{id}-dismissals.put.body": { "properties": { "message": { "type": "string", "x-swgg-descriptionLineList": [ "**Required.** The message for the pull request review dismissal\n" ] } }, "x-swgg-tags0": "github-pulls" }, "github-pulls.repos-{owner}-{repo}-pulls-{number}-reviews-{id}-events.post.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "The body text of the pull request review\n" ] }, "event": { "type": "string", "x-swgg-descriptionLineList": [ "**Required.** The review action you want to perform. The review actions include: ```APPROVE```, ```REQUEST_CHANGES```, or ```COMMENT```. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to ```PENDING```, which means you will need to re-submit the pull request review using a review action.\n" ] } }, "x-swgg-tags0": "github-pulls" }, "github-pulls.repos-{owner}-{repo}-pulls-{number}-reviews.post.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "**Required** when using ```REQUEST_CHANGES``` or ```COMMENT``` for the ```event``` parameter. The body text of the pull request review.\n" ] }, "commit_id": { "type": "string", "x-swgg-descriptionLineList": [ "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the ```position```. Defaults to the most recent commit in the pull request when you do not specify a value.\n" ] }, "event": { "type": "string", "x-swgg-descriptionLineList": [ "The review action you want to perform. The review actions include: ```APPROVE```, ```REQUEST_CHANGES```, or ```COMMENT```. By leaving this blank, you set the review action state to ```PENDING```, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.\n" ] } }, "required": [ "body" ], "x-swgg-tags0": "github-pulls" }, "github-pulls.repos-{owner}-{repo}-pulls-{number}.patch.body": { "properties": { "base": { "type": "string", "x-swgg-descriptionLineList": [ "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.\n" ] }, "body": { "type": "string", "x-swgg-descriptionLineList": [ "The contents of the pull request.\n" ] }, "maintainer_can_modify": { "type": "boolean", "x-swgg-descriptionLineList": [ "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.\n" ] }, "state": { "type": "string", "x-swgg-descriptionLineList": [ "State of this Pull Request. Either ```open``` or ```closed```.\n" ] }, "title": { "type": "string", "x-swgg-descriptionLineList": [ "The title of the pull request.\n" ] } }, "x-swgg-tags0": "github-pulls" }, "github-pulls.repos-{owner}-{repo}-pulls.post.body": { "properties": { "base": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.\n" ] }, "body": { "type": "string", "x-swgg-descriptionLineList": [ "The contents of the pull request.\n" ] }, "head": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace ```head``` with a user like this: ```username:branch```.\n" ] }, "maintainer_can_modify": { "type": "boolean", "x-swgg-descriptionLineList": [ "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.\n" ] }, "title": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The title of the pull request.\n" ] } }, "required": [ "title", "head", "base" ], "x-swgg-tags0": "github-pulls" }, "github-reactions.repos-{owner}-{repo}-comments-{id}-reactions.post.body": { "properties": { "content": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The reaction type\n" ] } }, "required": [ "content" ], "x-swgg-tags0": "github-reactions" }, "github-reactions.repos-{owner}-{repo}-issues-comments-{id}-reactions.post.body": { "properties": { "content": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The reaction type\n" ] } }, "required": [ "content" ], "x-swgg-tags0": "github-reactions" }, "github-reactions.repos-{owner}-{repo}-issues-{number}-reactions.post.body": { "properties": { "content": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The reaction type\n" ] } }, "required": [ "content" ], "x-swgg-tags0": "github-reactions" }, "github-reactions.repos-{owner}-{repo}-pulls-comments-{id}-reactions.post.body": { "properties": { "content": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The reaction type\n" ] } }, "required": [ "content" ], "x-swgg-tags0": "github-reactions" }, "github-repos.repos-{owner}-{repo}-branches-{branch}-protection-required_pull_request_reviews.patch.body": { "properties": { "dismiss_stale_reviews": { "type": "boolean", "x-swgg-descriptionLineList": [ "Dismiss approved reviews automatically when a new commit is pushed.\n" ] }, "dismissal_restrictions": { "type": "object", "x-swgg-descriptionLineList": [ "Specify which users and teams can dismiss pull request reviews. User and team ```dismissal_restrictions``` are only available for organization-owned repositories. Omit this parameter for personal repositories.\n" ] }, "require_code_owner_reviews": { "type": "boolean", "x-swgg-descriptionLineList": [ "Blocks merge until code owners have reviewed.\n" ] } }, "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-branches-{branch}-protection-required_status_checks.patch.body": { "properties": { "contexts": { "default": [ null ], "items": { "type": "string" }, "type": "array", "x-swgg-descriptionLineList": [ "The list of status checks to require in order to merge into this branch\n" ] }, "strict": { "type": "boolean", "x-swgg-descriptionLineList": [ "Require branches to be up to date before merging.\n" ] } }, "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-branches-{branch}-protection.put.body": { "properties": { "enforce_admins": { "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.\n" ] }, "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.\n" ] }, "required_status_checks": { "type": "object", "x-swgg-descriptionLineList": [ "**Required**. Require status checks to pass before merging. Set to ```null``` to disable.\n" ] }, "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.\n" ] } }, "required": [ "required_status_checks", "enforce_admins", "required_pull_request_reviews", "restrictions" ], "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-comments-{id}.patch.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The contents of the comment\n" ] } }, "required": [ "body" ], "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-commits-{sha}-comments.post.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The contents of the comment.\n" ] }, "line": { "type": "integer", "x-swgg-descriptionLineList": [ "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.\n" ] }, "path": { "type": "string", "x-swgg-descriptionLineList": [ "Relative path of the file to comment on.\n" ] }, "position": { "type": "integer", "x-swgg-descriptionLineList": [ "Line index in the diff to comment on.\n" ] } }, "required": [ "body" ], "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-contents-{path}#2.put.body": { "properties": { "content": { "default": "bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The updated file content, Base64 encoded.\n" ] }, "message": { "default": "my commit message", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The commit message.\n" ] } }, "required": [ "message", "content" ], "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-contents-{path}.put.body": { "properties": { "content": { "default": "bXkgbmV3IGZpbGUgY29udGVudHM=", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The new file content, Base64 encoded.\n" ] }, "message": { "default": "my commit message", "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The commit message.\n" ] } }, "required": [ "message", "content" ], "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-deployments.post.body": { "properties": { "required_contexts": { "default": [ null ], "items": { "type": "string" }, "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.\n" ] } }, "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-forks.post.body": { "properties": { "organization": { "type": "string", "x-swgg-descriptionLineList": [ "Optional parameter to specify the organization name if forking into an organization.\n" ] } }, "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-hooks-{id}.patch.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```.\n" ] }, "add_events": { "default": [ null ], "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.\n" ] }, "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).\n" ] }, "remove_events": { "default": [ null ], "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.\n" ] } }, "required": [ "config" ], "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-hooks.post.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```.\n" ] }, "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).\n" ] } }, "required": [ "config" ], "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-invitations-{invitation_id}.patch.body": { "properties": { "permissions": { "type": "string", "x-swgg-descriptionLineList": [ "The permissions that the associated user will have on the repository. Valid values are ```read```, ```write```, and ```admin```.\n" ] } }, "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-keys.post.body": { "properties": { "read_only": { "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.\n" ] }, "title": { "type": "string", "x-swgg-descriptionLineList": [ "A name for the key.\n" ] } }, "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-merges.post.body": { "properties": { "commit_message": { "type": "string", "x-swgg-descriptionLineList": [ "Commit message to use for the merge commit. If omitted, a default message will be used.\n" ] } }, "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-releases-assets-{id}.patch.body": { "properties": { "label": { "type": "string", "x-swgg-descriptionLineList": [ "An alternate short description of the asset. Used in place of the filename.\n" ] } }, "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-releases-{id}.patch.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "Text describing the contents of the tag.\n" ] }, "draft": { "type": "boolean", "x-swgg-descriptionLineList": [ "```true``` makes the release a draft, and ```false``` publishes the release.\n" ] }, "prerelease": { "type": "boolean", "x-swgg-descriptionLineList": [ "```true``` to identify the release as a prerelease, ```false``` to identify the release as a full release.\n" ] }, "tag_name": { "type": "string", "x-swgg-descriptionLineList": [ "The name of the tag.\n" ] }, "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```).\n" ] } }, "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-releases.post.body": { "properties": { "body": { "type": "string", "x-swgg-descriptionLineList": [ "Text describing the contents of the tag.\n" ] }, "tag_name": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The name of the tag.\n" ] }, "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```).\n" ] } }, "required": [ "tag_name" ], "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-statuses-{sha}.post.body": { "properties": { "description": { "type": "string", "x-swgg-descriptionLineList": [ "A short description of the status.\n" ] }, "state": { "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The state of the status. Can be one of ```error```, ```failure```, ```pending```, or ```success```.\n" ] } }, "required": [ "state" ], "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}-transfer.post.body": { "properties": { "new_owner": { "type": "string", "x-swgg-descriptionLineList": [ "**Required:** The username or organization name the repository will be transferred to.\n" ] } }, "x-swgg-tags0": "github-repos" }, "github-repos.repos-{owner}-{repo}.patch.body": { "properties": { "default_branch": { "type": "string", "x-swgg-descriptionLineList": [ "Updates the default branch for this repository.\n" ] }, "description": { "type": "string", "x-swgg-descriptionLineList": [ "A short description of the repository.\n" ] }, "has_issues": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to enable issues for this repository or ```false``` to disable them. Default: ```true```.\n" ] }, "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.\n" ] }, "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```.\n" ] }, "homepage": { "type": "string", "x-swgg-descriptionLineList": [ "A URL with more information about the repository.\n" ] }, "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.\n" ] } }, "x-swgg-tags0": "github-repos" }, "github-repos.upload_url-repos-{owner}-{repo}-releases-{id}-assets.post.body": { "properties": { "Content-Type": { "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).\n" ] }, "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.\n" ] } }, "required": [ "Content-Type" ], "x-swgg-tags0": "github-repos" }, "github-repos.user-repos.post.body": { "properties": { "auto_init": { "default": false, "type": "boolean", "x-swgg-descriptionLineList": [ "Pass ```true``` to create an initial commit with empty README. Default: ```false```.\n" ] }, "description": { "type": "string", "x-swgg-descriptionLineList": [ "A short description of the repository.\n" ] }, "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\".\n" ] }, "has_issues": { "default": true, "type": "boolean", "x-swgg-descriptionLineList": [ "Either ```true``` to enable issues for this repository or ```false``` to disable them. Default: ```true```.\n" ] }, "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.\n" ] }, "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```.\n" ] }, "homepage": { "type": "string", "x-swgg-descriptionLineList": [ "A URL with more information about the repository.\n" ] }, "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\".\n" ] }, "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```.\n" ] } }, "x-swgg-tags0": "github-repos" }, "github-users.user.patch.body": { "properties": { "bio": { "type": "string", "x-swgg-descriptionLineList": [ "The new short biography of the user.\n" ] }, "blog": { "type": "string", "x-swgg-descriptionLineList": [ "The new blog URL of the user.\n" ] }, "company": { "type": "string", "x-swgg-descriptionLineList": [ "The new company of the user.\n" ] }, "hireable": { "type": "boolean", "x-swgg-descriptionLineList": [ "The new hiring availability of the user.\n" ] }, "location": { "type": "string", "x-swgg-descriptionLineList": [ "The new location of the user.\n" ] } }, "x-swgg-tags0": "github-users" } }, "info": { "description": "this zero-dependency package will provide a swagger-client for github-all's web-apis, with a working web-demo", "title": "swgg-github-all", "version": "2018.2.2", "x-swgg-downloadStandaloneApp": "https://kaizhu256.github.io/node-swgg-github-all/build..beta..travis-ci.org/app/assets.app.js", "x-swgg-homepage": "https://github.com/kaizhu256/node-swgg-github-all" }, "parameters": { "github-all.key": { "default": "xxxxxxxx", "in": "query", "name": "access_token", "type": "string", "x-swgg-apiKey": true, "x-swgg-descriptionLineList": [ "OAuth2 token (sent as a parameter)\n", "https://developer.github.com/v3/#authentication\n" ] }, "github-all.user-agent": { "default": "Awesome-Octocat-App", "in": "header", "name": "user-agent", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "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.\n", "https://developer.github.com/v3/index.html#user-agent-required\n" ] } }, "paths": { "/admin/hooks": { "get": { "operationId": "_2Fadmin_2Fhooks_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.superpro-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Global Webhooks - List global hooks.\n", "**Note:** The [Global Webhooks API](https://developer.github.com/v3/enterprise-admin/global_webhooks/) is currently available for developers to preview. 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.superpro-preview+json ```\n", "**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).\n", "https://developer.github.com/v3/enterprise-admin/global_webhooks/#list-global-hooks\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Global Webhooks - List global hooks.\n", "x-swgg-tags0": "github-enterprise" }, "post": { "operationId": "_2Fadmin_2Fhooks_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.superpro-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-enterprise.admin-hooks.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Global Webhooks - Create a global hook.\n", "**Note:** The [Global Webhooks API](https://developer.github.com/v3/enterprise-admin/global_webhooks/) is currently available for developers to preview. 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.superpro-preview+json ```\n", "**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).\n", "https://developer.github.com/v3/enterprise-admin/global_webhooks/#create-a-global-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Global Webhooks - Create a global hook.\n", "x-swgg-tags0": "github-enterprise" } }, "/admin/hooks/{id}": { "delete": { "operationId": "_2Fadmin_2Fhooks_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.superpro-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Global Webhooks - Delete a global hook.\n", "**Note:** The [Global Webhooks API](https://developer.github.com/v3/enterprise-admin/global_webhooks/) is currently available for developers to preview. 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.superpro-preview+json ```\n", "**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).\n", "https://developer.github.com/v3/enterprise-admin/global_webhooks/#delete-a-global-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Global Webhooks - Delete a global hook.\n", "x-swgg-tags0": "github-enterprise" }, "get": { "operationId": "_2Fadmin_2Fhooks_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.superpro-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Global Webhooks - Get single global hook.\n", "**Note:** The [Global Webhooks API](https://developer.github.com/v3/enterprise-admin/global_webhooks/) is currently available for developers to preview. 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.superpro-preview+json ```\n", "**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).\n", "https://developer.github.com/v3/enterprise-admin/global_webhooks/#get-single-global-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Global Webhooks - Get single global hook.\n", "x-swgg-tags0": "github-enterprise" }, "patch": { "operationId": "_2Fadmin_2Fhooks_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.superpro-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-enterprise.admin-hooks-{id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Global Webhooks - Edit a global hook.\n", "**Note:** The [Global Webhooks API](https://developer.github.com/v3/enterprise-admin/global_webhooks/) is currently available for developers to preview. 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.superpro-preview+json ```\n", "**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).\n", "Parameters that are not provided will be overwritten with the default value or removed if no default exists.\n", "https://developer.github.com/v3/enterprise-admin/global_webhooks/#edit-a-global-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Global Webhooks - Edit a global hook.\n", "x-swgg-tags0": "github-enterprise" } }, "/admin/hooks/{id}/pings": { "post": { "operationId": "_2Fadmin_2Fhooks_2F_7Bid_7D_2Fpings_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.superpro-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Global Webhooks - Ping a global hook.\n", "**Note:** The [Global Webhooks API](https://developer.github.com/v3/enterprise-admin/global_webhooks/) is currently available for developers to preview. 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.superpro-preview+json ```\n", "**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).\n", "This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook.\n", "https://developer.github.com/v3/enterprise-admin/global_webhooks/#ping-a-global-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Global Webhooks - Ping a global hook.\n", "x-swgg-tags0": "github-enterprise" } }, "/admin/ldap/teams/{team_id}/mapping": { "patch": { "operationId": "_2Fadmin_2Fldap_2Fteams_2F_7Bteam_id_7D_2Fmapping_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "team_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "LDAP - Update LDAP mapping for a team.\n", "**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 ```\n", "**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).\n", "https://developer.github.com/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-team\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "LDAP - Update LDAP mapping for a team.\n", "x-swgg-tags0": "github-enterprise" } }, "/admin/ldap/teams/{team_id}/sync": { "post": { "operationId": "_2Fadmin_2Fldap_2Fteams_2F_7Bteam_id_7D_2Fsync_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "team_id", "required": true, "type": "string", "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.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "LDAP - Sync LDAP mapping for a team.\n", "Note that this API call does not automatically initiate an LDAP sync. Rather, if a ```201``` is returned, the sync job is queued successfully, and is performed when the instance is ready.\n", "https://developer.github.com/v3/enterprise-admin/ldap/#sync-ldap-mapping-for-a-team\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "LDAP - Sync LDAP mapping for a team.\n", "x-swgg-tags0": "github-enterprise" } }, "/admin/ldap/users/{username}/mapping": { "patch": { "operationId": "_2Fadmin_2Fldap_2Fusers_2F_7Busername_7D_2Fmapping_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "LDAP - Update LDAP mapping for a user.\n", "https://developer.github.com/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "LDAP - Update LDAP mapping for a user.\n", "x-swgg-tags0": "github-enterprise" } }, "/admin/ldap/users/{username}/sync": { "post": { "operationId": "_2Fadmin_2Fldap_2Fusers_2F_7Busername_7D_2Fsync_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "LDAP - Sync LDAP mapping for a user.\n", "Note that this API call does not automatically initiate an LDAP sync. Rather, if a ```201``` is returned, the sync job is queued successfully, and is performed when the instance is ready.\n", "https://developer.github.com/v3/enterprise-admin/ldap/#sync-ldap-mapping-for-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "LDAP - Sync LDAP mapping for a user.\n", "x-swgg-tags0": "github-enterprise" } }, "/admin/organizations": { "post": { "operationId": "_2Fadmin_2Forganizations_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-enterprise.admin-organizations.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Organization Administration - Create an organization.\n", "https://developer.github.com/v3/enterprise-admin/orgs/#create-an-organization\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Administration - Create an organization.\n", "x-swgg-tags0": "github-enterprise" } }, "/admin/organizations/{org}": { "patch": { "operationId": "_2Fadmin_2Forganizations_2F_7Borg_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-enterprise.admin-organizations-{org}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Organization Administration - Rename an organization.\n", "https://developer.github.com/v3/enterprise-admin/orgs/#rename-an-organization\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Administration - Rename an organization.\n", "x-swgg-tags0": "github-enterprise" } }, "/admin/pre-receive-environments": { "get": { "operationId": "_2Fadmin_2Fpre-receive-environments_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Pre-receive Environments - List pre-receive environments.\n", "https://developer.github.com/v3/enterprise-admin/pre_receive_environments/#list-pre-receive-environments\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pre-receive Environments - List pre-receive environments.\n", "x-swgg-tags0": "github-enterprise" }, "post": { "operationId": "_2Fadmin_2Fpre-receive-environments_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-enterprise.admin-pre-receive-environments.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Pre-receive Environments - Create a pre-receive environment.\n", "https://developer.github.com/v3/enterprise-admin/pre_receive_environments/#create-a-pre-receive-environment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pre-receive Environments - Create a pre-receive environment.\n", "x-swgg-tags0": "github-enterprise" } }, "/admin/pre-receive-environments/{id}": { "delete": { "operationId": "_2Fadmin_2Fpre-receive-environments_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Pre-receive Environments - Delete a pre-receive environment.\n", "https://developer.github.com/v3/enterprise-admin/pre_receive_environments/#delete-a-pre-receive-environment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pre-receive Environments - Delete a pre-receive environment.\n", "x-swgg-tags0": "github-enterprise" }, "get": { "operationId": "_2Fadmin_2Fpre-receive-environments_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Pre-receive Environments - Get a single pre-receive environment.\n", "https://developer.github.com/v3/enterprise-admin/pre_receive_environments/#get-a-single-pre-receive-environment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pre-receive Environments - Get a single pre-receive environment.\n", "x-swgg-tags0": "github-enterprise" }, "patch": { "operationId": "_2Fadmin_2Fpre-receive-environments_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-enterprise.admin-pre-receive-environments-{id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Pre-receive Environments - Edit a pre-receive environment.\n", "https://developer.github.com/v3/enterprise-admin/pre_receive_environments/#edit-a-pre-receive-environment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pre-receive Environments - Edit a pre-receive environment.\n", "x-swgg-tags0": "github-enterprise" } }, "/admin/pre-receive-environments/{id}/downloads": { "post": { "operationId": "_2Fadmin_2Fpre-receive-environments_2F_7Bid_7D_2Fdownloads_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Pre-receive Environments - Trigger a pre-receive environment download.\n", "Triggers a new download of the environment tarball from the environment's ```image_url```. When the download is finished, the newly downloaded tarball will overwrite the existing environment.\n", "https://developer.github.com/v3/enterprise-admin/pre_receive_environments/#trigger-a-pre-receive-environment-download\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pre-receive Environments - Trigger a pre-receive environment download.\n", "x-swgg-tags0": "github-enterprise" } }, "/admin/pre-receive-environments/{id}/downloads/latest": { "get": { "operationId": "_2Fadmin_2Fpre-receive-environments_2F_7Bid_7D_2Fdownloads_2Flatest_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "query", "name": "state", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The state of the most recent download.\n" ] }, { "in": "query", "name": "downloaded_at", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The time when the most recent download started.\n" ] }, { "in": "query", "name": "message", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "On failure, this will have any error messages produced.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Pre-receive Environments - Get a pre-receive environment's download status.\n", "In addition to seeing the download status at the ```/admin/pre-receive-environments/:id```, there is also a separate endpoint for just the status.\n", "https://developer.github.com/v3/enterprise-admin/pre_receive_environments/#get-a-pre-receive-environments-download-status\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pre-receive Environments - Get a pre-receive environment's download status.\n", "x-swgg-tags0": "github-enterprise" } }, "/admin/pre-receive-hooks": { "get": { "operationId": "_2Fadmin_2Fpre-receive-hooks_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Pre-receive Hooks - List pre-receive hooks.\n", "https://developer.github.com/v3/enterprise-admin/pre_receive_hooks/#list-pre-receive-hooks\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pre-receive Hooks - List pre-receive hooks.\n", "x-swgg-tags0": "github-enterprise" }, "post": { "operationId": "_2Fadmin_2Fpre-receive-hooks_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-enterprise.admin-pre-receive-hooks.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Pre-receive Hooks - Create a pre-receive hook.\n", "https://developer.github.com/v3/enterprise-admin/pre_receive_hooks/#create-a-pre-receive-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pre-receive Hooks - Create a pre-receive hook.\n", "x-swgg-tags0": "github-enterprise" } }, "/admin/pre-receive-hooks/{id}": { "get": { "operationId": "_2Fadmin_2Fpre-receive-hooks_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Pre-receive Hooks - Get a single pre-receive hook.\n", "https://developer.github.com/v3/enterprise-admin/pre_receive_hooks/#get-a-single-pre-receive-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pre-receive Hooks - Get a single pre-receive hook.\n", "x-swgg-tags0": "github-enterprise" } }, "/admin/pre_receive_hooks/{id}": { "delete": { "operationId": "_2Fadmin_2Fpre_receive_hooks_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Pre-receive Hooks - Delete a pre-receive hook.\n", "https://developer.github.com/v3/enterprise-admin/pre_receive_hooks/#delete-a-pre-receive-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pre-receive Hooks - Delete a pre-receive hook.\n", "x-swgg-tags0": "github-enterprise" }, "patch": { "operationId": "_2Fadmin_2Fpre_receive_hooks_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Pre-receive Hooks - Edit a pre-receive hook.\n", "https://developer.github.com/v3/enterprise-admin/pre_receive_hooks/#edit-a-pre-receive-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pre-receive Hooks - Edit a pre-receive hook.\n", "x-swgg-tags0": "github-enterprise" } }, "/app": { "get": { "operationId": "_2Fapp_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-apps" ], "x-swgg-descriptionLineList": [ "GitHub Apps - Get the authenticated GitHub App.\n", "Returns the GitHub App associated with the [authentication credentials](https://developer.github.com/apps/building-github-apps/authentication-options-for-github-apps#authenticating-as-a-github-app) used.\n", "https://developer.github.com/v3/apps/#get-the-authenticated-github-app\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "GitHub Apps - Get the authenticated GitHub App.\n", "x-swgg-tags0": "github-apps" } }, "/app/installations": { "get": { "operationId": "_2Fapp_2Finstallations_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-apps" ], "x-swgg-descriptionLineList": [ "GitHub Apps - Find installations.\n", "https://developer.github.com/v3/apps/#find-installations\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "GitHub Apps - Find installations.\n", "x-swgg-tags0": "github-apps" } }, "/app/installations/{installation_id}": { "get": { "operationId": "_2Fapp_2Finstallations_2F_7Binstallation_id_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "installation_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-apps" ], "x-swgg-descriptionLineList": [ "GitHub Apps - Get a single installation.\n", "https://developer.github.com/v3/apps/#get-a-single-installation\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "GitHub Apps - Get a single installation.\n", "x-swgg-tags0": "github-apps" } }, "/apps/{app_slug}": { "get": { "operationId": "_2Fapps_2F_7Bapp_slug_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "app_slug", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-apps" ], "x-swgg-descriptionLineList": [ "GitHub Apps - Get a single GitHub App.\n", "**Note**: The ```:app_slug``` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., ```https://github.com/settings/apps/:app_slug```).\n", "https://developer.github.com/v3/apps/#get-a-single-github-app\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "GitHub Apps - Get a single GitHub App.\n", "x-swgg-tags0": "github-apps" } }, "/codes_of_conduct": { "get": { "operationId": "_2Fcodes_of_conduct_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.scarlet-witch-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-misc" ], "x-swgg-descriptionLineList": [ "Codes of Conduct - List all codes of conduct.\n", "https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Codes of Conduct - List all codes of conduct.\n", "x-swgg-tags0": "github-misc" } }, "/codes_of_conduct/{key}": { "get": { "operationId": "_2Fcodes_of_conduct_2F_7Bkey_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.scarlet-witch-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "key", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "The contents of the key.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-misc" ], "x-swgg-descriptionLineList": [ "Codes of Conduct - Get an individual code of conduct.\n", "https://developer.github.com/v3/codes_of_conduct/#get-an-individual-code-of-conduct\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Codes of Conduct - Get an individual code of conduct.\n", "x-swgg-tags0": "github-misc" } }, "/emojis": { "get": { "operationId": "_2Femojis_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-misc" ], "x-swgg-descriptionLineList": [ "Emojis - Emojis.\n", "Lists all the emojis available to use on GitHub.\n", "https://developer.github.com/v3/emojis/#emojis\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Emojis - Emojis.\n", "x-swgg-tags0": "github-misc" } }, "/enterprise/settings/license": { "get": { "operationId": "_2Fenterprise_2Fsettings_2Flicense_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "License - Get license information.\n", "Request\n", "https://developer.github.com/v3/enterprise-admin/license/#get-license-information\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "License - Get license information.\n", "x-swgg-tags0": "github-enterprise" } }, "/enterprise/stats/{type}": { "get": { "operationId": "_2Fenterprise_2Fstats_2F_7Btype_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "default": "422", "in": "path", "name": "type", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "The type of the object we're tagging. Normally this is a ```commit``` but it can also be a ```tree``` or a ```blob```.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Admin Stats - Get statistics.\n", "Request\n", "https://developer.github.com/v3/enterprise-admin/admin_stats/#get-statistics\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Admin Stats - Get statistics.\n", "x-swgg-tags0": "github-enterprise" } }, "/events": { "get": { "operationId": "_2Fevents_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Events - List public events.\n", "https://developer.github.com/v3/activity/events/#list-public-events\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Events - List public events.\n", "x-swgg-tags0": "github-activity" } }, "/feeds": { "get": { "operationId": "_2Ffeeds_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Feeds - List Feeds.\n", "GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n", "- **Timeline**: The GitHub global public timeline\n", "- **User**: The public timeline for any user, using [URI template](https://developer.github.com/v3/#hypermedia)\n", "- **Current user public**: The public timeline for the authenticated user\n", "- **Current user**: The private timeline for the authenticated user\n", "- **Current user actor**: The private timeline for activity created by the authenticated user\n", "- **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n", "**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://developer.github.com/v3/#basic-authentication) since current feed URIs use the older, non revocable auth tokens.\n", "https://developer.github.com/v3/activity/feeds/#list-feeds\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Feeds - List Feeds.\n", "x-swgg-tags0": "github-activity" } }, "/gists": { "post": { "operationId": "_2Fgists_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-gists.gists.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gists - Create a gist.\n", "https://developer.github.com/v3/gists/#create-a-gist\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gists - Create a gist.\n", "x-swgg-tags0": "github-gists" } }, "/gists/public": { "get": { "operationId": "_2Fgists_2Fpublic_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "query", "name": "since", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "A timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```. Only gists updated at or after this time are returned.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gists - List all public gists.\n", "List all public gists sorted by most recently updated to least recently updated.\n", "Note: With [pagination](https://developer.github.com/v3/#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.\n", "https://developer.github.com/v3/gists/#list-all-public-gists\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gists - List all public gists.\n", "x-swgg-tags0": "github-gists" } }, "/gists/starred": { "get": { "operationId": "_2Fgists_2Fstarred_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "query", "name": "since", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "A timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```. Only gists updated at or after this time are returned.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gists - List starred gists.\n", "List the authenticated user's starred gists:\n", "https://developer.github.com/v3/gists/#list-starred-gists\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gists - List starred gists.\n", "x-swgg-tags0": "github-gists" } }, "/gists/{gist_id}/comments": { "get": { "operationId": "_2Fgists_2F_7Bgist_id_7D_2Fcomments_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "gist_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gist Comments - List comments on a gist.\n", "https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gist Comments - List comments on a gist.\n", "x-swgg-tags0": "github-gists" }, "post": { "operationId": "_2Fgists_2F_7Bgist_id_7D_2Fcomments_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "gist_id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-gists.gists-{gist_id}-comments.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gist Comments - Create a comment.\n", "https://developer.github.com/v3/gists/comments/#create-a-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gist Comments - Create a comment.\n", "x-swgg-tags0": "github-gists" } }, "/gists/{gist_id}/comments/{id}": { "delete": { "operationId": "_2Fgists_2F_7Bgist_id_7D_2Fcomments_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "gist_id", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gist Comments - Delete a comment.\n", "https://developer.github.com/v3/gists/comments/#delete-a-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gist Comments - Delete a comment.\n", "x-swgg-tags0": "github-gists" }, "get": { "operationId": "_2Fgists_2F_7Bgist_id_7D_2Fcomments_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "gist_id", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gist Comments - Get a single comment.\n", "https://developer.github.com/v3/gists/comments/#get-a-single-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gist Comments - Get a single comment.\n", "x-swgg-tags0": "github-gists" }, "patch": { "operationId": "_2Fgists_2F_7Bgist_id_7D_2Fcomments_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "gist_id", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-gists.gists-{gist_id}-comments-{id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gist Comments - Edit a comment.\n", "https://developer.github.com/v3/gists/comments/#edit-a-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gist Comments - Edit a comment.\n", "x-swgg-tags0": "github-gists" } }, "/gists/{id}": { "delete": { "operationId": "_2Fgists_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gists - Delete a gist.\n", "https://developer.github.com/v3/gists/#delete-a-gist\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gists - Delete a gist.\n", "x-swgg-tags0": "github-gists" }, "get": { "operationId": "_2Fgists_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gists - Get a single gist.\n", "https://developer.github.com/v3/gists/#get-a-single-gist\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gists - Get a single gist.\n", "x-swgg-tags0": "github-gists" }, "patch": { "operationId": "_2Fgists_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-gists.gists-{id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gists - Edit a gist.\n", "https://developer.github.com/v3/gists/#edit-a-gist\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gists - Edit a gist.\n", "x-swgg-tags0": "github-gists" } }, "/gists/{id}/commits": { "get": { "operationId": "_2Fgists_2F_7Bid_7D_2Fcommits_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gists - List gist commits.\n", "https://developer.github.com/v3/gists/#list-gist-commits\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gists - List gist commits.\n", "x-swgg-tags0": "github-gists" } }, "/gists/{id}/forks": { "get": { "operationId": "_2Fgists_2F_7Bid_7D_2Fforks_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gists - List gist forks.\n", "https://developer.github.com/v3/gists/#list-gist-forks\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gists - List gist forks.\n", "x-swgg-tags0": "github-gists" }, "post": { "operationId": "_2Fgists_2F_7Bid_7D_2Fforks_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gists - Fork a gist.\n", "https://developer.github.com/v3/gists/#fork-a-gist\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gists - Fork a gist.\n", "x-swgg-tags0": "github-gists" } }, "/gists/{id}/star": { "delete": { "operationId": "_2Fgists_2F_7Bid_7D_2Fstar_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gists - Unstar a gist.\n", "https://developer.github.com/v3/gists/#unstar-a-gist\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gists - Unstar a gist.\n", "x-swgg-tags0": "github-gists" }, "get": { "operationId": "_2Fgists_2F_7Bid_7D_2Fstar_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gists - Check if a gist is starred.\n", "https://developer.github.com/v3/gists/#check-if-a-gist-is-starred\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gists - Check if a gist is starred.\n", "x-swgg-tags0": "github-gists" }, "put": { "operationId": "_2Fgists_2F_7Bid_7D_2Fstar_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gists - Star a gist.\n", "https://developer.github.com/v3/gists/#star-a-gist\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gists - Star a gist.\n", "x-swgg-tags0": "github-gists" } }, "/gists/{id}/{sha}": { "get": { "operationId": "_2Fgists_2F_7Bid_7D_2F_7Bsha_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "sha", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gists - Get a specific revision of a gist.\n", "https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gists - Get a specific revision of a gist.\n", "x-swgg-tags0": "github-gists" } }, "/gitignore/templates": { "get": { "operationId": "_2Fgitignore_2Ftemplates_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-misc" ], "x-swgg-descriptionLineList": [ "Gitignore - Listing available templates.\n", "List all templates available to pass as an option when [creating a repository](https://developer.github.com/v3/repos/#create).\n", "https://developer.github.com/v3/gitignore/#listing-available-templates\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gitignore - Listing available templates.\n", "x-swgg-tags0": "github-misc" } }, "/gitignore/templates/C": { "get": { "operationId": "_2Fgitignore_2Ftemplates_2FC_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-misc" ], "x-swgg-descriptionLineList": [ "Gitignore - Get a single template.\n", "The API also allows fetching the source of a single template.\n", "https://developer.github.com/v3/gitignore/#get-a-single-template\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gitignore - Get a single template.\n", "x-swgg-tags0": "github-misc" } }, "/installation/repositories": { "get": { "operationId": "_2Finstallation_2Frepositories_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-apps" ], "x-swgg-descriptionLineList": [ "Installations - List repositories.\n", "List repositories that are accessible to the authenticated installation.\n", "https://developer.github.com/v3/apps/installations/#list-repositories\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Installations - List repositories.\n", "x-swgg-tags0": "github-apps" } }, "/installations/{installation_id}/access_tokens": { "post": { "operationId": "_2Finstallations_2F_7Binstallation_id_7D_2Faccess_tokens_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "installation_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-apps" ], "x-swgg-descriptionLineList": [ "GitHub Apps - Create a new installation token.\n", "https://developer.github.com/v3/apps/#create-a-new-installation-token\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "GitHub Apps - Create a new installation token.\n", "x-swgg-tags0": "github-apps" } }, "/issues": { "get": { "operationId": "_2Fissues_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.sailor-v-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "query", "name": "since", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issues - List issues.\n", "**Note**: In the past, pull requests and issues were more closely aligned than they are now. As far as the API is concerned, every pull request is an issue, but not every issue is a pull request.\n", "This endpoint may also return pull requests in the response. If an issue is a pull request, the object will include a ```pull_request``` key.\n", "List all issues **assigned** to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories:\n", "https://developer.github.com/v3/issues/#list-issues\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issues - List issues.\n", "x-swgg-tags0": "github-issues" } }, "/legacy/issues/search/{owner}/{repository}/{state}/{keyword}": { "get": { "operationId": "_2Flegacy_2Fissues_2Fsearch_2F_7Bowner_7D_2F_7Brepository_7D_2F_7Bstate_7D_2F_7Bkeyword_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repository", "required": true, "type": "string" }, { "in": "path", "name": "state", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "Indicates the state of the issues to return. Can be either ```open``` or ```closed```.\n" ] }, { "in": "path", "name": "keyword", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "The search term.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-search" ], "x-swgg-descriptionLineList": [ "Legacy Search - Search issues.\n", "Find issues by state and keyword.\n", "https://developer.github.com/v3/search/legacy/#search-issues\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Legacy Search - Search issues.\n", "x-swgg-tags0": "github-search" } }, "/legacy/repos/search/{keyword}": { "get": { "operationId": "_2Flegacy_2Frepos_2Fsearch_2F_7Bkeyword_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "keyword", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "The search term\n" ] }, { "in": "query", "name": "language", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Filter results by language\n" ] }, { "in": "query", "name": "start_page", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The page number to fetch\n" ] }, { "in": "query", "name": "sort", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The sort field. One of ```stars```, ```forks```, or ```updated```. Default: results are sorted by best match.\n" ] }, { "in": "query", "name": "order", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The sort field. if ```sort``` param is provided. Can be either ```asc``` or ```desc```.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-search" ], "x-swgg-descriptionLineList": [ "Legacy Search - Search repositories.\n", "Find repositories by keyword. Note, this legacy method does not follow the v3 pagination pattern. This method returns up to 100 results per page and pages can be fetched using the ```start_page``` parameter.\n", "https://developer.github.com/v3/search/legacy/#search-repositories\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Legacy Search - Search repositories.\n", "x-swgg-tags0": "github-search" } }, "/legacy/user/email/{email}": { "get": { "operationId": "_2Flegacy_2Fuser_2Femail_2F_7Bemail_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "email", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "The email address\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-search" ], "x-swgg-descriptionLineList": [ "Legacy Search - Email search.\n", "This API call is added for compatibility reasons only. There's no guarantee that full email searches will always be available. The ```@``` character in the address must be left unencoded. Searches only against public email addresses (as configured on the user's GitHub profile).\n", "https://developer.github.com/v3/search/legacy/#email-search\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Legacy Search - Email search.\n", "x-swgg-tags0": "github-search" } }, "/legacy/user/search/{keyword}": { "get": { "operationId": "_2Flegacy_2Fuser_2Fsearch_2F_7Bkeyword_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "keyword", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "The search term\n" ] }, { "in": "query", "name": "start_page", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The page number to fetch\n" ] }, { "in": "query", "name": "sort", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The sort field. One of ```stars```, ```forks```, or ```updated```. Default: results are sorted by best match.\n" ] }, { "in": "query", "name": "order", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The sort field. if ```sort``` param is provided. Can be either ```asc``` or ```desc```.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-search" ], "x-swgg-descriptionLineList": [ "Legacy Search - Search users.\n", "Find users by keyword.\n", "https://developer.github.com/v3/search/legacy/#search-users\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Legacy Search - Search users.\n", "x-swgg-tags0": "github-search" } }, "/licenses": { "get": { "operationId": "_2Flicenses_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-misc" ], "x-swgg-descriptionLineList": [ "Licenses - List all licenses.\n", "https://developer.github.com/v3/licenses/#list-all-licenses\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Licenses - List all licenses.\n", "x-swgg-tags0": "github-misc" } }, "/licenses/{license}": { "get": { "operationId": "_2Flicenses_2F_7Blicense_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "license", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-misc" ], "x-swgg-descriptionLineList": [ "Licenses - Get an individual license.\n", "https://developer.github.com/v3/licenses/#get-an-individual-license\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Licenses - Get an individual license.\n", "x-swgg-tags0": "github-misc" } }, "/markdown": { "post": { "operationId": "_2Fmarkdown_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-misc.markdown.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-misc" ], "x-swgg-descriptionLineList": [ "Markdown - Render an arbitrary Markdown document.\n", "https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Markdown - Render an arbitrary Markdown document.\n", "x-swgg-tags0": "github-misc" } }, "/markdown/raw": { "post": { "operationId": "_2Fmarkdown_2Fraw_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-misc" ], "x-swgg-descriptionLineList": [ "Markdown - Render a Markdown document in raw mode.\n", "https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Markdown - Render a Markdown document in raw mode.\n", "x-swgg-tags0": "github-misc" } }, "/marketplace_listing/accounts/{id}": { "get": { "operationId": "_2Fmarketplace_listing_2Faccounts_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.valkyrie-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-apps" ], "x-swgg-descriptionLineList": [ "GitHub Marketplace - Check if a GitHub account is associated with any Marketplace listing.\n", "https://developer.github.com/v3/apps/marketplace/#check-if-a-github-account-is-associated-with-any-marketplace-listing\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "GitHub Marketplace - Check if a GitHub account is associated with any Marketplace listing.\n", "x-swgg-tags0": "github-apps" } }, "/marketplace_listing/plans": { "get": { "operationId": "_2Fmarketplace_listing_2Fplans_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.valkyrie-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-apps" ], "x-swgg-descriptionLineList": [ "GitHub Marketplace - List all plans for your Marketplace listing.\n", "https://developer.github.com/v3/apps/marketplace/#list-all-plans-for-your-marketplace-listing\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "GitHub Marketplace - List all plans for your Marketplace listing.\n", "x-swgg-tags0": "github-apps" } }, "/marketplace_listing/plans/{id}/accounts": { "get": { "operationId": "_2Fmarketplace_listing_2Fplans_2F_7Bid_7D_2Faccounts_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.valkyrie-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-apps" ], "x-swgg-descriptionLineList": [ "GitHub Marketplace - List all GitHub accounts (user or organization) on a specific plan.\n", "https://developer.github.com/v3/apps/marketplace/#list-all-github-accounts-user-or-organization-on-a-specific-plan\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "GitHub Marketplace - List all GitHub accounts (user or organization) on a specific plan.\n", "x-swgg-tags0": "github-apps" } }, "/meta": { "get": { "operationId": "_2Fmeta_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "query", "name": "verifiable_password_authentication", "required": false, "type": "boolean", "x-swgg-descriptionLineList": [ "Whether authentication with username and password is supported.\n" ] }, { "in": "query", "name": "github_services_sha", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The currently-deployed SHA of [```github-services```](https://github.com/github/github-services).\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-misc" ], "x-swgg-descriptionLineList": [ "Meta - Meta.\n", "This endpoint provides information about GitHub.com, the service.\n", "https://developer.github.com/v3/meta/#meta\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Meta - Meta.\n", "x-swgg-tags0": "github-misc" } }, "/networks/{owner}/{repo}/events": { "get": { "operationId": "_2Fnetworks_2F_7Bowner_7D_2F_7Brepo_7D_2Fevents_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Events - List public events for a network of repositories.\n", "https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Events - List public events for a network of repositories.\n", "x-swgg-tags0": "github-activity" } }, "/notifications": { "get": { "operationId": "_2Fnotifications_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "query", "name": "before", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Notifications - List your notifications.\n", "List all notifications for the current user, sorted by most recently updated.\n", "https://developer.github.com/v3/activity/notifications/#list-your-notifications\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Notifications - List your notifications.\n", "x-swgg-tags0": "github-activity" }, "put": { "operationId": "_2Fnotifications_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Notifications - Mark as read.\n", "Marking a notification as \"read\" removes it from the [default view on GitHub](https://github.com/notifications).\n", "https://developer.github.com/v3/activity/notifications/#mark-as-read\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Notifications - Mark as read.\n", "x-swgg-tags0": "github-activity" } }, "/notifications/threads/{id}": { "get": { "operationId": "_2Fnotifications_2Fthreads_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Notifications - View a single thread.\n", "https://developer.github.com/v3/activity/notifications/#view-a-single-thread\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Notifications - View a single thread.\n", "x-swgg-tags0": "github-activity" }, "patch": { "operationId": "_2Fnotifications_2Fthreads_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Notifications - Mark a thread as read.\n", "https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Notifications - Mark a thread as read.\n", "x-swgg-tags0": "github-activity" } }, "/notifications/threads/{id}/subscription": { "delete": { "operationId": "_2Fnotifications_2Fthreads_2F_7Bid_7D_2Fsubscription_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Notifications - Delete a Thread Subscription.\n", "https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Notifications - Delete a Thread Subscription.\n", "x-swgg-tags0": "github-activity" }, "get": { "operationId": "_2Fnotifications_2Fthreads_2F_7Bid_7D_2Fsubscription_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Notifications - Get a Thread Subscription.\n", "This checks to see if the current user is subscribed to a thread. You can also [get a Repository subscription](https://developer.github.com/v3/activity/watching/#get-a-repository-subscription).\n", "Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mention**ed, or manually subscribe to a thread.\n", "https://developer.github.com/v3/activity/notifications/#get-a-thread-subscription\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Notifications - Get a Thread Subscription.\n", "x-swgg-tags0": "github-activity" }, "put": { "operationId": "_2Fnotifications_2Fthreads_2F_7Bid_7D_2Fsubscription_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-activity.notifications-threads-{id}-subscription.put.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Notifications - Set a Thread Subscription.\n", "This lets you subscribe or unsubscribe from a conversation. Unsubscribing from a conversation mutes all future notifications (until you comment or get **@mention**ed once more).\n", "https://developer.github.com/v3/activity/notifications/#set-a-thread-subscription\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Notifications - Set a Thread Subscription.\n", "x-swgg-tags0": "github-activity" } }, "/organizations": { "get": { "operationId": "_2Forganizations_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "query", "name": "since", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The integer ID of the last Organization that you've seen.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organizations - List all organizations.\n", "Lists all organizations, in the order that they were created on GitHub.\n", "**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 organizations.\n", "https://developer.github.com/v3/orgs/#list-all-organizations\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organizations - List all organizations.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organizations - Get an organization.\n", "https://developer.github.com/v3/orgs/#get-an-organization\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organizations - Get an organization.\n", "x-swgg-tags0": "github-orgs" }, "patch": { "operationId": "_2Forgs_2F_7Borg_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-orgs.orgs-{org}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organizations - Edit an organization.\n", "https://developer.github.com/v3/orgs/#edit-an-organization\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organizations - Edit an organization.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/blocks": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fblocks_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.giant-sentry-fist-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Blocking Users (Organizations) - List blocked users.\n", "List the users blocked by an organization.\n", "https://developer.github.com/v3/orgs/blocking/#list-blocked-users\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Blocking Users (Organizations) - List blocked users.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/blocks/{username}": { "delete": { "operationId": "_2Forgs_2F_7Borg_7D_2Fblocks_2F_7Busername_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.giant-sentry-fist-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Blocking Users (Organizations) - Unblock a user.\n", "https://developer.github.com/v3/orgs/blocking/#unblock-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Blocking Users (Organizations) - Unblock a user.\n", "x-swgg-tags0": "github-orgs" }, "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fblocks_2F_7Busername_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.giant-sentry-fist-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Blocking Users (Organizations) - Check whether a user is blocked from an organization.\n", "https://developer.github.com/v3/orgs/blocking/#check-whether-a-user-is-blocked-from-an-organization\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Blocking Users (Organizations) - Check whether a user is blocked from an organization.\n", "x-swgg-tags0": "github-orgs" }, "put": { "operationId": "_2Forgs_2F_7Borg_7D_2Fblocks_2F_7Busername_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.giant-sentry-fist-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Blocking Users (Organizations) - Block a user.\n", "https://developer.github.com/v3/orgs/blocking/#block-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Blocking Users (Organizations) - Block a user.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/events": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fevents_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Events - List public events for an organization.\n", "https://developer.github.com/v3/activity/events/#list-public-events-for-an-organization\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Events - List public events for an organization.\n", "x-swgg-tags0": "github-activity" } }, "/orgs/{org}/hooks": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fhooks_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Webhooks - List hooks.\n", "https://developer.github.com/v3/orgs/hooks/#list-hooks\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Webhooks - List hooks.\n", "x-swgg-tags0": "github-orgs" }, "post": { "operationId": "_2Forgs_2F_7Borg_7D_2Fhooks_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-orgs.orgs-{org}-hooks.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Webhooks - Create a hook.\n", "https://developer.github.com/v3/orgs/hooks/#create-a-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Webhooks - Create a hook.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/hooks/{id}": { "delete": { "operationId": "_2Forgs_2F_7Borg_7D_2Fhooks_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Webhooks - Delete a hook.\n", "https://developer.github.com/v3/orgs/hooks/#delete-a-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Webhooks - Delete a hook.\n", "x-swgg-tags0": "github-orgs" }, "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fhooks_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Webhooks - Get single hook.\n", "https://developer.github.com/v3/orgs/hooks/#get-single-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Webhooks - Get single hook.\n", "x-swgg-tags0": "github-orgs" }, "patch": { "operationId": "_2Forgs_2F_7Borg_7D_2Fhooks_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-orgs.orgs-{org}-hooks-{id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Webhooks - Edit a hook.\n", "https://developer.github.com/v3/orgs/hooks/#edit-a-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Webhooks - Edit a hook.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/hooks/{id}/pings": { "post": { "operationId": "_2Forgs_2F_7Borg_7D_2Fhooks_2F_7Bid_7D_2Fpings_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Webhooks - Ping a hook.\n", "This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook.\n", "https://developer.github.com/v3/orgs/hooks/#ping-a-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Webhooks - Ping a hook.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/invitations": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Finvitations_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - List pending organization invitations.\n", "**Note:** You can now use the API to invite users to a GitHub organization. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-25-organization-invitation-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header: ```application/vnd.github.dazzler-preview+json ```\n", "**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).\n", "The return hash contains a ```role``` field which refers to the Organization Invitation role and will be one of the following values: ```direct_member```, ```admin```, ```billing_manager```, ```hiring_manager```, or ```reinstate```. If the invitee is not a GitHub member, the ```login``` field in the return hash will be ```null```.\n", "https://developer.github.com/v3/orgs/members/#list-pending-organization-invitations\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - List pending organization invitations.\n", "x-swgg-tags0": "github-orgs" }, "post": { "operationId": "_2Forgs_2F_7Borg_7D_2Finvitations_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-orgs.orgs-{org}-invitations.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - Create organization invitation.\n", "**Note:** You can now use the API to invite users to a GitHub organization. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-25-organization-invitation-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header: ```application/vnd.github.dazzler-preview+json ```\n", "**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).\n", "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n", "https://developer.github.com/v3/orgs/members/#create-organization-invitation\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - Create organization invitation.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/invitations/{invitation_id}/teams": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Finvitations_2F_7Binvitation_id_7D_2Fteams_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "invitation_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - List organization invitation teams.\n", "**Note:** You can now use the API to invite users to a GitHub organization. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-25-organization-invitation-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header: ```application/vnd.github.dazzler-preview+json ```\n", "**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).\n", "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.\n", "https://developer.github.com/v3/orgs/members/#list-organization-invitation-teams\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - List organization invitation teams.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/members": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fmembers_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - Members list.\n", "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.\n", "https://developer.github.com/v3/orgs/members/#members-list\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - Members list.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/members/{username}": { "delete": { "operationId": "_2Forgs_2F_7Borg_7D_2Fmembers_2F_7Busername_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - Remove a member.\n", "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.\n", "https://developer.github.com/v3/orgs/members/#remove-a-member\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - Remove a member.\n", "x-swgg-tags0": "github-orgs" }, "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fmembers_2F_7Busername_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - Check membership.\n", "Check if a user is, publicly or privately, a member of the organization.\n", "https://developer.github.com/v3/orgs/members/#check-membership\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - Check membership.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/memberships/{username}": { "delete": { "operationId": "_2Forgs_2F_7Borg_7D_2Fmemberships_2F_7Busername_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - Remove organization membership.\n", "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n", "https://developer.github.com/v3/orgs/members/#remove-organization-membership\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - Remove organization membership.\n", "x-swgg-tags0": "github-orgs" }, "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fmemberships_2F_7Busername_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - Get organization membership.\n", "In order to get a user's membership with an organization, the authenticated user must be an organization member.\n", "https://developer.github.com/v3/orgs/members/#get-organization-membership\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - Get organization membership.\n", "x-swgg-tags0": "github-orgs" }, "put": { "operationId": "_2Forgs_2F_7Borg_7D_2Fmemberships_2F_7Busername_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - Add or update organization membership.\n", "In order to create or update a user's membership with an organization, the authenticated user must be an organization owner.\n", "- If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://developer.github.com/v3/orgs/members/#get-organization-membership) will be ```pending``` until they accept the invitation.\n", "- Authenticated users can update a user's membership by passing the ```role``` parameter. If the authenticated user changes a member's role to ```admin```, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to ```member```, no email will be sent.\n", "https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - Add or update organization membership.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/migrations": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fmigrations_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.wyandotte-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-migration" ], "x-swgg-descriptionLineList": [ "Migrations - Get a list of migrations.\n", "Lists the most recent migrations.\n", "https://developer.github.com/v3/migration/migrations/#get-a-list-of-migrations\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Migrations - Get a list of migrations.\n", "x-swgg-tags0": "github-migration" }, "post": { "operationId": "_2Forgs_2F_7Borg_7D_2Fmigrations_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.wyandotte-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-migration.orgs-{org}-migrations.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-migration" ], "x-swgg-descriptionLineList": [ "Migrations - Start a migration.\n", "Initiates the generation of a migration archive.\n", "https://developer.github.com/v3/migration/migrations/#start-a-migration\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Migrations - Start a migration.\n", "x-swgg-tags0": "github-migration" } }, "/orgs/{org}/migrations/{id}": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fmigrations_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.wyandotte-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-migration" ], "x-swgg-descriptionLineList": [ "Migrations - Get the status of a migration.\n", "Fetches the status of a migration.\n", "https://developer.github.com/v3/migration/migrations/#get-the-status-of-a-migration\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Migrations - Get the status of a migration.\n", "x-swgg-tags0": "github-migration" } }, "/orgs/{org}/migrations/{id}/archive": { "delete": { "operationId": "_2Forgs_2F_7Borg_7D_2Fmigrations_2F_7Bid_7D_2Farchive_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.wyandotte-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-migration" ], "x-swgg-descriptionLineList": [ "Migrations - Delete a migration archive.\n", "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.\n", "https://developer.github.com/v3/migration/migrations/#delete-a-migration-archive\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Migrations - Delete a migration archive.\n", "x-swgg-tags0": "github-migration" }, "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fmigrations_2F_7Bid_7D_2Farchive_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.wyandotte-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-migration" ], "x-swgg-descriptionLineList": [ "Migrations - Download a migration archive.\n", "Fetches the URL to a migration archive.\n", "https://developer.github.com/v3/migration/migrations/#download-a-migration-archive\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Migrations - Download a migration archive.\n", "x-swgg-tags0": "github-migration" } }, "/orgs/{org}/migrations/{id}/repos/{repo_name}/lock": { "delete": { "operationId": "_2Forgs_2F_7Borg_7D_2Fmigrations_2F_7Bid_7D_2Frepos_2F_7Brepo_name_7D_2Flock_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.wyandotte-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "repo_name", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-migration" ], "x-swgg-descriptionLineList": [ "Migrations - Unlock a repository.\n", "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://developer.github.com/v3/repos/#delete-a-repository) when the migration is complete and you no longer need the source data.\n", "https://developer.github.com/v3/migration/migrations/#unlock-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Migrations - Unlock a repository.\n", "x-swgg-tags0": "github-migration" } }, "/orgs/{org}/outside_collaborators": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Foutside_collaborators_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Outside Collaborators - List outside collaborators.\n", "List all users who are outside collaborators of an organization.\n", "https://developer.github.com/v3/orgs/outside_collaborators/#list-outside-collaborators\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Outside Collaborators - List outside collaborators.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/outside_collaborators/{username}": { "delete": { "operationId": "_2Forgs_2F_7Borg_7D_2Foutside_collaborators_2F_7Busername_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Outside Collaborators - Remove outside collaborator.\n", "Removing a user from this list will remove them from all the organization's repositories.\n", "https://developer.github.com/v3/orgs/outside_collaborators/#remove-outside-collaborator\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Outside Collaborators - Remove outside collaborator.\n", "x-swgg-tags0": "github-orgs" }, "put": { "operationId": "_2Forgs_2F_7Borg_7D_2Foutside_collaborators_2F_7Busername_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Outside Collaborators - Convert member to outside collaborator.\n", "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\".\n", "https://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Outside Collaborators - Convert member to outside collaborator.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/pre-receive-hooks": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fpre-receive-hooks_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Pre-receive Hooks - List pre-receive hooks.\n", "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.\n", "https://developer.github.com/v3/orgs/pre_receive_hooks/#list-pre-receive-hooks\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Pre-receive Hooks - List pre-receive hooks.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/pre-receive-hooks/{id}": { "delete": { "operationId": "_2Forgs_2F_7Borg_7D_2Fpre-receive-hooks_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Pre-receive Hooks - Remove enforcment overrides for a pre-receive hook.\n", "Removes any overrides for this hook at the org level for this org.\n", "https://developer.github.com/v3/orgs/pre_receive_hooks/#remove-enforcment-overrides-for-a-pre-receive-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Pre-receive Hooks - Remove enforcment overrides for a pre-receive hook.\n", "x-swgg-tags0": "github-orgs" }, "patch": { "operationId": "_2Forgs_2F_7Borg_7D_2Fpre-receive-hooks_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Pre-receive Hooks - Update pre-receive hook enforcement.\n", "For pre-receive hooks which are allowed to be configured at the org level, you can set ```enforcement``` and ```allow_downstream_configuration```\n", "https://developer.github.com/v3/orgs/pre_receive_hooks/#update-pre-receive-hook-enforcement\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Pre-receive Hooks - Update pre-receive hook enforcement.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/projects": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fprojects_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Projects - List organization projects.\n", "https://developer.github.com/v3/projects/#list-organization-projects\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Projects - List organization projects.\n", "x-swgg-tags0": "github-projects" }, "post": { "operationId": "_2Forgs_2F_7Borg_7D_2Fprojects_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-projects.orgs-{org}-projects.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Projects - Create an organization project.\n", "https://developer.github.com/v3/projects/#create-an-organization-project\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Projects - Create an organization project.\n", "x-swgg-tags0": "github-projects" } }, "/orgs/{org}/public_members": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fpublic_members_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - Public members list.\n", "Members of an organization can choose to have their membership publicized or not.\n", "https://developer.github.com/v3/orgs/members/#public-members-list\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - Public members list.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/public_members/{username}": { "delete": { "operationId": "_2Forgs_2F_7Borg_7D_2Fpublic_members_2F_7Busername_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - Conceal a user's membership.\n", "https://developer.github.com/v3/orgs/members/#conceal-a-users-membership\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - Conceal a user's membership.\n", "x-swgg-tags0": "github-orgs" }, "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fpublic_members_2F_7Busername_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - Check public membership.\n", "https://developer.github.com/v3/orgs/members/#check-public-membership\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - Check public membership.\n", "x-swgg-tags0": "github-orgs" }, "put": { "operationId": "_2Forgs_2F_7Borg_7D_2Fpublic_members_2F_7Busername_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - Publicize a user's membership.\n", "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n", "https://developer.github.com/v3/orgs/members/#publicize-a-users-membership\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - Publicize a user's membership.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}/repos": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Frepos_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.nightshade-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repositories - List organization repositories.\n", "List repositories for the specified org.\n", "https://developer.github.com/v3/repos/#list-organization-repositories\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repositories - List organization repositories.\n", "x-swgg-tags0": "github-repos" } }, "/orgs/{org}/teams": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_2Fteams_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - List teams.\n", "**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 ```\n", "**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).\n", "https://developer.github.com/v3/orgs/teams/#list-teams\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - List teams.\n", "x-swgg-tags0": "github-orgs" }, "post": { "operationId": "_2Forgs_2F_7Borg_7D_2Fteams_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-orgs.orgs-{org}-teams.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - Create team.\n", "**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 ```\n", "**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).\n", "To create a team, the authenticated user must be a member of ```:org```.\n", "https://developer.github.com/v3/orgs/teams/#create-team\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - Create team.\n", "x-swgg-tags0": "github-orgs" } }, "/orgs/{org}{pre-receive-hooks}/{id}": { "get": { "operationId": "_2Forgs_2F_7Borg_7D_7Bpre-receive-hooks_7D_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "pre-receive-hooks", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Pre-receive Hooks - Get a single pre-receive hook.\n", "https://developer.github.com/v3/orgs/pre_receive_hooks/#get-a-single-pre-receive-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Pre-receive Hooks - Get a single pre-receive hook.\n", "x-swgg-tags0": "github-orgs" } }, "/projects/columns/cards/{card_id}": { "delete": { "operationId": "_2Fprojects_2Fcolumns_2Fcards_2F_7Bcard_id_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "card_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Project cards - Delete a project card.\n", "https://developer.github.com/v3/projects/cards/#delete-a-project-card\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Project cards - Delete a project card.\n", "x-swgg-tags0": "github-projects" }, "get": { "operationId": "_2Fprojects_2Fcolumns_2Fcards_2F_7Bcard_id_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "card_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Project cards - Get a project card.\n", "https://developer.github.com/v3/projects/cards/#get-a-project-card\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Project cards - Get a project card.\n", "x-swgg-tags0": "github-projects" }, "patch": { "operationId": "_2Fprojects_2Fcolumns_2Fcards_2F_7Bcard_id_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "card_id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-projects.projects-columns-cards-{card_id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Project cards - Update a project card.\n", "https://developer.github.com/v3/projects/cards/#update-a-project-card\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Project cards - Update a project card.\n", "x-swgg-tags0": "github-projects" } }, "/projects/columns/cards/{card_id}/moves": { "post": { "operationId": "_2Fprojects_2Fcolumns_2Fcards_2F_7Bcard_id_7D_2Fmoves_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "card_id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-projects.projects-columns-cards-{card_id}-moves.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Project cards - Move a project card.\n", "https://developer.github.com/v3/projects/cards/#move-a-project-card\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Project cards - Move a project card.\n", "x-swgg-tags0": "github-projects" } }, "/projects/columns/{column_id}": { "delete": { "operationId": "_2Fprojects_2Fcolumns_2F_7Bcolumn_id_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "column_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Project columns - Delete a project column.\n", "https://developer.github.com/v3/projects/columns/#delete-a-project-column\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Project columns - Delete a project column.\n", "x-swgg-tags0": "github-projects" }, "get": { "operationId": "_2Fprojects_2Fcolumns_2F_7Bcolumn_id_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "column_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Project columns - Get a project column.\n", "https://developer.github.com/v3/projects/columns/#get-a-project-column\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Project columns - Get a project column.\n", "x-swgg-tags0": "github-projects" }, "patch": { "operationId": "_2Fprojects_2Fcolumns_2F_7Bcolumn_id_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "column_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Project columns - Update a project column.\n", "https://developer.github.com/v3/projects/columns/#update-a-project-column\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Project columns - Update a project column.\n", "x-swgg-tags0": "github-projects" } }, "/projects/columns/{column_id}/cards": { "get": { "operationId": "_2Fprojects_2Fcolumns_2F_7Bcolumn_id_7D_2Fcards_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "column_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Project cards - List project cards.\n", "https://developer.github.com/v3/projects/cards/#list-project-cards\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Project cards - List project cards.\n", "x-swgg-tags0": "github-projects" }, "post": { "operationId": "_2Fprojects_2Fcolumns_2F_7Bcolumn_id_7D_2Fcards_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "column_id", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "The ```id``` value of a column in the same project.\n" ] }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-projects.projects-columns-{column_id}-cards.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Project cards - Create a project card.\n", "https://developer.github.com/v3/projects/cards/#create-a-project-card\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Project cards - Create a project card.\n", "x-swgg-tags0": "github-projects" } }, "/projects/columns/{column_id}/moves": { "post": { "operationId": "_2Fprojects_2Fcolumns_2F_7Bcolumn_id_7D_2Fmoves_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "column_id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-projects.projects-columns-{column_id}-moves.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Project columns - Move a project column.\n", "https://developer.github.com/v3/projects/columns/#move-a-project-column\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Project columns - Move a project column.\n", "x-swgg-tags0": "github-projects" } }, "/projects/{project_id}": { "delete": { "operationId": "_2Fprojects_2F_7Bproject_id_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "project_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Projects - Delete a project.\n", "https://developer.github.com/v3/projects/#delete-a-project\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Projects - Delete a project.\n", "x-swgg-tags0": "github-projects" }, "get": { "operationId": "_2Fprojects_2F_7Bproject_id_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "project_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Projects - Get a project.\n", "https://developer.github.com/v3/projects/#get-a-project\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Projects - Get a project.\n", "x-swgg-tags0": "github-projects" }, "patch": { "operationId": "_2Fprojects_2F_7Bproject_id_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "project_id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-projects.projects-{project_id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Projects - Update a project.\n", "https://developer.github.com/v3/projects/#update-a-project\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Projects - Update a project.\n", "x-swgg-tags0": "github-projects" } }, "/projects/{project_id}/columns": { "get": { "operationId": "_2Fprojects_2F_7Bproject_id_7D_2Fcolumns_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "project_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Project columns - List project columns.\n", "https://developer.github.com/v3/projects/columns/#list-project-columns\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Project columns - List project columns.\n", "x-swgg-tags0": "github-projects" }, "post": { "operationId": "_2Fprojects_2F_7Bproject_id_7D_2Fcolumns_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "project_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Project columns - Create a project column.\n", "https://developer.github.com/v3/projects/columns/#create-a-project-column\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Project columns - Create a project column.\n", "x-swgg-tags0": "github-projects" } }, "/rate_limit": { "get": { "operationId": "_2Frate_limit_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-misc" ], "x-swgg-descriptionLineList": [ "Rate Limit - Get your current rate limit status.\n", "Note: Accessing this endpoint does not count against your rate limit.\n", "https://developer.github.com/v3/rate_limit/#get-your-current-rate-limit-status\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Rate Limit - Get your current rate limit status.\n", "x-swgg-tags0": "github-misc" } }, "/reactions/{id}": { "delete": { "operationId": "_2Freactions_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-reactions" ], "x-swgg-descriptionLineList": [ "Reactions - Delete a reaction.\n", "https://developer.github.com/v3/reactions/#delete-a-reaction\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reactions - Delete a reaction.\n", "x-swgg-tags0": "github-reactions" } }, "/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" }, { "default": "application/vnd.github.black-panther-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "name", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. Must be passed as \"web\".\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Community - Retrieve community profile metrics.\n", "https://developer.github.com/v3/repos/community/#retrieve-community-profile-metrics\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Community - Retrieve community profile metrics.\n", "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" }, { "default": "application/vnd.github.nightshade-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repositories - Delete a repository.\n", "Deleting a repository requires admin access. If OAuth is used, the ```delete_repo``` scope is required.\n", "https://developer.github.com/v3/repos/#delete-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repositories - Delete a repository.\n", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.scarlet-witch-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-misc" ], "x-swgg-descriptionLineList": [ "Codes of Conduct - Get a repository's code of conduct.\n", "When passed the preview media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.\n", "https://developer.github.com/v3/codes_of_conduct/#get-a-repositorys-code-of-conduct\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Codes of Conduct - Get a repository's code of conduct.\n", "x-swgg-tags0": "github-misc" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.nightshade-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repositories - Edit.\n", "https://developer.github.com/v3/repos/#edit\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repositories - Edit.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}#2": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_232_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.nightshade-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repositories - Get.\n", "https://developer.github.com/v3/repos/#get\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repositories - Get.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/assignees": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fassignees_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Assignees - List assignees.\n", "Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.\n", "https://developer.github.com/v3/issues/assignees/#list-assignees\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Assignees - List assignees.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/assignees/{assignee}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fassignees_2F_7Bassignee_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "assignee", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Assignees - Check assignee.\n", "Checks if a user has permission to be assigned to an issue in this repository.\n", "https://developer.github.com/v3/issues/assignees/#check-assignee\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Assignees - Check assignee.\n", "x-swgg-tags0": "github-issues" } }, "/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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "query", "name": "protected", "required": false, "type": "boolean", "x-swgg-descriptionLineList": [ "Set to ```true``` to only return protected branches\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - List branches.\n", "https://developer.github.com/v3/repos/branches/#list-branches\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - List branches.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Get branch.\n", "https://developer.github.com/v3/repos/branches/#get-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Get branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Remove branch protection.\n", "https://developer.github.com/v3/repos/branches/#remove-branch-protection\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Remove branch protection.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Get branch protection.\n", "https://developer.github.com/v3/repos/branches/#get-branch-protection\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Get branch protection.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-branches-{branch}-protection.put.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Update branch protection.\n", "Protecting a branch requires admin access.\n", "https://developer.github.com/v3/repos/branches/#update-branch-protection\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Update branch protection.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Remove admin enforcement of protected branch.\n", "Removing admin enforcement requires admin access and branch protection to be enabled.\n", "https://developer.github.com/v3/repos/branches/#remove-admin-enforcement-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Remove admin enforcement of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Get admin enforcement of protected branch.\n", "https://developer.github.com/v3/repos/branches/#get-admin-enforcement-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Get admin enforcement of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Add admin enforcement of protected branch.\n", "Adding admin enforcement requires admin access and branch protection to be enabled.\n", "https://developer.github.com/v3/repos/branches/#add-admin-enforcement-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Add admin enforcement of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Remove pull request review enforcement of protected branch.\n", "https://developer.github.com/v3/repos/branches/#remove-pull-request-review-enforcement-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Remove pull request review enforcement of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Get pull request review enforcement of protected branch.\n", "https://developer.github.com/v3/repos/branches/#get-pull-request-review-enforcement-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Get pull request review enforcement of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-branches-{branch}-protection-required_pull_request_reviews.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Update pull request review enforcement of protected branch.\n", "Updating pull request review enforcement requires admin access and branch protection to be enabled.\n", "https://developer.github.com/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Update pull request review enforcement of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Remove required status checks of protected branch.\n", "https://developer.github.com/v3/repos/branches/#remove-required-status-checks-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Remove required status checks of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Get required status checks of protected branch.\n", "https://developer.github.com/v3/repos/branches/#get-required-status-checks-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Get required status checks of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-branches-{branch}-protection-required_status_checks.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Update required status checks of protected branch.\n", "Updating required status checks requires admin access and branch protection to be enabled.\n", "https://developer.github.com/v3/repos/branches/#update-required-status-checks-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Update required status checks of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Remove required status checks contexts of protected branch.\n", "https://developer.github.com/v3/repos/branches/#remove-required-status-checks-contexts-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Remove required status checks contexts of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - List required status checks contexts of protected branch.\n", "https://developer.github.com/v3/repos/branches/#list-required-status-checks-contexts-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - List required status checks contexts of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Add required status checks contexts of protected branch.\n", "https://developer.github.com/v3/repos/branches/#add-required-status-checks-contexts-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Add required status checks contexts of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Replace required status checks contexts of protected branch.\n", "https://developer.github.com/v3/repos/branches/#replace-required-status-checks-contexts-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Replace required status checks contexts of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Remove restrictions of protected branch.\n", "https://developer.github.com/v3/repos/branches/#remove-restrictions-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Remove restrictions of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Get restrictions of protected branch.\n", "**Note**: Teams and users ```restrictions``` are only available for organization-owned repositories.\n", "https://developer.github.com/v3/repos/branches/#get-restrictions-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Get restrictions of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Remove team restrictions of protected branch.\n", "**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 ```\n", "**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).\n", "https://developer.github.com/v3/repos/branches/#remove-team-restrictions-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Remove team restrictions of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - List team restrictions of protected branch.\n", "**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 ```\n", "**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).\n", "https://developer.github.com/v3/repos/branches/#list-team-restrictions-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - List team restrictions of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Add team restrictions of protected branch.\n", "**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 ```\n", "**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).\n", "https://developer.github.com/v3/repos/branches/#add-team-restrictions-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Add team restrictions of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Replace team restrictions of protected branch.\n", "**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 ```\n", "**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).\n", "https://developer.github.com/v3/repos/branches/#replace-team-restrictions-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Replace team restrictions of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "master", "in": "path", "name": "branch", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "The branch name. Default: the repository’s default branch (usually ```master```)\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Remove user restrictions of protected branch.\n", "https://developer.github.com/v3/repos/branches/#remove-user-restrictions-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Remove user restrictions of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - List user restrictions of protected branch.\n", "https://developer.github.com/v3/repos/branches/#list-user-restrictions-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - List user restrictions of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Add user restrictions of protected branch.\n", "https://developer.github.com/v3/repos/branches/#add-user-restrictions-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Add user restrictions of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "branch", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Branches - Replace user restrictions of protected branch.\n", "https://developer.github.com/v3/repos/branches/#replace-user-restrictions-of-protected-branch\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Branches - Replace user restrictions of protected branch.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Collaborators - List collaborators.\n", "**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 ```\n", "**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).\n", "https://developer.github.com/v3/repos/collaborators/#list-collaborators\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Collaborators - List collaborators.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Collaborators - Remove user as a collaborator.\n", "https://developer.github.com/v3/repos/collaborators/#remove-user-as-a-collaborator\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Collaborators - Remove user as a collaborator.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Collaborators - Check if a user is a collaborator.\n", "**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 ```\n", "**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).\n", "https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Collaborators - Check if a user is a collaborator.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Collaborators - Add user as a collaborator.\n", "https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Collaborators - Add user as a collaborator.\n", "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" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Collaborators - Review a user's permission level.\n", "https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Collaborators - Review a user's permission level.\n", "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" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Comments - List commit comments for a repository.\n", "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/).\n", "Comments are ordered by ascending ID.\n", "https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Comments - List commit comments for a repository.\n", "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" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Comments - Delete a commit comment.\n", "https://developer.github.com/v3/repos/comments/#delete-a-commit-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Comments - Delete a commit comment.\n", "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" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Comments - Get a single commit comment.\n", "https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Comments - Get a single commit comment.\n", "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" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-comments-{id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Comments - Update a commit comment.\n", "https://developer.github.com/v3/repos/comments/#update-a-commit-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Comments - Update a commit comment.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/comments/{id}/reactions": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcomments_2F_7Bid_7D_2Freactions_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "query", "name": "content", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Indicates which type of reaction to return.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-reactions" ], "x-swgg-descriptionLineList": [ "Reactions - List reactions for a commit comment.\n", "https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reactions - List reactions for a commit comment.\n", "x-swgg-tags0": "github-reactions" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcomments_2F_7Bid_7D_2Freactions_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-reactions.repos-{owner}-{repo}-comments-{id}-reactions.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-reactions" ], "x-swgg-descriptionLineList": [ "Reactions - Create reaction for a commit comment.\n", "https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reactions - Create reaction for a commit comment.\n", "x-swgg-tags0": "github-reactions" } }, "/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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "query", "name": "path", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Only commits containing this file path will be returned.\n" ] }, { "in": "query", "name": "author", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "GitHub login or email address by which to filter by commit author.\n" ] }, { "in": "query", "name": "since", "required": false, "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```.\n" ] }, { "in": "query", "name": "until", "required": false, "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```.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Commits - List commits on a repository.\n", "https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Commits - List commits on a repository.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/commits/{ref}#0": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcommits_2F_7Bref_7D_230_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "master", "in": "path", "name": "ref", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "The name of the commit/branch/tag. Default: the repository’s default branch (usually ```master```)\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Commits - Get the SHA-1 of a commit reference.\n", "Users with read access can get the SHA-1 of a commit reference:\n", "https://developer.github.com/v3/repos/commits/#get-the-sha-1-of-a-commit-reference\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Commits - Get the SHA-1 of a commit reference.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/commits/{ref}/comments#0": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcommits_2F_7Bref_7D_2Fcomments_230_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "ref", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Comments - List comments for a single commit.\n", "https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Comments - List comments for a single commit.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "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.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Statuses - Get the combined status for a specific ref.\n", "Users with pull access can access a combined view of commit statuses for a given ref.\n", "https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Statuses - Get the combined status for a specific ref.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "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.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Statuses - List statuses for a specific ref.\n", "Users with pull access can view commit statuses for a given ref:\n", "https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Statuses - List statuses for a specific ref.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "sha", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Commits - Get a single commit.\n", "https://developer.github.com/v3/repos/commits/#get-a-single-commit\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Commits - Get a single commit.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/commits/{sha}#2": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcommits_2F_7Bsha_7D_232_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "sha", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The blob SHA of the file being replaced.\n" ] }, { "in": "query", "name": "verified", "required": false, "type": "boolean", "x-swgg-descriptionLineList": [ "Does GitHub consider the signature in this commit to be verified?\n" ] }, { "in": "query", "name": "reason", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The reason for ```verified``` value. Possible values and their meanings are enumerated in the table below.\n" ] }, { "in": "query", "name": "signature", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The signature that was extracted from the commit.\n" ] }, { "in": "query", "name": "payload", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The value that was signed.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Commits - Commit signature verification.\n", "https://developer.github.com/v3/repos/commits/#commit-signature-verification\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Commits - Commit signature verification.\n", "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" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "default": "master", "in": "path", "name": "sha", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "SHA or branch to start listing commits from. Default: the repository’s default branch (usually ```master```).\n" ] }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-commits-{sha}-comments.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Comments - Create a commit comment.\n", "https://developer.github.com/v3/repos/comments/#create-a-commit-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Comments - Create a commit comment.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/community/code_of_conduct": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcommunity_2Fcode_of_conduct_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.scarlet-witch-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-misc" ], "x-swgg-descriptionLineList": [ "Codes of Conduct - Get the contents of a repository's code of conduct.\n", "This method returns the contents of the repository's code of conduct file, if one is detected.\n", "https://developer.github.com/v3/codes_of_conduct/#get-the-contents-of-a-repositorys-code-of-conduct\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Codes of Conduct - Get the contents of a repository's code of conduct.\n", "x-swgg-tags0": "github-misc" } }, "/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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "base", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The name of the base branch that the head will be merged into.\n" ] }, { "in": "path", "name": "head", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The head to merge. This can be a branch name or a commit SHA1.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Commits - Compare two commits.\n", "https://developer.github.com/v3/repos/commits/#compare-two-commits\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Commits - Compare two commits.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "path", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The content path.\n" ] }, { "in": "query", "name": "message", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The commit message.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Contents - Delete a file.\n", "This method deletes a file in a repository\n", "https://developer.github.com/v3/repos/contents/#delete-a-file\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Contents - Delete a file.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "path", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "The content path.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Contents - Get contents.\n", "This method returns the contents of a file or directory in a repository.\n", "https://developer.github.com/v3/repos/contents/#get-contents\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Contents - Get contents.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "path", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The content path.\n" ] }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-contents-{path}.put.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Contents - Create a file.\n", "This method creates a new file in a repository\n", "https://developer.github.com/v3/repos/contents/#create-a-file\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Contents - Create a file.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/contents/{path}#2": { "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fcontents_2F_7Bpath_7D_232_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "path", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The content path.\n" ] }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-contents-{path}#2.put.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Contents - Update a file.\n", "This method updates a file in a repository\n", "https://developer.github.com/v3/repos/contents/#update-a-file\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Contents - Update a file.\n", "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" }, { "default": "application/vnd.github.nightshade-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "query", "name": "anon", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Set to ```1``` or ```true``` to include anonymous contributors in results.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repositories - List contributors.\n", "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.\n", "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.\n", "https://developer.github.com/v3/repos/#list-contributors\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repositories - List contributors.\n", "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" }, { "default": "application/vnd.github.ant-man-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Deployments - List deployments.\n", "Simple filtering of deployments is available via query parameters:\n", "https://developer.github.com/v3/repos/deployments/#list-deployments\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Deployments - List deployments.\n", "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" }, { "default": "application/vnd.github.ant-man-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-deployments.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Deployments - Create a deployment.\n", "Deployments offer a few configurable parameters with sane defaults.\n", "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.\n", "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```.\n", "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.\n", "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.\n", "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.\n", "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.\n", "Users with ```repo``` or ```repo_deployment``` scopes can create a deployment for a given ref:\n", "https://developer.github.com/v3/repos/deployments/#create-a-deployment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Deployments - Create a deployment.\n", "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" }, { "default": "application/vnd.github.ant-man-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Deployments - Get a single deployment.\n", "https://developer.github.com/v3/repos/deployments/#get-a-single-deployment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Deployments - Get a single deployment.\n", "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" }, { "default": "application/vnd.github.ant-man-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The deployment ID to list the statuses from.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Deployments - List deployment statuses.\n", "Users with pull access can view deployment statuses for a deployment:\n", "https://developer.github.com/v3/repos/deployments/#list-deployment-statuses\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Deployments - List deployment statuses.\n", "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" }, { "default": "application/vnd.github.ant-man-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Deployments - Create a deployment status.\n", "Users with push access can create deployment statuses for a given deployment:\n", "https://developer.github.com/v3/repos/deployments/#create-a-deployment-status\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Deployments - Create a deployment status.\n", "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" }, { "default": "application/vnd.github.ant-man-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The deployment ID to list the statuses from.\n" ] }, { "in": "path", "name": "status_id", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The deployment status ID.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Deployments - Get a single deployment status.\n", "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.\n", "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 ```\n", "Users with pull access can view a deployment status for a deployment:\n", "https://developer.github.com/v3/repos/deployments/#get-a-single-deployment-status\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Deployments - Get a single deployment status.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Downloads - List downloads for a repository.\n", "https://developer.github.com/v3/repos/downloads/#list-downloads-for-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Downloads - List downloads for a repository.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Downloads - Delete a download.\n", "https://developer.github.com/v3/repos/downloads/#delete-a-download\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Downloads - Delete a download.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Downloads - Get a single download.\n", "https://developer.github.com/v3/repos/downloads/#get-a-single-download\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Downloads - Get a single download.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/events": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fevents_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Events - List repository events.\n", "https://developer.github.com/v3/activity/events/#list-repository-events\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Events - List repository events.\n", "x-swgg-tags0": "github-activity" } }, "/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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Forks - List forks.\n", "https://developer.github.com/v3/repos/forks/#list-forks\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Forks - List forks.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-forks.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Forks - Create a fork.\n", "Create a fork for the authenticated user.\n", "https://developer.github.com/v3/repos/forks/#create-a-fork\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Forks - Create a fork.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/git/blobs": { "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Fblobs_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-git.repos-{owner}-{repo}-git-blobs.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Blobs - Create a Blob.\n", "https://developer.github.com/v3/git/blobs/#create-a-blob\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Blobs - Create a Blob.\n", "x-swgg-tags0": "github-git" } }, "/repos/{owner}/{repo}/git/blobs/{sha}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Fblobs_2F_7Bsha_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "sha", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Blobs - Get a Blob.\n", "https://developer.github.com/v3/git/blobs/#get-a-blob\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Blobs - Get a Blob.\n", "x-swgg-tags0": "github-git" } }, "/repos/{owner}/{repo}/git/commits": { "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Fcommits_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-git.repos-{owner}-{repo}-git-commits.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Commits - Create a Commit.\n", "https://developer.github.com/v3/git/commits/#create-a-commit\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Commits - Create a Commit.\n", "x-swgg-tags0": "github-git" } }, "/repos/{owner}/{repo}/git/commits/{sha}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Fcommits_2F_7Bsha_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "sha", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Commits - Get a Commit.\n", "https://developer.github.com/v3/git/commits/#get-a-commit\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Commits - Get a Commit.\n", "x-swgg-tags0": "github-git" } }, "/repos/{owner}/{repo}/git/commits/{sha}#2": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Fcommits_2F_7Bsha_7D_232_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "sha", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The SHA1 value to set this reference to\n" ] }, { "in": "query", "name": "verified", "required": false, "type": "boolean", "x-swgg-descriptionLineList": [ "Does GitHub consider the signature in this commit to be verified?\n" ] }, { "in": "query", "name": "reason", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The reason for ```verified``` value. Possible values and their meanings are enumerated in the table below.\n" ] }, { "in": "query", "name": "signature", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The signature that was extracted from the commit.\n" ] }, { "in": "query", "name": "payload", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The value that was signed.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Commits - Commit signature verification.\n", "https://developer.github.com/v3/git/commits/#commit-signature-verification\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Commits - Commit signature verification.\n", "x-swgg-tags0": "github-git" } }, "/repos/{owner}/{repo}/git/refs": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Frefs_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Refs - Get all References.\n", "https://developer.github.com/v3/git/refs/#get-all-references\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Refs - Get all References.\n", "x-swgg-tags0": "github-git" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Frefs_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Refs - Create a Reference.\n", "https://developer.github.com/v3/git/refs/#create-a-reference\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Refs - Create a Reference.\n", "x-swgg-tags0": "github-git" } }, "/repos/{owner}/{repo}/git/refs/{ref}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Frefs_2F_7Bref_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "ref", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Refs - Delete a Reference.\n", "https://developer.github.com/v3/git/refs/#delete-a-reference\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Refs - Delete a Reference.\n", "x-swgg-tags0": "github-git" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Frefs_2F_7Bref_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "ref", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The name of the fully qualified reference (ie: ```refs/heads/master```). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Refs - Get a Reference.\n", "https://developer.github.com/v3/git/refs/#get-a-reference\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Refs - Get a Reference.\n", "x-swgg-tags0": "github-git" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Frefs_2F_7Bref_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "ref", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Refs - Update a Reference.\n", "https://developer.github.com/v3/git/refs/#update-a-reference\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Refs - Update a Reference.\n", "x-swgg-tags0": "github-git" } }, "/repos/{owner}/{repo}/git/tags": { "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Ftags_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-git.repos-{owner}-{repo}-git-tags.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Tags - Create a Tag Object.\n", "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://developer.github.com/v3/git/refs/#create-a-reference) the ```refs/tags/[tag]``` reference. If you want to create a lightweight tag, you only have to [create](https://developer.github.com/v3/git/refs/#create-a-reference) the tag reference - this call would be unnecessary.\n", "https://developer.github.com/v3/git/tags/#create-a-tag-object\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Tags - Create a Tag Object.\n", "x-swgg-tags0": "github-git" } }, "/repos/{owner}/{repo}/git/tags/{sha}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Ftags_2F_7Bsha_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "sha", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Tags - Get a Tag.\n", "https://developer.github.com/v3/git/tags/#get-a-tag\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Tags - Get a Tag.\n", "x-swgg-tags0": "github-git" } }, "/repos/{owner}/{repo}/git/tags/{sha}#2": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Ftags_2F_7Bsha_7D_232_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "sha", "required": true, "type": "string" }, { "in": "query", "name": "verified", "required": false, "type": "boolean", "x-swgg-descriptionLineList": [ "Does GitHub consider the signature in this tag to be verified?\n" ] }, { "in": "query", "name": "reason", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The reason for ```verified``` value. Possible values and their meanings are enumerated in the table below.\n" ] }, { "in": "query", "name": "signature", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The signature that was extracted from the tag.\n" ] }, { "in": "query", "name": "payload", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The value that was signed.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Tags - Tag signature verification.\n", "https://developer.github.com/v3/git/tags/#tag-signature-verification\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Tags - Tag signature verification.\n", "x-swgg-tags0": "github-git" } }, "/repos/{owner}/{repo}/git/trees": { "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Ftrees_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-git.repos-{owner}-{repo}-git-trees.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Trees - Create a Tree.\n", "The tree creation API will take nested entries as well. If both a tree and a nested path modifying that tree are specified, it will overwrite the contents of that tree with the new path contents and write a new tree out.\n", "https://developer.github.com/v3/git/trees/#create-a-tree\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Trees - Create a Tree.\n", "x-swgg-tags0": "github-git" } }, "/repos/{owner}/{repo}/git/trees/{sha}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Ftrees_2F_7Bsha_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "sha", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Trees - Get a Tree.\n", "https://developer.github.com/v3/git/trees/#get-a-tree\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Trees - Get a Tree.\n", "x-swgg-tags0": "github-git" } }, "/repos/{owner}/{repo}/git/trees/{sha}#2": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fgit_2Ftrees_2F_7Bsha_7D_232_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "sha", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "SHA that pull request head must match to allow merge.\n" ] }, { "default": "1", "in": "query", "name": "recursive", "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-git" ], "x-swgg-descriptionLineList": [ "Git Trees - Get a Tree Recursively.\n", "https://developer.github.com/v3/git/trees/#get-a-tree-recursively\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Git Trees - Get a Tree Recursively.\n", "x-swgg-tags0": "github-git" } }, "/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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Webhooks - List hooks.\n", "https://developer.github.com/v3/repos/hooks/#list-hooks\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Webhooks - List hooks.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-hooks.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Webhooks - Create a hook.\n", "https://developer.github.com/v3/repos/hooks/#create-a-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Webhooks - Create a hook.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Webhooks - Delete a hook.\n", "https://developer.github.com/v3/repos/hooks/#delete-a-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Webhooks - Delete a hook.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Webhooks - Get single hook.\n", "https://developer.github.com/v3/repos/hooks/#get-single-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Webhooks - Get single hook.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-hooks-{id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Webhooks - Edit a hook.\n", "https://developer.github.com/v3/repos/hooks/#edit-a-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Webhooks - Edit a hook.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Webhooks - Ping a hook.\n", "This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook.\n", "https://developer.github.com/v3/repos/hooks/#ping-a-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Webhooks - Ping a hook.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Webhooks - Test a .\n", "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.\n", "https://developer.github.com/v3/repos/hooks/#test-a-push-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Webhooks - Test a .\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/import": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fimport_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.barred-rock-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-migration" ], "x-swgg-descriptionLineList": [ "Source Imports - Cancel an import.\n", "Stop an import for a repository.\n", "https://developer.github.com/v3/migration/source_imports/#cancel-an-import\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Source Imports - Cancel an import.\n", "x-swgg-tags0": "github-migration" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fimport_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.barred-rock-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-migration" ], "x-swgg-descriptionLineList": [ "Source Imports - Get import progress.\n", "View the progress of an import.\n", "https://developer.github.com/v3/migration/source_imports/#get-import-progress\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Source Imports - Get import progress.\n", "x-swgg-tags0": "github-migration" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fimport_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.barred-rock-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-migration.repos-{owner}-{repo}-import.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-migration" ], "x-swgg-descriptionLineList": [ "Source Imports - Update existing import.\n", "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API request. If no parameters are provided, the import will be restarted.\n", "https://developer.github.com/v3/migration/source_imports/#update-existing-import\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Source Imports - Update existing import.\n", "x-swgg-tags0": "github-migration" }, "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fimport_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.barred-rock-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-migration.repos-{owner}-{repo}-import.put.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-migration" ], "x-swgg-descriptionLineList": [ "Source Imports - Start an import.\n", "Start a source import to a GitHub repository using GitHub Importer.\n", "https://developer.github.com/v3/migration/source_imports/#start-an-import\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Source Imports - Start an import.\n", "x-swgg-tags0": "github-migration" } }, "/repos/{owner}/{repo}/import/authors": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fimport_2Fauthors_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.barred-rock-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "query", "name": "since", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the ```raw``` step.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-migration" ], "x-swgg-descriptionLineList": [ "Source Imports - Get commit authors.\n", "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username ```hubot``` into something like ```hubot <hubot@12341234-abab-fefe-8787-fedcba987654>```.\n", "This API method and the \"Map a commit author\" method allow you to provide correct Git author information.\n", "https://developer.github.com/v3/migration/source_imports/#get-commit-authors\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Source Imports - Get commit authors.\n", "x-swgg-tags0": "github-migration" } }, "/repos/{owner}/{repo}/import/authors/{author_id}": { "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fimport_2Fauthors_2F_7Bauthor_id_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.barred-rock-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "author_id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-migration.repos-{owner}-{repo}-import-authors-{author_id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-migration" ], "x-swgg-descriptionLineList": [ "Source Imports - Map a commit author.\n", "Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.\n", "https://developer.github.com/v3/migration/source_imports/#map-a-commit-author\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Source Imports - Map a commit author.\n", "x-swgg-tags0": "github-migration" } }, "/repos/{owner}/{repo}/import/large_files": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fimport_2Flarge_files_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.barred-rock-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-migration" ], "x-swgg-descriptionLineList": [ "Source Imports - Get large files.\n", "List files larger than 100MB found during the import\n", "https://developer.github.com/v3/migration/source_imports/#get-large-files\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Source Imports - Get large files.\n", "x-swgg-tags0": "github-migration" } }, "/repos/{owner}/{repo}/import/lfs": { "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fimport_2Flfs_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.barred-rock-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-migration.repos-{owner}-{repo}-import-lfs.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-migration" ], "x-swgg-descriptionLineList": [ "Source Imports - Set Git LFS preference.\n", "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/).\n", "https://developer.github.com/v3/migration/source_imports/#set-git-lfs-preference\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Source Imports - Set Git LFS preference.\n", "x-swgg-tags0": "github-migration" } }, "/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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Invitations - List invitations for a repository.\n", "https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Invitations - List invitations for a repository.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "invitation_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Invitations - Delete a repository invitation.\n", "https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Invitations - Delete a repository invitation.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "invitation_id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-invitations-{invitation_id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Invitations - Update a repository invitation.\n", "https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Invitations - Update a repository invitation.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/issues": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.sailor-v-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "query", "name": "assignee", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Can be the name of a user. Pass in ```none``` for issues with no assigned user, and ```*``` for issues assigned to any user.\n" ] }, { "in": "query", "name": "creator", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The user that created the issue.\n" ] }, { "in": "query", "name": "mentioned", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "A user that's mentioned in the issue.\n" ] }, { "in": "query", "name": "since", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issues - List issues for a repository.\n", "**Note**: In the past, pull requests and issues were more closely aligned than they are now. As far as the API is concerned, every pull request is an issue, but not every issue is a pull request.\n", "This endpoint may also return pull requests in the response. If an issue is a pull request, the object will include a ```pull_request``` key.\n", "https://developer.github.com/v3/issues/#list-issues-for-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issues - List issues for a repository.\n", "x-swgg-tags0": "github-issues" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.sailor-v-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-issues.repos-{owner}-{repo}-issues.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issues - Create an issue.\n", "Any user with pull access to a repository can create an issue.\n", "https://developer.github.com/v3/issues/#create-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issues - Create an issue.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/issues/comments": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2Fcomments_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.machine-man-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "query", "name": "direction", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Either ```asc``` or ```desc```. Ignored without the ```sort``` parameter.\n" ] }, { "in": "query", "name": "since", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Comments - List comments in a repository.\n", "https://developer.github.com/v3/issues/comments/#list-comments-in-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Comments - List comments in a repository.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/issues/comments/{id}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2Fcomments_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.machine-man-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Comments - Delete a comment.\n", "https://developer.github.com/v3/issues/comments/#delete-a-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Comments - Delete a comment.\n", "x-swgg-tags0": "github-issues" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2Fcomments_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.machine-man-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Comments - Get a single comment.\n", "https://developer.github.com/v3/issues/comments/#get-a-single-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Comments - Get a single comment.\n", "x-swgg-tags0": "github-issues" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2Fcomments_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.machine-man-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-issues.repos-{owner}-{repo}-issues-comments-{id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Comments - Edit a comment.\n", "https://developer.github.com/v3/issues/comments/#edit-a-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Comments - Edit a comment.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/issues/comments/{id}/reactions": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2Fcomments_2F_7Bid_7D_2Freactions_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "query", "name": "content", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Indicates which type of reaction to return.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-reactions" ], "x-swgg-descriptionLineList": [ "Reactions - List reactions for an issue comment.\n", "https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reactions - List reactions for an issue comment.\n", "x-swgg-tags0": "github-reactions" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2Fcomments_2F_7Bid_7D_2Freactions_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-reactions.repos-{owner}-{repo}-issues-comments-{id}-reactions.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-reactions" ], "x-swgg-descriptionLineList": [ "Reactions - Create reaction for an issue comment.\n", "https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reactions - Create reaction for an issue comment.\n", "x-swgg-tags0": "github-reactions" } }, "/repos/{owner}/{repo}/issues/events": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2Fevents_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Events - List issue events for a repository.\n", "Repository issue events have a different format than other events, as documented in the [Issue Events API](https://developer.github.com/v3/issues/events/).\n", "https://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Events - List issue events for a repository.\n", "x-swgg-tags0": "github-activity" } }, "/repos/{owner}/{repo}/issues/events#2": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2Fevents_232_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.machine-man-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Events - List events for a repository.\n", "https://developer.github.com/v3/issues/events/#list-events-for-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Events - List events for a repository.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/issues/events/{id}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2Fevents_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.machine-man-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Events - Get a single event.\n", "https://developer.github.com/v3/issues/events/#get-a-single-event\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Events - Get a single event.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/issues/{number}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.sailor-v-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issues - Get a single issue.\n", "**Note**: In the past, pull requests and issues were more closely aligned than they are now. As far as the API is concerned, every pull request is an issue, but not every issue is a pull request.\n", "This endpoint may also return pull requests in the response. If an issue is a pull request, the object will include a ```pull_request``` key.\n", "https://developer.github.com/v3/issues/#get-a-single-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issues - Get a single issue.\n", "x-swgg-tags0": "github-issues" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.sailor-v-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-issues.repos-{owner}-{repo}-issues-{number}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issues - Edit an issue.\n", "Issue owners and users with push access can edit an issue.\n", "https://developer.github.com/v3/issues/#edit-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issues - Edit an issue.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/issues/{number}/assignees": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_2Fassignees_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Assignees - Remove assignees from an issue.\n", "Removes one or more assignees from an issue.\n", "https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Assignees - Remove assignees from an issue.\n", "x-swgg-tags0": "github-issues" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_2Fassignees_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Assignees - Add assignees to an issue.\n", "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.\n", "https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Assignees - Add assignees to an issue.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/issues/{number}/comments": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_2Fcomments_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.machine-man-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "query", "name": "since", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Comments - List comments on an issue.\n", "https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Comments - List comments on an issue.\n", "x-swgg-tags0": "github-issues" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_2Fcomments_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.machine-man-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-issues.repos-{owner}-{repo}-issues-{number}-comments.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Comments - Create a comment.\n", "https://developer.github.com/v3/issues/comments/#create-a-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Comments - Create a comment.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/issues/{number}/events": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_2Fevents_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.machine-man-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Events - List events for an issue.\n", "https://developer.github.com/v3/issues/events/#list-events-for-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Events - List events for an issue.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/issues/{number}/labels": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_2Flabels_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Labels - Remove all labels from an issue.\n", "https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Labels - Remove all labels from an issue.\n", "x-swgg-tags0": "github-issues" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_2Flabels_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Labels - List labels on an issue.\n", "https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Labels - List labels on an issue.\n", "x-swgg-tags0": "github-issues" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_2Flabels_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Labels - Add labels to an issue.\n", "https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Labels - Add labels to an issue.\n", "x-swgg-tags0": "github-issues" }, "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_2Flabels_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Labels - Replace all labels for an issue.\n", "https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Labels - Replace all labels for an issue.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/issues/{number}/labels/{name}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_2Flabels_2F_7Bname_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "path", "name": "name", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "The new Git author name.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Labels - Remove a label from an issue.\n", "https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Labels - Remove a label from an issue.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/issues/{number}/lock": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_2Flock_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.sailor-v-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issues - Unlock an issue.\n", "Users with push access can unlock an issue's conversation.\n", "https://developer.github.com/v3/issues/#unlock-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issues - Unlock an issue.\n", "x-swgg-tags0": "github-issues" }, "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_2Flock_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.sailor-v-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issues - Lock an issue.\n", "**Note:** You can now add a reason when you lock an issue. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-10-lock-reason-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header: ```application/vnd.github.sailor-v-preview+json ```\n", "**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).\n", "Users with push access can lock an issue or pull request's conversation.\n", "https://developer.github.com/v3/issues/#lock-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issues - Lock an issue.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/issues/{number}/reactions": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_2Freactions_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "query", "name": "content", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Indicates which type of reaction to return.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-reactions" ], "x-swgg-descriptionLineList": [ "Reactions - List reactions for an issue.\n", "https://developer.github.com/v3/reactions/#list-reactions-for-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reactions - List reactions for an issue.\n", "x-swgg-tags0": "github-reactions" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_2Freactions_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-reactions.repos-{owner}-{repo}-issues-{number}-reactions.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-reactions" ], "x-swgg-descriptionLineList": [ "Reactions - Create reaction for an issue.\n", "https://developer.github.com/v3/reactions/#create-reaction-for-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reactions - Create reaction for an issue.\n", "x-swgg-tags0": "github-reactions" } }, "/repos/{owner}/{repo}/issues/{number}/timeline": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fissues_2F_7Bnumber_7D_2Ftimeline_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.mockingbird-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Timeline - List events for an issue.\n", "https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Timeline - List events for an issue.\n", "x-swgg-tags0": "github-issues" } }, "/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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Deploy Keys - List deploy keys.\n", "https://developer.github.com/v3/repos/keys/#list-deploy-keys\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Deploy Keys - List deploy keys.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-keys.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Deploy Keys - Add a new deploy key.\n", "https://developer.github.com/v3/repos/keys/#add-a-new-deploy-key\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Deploy Keys - Add a new deploy key.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Deploy Keys - Remove a deploy key.\n", "https://developer.github.com/v3/repos/keys/#remove-a-deploy-key\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Deploy Keys - Remove a deploy key.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Deploy Keys - Get a deploy key.\n", "https://developer.github.com/v3/repos/keys/#get-a-deploy-key\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Deploy Keys - Get a deploy key.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/labels": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Flabels_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Labels - List all labels for this repository.\n", "https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Labels - List all labels for this repository.\n", "x-swgg-tags0": "github-issues" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Flabels_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-issues.repos-{owner}-{repo}-labels.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Labels - Create a label.\n", "https://developer.github.com/v3/issues/labels/#create-a-label\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Labels - Create a label.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/labels/{name}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Flabels_2F_7Bname_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "name", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Labels - Delete a label.\n", "https://developer.github.com/v3/issues/labels/#delete-a-label\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Labels - Delete a label.\n", "x-swgg-tags0": "github-issues" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Flabels_2F_7Bname_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "name", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The name of the label.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Labels - Get a single label.\n", "https://developer.github.com/v3/issues/labels/#get-a-single-label\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Labels - Get a single label.\n", "x-swgg-tags0": "github-issues" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Flabels_2F_7Bname_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "name", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "The name of the label.\n" ] }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-issues.repos-{owner}-{repo}-labels-{name}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Labels - Update a label.\n", "https://developer.github.com/v3/issues/labels/#update-a-label\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Labels - Update a label.\n", "x-swgg-tags0": "github-issues" } }, "/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" }, { "default": "application/vnd.github.nightshade-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repositories - List languages.\n", "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.\n", "https://developer.github.com/v3/repos/#list-languages\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repositories - List languages.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/license": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Flicense_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-misc" ], "x-swgg-descriptionLineList": [ "Licenses - Get the contents of a repository's license.\n", "This method returns the contents of the repository's license file, if one is detected.\n", "https://developer.github.com/v3/licenses/#get-the-contents-of-a-repositorys-license\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Licenses - Get the contents of a repository's license.\n", "x-swgg-tags0": "github-misc" } }, "/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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-merges.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Merging - Perform a merge.\n", "https://developer.github.com/v3/repos/merging/#perform-a-merge\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Merging - Perform a merge.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/milestones": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fmilestones_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Milestones - List milestones for a repository.\n", "https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Milestones - List milestones for a repository.\n", "x-swgg-tags0": "github-issues" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fmilestones_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-issues.repos-{owner}-{repo}-milestones.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Milestones - Create a milestone.\n", "https://developer.github.com/v3/issues/milestones/#create-a-milestone\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Milestones - Create a milestone.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/milestones/{number}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fmilestones_2F_7Bnumber_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Milestones - Delete a milestone.\n", "https://developer.github.com/v3/issues/milestones/#delete-a-milestone\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Milestones - Delete a milestone.\n", "x-swgg-tags0": "github-issues" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fmilestones_2F_7Bnumber_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Milestones - Get a single milestone.\n", "https://developer.github.com/v3/issues/milestones/#get-a-single-milestone\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Milestones - Get a single milestone.\n", "x-swgg-tags0": "github-issues" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fmilestones_2F_7Bnumber_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-issues.repos-{owner}-{repo}-milestones-{number}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Milestones - Update a milestone.\n", "https://developer.github.com/v3/issues/milestones/#update-a-milestone\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Milestones - Update a milestone.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/milestones/{number}/labels": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fmilestones_2F_7Bnumber_7D_2Flabels_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-issues" ], "x-swgg-descriptionLineList": [ "Issue Labels - Get labels for every issue in a milestone.\n", "https://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Issue Labels - Get labels for every issue in a milestone.\n", "x-swgg-tags0": "github-issues" } }, "/repos/{owner}/{repo}/notifications": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fnotifications_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "query", "name": "before", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Notifications - List your notifications in a repository.\n", "List all notifications for the current user.\n", "https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Notifications - List your notifications in a repository.\n", "x-swgg-tags0": "github-activity" }, "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fnotifications_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Notifications - Mark notifications as read in a repository.\n", "Marking all notifications in a repository as \"read\" removes them from the [default view on GitHub](https://github.com/notifications).\n", "https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Notifications - Mark notifications as read in a repository.\n", "x-swgg-tags0": "github-activity" } }, "/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" }, { "default": "application/vnd.github.mister-fantastic-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Pages - Get information about a Pages site.\n", "https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pages - Get information about a Pages site.\n", "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" }, { "default": "application/vnd.github.mister-fantastic-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Pages - List Pages builds.\n", "https://developer.github.com/v3/repos/pages/#list-pages-builds\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pages - List Pages builds.\n", "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" }, { "default": "application/vnd.github.mister-fantastic-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Pages - Request a page build.\n", "https://developer.github.com/v3/repos/pages/#request-a-page-build\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pages - Request a page build.\n", "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" }, { "default": "application/vnd.github.mister-fantastic-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Pages - List latest Pages build.\n", "https://developer.github.com/v3/repos/pages/#list-latest-pages-build\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pages - List latest Pages build.\n", "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" }, { "default": "application/vnd.github.mister-fantastic-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Pages - List a specific Pages build.\n", "https://developer.github.com/v3/repos/pages/#list-a-specific-pages-build\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pages - List a specific Pages build.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/pre-receive-hooks": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpre-receive-hooks_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Pre-receive Hooks - List pre-receive hooks.\n", "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.\n", "https://developer.github.com/v3/repos/pre_receive_hooks/#list-pre-receive-hooks\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Pre-receive Hooks - List pre-receive hooks.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/pre-receive-hooks/{id}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpre-receive-hooks_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Pre-receive Hooks - Remove enforcement overrides for a pre-receive hook.\n", "Deletes any overridden enforcement on this repository for the specified hook.\n", "https://developer.github.com/v3/repos/pre_receive_hooks/#remove-enforcement-overrides-for-a-pre-receive-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Pre-receive Hooks - Remove enforcement overrides for a pre-receive hook.\n", "x-swgg-tags0": "github-repos" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpre-receive-hooks_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Pre-receive Hooks - Get a single pre-receive hook.\n", "https://developer.github.com/v3/repos/pre_receive_hooks/#get-a-single-pre-receive-hook\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Pre-receive Hooks - Get a single pre-receive hook.\n", "x-swgg-tags0": "github-repos" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpre-receive-hooks_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.eye-scream-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Pre-receive Hooks - Update pre-receive hook enforcement.\n", "For pre-receive hooks which are allowed to be configured at the repo level, you can set ```enforcement```\n", "https://developer.github.com/v3/repos/pre_receive_hooks/#update-pre-receive-hook-enforcement\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Pre-receive Hooks - Update pre-receive hook enforcement.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/projects": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fprojects_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Projects - List repository projects.\n", "https://developer.github.com/v3/projects/#list-repository-projects\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Projects - List repository projects.\n", "x-swgg-tags0": "github-projects" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fprojects_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.inertia-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-projects.repos-{owner}-{repo}-projects.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-projects" ], "x-swgg-descriptionLineList": [ "Projects - Create a repository project.\n", "https://developer.github.com/v3/projects/#create-a-repository-project\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Projects - Create a repository project.\n", "x-swgg-tags0": "github-projects" } }, "/repos/{owner}/{repo}/pulls": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "query", "name": "head", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Filter pulls by head user and branch name in the format of ```user:ref-name```. Example: ```github:new-script-format```.\n" ] }, { "in": "query", "name": "base", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Filter pulls by base branch name. Example: ```gh-pages```.\n" ] }, { "default": "asc", "in": "query", "name": "direction", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The direction of the sort. Can be either ```asc``` or ```desc```. Default: ```desc``` when sort is ```created``` or sort is not specified, otherwise ```asc```.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Pull Requests - List pull requests.\n", "https://developer.github.com/v3/pulls/#list-pull-requests\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pull Requests - List pull requests.\n", "x-swgg-tags0": "github-pulls" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-pulls.repos-{owner}-{repo}-pulls.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Pull Requests - Create a pull request.\n", "https://developer.github.com/v3/pulls/#create-a-pull-request\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pull Requests - Create a pull request.\n", "x-swgg-tags0": "github-pulls" } }, "/repos/{owner}/{repo}/pulls/comments": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2Fcomments_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "query", "name": "direction", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Can be either ```asc``` or ```desc```. Ignored without ```sort``` parameter.\n" ] }, { "in": "query", "name": "since", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "This is a timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```. Only returns comments ```updated``` at or after this time.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Review Comments - List comments in a repository.\n", "https://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Review Comments - List comments in a repository.\n", "x-swgg-tags0": "github-pulls" } }, "/repos/{owner}/{repo}/pulls/comments/{id}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2Fcomments_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Review Comments - Delete a comment.\n", "https://developer.github.com/v3/pulls/comments/#delete-a-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Review Comments - Delete a comment.\n", "x-swgg-tags0": "github-pulls" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2Fcomments_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Review Comments - Get a single comment.\n", "https://developer.github.com/v3/pulls/comments/#get-a-single-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Review Comments - Get a single comment.\n", "x-swgg-tags0": "github-pulls" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2Fcomments_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-pulls.repos-{owner}-{repo}-pulls-comments-{id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Review Comments - Edit a comment.\n", "https://developer.github.com/v3/pulls/comments/#edit-a-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Review Comments - Edit a comment.\n", "x-swgg-tags0": "github-pulls" } }, "/repos/{owner}/{repo}/pulls/comments/{id}/reactions": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2Fcomments_2F_7Bid_7D_2Freactions_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "query", "name": "content", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Indicates which type of reaction to return.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-reactions" ], "x-swgg-descriptionLineList": [ "Reactions - List reactions for a pull request review comment.\n", "https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reactions - List reactions for a pull request review comment.\n", "x-swgg-tags0": "github-reactions" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2Fcomments_2F_7Bid_7D_2Freactions_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-reactions.repos-{owner}-{repo}-pulls-comments-{id}-reactions.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-reactions" ], "x-swgg-descriptionLineList": [ "Reactions - Create reaction for a pull request review comment.\n", "https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reactions - Create reaction for a pull request review comment.\n", "x-swgg-tags0": "github-reactions" } }, "/repos/{owner}/{repo}/pulls/{number}": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Pull Requests - Get a single pull request.\n", "https://developer.github.com/v3/pulls/#get-a-single-pull-request\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pull Requests - Get a single pull request.\n", "x-swgg-tags0": "github-pulls" }, "patch": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-pulls.repos-{owner}-{repo}-pulls-{number}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Pull Requests - Update a pull request.\n", "https://developer.github.com/v3/pulls/#update-a-pull-request\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pull Requests - Update a pull request.\n", "x-swgg-tags0": "github-pulls" } }, "/repos/{owner}/{repo}/pulls/{number}/comments": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Fcomments_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "query", "name": "direction", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Can be either ```asc``` or ```desc```. Ignored without ```sort``` parameter.\n" ] }, { "in": "query", "name": "since", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "This is a timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```. Only returns comments ```updated``` at or after this time.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Review Comments - List comments on a pull request.\n", "https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Review Comments - List comments on a pull request.\n", "x-swgg-tags0": "github-pulls" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Fcomments_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.squirrel-girl-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-pulls.repos-{owner}-{repo}-pulls-{number}-comments.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Review Comments - Create a comment.\n", "https://developer.github.com/v3/pulls/comments/#create-a-comment\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Review Comments - Create a comment.\n", "x-swgg-tags0": "github-pulls" } }, "/repos/{owner}/{repo}/pulls/{number}/commits": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Fcommits_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Pull Requests - List commits on a pull request.\n", "**Note:** The response includes a maximum of 250 commits. To receive a complete commit list for pull requests with more than 250 commits, use the [Commit List API](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository).\n", "https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pull Requests - List commits on a pull request.\n", "x-swgg-tags0": "github-pulls" } }, "/repos/{owner}/{repo}/pulls/{number}/files": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Ffiles_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Pull Requests - List pull requests files.\n", "https://developer.github.com/v3/pulls/#list-pull-requests-files\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pull Requests - List pull requests files.\n", "x-swgg-tags0": "github-pulls" } }, "/repos/{owner}/{repo}/pulls/{number}/merge": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Fmerge_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Pull Requests - Get if a pull request has been merged.\n", "https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pull Requests - Get if a pull request has been merged.\n", "x-swgg-tags0": "github-pulls" }, "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Fmerge_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-pulls.repos-{owner}-{repo}-pulls-{number}-merge.put.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Pull Requests - Merge a pull request (Merge Button).\n", "https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Pull Requests - Merge a pull request (Merge Button).\n", "x-swgg-tags0": "github-pulls" } }, "/repos/{owner}/{repo}/pulls/{number}/requested_reviewers": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Frequested_reviewers_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Review Requests - Delete a review request.\n", "https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Review Requests - Delete a review request.\n", "x-swgg-tags0": "github-pulls" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Frequested_reviewers_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Review Requests - List review requests.\n", "https://developer.github.com/v3/pulls/review_requests/#list-review-requests\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Review Requests - List review requests.\n", "x-swgg-tags0": "github-pulls" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Frequested_reviewers_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Review Requests - Create a review request.\n", "https://developer.github.com/v3/pulls/review_requests/#create-a-review-request\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Review Requests - Create a review request.\n", "x-swgg-tags0": "github-pulls" } }, "/repos/{owner}/{repo}/pulls/{number}/reviews": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Freviews_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Reviews - List reviews on a pull request.\n", "https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reviews - List reviews on a pull request.\n", "x-swgg-tags0": "github-pulls" }, "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Freviews_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-pulls.repos-{owner}-{repo}-pulls-{number}-reviews.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Reviews - Create a pull request review.\n", "https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reviews - Create a pull request review.\n", "x-swgg-tags0": "github-pulls" } }, "/repos/{owner}/{repo}/pulls/{number}/reviews/{id}": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Freviews_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Reviews - Delete a pending review.\n", "https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reviews - Delete a pending review.\n", "x-swgg-tags0": "github-pulls" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Freviews_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Reviews - Get a single review.\n", "https://developer.github.com/v3/pulls/reviews/#get-a-single-review\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reviews - Get a single review.\n", "x-swgg-tags0": "github-pulls" } }, "/repos/{owner}/{repo}/pulls/{number}/reviews/{id}/comments": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Freviews_2F_7Bid_7D_2Fcomments_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Reviews - Get comments for a single review.\n", "https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reviews - Get comments for a single review.\n", "x-swgg-tags0": "github-pulls" } }, "/repos/{owner}/{repo}/pulls/{number}/reviews/{id}/dismissals": { "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Freviews_2F_7Bid_7D_2Fdismissals_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-pulls.repos-{owner}-{repo}-pulls-{number}-reviews-{id}-dismissals.put.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Reviews - Dismiss a pull request review.\n", "https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reviews - Dismiss a pull request review.\n", "x-swgg-tags0": "github-pulls" } }, "/repos/{owner}/{repo}/pulls/{number}/reviews/{id}/events": { "post": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fpulls_2F_7Bnumber_7D_2Freviews_2F_7Bid_7D_2Fevents_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "number", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-pulls.repos-{owner}-{repo}-pulls-{number}-reviews-{id}-events.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-pulls" ], "x-swgg-descriptionLineList": [ "Reviews - Submit a pull request review.\n", "https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Reviews - Submit a pull request review.\n", "x-swgg-tags0": "github-pulls" } }, "/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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Contents - Get the README.\n", "This method returns the preferred README for a repository.\n", "https://developer.github.com/v3/repos/contents/#get-the-readme\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Contents - Get the README.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Releases - List releases for a repository.\n", "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).\n", "Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.\n", "https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Releases - List releases for a repository.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-releases.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Releases - Create a release.\n", "Users with push access to the repository can create a release.\n", "https://developer.github.com/v3/repos/releases/#create-a-release\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Releases - Create a release.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Releases - Delete a release asset.\n", "https://developer.github.com/v3/repos/releases/#delete-a-release-asset\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Releases - Delete a release asset.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Releases - Get a single release asset.\n", "https://developer.github.com/v3/repos/releases/#get-a-single-release-asset\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Releases - Get a single release asset.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-releases-assets-{id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Releases - Edit a release asset.\n", "Users with push access to the repository can edit a release asset.\n", "https://developer.github.com/v3/repos/releases/#edit-a-release-asset\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Releases - Edit a release asset.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Releases - Get the latest release.\n", "View the latest published full release for the repository. Draft releases and prereleases are not returned by this endpoint.\n", "https://developer.github.com/v3/repos/releases/#get-the-latest-release\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Releases - Get the latest release.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "tag", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Releases - Get a release by tag name.\n", "Get a published release with the specified tag.\n", "https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Releases - Get a release by tag name.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Releases - Delete a release.\n", "Users with push access to the repository can delete a release.\n", "https://developer.github.com/v3/repos/releases/#delete-a-release\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Releases - Delete a release.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Releases - Get a single release.\n", "https://developer.github.com/v3/repos/releases/#get-a-single-release\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Releases - Get a single release.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-releases-{id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Releases - Edit a release.\n", "Users with push access to the repository can edit a release.\n", "https://developer.github.com/v3/repos/releases/#edit-a-release\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Releases - Edit a release.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Releases - List assets for a release.\n", "https://developer.github.com/v3/repos/releases/#list-assets-for-a-release\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Releases - List assets for a release.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/stargazers": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fstargazers_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Starring - List Stargazers.\n", "https://developer.github.com/v3/activity/starring/#list-stargazers\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Starring - List Stargazers.\n", "x-swgg-tags0": "github-activity" } }, "/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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Statistics - Get the number of additions and deletions per week.\n", "https://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Statistics - Get the number of additions and deletions per week.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Statistics - Get the last year of commit activity data.\n", "Returns the last year of commit activity grouped by week. The ```days``` array is a group of commits per day, starting on ```Sunday```.\n", "https://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Statistics - Get the last year of commit activity data.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Statistics - Get contributors list with additions, deletions, and commit counts.\n", "https://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Statistics - Get contributors list with additions, deletions, and commit counts.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Statistics - Get the weekly commit count for the repository owner and everyone else.\n", "https://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repository-owner-and-everyone-else\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Statistics - Get the weekly commit count for the repository owner and everyone else.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Statistics - Get the number of commits per hour in each day.\n", "https://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Statistics - Get the number of commits per hour in each day.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "sha", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-statuses-{sha}.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Statuses - Create a status.\n", "Users with push access can create commit statuses for a given ref:\n", "https://developer.github.com/v3/repos/statuses/#create-a-status\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Statuses - Create a status.\n", "x-swgg-tags0": "github-repos" } }, "/repos/{owner}/{repo}/subscribers": { "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fsubscribers_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Watching - List watchers.\n", "https://developer.github.com/v3/activity/watching/#list-watchers\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Watching - List watchers.\n", "x-swgg-tags0": "github-activity" } }, "/repos/{owner}/{repo}/subscription": { "delete": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fsubscription_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Watching - Delete a Repository Subscription.\n", "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://developer.github.com/v3/activity/watching/#set-a-repository-subscription).\n", "https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Watching - Delete a Repository Subscription.\n", "x-swgg-tags0": "github-activity" }, "get": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fsubscription_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Watching - Get a Repository Subscription.\n", "https://developer.github.com/v3/activity/watching/#get-a-repository-subscription\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Watching - Get a Repository Subscription.\n", "x-swgg-tags0": "github-activity" }, "put": { "operationId": "_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_2Fsubscription_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-activity.repos-{owner}-{repo}-subscription.put.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Watching - Set a Repository Subscription.\n", "https://developer.github.com/v3/activity/watching/#set-a-repository-subscription\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Watching - Set a Repository Subscription.\n", "x-swgg-tags0": "github-activity" } }, "/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" }, { "default": "application/vnd.github.nightshade-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repositories - List tags.\n", "https://developer.github.com/v3/repos/#list-tags\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repositories - List tags.\n", "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" }, { "default": "application/vnd.github.nightshade-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repositories - List teams.\n", "**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 ```\n", "**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).\n", "https://developer.github.com/v3/repos/#list-teams\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repositories - List teams.\n", "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" }, { "default": "application/vnd.github.nightshade-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repositories - List all topics for a repository.\n", "**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 ```\n", "**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).\n", "https://developer.github.com/v3/repos/#list-all-topics-for-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repositories - List all topics for a repository.\n", "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" }, { "default": "application/vnd.github.nightshade-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repositories - Replace all topics for a repository.\n", "**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 ```\n", "**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).\n", "https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repositories - Replace all topics for a repository.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Traffic - Clones.\n", "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.\n", "https://developer.github.com/v3/repos/traffic/#clones\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Traffic - Clones.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Traffic - List paths.\n", "Get the top 10 popular contents over the last 14 days.\n", "https://developer.github.com/v3/repos/traffic/#list-paths\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Traffic - List paths.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Traffic - List referrers.\n", "Get the top 10 referrers over the last 14 days.\n", "https://developer.github.com/v3/repos/traffic/#list-referrers\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Traffic - List referrers.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Traffic - Views.\n", "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.\n", "https://developer.github.com/v3/repos/traffic/#views\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Traffic - Views.\n", "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" }, { "default": "application/vnd.github.nightshade-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.repos-{owner}-{repo}-transfer.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repositories - Transfer a repository.\n", "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/).\n", "**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 ```\n", "**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).\n", "https://developer.github.com/v3/repos/#transfer-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repositories - Transfer a repository.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "path", "name": "archive_format", "required": true, "type": "string" }, { "default": "master", "in": "path", "name": "ref", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "A valid Git reference. Default: the repository’s default branch (usually ```master```)\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Contents - Get archive link.\n", "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.\n", "Note: For private repositories, these links are temporary and expire after five minutes.\n", "https://developer.github.com/v3/repos/contents/#get-archive-link\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Contents - Get archive link.\n", "x-swgg-tags0": "github-repos" } }, "/repositories": { "get": { "operationId": "_2Frepositories_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.nightshade-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "query", "name": "since", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The integer ID of the last Repository that you've seen.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repositories - List all public repositories.\n", "This provides a dump of every public repository, in the order that they were created.\n", "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.\n", "https://developer.github.com/v3/repos/#list-all-public-repositories\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repositories - List all public repositories.\n", "x-swgg-tags0": "github-repos" } }, "/scim/v2/organizations/{organization}/Users": { "get": { "operationId": "_2Fscim_2Fv2_2Forganizations_2F_7Borganization_7D_2FUsers_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.cloud-9-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "organization", "required": true, "type": "string" }, { "in": "query", "name": "startIndex", "required": false, "type": "integer", "x-swgg-descriptionLineList": [ "Used for pagination: the index of the first result to return\n" ] }, { "in": "query", "name": "count", "required": false, "type": "integer", "x-swgg-descriptionLineList": [ "Used for pagination: the number of results to return\n" ] }, { "in": "query", "name": "filter", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Only ```eq``` type filters are supported\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-scim" ], "x-swgg-descriptionLineList": [ "SCIM - Get a list of provisioned identities.\n", "https://developer.github.com/v3/scim/#get-a-list-of-provisioned-identities\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "SCIM - Get a list of provisioned identities.\n", "x-swgg-tags0": "github-scim" }, "post": { "operationId": "_2Fscim_2Fv2_2Forganizations_2F_7Borganization_7D_2FUsers_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.cloud-9-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "organization", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-scim" ], "x-swgg-descriptionLineList": [ "SCIM - Provision and invite users.\n", "Provision organization membership for and send activation emails to a list of email addresses.\n", "https://developer.github.com/v3/scim/#provision-and-invite-users\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "SCIM - Provision and invite users.\n", "x-swgg-tags0": "github-scim" } }, "/scim/v2/organizations/{organization}/Users/{id}": { "delete": { "operationId": "_2Fscim_2Fv2_2Forganizations_2F_7Borganization_7D_2FUsers_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.cloud-9-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "organization", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-scim" ], "x-swgg-descriptionLineList": [ "SCIM - Remove a user from the organization.\n", "https://developer.github.com/v3/scim/#remove-a-user-from-the-organization\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "SCIM - Remove a user from the organization.\n", "x-swgg-tags0": "github-scim" }, "get": { "operationId": "_2Fscim_2Fv2_2Forganizations_2F_7Borganization_7D_2FUsers_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.cloud-9-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "organization", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "Identifier generated by the GitHub SCIM endpoint\n" ] }, { "in": "query", "name": "userName", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The username for the user\n" ] }, { "in": "query", "name": "name.givenName", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "User first name\n" ] }, { "in": "query", "name": "name.lastName", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "User last name\n" ] }, { "default": [ null ], "in": "query", "items": { "type": "string" }, "name": "emails", "required": false, "type": "array", "x-swgg-descriptionLineList": [ "List of user emails\n" ] }, { "in": "query", "name": "externalId", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "External identifier (generated by the SAML SSO provider)\n" ] }, { "in": "query", "name": "active", "required": false, "type": "boolean", "x-swgg-descriptionLineList": [ "Used to indicate whether the identity is active (true) or should be deprovisioned (false)\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-scim" ], "x-swgg-descriptionLineList": [ "SCIM - Supported SCIM User attributes.\n", "Name Type Description ```userName``` ```string``` The username for the user ```name.givenName``` ```string``` User first name ```name.lastName``` ```string``` User last name ```emails``` ```array``` List of user emails ```externalId``` ```string``` External identifier (generated by the SAML SSO provider) ```id``` ```string``` Identifier generated by the GitHub SCIM endpoint ```active``` ```boolean``` Used to indicate whether the identity is active (true) or should be deprovisioned (false)\n", "Note: Endpoints for the SCIM API are case sensitive: the first letter in the ```Users``` endpoint must be capitalized. For example:\n", "https://developer.github.com/v3/scim/#supported-scim-user-attributes\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "SCIM - Supported SCIM User attributes.\n", "x-swgg-tags0": "github-scim" }, "patch": { "operationId": "_2Fscim_2Fv2_2Forganizations_2F_7Borganization_7D_2FUsers_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.cloud-9-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "organization", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-scim" ], "x-swgg-descriptionLineList": [ "SCIM - Update a user attribute.\n", "https://developer.github.com/v3/scim/#update-a-user-attribute\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "SCIM - Update a user attribute.\n", "x-swgg-tags0": "github-scim" }, "put": { "operationId": "_2Fscim_2Fv2_2Forganizations_2F_7Borganization_7D_2FUsers_2F_7Bid_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.cloud-9-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "organization", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-scim" ], "x-swgg-descriptionLineList": [ "SCIM - Update a provisioned organization membership.\n", "https://developer.github.com/v3/scim/#update-a-provisioned-organization-membership\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "SCIM - Update a provisioned organization membership.\n", "x-swgg-tags0": "github-scim" } }, "/scim/v2/organizations/{organization}/Users/{id}#2": { "get": { "operationId": "_2Fscim_2Fv2_2Forganizations_2F_7Borganization_7D_2FUsers_2F_7Bid_7D_232_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.cloud-9-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "organization", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-scim" ], "x-swgg-descriptionLineList": [ "SCIM - Get provisioning details for a single user.\n", "https://developer.github.com/v3/scim/#get-provisioning-details-for-a-single-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "SCIM - Get provisioning details for a single user.\n", "x-swgg-tags0": "github-scim" } }, "/search/code": { "get": { "operationId": "_2Fsearch_2Fcode_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.mercy-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "query", "name": "q", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The search terms.\n" ] }, { "in": "query", "name": "sort", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The sort field. Can only be ```indexed```, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: results are sorted by best match.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-search" ], "x-swgg-descriptionLineList": [ "Search - Search code.\n", "Find file contents via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n", "https://developer.github.com/v3/search/#search-code\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Search - Search code.\n", "x-swgg-tags0": "github-search" } }, "/search/commits": { "get": { "operationId": "_2Fsearch_2Fcommits_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.mercy-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "query", "name": "q", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The search terms.\n" ] }, { "in": "query", "name": "sort", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The sort field. Can be ```author-date``` or ```committer-date```. Default: results are sorted by best match.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-search" ], "x-swgg-descriptionLineList": [ "Search - Search commits.\n", "The Commit Search API 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/2017-01-05-commit-search-api/) for full details.\n", "To access the API you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header: ``` application/vnd.github.cloak-preview ```\n", "Find commits via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n", "https://developer.github.com/v3/search/#search-commits\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Search - Search commits.\n", "x-swgg-tags0": "github-search" } }, "/search/issues": { "get": { "operationId": "_2Fsearch_2Fissues_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.mercy-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "query", "name": "q", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The search terms.\n" ] }, { "in": "query", "name": "sort", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The sort field. Can be ```comments```, ```created```, or ```updated```. Default: results are sorted by best match.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-search" ], "x-swgg-descriptionLineList": [ "Search - Search issues.\n", "Find issues by state and keyword. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n", "https://developer.github.com/v3/search/#search-issues\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Search - Search issues.\n", "x-swgg-tags0": "github-search" } }, "/search/repositories": { "get": { "operationId": "_2Fsearch_2Frepositories_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.mercy-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "query", "name": "q", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The search keywords, as well as any qualifiers.\n" ] }, { "in": "query", "name": "sort", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The sort field. One of ```stars```, ```forks```, or ```updated```. Default: results are sorted by best match.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-search" ], "x-swgg-descriptionLineList": [ "Search - Search repositories.\n", "Find repositories via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n", "https://developer.github.com/v3/search/#search-repositories\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Search - Search repositories.\n", "x-swgg-tags0": "github-search" } }, "/search/topics": { "get": { "operationId": "_2Fsearch_2Ftopics_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.mercy-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "query", "name": "q", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The search terms.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-search" ], "x-swgg-descriptionLineList": [ "Search - Search topics.\n", "**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 ```\n", "Find topics via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n", "https://developer.github.com/v3/search/#search-topics\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Search - Search topics.\n", "x-swgg-tags0": "github-search" } }, "/search/users": { "get": { "operationId": "_2Fsearch_2Fusers_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.mercy-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "query", "name": "q", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The search terms.\n" ] }, { "in": "query", "name": "sort", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The sort field. Can be ```followers```, ```repositories```, or ```joined```. Default: results are sorted by best match.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-search" ], "x-swgg-descriptionLineList": [ "Search - Search users.\n", "Find users via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n", "https://developer.github.com/v3/search/#search-users\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Search - Search users.\n", "x-swgg-tags0": "github-search" } }, "/setup/api/configcheck": { "get": { "operationId": "_2Fsetup_2Fapi_2Fconfigcheck_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Management Console - Check configuration status.\n", "This endpoint allows you to check the status of the most recent configuration process:\n", "https://developer.github.com/v3/enterprise-admin/management_console/#check-configuration-status\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Management Console - Check configuration status.\n", "x-swgg-tags0": "github-enterprise" } }, "/setup/api/configure": { "post": { "operationId": "_2Fsetup_2Fapi_2Fconfigure_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Management Console - Start a configuration process.\n", "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:\n", "https://developer.github.com/v3/enterprise-admin/management_console/#start-a-configuration-process\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Management Console - Start a configuration process.\n", "x-swgg-tags0": "github-enterprise" } }, "/setup/api/maintenance": { "get": { "operationId": "_2Fsetup_2Fapi_2Fmaintenance_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Management Console - Check maintenance status.\n", "Check your installation's maintenance status:\n", "https://developer.github.com/v3/enterprise-admin/management_console/#check-maintenance-status\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Management Console - Check maintenance status.\n", "x-swgg-tags0": "github-enterprise" }, "post": { "operationId": "_2Fsetup_2Fapi_2Fmaintenance_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-enterprise.setup-api-maintenance.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Management Console - Enable or disable maintenance mode.\n", "https://developer.github.com/v3/enterprise-admin/management_console/#enable-or-disable-maintenance-mode\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Management Console - Enable or disable maintenance mode.\n", "x-swgg-tags0": "github-enterprise" } }, "/setup/api/settings": { "get": { "operationId": "_2Fsetup_2Fapi_2Fsettings_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Management Console - Retrieve settings.\n", "https://developer.github.com/v3/enterprise-admin/management_console/#retrieve-settings\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Management Console - Retrieve settings.\n", "x-swgg-tags0": "github-enterprise" }, "put": { "operationId": "_2Fsetup_2Fapi_2Fsettings_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-enterprise.setup-api-settings.put.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Management Console - Modify settings.\n", "https://developer.github.com/v3/enterprise-admin/management_console/#modify-settings\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Management Console - Modify settings.\n", "x-swgg-tags0": "github-enterprise" } }, "/setup/api/settings/authorized-keys": { "delete": { "operationId": "_2Fsetup_2Fapi_2Fsettings_2Fauthorized-keys_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "query", "name": "authorized_key", "required": true, "type": "string", "x-swgg-descriptionLineList": [ "**Required**. The path to the public SSH key.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Management Console - Remove an authorized SSH key.\n", "https://developer.github.com/v3/enterprise-admin/management_console/#remove-an-authorized-ssh-key\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Management Console - Remove an authorized SSH key.\n", "x-swgg-tags0": "github-enterprise" }, "get": { "operationId": "_2Fsetup_2Fapi_2Fsettings_2Fauthorized-keys_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Management Console - Retrieve authorized SSH keys.\n", "https://developer.github.com/v3/enterprise-admin/management_console/#retrieve-authorized-ssh-keys\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Management Console - Retrieve authorized SSH keys.\n", "x-swgg-tags0": "github-enterprise" }, "post": { "operationId": "_2Fsetup_2Fapi_2Fsettings_2Fauthorized-keys_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-enterprise.setup-api-settings-authorized-keys.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Management Console - Add a new authorized SSH key.\n", "https://developer.github.com/v3/enterprise-admin/management_console/#add-a-new-authorized-ssh-key\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Management Console - Add a new authorized SSH key.\n", "x-swgg-tags0": "github-enterprise" } }, "/setup/api/start": { "post": { "operationId": "_2Fsetup_2Fapi_2Fstart_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-enterprise.setup-api-start.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Management Console - Upload a license for the first time.\n", "When you boot a virtual machine for the first time, you can use the following endpoint to upload a license:\n", "https://developer.github.com/v3/enterprise-admin/management_console/#upload-a-license-for-the-first-time\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Management Console - Upload a license for the first time.\n", "x-swgg-tags0": "github-enterprise" } }, "/setup/api/upgrade": { "post": { "operationId": "_2Fsetup_2Fapi_2Fupgrade_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-enterprise.setup-api-upgrade.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Management Console - Upgrade a license.\n", "This API upgrades your license and also triggers the configuration process:\n", "https://developer.github.com/v3/enterprise-admin/management_console/#upgrade-a-license\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Management Console - Upgrade a license.\n", "x-swgg-tags0": "github-enterprise" } }, "/staff/indexing_jobs": { "post": { "operationId": "_2Fstaff_2Findexing_jobs_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-enterprise.staff-indexing_jobs.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-enterprise" ], "x-swgg-descriptionLineList": [ "Search Indexing - Queue an indexing job.\n", "https://developer.github.com/v3/enterprise-admin/search_indexing/#queue-an-indexing-job\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Search Indexing - Queue an indexing job.\n", "x-swgg-tags0": "github-enterprise" } }, "/teams/{id}": { "delete": { "operationId": "_2Fteams_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - Delete team.\n", "**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 ```\n", "**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).\n", "To delete a team, the authenticated user must be a team maintainer or an owner of the org associated with the team.\n", "If you are an organization owner and you pass the ```hellcat-preview``` media type, deleting a parent team will delete all of its child teams as well.\n", "https://developer.github.com/v3/orgs/teams/#delete-team\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - Delete team.\n", "x-swgg-tags0": "github-orgs" }, "get": { "operationId": "_2Fteams_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - Get team.\n", "**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 ```\n", "**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).\n", "https://developer.github.com/v3/orgs/teams/#get-team\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - Get team.\n", "x-swgg-tags0": "github-orgs" }, "patch": { "operationId": "_2Fteams_2F_7Bid_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-orgs.teams-{id}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - Edit team.\n", "**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 ```\n", "**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).\n", "To edit a team, the authenticated user must either be an owner of the org that the team is associated with, or a maintainer of the team.\n", "https://developer.github.com/v3/orgs/teams/#edit-team\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - Edit team.\n", "x-swgg-tags0": "github-orgs" } }, "/teams/{id}/invitations": { "get": { "operationId": "_2Fteams_2F_7Bid_7D_2Finvitations_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - List pending team invitations.\n", "**Note:** You can now use the API to invite users to a GitHub organization. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-01-25-organization-invitation-api-preview) for full details. To access this feature, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` header: ```application/vnd.github.dazzler-preview+json ```\n", "**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).\n", "The return hash contains a ```role``` field which refers to the Organization Invitation role and will be one of the following values: ```direct_member```, ```admin```, ```billing_manager```, ```hiring_manager```, or ```reinstate```. If the invitee is not a GitHub member, the ```login``` field in the return hash will be ```null```.\n", "https://developer.github.com/v3/orgs/teams/#list-pending-team-invitations\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - List pending team invitations.\n", "x-swgg-tags0": "github-orgs" } }, "/teams/{id}/members": { "get": { "operationId": "_2Fteams_2F_7Bid_7D_2Fmembers_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - List team members.\n", "**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 ```\n", "**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).\n", "If you pass the ```hellcat-preview``` media type, team members will include the members of child teams.\n", "To list members in a team, the team must be visible to the authenticated user.\n", "https://developer.github.com/v3/orgs/teams/#list-team-members\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - List team members.\n", "x-swgg-tags0": "github-orgs" } }, "/teams/{id}/members/{username}": { "delete": { "operationId": "_2Fteams_2F_7Bid_7D_2Fmembers_2F_7Busername_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - Remove team member.\n", "Deprecation notice\n", "The \"Remove team member\" API (described below) is deprecated.\n", "We recommend using the [Remove team membership API](https://developer.github.com/v3/orgs/teams/#remove-team-membership) instead. It allows you to remove both active and pending memberships.\n", "To remove a user from a team, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. NOTE: This does not delete the user, it just removes them from the team.\n", "https://developer.github.com/v3/orgs/teams/#remove-team-member\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - Remove team member.\n", "x-swgg-tags0": "github-orgs" }, "get": { "operationId": "_2Fteams_2F_7Bid_7D_2Fmembers_2F_7Busername_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - Get team member.\n", "Deprecation notice\n", "The \"Get team member\" API (described below) is deprecated.\n", "We recommend using the [Get team membership API](https://developer.github.com/v3/orgs/teams/#get-team-membership) instead. It allows you to get both active and pending memberships.\n", "To list members in a team, the team must be visible to the authenticated user.\n", "https://developer.github.com/v3/orgs/teams/#get-team-member\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - Get team member.\n", "x-swgg-tags0": "github-orgs" }, "put": { "operationId": "_2Fteams_2F_7Bid_7D_2Fmembers_2F_7Busername_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - Add team member.\n", "Deprecation notice\n", "The \"Add team member\" API (described below) is deprecated.\n", "We recommend using the [Add team membership API](https://developer.github.com/v3/orgs/teams/#add-or-update-team-membership) instead. It allows you to invite new organization members to your teams.\n", "To add a user to a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with, and the user being added must already be a member of at least one other team on the same organization.\n", "https://developer.github.com/v3/orgs/teams/#add-team-member\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - Add team member.\n", "x-swgg-tags0": "github-orgs" } }, "/teams/{id}/memberships/{username}": { "delete": { "operationId": "_2Fteams_2F_7Bid_7D_2Fmemberships_2F_7Busername_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - Remove team membership.\n", "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. NOTE: This does not delete the user, it just removes their membership from the team.\n", "https://developer.github.com/v3/orgs/teams/#remove-team-membership\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - Remove team membership.\n", "x-swgg-tags0": "github-orgs" }, "get": { "operationId": "_2Fteams_2F_7Bid_7D_2Fmemberships_2F_7Busername_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - Get team membership.\n", "**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 ```\n", "**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).\n", "If you pass the ```hellcat-preview``` media type, team members will include the members of child teams.\n", "To get a user's membership with a team, the team must be visible to the authenticated user.\n", "https://developer.github.com/v3/orgs/teams/#get-team-membership\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - Get team membership.\n", "x-swgg-tags0": "github-orgs" }, "put": { "operationId": "_2Fteams_2F_7Bid_7D_2Fmemberships_2F_7Busername_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - Add or update team membership.\n", "If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a maintainer of the team.\n", "If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n", "If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a maintainer of the team.\n", "https://developer.github.com/v3/orgs/teams/#add-or-update-team-membership\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - Add or update team membership.\n", "x-swgg-tags0": "github-orgs" } }, "/teams/{id}/repos": { "get": { "operationId": "_2Fteams_2F_7Bid_7D_2Frepos_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - List team repos.\n", "**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 ```\n", "**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).\n", "**Note**: If you pass the ```hellcat-preview``` media type, the response will include any repositories inherited through a parent team.\n", "https://developer.github.com/v3/orgs/teams/#list-team-repos\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - List team repos.\n", "x-swgg-tags0": "github-orgs" } }, "/teams/{id}/repos/{org}/{repo}#0": { "put": { "operationId": "_2Fteams_2F_7Bid_7D_2Frepos_2F_7Borg_7D_2F_7Brepo_7D_230_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-orgs.teams-{id}-repos-{org}-{repo}.put.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - Add or update team repository.\n", "**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 ```\n", "**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).\n", "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. Also, the repository must be owned by the organization, or a direct fork of a repository owned by the organization.\n", "https://developer.github.com/v3/orgs/teams/#add-or-update-team-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - Add or update team repository.\n", "x-swgg-tags0": "github-orgs" } }, "/teams/{id}/repos/{owner}/{repo}#1": { "delete": { "operationId": "_2Fteams_2F_7Bid_7D_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_231_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - Remove team repository.\n", "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.\n", "https://developer.github.com/v3/orgs/teams/#remove-team-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - Remove team repository.\n", "x-swgg-tags0": "github-orgs" }, "get": { "operationId": "_2Fteams_2F_7Bid_7D_2Frepos_2F_7Bowner_7D_2F_7Brepo_7D_231_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - Check if a team manages a repository.\n", "**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 ```\n", "**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).\n", "**Note**: If you pass the ```hellcat-preview``` media type, repositories inherited through a parent team will be checked as well.\n", "https://developer.github.com/v3/orgs/teams/#check-if-a-team-manages-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - Check if a team manages a repository.\n", "x-swgg-tags0": "github-orgs" } }, "/teams/{id}/teams": { "get": { "operationId": "_2Fteams_2F_7Bid_7D_2Fteams_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - List child teams.\n", "**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 ```\n", "**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).\n", "At this time, the ```hellcat-preview``` media type is required to use this endpoint.\n", "https://developer.github.com/v3/orgs/teams/#list-child-teams\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - List child teams.\n", "x-swgg-tags0": "github-orgs" } }, "/upload_url/repos/{owner}/{repo}/releases/{id}/assets": { "post": { "operationId": "_2Fupload_url_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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" }, { "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.\n" ] }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.upload_url-repos-{owner}-{repo}-releases-{id}-assets.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Releases - Upload a release asset.\n", "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.\n", "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.\n", "https://developer.github.com/v3/repos/releases/#upload-a-release-asset\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Releases - Upload a release asset.\n", "x-swgg-tags0": "github-repos" } }, "/user": { "get": { "operationId": "_2Fuser_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "Users - Get the authenticated user.\n", "https://developer.github.com/v3/users/#get-the-authenticated-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Users - Get the authenticated user.\n", "x-swgg-tags0": "github-users" }, "patch": { "operationId": "_2Fuser_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-users.user.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "Users - Update the authenticated user.\n", "https://developer.github.com/v3/users/#update-the-authenticated-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Users - Update the authenticated user.\n", "x-swgg-tags0": "github-users" } }, "/user/blocks": { "get": { "operationId": "_2Fuser_2Fblocks_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.giant-sentry-fist-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "Block Another User - List blocked users.\n", "List the users you've blocked on your personal account.\n", "https://developer.github.com/v3/users/blocking/#list-blocked-users\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Block Another User - List blocked users.\n", "x-swgg-tags0": "github-users" } }, "/user/blocks/{username}": { "delete": { "operationId": "_2Fuser_2Fblocks_2F_7Busername_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.giant-sentry-fist-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "Block Another User - Unblock a user.\n", "https://developer.github.com/v3/users/blocking/#unblock-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Block Another User - Unblock a user.\n", "x-swgg-tags0": "github-users" }, "get": { "operationId": "_2Fuser_2Fblocks_2F_7Busername_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.giant-sentry-fist-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "Block Another User - Check whether you've blocked a user.\n", "https://developer.github.com/v3/users/blocking/#check-whether-youve-blocked-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Block Another User - Check whether you've blocked a user.\n", "x-swgg-tags0": "github-users" }, "put": { "operationId": "_2Fuser_2Fblocks_2F_7Busername_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.giant-sentry-fist-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "Block Another User - Block a user.\n", "https://developer.github.com/v3/users/blocking/#block-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Block Another User - Block a user.\n", "x-swgg-tags0": "github-users" } }, "/user/email/visibility": { "patch": { "operationId": "_2Fuser_2Femail_2Fvisibility_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Emails - Toggle primary email visibility.\n", "https://developer.github.com/v3/users/emails/#toggle-primary-email-visibility\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Emails - Toggle primary email visibility.\n", "x-swgg-tags0": "github-users" } }, "/user/emails": { "delete": { "operationId": "_2Fuser_2Femails_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Emails - Delete email address(es).\n", "https://developer.github.com/v3/users/emails/#delete-email-addresses\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Emails - Delete email address(es).\n", "x-swgg-tags0": "github-users" }, "get": { "operationId": "_2Fuser_2Femails_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Emails - List email addresses for a user.\n", "https://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Emails - List email addresses for a user.\n", "x-swgg-tags0": "github-users" }, "post": { "operationId": "_2Fuser_2Femails_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Emails - Add email address(es).\n", "https://developer.github.com/v3/users/emails/#add-email-addresses\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Emails - Add email address(es).\n", "x-swgg-tags0": "github-users" } }, "/user/following/{username}": { "delete": { "operationId": "_2Fuser_2Ffollowing_2F_7Busername_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Followers - Unfollow a user.\n", "https://developer.github.com/v3/users/followers/#unfollow-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Followers - Unfollow a user.\n", "x-swgg-tags0": "github-users" }, "get": { "operationId": "_2Fuser_2Ffollowing_2F_7Busername_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Followers - Check if you are following a user.\n", "https://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Followers - Check if you are following a user.\n", "x-swgg-tags0": "github-users" }, "put": { "operationId": "_2Fuser_2Ffollowing_2F_7Busername_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Followers - Follow a user.\n", "https://developer.github.com/v3/users/followers/#follow-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Followers - Follow a user.\n", "x-swgg-tags0": "github-users" } }, "/user/gpg_keys": { "get": { "operationId": "_2Fuser_2Fgpg_keys_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User GPG Keys - List your GPG keys.\n", "https://developer.github.com/v3/users/gpg_keys/#list-your-gpg-keys\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User GPG Keys - List your GPG keys.\n", "x-swgg-tags0": "github-users" }, "post": { "operationId": "_2Fuser_2Fgpg_keys_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User GPG Keys - Create a GPG key.\n", "Creates a GPG key. Requires that you are authenticated via Basic Auth, or OAuth with at least ```write:gpg_key``` [scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/).\n", "https://developer.github.com/v3/users/gpg_keys/#create-a-gpg-key\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User GPG Keys - Create a GPG key.\n", "x-swgg-tags0": "github-users" } }, "/user/gpg_keys/{id}": { "delete": { "operationId": "_2Fuser_2Fgpg_keys_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User GPG Keys - Delete a GPG key.\n", "Removes a GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least ```admin:gpg_key``` [scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/).\n", "https://developer.github.com/v3/users/gpg_keys/#delete-a-gpg-key\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User GPG Keys - Delete a GPG key.\n", "x-swgg-tags0": "github-users" }, "get": { "operationId": "_2Fuser_2Fgpg_keys_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User GPG Keys - Get a single GPG key.\n", "View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least ```read:gpg_key``` [scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/).\n", "https://developer.github.com/v3/users/gpg_keys/#get-a-single-gpg-key\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User GPG Keys - Get a single GPG key.\n", "x-swgg-tags0": "github-users" } }, "/user/installations": { "get": { "operationId": "_2Fuser_2Finstallations_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "default": "...", "in": "query", "name": "access_token", "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-apps" ], "x-swgg-descriptionLineList": [ "GitHub Apps - List installations for user.\n", "List installations that are accessible to the authenticated user.\n", "https://developer.github.com/v3/apps/#list-installations-for-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "GitHub Apps - List installations for user.\n", "x-swgg-tags0": "github-apps" } }, "/user/installations/{installation_id}/repositories": { "get": { "operationId": "_2Fuser_2Finstallations_2F_7Binstallation_id_7D_2Frepositories_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "installation_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-apps" ], "x-swgg-descriptionLineList": [ "Installations - List repositories accessible to the user for an installation.\n", "List repositories that are accessible to the authenticated user for an installation.\n", "https://developer.github.com/v3/apps/installations/#list-repositories-accessible-to-the-user-for-an-installation\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Installations - List repositories accessible to the user for an installation.\n", "x-swgg-tags0": "github-apps" } }, "/user/installations/{installation_id}/repositories/{repository_id}": { "delete": { "operationId": "_2Fuser_2Finstallations_2F_7Binstallation_id_7D_2Frepositories_2F_7Brepository_id_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "installation_id", "required": true, "type": "string" }, { "in": "path", "name": "repository_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-apps" ], "x-swgg-descriptionLineList": [ "Installations - Remove repository from installation.\n", "Remove a single repository from an installation.\n", "https://developer.github.com/v3/apps/installations/#remove-repository-from-installation\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Installations - Remove repository from installation.\n", "x-swgg-tags0": "github-apps" }, "put": { "operationId": "_2Fuser_2Finstallations_2F_7Binstallation_id_7D_2Frepositories_2F_7Brepository_id_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "installation_id", "required": true, "type": "string" }, { "in": "path", "name": "repository_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-apps" ], "x-swgg-descriptionLineList": [ "Installations - Add repository to installation.\n", "Add a single repository to an installation.\n", "https://developer.github.com/v3/apps/installations/#add-repository-to-installation\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Installations - Add repository to installation.\n", "x-swgg-tags0": "github-apps" } }, "/user/keys": { "get": { "operationId": "_2Fuser_2Fkeys_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Public Keys - List your public keys.\n", "https://developer.github.com/v3/users/keys/#list-your-public-keys\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Public Keys - List your public keys.\n", "x-swgg-tags0": "github-users" }, "post": { "operationId": "_2Fuser_2Fkeys_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Public Keys - Create a public key.\n", "Creates a public key. Requires that you are authenticated via Basic Auth, or OAuth with at least ```write:public_key``` [scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/).\n", "https://developer.github.com/v3/users/keys/#create-a-public-key\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Public Keys - Create a public key.\n", "x-swgg-tags0": "github-users" } }, "/user/keys/{id}": { "delete": { "operationId": "_2Fuser_2Fkeys_2F_7Bid_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Public Keys - Delete a public key.\n", "Removes a public key. Requires that you are authenticated via Basic Auth or via OAuth with at least ```admin:public_key``` [scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/).\n", "https://developer.github.com/v3/users/keys/#delete-a-public-key\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Public Keys - Delete a public key.\n", "x-swgg-tags0": "github-users" }, "get": { "operationId": "_2Fuser_2Fkeys_2F_7Bid_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Public Keys - Get a single public key.\n", "View extended details for a single public key. Requires that you are authenticated via Basic Auth or via OAuth with at least ```read:public_key``` [scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/).\n", "https://developer.github.com/v3/users/keys/#get-a-single-public-key\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Public Keys - Get a single public key.\n", "x-swgg-tags0": "github-users" } }, "/user/marketplace_purchases": { "get": { "operationId": "_2Fuser_2Fmarketplace_purchases_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.valkyrie-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-apps" ], "x-swgg-descriptionLineList": [ "GitHub Marketplace - Get a user's Marketplace purchases.\n", "https://developer.github.com/v3/apps/marketplace/#get-a-users-marketplace-purchases\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "GitHub Marketplace - Get a user's Marketplace purchases.\n", "x-swgg-tags0": "github-apps" } }, "/user/memberships/orgs": { "get": { "operationId": "_2Fuser_2Fmemberships_2Forgs_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "query", "name": "state", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "Indicates the state of the memberships to return. Can be either ```active``` or ```pending```. If not specified, the API returns both active and pending memberships.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - List your organization memberships.\n", "https://developer.github.com/v3/orgs/members/#list-your-organization-memberships\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - List your organization memberships.\n", "x-swgg-tags0": "github-orgs" } }, "/user/memberships/orgs/{org}": { "get": { "operationId": "_2Fuser_2Fmemberships_2Forgs_2F_7Borg_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - Get your organization membership.\n", "https://developer.github.com/v3/orgs/members/#get-your-organization-membership\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - Get your organization membership.\n", "x-swgg-tags0": "github-orgs" }, "patch": { "operationId": "_2Fuser_2Fmemberships_2Forgs_2F_7Borg_7D_20PATCH", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.dazzler-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-orgs.user-memberships-orgs-{org}.patch.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Members - Edit your organization membership.\n", "https://developer.github.com/v3/orgs/members/#edit-your-organization-membership\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Members - Edit your organization membership.\n", "x-swgg-tags0": "github-orgs" } }, "/user/orgs": { "get": { "operationId": "_2Fuser_2Forgs_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organizations - List your organizations.\n", "List organizations for the authenticated user. OAuth scope requirements\n", "This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with ```read:org``` scope, you can publicize your organization membership with ```user``` scope, etc.). Therefore, this API requires at least ```user``` or ```read:org``` scope. OAuth requests with insufficient scope receive a ```403 Forbidden``` response.\n", "https://developer.github.com/v3/orgs/#list-your-organizations\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organizations - List your organizations.\n", "x-swgg-tags0": "github-orgs" } }, "/user/public_emails": { "get": { "operationId": "_2Fuser_2Fpublic_emails_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Emails - List public email addresses for a user.\n", "https://developer.github.com/v3/users/emails/#list-public-email-addresses-for-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Emails - List public email addresses for a user.\n", "x-swgg-tags0": "github-users" } }, "/user/repos": { "get": { "operationId": "_2Fuser_2Frepos_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.nightshade-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repositories - List your repositories.\n", "List repositories that are accessible to the authenticated user.\n", "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.\n", "https://developer.github.com/v3/repos/#list-your-repositories\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repositories - List your repositories.\n", "x-swgg-tags0": "github-repos" }, "post": { "operationId": "_2Fuser_2Frepos_20POST", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.nightshade-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/github-repos.user-repos.post.body" } } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repositories - Create.\n", "Create a new repository for the authenticated user.\n", "**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).\n", "https://developer.github.com/v3/repos/#create\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repositories - Create.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Invitations - List a user's repository invitations.\n", "https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Invitations - List a user's repository invitations.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "invitation_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Invitations - Decline a repository invitation.\n", "https://developer.github.com/v3/repos/invitations/#decline-a-repository-invitation\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Invitations - Decline a repository invitation.\n", "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" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "invitation_id", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repository Invitations - Accept a repository invitation.\n", "https://developer.github.com/v3/repos/invitations/#accept-a-repository-invitation\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repository Invitations - Accept a repository invitation.\n", "x-swgg-tags0": "github-repos" } }, "/user/starred/{owner}/{repo}": { "delete": { "operationId": "_2Fuser_2Fstarred_2F_7Bowner_7D_2F_7Brepo_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Starring - Unstar a repository.\n", "Requires for the user to be authenticated.\n", "https://developer.github.com/v3/activity/starring/#unstar-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Starring - Unstar a repository.\n", "x-swgg-tags0": "github-activity" }, "get": { "operationId": "_2Fuser_2Fstarred_2F_7Bowner_7D_2F_7Brepo_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Starring - Check if you are starring a repository.\n", "Requires for the user to be authenticated.\n", "https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Starring - Check if you are starring a repository.\n", "x-swgg-tags0": "github-activity" }, "put": { "operationId": "_2Fuser_2Fstarred_2F_7Bowner_7D_2F_7Brepo_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Starring - Star a repository.\n", "Requires for the user to be authenticated.\n", "https://developer.github.com/v3/activity/starring/#star-a-repository\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Starring - Star a repository.\n", "x-swgg-tags0": "github-activity" } }, "/user/subscriptions/{owner}/{repo}": { "delete": { "operationId": "_2Fuser_2Fsubscriptions_2F_7Bowner_7D_2F_7Brepo_7D_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Watching - Stop watching a repository (LEGACY).\n", "Requires for the user to be authenticated.\n", "https://developer.github.com/v3/activity/watching/#stop-watching-a-repository-legacy\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Watching - Stop watching a repository (LEGACY).\n", "x-swgg-tags0": "github-activity" }, "get": { "operationId": "_2Fuser_2Fsubscriptions_2F_7Bowner_7D_2F_7Brepo_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Watching - Check if you are watching a repository (LEGACY).\n", "Requires for the user to be authenticated.\n", "https://developer.github.com/v3/activity/watching/#check-if-you-are-watching-a-repository-legacy\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Watching - Check if you are watching a repository (LEGACY).\n", "x-swgg-tags0": "github-activity" }, "put": { "operationId": "_2Fuser_2Fsubscriptions_2F_7Bowner_7D_2F_7Brepo_7D_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "owner", "required": true, "type": "string" }, { "in": "path", "name": "repo", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Watching - Watch a repository (LEGACY).\n", "Requires the user to be authenticated.\n", "https://developer.github.com/v3/activity/watching/#watch-a-repository-legacy\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Watching - Watch a repository (LEGACY).\n", "x-swgg-tags0": "github-activity" } }, "/user/teams": { "get": { "operationId": "_2Fuser_2Fteams_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.hellcat-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organization Teams - List user teams.\n", "**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 ```\n", "**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).\n", "List all of the teams across all of the organizations to which the authenticated user belongs. This method requires ```user```, ```repo```, or ```read:org``` [scope](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/) when authenticating via [OAuth](https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/).\n", "https://developer.github.com/v3/orgs/teams/#list-user-teams\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organization Teams - List user teams.\n", "x-swgg-tags0": "github-orgs" } }, "/users": { "get": { "operationId": "_2Fusers_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "query", "name": "since", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "The integer ID of the last User that you've seen.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "Users - Get all users.\n", "Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts.\n", "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 users.\n", "https://developer.github.com/v3/users/#get-all-users\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Users - Get all users.\n", "x-swgg-tags0": "github-users" } }, "/users/{username}": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "Users - Get a single user.\n", "https://developer.github.com/v3/users/#get-a-single-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Users - Get a single user.\n", "x-swgg-tags0": "github-users" } }, "/users/{username}/events": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Fevents_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Events - List events performed by a user.\n", "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.\n", "https://developer.github.com/v3/activity/events/#list-events-performed-by-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Events - List events performed by a user.\n", "x-swgg-tags0": "github-activity" } }, "/users/{username}/events/orgs/{org}": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Fevents_2Forgs_2F_7Borg_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" }, { "in": "path", "name": "org", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Events - List events for an organization.\n", "This is the user's organization dashboard. You must be authenticated as the user to view this.\n", "https://developer.github.com/v3/activity/events/#list-events-for-an-organization\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Events - List events for an organization.\n", "x-swgg-tags0": "github-activity" } }, "/users/{username}/events/public": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Fevents_2Fpublic_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Events - List public events performed by a user.\n", "https://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Events - List public events performed by a user.\n", "x-swgg-tags0": "github-activity" } }, "/users/{username}/followers": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Ffollowers_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Followers - List followers of a user.\n", "List a user's followers:\n", "https://developer.github.com/v3/users/followers/#list-followers-of-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Followers - List followers of a user.\n", "x-swgg-tags0": "github-users" } }, "/users/{username}/following": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Ffollowing_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Followers - List users followed by another user.\n", "List who a user is following:\n", "https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Followers - List users followed by another user.\n", "x-swgg-tags0": "github-users" } }, "/users/{username}/following/{target_user}": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Ffollowing_2F_7Btarget_user_7D_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" }, { "in": "path", "name": "target_user", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Followers - Check if one user follows another.\n", "https://developer.github.com/v3/users/followers/#check-if-one-user-follows-another\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Followers - Check if one user follows another.\n", "x-swgg-tags0": "github-users" } }, "/users/{username}/gists": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Fgists_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" }, { "in": "query", "name": "since", "required": false, "type": "string", "x-swgg-descriptionLineList": [ "A timestamp in ISO 8601 format: ```YYYY-MM-DDTHH:MM:SSZ```. Only gists updated at or after this time are returned.\n" ] } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-gists" ], "x-swgg-descriptionLineList": [ "Gists - List a user's gists.\n", "List public gists for the specified user:\n", "https://developer.github.com/v3/gists/#list-a-users-gists\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Gists - List a user's gists.\n", "x-swgg-tags0": "github-gists" } }, "/users/{username}/gpg_keys": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Fgpg_keys_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User GPG Keys - List GPG keys for a user.\n", "https://developer.github.com/v3/users/gpg_keys/#list-gpg-keys-for-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User GPG Keys - List GPG keys for a user.\n", "x-swgg-tags0": "github-users" } }, "/users/{username}/keys": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Fkeys_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Public Keys - List public keys for a user.\n", "https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Public Keys - List public keys for a user.\n", "x-swgg-tags0": "github-users" } }, "/users/{username}/orgs": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Forgs_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-orgs" ], "x-swgg-descriptionLineList": [ "Organizations - List user organizations.\n", "List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n", "This method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List your organizations](https://developer.github.com/v3/orgs/#list-your-organizations) API instead.\n", "https://developer.github.com/v3/orgs/#list-user-organizations\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Organizations - List user organizations.\n", "x-swgg-tags0": "github-orgs" } }, "/users/{username}/received_events": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Freceived_events_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Events - List events that a user has received.\n", "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.\n", "https://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Events - List events that a user has received.\n", "x-swgg-tags0": "github-activity" } }, "/users/{username}/received_events/public": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Freceived_events_2Fpublic_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Events - List public events that a user has received.\n", "https://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Events - List public events that a user has received.\n", "x-swgg-tags0": "github-activity" } }, "/users/{username}/repos": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Frepos_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github.nightshade-preview+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": true, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-repos" ], "x-swgg-descriptionLineList": [ "Repositories - List user repositories.\n", "List public repositories for the specified user.\n", "https://developer.github.com/v3/repos/#list-user-repositories\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Repositories - List user repositories.\n", "x-swgg-tags0": "github-repos" } }, "/users/{username}/site_admin": { "delete": { "operationId": "_2Fusers_2F_7Busername_7D_2Fsite_admin_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Administration - Demote a site administrator to an ordinary user.\n", "https://developer.github.com/v3/users/administration/#demote-a-site-administrator-to-an-ordinary-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Administration - Demote a site administrator to an ordinary user.\n", "x-swgg-tags0": "github-users" }, "put": { "operationId": "_2Fusers_2F_7Busername_7D_2Fsite_admin_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Administration - Promote an ordinary user to a site administrator.\n", "https://developer.github.com/v3/users/administration/#promote-an-ordinary-user-to-a-site-administrator\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Administration - Promote an ordinary user to a site administrator.\n", "x-swgg-tags0": "github-users" } }, "/users/{username}/starred": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Fstarred_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Starring - List repositories being starred.\n", "List repositories being starred by a user.\n", "https://developer.github.com/v3/activity/starring/#list-repositories-being-starred\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Starring - List repositories being starred.\n", "x-swgg-tags0": "github-activity" } }, "/users/{username}/subscriptions": { "get": { "operationId": "_2Fusers_2F_7Busername_7D_2Fsubscriptions_20GET", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-activity" ], "x-swgg-descriptionLineList": [ "Watching - List repositories being watched.\n", "List repositories being watched by a user.\n", "https://developer.github.com/v3/activity/watching/#list-repositories-being-watched\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "Watching - List repositories being watched.\n", "x-swgg-tags0": "github-activity" } }, "/users/{username}/suspended": { "delete": { "operationId": "_2Fusers_2F_7Busername_7D_2Fsuspended_20DELETE", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Administration - Unsuspend a user.\n", "If your GitHub Enterprise appliance has [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a ```403``` response. Users managed by an external account cannot be unsuspended via the API.\n", "https://developer.github.com/v3/users/administration/#unsuspend-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Administration - Unsuspend a user.\n", "x-swgg-tags0": "github-users" }, "put": { "operationId": "_2Fusers_2F_7Busername_7D_2Fsuspended_20PUT", "parameters": [ { "$ref": "#/parameters/github-all.key" }, { "$ref": "#/parameters/github-all.user-agent" }, { "default": "application/vnd.github+json", "description": "accept header\n\n[https://developer.github.com/v3/media](https://developer.github.com/v3/media)", "in": "header", "name": "accept", "required": false, "type": "string" }, { "in": "path", "name": "username", "required": true, "type": "string" } ], "responses": { "default": { "description": "default response" } }, "tags": [ "github-users" ], "x-swgg-descriptionLineList": [ "User Administration - Suspend a user.\n", "If your GitHub Enterprise appliance has [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a ```403``` response. Users managed by an external account cannot be suspended via the API.\n", "https://developer.github.com/v3/users/administration/#suspend-a-user\n" ], "x-swgg-host": "api.github.com", "x-swgg-sortValue": "User Administration - Suspend a user.\n", "x-swgg-tags0": "github-users" } } }, "schemes": [ "https" ], "swagger": "2.0", "tags": [ { "name": "github-activity", "x-swgg-descriptionLineList": [ "Activity.\n", "Serving up the 'social' in Social Coding, the Activity APIs provide access to notifications, subscriptions, and timelines.\n", "[https://developer.github.com/v3/activity/](https://developer.github.com/v3/activity/)\n" ] }, { "name": "github-apps", "x-swgg-descriptionLineList": [ "GitHub Apps.\n", "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).\"\n", "**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.\n", "```application/vnd.github.machine-man-preview+json```\n", "[https://developer.github.com/v3/apps/](https://developer.github.com/v3/apps/)\n" ] }, { "name": "github-enterprise", "x-swgg-descriptionLineList": [ "Enterprise.\n", "See the [Enterprise homepage](https://developer.github.com/enterprise/) for information about the supported releases. These Enterprise-specific endpoints are available:\n", "- [Admin Stats](https://developer.github.com/v3/enterprise-admin/admin_stats/)\n", "- [Global Webhooks](https://developer.github.com/v3/enterprise-admin/global_webhooks)\n", "- [LDAP](https://developer.github.com/v3/enterprise-admin/ldap/)\n", "- [License](https://developer.github.com/v3/enterprise-admin/license/)\n", "- [Management Console](https://developer.github.com/v3/enterprise-admin/management_console/)\n", "- [Organization Administration](https://developer.github.com/v3/enterprise-admin/orgs/)\n", "- [Pre-receive Environments](https://developer.github.com/v3/enterprise-admin/pre_receive_environments/)\n", "- [Pre-receive Hooks](https://developer.github.com/v3/enterprise-admin/pre_receive_hooks/)\n", "- [Search Indexing](https://developer.github.com/v3/enterprise-admin/search_indexing/)\n", "- [User Administration](https://developer.github.com/v3/users/administration/)\n", "- [Organization Pre-receive Hooks](https://developer.github.com/v3/orgs/pre_receive_hooks/)\n", "- [Repository Pre-receive Hooks](https://developer.github.com/v3/repos/pre_receive_hooks/)\n", "[https://developer.github.com/v3/enterprise/](https://developer.github.com/v3/enterprise/)\n" ] }, { "name": "github-gists", "x-swgg-descriptionLineList": [ "Gists.\n", "**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 ```\n", "**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).\n", "[https://developer.github.com/v3/gists/](https://developer.github.com/v3/gists/)\n" ] }, { "name": "github-git", "x-swgg-descriptionLineList": [ "Git Data.\n", "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).\n", "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.\n", "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.\n", "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.\n", "As an example, if you wanted to commit a change to a file in your repository, you would:\n", "- get the current commit object\n", "- retrieve the tree it points to\n", "- retrieve the content of the blob object that tree has for that particular file path\n", "- change the content somehow and post a new blob object with that new content, getting a blob SHA back\n", "- post a new tree object with that file path pointer replaced with your new blob SHA getting a tree SHA back\n", "- create a new commit object with the current commit SHA as the parent and the new tree SHA, getting a commit SHA back\n", "- update the reference of your branch to point to the new commit SHA\n", "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.\n", "[https://developer.github.com/v3/git/](https://developer.github.com/v3/git/)\n" ] }, { "name": "github-issues", "x-swgg-descriptionLineList": [ "Issues.\n", "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/).\n", "**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 ```\n", "**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).\n", "[https://developer.github.com/v3/issues/](https://developer.github.com/v3/issues/)\n" ] }, { "name": "github-migration", "x-swgg-descriptionLineList": [ "Migration.\n", "These APIs help you move projects to or from GitHub.\n", "[https://developer.github.com/v3/migration/](https://developer.github.com/v3/migration/)\n" ] }, { "name": "github-misc", "x-swgg-descriptionLineList": [ "Miscellaneous.\n", "This is a miscellaneous set of APIs which provide access to top level GitHub resources and info.\n", "[https://developer.github.com/v3/misc/](https://developer.github.com/v3/misc/)\n" ] }, { "name": "github-orgs", "x-swgg-descriptionLineList": [ "Organizations.\n", "**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 ```\n", "**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).\n", "[https://developer.github.com/v3/orgs/](https://developer.github.com/v3/orgs/)\n" ] }, { "name": "github-projects", "x-swgg-descriptionLineList": [ "Projects.\n", "**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 ```\n", "**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).\n", "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.\n", "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 ```\n", "[https://developer.github.com/v3/projects/](https://developer.github.com/v3/projects/)\n" ] }, { "name": "github-pulls", "x-swgg-descriptionLineList": [ "Pull Requests.\n", "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/).\n", "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/).\n", "**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 ```\n", "**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).\n", "[https://developer.github.com/v3/pulls/](https://developer.github.com/v3/pulls/)\n" ] }, { "name": "github-reactions", "x-swgg-descriptionLineList": [ "Reactions.\n", "**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 ```\n", "**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 ```\n", "**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).\n", "[https://developer.github.com/v3/reactions/](https://developer.github.com/v3/reactions/)\n" ] }, { "name": "github-repos", "x-swgg-descriptionLineList": [ "Repositories.\n", "**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 ```\n", "**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 ```\n", "**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 ```\n", "**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).\n", "[https://developer.github.com/v3/repos/](https://developer.github.com/v3/repos/)\n" ] }, { "name": "github-scim", "x-swgg-descriptionLineList": [ "SCIM.\n", "The SCIM API is used by SCIM-enabled Identity Providers (IdPs) to automate provisioning of GitHub organization membership. The GitHub API is based on version 2.0 of the [SCIM standard](http://www.simplecloud.info/).\n", "Please note that the SCIM API is available only to [Business Plan](https://help.github.com/articles/organization-billing-plans/#business-plan) with [SAML SSO](https://developer.github.com/v3/auth/#authenticating-for-saml-sso) enabled.\n", "**Note:** The SCIM 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.cloud-9-preview+json+scim ```\n", "**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).\n", "[https://developer.github.com/v3/scim/](https://developer.github.com/v3/scim/)\n" ] }, { "name": "github-search", "x-swgg-descriptionLineList": [ "Search.\n", "**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 ```\n", "**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\n", "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\n", "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\n", "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.\n", "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\n", "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```.\n", "Reaching a timeout does not necessarily mean that search results are incomplete. More results might have been found, but also might not.\n", "[https://developer.github.com/v3/search/](https://developer.github.com/v3/search/)\n" ] }, { "name": "github-users", "x-swgg-descriptionLineList": [ "Users.\n", "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.\n", "**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 ```\n", "**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).\n", "[https://developer.github.com/v3/users/](https://developer.github.com/v3/users/)\n" ] } ], "x-swgg-corsForwardProxyHost": "disabled", "x-swgg-operationIdFromPath": true, "x-swgg-tags0-override": { "github-activity": { "externalDocs": { "url": "https://developer.github.com/v3/activity/" }, "name": "github-activity" }, "github-apps": { "externalDocs": { "url": "https://developer.github.com/v3/apps/" }, "name": "github-apps" }, "github-enterprise": { "externalDocs": { "url": "https://developer.github.com/v3/enterprise/" }, "name": "github-enterprise" }, "github-gists": { "externalDocs": { "url": "https://developer.github.com/v3/gists/" }, "name": "github-gists" }, "github-git": { "externalDocs": { "url": "https://developer.github.com/v3/git/" }, "name": "github-git" }, "github-issues": { "externalDocs": { "url": "https://developer.github.com/v3/issues/" }, "name": "github-issues" }, "github-migration": { "externalDocs": { "url": "https://developer.github.com/v3/migration/" }, "name": "github-migration" }, "github-misc": { "externalDocs": { "url": "https://developer.github.com/v3/misc/" }, "name": "github-misc" }, "github-orgs": { "externalDocs": { "url": "https://developer.github.com/v3/orgs/" }, "name": "github-orgs" }, "github-projects": { "externalDocs": { "url": "https://developer.github.com/v3/projects/" }, "name": "github-projects" }, "github-pulls": { "externalDocs": { "url": "https://developer.github.com/v3/pulls/" }, "name": "github-pulls" }, "github-reactions": { "externalDocs": { "url": "https://developer.github.com/v3/reactions/" }, "name": "github-reactions" }, "github-repos": { "externalDocs": { "url": "https://developer.github.com/v3/repos/" }, "name": "github-repos" }, "github-scim": { "externalDocs": { "url": "https://developer.github.com/v3/scim/" }, "name": "github-scim" }, "github-search": { "externalDocs": { "url": "https://developer.github.com/v3/search/" }, "name": "github-search" }, "github-users": { "externalDocs": { "url": "https://developer.github.com/v3/users/" }, "name": "github-users" } } }