- Notifications
You must be signed in to change notification settings - Fork13
markmssd/bitbucket-server-nodejs
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Provides access tosome of client's APIs.
npm install bitbucket-server-nodejsSupports public, basic auth (either with username/password, orPersonal Access Tokens) and OAuth1.
Specify auth's type as 'public', 'basic' or 'oauth'. Defaults to 'public'.
var Client = require('bitbucket-server-nodejs').Client; - BASIC AUTH -var auth = { "type": "basic", "username": "username", "password": "password"}; - OR BASIC AUTH WITH PERSONAL ACCESS TOKEN -var auth = { "type": "basic", "bearer": "bearer",}; - OR OAUTH1 -var auth = { "type": "oauth", "consumer_secret": "consumer_secret", "signature_method": "signature_method", "token": "token", "token_secret": "token_secret"}; - OR NO AUTH AT ALL, FOR PUBLIC ACCESS -var client = new Client('http://localhost:7990/rest/api/1.0'); - OR -var client = new Client('http://localhost:7990/rest/api/1.0', auth);Get all projects.
client.projects.get(); // PromiseGet all repos for a project.
client.repos.get(projectKey); // PromiseGet all repos, using pagination.
client.repos.getAll(); // PromiseGet all repos for all projects.
client.repos.getCombined(); // PromiseGet one repo for a project.
client.repos.getRepo(projectKey, repo); // PromiseGet all branches for a repo.
client.branches.get(projectKey, repoKey); // PromiseTo get branches from a user repo rather than a project repo, use user's slug as the project key, prepended by '~'.
client.branches.get('~userslug', repoKey); // PromiseGet all tags for a repo.
client.tags.get(projectKey, repoKey); // PromiseTo get tags from a user repo rather than a project repo, use user's slug as the project key, prepended by '~'.
client.tags.get('~userslug', repoKey); // PromiseGet a specific pull request.
client.prs.getSpecific(projectKey, repoSlug, id); // PromiseGet all pull requests for a repo.
client.prs.get(projectKey, repoSlug); // PromiseGet all pull requests for a project.
client.prs.getCombined(projectKey); // PromiseGet all pull requests on all projects.
client.prs.getCombined(); // PromiseGet all pull requests by a specific author.
client.prs.getCombined(null, null, { author: "ben" }); // PromiseGet all pull requests in a specific state (defaults OPEN).
client.prs.getCombined(null, null, { state: "MERGED" }); // PromisePossible states: ALL, OPEN, DECLINED or MERGED.
Get all hooks for a repo.
client.hooks.get(projectKey, repoSlug); // PromiseGet all pre-recieve hooks.
client.hooks.getPreReceive(projectKey, repoSlug); // PromiseGet all post-recieve hooks.
client.hooks.getPostReceive(projectKey, repoSlug); // PromiseGet details for a single hook.
client.hooks.getHook(projectKey, repoSlug, hookKey); // PromiseGet user's settings. Username and Password must be valid.
client.settings.get(username); // PromiseGet full list of users. You will probably need to have admin access.
client.users.get(); // PromiseGet one user.
client.users.getUser(userSlug); // Promise- /rest/api/1.0/users [GET]
- /rest/api/1.0/users/{userSlug} [GET]
- /rest/api/1.0/users/{userSlug}/settings [GET]
- /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}/browse [GET]
- /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches [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]
- /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/tags [GET]
About
A NodeJS library to interact with Bitbucket-Server. Supports Basic Auth and OAuth1.
Topics
Resources
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Languages
- JavaScript100.0%