@managed-api/gitlab-v4-sr-connect

ScriptRunner Connect Managed API for GitLab

Managed API for GitLab is an API Client for GitLab 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
  • createBranch
  • deleteBranch
  • deleteMergedBranches
  • getBranch
  • getBranches
• Commit
  • cherryPickCommit
  • createComment
  • createCommit
  • getComments
  • getCommit
  • getCommitDiff
  • getCommitReferences
  • getCommits
  • getDiscussions
  • getGPGSignature
  • getMergeRequests
  • revertCommit
  • Status
    • createBuildStatus
    • getStatuses
• Epic
  • createEpic
  • createTodoItem
  • deleteEpic
  • getEpic
  • getEpicsForGroup
  • updateEpic
• Issue
  • addSpentTimeForIssue
  • cloneIssue
  • createIssue
  • createTodoItem
  • deleteIssue
  • editIssue
  • getGroupIssues
  • getIssue
  • getIssues
  • getMergeRequestsRelatedToIssue
  • getMergeRequestsThatClosedAnIssue
  • getParticipants
  • getProjectIssue
  • getProjectIssues
  • getTimeTrackingStatsForIssue
  • getUserAgentDetails
  • moveIssue
  • promoteToEpic
  • reorderIssue
  • resetSpentTimeForIssue
  • resetTimeEstimateForIssue
  • setTimeEstimateForIssue
  • subscribeToIssue
  • unsubscribeFromIssue
• Link
  • Issue
    • createLink
    • deleteLink
    • getRelations
• Repository
  • addChangelog
  • compare
  • generateChangelog
  • getBlob
  • getContributors
  • getFileArchive
  • getRawBlobContent
  • getRepositoryTree
  • mergeBase
  • File
    • createFile
    • deleteFile
    • getFile
    • getFileBlame
    • getRawFile
    • updateFile

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 { GitlabApi } from '@managed-api/gitlab-v4-sr-connect';

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

Contact

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

Changelog

• 2.3.0
  • Removed non-empty body from HEAD requests.
• 2.2.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.

Copyright Adaptavist 2022 (c) All rights reserved