crucible-connector
v0.1.2
Published
REST API Implementation for Atlassian Crucible
Downloads
243
Readme
Crucible Connector
A typed JavaScript REST client for Atlassian's Crucible.
NOTICE: This package is currently under heavy development and not yet much tested (coming soon).
Features
- Create a REST client to communicate with your Crucible/Fisheye server.
- Call methods of the Crucible API.
- Call methods of the Crucible/Fisheye Common API.
- Call methods of the Fisheye API.
More details about the API can be found at the Crucible REST API Guide.
Requirements
This implementation uses the REST API version 4.7.
Installation
npm install --save crucible-connector
Usage
Create your REST client.
const connector = new Connector(
{ host: 'https://crucible.example.com:443', ignoreSslError: false },
{ username: 'user', password: 'password' }
);
Now start to communicate via common
, crucible
and fisheye
:
connector.crucible
.searchRepositories({ types: ['git'] })
.then((result) => {
console.log(result.repoData.map((repo) => repo.name).join(', '));
})
.catch((error) => {
console.log(error);
});
Acknowledgements
This package uses Microsoft Typed REST Client as underlying REST Client.
Contributors
Feel free to contribute...