@managed-api/confluence-cloud-core
v2.1.0
Published
Adaptavist Managed API for Confluence Cloud
Downloads
41
Keywords
Readme
Managed API for Confluence Cloud
Managed API for Confluence Cloud is an API Client for Confluence 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
- Content
- createContent
- deleteContent
- getContent
- getContentById
- getContentHistory
- publishLegacyDraft
- publishSharedDraft
- searchContentByCQL
- updateContent
- Attachment
- Body
- Children
- Comment
- Copy
- Descendant
- Label
- Move
- Property
- Restriction
- Version
- DynamicModule
- InlineTask
- Label
- LongRunningTask
- Relation
- Search
- Setting
- Space
- Template
- Theme
- User
- UserGroup
- Watcher
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 { ConfluenceCloudApiCore } from "@managed-api/confluence-cloud-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";
export class ConfluenceCloudApi extends ConfluenceCloudApiCore {
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
2.1.0
The following methods are deprecated:
- Get content properties that can be used as
Content.Property.getProperties
orAll.getContentProperties
. - Create content property that can be used as
Content.Property.createProperty
orAll.createContentProperty
. - Get content property that can be used as
Content.Property.getProperty
orAll.getContentProperty
. - Update content property that can be used as
Content.Property.updateProperty
orAll.updateContentProperty
. - Create content property for key that can be used as
Content.Property.createPropertyForKey
orAll.createContentPropertyForKey
. - Delete content property that can be used as
Content.Property.deleteProperty
orAll.deleteContentProperty
. - Get content restriction status for group that can be used as
Content.Restriction.Group.getGroupStatus
orAll.getContentRestrictionGroupStatus
. - Add group to content restriction that can be used as
Content.Restriction.Group.addGroup
orAll.addContentRestrictionGroup
. - Remove group from content restriction that can be used as
Content.Restriction.Group.removeGroup
orAll.removeContentRestrictionGroup
. - Delete user group that can be used as
UserGroup.deleteUserGroup
orAll.deleteUserGroup
. - Get group that can be used as
UserGroup.getUserGroupByName
orAll.getUserGroupByName
. - Get group members that can be used as
UserGroup.Member.getMembersByName
orAll.getUserGroupMembersByName
. - Add member to group that can be used as
UserGroup.Member.addMemberByName
orAll.addUserGroupMembersByName
. - Remove member from group that can be used as
UserGroup.Member.removeMember
orAll.removeUserGroupMember
. - Create space property that can be used as
Space.Property.createProperty
orAll.createSpaceProperty
. - Get space property that can be used as
Space.Property.getProperty
orAll.getSpaceProperty
. - Update space property that can be used as
Space.Property.updateProperty
orAll.updateSpaceProperty
. - Create space property for key that can be used as
Space.Property.createPropertyForKey
orAll.createSpacePropertyForKey
. - Delete space property that can be used as
Space.Property.deleteProperty
orAll.deleteSpaceProperty
.
- Get content properties that can be used as
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
The following methods are deprecated:
- Get content that can be used as
Content.getContent
orAll.getContent
. - Create Content that can be used as
Content.createContent
orAll.createContent
. - Get content by ID that can be used as
Content.getContentById
orAll.getContentById
. - Update content that can be used as
Content.updateContent
orAll.updateContent
. - Delete content that can be used as
Content.deleteContent
orAll.deleteContent
. - Get content history that can be used as
Content.getContentHistory
orAll.getContentHistory
. - Get attachments that can be used as
Content.Attachment.getAttachments
orAll.getContentAttachments
. - Get content children that can be used as
Content.Children.getAttachments
orAll.getContentChildren
. - Get content children by type that can be used as
Content.Children.getChildrenByType
orAll.getContentChildrenByType
. - Get content comments that can be used as
Content.Comment.getComments
orAll.getContentComments
. - Get labels for content that can be used as
Content.Label.getLabels
orAll.getContentLabels
. - Get content versions that can be used as
Content.Version.getVersions
orAll.getContentVersions
. - Get content version that can be used as
Content.Version.getVersion
orAll.getContentVersion
. - Get inline tasks based on search parameters that can be used as
InlineTask.getInlineTasksBasedOnSearchParameters
orAll.getInlineTasksBasedOnSearchParameters
. - Get spaces that can be used as
Space.getSpaces
orAll.getSpaces
. - Get space that can be used as
Space.getSpace
orAll.getSpace
. - Get content for space that can be used as
Space.Content.getContent
orAll.getSpaceContent
. - Get content by type for space that can be used as
Space.Content.getContentByType
orAll.getSpaceContentByType
. - Get space properties that can be used as
Space.Property.getProperties
orAll.getSpaceProperties
.
- Get content that can be used as
Copyright Adaptavist 2024 (c) All rights reserved