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

GetRepositoryPublicKey (string repositoryOwner, string repositoryName, [internal]string Accept)

Get a repository public key

CreateUpdateRepositorySecret (string repositoryOwner, string repositoryName, string secretName, [internal]string Accept, CreateRepositorySecretRequest body)

Create or update a repository secret

CreateRepositoryUsingTemplate (string templateOwner, string templateRepository, [internal]string Accept, CreateRepositoryUsingTemplateRequest body)

Create a repository using a template

GetRepositoryById (integer repositoryId, [internal]string Accept)

Get a repository by Id

CreateReference (string repositoryOwner, string repositoryName, [internal]string Accept, CreateReferenceRequest body)

Create a reference

GetReference (string repositoryOwner, string repositoryName, string reference, [internal]string Accept)

Get a reference

MergePullRequest (string repositoryOwner, string repositoryName, integer pullNumber, [internal]string Accept, PullRequestMergeRequest body)

Merge a pull request

UpdatePullRequest (string repositoryOwner, string repositoryName, integer pullNumber, [internal]string Accept, PullRequestUpdateRequest body)

Update a pull request

GetPullRequestFiles (string repositoryOwner, string repositoryName, integer pullNumber, [internal]string Accept)

Get the list of files from a pull request

CreatePullRequest (string repositoryOwner, string repositoryName, [internal]string Accept, PullRequestCreateRequest body)

Create a pull request

CreateRepositoryDispatchEvent (string repositoryOwner, string repositoryName, [internal]string Accept, RepositoryDispatchEvent body)

Create a repository dispatch event

CompareRepositoryCommits (string repositoryOwner, string repositoryName, string base, string head, [internal]string Accept)

Compare two commits

AddSelectedRepoToOrgSecret (string repositoryOwner, integer repositoryId, string secretName)

Add selected repository to an organization secret

RemoveSelectedRepoFromOrgSecret (string repositoryOwner, integer repositoryId, string secretName)

Remove selected repository from an organization secret

DeleteWebhookTrigger (string repositoryOwner, string repositoryName, string webhookId)

Deletes a Github Webhook

 

Triggers:

Name

Summary

WebhookPullRequestTrigger (string repositoryOwner, string repositoryName, [internal]string Accept, [Optional]WebhookRequestBody Request body of webhook)

When a pull request is created or modified

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

ActionsPublicKey

 

Commit

 

CommitComparison

 

CreateReferenceRequest

 

CreateRepositorySecretRequest

 

CreateRepositoryUsingTemplateRequest

 

DiffEntry

 

GitReference

 

GitUser

 

IssueBasicDetailsModel

 

IssueDetailsModel

 

Label

 

LicenseDetails

 

Milestone

 

PullRequest

 

PullRequestCreateRequest

 

PullRequestFile

 

PullRequestMergeRequest

 

PullRequestMergeResult

 

PullRequestUpdateRequest

 

RepositoryDetails

 

RepositoryDispatchEvent

 

RepositoryMiniDetails

 

TeamDetails

 

UserDetailsModel

 

Verification

 

WebhookCreationResponse

 

WebhookRequestBody

 

 

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.

 

GetRepositoryPublicKey

Summary: Get a repository public key

Description: Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

 

Syntax:

GitHub.GetRepositoryPublicKey (string repositoryOwner, string repositoryName, [internal]string Accept)

 

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

Accept

string

 

 

True

 

Returns:

          Type:ActionsPublicKey

          Description: The public key used for setting Actions Secrets.

 

CreateUpdateRepositorySecret

Summary: Create or update a repository secret

Description: Creates or updates a repository secret with an encrypted value. Encrypt your secret using LibSodium.

 

Syntax:

GitHub.CreateUpdateRepositorySecret (string repositoryOwner, string repositoryName, string secretName, [internal]string Accept, CreateRepositorySecretRequest body)

 

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

secretName

string

(Secret Name)

Name of the secret.

True

Accept

string

 

 

True

body

CreateRepositorySecretRequest

 

 

True

 

Returns:

 

CreateRepositoryUsingTemplate

Summary: Create a repository using a template

Description: Creates a new repository using a repository template. The authenticated user must own or be a member of an organization that owns the repository.

 

Syntax:

GitHub.CreateRepositoryUsingTemplate (string templateOwner, string templateRepository, [internal]string Accept, CreateRepositoryUsingTemplateRequest body)

 

Parameters:

Name

Type

Summary

Required

Related Action

templateOwner

string

(Template Owner)

Name of the template repository owner.

True

templateRepository

string

(Template Repository)

Name of the template repository.

True

Accept

string

 

 

True

body

CreateRepositoryUsingTemplateRequest

 

 

True

 

Returns:

          Type:RepositoryDetails

          Description: A git repository

 

GetRepositoryById

Summary: Get a repository by Id

Description: Gets a repository by Id.

 

Syntax:

GitHub.GetRepositoryById (integer repositoryId, [internal]string Accept)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryId

integer

(Repository Id)

Unique Identifier of the repository.

True

Accept

string

 

 

True

 

Returns:

          Type:RepositoryDetails

          Description: A git repository

 

CreateReference

Summary: Create a reference

Description: 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.

 

Syntax:

GitHub.CreateReference (string repositoryOwner, string repositoryName, [internal]string Accept, CreateReferenceRequest body)

 

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

Accept

string

 

 

True

body

CreateReferenceRequest

 

 

True

 

Returns:

          Type:GitReference

          Description: Git references within a repository

 

GetReference

Summary: Get a reference

Description: 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.

 

Syntax:

GitHub.GetReference (string repositoryOwner, string repositoryName, string reference, [internal]string Accept)

 

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

reference

string

(Reference)

The ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags.

True

Accept

string

 

 

True

 

Returns:

          Type:GitReference

          Description: Git references within a repository

 

MergePullRequest

Summary: Merge a pull request

Description: This operation is used to merge a pull request for the repository.

 

Syntax:

GitHub.MergePullRequest (string repositoryOwner, string repositoryName, integer pullNumber, [internal]string Accept, PullRequestMergeRequest body)

 

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

pullNumber

integer

(Pull Number)

Pull Number.

True

Accept

string

 

 

True

body

PullRequestMergeRequest

 

Pull Request Merge Request.

True

 

Returns:

          Type:PullRequestMergeResult

          Description: Pull Request Merge Result.

 

UpdatePullRequest

Summary: Update a pull request

Description: 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.

 

Syntax:

GitHub.UpdatePullRequest (string repositoryOwner, string repositoryName, integer pullNumber, [internal]string Accept, PullRequestUpdateRequest body)

 

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

pullNumber

integer

(Pull Number)

Pull Number.

True

Accept

string

 

 

True

body

PullRequestUpdateRequest

 

 

True

 

Returns:

          Type:PullRequest

          Description: Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.

 

GetPullRequestFiles

Summary: Get the list of files from a pull request

Description: This operation is used to get the list of files from a pull request for the repository.

 

Syntax:

GitHub.GetPullRequestFiles (string repositoryOwner, string repositoryName, integer pullNumber, [internal]string Accept)

 

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

pullNumber

integer

(Pull Number)

Pull Number.

True

Accept

string

 

 

True

 

Returns:

          Type:array of (PullRequestFile)

 

CreatePullRequest

Summary: Create a pull request

Description: 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.

 

Syntax:

GitHub.CreatePullRequest (string repositoryOwner, string repositoryName, [internal]string Accept, PullRequestCreateRequest body)

 

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

Accept

string

 

 

True

body

PullRequestCreateRequest

 

Pull Request Creation Request.

True

 

Returns:

          Type:PullRequest

          Description: Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.

 

CreateRepositoryDispatchEvent

Summary: Create a repository dispatch event

Description: 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.

 

Syntax:

GitHub.CreateRepositoryDispatchEvent (string repositoryOwner, string repositoryName, [internal]string Accept, RepositoryDispatchEvent body)

 

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

Accept

string

 

 

True

body

RepositoryDispatchEvent

 

Repository Dispatch Event raised

True

 

Returns:

 

CompareRepositoryCommits

Summary: Compare two commits

Description: 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.

 

Syntax:

GitHub.CompareRepositoryCommits (string repositoryOwner, string repositoryName, string base, string head, [internal]string Accept)

 

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

base

string

(Base)

base parameter

True

head

string

(Head)

head parameter

True

Accept

string

 

 

True

 

Returns:

          Type:CommitComparison

          Description: Commit Comparison

 

AddSelectedRepoToOrgSecret

Summary: Add selected repository to an organization secret

Description: 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](https://developer.github.com/v3/actions/secrets/#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.

 

Syntax:

GitHub.AddSelectedRepoToOrgSecret (string repositoryOwner, integer repositoryId, string secretName)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryOwner

string

(Repository Owner)

Name of the repository owner.

True

repositoryId

integer

(Repository Id)

Unique Identifier of the repository.

True

secretName

string

(Secret Name)

Name of the secret.

True

 

Returns:

 

RemoveSelectedRepoFromOrgSecret

Summary: Remove selected repository from an organization secret

Description: 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](https://developer.github.com/v3/actions/secrets/#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.

 

Syntax:

GitHub.RemoveSelectedRepoFromOrgSecret (string repositoryOwner, integer repositoryId, string secretName)

 

Parameters:

Name

Type

Summary

Required

Related Action

repositoryOwner

string

(Repository Owner)

Name of the repository owner.

True

repositoryId

integer

(Repository Id)

Unique Identifier of the repository.

True

secretName

string

(Secret Name)

Name of the secret.

True

 

Returns:

 

DeleteWebhookTrigger

Summary: Deletes a Github Webhook

Description: Deletes a Github Webhook

 

Syntax:

GitHub.DeleteWebhookTrigger (string repositoryOwner, string repositoryName, string webhookId)

 

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

webhookId

string

(Github Webhook ID)

ID of the Github Webhook

True

 

Returns:

 

Triggers:

Trigger WebhookPullRequestTrigger

Summary: When a pull request is created or modified

Description: Creates a Github Webhook for Pull Requests

 

Syntax:

GitHub.WebhookPullRequestTrigger (string repositoryOwner, string repositoryName, [internal]string Accept, [Optional]WebhookRequestBody Request body of webhook)

 

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

Accept

string

 

 

True

Request body of webhook

WebhookRequestBody

 

Webhook request body.

False

 

Returns:

          Type:WebhookCreationResponse

          Description: Webhook creation response.

 

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)

 


 

ActionsPublicKey

Summary:

Description: The public key used for setting Actions Secrets.

 

          Properties:

Name

Type

Summary

key_id

string

Key Id

The identifier for the key.

key

string

Key

The Base64 encoded public key.

id

integer(int32)

Id

Unique identifier of the key.

url

string

Url

Public key url.

title

string

Title

Public key title.

created_at

string

Created At

The date and time when the key was created.


 

Commit

Summary:

Description: Commit

 

          Properties:

Name

Type

Summary

url

string

Commit Url

The HTTP URL for the commit.

sha

string

Commit Sha

SHA of the commit

node_id

string

Node Id

Node Id of the commit.

html_url

string

HTML Url

HTML Url of the commit

comments_url

string

Comments Url

Comments Url of the commit

commit

Commit

 

 

author

UserDetailsModel

 

Properties of a GitHub user.

committer

UserDetailsModel

 

Properties of a GitHub user.

parents

array of (ParentsItem)

 

 

stats

Stats

 

 

files

array of (DiffEntry)

 

 

 

Commit

Summary:

Description:

 

          Properties:

Name

Type

Summary

url

string

Commit Url

Url of the commit.

author

GitUser

 

Metaproperties for Git author/committer information.

committer

GitUser

 

Metaproperties for Git author/committer information.

message

string

Commit message

Commit Message.

comment_count

integer(int32)

Comment Count

Comments Count of the commit

tree

Tree

 

 

verification

Verification

 

 

 

Tree

Summary:

Description:

 

          Properties:

Name

Type

Summary

sha

string

Commit Sha

SHA of the Commit

url

string(uri)

Commit Url

Commit Url.

 

ParentsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

sha

string

Parent Sha

Parent branch commit sha

url

string

Parent branch Url

Url of the parent branch.

html_url

string

Parent branch HTML Url

HTML Url of the parent branch.

 

Stats

Summary:

Description:

 

          Properties:

Name

Type

Summary

additions

integer(int32)

Additions

Number of additions

deletions

integer(int32)

Deletions

Number of Deletions

total

integer(int32)

Total

Total changes

 


 

CommitComparison

Summary:

Description: Commit Comparison

 

          Properties:

Name

Type

Summary

url

string

Url

Url for the comparison

html_url

string

HTML Url

Html Url for the comparison

permalink_url

string

Permanent Url

Permanent Url for the comparison

diff_url

string

Diff Url

Diff Url

patch_url

string

Patch Url

Patch Url

base_commit

Commit

 

Commit

merge_base_commit

Commit

 

Commit

status

string

Status

Status of the comparision eg. diverged etc.,

ahead_by

integer(int32)

Ahead by

ahead by base branch

behind_by

integer(int32)

Behind by

behind_by base branch

total_commits

integer(int32)

Total Commits

total commits

commits

array of (Commit)

Commits

commits

files

array of (DiffEntry)

Files

files


 

CreateReferenceRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

ref

string

Reference

The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

sha

string

Sha

The SHA1 value for this reference.


 

CreateRepositorySecretRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

encrypted_value

string

 

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an Repository public key action.

key_id

string

 

ID of the key you used to encrypt the secret.


 

CreateRepositoryUsingTemplateRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

owner

string

Owner

The organization or person who will own the new repository. If left blank, the authenticated user will be the owner.

name

string

Name

The name of the new repository.

description

string

Description

A short description of the new repository.

private

boolean

Is Private?

Either `true` to create a new private repository or `false` to create a new public one.


 

DiffEntry

Summary:

Description: Diff Entry

 

          Properties:

Name

Type

Summary

filename

string

File Name

Changed File Name.

additions

integer(int32)

Additions

Number of additions in the file

deletions

integer(int32)

Deletions

Number of Deletions in the file

changes

integer(int32)

Changes

Number of Changes in the file

status

string

Status

Status of the change modified, renamed etc.,

raw_url

string

Raw Url

Raw Url link to the file

blob_url

string

Blob Url

Blob Url link to the file

patch

string

Patch

Actual changes made to the file.

sha

string

Sha of the change

SHA of the change.

contents_url

string

Contents Url

File Contents Url.

previous_filename

string

Previous FileName

Previous FileName if the FileName is changed


 

GitReference

Summary:

Description: Git references within a repository

 

          Properties:

Name

Type

Summary

ref

string

Reference

The name of the fully qualified reference.

node_id

string

Node Id

The Node Id of the reference.

url

string(uri)

Url

The url of the reference.

object

Object

 

 

 

Object

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

type

The type of the object.

sha

string

Sha

The SHA for the reference.

url

string(uri)

Url

The url of the object.

 


 

GitUser

Summary:

Description: Metaproperties for Git author/committer information.

 

          Properties:

Name

Type

Summary

name

string

Git User Name

User Name

email

string

Git User Email

Email

date

string

Timestamp of Commit

Timestamp of Commit.


 

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.


 

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

UserDetailsModel

 

Properties of a GitHub user.

number

integer(int32)

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.


 

Label

Summary:

Description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail).

 

          Properties:

Name

Type

Summary

id

integer(int32)

Id

The Unique Identifier for the label.

node_id

string

Node Id

The Node ID for the label.

url

string(uri)

Url

URL for the label

name

string

Name

The name of the label.

description

string

Description

A brief description of this label.

color

string

Color

6-character hex code, without the leading #, identifying the color

default

boolean

Is Default?

Whether or not this is a default label.


 

LicenseDetails

Summary:

Description: License Details

 

          Properties:

Name

Type

Summary

key

string

Key

The lowercased SPDX Id of the license.

name

string

Name

The license full name specified by https://spdx.org/licenses.

url

string(uri)

Url

URL to the license on https://choosealicense.com.

spdx_id

string

SPDX Id

Short identifier specified by https://spdx.org/licenses.

node_id

string

Node Id

License Node Id.

html_url

string(uri)

HTML Url

License HTML URL.


 

Milestone

Summary:

Description: A collection of related issues and pull requests.

 

          Properties:

Name

Type

Summary

url

string(uri)

Milestone Url

The HTTP URL for the milestone.

html_url

string(uri)

Milestone Html Url

The HTML URL for the milestone.

labels_url

string(uri)

Milestone Labels Url

The labels URL for the milestone.

id

integer(int32)

Milestone Id

The Unique Identifier for the milestone.

node_id

string

Milestone Node Id

The Node ID for the milestone.

number

integer(int32)

Milestone Number

The number of the milestone.

state

string

Milestone State

The state of the milestone.  Values: [open, closed]

title

string

Milestone Title

The title of the milestone.

description

string

Milestone Description

The description of the milestone.

creator

UserDetailsModel

 

Properties of a GitHub user.

open_issues

integer(int32)

Milestone Open Issues

Number of open issues for the repository.

closed_issues

integer(int32)

Milestone Closed Issues

Number of closed issues for the repository.

created_at

string(date-time)

Milestone Created At

The date and time when the milestone was created.

updated_at

string(date-time)

Milestone Updated At

The date and time when the milestone was last updated.

closed_at

string(date-time)

Milestone Closed At

The date and time when the milestone was closed.

due_on

string(date-time)

Milestone Due On

The due date of the milestone.


 

PullRequest

Summary:

Description: Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.

 

          Properties:

Name

Type

Summary

url

string(uri)

Pull Request Url

The HTTP URL for this pull request.

id

integer(int32)

Pull Request Id

The Unique Identifier for the pull request.

node_id

string

Pull Request Node Id

The Node ID for the pull request.

html_url

string(uri)

Pull Request Html Url

The HTML URL for the pull request.

diff_url

string(uri)

Pull Request Diff Url

The Diff URL for the pull request.

patch_url

string(uri)

Pull Request Patch Url

The patch URL for the pull request.

issue_url

string(uri)

Pull Request Issue Url

The issue URL for the pull request.

commits_url

string(uri)

Pull Request Commit Url

The commit URL for the pull request.

review_comments_url

string(uri)

Pull Request Review Comments Url

The review comments URL for the pull request.

review_comment_url

string

Pull Request Review Comment Url

The review comment URL for the pull request.

comments_url

string(uri)

Pull Request Diff Url

The Diff URL for the pull request.

statuses_url

string(uri)

Pull Request Statuses Url

The statuses URL for the pull request.

number

integer(int32)

Pull Request Number

Number uniquely identifying the pull request within its repository.

state

string

Pull Request State

State of this Pull Request. Either `open` or `closed`.  Values: [open, closed]

locked

boolean

Is Pull Request Locked?

Whether the pull request is locked or not.

title

string

Pull Request Title

The title of the pull request.

user

UserDetailsModel

 

Properties of a GitHub user.

body

string

Pull Request Body

The body as Markdown.

labels

array of (Label)

Pull Request Labels

The list of labels associated with the pull request.

milestone

Milestone

 

A collection of related issues and pull requests.

active_lock_reason

string

Pull Request Active Lock Reason

Reason that the conversation was locked.

created_at

string(date-time)

Pull Request Created At

The date and time when the pull request was created.

updated_at

string(date-time)

Pull Request Updated At

The date and time when the pull request was last updated.

closed_at

string(date-time)

Pull Request Closed At

The date and time when the pull request was closed.

merged_at

string(date-time)

Pull Request Merged At

The date and time that the pull request was merged.

merge_commit_sha

string

Pull Request Merge Commit Sha

The merge commit Sha of the pull request.

assignee

UserDetailsModel

 

Properties of a GitHub user.

assignees

array of (UserDetailsModel)

Pull Request Assignees

The list of assignees for the pull request.

requested_reviewers

array of (UserDetailsModel)

Pull Request Requested Reviewers

The list of Users assigned to this pull request.

requested_teams

array of (TeamDetails)

Pull Request Requested Teams

The list of requested teams to this pull request.

head

Head

 

Head

base

Base

 

Base

author_association

string

Pull RequestAuthor Association

Author's association with the subject of the comment.

draft

boolean

Is Pull Request Draft?

Indicates whether or not the pull request is a draft.

merged

boolean

Is Pull Request Merged?

Whether or not the pull request was merged.

mergeable

boolean

Is Pull Request Mergeable?

Whether or not the pull request can be merged based on the existence of merge conflicts.

rebaseable

boolean

Is Pull Request Rebaseable?

Whether or not the pull request is rebaseable.

mergeable_state

string

Pull Request Mergeable State

The mergeable state of the pull request.

merged_by

UserDetailsModel

 

Properties of a GitHub user.

comments

integer(int32)

Pull Request Comments Count

The number of comments in this pull request.

review_comments

integer(int32)

Pull Request Review Comments Count

The number of review comments in this pull request.

maintainer_can_modify

boolean

Can Maintainer Modify Pull Request?

Indicates whether maintainers can modify the pull request.

commits

integer(int32)

Pull Request Commits Count

The number of commits in this pull request.

additions

integer(int32)

Pull Request Additions Count

The number of additions in this pull request.

deletions

integer(int32)

Pull Request Deletions Count

The number of deletions in this pull request.

changed_files

integer(int32)

Pull Request Changed Files Count

The number of changed files in this pull request.

 

Head

Summary:

Description: Head

 

          Properties:

Name

Type

Summary

label

string

Pull Request Head Label

Head label.

ref

string

Pull Request Head Reference

Head Reference

repo

RepositoryMiniDetails

 

A git repository

sha

string

Pull Request Head Sha

Head Sha

user

UserDetailsModel

 

Properties of a GitHub user.

 

Base

Summary:

Description: Base

 

          Properties:

Name

Type

Summary

label

string

Pull Request Base Label

Head label.

ref

string

Pull Request Base Reference

Head Reference

repo

RepositoryMiniDetails

 

A git repository

sha

string

Pull Request Base Sha

Head Sha

user

UserDetailsModel

 

Properties of a GitHub user.

 


 

PullRequestCreateRequest

Summary:

Description: Pull Request Creation Request.

 

          Properties:

Name

Type

Summary

title

string

Title

The title of the new pull request.

head

string

Head

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`.

base

string

Base

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.

body

string

Body

The contents of the pull request.

maintainer_can_modify

boolean

Can Maintainer Modify?

Indicates whether maintainers can modify the pull request.

draft

boolean

Draft

Indicates whether the pull request is a draft.


 

PullRequestFile

Summary:

Description:

 

          Properties:

Name

Type

Summary

sha

string

sha for the file

The sha for the file.

filename

string

The file name

The file name.

status

string

Modification status for the file

The modification status for the file.

additions

integer(int32)

Number of additions made to the file

The number of additions made to the file.

deletions

integer(int32)

Number of deletions made to the file

The number of deletions made to the file.

changes

integer(int32)

Number of changes made to the file

The number of changes made to the file.

blob_url

string

Blob Url for the file

The blob Url for the file.

raw_url

string

Raw Url for the file

The Raw Url for the file.

contents_url

string

Contents Url for the file

The contents Url for the file.

patch

string

Patch content for the file

The patch content for the file.


 

PullRequestMergeRequest

Summary:

Description: Pull Request Merge Request.

 

          Properties:

Name

Type

Summary

commitTitle

string

Commit Title

Title for the automatic commit message.

commitMessage

string

Commit Message

Extra detail to append to automatic commit message.

sha

string

Sha

SHA that pull request head must match to allow merge.

mergeMethod

string

Merge Method

Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.  Values: [merge, squash, rebase]


 

PullRequestMergeResult

Summary:

Description: Pull Request Merge Result.

 

          Properties:

Name

Type

Summary

sha

string

Sha

SHA for the merge commit.

merged

boolean

Is Merged?

Whether or not the pull request was merged.

message

string

Message

Merge response message.


 

PullRequestUpdateRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

title

string

Title

The title of the pull request.

body

string

Body

The contents of the pull request.

state

string

State

State of this Pull Request. Either `open` or `closed`.  Values: [open, closed]

base

string

Base

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.

maintainer_can_modify

boolean

Can Maintainer Modify?

Indicates whether maintainers can modify the pull request.


 

RepositoryDetails

Summary:

Description: A git repository

 

          Properties:

Name

Type

Summary

id

integer(int32)

Id

Unique identifier of the repository.

node_id

string

Node Id

The Node Id of the repository.

name

string

Name

The name of the repository.

full_name

string

Full Name

The full name of the repository.

license

LicenseDetails

 

License Details

forks

integer(int32)

Forks

The number of forks of the repository.

permissions

Permissions

Permissions

Permissions on the repository.

owner

UserDetailsModel

 

Properties of a GitHub user.

private

boolean

Is Private?

Whether the repository is private or public.

html_url

string(uri)

Html Url

The Html Url of the repository

description

string

Description

The description of the repository

fork

boolean

Is a Fork?

If the repository is a fork?

url

string(uri)

Url

The HTTP URL for this repository

archive_url

string

Archive Url

The Archive URL for this repository

assignees_url

string

Assignees Url

The Assignees URL for this repository

blobs_url

string

Blobs Url

The Blobs URL for this repository

branches_url

string

Branches Url

The Branches URL for this repository

collaborators_url

string

Collaborators Url

The Collaborators URL for this repository

comments_url

string

Comments Url

The Comments URL for this repository

commits_url

string

Commits Url

The Commits URL for this repository

compare_url

string

Compare Url

The Compare URL for this repository

contents_url

string

Contents Url

The Contents URL for this repository

contributors_url

string(uri)

Contributors Url

The Contributors URL for this repository

deployments_url

string(uri)

Deployments Url

The Deployments URL for this repository

downloads_url

string(uri)

Downloads Url

The Downloads URL for this repository

events_url

string(uri)

Events Url

The Events URL for this repository

forks_url

string(uri)

Forks Url

The Forks URL for this repository

git_commits_url

string

Git Commits Url

The Git Commits URL for this repository

git_refs_url

string

Git References Url

The Git References URL for this repository

git_tags_url

string

Git Tags Url

The Git Tags URL for this repository

git_url

string

Git Url

The Git URL for this repository

issue_comment_url

string

Issue Comment Url

The issue comment URL for this repository

issue_events_url

string

Issue Events Url

The issue events URL for this repository

issues_url

string

Issues Url

The issues URL for this repository

keys_url

string

Keys Url

The keys URL for this repository

labels_url

string

Labels Url

The labels URL for this repository

languages_url

string(uri)

Languages Url

The languages URL for this repository

merges_url

string(uri)

Merges Url

The merges URL for this repository

milestones_url

string

Milestones Url

The milestones URL for this repository

notifications_url

string

Notifications Url

The notifications URL for this repository

pulls_url

string

Pulls Url

The pulls URL for this repository

releases_url

string

Releases Url

The releases URL for this repository

ssh_url

string

SSH Url

The SSH URL to clone this repository

stargazers_url

string(uri)

Stargazers Url

The stargazers (Stargazers are the people that have bookmarked the GitHub repository) URL for this repository

statuses_url

string

Statuses Url

The statuses URL for this repository

subscribers_url

string(uri)

Subscribers Url

The subscribers URL for this repository

subscription_url

string(uri)

Subscription Url

The subscription URL for this repository

tags_url

string(uri)

Tags Url

The tags URL for this repository

teams_url

string(uri)

Teams Url

The teams URL for this repository

trees_url

string

Trees Url

The trees URL for this repository

clone_url

string

Clone Url

The clone URL for this repository

mirror_url

string(uri)

Mirror Url

The original mirror URL for this repository

hooks_url

string(uri)

Hooks Url

The hooks URL for this repository

svn_url

string(uri)

SVN Url

The SVN URL for this repository

homepage

string(uri)

Homepage

The homepage for this repository

language

string

Language

The language for this repository

forks_count

integer(int32)

Forks Count

Number of forks there are of this repository in the whole network.

stargazers_count

integer(int32)

Stargazers Count

Number of users who have starred the repository.

watchers_count

integer(int32)

Watchers Count

Number of users watching the repository.

size

integer(int32)

Size

Size of the repository

default_branch

string

Default Branch

The default branch of the repository.

open_issues_count

integer(int32)

Open Issues Count

Number of open issues in the repository.

is_template

boolean

Is Template?

Whether this repository acts as a template that can be used to generate new repositories.

topics

array of (string)

Topics

List of topics in the repository

has_issues

boolean

Has Issues?

Whether issues are enabled.

has_projects

boolean

Has Projects?

Whether projects are enabled.

has_wiki

boolean

Has Wiki?

Whether the wiki is enabled.

has_pages

boolean

Has Pages?

Whether pages are enabled.

has_downloads

boolean

Has Downloads?

Whether downloads are enabled.

archived

boolean

Is Archived?

Whether the repository is archived.

disabled

boolean

Is Disabled?

Returns whether or not this repository disabled.

visibility

string

Visibility

The repository visibility: public, private, or internal.

pushed_at

string(date-time)

Pushed At

When the repository was last pushed to.

created_at

string(date-time)

Created At

the date and time when the repository was created.

updated_at

string(date-time)

Updated At

the date and time when the repository was last updated.

allow_rebase_merge

boolean

Allow Rebase Merge

Whether to allow rebase merges for pull requests.

template_repository

Template_repository

 

 

temp_clone_token

string

Temp Clone Token

Temporary authentication token for cloning this repository.

allow_squash_merge

boolean

Allow Squash Merge

Whether to allow squash merges for pull requests.

delete_branch_on_merge

boolean

Delete Branch On Merge

Whether to delete head branches when pull requests are merged

allow_merge_commit

boolean

Allow Merge Commit

Whether to allow merge commits for pull requests.

subscribers_count

integer(int32)

Subscribers Count

Number of subscribers for the repository.

network_count

integer(int32)

Network Count

Repository Network Count

open_issues

integer(int32)

Open Issues

Repository open issues.

watchers

integer(int32)

Watchers

Repository Watchers.

master_branch

string

Master Branch

Repository master branch.

starred_at

string

Starred At

Repository Starred At

 

Permissions

Summary: Permissions

Description: Permissions on the repository.

 

          Properties:

Name

Type

Summary

admin

boolean

 

 

pull

boolean

 

 

triage

boolean

 

 

push

boolean

 

 

maintain

boolean

 

 

 

Template_repository

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Template Repository Id

Unique identifier of the repository.

node_id

string

Template Repository Node Id

The Node Id of the repository.

name

string

Template Repository Name

The name of the repository.

full_name

string

Template Repository Full Name

The full name of the repository.

owner

UserDetailsModel

 

Properties of a GitHub user.

private

boolean

Is Template Repository Private?

Whether the repository is private or public.

html_url

string(uri)

Template Repository Html Url

The Html Url of the repository

description

string

Template Repository Description

The description of the repository

fork

boolean

Is Template Repository a Fork?

If the repository is a fork?

url

string(uri)

Template Repository Url

The HTTP URL for this repository

archive_url

string

Template Repository Archive Url

The Archive URL for this repository

assignees_url

string

Template Repository Assignees Url

The Assignees URL for this repository

blobs_url

string

Template Repository Blobs Url

The Blobs URL for this repository

branches_url

string

Template Repository Branches Url

The Branches URL for this repository

collaborators_url

string

Template Repository Collaborators Url

The Collaborators URL for this repository

comments_url

string

Template Repository Comments Url

The Comments URL for this repository

commits_url

string

Template Repository Commits Url

The Commits URL for this repository

compare_url

string

Template Repository Compare Url

The Compare URL for this repository

contents_url

string

Template Repository Contents Url

The Contents URL for this repository

contributors_url

string(uri)

Template Repository Contributors Url

The Contributors URL for this repository

deployments_url

string(uri)

Template Repository Deployments Url

The Deployments URL for this repository

downloads_url

string(uri)

Template Repository Downloads Url

The Downloads URL for this repository

events_url

string(uri)

Template Repository Events Url

The Events URL for this repository

forks_url

string(uri)

Template Repository Forks Url

The Forks URL for this repository

git_commits_url

string

Template Repository Git Commits Url

The Git Commits URL for this repository

git_refs_url

string

Template Repository Git References Url

The Git References URL for this repository

git_tags_url

string

Template Repository Git Tags Url

The Git Tags URL for this repository

git_url

string

Template Repository Git Url

The Git URL for this repository

issue_comment_url

string

Template Repository Issue Comment Url

The issue comment URL for this repository

issue_events_url

string

Template Repository Issue Events Url

The issue events URL for this repository

issues_url

string

Template Repository Issues Url

The issues URL for this repository

keys_url

string

Template Repository Keys Url

The keys URL for this repository

labels_url

string

Template Repository Labels Url

The labels URL for this repository

languages_url

string(uri)

Template Repository Languages Url

The languages URL for this repository

merges_url

string(uri)

Template Repository Merges Url

The merges URL for this repository

milestones_url

string

Template Repository Milestones Url

The milestones URL for this repository

notifications_url

string

Template Repository Notifications Url

The notifications URL for this repository

pulls_url

string

Template Repository Pulls Url

The pulls URL for this repository

releases_url

string

Template Repository Releases Url

The releases URL for this repository

ssh_url

string

Template Repository SSH Url

The SSH URL to clone this repository

stargazers_url

string(uri)

Template Repository Stargazers Url

The stargazers (Stargazers are the people that have bookmarked the GitHub repository) URL for this repository

statuses_url

string

Template Repository Statuses Url

The statuses URL for this repository

subscribers_url

string(uri)

Template Repository Subscribers Url

The subscribers URL for this repository

subscription_url

string(uri)

Template Repository Subscription Url

The subscription URL for this repository

tags_url

string(uri)

Template Repository Tags Url

The tags URL for this repository

teams_url

string(uri)

Template Repository Teams Url

The teams URL for this repository

trees_url

string

Template Repository Trees Url

The trees URL for this repository

clone_url

string

Template Repository Clone Url

The clone URL for this repository

mirror_url

string(uri)

Template Repository Mirror Url

The original mirror URL for this repository

hooks_url

string(uri)

Template Repository Hooks Url

The hooks URL for this repository

svn_url

string(uri)

Template Repository SVN Url

The SVN URL for this repository

homepage

string(uri)

Template Repository Homepage

The homepage for this repository

language

string

Template Repository Language

The language for this repository

forks_count

integer(int32)

Template Repository Forks Count

Number of forks there are of this repository in the whole network.

stargazers_count

integer(int32)

Template Repository Stargazers Count

Number of users who have starred the repository.

watchers_count

integer(int32)

Template Repository Watchers Count

Number of users watching the repository.

size

integer(int32)

Template Repository Size

Size of the repository

default_branch

string

Template Repository Default Branch

The default branch of the repository.

open_issues_count

integer(int32)

Template Repository Open Issues Count

Number of open issues in the repository.

is_template

boolean

Is Template Repository a Template?

Whether this repository acts as a template that can be used to generate new repositories.

topics

array of (string)

Template Repository Topics

List of topics in the repository

has_issues

boolean

Template Repository Has Issues?

Whether issues are enabled.

has_projects

boolean

Template Repository Has Projects?

Whether projects are enabled.

has_wiki

boolean

Template Repository Has Wiki?

Whether the wiki is enabled.

has_pages

boolean

Template Repository Has Pages?

Whether pages are enabled.

has_downloads

boolean

Template Repository Has Downloads?

Whether downloads are enabled.

archived

boolean

Is Template Repository Archived?

Whether the repository is archived.

disabled

boolean

Is Template Repository Disabled?

Returns whether or not this repository disabled.

visibility

string

Template Repository Visibility

The repository visibility: public, private, or internal.

pushed_at

string(date-time)

Template Repository Pushed At

When the repository was last pushed to.

created_at

string(date-time)

Template Repository Created At

the date and time when the repository was created.

updated_at

string(date-time)

Template Repository Updated At

the date and time when the repository was last updated.

permissions

Permissions

Template Repository Permissions

Permissions on the repository.

allow_rebase_merge

boolean

Template Repository Allow Rebase Merge

Whether to allow rebase merges for pull requests.

template_repository

string

Template Repository of Template Repository

Template repository.

temp_clone_token

string

Template Repository Temp Clone Token

Temporary authentication token for cloning this repository.

allow_squash_merge

boolean

Template Repository Allow Squash Merge

Whether to allow squash merges for pull requests.

delete_branch_on_merge

boolean

Template Repository Delete Branch On Merge

Whether to delete head branches when pull requests are merged

allow_merge_commit

boolean

Template Repository Allow Merge Commit

Whether to allow merge commits for pull requests.

subscribers_count

integer(int32)

Template Repository Subscribers Count

Number of subscribers for the repository.

network_count

integer(int32)

Template Repository Network Count

Repository Network Count

 

Permissions

Summary: Template Repository Permissions

Description: Permissions on the repository.

 

          Properties:

Name

Type

Summary

admin

boolean

 

 

push

boolean

 

 

pull

boolean

 

 

 


 

RepositoryDispatchEvent

Summary:

Description: Repository Dispatch Event raised

 

          Properties:

Name

Type

Summary

event_type

string

Event Name

A custom webhook event name.

client_payload

Client_payload

Event Payload

JSON payload with extra information about the webhook event that your action or worklow may use.

 

Client_payload

Summary: Event Payload

Description: JSON payload with extra information about the webhook event that your action or worklow may use.

 

          Properties:

Name

Type

Summary

 


 

RepositoryMiniDetails

Summary:

Description: A git repository

 

          Properties:

Name

Type

Summary

id

integer(int32)

Repository Id

Unique identifier of the repository.

node_id

string

Repository Node Id

The Node Id of the repository.

name

string

Repository Name

The name of the repository.

full_name

string

Repository Full Name

The full name of the repository.

permissions

Permissions

Repository Permissions

Permissions on the repository.

owner

UserDetailsModel

 

Properties of a GitHub user.

private

boolean

Is Repository Private?

Whether the repository is private or public.

description

string

Repository Description

The description of the repository

homepage

string(uri)

Repository Homepage

The homepage for this repository

language

string

Repository Language

The language for this repository

archived

boolean

Is Repository Archived?

Whether the repository is archived.

disabled

boolean

Is Repository Disabled?

Returns whether or not this repository disabled.

visibility

string

Repository Visibility

The repository visibility: public, private, or internal.

created_at

string(date-time)

Repository Created At

the date and time when the repository was created.

updated_at

string(date-time)

Repository Updated At

the date and time when the repository was last updated.

allow_rebase_merge

boolean

Repository Allow Rebase Merge

Whether to allow rebase merges for pull requests.

allow_squash_merge

boolean

Repository Allow Squash Merge

Whether to allow squash merges for pull requests.

delete_branch_on_merge

boolean

Repository Delete Branch On Merge

Whether to delete head branches when pull requests are merged

allow_merge_commit

boolean

Repository Allow Merge Commit

Whether to allow merge commits for pull requests.

master_branch

string

Repository Master Branch

Repository master branch.

 

Permissions

Summary: Repository Permissions

Description: Permissions on the repository.

 

          Properties:

Name

Type

Summary

admin

boolean

 

 

pull

boolean

 

 

triage

boolean

 

 

push

boolean

 

 

maintain

boolean

 

 

 


 

TeamDetails

Summary:

Description: Groups of organization members that gives permissions on specified repositories.

 

          Properties:

Name

Type

Summary

id

integer(int32)

Id

Unique identifier of the team.

node_id

string

Node Id

The Node ID for the team.

url

string(uri)

Url

URL for the team.

members_url

string

Members Url

The HTTP URL for the team members.

name

string

 

Name of the team

description

string

Description

Description of the team

permission

string

Permission

Permission that the team will have for its repositories

privacy

string

Privacy

The level of privacy this team should have

html_url

string(uri)

HTML Url

HTML Url of the team.

repositories_url

string(uri)

Repositories Url

The HTTP URL for this team's repositories.

slug

string

Slug

The slug corresponding to the team.

ldap_dn

string

LDAP DN

Distinguished Name (DN) that team maps to within LDAP environment


 

UserDetailsModel

Summary:

Description: Properties of a GitHub user.

 

          Properties:

Name

Type

Summary

login

string

Login

User Login.

id

integer(int32)

Id

User Id.

node_id

string

Node Id

User Node Id.

avatar_url

string

Avatar Url

User Avatar Url.

gravatar_id

string

Gravatar Id

User Gravatar Id.

url

string

Url

User Url.

html_url

string

Html Url

User Html Url.

followers_url

string

Followers Url

User FollowersUrl

following_url

string

Following Url

User Following Url.

gists_url

string

Gists Url

User Gists Url.

starred_url

string

Starred Url

User Starred Url.

subscriptions_url

string

Subscriptions Url

User Subscriptions Url.

organizations_url

string

Organizations Url

User Organizations Url.

repos_url

string

Repos Url

User Repos Url.

events_url

string

Events Url

User Events Url.

received_events_url

string

Received Events Url

User Received Events Url.

type

string

Type

User Type.

site_admin

boolean

Site Admin

Is User Site Admin?

name

string

Name

User Name.

company

string

Company

User Company.

blog

string

Blog

User Blog.

location

string

Location

User Location.

email

string

Email

User Email.

hireable

boolean

Hireable

User Hireable?

bio

string

Bio

User Bio.

public_repos

integer(int32)

Public Repos

User Public Repos.

public_gists

integer(int32)

Public Gists

User Public Gists.

followers

integer(int32)

Followers

User Followers.

following

integer(int32)

Following

User Following.

created_at

string(date-time)

Created At

User Created At.

updated_at

string(date-time)

Updated At

User Updated At.


 

Verification

Summary:

Description:

 

          Properties:

Name

Type

Summary

verified

boolean

Is Verified

Indicates whether GitHub considers the signature in this commit to be verified.

reason

string

Verification reason

The reason for verified value.

payload

string

Signed value

The value that was signed.

signature

string

Commit Signature

The signature that was extracted from the commit.


 

WebhookCreationResponse

Summary:

Description: Webhook creation response.

 

          Properties:

Name

Type

Summary

type

string

 

 

id

integer

 

 

name

string

 

 

active

boolean

 

 

events

array of (string)

 

 

config

Config

 

 

updated_at

string

 

 

created_at

string

 

 

url

string

 

 

test_url

string

 

 

ping_url

string

 

 

last_response

Last_response

 

 

 

Config

Summary:

Description:

 

          Properties:

Name

Type

Summary

content_type

string

 

 

url

string

 

 

 

Last_response

Summary:

Description:

 

          Properties:

Name

Type

Summary

code

string

 

 

status

string

 

 

message

string

 

 

 


 

WebhookRequestBody

Summary:

Description: Webhook request body.

 

          Properties:

Name

Type

Summary

active

boolean

State of the Trigger

State of the Trigger, always set to true

name

string

Name of the trigger

Name of the trigger

config

Config

 

Configuration of the Trigger

events

array of (string)

Webhook events to listen on

Webhook events to listen on

 

Config

Summary:

Description: Configuration of the Trigger

 

          Properties:

Name

Type

Summary

content_type

string

Description of repo

Description of repo

url

string

callback url for trigger

callback url