API_DOC.md

MS-USERS Endpoints v0.0.0

Each section in this document contains all valid HTTP verbs that can be called. Section headers are the route.

/

#GET

Params: none.
Returns: array of user objects.

Each object is an index in the array. All users in the database will be returned.

This is an unauthenticated endpoint, meaning that anyone will receive responses.

DEPRECATION WARNING

This enpoint is being deprecated. It will be inexistent in all subsequent versions of this API. See the ms-users-auth microservice for alternatives.

#PUT

Creates a new user.

Returns: "User has been created!"

Params (must be Body parameters in raw JSON format):

{
  "username": "some_username",
    "password": "some_password",
    "email": "some_email",
    "location": "some_location"
}

Location is optional. This is an unauthenticated endpoint.

#POST

Updates a user object.

Params:

  {
    "username": "user_name",
    "location": "some_location"
  }

Both of these parameters are optional..?

This is an authenticated endpoint.

Returns "Success" OR some_probably_nondescriptive_error

/:username

Where :username is replaced by (you guessed it!) a username that exists in the database.

#GET

Params: none.

Returns: one user object.

This is an unauthenticated endpoint.

#DELETE

Deletes a single user.

Params: none.

Returns: "Deleted user_name" OR some_error_message.

This is an unauthenticated endpoint.

/validate

#POST

Sets a user's validated property to true

Params (must be raw JSON in request.body ):

  {
   "email": "email_addr_of_user",
   "key": "long_string_sent_in_user_validation_email"
  }

Returns "Validated email_address"

This is an unauthenticaed endpoint.