DOCS.md

rnapi v0.0.0

• Auth

  • Authenticate

• Bike

  • Create bike
  • Delete bike
  • Retrieve bike
  • Retrieve bikes
  • Update bike

• 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.

Parameters

Name	Type	Description
access_token	String	Master access_token.

Bike

Create bike

POST /bike

Parameters

Name	Type	Description
access_token	String	admin access token.
Model		Bike's Model.
Photo		Bike's Photo.
Color		Bike's Color.
Weight		Bike's Weight.
Location		Bike's Location.
Available		Bike's Available.
Rate		Bike's Rate.
RentalDate		Bike's RentalDate.

Delete bike

DELETE /bike/:id

Parameters

Name	Type	Description
access_token	String	admin access token.

Retrieve bike

GET /bike/:id

Parameters

Name	Type	Description
access_token	String	user access token.

Retrieve bikes

GET /bike

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 bike

PUT /bike/:id

Parameters

Name	Type	Description
access_token	String	admin access token.
Model		Bike's Model.
Photo		Bike's Photo.
Color		Bike's Color.
Weight		Bike's Weight.
Location		Bike's Location.
Available		Bike's Available.
Rate		Bike's Rate.
RentalDate		Bike's RentalDate.

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.
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.