Lodol Docs

GitHub

API actions for the GitHub integration.

GitHub

Manage GitHub issues and repositories with a personal access token.


Add labels to issue

Add one or more labels to an issue.

Parameters

ParameterTypeRequiredDescription
ownerstringYesRepository owner (username or organization)
repostringYesRepository name
issue_numbernumberYesIssue number
labelsarrayYesLabels to add

Response

[
  "bug",
  "enhancement",
  "help wanted"
]

Close issue

Close an existing issue.

Parameters

ParameterTypeRequiredDescription
ownerstringYesRepository owner (username or organization)
repostringYesRepository name
issue_numbernumberYesIssue number to close

Response

{
  "id": 789,
  "number": 42,
  "state": "closed",
  "title": "Bug in feature X"
}

Comment on issue

Add a comment to an existing issue.

Parameters

ParameterTypeRequiredDescription
ownerstringYesRepository owner (username or organization)
repostringYesRepository name
issue_numbernumberYesIssue number
bodystringYesComment body

Response

{
  "body": "This is a comment.",
  "id": 456,
  "user": {
    "login": "commenter"
  }
}

Create issue

Create a new issue in a repository.

Parameters

ParameterTypeRequiredDescription
ownerstringYesRepository owner (username or organization)
repostringYesRepository name
titlestringYesIssue title
bodystringNoIssue body/description
labelsarrayNoLabels to assign to the issue
assigneesarrayNoUsernames to assign to the issue

Response

{
  "html_url": "https://github.com/user/repo/issues/43",
  "id": 123,
  "number": 43,
  "title": "New Feature Request"
}

Get issue

Get details of a specific issue.

Parameters

ParameterTypeRequiredDescription
ownerstringYesRepository owner (username or organization)
repostringYesRepository name
issue_numbernumberYesIssue number

Response

{
  "body": "Description of the bug.",
  "html_url": "https://github.com/user/repo/issues/42",
  "id": 789,
  "number": 42,
  "state": "open",
  "title": "Bug in feature X"
}

List issues

List issues for a specific repository.

Parameters

ParameterTypeRequiredDescription
ownerstringYesRepository owner (username or organization)
repostringYesRepository name
statestringNoFilter by state (open, closed, all)
labelsarrayNoFilter by labels (comma-separated)
per_pagenumberNoNumber of results per page (max 100)

Response

[
  {
    "html_url": "https://github.com/user/repo/issues/42",
    "id": 789,
    "number": 42,
    "state": "open",
    "title": "Bug in feature X"
  }
]

List repositories

List repositories accessible to the authenticated user.

Parameters

ParameterTypeRequiredDescription
visibilitystringNoFilter by visibility (all, public, private)
affiliationstringNoFilter by affiliation (owner, collaborator, organization_member)
per_pagenumberNoNumber of results per page (max 100)

Response

[
  {
    "full_name": "user/my-repo",
    "html_url": "https://github.com/user/my-repo",
    "id": 123456,
    "name": "my-repo",
    "private": false
  }
]

On this page