GithubClient
Attributes
module-attribute
module-attribute
TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'WebhookPullRequestTrigger': {'operation_id': 'WebhookPullRequestTrigger', 'path': '/{connectionId}/repos/{repositoryOwner}/{repositoryName}/hooks', 'method': 'post', 'required_parameters': ['repositoryOwner', 'repositoryName'], 'callback_payload_type': 'WebhookCreationResponse'}, 'IssueOpened': {'operation_id': 'IssueOpened', 'path': '/{connectionId}/trigger/issueOpened', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'IssueDetailsModel'}, 'IssueClosed': {'operation_id': 'IssueClosed', 'path': '/{connectionId}/trigger/issueClosed', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'IssueDetailsModel'}, 'IssueAssigned': {'operation_id': 'IssueAssigned', 'path': '/{connectionId}/trigger/issueAssigned', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'IssueDetailsModel'}}
Classes
dataclass
IssueDetailsModel(title: str, *, body: Optional[str] = None, assignee: Optional[UserDetailsModel | Mapping[str, Any]] = None, number: Optional[int] = None, state: Optional[str] = None, created_at: Optional[str] = None, repository_url: Optional[str] = None)
Response for Create an issue
Attributes
class-attribute
instance-attribute
Description of the issue.
class-attribute
instance-attribute
Unique id of the issue.
class-attribute
instance-attribute
Status of the issue.
class-attribute
instance-attribute
yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).
dataclass
ActionsPublicKey(key_id: str, key: str, *, id: Optional[int] = None, url: Optional[str] = None, title: Optional[str] = None, created_at: Optional[str] = None)
Response for Get a repository public key
Attributes
class-attribute
instance-attribute
Unique identifier of the key.
class-attribute
instance-attribute
Public key url.
class-attribute
instance-attribute
Public key title.
dataclass
RepositoryDetails(*, id: Optional[int] = None, node_id: Optional[str] = None, name: Optional[str] = None, full_name: Optional[str] = None, license: Optional[LicenseDetails | Mapping[str, Any]] = None, forks: Optional[int] = None, permissions: Optional[Dict[str, Any]] = None, owner: Optional[UserDetailsModel | Mapping[str, Any]] = None, private: Optional[bool] = None, html_url: Optional[str] = None, description: Optional[str] = None, fork: Optional[bool] = None, url: Optional[str] = None, archive_url: Optional[str] = None, assignees_url: Optional[str] = None, blobs_url: Optional[str] = None, branches_url: Optional[str] = None, collaborators_url: Optional[str] = None, comments_url: Optional[str] = None, commits_url: Optional[str] = None, compare_url: Optional[str] = None, contents_url: Optional[str] = None, contributors_url: Optional[str] = None, deployments_url: Optional[str] = None, downloads_url: Optional[str] = None, events_url: Optional[str] = None, forks_url: Optional[str] = None, git_commits_url: Optional[str] = None, git_refs_url: Optional[str] = None, git_tags_url: Optional[str] = None, git_url: Optional[str] = None, issue_comment_url: Optional[str] = None, issue_events_url: Optional[str] = None, issues_url: Optional[str] = None, keys_url: Optional[str] = None, labels_url: Optional[str] = None, languages_url: Optional[str] = None, merges_url: Optional[str] = None, milestones_url: Optional[str] = None, notifications_url: Optional[str] = None, pulls_url: Optional[str] = None, releases_url: Optional[str] = None, ssh_url: Optional[str] = None, stargazers_url: Optional[str] = None, statuses_url: Optional[str] = None, subscribers_url: Optional[str] = None, subscription_url: Optional[str] = None, tags_url: Optional[str] = None, teams_url: Optional[str] = None, trees_url: Optional[str] = None, clone_url: Optional[str] = None, mirror_url: Optional[str] = None, hooks_url: Optional[str] = None, svn_url: Optional[str] = None, homepage: Optional[str] = None, language: Optional[str] = None, forks_count: Optional[int] = None, stargazers_count: Optional[int] = None, watchers_count: Optional[int] = None, size: Optional[int] = None, default_branch: Optional[str] = None, open_issues_count: Optional[int] = None, is_template: Optional[bool] = None, topics: Optional[List[str]] = None, has_issues: Optional[bool] = None, has_projects: Optional[bool] = None, has_wiki: Optional[bool] = None, has_pages: Optional[bool] = None, has_downloads: Optional[bool] = None, archived: Optional[bool] = None, disabled: Optional[bool] = None, visibility: Optional[str] = None, pushed_at: Optional[str] = None, created_at: Optional[str] = None, updated_at: Optional[str] = None, allow_rebase_merge: Optional[bool] = None, template_repository: Optional[Dict[str, Any]] = None, temp_clone_token: Optional[str] = None, allow_squash_merge: Optional[bool] = None, delete_branch_on_merge: Optional[bool] = None, allow_merge_commit: Optional[bool] = None, subscribers_count: Optional[int] = None, network_count: Optional[int] = None, open_issues: Optional[int] = None, watchers: Optional[int] = None, master_branch: Optional[str] = None, starred_at: Optional[str] = None)
Response for Create a repository using a template
Attributes
class-attribute
instance-attribute
Unique identifier of the repository.
class-attribute
instance-attribute
The Node Id of the repository.
class-attribute
instance-attribute
The name of the repository.
class-attribute
instance-attribute
The full name of the repository.
class-attribute
instance-attribute
The number of forks of the repository.
class-attribute
instance-attribute
Permissions on the repository.
class-attribute
instance-attribute
Whether the repository is private or public.
class-attribute
instance-attribute
The Html Url of the repository
class-attribute
instance-attribute
The description of the repository
class-attribute
instance-attribute
If the repository is a fork?
class-attribute
instance-attribute
The HTTP URL for this repository
class-attribute
instance-attribute
The Archive URL for this repository
class-attribute
instance-attribute
The Assignees URL for this repository
class-attribute
instance-attribute
The Blobs URL for this repository
class-attribute
instance-attribute
The Branches URL for this repository
class-attribute
instance-attribute
The Collaborators URL for this repository
class-attribute
instance-attribute
The Comments URL for this repository
class-attribute
instance-attribute
The Commits URL for this repository
class-attribute
instance-attribute
The Compare URL for this repository
class-attribute
instance-attribute
The Contents URL for this repository
class-attribute
instance-attribute
The Contributors URL for this repository
class-attribute
instance-attribute
The Deployments URL for this repository
class-attribute
instance-attribute
The Downloads URL for this repository
class-attribute
instance-attribute
The Events URL for this repository
class-attribute
instance-attribute
The Forks URL for this repository
class-attribute
instance-attribute
The Git Commits URL for this repository
class-attribute
instance-attribute
The Git References URL for this repository
class-attribute
instance-attribute
The Git Tags URL for this repository
class-attribute
instance-attribute
The Git URL for this repository
class-attribute
instance-attribute
The issue comment URL for this repository
class-attribute
instance-attribute
The issue events URL for this repository
class-attribute
instance-attribute
The issues URL for this repository
class-attribute
instance-attribute
The keys URL for this repository
class-attribute
instance-attribute
The labels URL for this repository
class-attribute
instance-attribute
The languages URL for this repository
class-attribute
instance-attribute
The merges URL for this repository
class-attribute
instance-attribute
The milestones URL for this repository
class-attribute
instance-attribute
The notifications URL for this repository
class-attribute
instance-attribute
The pulls URL for this repository
class-attribute
instance-attribute
The releases URL for this repository
class-attribute
instance-attribute
The SSH URL to clone this repository
class-attribute
instance-attribute
The stargazers (Stargazers are the people that have bookmarked the GitHub repository) URL for this repository
class-attribute
instance-attribute
The statuses URL for this repository
class-attribute
instance-attribute
The subscribers URL for this repository
class-attribute
instance-attribute
The subscription URL for this repository
class-attribute
instance-attribute
The tags URL for this repository
class-attribute
instance-attribute
The teams URL for this repository
class-attribute
instance-attribute
The trees URL for this repository
class-attribute
instance-attribute
The clone URL for this repository
class-attribute
instance-attribute
The original mirror URL for this repository
class-attribute
instance-attribute
The hooks URL for this repository
class-attribute
instance-attribute
The SVN URL for this repository
class-attribute
instance-attribute
The homepage for this repository
class-attribute
instance-attribute
The language for this repository
class-attribute
instance-attribute
Number of forks there are of this repository in the whole network.
class-attribute
instance-attribute
Number of users who have starred the repository.
class-attribute
instance-attribute
Number of users watching the repository.
class-attribute
instance-attribute
Size of the repository
class-attribute
instance-attribute
The default branch of the repository.
class-attribute
instance-attribute
Number of open issues in the repository.
class-attribute
instance-attribute
Whether this repository acts as a template that can be used to generate new repositories.
class-attribute
instance-attribute
List of topics in the repository
class-attribute
instance-attribute
Whether issues are enabled.
class-attribute
instance-attribute
Whether projects are enabled.
class-attribute
instance-attribute
Whether the wiki is enabled.
class-attribute
instance-attribute
Whether pages are enabled.
class-attribute
instance-attribute
Whether downloads are enabled.
class-attribute
instance-attribute
Whether the repository is archived.
class-attribute
instance-attribute
Returns whether or not this repository disabled.
class-attribute
instance-attribute
The repository visibility: public, private, or internal.
class-attribute
instance-attribute
When the repository was last pushed to.
class-attribute
instance-attribute
the date and time when the repository was created.
class-attribute
instance-attribute
the date and time when the repository was last updated.
class-attribute
instance-attribute
Whether to allow rebase merges for pull requests.
class-attribute
instance-attribute
Temporary authentication token for cloning this repository.
class-attribute
instance-attribute
Whether to allow squash merges for pull requests.
class-attribute
instance-attribute
Whether to delete head branches when pull requests are merged
class-attribute
instance-attribute
Whether to allow merge commits for pull requests.
class-attribute
instance-attribute
Number of subscribers for the repository.
class-attribute
instance-attribute
Repository Network Count
class-attribute
instance-attribute
Repository open issues.
class-attribute
instance-attribute
Repository Watchers.
class-attribute
instance-attribute
Repository master branch.
dataclass
GitReference(*, ref: Optional[str] = None, node_id: Optional[str] = None, url: Optional[str] = None, object: Optional[Dict[str, Any]] = None)
Response for Create a reference
Attributes
class-attribute
instance-attribute
The name of the fully qualified reference.
class-attribute
instance-attribute
The Node Id of the reference.
dataclass
PullRequestMergeResult(*, sha: Optional[str] = None, merged: Optional[bool] = None, message: Optional[str] = None)
Response for Merge a pull request
Attributes
class-attribute
instance-attribute
SHA for the merge commit.
class-attribute
instance-attribute
Whether or not the pull request was merged.
dataclass
PullRequest(*, url: Optional[str] = None, id: Optional[int] = None, node_id: Optional[str] = None, html_url: Optional[str] = None, diff_url: Optional[str] = None, patch_url: Optional[str] = None, issue_url: Optional[str] = None, commits_url: Optional[str] = None, review_comments_url: Optional[str] = None, review_comment_url: Optional[str] = None, comments_url: Optional[str] = None, statuses_url: Optional[str] = None, number: Optional[int] = None, state: Optional[str] = None, locked: Optional[bool] = None, title: Optional[str] = None, user: Optional[UserDetailsModel | Mapping[str, Any]] = None, body: Optional[str] = None, labels: Optional[List[Label | Mapping[str, Any]]] = None, milestone: Optional[Milestone | Mapping[str, Any]] = None, active_lock_reason: Optional[str] = None, created_at: Optional[str] = None, updated_at: Optional[str] = None, closed_at: Optional[str] = None, merged_at: Optional[str] = None, merge_commit_sha: Optional[str] = None, assignee: Optional[UserDetailsModel | Mapping[str, Any]] = None, assignees: Optional[List[UserDetailsModel | Mapping[str, Any]]] = None, requested_reviewers: Optional[List[UserDetailsModel | Mapping[str, Any]]] = None, requested_teams: Optional[List[TeamDetails | Mapping[str, Any]]] = None, head: Optional[Dict[str, Any]] = None, base: Optional[Dict[str, Any]] = None, author_association: Optional[str] = None, draft: Optional[bool] = None, merged: Optional[bool] = None, mergeable: Optional[bool] = None, rebaseable: Optional[bool] = None, mergeable_state: Optional[str] = None, merged_by: Optional[UserDetailsModel | Mapping[str, Any]] = None, comments: Optional[int] = None, review_comments: Optional[int] = None, maintainer_can_modify: Optional[bool] = None, commits: Optional[int] = None, additions: Optional[int] = None, deletions: Optional[int] = None, changed_files: Optional[int] = None)
Response for Get a pull request
Attributes
class-attribute
instance-attribute
The HTTP URL for this pull request.
class-attribute
instance-attribute
The Unique Identifier for the pull request.
class-attribute
instance-attribute
The Node ID for the pull request.
class-attribute
instance-attribute
The HTML URL for the pull request.
class-attribute
instance-attribute
The Diff URL for the pull request.
class-attribute
instance-attribute
The patch URL for the pull request.
class-attribute
instance-attribute
The issue URL for the pull request.
class-attribute
instance-attribute
The commit URL for the pull request.
class-attribute
instance-attribute
The review comments URL for the pull request.
class-attribute
instance-attribute
The review comment URL for the pull request.
class-attribute
instance-attribute
The Diff URL for the pull request.
class-attribute
instance-attribute
The statuses URL for the pull request.
class-attribute
instance-attribute
Number uniquely identifying the pull request within its repository.
class-attribute
instance-attribute
State of this Pull Request. Either open or closed.
class-attribute
instance-attribute
Whether the pull request is locked or not.
class-attribute
instance-attribute
The title of the pull request.
class-attribute
instance-attribute
The body as Markdown.
class-attribute
instance-attribute
The list of labels associated with the pull request.
class-attribute
instance-attribute
Reason that the conversation was locked.
class-attribute
instance-attribute
The date and time when the pull request was created.
class-attribute
instance-attribute
The date and time when the pull request was last updated.
class-attribute
instance-attribute
The date and time when the pull request was closed.
class-attribute
instance-attribute
The date and time that the pull request was merged.
class-attribute
instance-attribute
The merge commit Sha of the pull request.
class-attribute
instance-attribute
assignees: Optional[List[UserDetailsModel | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)
The list of assignees for the pull request.
class-attribute
instance-attribute
requested_reviewers: Optional[List[UserDetailsModel | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)
The list of Users assigned to this pull request.
class-attribute
instance-attribute
requested_teams: Optional[List[TeamDetails | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True)
The list of requested teams to this pull request.
class-attribute
instance-attribute
Head
class-attribute
instance-attribute
Base
class-attribute
instance-attribute
Author's association with the subject of the comment.
class-attribute
instance-attribute
Indicates whether or not the pull request is a draft.
class-attribute
instance-attribute
Whether or not the pull request was merged.
class-attribute
instance-attribute
Whether or not the pull request can be merged based on the existence of merge conflicts.
class-attribute
instance-attribute
Whether or not the pull request is rebaseable.
class-attribute
instance-attribute
The mergeable state of the pull request.
class-attribute
instance-attribute
The number of comments in this pull request.
class-attribute
instance-attribute
The number of review comments in this pull request.
class-attribute
instance-attribute
Indicates whether maintainers can modify the pull request.
class-attribute
instance-attribute
The number of commits in this pull request.
class-attribute
instance-attribute
The number of additions in this pull request.
class-attribute
instance-attribute
The number of deletions in this pull request.
dataclass
PullRequestFile(*, sha: Optional[str] = None, filename: Optional[str] = None, status: Optional[str] = None, additions: Optional[int] = None, deletions: Optional[int] = None, changes: Optional[int] = None, blob_url: Optional[str] = None, raw_url: Optional[str] = None, contents_url: Optional[str] = None, patch: Optional[str] = None)
Response for Get the list of files from a pull request
Attributes
class-attribute
instance-attribute
The sha for the file.
class-attribute
instance-attribute
The file name.
class-attribute
instance-attribute
The modification status for the file.
class-attribute
instance-attribute
The number of additions made to the file.
class-attribute
instance-attribute
The number of deletions made to the file.
class-attribute
instance-attribute
The number of changes made to the file.
class-attribute
instance-attribute
The blob Url for the file.
class-attribute
instance-attribute
The Raw Url for the file.
class-attribute
instance-attribute
The contents Url for the file.
dataclass
CommitComparison(*, url: Optional[str] = None, html_url: Optional[str] = None, permalink_url: Optional[str] = None, diff_url: Optional[str] = None, patch_url: Optional[str] = None, base_commit: Optional[Commit | Mapping[str, Any]] = None, merge_base_commit: Optional[Commit | Mapping[str, Any]] = None, status: Optional[str] = None, ahead_by: Optional[int] = None, behind_by: Optional[int] = None, total_commits: Optional[int] = None, commits: Optional[List[Commit | Mapping[str, Any]]] = None, files: Optional[List[DiffEntry | Mapping[str, Any]]] = None)
Response for Compare two commits
Attributes
class-attribute
instance-attribute
Url for the comparison
class-attribute
instance-attribute
Html Url for the comparison
class-attribute
instance-attribute
Permanent Url for the comparison
class-attribute
instance-attribute
Diff Url
class-attribute
instance-attribute
Patch Url
class-attribute
instance-attribute
Status of the comparision eg. diverged etc.,
class-attribute
instance-attribute
ahead by base branch
class-attribute
instance-attribute
behind_by base branch
class-attribute
instance-attribute
total commits
class-attribute
instance-attribute
commits
dataclass
WebhookCreationResponse(*, type_: Optional[str] = None, id: Optional[int] = None, name: Optional[str] = None, active: Optional[bool] = None, events: Optional[List[str]] = None, config: Optional[Dict[str, Any]] = None, updated_at: Optional[str] = None, created_at: Optional[str] = None, url: Optional[str] = None, test_url: Optional[str] = None, ping_url: Optional[str] = None, last_response: Optional[Dict[str, Any]] = None)
Response for When a pull request is created or modified
dataclass
Milestone(*, url: Optional[str] = None, html_url: Optional[str] = None, labels_url: Optional[str] = None, id: Optional[int] = None, node_id: Optional[str] = None, number: Optional[int] = None, state: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, creator: Optional[UserDetailsModel | Mapping[str, Any]] = None, open_issues: Optional[int] = None, closed_issues: Optional[int] = None, created_at: Optional[str] = None, updated_at: Optional[str] = None, closed_at: Optional[str] = None, due_on: Optional[str] = None)
Response for Update a milestone
Attributes
class-attribute
instance-attribute
The HTTP URL for the milestone.
class-attribute
instance-attribute
The HTML URL for the milestone.
class-attribute
instance-attribute
The labels URL for the milestone.
class-attribute
instance-attribute
The Unique Identifier for the milestone.
class-attribute
instance-attribute
The Node ID for the milestone.
class-attribute
instance-attribute
The number of the milestone.
class-attribute
instance-attribute
The state of the milestone.
class-attribute
instance-attribute
The title of the milestone.
class-attribute
instance-attribute
The description of the milestone.
class-attribute
instance-attribute
Number of open issues for the repository.
class-attribute
instance-attribute
Number of closed issues for the repository.
class-attribute
instance-attribute
The date and time when the milestone was created.
class-attribute
instance-attribute
The date and time when the milestone was last updated.
class-attribute
instance-attribute
The date and time when the milestone was closed.
dataclass
UserDetailsModel(*, login: Optional[str] = None, id: Optional[int] = None, node_id: Optional[str] = None, avatar_url: Optional[str] = None, gravatar_id: Optional[str] = None, url: Optional[str] = None, html_url: Optional[str] = None, followers_url: Optional[str] = None, following_url: Optional[str] = None, gists_url: Optional[str] = None, starred_url: Optional[str] = None, subscriptions_url: Optional[str] = None, organizations_url: Optional[str] = None, repos_url: Optional[str] = None, events_url: Optional[str] = None, received_events_url: Optional[str] = None, type_: Optional[str] = None, site_admin: Optional[bool] = None, name: Optional[str] = None, company: Optional[str] = None, blog: Optional[str] = None, location: Optional[str] = None, email: Optional[str] = None, hireable: Optional[bool] = None, bio: Optional[str] = None, public_repos: Optional[int] = None, public_gists: Optional[int] = None, followers: Optional[int] = None, following: Optional[int] = None, created_at: Optional[str] = None, updated_at: Optional[str] = None)
Response for Get the authenticated user
Attributes
class-attribute
instance-attribute
User Login.
class-attribute
instance-attribute
User Id.
class-attribute
instance-attribute
User Node Id.
class-attribute
instance-attribute
User Avatar Url.
class-attribute
instance-attribute
User Gravatar Id.
class-attribute
instance-attribute
User Url.
class-attribute
instance-attribute
User Html Url.
class-attribute
instance-attribute
User FollowersUrl
class-attribute
instance-attribute
User Following Url.
class-attribute
instance-attribute
User Gists Url.
class-attribute
instance-attribute
User Starred Url.
class-attribute
instance-attribute
User Subscriptions Url.
class-attribute
instance-attribute
User Organizations Url.
class-attribute
instance-attribute
User Repos Url.
class-attribute
instance-attribute
User Events Url.
class-attribute
instance-attribute
User Received Events Url.
class-attribute
instance-attribute
User Type.
class-attribute
instance-attribute
Is User Site Admin?
class-attribute
instance-attribute
User Name.
class-attribute
instance-attribute
User Company.
class-attribute
instance-attribute
User Blog.
class-attribute
instance-attribute
User Location.
class-attribute
instance-attribute
User Email.
class-attribute
instance-attribute
User Hireable?
class-attribute
instance-attribute
User Bio.
class-attribute
instance-attribute
User Public Repos.
class-attribute
instance-attribute
User Public Gists.
class-attribute
instance-attribute
User Followers.
class-attribute
instance-attribute
User Following.
class-attribute
instance-attribute
User Created At.
dataclass
dataclass
dataclass
dataclass
dataclass
IssueUpdateModel(*, title: Optional[str] = None, body: Optional[str] = None, assignee: Optional[str] = None, state: Optional[str] = None, state_reason: Optional[str] = None, milestone: Optional[str] = None, labels: Optional[List[str]] = None, assignees: Optional[List[str]] = None)
Definition: IssueUpdateModel
Attributes
class-attribute
instance-attribute
Summary of the issue.
class-attribute
instance-attribute
Description of the issue.
class-attribute
instance-attribute
Assignee of the issue.
class-attribute
instance-attribute
The open or close state of an issue. Can be one of open or closed.
class-attribute
instance-attribute
The reason for change of state.
class-attribute
instance-attribute
Number of milestones to associate with issue.
class-attribute
instance-attribute
labels associated with the issue.
dataclass
MilestoneUpdateModel(*, title: Optional[str] = None, state: Optional[str] = None, description: Optional[str] = None, due_on: Optional[str] = None)
Definition: MilestoneUpdateModel
Attributes
class-attribute
instance-attribute
Summary of the milestone.
class-attribute
instance-attribute
The open or close state of the milestone.
class-attribute
instance-attribute
A description of the milestone.
dataclass
Verification(*, verified: Optional[bool] = None, reason: Optional[str] = None, payload: Optional[str] = None, signature: Optional[str] = None)
Definition: Verification
Attributes
class-attribute
instance-attribute
Indicates whether GitHub considers the signature in this commit to be verified.
class-attribute
instance-attribute
The reason for verified value.
class-attribute
instance-attribute
The value that was signed.
dataclass
Definition: GitUser
Attributes
class-attribute
instance-attribute
User Name
class-attribute
instance-attribute
dataclass
dataclass
DiffEntry(*, filename: Optional[str] = None, additions: Optional[int] = None, deletions: Optional[int] = None, changes: Optional[int] = None, status: Optional[str] = None, raw_url: Optional[str] = None, blob_url: Optional[str] = None, patch: Optional[str] = None, sha: Optional[str] = None, contents_url: Optional[str] = None, previous_filename: Optional[str] = None)
Definition: DiffEntry
Attributes
class-attribute
instance-attribute
Changed File Name.
class-attribute
instance-attribute
Number of additions in the file
class-attribute
instance-attribute
Number of Deletions in the file
class-attribute
instance-attribute
Number of Changes in the file
class-attribute
instance-attribute
Status of the change modified, renamed etc.,
class-attribute
instance-attribute
Raw Url link to the file
class-attribute
instance-attribute
Blob Url link to the file
class-attribute
instance-attribute
Actual changes made to the file.
class-attribute
instance-attribute
SHA of the change.
class-attribute
instance-attribute
File Contents Url.
dataclass
Commit(*, url: Optional[str] = None, sha: Optional[str] = None, node_id: Optional[str] = None, html_url: Optional[str] = None, comments_url: Optional[str] = None, commit: Optional[Dict[str, Any]] = None, author: Optional[UserDetailsModel | Mapping[str, Any]] = None, committer: Optional[UserDetailsModel | Mapping[str, Any]] = None, parents: Optional[List[Dict[str, Any]]] = None, stats: Optional[Dict[str, Any]] = None, files: Optional[List[DiffEntry | Mapping[str, Any]]] = None)
Definition: Commit
Attributes
class-attribute
instance-attribute
The HTTP URL for the commit.
class-attribute
instance-attribute
SHA of the commit
class-attribute
instance-attribute
Node Id of the commit.
class-attribute
instance-attribute
HTML Url of the commit
dataclass
RepositoryDispatchEvent(*, event_type: Optional[str] = None, client_payload: Optional[Dict[str, Any]] = None)
Definition: RepositoryDispatchEvent
Attributes
class-attribute
instance-attribute
A custom webhook event name.
dataclass
CreateRepositorySecretRequest(*, encrypted_value: Optional[str] = None, key_id: Optional[str] = None)
Definition: CreateRepositorySecretRequest
Attributes
class-attribute
instance-attribute
Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an Repository public key action.
dataclass
CreateRepositoryUsingTemplateRequest(name: str, *, owner: Optional[str] = None, description: Optional[str] = None, private: Optional[bool] = None)
Definition: CreateRepositoryUsingTemplateRequest
Attributes
class-attribute
instance-attribute
The organization or person who will own the new repository. If left blank, the authenticated user will be the owner.
class-attribute
instance-attribute
A short description of the new repository.
dataclass
LicenseDetails(*, key: Optional[str] = None, name: Optional[str] = None, url: Optional[str] = None, spdx_id: Optional[str] = None, node_id: Optional[str] = None, html_url: Optional[str] = None)
Definition: LicenseDetails
Attributes
class-attribute
instance-attribute
The lowercased SPDX Id of the license.
class-attribute
instance-attribute
The license full name specified by https://spdx.org/licenses.
class-attribute
instance-attribute
URL to the license on https://choosealicense.com.
class-attribute
instance-attribute
Short identifier specified by https://spdx.org/licenses.
class-attribute
instance-attribute
License Node Id.
dataclass
RepositoryMiniDetails(*, id: Optional[int] = None, node_id: Optional[str] = None, name: Optional[str] = None, full_name: Optional[str] = None, permissions: Optional[Dict[str, Any]] = None, owner: Optional[UserDetailsModel | Mapping[str, Any]] = None, private: Optional[bool] = None, description: Optional[str] = None, homepage: Optional[str] = None, language: Optional[str] = None, archived: Optional[bool] = None, disabled: Optional[bool] = None, visibility: Optional[str] = None, created_at: Optional[str] = None, updated_at: Optional[str] = None, allow_rebase_merge: Optional[bool] = None, allow_squash_merge: Optional[bool] = None, delete_branch_on_merge: Optional[bool] = None, allow_merge_commit: Optional[bool] = None, master_branch: Optional[str] = None)
Definition: RepositoryMiniDetails
Attributes
class-attribute
instance-attribute
Unique identifier of the repository.
class-attribute
instance-attribute
The Node Id of the repository.
class-attribute
instance-attribute
The name of the repository.
class-attribute
instance-attribute
The full name of the repository.
class-attribute
instance-attribute
Permissions on the repository.
class-attribute
instance-attribute
Whether the repository is private or public.
class-attribute
instance-attribute
The description of the repository
class-attribute
instance-attribute
The homepage for this repository
class-attribute
instance-attribute
The language for this repository
class-attribute
instance-attribute
Whether the repository is archived.
class-attribute
instance-attribute
Returns whether or not this repository disabled.
class-attribute
instance-attribute
The repository visibility: public, private, or internal.
class-attribute
instance-attribute
the date and time when the repository was created.
class-attribute
instance-attribute
the date and time when the repository was last updated.
class-attribute
instance-attribute
Whether to allow rebase merges for pull requests.
class-attribute
instance-attribute
Whether to allow squash merges for pull requests.
class-attribute
instance-attribute
Whether to delete head branches when pull requests are merged
class-attribute
instance-attribute
Whether to allow merge commits for pull requests.
dataclass
dataclass
PullRequestCreateRequest(head: str, base: str, *, title: Optional[str] = None, body: Optional[str] = None, maintainer_can_modify: Optional[bool] = None, draft: Optional[bool] = None)
Definition: PullRequestCreateRequest
Attributes
class-attribute
instance-attribute
The title of the new pull request.
instance-attribute
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.
instance-attribute
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.
class-attribute
instance-attribute
The contents of the pull request.
class-attribute
instance-attribute
Indicates whether maintainers can modify the pull request.
dataclass
PullRequestMergeRequest(*, commit_title: Optional[str] = None, commit_message: Optional[str] = None, sha: Optional[str] = None, merge_method: Optional[str] = None)
Definition: PullRequestMergeRequest
Attributes
class-attribute
instance-attribute
commit_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'commitTitle'})
Title for the automatic commit message.
class-attribute
instance-attribute
commit_message: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'commitMessage'})
Extra detail to append to automatic commit message.
class-attribute
instance-attribute
SHA that pull request head must match to allow merge.
dataclass
PullRequestUpdateRequest(*, title: Optional[str] = None, body: Optional[str] = None, state: Optional[str] = None, base: Optional[str] = None, maintainer_can_modify: Optional[bool] = None)
Definition: PullRequestUpdateRequest
Attributes
class-attribute
instance-attribute
The title of the pull request.
class-attribute
instance-attribute
The contents of the pull request.
class-attribute
instance-attribute
State of this Pull Request. Either open or closed.
class-attribute
instance-attribute
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.
dataclass
Label(*, id: Optional[int] = None, node_id: Optional[str] = None, url: Optional[str] = None, name: Optional[str] = None, description: Optional[str] = None, color: Optional[str] = None, default: Optional[bool] = None)
Definition: Label
Attributes
class-attribute
instance-attribute
The Unique Identifier for the label.
class-attribute
instance-attribute
The Node ID for the label.
class-attribute
instance-attribute
URL for the label
class-attribute
instance-attribute
The name of the label.
class-attribute
instance-attribute
A brief description of this label.
class-attribute
instance-attribute
6-character hex code, without the leading #, identifying the color
dataclass
TeamDetails(*, id: Optional[int] = None, node_id: Optional[str] = None, url: Optional[str] = None, members_url: Optional[str] = None, name: Optional[str] = None, description: Optional[str] = None, permission: Optional[str] = None, privacy: Optional[str] = None, html_url: Optional[str] = None, repositories_url: Optional[str] = None, slug: Optional[str] = None, ldap_dn: Optional[str] = None)
Definition: TeamDetails
Attributes
class-attribute
instance-attribute
Unique identifier of the team.
class-attribute
instance-attribute
The Node ID for the team.
class-attribute
instance-attribute
URL for the team.
class-attribute
instance-attribute
The HTTP URL for the team members.
class-attribute
instance-attribute
Name of the team
class-attribute
instance-attribute
Description of the team
class-attribute
instance-attribute
Permission that the team will have for its repositories
class-attribute
instance-attribute
The level of privacy this team should have
class-attribute
instance-attribute
HTML Url of the team.
class-attribute
instance-attribute
The HTTP URL for this team's repositories.
class-attribute
instance-attribute
The slug corresponding to the team.
dataclass
WebhookPullRequestResponse(*, action: Optional[str] = None, number: Optional[int] = None, pull_request: Optional[PullRequest | Mapping[str, Any]] = None)
Definition: WebhookPullRequestResponse
dataclass
Definition: WebhookRequestBody
dataclass
RequestReviewersBody(*, reviewers: Optional[List[str]] = None, team_reviewers: Optional[List[str]] = None)
Definition: RequestReviewersBody
dataclass
QueryRequest(*, jsonrpc: Optional[str] = None, id: Optional[str] = None, method: Optional[str] = None, params: Optional[Dict[str, Any]] = None, result: Optional[Dict[str, Any]] = None, error: Optional[Dict[str, Any]] = None)
Definition: QueryRequest
GithubClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for github connector.
Initialize a GithubClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
async
create_issue(input: IssueBasicDetailsModel | Mapping[str, Any], repository_owner: str, repository_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create an issue
This operation is used to create a new issue for a specific repository.
Swagger operation ID: CreateIssue.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
IssueBasicDetailsModel | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_issues(repository_owner: str, repository_name: str, *, milestone: Optional[str] = None, state: Optional[str] = None, assignee: Optional[str] = None, creator: Optional[str] = None, mentioned: Optional[str] = None, labels: Optional[str] = None, sort: Optional[str] = None, direction: Optional[str] = None, since: Optional[str] = None, per_page: Optional[int] = None, page: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get all issues of a repository
Get all issues of a repository.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetIssues.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
milestone
|
Optional[str]
|
Filter by milestone. |
None
|
state
|
Optional[str]
|
Filter by state. |
None
|
assignee
|
Optional[str]
|
Filter by assignee. |
None
|
creator
|
Optional[str]
|
Filter by creator. |
None
|
mentioned
|
Optional[str]
|
Filter by mentions. |
None
|
labels
|
Optional[str]
|
Filter by label names. |
None
|
sort
|
Optional[str]
|
Field to sort results by. |
None
|
direction
|
Optional[str]
|
Direction of sort. |
None
|
since
|
Optional[str]
|
Filter by issues after given date. |
None
|
per_page
|
Optional[int]
|
Number of results per page. |
None
|
page
|
Optional[int]
|
Page number to display. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_repository_public_key(repository_owner: str, repository_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a repository public key
Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.
Swagger operation ID: GetRepositoryPublicKey.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_update_repository_secret(input: CreateRepositorySecretRequest | Mapping[str, Any], repository_owner: str, repository_name: str, secret_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Create or update a repository secret
Creates or updates a repository secret with an encrypted value. Encrypt your secret using LibSodium.
Swagger operation ID: CreateUpdateRepositorySecret.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateRepositorySecretRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
secret_name
|
str
|
Name of the secret. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_repository_using_template(input: CreateRepositoryUsingTemplateRequest | Mapping[str, Any], template_owner: str, template_repository: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a repository using a template
Creates a new repository using a repository template. The authenticated user must own or be a member of an organization that owns the repository.
Swagger operation ID: CreateRepositoryUsingTemplate.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateRepositoryUsingTemplateRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
template_owner
|
str
|
Name of the template repository owner. |
required |
template_repository
|
str
|
Name of the template repository. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_repository_by_id(repository_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a repository by Id
Gets a repository by Id.
Swagger operation ID: GetRepositoryById.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_id
|
int
|
Unique Identifier of the repository. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_reference(input: CreateReferenceRequest | Mapping[str, Any], repository_owner: str, repository_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a reference
Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
Swagger operation ID: CreateReference.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateReferenceRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_reference(repository_owner: str, repository_name: str, reference: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a reference
Returns a single reference from your Git database. The reference
parameter must be formatted as heads/<branch name> for branches and
tags/<tag name> for tags. If the reference doesn't match an
existing ref, a 404 is returned.
Swagger operation ID: GetReference.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
reference
|
str
|
The ref in the URL must be formatted as heads/ |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
merge_pull_request(input: PullRequestMergeRequest | Mapping[str, Any], repository_owner: str, repository_name: str, pull_number: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Merge a pull request
This operation is used to merge a pull request for the repository.
Swagger operation ID: MergePullRequest.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PullRequestMergeRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
pull_number
|
int
|
Pull Number. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_pull_request(repository_owner: str, repository_name: str, pull_number: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a pull request
This operation is used to get a pull request for the repository.
Swagger operation ID: GetPullRequest.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
pull_number
|
int
|
Pull Number. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_pull_request(input: PullRequestUpdateRequest | Mapping[str, Any], repository_owner: str, repository_name: str, pull_number: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update a pull request
This operation is used to update a pull request for the repository. To update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
Swagger operation ID: UpdatePullRequest.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PullRequestUpdateRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
pull_number
|
int
|
Pull Number. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_pull_request_files(repository_owner: str, repository_name: str, pull_number: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get the list of files from a pull request
This operation is used to get the list of files from a pull request for the repository.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetPullRequestFiles.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
pull_number
|
int
|
Pull Number. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
request_reviewers_pull_request(input: RequestReviewersBody | Mapping[str, Any], repository_owner: str, repository_name: str, pull_number: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Request reviewers for a pull request
Requests reviews for a pull request from a given set of users and/or teams.
Swagger operation ID: RequestReviewersPullRequest.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
RequestReviewersBody | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
pull_number
|
int
|
Pull Number. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
remove_reviewers_pull_request(input: RequestReviewersBody | Mapping[str, Any], repository_owner: str, repository_name: str, pull_number: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Remove requested reviewers from a pull request
Remove requested reviewers from a pull request from a given set of users and/or teams.
Swagger operation ID: RemoveReviewersPullRequest.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
RequestReviewersBody | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
pull_number
|
int
|
Pull Number. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_pull_request(input: PullRequestCreateRequest | Mapping[str, Any], repository_owner: str, repository_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a pull request
This operation is to create a pull request in a repository. To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to create a pull request.
Swagger operation ID: CreatePullRequest.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PullRequestCreateRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_pull_requests(repository_owner: str, repository_name: str, *, state: Optional[str] = None, head: Optional[str] = None, base: Optional[str] = None, sort: Optional[str] = None, direction: Optional[str] = None, per_page: Optional[int] = None, page: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get all Pull Requests of A Repository
Get all Pull Requests of A Repository.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetPullRequests.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
state
|
Optional[str]
|
Filter by state. |
None
|
head
|
Optional[str]
|
Filter by head user or organization. |
None
|
base
|
Optional[str]
|
Filter by base branch name. |
None
|
sort
|
Optional[str]
|
What to sort the results by. |
None
|
direction
|
Optional[str]
|
Direction of sort. |
None
|
per_page
|
Optional[int]
|
Number of results per page. |
None
|
page
|
Optional[int]
|
Page number to display. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
create_repository_dispatch_event(input: RepositoryDispatchEvent | Mapping[str, Any], repository_owner: str, repository_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Create a repository dispatch event
This operation is to trigger a webhook event called
repository_dispatch when you want activity that happens outside of
GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You
must configure your GitHub Actions workflow or GitHub App to run when
the repository_dispatch event occurs.
Swagger operation ID: CreateRepositoryDispatchEvent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
RepositoryDispatchEvent | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
compare_repository_commits(repository_owner: str, repository_name: str, base: str, head: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Compare two commits
Both base and head must be branch names in repositoryName. To
compare branches across other repositories in the same network as
repositoryName, use the format <USERNAME>:branch. The response is
equivalent to running the git log base..head command; however,
commits are returned in chronological order.
Swagger operation ID: CompareRepositoryCommits.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
base
|
str
|
base parameter. |
required |
head
|
str
|
head parameter. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
add_selected_repo_to_org_secret(repository_owner: str, repository_id: int, secret_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Add selected repository to an organization secret
Adds a repository to an organization secret when the visibility for
repository access is set to selected. The visibility is set when you
Create or update an organization
secret.
You must authenticate using an access token with the admin:org scope
to use this endpoint. GitHub Apps must have the secrets organization
permission to use this endpoint.
Swagger operation ID: AddSelectedRepoToOrgSecret.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_id
|
int
|
Unique Identifier of the repository. |
required |
secret_name
|
str
|
Name of the secret. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
remove_selected_repo_from_org_secret(repository_owner: str, repository_id: int, secret_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Remove selected repository from an organization secret
Removes a repository from an organization secret when the visibility
for repository access is set to selected. The visibility is set when
you Create or update an organization
secret.
You must authenticate using an access token with the admin:org scope
to use this endpoint. GitHub Apps must have the secrets organization
permission to use this endpoint.
Swagger operation ID: RemoveSelectedRepoFromOrgSecret.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_id
|
int
|
Unique Identifier of the repository. |
required |
secret_name
|
str
|
Name of the secret. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
delete_webhook_trigger(repository_owner: str, repository_name: str, webhook_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Deletes a GitHub Webhook
Deletes a GitHub Webhook
Swagger operation ID: DeleteWebhookTrigger.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
webhook_id
|
str
|
ID of the GitHub Webhook. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_issue_num(repository_owner: str, repository_name: str, issue_number: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get a particular issue of a repository
Get a particular issue of a repository.
Swagger operation ID: GetIssueNum.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
issue_number
|
int
|
Issue Number for a given issue. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_issue_num(input: IssueUpdateModel | Mapping[str, Any], repository_owner: str, repository_name: str, issue_number: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update an Issue
Update an existing issue given the issue number.
Swagger operation ID: UpdateIssueNum.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
IssueUpdateModel | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
issue_number
|
int
|
Issue Number for a given issue. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_milestone(input: MilestoneUpdateModel | Mapping[str, Any], repository_owner: str, repository_name: str, milestone_number: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update a milestone
Update an existing milestone.
Swagger operation ID: UpdateMilestone.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
MilestoneUpdateModel | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
milestone_number
|
int
|
Milestone number for a given milestone. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_user(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get the authenticated user
Get the authenticated user.
Swagger operation ID: GetUser.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
search_github_with_query(input: GraphQlQuery | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Search Github using Query
Search Github using Query
Swagger operation ID: SearchGithubWithQuery.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GraphQlQuery | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_assignees(repository_owner: str, repository_name: str, *, per_page: Optional[int] = None, page: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Lists the available assignees for issues in a repository
Lists the available assignees for issues in a repository.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetAssignees.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
per_page
|
Optional[int]
|
Number of results per page. |
None
|
page
|
Optional[int]
|
Page number to display. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_collaborators(repository_owner: str, repository_name: str, *, per_page: Optional[int] = None, page: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List repository collaborators
List repository collaborators.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListCollaborators.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
per_page
|
Optional[int]
|
Number of results per page. |
None
|
page
|
Optional[int]
|
Page number to display. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
check_collaborator(repository_owner: str, repository_name: str, user_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Check if a user is a repository collaborator
Check if a user is a repository collaborator.
Swagger operation ID: checkCollaborator.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
user_name
|
str
|
The handle for the GitHub user account. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_milestones(repository_owner: str, repository_name: str, *, state: Optional[str] = None, sort: Optional[str] = None, direction: Optional[str] = None, per_page: Optional[int] = None, page: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Lists all milestones of a repository
Lists all milestones of a repository.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetMilestones.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
state
|
Optional[str]
|
State of the milestone. |
None
|
sort
|
Optional[str]
|
What to sort the results by. |
None
|
direction
|
Optional[str]
|
Direction of sort. |
None
|
per_page
|
Optional[int]
|
Number of results per page. |
None
|
page
|
Optional[int]
|
Page number to display. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_labels(repository_owner: str, repository_name: str, *, per_page: Optional[int] = None, page: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Lists all labels for a repository
Lists all labels for a repository.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetLabels.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
per_page
|
Optional[int]
|
Number of results per page. |
None
|
page
|
Optional[int]
|
Page number to display. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_issue_labels(repository_owner: str, repository_name: str, issue_number: int, *, per_page: Optional[int] = None, page: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Lists all labels for an issue
Lists all labels for an issue.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetIssueLabels.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
repository_name
|
str
|
Name of the repository. |
required |
issue_number
|
int
|
Issue Number for a given issue. |
required |
per_page
|
Optional[int]
|
Number of results per page. |
None
|
page
|
Optional[int]
|
Page number to display. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_repos(repository_owner: str, *, type_: Optional[str] = None, sort: Optional[str] = None, direction: Optional[str] = None, per_page: Optional[int] = None, page: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Lists all public repositories for a user
Lists all public repositories for a user.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetRepos.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
type_
|
Optional[str]
|
Limit results to repositories of the specified type. |
None
|
sort
|
Optional[str]
|
The property to sort the results by. |
None
|
direction
|
Optional[str]
|
Direction of sort. |
None
|
per_page
|
Optional[int]
|
Number of results per page. |
None
|
page
|
Optional[int]
|
Page number to fetch. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_org_repos(repository_owner: str, *, type_: Optional[str] = None, sort: Optional[str] = None, direction: Optional[str] = None, per_page: Optional[int] = None, page: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Lists all public repositories for an organization
Lists all public repositories for an organization.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetOrgRepos.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
repository_owner
|
str
|
Name of the repository owner. |
required |
type_
|
Optional[str]
|
Limit results to repositories of the specified type. |
None
|
sort
|
Optional[str]
|
The property to sort the results by. |
None
|
direction
|
Optional[str]
|
Direction of sort. |
None
|
per_page
|
Optional[int]
|
Number of results per page. |
None
|
page
|
Optional[int]
|
Page number to fetch. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_user_repos(*, visibility: Optional[str] = None, affiliation: Optional[str] = None, since: Optional[str] = None, before: Optional[str] = None, type_: Optional[str] = None, sort: Optional[str] = None, direction: Optional[str] = None, per_page: Optional[int] = None, page: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Lists all repositories for the authenticated user
Lists all repositories (both public and private) for the authenticated user.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetUserRepos.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
visibility
|
Optional[str]
|
Limit results to repositories of the specified visibility(public/private/all). |
None
|
affiliation
|
Optional[str]
|
Limit results based on affiliation. |
None
|
since
|
Optional[str]
|
Limit results to repositories updated after a given time. |
None
|
before
|
Optional[str]
|
Limit results to repositories updated before a given time. |
None
|
type_
|
Optional[str]
|
Limit results to repositories of the specified type. |
None
|
sort
|
Optional[str]
|
The property to sort the results by. |
None
|
direction
|
Optional[str]
|
Direction of sort. |
None
|
per_page
|
Optional[int]
|
Number of results per page. |
None
|
page
|
Optional[int]
|
Page number to fetch. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_search_issues(q: str, *, sort: Optional[str] = None, order: Optional[str] = None, per_page: Optional[int] = None, page: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Find issues by state and keyword
Find issues by state and keyword.
Returns a single-page Azure Core async collection.
Swagger operation ID: SearchIssues.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
q
|
str
|
Search keywords and qualifiers. |
required |
sort
|
Optional[str]
|
The property to sort the results by. |
None
|
order
|
Optional[str]
|
Direction of sort. |
None
|
per_page
|
Optional[int]
|
Number of results per page. |
None
|
page
|
Optional[int]
|
Page number to fetch. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
invoke_mcp_server(input: QueryRequest | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Github MCP Server
Github MCP Server
Swagger operation ID: InvokeMCPServer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
QueryRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |