woden

Woden - JavaScript client for woden Specification for Woden REST API This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.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 woden --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 woden from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('woden') 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/YOUR_USERNAME/woden then install it via:

    npm install YOUR_USERNAME/woden --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 Woden = require('woden');

var defaultClient = Woden.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 Woden.FileSystemApi()

var body = new Woden.CreateFolder(); // {CreateFolder} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createFolder(body, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:1823/api/v1

Class	Method	HTTP request	Description
Woden.FileSystemApi	createFolder	POST /folder	Create folder
Woden.FileSystemApi	downloadFile	GET /file/{hash}/{cid}	Download file
Woden.FileSystemApi	getFolder	GET /folder/{hash}	Get folder
Woden.FileSystemApi	search	GET /search/{name}	Search
Woden.FileSystemApi	tree	GET /tree	Get folders tree
Woden.FileSystemApi	updateFile	PUT /file	Update file
Woden.FileSystemApi	uploadFile	POST /file	Upload file
Woden.FileSystemApi	versions	GET /versions/{hash}	Versions of file
Woden.PermissionsApi	changePermissions	PUT /permissions	Change permissions
Woden.PermissionsApi	revokePermissions	DELETE /permissions	Revoke permissions
Woden.UserApi	changeUser	PUT /user	Update user password
Woden.UserApi	createUser	POST /user	Create user
Woden.UserApi	login	POST /user/auth	Login user into the system
Woden.UserApi	logout	DELETE /user/logout	Logout user from the system
Woden.VotingApi	createVoting	POST /voting	Create voting
Woden.VotingApi	getVoting	GET /voting	Get voting list
Woden.VotingApi	updateVoting	PUT /voting	User vote

Documentation for Models

• Woden.ChangePassword
• Woden.ChangePermissions
• Woden.CreateFolder
• Woden.CreateUser
• Woden.Login
• Woden.RevokePermissions
• Woden.Vote
• Woden.Voting

Documentation for Authorization

Bearer

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