Skip to content
This repository has been archived by the owner on Feb 19, 2024. It is now read-only.

Latest commit

 

History

History
153 lines (106 loc) · 4.62 KB

README.md

File metadata and controls

153 lines (106 loc) · 4.62 KB
Raw

scrumboard-it-client

ScrumBoardIt - JavaScript client for scrumboard-it-client ScrumBoard-it API This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.1.0
  • Package version: 0.2.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install scrumboard-it-client --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your scrumboard-it-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('scrumboard-it-client') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var ScrumBoardIt = require('scrumboard-it-client');

var defaultClient = ScrumBoardIt.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new ScrumBoardIt.BoardApi()

var boardId = "boardId_example"; // {String} ID of the board to return

api.getBoardById(boardId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://api.scrumboard-it.org

Class Method HTTP request Description
ScrumBoardIt.BoardApi getBoardById GET /boards/{boardId} Find board by ID
ScrumBoardIt.BoardApi getBoards GET /boards List all accessible boards
ScrumBoardIt.BoardApi getTasksByBoardId GET /boards/{boardId}/tasks List all tasks of a board
ScrumBoardIt.OauthApi getAuthorizationConfig GET /oauth/{provider}/config Authentication public config
ScrumBoardIt.OauthApi getAuthorizationToken GET /oauth/{provider}/token Authentication token bridge

Documentation for Models

Documentation for Authorization

Bearer

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header