Doclab

Install

npm install doclab-api

HTTP API

There are two methods available for authentication: HTTP Basic and session token. HTTP Basic authentication should only be used to request a new session token or when session token don't have enough permission to access(or update) the resource(i.e. changing user's password).

To auth a user using session token, set the custom header "X-SESSION-TOKEN" with the value of the token you have.

Sessions

POST /sessions

Create a new session and get the token. You need to specify a ttl(measured in seconds).

Test Code

Users

GET /users/{userId|'me'}

Get the info of the user

Test Code

POST /users

Create a new user

Test Code

PATCH /users/{userId|'me'}

Update the current user's info

Test Code

PUT /users/{userId|'me'}/password

Update the current user's password

Test Code

Teams

GET /teams

Get all teams

Test Code

POST /teams

Create a new team

Test Code

Projects

POST /projects

Create a new project

Test Code

GET /projects

Get all projects which the current user has access to

Test Code

GET /projects/:projectId

Get the specified project info

Test Code

PATCH /projects/:projectId

Update a project

Test Code

POST /projects/:projectId/collections

Create a collection

Test Code

PUT /projects/:projectId/teams/:teamId

Update the permission of the team to the project

Test Code

Collections

Get /collections/:collectionId

Get the specified collection info

Test Code

Get /collections/:collectionId/dirs

Get the dirs of a collection

Test Code

POST /collections/:collectionId/dirs/_move

Move the doc in the dirs

Test Code

POST /collections/:collectionId/docs

Create a doc

Test Code

POST /collections/:collectionId/_move

Move a collection

Test Code

Docs

GET /docs/:docUUID

Get the doc.You can use ?version=:version to specified a version

Test Code

GET /docs/:docUUID/versions

Get the versions of the doc

Test Code

PATCH /docs/:docUUID

Update the title or content of the doc

Test Code