@managed-api/jira-cloud-v3-core
v3.7.0
Published
Adaptavist Managed API for Jira Cloud
Downloads
433
Keywords
Readme
Managed API for Jira Cloud
Managed API for Jira Cloud is an API Client for Jira Cloud by Adaptavist primarily designed for the use in ScriptRunner Connect. You can read more about Managed APIs here.
This 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.
Platform specific ports
Supported API calls
- fetch
- Application
- Avatar
- Dashboard
- Filter
- Group
- GroupAndUserPicker
- Instance
- Issue
- assignIssue
- createIssue
- createIssues
- deleteIssue
- editIssue
- getChangeLogs
- getChangeLogsById
- getIssue
- sendNotification
- Attachment
- Comment
- Field
- getContexts
- getFields
- getFieldsPaginated
- Configuration
- Custom
- Link
- Metadata
- Navigator
- Notification
- Scheme
- Priority
- Property
- Resolution
- Search
- Security
- Transition
- Type
- Vote
- Watcher
- Worklog
- Jql
- Label
- Myself
- Permission
- Project
- createProject
- deleteProject
- deleteProjectAsync
- getProject
- getProjects
- getStatuses
- restoreDeletedProject
- updateProject
- Avatar
- Category
- Component
- IssueType
- Notification
- Scheme
- Permission
- Property
- Role
- Security
- Scheme
- Type
- Validation
- Version
- Screen
- User
- Workflow
- createWorkflow
- deleteWorkflow
- getWorkflows
- readWorkflows
- searchWorkflows
- updateWorkflows
- Scheme
- Status
- Transition
Porting to other runtimes
While the primary reason for creating Managed APIs was to use them in ScriptRunner Connect runtime, then you can easily port them to any runtime of your choosing.
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:
{
buffer: {
encode(input: string): ArrayBuffer;
decode(input: ArrayBuffer): string;
},
performHttpCall(request: Request): Promise<Response>
}Here is an example how to create a Node port of the Managed API:
import { JiraCloudApiCore } from "@managed-api/jira-cloud-v3-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";
export class JiraCloudApi extends JiraCloudApiCore {
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<Response> {
const requestUrl = `${this.baseUrl}${request.url}`; // Substitute base URL
request.headers.set('Authorization', `Basic ${this.authToken}`); // 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 to 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.
Contact
At this time Managed APIs are unlicensed and close sourced, but feel free to drop an email to [email protected] for ideas, suggestions and improvements.
Changelog
3.7.0
Renamed the following methods:
- Get create issue types metadata that can be used as
Issue.Metadata.getCreateIssueTypesMetadataorAll.getCreateIssueTypesMetadatahas been renamed toIssue.Metadata.getIssueTypesMetadataForCreateIssueorAll.getIssueTypesMetadataForCreateIssue. - Get create field metadata that can be used as
Issue.Metadata.getCreateFieldMetadataorAll.getCreateFieldMetadatahas been renamed toIssue.Metadata.getFieldsMetadataForCreateIssueorAll.getFieldsMetadataForCreateIssue. - Get edit metadata that can be used as
Issue.Metadata.getEditMetadataorAll.getEditIssueMetadatahas been renamed toIssue.Metadata.getMetadataForIssueEditorAll.getMetadataForIssueEdit.
- Get create issue types metadata that can be used as
3.6.0
Added support for the following methods:
- Read workflows that can be used as
Workflow.readWorkflowsorAll.readWorkflows. - Update workflows that can be used as
Workflow.updateWorkflowsorAll.updateWorkflows. - [Sear
- Read workflows that can be used as
