@managed-api/github-sr-connect

ScriptRunner Connect Managed API for GitHub

Managed API for GitHub is an API Client for GitHub by Adaptavist. You can read more about Managed APIs here.

This is ScriptRunner Connect runtime specific version of the Managed API (with sr-connect suffix). If you want to use Managed API in any other runtime, have a look at the runtime agnostic version.

Supported API calls

• fetch
• Branch
  • getBranch
  • getBranches
  • mergeBranch
  • renameBranch
  • syncForkBranch
  • Protection
    • deleteProtection
    • getProtection
    • updateProtection
    • Admin
      • deleteProtection
      • getProtection
      • setProtection
    • Commit
      • Signature
        • createProtection
        • deleteProtection
        • getProtection
    • Pull
      • Review
        • getProtection
        • updateProtection
    • Status
      • Check
        • addContexts
        • getContexts
        • getProtection
        • removeContexts
        • removeProtection
        • setContexts
        • updateProtection
• Commit
  • compareCommits
  • getBranchesForHead
  • getCommit
  • getCommits
  • getPullRequestsForCommit
  • Comment
    • createComment
    • deleteComment
    • getComment
    • getComments
    • getCommentsForRepository
    • updateComment
  • Status
    • createStatus
    • getCombinedStatusForReference
    • getStatusesForReference
• Deployment
  • createDeployment
  • deleteDeployment
  • getDeployment
  • getDeployments
  • Environment
    • createOrUpdateEnvironment
    • deleteEnvironment
    • getEnvironment
    • getEnvironments
  • Key
    • createKey
    • deleteKey
    • getKey
    • getKeys
  • Status
    • createStatus
    • getStatus
    • getStatuses
• Git
  • Blob
    • createBlob
    • getBlob
  • Commit
    • createCommit
    • getCommit
  • Reference
    • createReference
    • deleteReference
    • getMatchingReferences
    • getReference
    • updateReference
  • Tag
    • createTag
    • getTag
  • Tree
    • createTree
    • getTree
• Issue
  • createIssue
  • getIssue
  • getIssuesForAuthenticatedUser
  • getOrganizationIssuesForAuthenticatedUser
  • getRepositoryIssues
  • lockIssue
  • unlockIssue
  • updateIssue
  • Assignee
    • addAssignees
    • canUserBeAssigned
    • getAssignees
    • removeAssignees
  • Comment
    • createComment
    • deleteComment
    • getComment
    • getComments
    • getCommentsForRepository
    • updateComment
  • Event
    • getEvent
    • getEvents
    • getEventsForRepository
  • Label
    • addLabelsToIssue
    • createLabel
    • deleteLabel
    • getLabel
    • getLabels
    • getLabelsForIssuesInMilestone
    • getLabelsForRepository
    • removeLabelFromIssue
    • removeLabelsFromIssue
    • setLabelsToIssue
    • updateLabel
  • Milestone
    • createMilestone
    • deleteMilestone
    • getMilestone
    • getMilestones
    • updateMilestone
• Organization
  • getAuditLog
  • getInstallations
  • getOrganization
  • getOrganizations
  • getOrganizationsForAuthenticatedUser
  • getOrganizationsForUser
  • updateOrganization
  • Member
    • checkMembershipForUser
    • getMembers
    • getMembershipForAuthenticatedUser
    • getMembershipForUser
    • getMembershipsForAuthenticatedUser
    • removeMember
    • removeMembershipForUser
    • setMembershipForUser
    • updateMembershipForAuthenticatedUser
• Project
  • createOrganizationProject
  • createRepositoryProject
  • createUserProject
  • deleteProject
  • getOrganizationProjects
  • getProject
  • getRepositoryProjects
  • getUserProjects
  • updateProject
• Pull
  • createPullRequest
  • getCommits
  • getFiles
  • getPullRequest
  • getPullRequests
  • isMerged
  • mergePullRequest
  • updatePullRequest
  • updatePullRequestBranch
  • Review
    • createReview
    • deletePendingReview
    • dismissReview
    • getComments
    • getReview
    • getReviews
    • submitReview
    • updateReview
    • Comment
      • createComment
      • createReply
      • deleteComment
      • getComment
      • getComments
      • getCommentsInRepository
      • updateComment
    • Request
      • getReviewers
      • removeReviewers
      • requestReviewers
• Release
  • createRelease
  • deleteRelease
  • generateReleaseNotes
  • getLatestRelease
  • getRelease
  • getReleaseByTagName
  • getReleases
  • updateRelease
• Repository
  • createDispatchEvent
  • createOrganizationRepository
  • createRepositoryForAuthenticatedUser
  • createRepositoryFromTemplate
  • deleteRepository
  • disableAutomatedSecurityFixes
  • disableVulnerabilityAlerts
  • enableAutomatedSecurityFixes
  • enableVulnerabilityAlerts
  • getCodeOwnersErrors
  • getContributors
  • getLanguages
  • getOrganizationRepositories
  • getPublicRepositories
  • getRepositoriesForAuthenticatedUser
  • getRepositoriesForUser
  • getRepository
  • getTags
  • getTeams
  • getTopics
  • isVulnerabilityAlertsEnabled
  • replaceTopics
  • transferRepository
  • updateRepository
  • Collaborator
    • addCollaborator
    • getCollaborators
    • getPermissionsForUser
    • isUserCollaborator
    • removeCollaborator
    • Invitation
      • acceptInvitation
      • declineInvitation
      • deleteInvitation
      • getInvitations
      • getInvitationsForAuthenticatedUser
      • updateInvitation
  • Content
    • createOrUpdateFileContents
    • deleteFile
    • getContent
    • getRepositoryReadme
    • getRepositoryReadmeForDirectory
  • Fork
    • createFork
    • getForks
• Search
  • searchCode
  • searchCommits
  • searchIssuesAndPullRequests
  • searchLabels
  • searchRepositories
  • searchTopics
  • searchUsers
• User
  • getAuthenticatedUser
  • getUser
  • getUserContext
  • getUsers
  • updateAuthenticatedUser
  • Block
    • blockUser
    • checkIfUserIsBlockedByAuthenticatedUser
    • getBlockedUsersByAuthenticatedUser
    • unblockUser

Constructing Managed API

In ScriptRunner Connect a Managed API is constructed for you, but if you need to construct it manually, here's how you can do it:

import { GitHubApi } from '@managed-api/github-sr-connect';

export default async function() {
    const api = new GitHubApi('API_CONNECTION_ID');
}

Contact

Feel free to drop ideas, suggestions or improvements into our Slack community channel.

Changelog

2.0.0

• Breaking change: URL and query string parameters are now URL encoded, meaning if you encoded them explicitly before you have to remove your own encoding, otherwise they will get double encoded.

0.11.0

• • Updated OpenApi Specification.
• • Fields sort and order are deprecated in Search.searchCode.

0.9.0

Added support for the following Organization.Member methods:

• List organization members that can be used as Organization.Member.getMembers or All.getOrganizationMembers.

• Check organization membership for a user that can be used as Organization.Member.checkMembershipForUser or All.checkOrganizationMembershipForUser.

• Remove an organization member that can be used as Organization.Member.removeMember or All.removeOrganizationMember.

• Get organization membership for a user that can be used as Organization.Member.getMembershipForUser or All.getOrganizationMembershipForUser.

• Set organization membership for a user that can be used as Organization.Member.setMembershipForUser or All.setOrganizationMembershipForUser.

• Remove organization membership for a user that can be used as Organization.Member.removeMembershipForUser or All.removeOrganzationMembershipForUser.

• List organization memberships for the authenticated user that can be used as Organization.Member.getMembershipsForAuthenticatedUser or All.getOrganizationMembershipsForAuthenticatedUser.

• Get an organization membership for the authenticated user that can be used as Organization.Member.getMembershipForAuthenticatedUser or All.getOrganizationMembershipForAuthenticatedUser.

• Update an organization membership for the authenticated user that can be used as Organization.Member.updateMembershipForAuthenticatedUser or All.updateOrganizationMembershipForAuthenticatedUser.

Added support for the following Organization methods:

• List organizations that can be used as Organization.getOrganizations or All.getOrganizations.

• Get an organization that can be used as Organization.getOrganization or All.getOrganization.

• Update an organization that can be used as Organization.updateOrganization or All.updateOrganization.

• Get the audit log for an organization that can be used as Organization.getAuditLog or All.getAuditLogForOrganization.

• List app installations for an organization that can be used as Organization.getInstallations or All.getInstallationsForOrganization.

• List organizations for the authenticated user that can be used as Organization.getOrganizationsForAuthenticatedUser or All.getOrganizationsForAuthenticatedUser.

• List organizations for a user that can be used as Organization.getOrganizationsForUser or All.getOrganizationsForUser.

Added support for the following Search methods:

• Search code that can be used as Search.searchCode or All.searchCode.

• Search commits that can be used as Search.searchCommits or All.searchCommits.

• Search issues and pull requests that can be used as Search.searchIssuesAndPullRequests or All.searchIssuesAndPullRequests.

• Search labels that can be used as Search.searchLabels or All.searchLabels.

• Search repositories that can be used as Search.searchRepositories or All.searchRepositories.

• Search topics that can be used as Search.searchTopics or All.searchTopics.

• Search users that can be used as Search.searchUsers or All.searchUsers.

Added support for the following Release methods:

• List releases that can be used as Release.getReleases or All.getReleases.

• Create a release that can be used as Release.createRelease or All.createRelease.

• Generate release notes content for a release that can be used as Release.generateReleaseNotes or All.generateReleaseNotes.

• Get the latest release that can be used as Release.getLatestRelease or All.getLatestRelease.

• Get a release by tag name that can be used as Release.getReleaseByTagName or All.getReleaseByTagName.

• Get a release that can be used as Release.getRelease or All.getRelease.

• Update a release that can be used as Release.updateRelease or All.updateRelease.

• Delete a release that can be used as Release.deleteRelease or All.deleteRelease.

Added support for the following User.Block methods:

• List users blocked by the authenticated user that can be used as User.Block.getBlockedUsersByAuthenticatedUser or All.getBlockedUsersByAuthenticatedUser.

• Check if a user is blocked by the authenticated user that can be used as User.Block.checkIfUserIsBlockedByAuthenticatedUser or All.checkIfUserIsBlockedByAuthenticatedUser.

• Block a user that can be used as User.Block.blockUser or All.blockUser.

• Unblock a user that can be used as User.Block.unblockUser or All.unblockUser.

Added support for the following User methods:

• Get the authenticated user that can be used as User.getAuthenticatedUser or All.getAuthenticatedUser.

• Update the authenticated user that can be used as User.updateAuthenticatedUser or All.updateAuthenticatedUser.

• List users that can be used as User.getUsers or All.getUsers.

• Get a user that can be used as User.getUser or All.getUser.

• Get contextual information for a user that can be used as User.getUserContext or All.getUserContext.

Added support for the following Repository.Content methods:

• Delete a file that can be used as Repository.Content.deleteFile or All.deleteFile.

• Get a repository README that can be used as Repository.Content.getRepositoryReadme or All.getRepositoryReadme.

• Get a repository README for a directory that can be used as Repository.Content.getRepositoryReadmeForDirectory or All.getRepositoryReadmeForDirectory.

Added support for the following Branch.Protection methods:

• Get branch protection that can be used as Branch.Protection.getProtection or All.getBranchProtection.

• Update branch protection that can be used as Branch.Protection.updateProtection or All.updateBranchProtection.

• Delete branch protection that can be used as Branch.Protection.deleteProtection or All.deleteBranchProtection.

Added support for the following Branch.Protection.Admin methods:

• Get admin branch protection that can be used as Branch.Protection.Admin.getProtection or All.getAdminBranchProtection.

• Set admin branch protection that can be used as Branch.Protection.Admin.setProtection or All.setAdminBranchProtection.

• Delete admin branch protection that can be used as Branch.Protection.Admin.deleteProtection or All.deleteAdminBranchProtection.

Added support for the following Branch.Protection.Pull.Review methods:

• Get pull request review protection that can be used as Branch.Protection.Pull.Review.getProtection or All.getBranchPullRequestReviewProtection.

• Update pull request review protection that can be used as Branch.Protection.Pull.Review.updateProtection or All.updateBranchPullRequestReviewProtection.

Added support for the following Branch.Protection.Commit.Signature methods:

• Get commit signature protection that can be used as Branch.Protection.Commit.Signature.getProtection or All.getBranchCommitSignatureProtection.

• Create commit signature protection that can be used as Branch.Protection.Commit.Signature.createProtection or All.createBranchCommitSignatureProtection.

• Delete commit signature protection that can be used as Branch.Protection.Commit.Signature.deleteProtection or All.deleteBranchCommitSignatureProtection.

Added support for the following Branch.Protection.Status.Check methods:

• Get status checks protection that can be used as Branch.Protection.Status.Check.getProtection or All.getBranchStatusCheckProtection.

• Update status checks protection that can be used as Branch.Protection.Status.Check.updateProtection or All.updateBranchStatusCheckProtection.

• Remove status checks protection that can be used as Branch.Protection.Status.Check.removeProtection or All.removeBranchStatusCheckProtection.

• Get all status check contexts that can be used as Branch.Protection.Status.Check.getContexts or All.getBranchStatusCheckContexts.

• Add status check contexts that can be used as Branch.Protection.Status.Check.addContexts or All.addBranchStatusCheckContexts.

• Set status check contexts that can be used as Branch.Protection.Status.Check.setContexts or All.setBranchStatusCheckContexts.

Added support for the following Project methods:

• List organization projects that can be used as Project.getOrganizationProjects or All.getOrganizationProjects.

• Create an organization project that can be used as Project.createOrganizationProject or All.createOrganizationProject.

• Get a project that can be used as Project.getProject or All.getProject.

• Update a project that can be used as Project.updateProject or All.updateProject.

• Delete a project that can be used as Project.deleteProject or All.deleteProject.

• List repository projects that can be used as Project.getRepositoryProjects or All.getRepositoryProjects.

• Create a repository project that can be used as Project.createRepositoryProject or All.createRepositoryProject.

• List user projects that can be used as Project.getUserProjects or All.getUserProjects.

• Create a user project that can be used as Project.createUserProject or All.createUserProject.

Added support for the following Search methods:

• Search code that can be used as Search.searchCode or All.searchCode.

• Search commits that can be used as Search.searchCommits or All.searchCommits.

• Search issues and pull requests that can be used as Search.searchIssuesAndPullRequests or All.searchIssuesAndPullRequests.

• Search labels that can be used as Search.searchLabels or All.searchLabels.

• Search repositories that can be used as Search.searchRepositories or All.searchRepositories.

• Search topics that can be used as Search.searchTopics or All.searchTopics.

• Search users that can be used as Search.searchUsers or All.searchUsers.

Copyright Adaptavist 2024 (c) All rights reserved