DOCS.md

devstat-core v0.0.1

• Auth

  • Authenticate

• DataSource

  • Create data source
  • Delete data source
  • Retrieve data source
  • Retrieve data sources
  • Update data source

• Member

  • Create member
  • Delete member
  • Retrieve member
  • Retrieve members
  • Update member

• Team

  • Create team
  • Delete team
  • Retrieve team
  • Retrieve teams
  • Update team

• User

  • Create user
  • Delete user
  • Retrieve current user
  • Retrieve user
  • Retrieve users
  • Update password
  • Update user

Auth

Authenticate

POST /auth

Headers

Name	Type	Description
Authorization	String	Basic authorization with email and password.

DataSource

Create data source

POST /data-sources

Parameters

Name	Type	Description
access_token	String	user access token.
type		Data source's type.
data		Data source's data.

Delete data source

DELETE /data-sources/:id

Parameters

Name	Type	Description
access_token	String	user access token.

Retrieve data source

GET /data-sources/:id

Parameters

Name	Type	Description
access_token	String	user access token.

Retrieve data sources

GET /data-sources

Parameters

Name	Type	Description
access_token	String	user access token.
q	String	optional Query to search.
page	Number	optional Page number.
limit	Number	optional Amount of returned items.
sort	String[]	optional Order of returned items.
fields	String[]	optional Fields to be returned.

Update data source

PUT /data-sources/:id

Parameters

Name	Type	Description
access_token	String	user access token.
type		Data source's type.
data		Data source's data.

Member

Create member

POST /members

Parameters

Name	Type	Description
access_token	String	user access token.
name		Member's name.
status		Member's status.
group		Member's group.

Delete member

DELETE /members/:id

Parameters

Name	Type	Description
access_token	String	user access token.

Retrieve member

GET /members/:id

Parameters

Name	Type	Description
access_token	String	user access token.

Retrieve members

GET /members

Parameters

Name	Type	Description
access_token	String	user access token.
q	String	optional Query to search.
page	Number	optional Page number.
limit	Number	optional Amount of returned items.
sort	String[]	optional Order of returned items.
fields	String[]	optional Fields to be returned.

Update member

PUT /members/:id

Parameters

Name	Type	Description
access_token	String	user access token.
name		Member's name.
status		Member's status.
group		Member's group.

Team

Create team

POST /teams

Parameters

Name	Type	Description
access_token	String	user access token.
name		Team's name.
members		Team's members.

Delete team

DELETE /teams/:id

Parameters

Name	Type	Description
access_token	String	user access token.

Retrieve team

GET /teams/:id

Parameters

Name	Type	Description
access_token	String	user access token.

Retrieve teams

GET /teams

Parameters

Name	Type	Description
access_token	String	user access token.
q	String	optional Query to search.
page	Number	optional Page number.
limit	Number	optional Amount of returned items.
sort	String[]	optional Order of returned items.
fields	String[]	optional Fields to be returned.

Update team

PUT /teams/:id

Parameters

Name	Type	Description
access_token	String	user access token.
name		Team's name.
members		Team's members.

User

Create user

POST /users

Parameters

Name	Type	Description
email	String	User's email.
password	String	User's password.
name	String	optional User's name.
picture	String	optional User's picture.
role	String	optional User's role.

Delete user

DELETE /users/:id

Parameters

Name	Type	Description
access_token	String	User access_token.

Retrieve current user

GET /users/me

Parameters

Name	Type	Description
access_token	String	User access_token.

Retrieve user

GET /users/:id

Retrieve users

GET /users

Parameters

Name	Type	Description
access_token	String	User access_token.
q	String	optional Query to search.
page	Number	optional Page number.
limit	Number	optional Amount of returned items.
sort	String[]	optional Order of returned items.
fields	String[]	optional Fields to be returned.

Update password

PUT /users/:id/password

Headers

Name	Type	Description
Authorization	String	Basic authorization with email and password.

Parameters

Name	Type	Description
password	String	User's new password.

Update user

PUT /users/:id

Parameters

Name	Type	Description
access_token	String	User access_token.
name	String	optional User's name.
picture	String	optional User's picture.