Skip to content

Latest commit

 

History

History
110 lines (67 loc) · 2.69 KB

UserApi.md

File metadata and controls

110 lines (67 loc) · 2.69 KB

UserApi

All URIs are relative to http://localhost

Method HTTP request Description
addUser POST /api/user Adds a new user.
getAllUsers GET /api/user Retrieves all users.
getUserByEmail GET /api/user/{email} Retrieves a user by their email address.
updateUser PUT /api/user/{email} update a user by their email address.

addUser

UserResponse addUser(UserRequest)

Adds a new user.

Parameters

Name Type Description Notes
UserRequest UserRequest User to add to the system. [optional]

Return type

UserResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

getAllUsers

List getAllUsers()

Retrieves all users.

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

getUserByEmail

UserResponse getUserByEmail(email)

Retrieves a user by their email address.

Parameters

Name Type Description Notes
email String The email address of the user to retrieve. [default to null]

Return type

UserResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

updateUser

updateUser(email, UserUpdateRequest)

update a user by their email address.

Parameters

Name Type Description Notes
email String The email address of the user to update. [default to null]
UserUpdateRequest UserUpdateRequest User to update from the system. [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json