Summary: Configuration | Message Processors

org.mule.modules

mule-module-github

Namespace	http://www.mulesoft.org/schema/mule/github
Schema Location	http://www.mulesoft.org/schema/mule/github/current/mule-github.xsd (View Schema)
Schema Version	1.0
Minimum Mule Version	3.2

Module Overview

Generic module

Summary

Configuration
<github:config> Configure an instance of this module

Message Processors
<github:add-collaborator> Adds a collaborator to the given repository
<github:add-comment> Creates a commit comment
<github:add-emails> Add one or more e-mail addresses to the currently authenticated user's account
<github:add-team-member> Add given user to team with given id
<github:add-team-repository> Add repository to team
<github:close-issue> Closes a GitHub issue
<github:create-comment> Create comment on specified issue id
<github:create-deploy-key> Returns a new deploy key
<github:create-gist-comment> Creates a comment on the specified gist id
<github:create-issue> Creates a GitHub issue
<github:create-key> Create key for currently authenticated user
<github:create-label> Creates a new label
<github:create-milestone> Creates a new milestone
<github:create-repository> Create a new repository
<github:create-repository-for-org> Create a new repository for the given organization
<github:create-resource> Creates a new download resource
<github:create-team> Create the given team
<github:delete-comment> Delete the issue comment with the given id
<github:delete-commit-comment> Deletes the given comment
<github:delete-deploy-key> Deletes a deploy key given the given id
<github:delete-download> Deletes a download given the provided id
<github:delete-gist> Deletes the given gist
<github:delete-gist-comment> Deletes the given comment
<github:delete-key> Delete key with given id
<github:delete-label> Deletes the given label
<github:delete-milestone> Deletes a given milestone
<github:delete-team> Delete the team with the given id
<github:edit-comment> Edits the body of the comment represented by the given comment id
<github:edit-commit-comment> Edits a given comment
<github:edit-deploy-key> Edits a given deploy key
<github:edit-gist-comment> Updates the given comment
<github:edit-key> Edit key for currently authenticated user
<github:edit-repository> Edit given repository.
<github:edit-team> Edit the given team.
<github:follow> Make the currently authenticated user follow the given user
<github:fork-gist> Forks the given gist
<github:fork-repository> Fork given repository into new repository under the currently authenticated user.
<github:fork-repository-for-org> Fork given repository into new repository.
<github:get-branches> Get branches in given repository
<github:get-collaborators> Returns the list of collaborators of the given repository
<github:get-comment> Returns a comment from commit with the given id
<github:get-comments> Get an issue's comments
<github:get-commit> Returns a commit with given SHA-1 from given repository
<github:get-commits> Returns a list of the commits for a given repository
<github:get-commits-by-sha> Returns all commits in given repository beginning at an optional commit SHA-1 and affecting an optional path.
<github:get-commmit-comments> Returns all comments on commit with given Sha
<github:get-contributors> Get contributors to repository
<github:get-current-user> Get the currently authenticated user
<github:get-deploy-key> Returns the key that corresponds to the given id
<github:get-deploy-keys> Returns all deploys keys associated with the given repository
<github:get-download> Returns a single download given the provided id
<github:get-emails> Get all e-mail addresses for the currently authenticated user
<github:get-followers> Returns a list of followers for given user, if no one is provided the current authenticated user will be used
<github:get-following> Returns a list users following the given user, if no one is provided the current authenticated user will be used
<github:get-forks> Get all the forks of the given repository
<github:get-gist> Returns the gist according to the given id
<github:get-gist-comment> Returns the comment according to the given id
<github:get-gist-comments> Returns a list of comments for the given gist
<github:get-gists> Returns a list of gists for the specified user
<github:get-issue> Get the issue represented by the given issueId
<github:get-issue-event> Get issue event for repository
<github:get-issues> Get a list of Issue objects that match the specified filter data
<github:get-issues-creted-after> Custom processor
<github:get-issues-since-number> Custom processor
<github:get-key> Get key with given id
<github:get-keys> Get all public keys for currently authenticated user
<github:get-label> Returns a single label
<github:get-labels> Returns a list of labels for the given repository and user
<github:get-languages> Get languages used in given repository
<github:get-milestone> Returns a single milestone
<github:get-milestones> Returns a list of milestones for the given repository
<github:get-org-repositories> Get organization repositories for the given organization
<github:get-repositories> Get repositories for the currently authenticated user
<github:get-repositories-for-user> Get repositories for the given user
<github:get-repository> Get repository
<github:get-starred-gist> Returns the starred gists for the currently authenticated user
<github:get-tags> Get tags in given repository
<github:get-team> Get team with given id
<github:get-team-members> Get members of team with given id
<github:get-team-repositories> Get all repositories for given team
<github:get-teams-for-org> Get all teams in the given organization
<github:get-user-by-login-name> Get user with given login name
<github:get-watched> Get repositories watched by the given user
<github:get-watchers> Get users watching given repository
<github:is-collaborator> Returns whether the user is a collaborator of the given repository
<github:is-following> Returns wether the authenticated user is following the given user
<github:is-starred> Returns whether the gist is starred or not
<github:is-team-member> Is the given user a member of the team with the given id
<github:is-watching> Is currently authenticated user watching given repository?
<github:remove-collaborator> Removes a collaborator from the given repository
<github:remove-emails> Removes one or more e-mail addresses to the currently authenticated user's account
<github:remove-team-member> Remove given user from team with given id
<github:remove-team-repository> Remove repository from team
<github:star-gist> Star the gist with the given id
<github:unfollow> Make the currently authenticated user unfollow the given user
<github:unstar-gist> Unstar the gist with the given id
<github:unwatch> Remove currently authenticated user as a watcher of the given repository
<github:update-current-user> Updates the currently authenticated user using the given attributes.
<github:watch> Add currently authenticated user as a watcher of the given repository

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:github="http://www.mulesoft.org/schema/mule/github"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/github
               http://www.mulesoft.org/schema/mule/github/current/mule-github.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
xs:string	password		The password
xs:string	user		The user name

Message Processors

<github:add-collaborator>

Adds a collaborator to the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
user		Optional. The user that's going to be added as a collaborator to the given repository, leave empty to use this#user

Child Elements

Exception Payloads

Payload Class	Description
IOException

<github:add-comment>

Creates a commit comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
body		Body of the commit comment
commitId		Sha of the commit to comment on
line		Line number in the file to comment on
path		Relative path of the file to comment on
position		Line index in the diff to comment on

Child Elements

Exception Payloads

Payload Class	Description
IOException

<github:add-emails>

Add one or more e-mail addresses to the currently authenticated user's account

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

<github:emails> The email addresses to add

API Information

Add email address(es)

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:add-team-member>

Add given user to team with given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
id		The team id
user		The user name

Child Elements

API Information

Add a member

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:add-team-repository>

Add repository to team

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
id		The team id
owner		The owner of the repository
name		The name of the repository

Child Elements

API Information

Add team repo

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:close-issue>

Closes a GitHub issue

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The repository name
issueId		The issues's id

Child Elements

Return Payload

the newly created Issue

Exception Payloads

Payload Class	Description
IOException

<github:create-comment>

Create comment on specified issue id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The repostory name
issueId		The issue id
comment		The text of the comment

Child Elements

Return Payload

the created Comment

Exception Payloads

Payload Class	Description
IOException

<github:create-deploy-key>

Returns a new deploy key

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
title		The title of the key
key		Ssh key

Child Elements

Return Payload

a new Key created based on the given parameters

Exception Payloads

Payload Class	Description
IOException

<github:create-gist-comment>

Creates a comment on the specified gist id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
gistId		Id of the gist
comment		Comment to create in the gist

Child Elements

Return Payload

a new Comment for the gist

Exception Payloads

Payload Class	Description
IOException

<github:create-issue>

Creates a GitHub issue

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The repository name
title		The issues's title
body		The issuess's body
assignee		Optional. Optionally specify a asignee for the issue

Child Elements

Return Payload

the newly created Issue

Exception Payloads

Payload Class	Description
IOException

<github:create-key>

Create key for currently authenticated user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
title		The title of the new key
key		The new key

Child Elements

Return Payload

the created Key

API Information

Create a public key

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:create-label>

Creates a new label

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The name of the repository
name		The name of the label
color		The color of the label, a 6 character hex code, without a leading #

Child Elements

Return Payload

returns a new Label

Exception Payloads

Payload Class	Description
IOException

<github:create-milestone>

Creates a new milestone

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The name of the repository
title		The title of the milestone
state		Optional. The state of the milestone, open or closed, by default is open
description		Optional. The description of the milestone
dueOn		Optional. When the milestone is due

Child Elements

Return Payload

a new milestone with the given parameters

Exception Payloads

Payload Class	Description
IOException

<github:create-repository>

Create a new repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
name		The name of the new repository
description		Optional. A description for the new repository
isPrivate	false	Optional. True to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. Default is false.
hasIssues	true	Optional. True to enable issues for this repository, false to disable them. Default is true.
hasWiki	true	Optional. True to enable the wiki for this repository, false to disable it. Default is true.
hasDownloads	true	Optional. True to enable downloads for this repository, false to disable them. Default is true.

Child Elements

Return Payload

the created Repository

API Information

Create

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:create-repository-for-org>

Create a new repository for the given organization

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
organization		The organization for the new repository
name		The name of the new repository
description		Optional. A description for the new repository
isPrivate	false	Optional. True to create a private repository, false to create a public one. Creating private repositories requires a paid GitHub account. Default is false.
hasIssues	true	Optional. True to enable issues for this repository, false to disable them. Default is true.
hasWiki	true	Optional. True to enable the wiki for this repository, false to disable it. Default is true.
hasDownloads	true	Optional. True to enable downloads for this repository, false to disable them. Default is true.

Child Elements

Return Payload

the created Repository

API Information

Create

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:create-resource>

Creates a new download resource

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
resourceName		The name of the resource
size		Size of file in bytes.
description		Optional. An optional description
contentType		Optional. An optional content type

Child Elements

Return Payload

a new DownloadResource resource

Exception Payloads

Payload Class	Description
IOException

<github:create-team>

Create the given team

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
organization		The organization
teamName		The team name
teamPermission	PULL	Optional. The team's `TeamPermission`

Child Elements

<github:repo-names> Optional. The associated repository names

Return Payload

the created Team

API Information

Create team

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:delete-comment>

Delete the issue comment with the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The repostory name
commentId		The id of the comment to delete

Child Elements

Exception Payloads

Payload Class	Description
IOException

<github:delete-commit-comment>

Deletes the given comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
commentId		Id from the comment

Child Elements

Exception Payloads

Payload Class	Description
IOException

<github:delete-deploy-key>

Deletes a deploy key given the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
id		The id of the deploy key

Child Elements

Exception Payloads

Payload Class	Description
IOException

<github:delete-download>

Deletes a download given the provided id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
id		The id of the download

Child Elements

Exception Payloads

Payload Class	Description
IOException

<github:delete-gist>

Deletes the given gist

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
gistId		Id of the gist

Child Elements

Exception Payloads

Payload Class	Description
IOException

<github:delete-gist-comment>

Deletes the given comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
commentId		Id of the comment

Child Elements

Exception Payloads

Payload Class	Description
IOException

<github:delete-key>

Delete key with given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
id		The id of the key to delete

Child Elements

API Information

Delete a public key

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:delete-label>

Deletes the given label

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The name of the repository
label		The label id

Child Elements

Exception Payloads

Payload Class	Description
IOException

<github:delete-milestone>

Deletes a given milestone

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The name of the repository
number		Number of the milestone

Child Elements

Exception Payloads

Payload Class	Description
IOException

<github:delete-team>

Delete the team with the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
id		The id of the team to delete.

Child Elements

API Information

Delete team

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:edit-comment>

Edits the body of the comment represented by the given comment id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The repostory name
commentId		The comment id
body		The new text of the comment

Child Elements

Return Payload

the created Comment

Exception Payloads

Payload Class	Description
IOException

<github:edit-commit-comment>

Edits a given comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
body		Body of the commit comment
commitId		Sha of the commit to comment on
line		Line number in the file to comment on
path		Relative path of the file to comment on
position		Line index in the diff to comment on

Child Elements

Exception Payloads

Payload Class	Description
IOException

<github:edit-deploy-key>

Edits a given deploy key

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
title		The title of the key
key		Ssh key

Child Elements

Return Payload

the modified Key

Exception Payloads

Payload Class	Description
IOException

<github:edit-gist-comment>

Updates the given comment

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
commentId		Id of the comment
body		New body of the comment

Child Elements

Return Payload

returns the updated Comment

Exception Payloads

Payload Class	Description
IOException

<github:edit-key>

Edit key for currently authenticated user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
keyId		The id of the key to edit
title		Optional. A new title for the key
key		Optional. A new key

Child Elements

Return Payload

edited Key

API Information

Update a public key

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:edit-repository>

Edit given repository. Only provide values for the attributes you need to change.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The owner of the repository
name		The name of the repository
description		Optional. A new description for the repository
isPrivate		Optional. True to turn it into a private repository, false to make it public. Private repositories require a paid GitHub account.
hasIssues		Optional. True to enable issues for this repository, false to disable them.
hasWiki		Optional. True to enable the wiki for this repository, false to disable it.
hasDownloads		Optional. True to enable downloads for this repository, false to disable them.

Child Elements

Return Payload

the edited Repository

API Information

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:edit-team>

Edit the given team. Only provide values for the attributes you want to update.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
id		The id of the team to edit
name		Optional. The new name of the team
teamPermission		Optional. The new `TeamPermission` for the team

Child Elements

Return Payload

the edited Team

API Information

Edit team

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:follow>

Make the currently authenticated user follow the given user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		The user to follow

Child Elements

API Information

Follow a user

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:fork-gist>

Forks the given gist

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
gistId		Id of the gist to be forked

Child Elements

Return Payload

returns the forked gist

Exception Payloads

Payload Class	Description
IOException

<github:fork-repository>

Fork given repository into new repository under the currently authenticated user.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The owner of the repository
name		The name of the repository

Child Elements

Return Payload

forked repository

Exception Payloads

Payload Class	Description
IOException

<github:fork-repository-for-org>

Fork given repository into new repository.

The new repository will be under the given organization if non-null, else it will be under the currently authenticated user.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
organization		The organization where the new repository will be
owner		The owner of the repository
name		The name of the repository

Child Elements

Return Payload

forked repository

Exception Payloads

Payload Class	Description
IOException

<github:get-branches>

Get branches in given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The owner of the repository
name		The name of the repository

Child Elements

Return Payload

list of branches

API Information

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-collaborators>

Returns the list of collaborators of the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository

Child Elements

Return Payload

non-null but possibly empty list of User

Exception Payloads

Payload Class	Description
IOException

<github:get-comment>

Returns a comment from commit with the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
commentId		Id from the comment

Child Elements

Return Payload

a CommitComment that corresponds to the given id

Exception Payloads

Payload Class	Description
IOException

<github:get-comments>

Get an issue's comments

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The repostory name
issueId		The id of the issue

Child Elements

Return Payload

a list of Comment

Exception Payloads

Payload Class	Description
IOException

<github:get-commit>

Returns a commit with given SHA-1 from given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
sha		Sha from comment

Child Elements

Return Payload

a RepositoryCommit for the given Sha and repository

Exception Payloads

Payload Class	Description
IOException

<github:get-commits>

Returns a list of the commits for a given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository

Child Elements

Return Payload

non-null but possibly empty list of RepositoryCommit

Exception Payloads

Payload Class	Description
IOException

<github:get-commits-by-sha>

Returns all commits in given repository beginning at an optional commit SHA-1 and affecting an optional path.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
sha		Optional. An optional Sha or branch to start listing commits from
path		Optional. Optional Only commits containing this file path will be returned

Child Elements

Return Payload

non-null but possibly empty list of RepositoryCommit

Exception Payloads

Payload Class	Description
IOException

<github:get-commmit-comments>

Returns all comments on commit with given Sha

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
sha		Sha or branch to start listing commits comments from

Child Elements

Return Payload

non-null but possibly empty list of CommitComment

Exception Payloads

Payload Class	Description
IOException

<github:get-contributors>

Get contributors to repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The owner of the repository
name		The name of the repository
includeAnonymous	false	Optional. Whether to include anonymus contributors

Child Elements

Return Payload

list of contributors

API Information

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-current-user>

Get the currently authenticated user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

Return Payload

a User instance representing the current user

API Information

Get the authenticated user

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-deploy-key>

Returns the key that corresponds to the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
id		The id of the key

Child Elements

Return Payload

the Key corresponding to the given id

Exception Payloads

Payload Class	Description
IOException

<github:get-deploy-keys>

Returns all deploys keys associated with the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository

Child Elements

Return Payload

non-null but possibly empty list of Key

Exception Payloads

Payload Class	Description
IOException

<github:get-download>

Returns a single download given the provided id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
id		The id of the download

Child Elements

Return Payload

the download corresponding to the given id

Exception Payloads

Payload Class	Description
IOException

<github:get-emails>

Get all e-mail addresses for the currently authenticated user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

Return Payload

list of e-mail address

API Information

List email addresses for a user

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-followers>

Returns a list of followers for given user, if no one is provided the current authenticated user will be used

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The user for which to get the followers, leave empty to use current user

Child Elements

Return Payload

a collection of User that follow the current user

API Information

List followers of a user

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-following>

Returns a list users following the given user, if no one is provided the current authenticated user will be used

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The user for which to get who is following, leave empty to use current user

Child Elements

Return Payload

a collection of User the user is following

API Information

List users following another user

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-forks>

Get all the forks of the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The owner of the repository
name		The name of the repository

Child Elements

Return Payload

non-null but possibly empty list of repository

Exception Payloads

Payload Class	Description
IOException

<github:get-gist>

Returns the gist according to the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
id		Id of the wanted gist

Child Elements

Return Payload

returns the Gist according to the provided id

Exception Payloads

Payload Class	Description
IOException

<github:get-gist-comment>

Returns the comment according to the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
commentId		Id of the comment to be retrieved

Child Elements

Return Payload

a comment corresponding to the given id

Exception Payloads

Payload Class	Description
IOException

<github:get-gist-comments>

Returns a list of comments for the given gist

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
gistId		Id of the gist

Child Elements

Return Payload

a list with the comments of the given gist

Exception Payloads

Payload Class	Description
IOException

<github:get-gists>

Returns a list of gists for the specified user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. User of the gists, leave empty to use this#user

Child Elements

Return Payload

a list of gists for the specified user

Exception Payloads

Payload Class	Description
IOException

<github:get-issue>

Get the issue represented by the given issueId

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The repostory name
issueId		The id of the issue

Child Elements

Return Payload

a Issue

Exception Payloads

Payload Class	Description
IOException

<github:get-issue-event>

Get issue event for repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The repostory name
eventId		The id of the event

Child Elements

Return Payload

a IssueEvent

Exception Payloads

Payload Class	Description
IOException

<github:get-issues>

Get a list of Issue objects that match the specified filter data

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The repostory name

Child Elements

<github:filter-data> Optional. Data to filter issues, if non is specified all issues will be returned

Return Payload

list of Issue

API Information

List issues for a repository

Exception Payloads

Payload Class	Description
	java.io.IOException
IOException

<github:get-issues-creted-after>

Custom processor

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The repository name
minutes		Minutes

Child Elements

Return Payload

a list of Issue

Exception Payloads

Payload Class	Description
IOException

<github:get-issues-since-number>

Custom processor

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The repository name
fromIssueNumber		From issue number

Child Elements

Return Payload

a list of Issue

Exception Payloads

Payload Class	Description
IOException

<github:get-key>

Get key with given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
id		The id of the key of obtain

Child Elements

Return Payload

a Key instance

API Information

Get a single public key

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-keys>

Get all public keys for currently authenticated user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

Return Payload

non-null list of Key

API Information

List public keys for a user

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-label>

Returns a single label

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The name of the repository
label		The label id

Child Elements

Return Payload

the label associated to the given id

Exception Payloads

Payload Class	Description
IOException

<github:get-labels>

Returns a list of labels for the given repository and user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The name of the repository

Child Elements

Return Payload

a list of labels for the given repository and user

Exception Payloads

Payload Class	Description
IOException

<github:get-languages>

Get languages used in given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The owner of the repository
name		The name of the repository

Child Elements

Return Payload

map of language names mapped to line counts

API Information

Exception Payloads

Payload Class	Description
	IOException\
IOException

<github:get-milestone>

Returns a single milestone

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The name of the repository
number		Milestone number

Child Elements

Return Payload

returns a single milestone

Exception Payloads

Payload Class	Description
IOException

<github:get-milestones>

Returns a list of milestones for the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The owner of the repository, leave empty to use this#user
repository		The name of the repository
state		State of the milestone, open or closed

Child Elements

Return Payload

s list of Milestone for the given repository

Exception Payloads

Payload Class	Description
IOException

<github:get-org-repositories>

Get organization repositories for the given organization

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
organization		The organization for which to get the repositories for

Child Elements

<github:filter-data> Optional. Data to filter repos, if non is specified all repos will be returned

Return Payload

list of Repository

API Information

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-repositories>

Get repositories for the currently authenticated user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

<github:filter-data> Optional. Data to filter repos, if non is specified all repos will be returned

Return Payload

list of Repository

API Information

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-repositories-for-user>

Get repositories for the given user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		The user for which to get the repositories for

Child Elements

Return Payload

list of Repository

API Information

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-repository>

Get repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository

Child Elements

Return Payload

repository

API Information

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-starred-gist>

Returns the starred gists for the currently authenticated user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

Return Payload

list of starred Gist for currently authenticated user

Exception Payloads

Payload Class	Description
IOException

<github:get-tags>

Get tags in given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The owner of the repository
name		The name of the repository

Child Elements

Return Payload

list of tags

API Information

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-team>

Get team with given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
id		The id of the team

Child Elements

Return Payload

a Team instance

API Information

Get team

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-team-members>

Get members of team with given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
id		The team id

Child Elements

Return Payload

team members

API Information

List members

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-team-repositories>

Get all repositories for given team

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
id		The team id

Child Elements

Return Payload

non-null list of repositories

API Information

List team repos

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-teams-for-org>

Get all teams in the given organization

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
organization		The organization for which te get the teams associated with

Child Elements

Return Payload

list of Team

API Information

List teams

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-user-by-login-name>

Get user with given login name

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
loginName		The login name of the user to look up

Child Elements

Return Payload

a User instance

API Information

Get a single user

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:get-watched>

Get repositories watched by the given user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		Optional. The user for which the get the watched repositories, leave empty to use this#user

Child Elements

Return Payload

non-null but possibly empty list of Repository

Exception Payloads

Payload Class	Description
IOException

<github:get-watchers>

Get users watching given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository

Child Elements

Return Payload

non-null but possibly empty list of User

Exception Payloads

Payload Class	Description
IOException

<github:is-collaborator>

Returns whether the user is a collaborator of the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
user		Optional. The user to consult if it's a collaborator or not, leave empty to use this#user

Child Elements

Return Payload

true if the user is a collaborator, false otherwise

Exception Payloads

Payload Class	Description
IOException

<github:is-following>

Returns wether the authenticated user is following the given user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		The user to check

Child Elements

Return Payload

wether the authenticated user is following the given user

API Information

Check if you are following a user

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:is-starred>

Returns whether the gist is starred or not

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
gistId		Id of the gist

Child Elements

Return Payload

returns true if the gist is starred, false otherwise

Exception Payloads

Payload Class	Description
IOException

<github:is-team-member>

Is the given user a member of the team with the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
id		The team id
user		The user name

Child Elements

Return Payload

true if member, false if not member

API Information

Get if a user is a public member

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:is-watching>

Is currently authenticated user watching given repository?

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository

Child Elements

Return Payload

true if watch, false otherwise

Exception Payloads

Payload Class	Description
IOException

<github:remove-collaborator>

Removes a collaborator from the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository
user		Optional. The user that's going to be removed as a collaborator from the given repository, leave empty to use this#user

Child Elements

Exception Payloads

Payload Class	Description
IOException

<github:remove-emails>

Removes one or more e-mail addresses to the currently authenticated user's account

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.

Child Elements

<github:emails> The email addresses to add

API Information

Delete email address(es)

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:remove-team-member>

Remove given user from team with given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
id		The team id
user		The user name

Child Elements

API Information

Remove a member

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:remove-team-repository>

Remove repository from team

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
id		The team id
owner		The owner of the repository
name		The name of the repository

Child Elements

API Information

Remove team repo

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:star-gist>

XML Sample

INCLUDE_ERROR

Star the gist with the given id

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
gistId		Id of the gist to be starred

Child Elements

Exception Payloads

Payload Class	Description
IOException

<github:unfollow>

Make the currently authenticated user unfollow the given user

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
user		The user to unfollow

Child Elements

API Information

Unfollow a user

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:unstar-gist>

XML Sample

INCLUDE_ERROR

Unstar the gist with the given id

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
gistId		Id of the gist to be unstarred

Child Elements

Exception Payloads

Payload Class	Description
IOException

<github:unwatch>

Remove currently authenticated user as a watcher of the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository

Child Elements

Exception Payloads

Payload Class	Description
IOException

<github:update-current-user>

Updates the currently authenticated user using the given attributes. Only provide values for the attributes you want to change.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
name		Optional. A the name for the current user
email		Optional. A publicly visibile email address for the current user
blog		Optional. A blog for the current user
company		Optional. A company for the current user
location		Optional. A location for the current user
hireable		Optional. Whether the current user is hireable

Child Elements

Return Payload

a User instance representing the current user

API Information

Update the authenticated user

Exception Payloads

Payload Class	Description
	IOException
IOException

<github:watch>

Add currently authenticated user as a watcher of the given repository

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description
config-ref		Optional. Specify which configuration to use.
owner		The name of the user that owns the repository
name		The name of the repository

Child Elements

Exception Payloads

Payload Class	Description
IOException