🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

bitbucket-server-nodejs

Package Overview
Dependencies
Maintainers
1
Versions
19
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

bitbucket-server-nodejs

Provides access to *some* of Stash's APIs.

2.6.1
Source
npm
Version published
Weekly downloads
76
26.67%
Maintainers
1
Weekly downloads
 
Created
Source

Rest client for Atlassian client

Provides access to some of client's APIs.

Coverage Status

Initialising Client

var oauth = {
    "consumer_key": "consumer_key",
    "consumer_secret": "consumer_secret",
    "signature_method": "signature_method",
    "token": "token",
    "token_secret": "token_secret"
};

var Client = require('bitbucket-server-nodejs').Client;

var client = new Client(
    'http://localhost:7990/rest/api/1.0/',
    oauth
);

APIS

projects

Get all projects.

client.projects.get(); // Promise

repos

Get all repos for a project.

client.repos.get(projectKey); // Promise

Get all repos for all projects.

client.repos.getCombined(); // Promise

pull requests

Get all pull requests for a repo.

client.prs.get(projectKey, repoSlug); // Promise

Get all pull requests for a project.

client.prs.getCombined(projectKey); // Promise

Get all pull requests on all projects.

client.prs.getCombined(); // Promise

Get all pull requests by a specific author.

client.prs.getCombined(null, null, { author: "ben" }); // Promise

Get all pull requests in a specific state (defaults OPEN).

client.prs.getCombined(null, null, { state: "MERGED" }); // Promise

Possible states: ALL, OPEN, DECLINED or MERGED.

hooks

Get all hooks for a repo.

client.hooks.get(projectKey, repoSlug); // Promise

Get all pre-recieve hooks.

client.hooks.getPreReceive(projectKey, repoSlug); // Promise

Get all post-recieve hooks.

client.hooks.getPostReceive(projectKey, repoSlug); // Promise

Get details for a single hook.

client.hooks.getHook(projectKey, repoSlug, hookKey); // Promise

API Coverage

  • /rest/api/1.0/projects [GET]
  • /rest/api/1.0/projects/{projectKey}/repos [GET]
  • /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug} [GET]
  • /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests [GET]
  • /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks [GET]
  • /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/enabled [PUT]

Keywords

api

FAQs

Package last updated on 24 Sep 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts