Skip to content

Commit

Permalink
Update SDK
Browse files Browse the repository at this point in the history
  • Loading branch information
cdujeu committed Sep 22, 2021
1 parent 1a099c5 commit ce76b31
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 2 deletions.
65 changes: 64 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,65 @@
# cells-sdk-js
Javascript SDK for communicating with Cells server

Javascript SDK for communicating with Cells server.

This SDK is generated automatically using `swagger-codegen` tool from the OpenAPI specification of Cells Rest API. It does not rely on any framework and uses superagent internally for performing HTTP requests.

Since Cells v3, it is used internally by the official Pydio Cells web interface (written in React).

## Usage

### Installation

Simply use `npm install --save cells-sdk` to append the latest version to your package.json.

### Authentication

Authentication is passed via the `Authorization: Bearer $TOKEN` header, where `$TOKEN` can be a Personal Access Token, or retrieved dynamically by the frontend login process.

### Endpoints

All APIs described in Cells official documentation are supported. Below are listed the main services available :

- ACLService
- ActivityService
- AdminTreeService
- ConfigService
- FrontendService
- GraphService
- InstallService
- JobsService
- LogService
- MailerService
- MetaService
- PolicyService
- RoleService
- SearchService
- ShareService
- TemplatesService
- TokenService
- TreeService
- UpdateService
- UserMetaService
- UserService
- WorkspaceService

Please refer to the docs for more information.

### Example

A sample application is available in example/app.js

Basic tree listing looks like :

```javascript
var api = new TreeServiceApi(client);
var request = new RestGetBulkMetaRequest();
request.NodePaths = ['/folder/*'];
api.bulkStatNodes(request).then(res => {
// Read array res.Nodes with all nodes
});
```

## License

This library is licensed under Apache V2.0 license.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "cells-sdk",
"version": "2.3.4",
"version": "3.0.0",
"description": "Javascript SDK for Pydio Cells",
"main": "lib/index.js",
"module": "src/index.js",
Expand Down

0 comments on commit ce76b31

Please sign in to comment.