Adaptavist Managed API for GitLab API v4
npm install @managed-api/gitlab-v4-coreThis is a runtime agnostic version of the Managed API (with core suffix) that makes it easy to port it to any runtime you may want to use this Managed API on.
You can do so by extending the *Core Managed API class where you'll be asked to provide implementation for getPlatformImplementation function. In this implementation you have to specify how to perform buffer encoding/decoding operations and how to perform HTTP calls:
``typescript`
{
buffer: {
encode(input: string): ArrayBuffer;
decode(input: ArrayBuffer): string;
},
performHttpCall(request: Request): Promise
}
Here is an example how to create a Node port of the Managed API:
`typescript
import { GitlabApiCore } from "@managed-api/gitlab-v4-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";
export class GitlabApi extends GitlabApiCore {
constructor(private baseUrl: string, private authToken: string) {
super();
}
protected getPlatformImplementation(): PlatformImplementation {
return {
buffer: {
encode: (input) => Buffer.from(input, 'utf-8'),
decode: (input) => Buffer.from(input).toString('utf-8')
},
performHttpCall: (request) => this.performHttpCall(request)
};
}
private async performHttpCall(request: Request): Promise
const requestUrl = ${this.baseUrl}${request.url}; // Substitute base URLBasic ${this.authToken}
request.headers.set('Authorization', ); // Substitute auth token
const response = await fetch(requestUrl, {
method: request.method,
headers: request.headers as any,
body: request.method.toLowerCase() !== 'get' ? Buffer.from((await request.arrayBuffer()) ?? new ArrayBuffer(0)) : undefined
});
const apiHeaders = new Headers();
response.headers.forEach((value, key) => apiHeaders.append(key, value));
const body = await response.arrayBuffer();
return super.buildResponse(response.url, response.status, response.statusText, apiHeaders, body);
}
}
`
Please note that the authentication handling details may not be accurate and serve as an example. If you wish yo use these Managed APIs without having to concern yourself how to deal with and secure authentication details when working with APIs, then feel free to evaluate ScriptRunner Connect platform.
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.* 2.1.0
- Url-encoded the following properties:
-
id in all Repository, Commit, Epic, Link and Branch methods.
- id in the following Issue Methods: getGroupIssues, getProjectIssues, getProjectIssue, createIssue, editIssue, deleteIssue, reorderIssue, moveIssue, cloneIssue, subscribeToIssue, unsubscribeFromIssue, createTodoItem, promoteToEpic, setTimeEstimateForIssue, resetTimeEstimateForIssue, addSpentTimeForIssue, resetSpentTimeForIssue, getTimeTrackingStatsForIssue, getMergeRequestsRelatedToIssue, getMergeRequestsThatClosedAnIssue, getParticipants, getUserAgentDetails.
- branch in Branch.getBranch and Branch.deleteBranch.
- file_path in all Repository.File` methods.Copyright Adaptavist 2022 (c) All rights reserved