Connectors Reference

GitHub

GitHub is a web-based Git repository hosting service. It offers all of the distributed revision control and source code management (SCM) functionality of Git as well as adding its own features.

 

Status: Production

Tier: Standard

Version: 1.0

 

Actions:

Name

Summary

CreateIssue (string repositoryOwner, string repositoryName, IssueBasicDetailsModel issueBasicDetails)

Create an issue

 

Triggers:

Name

Summary

IssueOpened ()

When a new issue is opened and assigned to me

IssueClosed ()

When an issue assigned to me is closed

IssueAssigned ()

When an issue is assigned to me

 

Objects:

Name

Summary

IssueBasicDetailsModel

 

IssueDetailsModel

 

 

Actions:

CreateIssue

Summary: Create an issue

Description: This operation is used to create a new issue for a specific repository.

 

Syntax:

GitHub.CreateIssue (string repositoryOwner, string repositoryName, IssueBasicDetailsModel issueBasicDetails)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryOwner

string

(Repository Owner)

Name of the repository owner.

True

repositoryName

string

(Repository Name)

Name of the repository.

True

issueBasicDetails

IssueBasicDetailsModel

 

Properties of an issue.

True

 

Returns:

          Type:IssueDetailsModel

          Description: Properties of a GitHub issue.

 

Triggers:

Trigger IssueOpened

Summary: When a new issue is opened and assigned to me

Description: This operation triggers when an issue is opened and assigned to the logged in user.

 

Syntax:

GitHub.IssueOpened ()

 

Returns:

          Type:array of (IssueDetailsModel)

 

Trigger IssueClosed

Summary: When an issue assigned to me is closed

Description: This operation triggers when an issue assigned to the logged in user is closed.

 

Syntax:

GitHub.IssueClosed ()

 

Returns:

          Type:array of (IssueDetailsModel)

 

Trigger IssueAssigned

Summary: When an issue is assigned to me

Description: This operation triggers when an issue is assigned to the logged in user.

 

Syntax:

GitHub.IssueAssigned ()

 

Returns:

          Type:array of (IssueDetailsModel)

 


 

IssueBasicDetailsModel

Summary:

Description: Properties of an issue.

 

          Properties:

Name

Type

Summary

title

string

Title

Summary of the issue.

body

string

Body

Description of the issue.

assignee

string

Assignee

Issue assignee


 

IssueDetailsModel

Summary:

Description: Properties of a GitHub issue.

 

          Properties:

Name

Type

Summary

title

string

Title

Summary of the issue.

body

string

Body

Description of the issue.

assignee

string

Assignee

Id of the user issue is assigned to.

number

string

Id

Unique id of the issue.

state

string

State

Status of the issue.

created_at

string

Created Date-Time

yyyy-MM-ddTHH:mm:ss.fffZ (UTC format).

repository_url

string

Repository Url

Web link to the repository.