✅ GET /repos/:owner/:repo/issues/events
[
{
"name": "List issue events for a repository",
"enabledForApps": false,
"method": "GET",
"path": "/repos/:owner/:repo/issues/events",
"params": [],
"description": "Repository issue events have a different format than other events, as documented in the [Issue Events API](/v3/issues/events/).",
"documentationUrl": "https://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository"
},
{
"name": "List events for a repository",
"enabledForApps": true,
"method": "GET",
"path": "/repos/:owner/:repo/issues/events",
"params": [],
"description": "",
"documentationUrl": "https://developer.github.com/v3/issues/events/#list-events-for-a-repository"
}
]
✅ GET /repos/:owner/:repo
[
{
"name": "Get a repository's code of conduct",
"enabledForApps": true,
"method": "GET",
"path": "/repos/:owner/:repo",
"params": [],
"description": "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.",
"documentationUrl": "https://developer.github.com/v3/codes_of_conduct/#get-a-repositorys-code-of-conduct"
},
{
"name": "Get",
"enabledForApps": true,
"method": "GET",
"path": "/repos/:owner/:repo",
"params": [],
"description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.",
"documentationUrl": "https://developer.github.com/v3/repos/#get"
}
]
✅ GET /repos/:owner/:repo/git/tags/:sha
[
{
"name": "Get a Tag",
"enabledForApps": true,
"method": "GET",
"path": "/repos/:owner/:repo/git/tags/:sha",
"params": [],
"description": "",
"documentationUrl": "https://developer.github.com/v3/git/tags/#get-a-tag"
},
{
"name": "Tag signature verification",
"enabledForApps": false,
"method": "GET",
"path": "/repos/:owner/:repo/git/tags/:sha",
"params": [
{
"name": "verified",
"type": "boolean",
"description": "Does GitHub consider the signature in this tag to be verified?",
"required": false
},
{
"name": "reason",
"type": "string",
"description": "The reason for `verified` value. Possible values and their meanings are enumerated in the table below.",
"required": false
},
{
"name": "signature",
"type": "string",
"description": "The signature that was extracted from the tag.",
"required": false
},
{
"name": "payload",
"type": "string",
"description": "The value that was signed.",
"required": false
}
],
"description": "**The verification object**\n\n**The reason field**\n\nThe following are possible `reason`s that may be included in the `verification` object:\n\n| Value | Description |\n| ----------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature-verification service. |\n| `gpgverify_unavailable` | The signature-verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unkown_signature_type` | A non-PGP signature was found in the tag. |\n| `no_user` | No user was associated with the `tagger` email address in the tag. |\n| `unverified_email` | The `tagger` email address in the tag was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `tagger` email address in the tag is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
"documentationUrl": "https://developer.github.com/v3/git/tags/#tag-signature-verification"
}
]
✅ GET /repos/:owner/:repo/git/commits/:sha
[
{
"name": "Get a Commit",
"enabledForApps": true,
"method": "GET",
"path": "/repos/:owner/:repo/git/commits/:sha",
"params": [],
"description": "",
"documentationUrl": "https://developer.github.com/v3/git/commits/#get-a-commit"
},
{
"name": "Commit signature verification",
"enabledForApps": false,
"method": "GET",
"path": "/repos/:owner/:repo/git/commits/:sha",
"params": [
{
"name": "verified",
"type": "boolean",
"description": "Does GitHub consider the signature in this commit to be verified?",
"required": false
},
{
"name": "reason",
"type": "string",
"description": "The reason for `verified` value. Possible values and their meanings are enumerated in the table below.",
"required": false
},
{
"name": "signature",
"type": "string",
"description": "The signature that was extracted from the commit.",
"required": false
},
{
"name": "payload",
"type": "string",
"description": "The value that was signed.",
"required": false
}
],
"description": "**The verification object**\n\n**The reason field**\n\nThe following are possible `reason`s that may be included in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature-verification service. |\n| `gpgverify_unavailable` | The signature-verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
"documentationUrl": "https://developer.github.com/v3/git/commits/#commit-signature-verification"
}
]
✅ POST /repos/:owner/:repo/pulls/:number/comments
[
{
"name": "Create a comment",
"enabledForApps": true,
"method": "POST",
"path": "/repos/:owner/:repo/pulls/:number/comments",
"params": [
{
"name": "body",
"type": "string",
"description": "The text of the comment.",
"required": true
},
{
"name": "commit_id",
"type": "string",
"description": "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`.",
"required": true
},
{
"name": "path",
"type": "string",
"description": "The relative path to the file that necessitates a comment.",
"required": true
},
{
"name": "position",
"type": "integer",
"description": "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.",
"required": true
}
],
"description": "**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](/v3/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](/v3/pulls/#get-a-single-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"documentationUrl": "https://developer.github.com/v3/pulls/comments/#create-a-comment"
},
{
"name": "Create a comment (alternative)",
"enabledForApps": true,
"method": "POST",
"path": "/repos/:owner/:repo/pulls/:number/comments",
"params": [
{
"name": "body",
"type": "string",
"description": "The text of the comment.",
"required": true
},
{
"name": "commit_id",
"type": "string",
"description": "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`.",
"required": true
},
{
"name": "path",
"type": "string",
"description": "The relative path to the file that necessitates a comment.",
"required": true
},
{
"name": "position",
"type": "integer",
"description": "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.",
"required": true
}
],
"description": "**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](/v3/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](/v3/pulls/#get-a-single-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"documentationUrl": "https://developer.github.com/v3/pulls/comments/#create-a-comment"
}
]
✅ POST /repos/:owner/:repo/pulls
[
{
"name": "Create a pull request",
"enabledForApps": true,
"method": "POST",
"path": "/repos/:owner/:repo/pulls",
"params": [
{
"name": "title",
"type": "string",
"description": "The title of the pull request.",
"required": true
},
{
"name": "head",
"type": "string",
"description": "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`.",
"required": true
},
{
"name": "base",
"type": "string",
"description": "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.",
"required": true
},
{
"name": "body",
"type": "string",
"description": "The contents of the pull request.",
"required": false
},
{
"name": "maintainer_can_modify",
"type": "boolean",
"description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.",
"required": false
}
],
"description": "",
"documentationUrl": "https://developer.github.com/v3/pulls/#create-a-pull-request"
},
{
"name": "Create a pull request (alternative)",
"enabledForApps": true,
"method": "POST",
"path": "/repos/:owner/:repo/pulls",
"params": [
{
"name": "owner",
"type": "string",
"required": true,
"description": "",
"location": "url"
},
{
"name": "repo",
"type": "string",
"required": true,
"description": "",
"location": "url"
},
{
"name": "issue",
"type": "integer",
"description": "The issue number in this repository to turn into a Pull Request.",
"required": true,
"location": "body"
},
{
"name": "head",
"type": "string",
"description": "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`.",
"required": true,
"location": "body"
},
{
"name": "base",
"type": "string",
"description": "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.",
"required": true,
"location": "body"
},
{
"name": "maintainer_can_modify",
"type": "boolean",
"description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.",
"required": false,
"location": "body"
}
],
"description": "",
"documentationUrl": "https://developer.github.com/v3/pulls/#create-a-pull-request"
}
]
✅ GET /repos/:owner/:repo/commits/:sha
[
{
"name": "Get a single commit",
"enabledForApps": true,
"method": "GET",
"path": "/repos/:owner/:repo/commits/:sha",
"params": [],
"description": "Diffs with binary data will have no 'patch' property. Pass the appropriate [media type](/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.",
"documentationUrl": "https://developer.github.com/v3/repos/commits/#get-a-single-commit"
},
{
"name": "Commit signature verification",
"enabledForApps": false,
"method": "GET",
"path": "/repos/:owner/:repo/commits/:sha",
"params": [
{
"name": "verified",
"type": "boolean",
"description": "Does GitHub consider the signature in this commit to be verified?",
"required": false
},
{
"name": "reason",
"type": "string",
"description": "The reason for `verified` value. Possible values and their meanings are enumerated in the table below.",
"required": false
},
{
"name": "signature",
"type": "string",
"description": "The signature that was extracted from the commit.",
"required": false
},
{
"name": "payload",
"type": "string",
"description": "The value that was signed.",
"required": false
}
],
"description": "**The verification object**\n\n**The reason field**\n\nThe following are possible `reason`s that may be included in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature-verification service. |\n| `gpgverify_unavailable` | The signature-verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
"documentationUrl": "https://developer.github.com/v3/repos/commits/#commit-signature-verification"
}
]
✅ PUT /repos/:owner/:repo/contents/:path
[
{
"name": "Create a file",
"enabledForApps": true,
"method": "PUT",
"path": "/repos/:owner/:repo/contents/:path",
"params": [
{
"name": "path",
"type": "string",
"description": "The content path.",
"required": true
},
{
"name": "message",
"type": "string",
"description": "The commit message.",
"required": true
},
{
"name": "content",
"type": "string",
"description": "The new file content, Base64 encoded.",
"required": true
},
{
"name": "branch",
"type": "string",
"description": "The branch name.",
"default": "the repository’s default branch (usually `master`)",
"required": false
},
{
"name": "committer",
"type": "object",
"description": "object containing information about the committer."
},
{
"name": "author",
"type": "object",
"description": "object containing information about the author."
}
],
"description": "This method creates a new file in a repository\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\nBoth the `author` and `committer` parameters have the same keys:\n\n| name | type | description |\n| ----- | ------ | ---------------------------------------------------- |\n| name | string | The name of the author (or committer) of the commit |\n| email | string | The email of the author (or committer) of the commit |",
"documentationUrl": "https://developer.github.com/v3/repos/contents/#create-a-file"
},
{
"name": "Update a file",
"enabledForApps": true,
"method": "PUT",
"path": "/repos/:owner/:repo/contents/:path",
"params": [
{
"name": "path",
"type": "string",
"description": "The content path.",
"required": true
},
{
"name": "message",
"type": "string",
"description": "The commit message.",
"required": true
},
{
"name": "content",
"type": "string",
"description": "The updated file content, Base64 encoded.",
"required": true
},
{
"name": "sha",
"type": "string",
"description": "The blob SHA of the file being replaced.",
"required": true
},
{
"name": "branch",
"type": "string",
"description": "The branch name.",
"default": "the repository’s default branch (usually `master`)",
"required": false
},
{
"name": "committer",
"type": "object",
"description": "object containing information about the committer."
},
{
"name": "author",
"type": "object",
"description": "object containing information about the author."
}
],
"description": "This method updates a file in a repository\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\nBoth the `author` and `committer` parameters have the same keys:\n\n| name | type | description |\n| ----- | ------ | ---------------------------------------------------- |\n| name | string | The name of the author (or committer) of the commit |\n| email | string | The email of the author (or committer) of the commit |",
"documentationUrl": "https://developer.github.com/v3/repos/contents/#update-a-file"
}
]