Ballerina library

github

Modules

github

github

github.webhook

Module github

OverviewPrerequisitesQuickstart

API

Client

Declarations

PULL_REQUEST_STATE_ALL
STATE_ALL
STATE_CLOSED
STATE_MERGED
STATE_OPEN

DiffSide
IssueState
ProjectState
ProjectTemplate
PullRequestReviewEvent
PullRequestReviewState
PullRequestState
RepositoryVisibility

Definitions

Actor
AddCommentInput
AddIssueCommentInput
AddIssueLabelsInput
AddLabelsToLabelableInput
AddPullRequestReviewInput
Branch
BranchList
BranchListPayload
CollaboratorList
CollaboratorListPayload
Configuration
CreateIssueInput
CreateIssueInputPayload
CreateLabelInput
CreateProjectInput
CreatePullRequestInput
CreateRepositoryInput
CreateRepositoryProjectInput
DeleteIssueCommentInput
DeleteLabelInput
DeleteProjectInput
DeletePullRequestReviewInput
DraftPullRequestReviewComment
DraftPullRequestReviewThread
Issue
IssueComment
IssueCommentList
IssueCommentListPayload
IssueList
IssueListPayload
Label
LabelList
LabelListPayload
Milestone
MilestoneList
MilestoneListPayload
Organization
OrganizationList
OrganizationListPayload
PageInfo
Project
ProjectList
ProjectListPayload
PullRequest
PullRequestList
PullRequestListPayload
PullRequestReview
PullRequestReviewList
PullRequestReviewListPayload
Ref
RemoveIssueLabelInput
RemoveLabelsFromLabelableInput
Repository
RepositoryList
RepositoryListPayload
RepositoryOwner
UpdateIssueCommentInput
UpdateIssueInput
UpdateIssueInputPayload
UpdateLabelInput
UpdateProjectInput
UpdatePullRequestInput
UpdatePullRequestInputPayload
UpdatePullRequestReviewInput
UpdateRepositoryInput
User
UserList
UserListPayload

ballerinax/github Ballerina library

1.0.1

Overview

This GitHub connector client module provides capability to perform operations on major resource types such as Repositories, Issues, Pull Requests, Projects etc.

This module supports GitHub API v4 version and only allows to perform functions behalf of the user who is currently logged in.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

  • Create account

  • Obtain token - To obtain a personal access token via which the connector can access the API, follow these steps

  • Configure the connector with obtained token

Quickstart

To use the GitHub connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/github module into the Ballerina project as follows.

Copy
import ballerinax/github;

Step 2: Create a new connector instance

Create a github:Configuration using your GitHub personal access token and and initialize the connector with it.

Copy
ithub:Configuration config = {
   token: accessToken
;

ithub:Client githubClient = new (config);

Step 3: Invoke connector operation

  • Get All Open Pull Requests In A Repository
Copy
github:PullRequestList response = check githubClient->getRepositoryPullRequestList(<GitHub_Username>, <GitHub_Repository_Name>, github:PULL_REQUEST_OPEN, <Per_Page_Count>);
  • Use bal run command to compile and run the Ballerina program.

You can find a list of samples here

Clients

github: Client

Isolated

Ballerina GitHub connector provides the capability to access GitHub GraphQL API. This connector lets you to get authorized access to GitHub data in a personal or organization account.

Constructor

Initialize the connector. During the initialization you have to pass Create a GitHub account and obtain tokens following this guid

init (Configuration config)
  • config Configuration - Configurations required to initialize the Client

getAuthenticatedUser

Isolated FunctionRemote Function
function getAuthenticatedUser() returns User|error

Get authenticated user

Return Type
  • User|error - User record if successful else error

getUserId

Isolated FunctionRemote Function
function getUserId(string userName) returns string|error

Get User Id

Parameters
  • userName string - GitHub username
Return Type

getUserRepository

Isolated FunctionRemote Function
function getUserRepository(string username, string repositoryName) returns Repository|error

Get user repository

Parameters
  • username string - GitHub repository owner name
  • repositoryName string - GitHub repository name
Return Type

getAuthenticatedUserRepositoryList

Isolated FunctionRemote Function
function getAuthenticatedUserRepositoryList(int perPageCount, string? nextPageCursor) returns RepositoryList|error

Get authenticated user repository list

Parameters
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

getUserRepositoryList

Isolated FunctionRemote Function
function getUserRepositoryList(string username, int perPageCount, string? nextPageCursor) returns RepositoryList|error

Get user repository list

Parameters
  • username string - Repository owner name
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

getOrganizationRepositoryList

Isolated FunctionRemote Function
function getOrganizationRepositoryList(string organizationName, int perPageCount, string? nextPageCursor) returns RepositoryList|error

Get organization repository list

Parameters
  • organizationName string - Organization GitHub username
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

getRepositoryCollobaratorList

Isolated FunctionRemote Function
function getRepositoryCollobaratorList(string ownerName, string repositoryName, int perPageCount, string? nextPageCursor) returns CollaboratorList|error

Get repository collaborator list

Parameters
  • ownerName string - Repository owner username
  • repositoryName string - Repository name
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

getRepositoryBranchList

Isolated FunctionRemote Function
function getRepositoryBranchList(string ownerName, string repositoryName, int perPageCount, string? nextPageCursor) returns BranchList|error

Get repository branch list

Parameters
  • ownerName string - Repository owner name
  • repositoryName string - Repository name
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

createRepository

Isolated FunctionRemote Function
function createRepository(CreateRepositoryInput createRepositoryInput) returns error?

Create repository

Parameters
Return Type
  • error? - error if not successful

updateRepository

Isolated FunctionRemote Function
function updateRepository(UpdateRepositoryInput updateRepositoryInput, string repositoryOwnerName, string repositoryName) returns error?

Update repository

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
Return Type
  • error? - error if not successful

getRepositoryIssueListAssignedToUser

Isolated FunctionRemote Function
function getRepositoryIssueListAssignedToUser(string repositoryOwnerName, string repositoryName, string assignee, int perPageCount, string? nextPageCursor) returns IssueList|error

Get repository issue list assigned to user

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
  • assignee string - Issue assignee username
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

getRepositoryIssueList

Isolated FunctionRemote Function
function getRepositoryIssueList(string repositoryOwnerName, string repositoryName, IssueState[] states, int perPageCount, string? nextPageCursor) returns IssueList|error

Get repository issue list

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

createIssue

Isolated FunctionRemote Function
function createIssue(CreateIssueInput createIssueInput, string repositoryOwnerName, string repositoryName) returns Issue|error

Create issue

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
Return Type
  • Issue|error - Issue record if successful else error

updateIssue

Isolated FunctionRemote Function
function updateIssue(UpdateIssueInput updateIssueInput, string repositoryOwnerName, string repositoryName, int issueNumber) returns Issue|error

Update issue

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
  • issueNumber int - Issue number of the issue to be updated
Return Type
  • Issue|error - Issue record if successful else error

getRepositoryIssue

Isolated FunctionRemote Function
function getRepositoryIssue(string repositoryOwnerName, string repositoryName, int issueNumber) returns Issue|error

Get repository issue

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - repositoryName
  • issueNumber int - Issue number
Return Type
  • Issue|error - Issue record if successful else error

getRepositoryIssueCommentList

Isolated FunctionRemote Function
function getRepositoryIssueCommentList(string repositoryOwnerName, string repositoryName, int issueNumber, int perPageCount, string? nextPageCursor) returns IssueCommentList|error

Get repository issue comment list

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
  • issueNumber int - Issue number
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

getIssuesWithLabel

Isolated FunctionRemote Function
function getIssuesWithLabel(string repositoryOwnerName, string repositoryName, string labelName, int perPageCount, string? nextPageCursor) returns IssueList|error

Get issue with label

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
  • labelName string - Label name
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

addComment

Isolated FunctionRemote Function
function addComment(AddIssueCommentInput addIssueCommentInput) returns IssueComment|error

Add issue comment

Parameters
Return Type

updateComment

Isolated FunctionRemote Function
function updateComment(UpdateIssueCommentInput updateCommentInput) returns error?

Update issue comment

Parameters
Return Type
  • error? - error if un-successful

deleteComment

Isolated FunctionRemote Function
function deleteComment(DeleteIssueCommentInput deleteCommentInput) returns error?

Delete issue comment

Parameters
Return Type
  • error? - error if un-successful

getRepositoryLabel

Isolated FunctionRemote Function
function getRepositoryLabel(string repositoryOwnerName, string repositoryName, string labelName) returns Label|error

Get repository label

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
  • labelName string - Label name
Return Type
  • Label|error - Label record if successful else error

getLabelsInIssue

Isolated FunctionRemote Function
function getLabelsInIssue(string repositoryOwnerName, string repositoryName, int issueNumber, int perPageCount, string? nextPageCursor) returns LabelList|error

Get labels in an issue

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
  • issueNumber int - Issue number
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

addIssueLabels

Isolated FunctionRemote Function
function addIssueLabels(AddIssueLabelsInput addIssueLabelsInput) returns LabelList|error

Add labels to an issue

Parameters
Return Type

removeLabelFromLabelable

Isolated FunctionRemote Function
function removeLabelFromLabelable(RemoveIssueLabelInput removeIssueLabelInput) returns error?

Remove issue labeles

Parameters
Return Type
  • error? - error if failed

getRepositoryMilestoneList

Isolated FunctionRemote Function
function getRepositoryMilestoneList(string repositoryOwnerName, string repositoryName, int perPageCount, string? nextPageCursor) returns MilestoneList|error

Get repository milestone list

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

getRepositoryMilestone

Isolated FunctionRemote Function
function getRepositoryMilestone(string repositoryOwnerName, string repositoryName, int milestoneNumber) returns Milestone|error

Get repository milestone

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
  • milestoneNumber int - Milestone number
Return Type

getPullRequest

Isolated FunctionRemote Function
function getPullRequest(string repositoryOwnerName, string repositoryName, int pullRequestNumber) returns PullRequest|error

Get pull requests

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
  • pullRequestNumber int - Pull request number
Return Type

getRepositoryPullRequestList

Isolated FunctionRemote Function
function getRepositoryPullRequestList(string repositoryOwnerName, string repositoryName, PullRequestState state, int perPageCount, string? nextPageCursor) returns PullRequestList|error

Get repository pull request list

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

createPullRequest

Isolated FunctionRemote Function
function createPullRequest(CreatePullRequestInput createPullRequestInput, string repositoryOwnerName, string repositoryName) returns PullRequest|error

Create pull request

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
Return Type

updatePullRequest

Isolated FunctionRemote Function
function updatePullRequest(UpdatePullRequestInput updatePullRequestInput, string repositoryOwnerName, string repositoryName, int pullRequestNumber) returns PullRequest|error

Update pull request

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
  • pullRequestNumber int - Pull request number
Return Type

getPullRequestReviewCommentList

Isolated FunctionRemote Function
function getPullRequestReviewCommentList(string repositoryOwnerName, string repositoryName, int pullRequestNumber, int perPageCount, string? nextPageCursor) returns PullRequestReviewList|error

Get pull request review comment list

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
  • pullRequestNumber int - Pull request number
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

createPullRequestReview

Isolated FunctionRemote Function
function createPullRequestReview(AddPullRequestReviewInput addPullRequestReviewInput, string repositoryOwnerName, string repositoryName, int pullRequestNumber) returns PullRequestReview|error

Create pull request review

Parameters
  • repositoryOwnerName string - Repository owner name
  • repositoryName string - Repository name
  • pullRequestNumber int - Pull request number
Return Type

updatePullRequestReview

Isolated FunctionRemote Function
function updatePullRequestReview(UpdatePullRequestReviewInput updatePullRequestReviewInput) returns error?

Update pull request review

Parameters
Return Type
  • error? - error if failed.

deletePendingPullRequestReview

Isolated FunctionRemote Function
function deletePendingPullRequestReview(DeletePullRequestReviewInput deletePullRequestReview) returns error?

Delete pending pull request review

Parameters
Return Type
  • error? - error if failed

getOrganizationProjectList

Isolated FunctionRemote Function
function getOrganizationProjectList(string organizationName, ProjectState state, int perPageCount, string? nextPageCursor) returns ProjectList|error

Get organization project list

Parameters
  • organizationName string - Organization name
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

createProject

Isolated FunctionRemote Function
function createProject(CreateRepositoryProjectInput createRepositoryProjectInput) returns Project|error

Create project

Parameters
Return Type

getUserProject

Isolated FunctionRemote Function
function getUserProject(string username, int projectNumber) returns Project|error

Get user project

Parameters
  • username string - Project owner name
  • projectNumber int - Project number
Return Type

updateProject

Isolated FunctionRemote Function
function updateProject(UpdateProjectInput updateProjectInput) returns Project|error

Update project

Parameters
Return Type

deleteProject

Isolated FunctionRemote Function
function deleteProject(DeleteProjectInput deleteProjectInput) returns error?

Delete project

Parameters
Return Type
  • error? - error if failed

getRepositoryProjectList

Isolated FunctionRemote Function
function getRepositoryProjectList(string repositoryOwner, string repositoryName, ProjectState state, int perPageCount, string? nextPageCursor) returns ProjectList|error

Get Repository project list

Parameters
  • repositoryOwner string - Repository owner name
  • repositoryName string - Repository name
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

getUserProjectList

Isolated FunctionRemote Function
function getUserProjectList(string username, int perPageCount, string? nextPageCursor) returns ProjectList|error

Get user project list

Parameters
  • username string - Project owner name
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

getOrganization

Isolated FunctionRemote Function
function getOrganization(string organizationName) returns Organization|error

Get a organization

Parameters
  • organizationName string - Organization name
Return Type

getUserOrganizationList

Isolated FunctionRemote Function
function getUserOrganizationList(string username, int perPageCount, string? nextPageCursor) returns OrganizationList|error

Get user organization list

Parameters
  • username string - Organization username
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

getOrganizationMemberList

Isolated FunctionRemote Function
function getOrganizationMemberList(string organizationName, int perPageCount, string? nextPageCursor) returns UserList|error

Get organization member list

Parameters
  • organizationName string - Organization username
  • perPageCount int - Per page record count
  • nextPageCursor string? (default ()) - Next page token
Return Type

getOrganizationOwnerId

Isolated FunctionRemote Function
function getOrganizationOwnerId(string organizationName) returns string|error

Get organization Id

Parameters
  • organizationName string - Organization username
Return Type

Constants

github: PULL_REQUEST_STATE_ALL

string "[\"OPEN\",\"CLOSED\",\"MERGED\"]"

Pull request state open, closed and merged

github: STATE_ALL

string "[\"OPEN\",\"CLOSED\"]"

State open and closed

github: STATE_CLOSED

string "[\"CLOSED\"]"

Closed state

github: STATE_MERGED

string "[\"MERGED\"]"

Merged state

github: STATE_OPEN

string "[\"OPEN\"]"

Open state

Enums

github: DiffSide

Represent GitHub change Diff sides.

Members

DIFF_SIDE_RIGHT - The right side of the diff.
DIFF_SIDE_LEFT - The left side of the diff.

github: IssueState

Represent issue state types.

Members

ISSUE_OPEN - An issue that is still open
ISSUE_CLOSED - An issue that has been closed

github: ProjectState

Represent GitHub project state.

Members

PROJECT_OPEN - The project is open.
PROJECT_CLOSED - The project is closed.

github: ProjectTemplate

Represent GitHub project templates.

Members

PROJECT_TEMPLATE_AUTOMATED_KANBAN_V2 - Create a board with v2 triggers to automatically move cards across To do, In progress and Done columns.
PROJECT_TEMPLATE_AUTOMATED_REVIEWS_KANBAN - Create a board with triggers to automatically move cards across columns with review automation.
PROJECT_TEMPLATE_BASIC_KANBAN - Create a board with columns for To do, In progress and Done.
PROJECT_TEMPLATE_BUG_TRIAGE - Create a board to triage and prioritize bugs with To do, priority, and Done columns.

github: PullRequestReviewEvent

Represent GitHub pull request review states.

Members

PULL_REQUEST_REVIEW_COMMENT - Submit general feedback without explicit approval.
PULL_REQUEST_REVIEW_APPROVE - Submit feedback and approve merging these changes.
PULL_REQUEST_REVIEW_REQUEST_CHANGES - Submit feedback that must be addressed before merging.
PULL_REQUEST_REVIEW_DISMISS - Dismiss review so it now longer effects merging.

github: PullRequestReviewState

Represent GitHub pull request review state.

Members

PR_REVIEW_PENDING - A review that has not yet been submitted.
PR_REVIEW_COMMENTED - An informational review.
PR_REVIEW_APPROVED - A review allowing the pull request to merge.
PR_REVIEW_CHANGES_REQUESTED - A review blocking the pull request from merging.
PR_REVIEW_DISMISSED - A review that has been dismissed.

github: PullRequestState

Represent GitHub pull request states.

Members

PULL_REQUEST_OPEN - A pull request that is still open.
PULL_REQUEST_CLOSED - A pull request that has been closed without being merged.

github: RepositoryVisibility

Represent repository visibility types

Members

PRIVATE_REPOSITORY - The repository is visible only to anyone
PUBLIC_REPOSITORY - The repository is visible only to those with explicit access.
INTERNAL_REPOSITORY - The repository is visible only to users in the same business.

Records

github: Actor

Represent GitHub actor.

Fields
  • login string - The username of the actor.
  • resourcePath string? - The HTTP path for this actor.
  • url string? - The HTTP URL for this actor.
  • avatarUrl string? - A URL pointing to the actor's public avatar.

github: AddCommentInput

Represent add comment input payload.

Fields
  • subjectId string - The Node ID of the subject to modify.
  • body string - The contents of the comment.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: AddIssueCommentInput

Represent add comment input payload.

Fields
  • repositoryOwnerName string - GitHub username of the repository owner
  • repositoryName string - Repository name
  • issueNumber int - Issue number
  • body string - The contents of the comment.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: AddIssueLabelsInput

Represent add label to issue input payload.

Fields
  • repositoryOwnerName string - Repository owner name/ GitHub username
  • repositoryName string - Repository name
  • issueNumber int - Issue number
  • labelNames string[] - Repository label name
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: AddLabelsToLabelableInput

Represent add label to labelable input payload.

Fields
  • labelableId string - The id of the labelable object to add labels to.
  • labelIds string[]? - The ids of the labels to add.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: AddPullRequestReviewInput

Represent GitHub pull request review create input payload.

Fields
  • pullRequestId string? - The Node ID of the pull request to modify.
  • commitOID string? - The commit OID the review pertains to.
  • body string? - The contents of the review body comment.
  • clientMutationId string? - A unique identifier for the client performing the mutation. A unique identifier for the client performing the mutation.

github: Branch

Represent GitHub branch.

Fields
  • name string - Name of the branch
  • prefix string - GitHub reference prefix

github: BranchList

Represent GitHub branch list.

Fields
  • branches Branch[] - Branch list.
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total branch count.

github: BranchListPayload

Represent GitHub branch list.

Fields
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total branch count.

github: CollaboratorList

Represent GitHub collaborator list.

Fields
  • collaborators User[] - Collaborator list.
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total collaborator count.

github: CollaboratorListPayload

Represent GitHub collaborator list.

Fields
  • nodes User[] - Collaborator list.
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total collaborator count.

github: Configuration

Represents the Github Client Connector Endpoint configuration.

Fields
  • accessToken string - The access token of the Github

github: CreateIssueInput

Represent create issue input payload.

Fields
  • title string - The title for the issue.
  • body string? - The body for the issue description.
  • assigneeNames string[]? - The GitHub usernames of the user assignees for this issue.
  • milestoneId string? - The Node ID of the milestone for this issue.
  • labelNames string[]? - An array of Node IDs of labels for this issue.
  • projectIds string[]? - An array of Node IDs for projects associated with this issue.
  • issueTemplate string? - The name of an issue template in the repository, assigns labels and assignees from the template to the issue
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: CreateIssueInputPayload

Represent create issue input payload.

Fields
  • repositoryId string - The Node ID of the repository.
  • title string - The title for the issue.
  • body string? - The body for the issue description.
  • assigneeIds string[]? - The Node ID for the user assignee for this issue.
  • milestoneId string? - The Node ID of the milestone for this issue.
  • labelIds string[]? - An array of Node IDs of labels for this issue.
  • projectIds string[]? - An array of Node IDs for projects associated with this issue.
  • issueTemplate string? - The name of an issue template in the repository, assigns labels and assignees from the template to the issue
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: CreateLabelInput

Represent create label input payload.

Fields
  • name string - Name of the label
  • description string - Description of the label
  • color string - Color of the label
  • repositoryId string - Node ID of the repository where this label needs to be created
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: CreateProjectInput

Represent GitHub project creation input payload.

Fields
  • ownerId string - The owner ID to create the project under.
  • name string - The name of project.
  • body string? - The description of project.
  • repositoryIds string[]? - A list of repository IDs to create as linked repositories for the project
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: CreatePullRequestInput

Represent GitHub pull request create input payload.

Fields
  • repositoryId string? - Node of the repository where the pull request create
  • title string - Title of the pull request
  • baseRefName string - 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.
  • headRefName string - The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head_ref_name with a user like this: username:branch.
  • body string? - The contents of the pull request.
  • maintainerCanModify boolean(default false) - Indicates whether maintainers can modify the pull request.
  • draft boolean(default false) - Indicates whether this pull request should be a draft.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: CreateRepositoryInput

Represent create repository input payload

Fields
  • ownerId string? - The ID of the owner for the new repository.
  • name string - The name of the new repository.
  • description string? - A short description of the new repository.
  • visibility RepositoryVisibility - Indicates the repository's visibility level. eg: github: PUBLIC_REPOSITORY
  • template boolean? - Whether this repository should be marked as a template such that anyone who can access it can create new repositories with the same files and directory structure.
  • homepageUrl string? - The URL for a web page about this repository.
  • hasWikiEnabled boolean? - Indicates if the repository should have the wiki feature enabled.
  • hasIssuesEnabled boolean? - Indicates if the repository should have the issues feature enabled.
  • teamId string? - When an organization is specified as the owner, this ID identifies the team that should be granted access to the new repository.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: CreateRepositoryProjectInput

Represent GitHub project creation input payload.

Fields
  • ownerName string - Repository owner name/ GitHub username.
  • name string - Name of the project
  • body string? - Description of the project.
  • repositoryNames string[]? - Array of repository names to be included in the project.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: DeleteIssueCommentInput

Represent delete issue comment input payload.

Fields
  • id string - The ID of the comment to delete.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: DeleteLabelInput

Represent delete label input payload.

Fields
  • id string - Node ID of the label
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: DeleteProjectInput

Represent GitHub project delete input payload.

Fields
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: DeletePullRequestReviewInput

Represent pull request review delete input payload.

Fields
  • pullRequestReviewId string - The Node ID of the pull request review to delete.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: DraftPullRequestReviewComment

Repreent GitHub draft pull request review comment payload.

Fields
  • path string - Path to the file being commented on.
  • position int - Position in the file to leave a comment on.
  • body string - Body of the comment to leave.

github: DraftPullRequestReviewThread

Represent GitHub draft pull request review thread.

Fields
  • path string - Path to the file being commented on.
  • line int - The line of the blob to which the thread refers. The end of the line range for multi-line comments.
  • side DiffSide(default DIFF_SIDE_RIGHT) - The side of the diff on which the line resides. For multi-line comments, this is the side for the end of the line range.
  • startLine int? - The first line of the range to which the comment refers.
  • startSide DiffSide(default DIFF_SIDE_RIGHT) - The side of the diff on which the start line resides.
  • body string - Body of the comment to leave.

github: Issue

Represent GitHub issue.

Fields
  • author Actor? - The actor who authored the comment.
  • body string? - Identifies the body of the issue.
  • bodyHTML string? - The body rendered to HTML.
  • bodyResourcePath string? - The http path for this issue body
  • bodyText string? - Identifies the body of the issue rendered to text.
  • bodyUrl string? - The http URL for this issue body
  • closed boolean? - true if the object is closed (definition of closed may depend on type)
  • closedAt string? - Identifies the date and time when the object was closed.
  • createdAt string? - Identifies the date and time when the object was created.
  • createdViaEmail boolean? - Check if this comment was created via an email reply.
  • databaseId int? - Identifies the primary key from the database.
  • editor Actor? - The actor who edited the comment.
  • isPinned boolean? - Indicates whether or not this issue is currently pinned to the repository issues list
  • isReadByViewer boolean? - Is this issue read by the viewer
  • lastEditedAt string? - The moment the editor made the last edit
  • locked boolean? - true if the object is locked
  • number int - Identifies the issue number.
  • publishedAt string? - Identifies when the comment was published at.
  • resourcePath string? - The HTTP path for this issue
  • state IssueState? - Identifies the state of the issue.
  • title string? - Identifies the issue title.
  • updatedAt string? - Identifies the date and time when the object was last updated.
  • url string? - The HTTP URL for this issue
  • viewerDidAuthor boolean? - Did the viewer author this comment.
  • viewerCanUpdate boolean? - Check if the current viewer can update this object.

github: IssueComment

Represent GitHub issue comment.

Fields
  • author Actor? - The actor who authored the comment.
  • body string? - The body as Markdown.
  • bodyHTML string? - The body rendered to HTML.
  • bodyText string? - The body rendered to text.
  • createdAt string? - Identifies the date and time when the object was created.
  • databaseId int? - Identifies the primary key from the database.
  • editor Actor? - The actor who edited the comment.
  • isMinimized boolean? - Returns whether or not a comment has been minimized.
  • lastEditedAt string? - The moment the editor made the last edit
  • minimizedReason string? - Returns why the comment was minimized.
  • publishedAt string? - Identifies when the comment was published at.
  • url string? - The HTTP URL for this issue comment
  • viewerCanDelete boolean? - Check if the current viewer can delete this object.
  • viewerCanUpdate boolean? - Check if the current viewer can update this object.
  • viewerDidAuthor boolean? - Did the viewer author this comment.

github: IssueCommentList

Represent GitHub issue comment list.

Fields
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total issues comment count.

github: IssueCommentListPayload

Represent GitHub issue comment list.

Fields
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total issues comment count.

github: IssueList

Represent GitHub issue list.

Fields
  • issues Issue[] - Issue list
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total issues count.

github: IssueListPayload

Represent GitHub issue list.

Fields
  • nodes Issue[] - Issue list
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total issues count.

github: Label

Represent GitHub Label.

Fields
  • color string? - Identifies the label color.
  • createdAt string? - Identifies the date and time when the label was created.
  • description string? - A brief description of this label.
  • isDefault boolean? - Indicates whether or not this is a default label.
  • name string - Identifies the label name.
  • updatedAt string? - Identifies the date and time when the label was last updated.
  • url string? - The HTTP URL for this label.

github: LabelList

Represent GitHub label list.

Fields
  • labels Label[] - Labale list.
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total label count

github: LabelListPayload

Represent GitHub label list.

Fields
  • nodes Label[] - Labale list.
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total label count

github: Milestone

Represent GitHub milestone

Fields
  • closed boolean? - true if the object is closed (definition of closed may depend on type)
  • closedAt string? - Identifies the date and time when the object was closed.
  • createdAt string? - Identifies the date and time when the object was created.
  • creator Actor? - Identifies the actor who created the milestone.
  • description string? - Identifies the description of the milestone.
  • dueOn string? - Identifies the due date of the milestone.
  • progressPercentage float? - Identifies the percentage complete for the milestone
  • resourcePath string? - The HTTP path for this milestone
  • title string? - Identifies the title of the milestone.
  • updatedAt string? - Identifies the date and time when the object was last updated.
  • url string? - The HTTP URL for this milestone

github: MilestoneList

Represent GitHub milestone list.

Fields
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total milestone count

github: MilestoneListPayload

Represent GitHub milestone list.

Fields
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total milestone count

github: Organization

Represent GitHub organization

Fields
  • avatarUrl string? - A URL pointing to the organization's public avatar.
  • description string? - The organization's public profile description.
  • email string? - The organization's public email.
  • location string? - The organization's public profile location.
  • login string - The organization's login name.
  • name string - The organization's public profile name.
  • projectsResourcePath string? - The HTTP path listing organization's projects
  • projectsUrl string? - The HTTP URL listing organization's projects
  • resourcePath string? - The HTTP path for this organization.
  • url string? - The HTTP URL for this organization.
  • websiteUrl string? - The organization's public profile URL.

github: OrganizationList

Represent GitHub organization list.

Fields
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total organization count.

github: OrganizationListPayload

Represent GitHub organization list.

Fields
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total organization count.

github: PageInfo

Represent GitHub page info.

Fields
  • startCursor string - When paginating backwards, the cursor to continue.
  • endCursor string - When paginating forwards, the cursor to continue. [next page token]
  • hasNextPage boolean - When paginating forwards, are there more items?
  • hasPreviousPage boolean - When paginating backwards, are there more items?

github: Project

Represent GitHub project

Fields
  • name string - The project's name.
  • body string? - The project's description body.
  • closed boolean? - true if the object is closed (definition of closed may depend on type)
  • closedAt string? - Identifies the date and time when the object was closed.
  • createdAt string? - Identifies the date and time when the object was created.
  • creator Actor? - The actor who originally created the project.
  • databaseId int? - Identifies the primary key from the database.
  • number int? - The project's number.
  • state ProjectState? - Whether the project is open or closed.
  • updatedAt string? - Identifies the date and time when the object was last updated.
  • url string? - The HTTP URL for this project

github: ProjectList

Represent GitHub project list.

Fields
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total projects count.

github: ProjectListPayload

Represent GitHub project list.

Fields
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total projects count.

github: PullRequest

Represent GitHub pull request.

Fields
  • additions int? - The number of additions in this pull request.
  • author Actor? - The actor who authored the comment.
  • baseRef Ref? - Identifies the base Ref associated with the pull request.
  • baseRefName string? - Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.
  • body string? - The body as Markdown.
  • bodyHTML string? - The body rendered to HTML.
  • bodyText string? - The body rendered to text.
  • changedFiles int? - The number of changed files in this pull request.
  • checksResourcePath string? - The HTTP path for the checks of this pull request.
  • checksUrl string? - The HTTP URL for the checks of this pull request.
  • closed boolean? - true if the pull request is closed
  • closedAt string? - Identifies the date and time when the object was closed.
  • createdAt string? - Identifies the date and time when the object was created.
  • createdViaEmail boolean? - Check if this comment was created via an email reply.
  • databaseId int? - Identifies the primary key from the database.
  • deletions int? - The number of deletions in this pull request.
  • editor Actor? - The actor who edited this pull request's body.
  • headRef Ref? - Identifies the head Ref associated with the pull request.
  • headRefName string? - Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.
  • headRepositoryOwner RepositoryOwner? - The owner of the repository associated with this pull request's head Ref.
  • isDraft boolean? - Identifies if the pull request is a draft.
  • lastEditedAt string? - The moment the editor made the last edit
  • locked boolean? - true if the pull request is locked
  • merged boolean? - Whether or not the pull request was merged.
  • mergedBy Actor? - The actor who merged the pull request.
  • number int - Identifies the pull request number.
  • publishedAt string? - Identifies when the comment was published at.
  • resourcePath string? - The HTTP path for this pull request.
  • revertUrl string? - The HTTP URL for reverting this pull request.
  • title string? - Identifies the pull request title.
  • updatedAt string? - Identifies the date and time when the object was last updated.
  • url string? - The HTTP URL for this pull request.

github: PullRequestList

Represent GitHub pull request list.

Fields
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total pull request count

github: PullRequestListPayload

Represent GitHub pull request list.

Fields
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total pull request count

github: PullRequestReview

Represent GitHub pull request review

Fields
  • body string? - Identifies the pull request review body.
  • createdAt string? - Identifies the date and time when the object was created.
  • lastEditedAt string? - The moment the editor made the last edit
  • url string? - The HTTP URL permalink for this PullRequestReview.
  • publishedAt string? - Identifies when the comment was published at.

github: PullRequestReviewList

Represent GitHub pull request review list.

Fields
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total pull request review count

github: PullRequestReviewListPayload

Represent GitHub pull request review list.

Fields
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total pull request review count

github: Ref

Represent GitHub Reference

Fields
  • prefix string - The ref's prefix, such as refs/heads/ or refs/tags/.

github: RemoveIssueLabelInput

Represent remove label from labelable input payload.

Fields
  • repositoryOwnerName string - Repository owner name/ GitHub username
  • repositoryName string - Repository name
  • issueNumber int - Issue number
  • labelNames string[] - Array of existing label names of the issue to be removed
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: RemoveLabelsFromLabelableInput

Represent remove label from labelable input payload.

Fields
  • labelableId string - The id of the labelable object to add labels to.
  • labelIds string[] - The ids of the labels to add.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: Repository

Represent GitHub repository.

Fields
  • createdAt string - Identifies the date and time when the object was created.
  • databaseId int? - Identifies the primary key from the database.
  • deleteBranchOnMerge boolean? - Whether or not branches are automatically deleted when merged in this repository.
  • description string? - The description of the repository.
  • descriptionHTML string? - The description of the repository rendered to HTML.
  • diskUsage int? - The number of kilobytes this repository occupies on disk.
  • forkCount int? - Returns how many forks there are of this repository in the whole network.
  • hasIssuesEnabled boolean? - Indicates if the repository has issues feature enabled.
  • hasProjectsEnabled boolean? - Indicates if the repository has the Projects feature enabled.
  • hasWikiEnabled boolean? - Indicates if the repository has wiki feature enabled.
  • homepageUrl string? - The repository's URL.
  • isArchived boolean? - Indicates if the repository is unmaintained.
  • isBlankIssuesEnabled boolean? - Returns true if blank issue creation is allowed
  • isDisabled boolean? - Returns whether or not this repository disabled.
  • isEmpty boolean? - Returns whether or not this repository is empty.
  • isFork boolean? - Identifies if the repository is a fork.
  • isInOrganization boolean? - Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.
  • isLocked boolean? - Indicates if the repository has been locked or not.
  • isMirror boolean? - Identifies if the repository is a mirror.
  • isPrivate boolean? - Identifies if the repository is private or internal.
  • isSecurityPolicyEnabled boolean? - Returns true if this repository has a security policy
  • isTemplate boolean? - Identifies if the repository is a template that can be used to generate new repositories.
  • isUserConfigurationRepository boolean? - Is this repository a user configuration repository?
  • mergeCommitAllowed boolean? - Whether or not PRs are merged with a merge commit on this repository.
  • mirrorUrl string? - The repository's original mirror URL.
  • name string - The name of the repository.
  • nameWithOwner string - The repository's name with owner.
  • projectsResourcePath string? - The HTTP path listing the repository's projects
  • projectsUrl string? - The HTTP URL listing the repository's projects
  • pushedAt string? - Identifies when the repository was last pushed to.
  • rebaseMergeAllowed boolean? - Whether or not rebase-merging is enabled on this repository.
  • resourcePath string? - The HTTP path for this repository
  • securityPolicy string? - The security policy URL.
  • sshUrl string? - The SSH URL to clone this repository
  • stargazerCount int? - Returns a count of how many stargazers there are on this object
  • tempCloneToken string? - Temporary authentication token for cloning this repository.
  • updatedAt string? - Identifies the date and time when the object was last updated.
  • url string? - The HTTP URL for this repository
  • viewerCanAdminister boolean? - Indicates whether the viewer has admin permissions on this repository.
  • viewerCanCreateProjects boolean? - Can the current viewer create new projects on this owner.
  • viewerCanSubscribe boolean? - Check if the viewer is able to change their subscription status for the repository.

github: RepositoryList

Represent GitHub repository list.

Fields
  • pageInfo PageInfo - Response pagination info
  • totalCount int - Total repository count

github: RepositoryListPayload

Represent GitHub repository list.

Fields
  • pageInfo PageInfo - Response pagination info
  • totalCount int - Total repository count

github: RepositoryOwner

Represent GitHub repository owner

Fields
  • login string - The username used to login.
  • resourcePath string? - The HTTP URL for the owner.
  • url string? - The HTTP URL for the owner.
  • avatarUrl string? - A URL pointing to the owner's public avatar.

github: UpdateIssueCommentInput

Represent update issue comment input payload.

Fields
  • id string - The ID of the IssueComment to modify.
  • body string - The updated text of the comment.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: UpdateIssueInput

Represent update issue input payload.

Fields
  • id string? - The ID of the Issue to modify.
  • title string? - The title for the issue.
  • body string? - The body for the issue description.
  • assigneeNames string[]? - An array of GitHub usernames of users for this issue.
  • milestoneId string? - The Node ID of the milestone for this issue.
  • labelNames string[]? - An array of label names of labels for this issue.
  • projectIds string[]? - An array of Node IDs for projects associated with this issue.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: UpdateIssueInputPayload

Represent update issue input payload.

Fields
  • id string? - The ID of the Issue to modify.
  • title string? - The title for the issue.
  • body string? - The body for the issue description.
  • assigneeIds string[]? - An array of Node IDs of users for this issue.
  • milestoneId string? - The Node ID of the milestone for this issue.
  • labelIds string[]? - An array of Node IDs of labels for this issue.
  • projectIds string[]? - An array of Node IDs for projects associated with this issue.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: UpdateLabelInput

Represent update label input payload.

Fields
  • name string? - Name of the label
  • description string? - Description of the label
  • color string? - Color of the label
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: UpdateProjectInput

Represent GitHub project update input payload.

Fields
  • projectId string - The Project ID to update.
  • body string? - The description of project.
  • name string? - The name of project.
  • state ProjectState? - Whether the project is open or closed.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: UpdatePullRequestInput

Represent GitHub pull request update input payload.

Fields
  • pullRequestId string? - The Node ID of the pull request.
  • baseRefName string? - The name of the branch you want your changes pulled into. This should be an existing branch on the current repository.
  • title string? - Title of the pull request
  • body string? - The contents of the pull request.
  • maintainerCanModify boolean? - Indicates whether maintainers can modify the pull request.
  • assigneeNames string[]? - An array of assignee names of users for this pull request.
  • milestoneId string? - The Node ID of the milestone for this pull request.
  • labelNames string[]? - An array of label names of labels for this pull request.
  • projectIds string[]? - An array of Node IDs for projects associated with this pull request.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: UpdatePullRequestInputPayload

Represent GitHub pull request update input payload.

Fields
  • pullRequestId string? - The Node ID of the pull request.
  • baseRefName string? - The name of the branch you want your changes pulled into. This should be an existing branch on the current repository.
  • title string? - Title of the pull request
  • body string? - The contents of the pull request.
  • assigneeIds string[]? - An array of Node IDs of users for this pull request.
  • milestoneId string? - The Node ID of the milestone for this pull request.
  • labelIds string[]? - An array of Node IDs of labels for this pull request.
  • projectIds string[]? - An array of Node IDs for projects associated with this pull request.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: UpdatePullRequestReviewInput

Represent GitHub pull request review update input payload.

Fields
  • pullRequestReviewId string - The Node ID of the pull request review to modify.
  • body string - The contents of the pull request review body.
  • clientMutationId string? - A unique identifier for the client performing the mutation.

github: UpdateRepositoryInput

Represent update repository input payload.

Fields
  • clientMutationId string? - A unique identifier for the client performing the mutation.
  • description string? - A new description for the repository. Pass an empty string to erase the existing description.
  • hasIssuesEnabled boolean? - Indicates if the repository should have the issues feature enabled.
  • hasProjectsEnabled boolean? - Indicates if the repository should have the project boards feature enabled.
  • hasWikiEnabled boolean? - Indicates if the repository should have the wiki feature enabled.
  • homePageUrl string? - The URL for a web page about this repository. Pass an empty string to erase the existing URL.
  • name string? - The new name of the repository.
  • repositoryId string? - The ID of the repository to update.
  • template boolean? - Whether this repository should be marked as a template such that anyone who can access it can create new repositories with the same files and directory structure.

github: User

Repesent GitHub user

Fields
  • anyPinnableItems boolean? - Determine if this repository owner has any items that can be pinned to their profile.
  • avatarUrl string? - A URL pointing to the user's public avatar.
  • bio string? - The user's public profile bio.
  • bioHTML string? - The user's public profile bio as HTML.
  • company string? - The user's public profile company.
  • companyHTML string? - The user's public profile company as HTML.
  • createdAt string? - Identifies the date and time when the object was created.
  • databaseId int? - Identifies the primary key from the database.
  • email string? - The user's publicly visible profile email.
  • hasSponsorsListing boolean? - True if this user/organization has a GitHub Sponsors listing.
  • isBountyHunter boolean? - Whether or not this user is a participant in the GitHub Security Bug Bounty.
  • isCampusExpert boolean? - Whether or not this user is a participant in the GitHub Campus Experts Program.
  • isDeveloperProgramMember boolean? - Whether or not this user is a GitHub Developer Program member.
  • isEmployee boolean? - Whether or not this user is a GitHub employee.
  • isGitHubStar boolean? - Whether or not this user is a member of the GitHub Stars Program.
  • isSiteAdmin boolean? - Whether or not this user is a site administrator.
  • isViewer boolean? - Whether or not this user is the viewing user.
  • location string? - The user's public profile location.
  • login string - The username used to login.
  • projectsUrl string? - The HTTP URL listing user's projects
  • resourcePath string? - The HTTP path for this user
  • twitterUsername string? - The user's Twitter username.
  • updatedAt string? - Identifies the date and time when the object was last updated.
  • url string? - The HTTP URL for this user
  • websiteUrl string? - A URL pointing to the user's public website/blog.
  • name string? - The user's public profile name.

github: UserList

Represent GitHub user list.

Fields
  • users User[] - User list.
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total user count

github: UserListPayload

Represent GitHub user list.

Fields
  • nodes User[] - User list.
  • pageInfo PageInfo - Response pagination info.
  • totalCount int - Total user count

Import

import ballerinax/github;Copy

Metadata

Released date: over 3 years ago

Version: 1.0.1

License: Apache-2.0

Compatibility

Platform: java11

Ballerina version: slbeta2

Pull count

Total: 17366

Current verison: 20

Weekly downloads

Source repository

Keywords

github

endpoint

API

Contributors

Other versions

5.0.25.0.15.0.04.6.04.5.0
See more...

Dependencies

ballerina/url/1.1.0-beta.2ballerina/time/2.0.0-beta.2ballerina/random/0.10.0-beta.2
See more...

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC