Resources Models Clients

Trainer 0.0.1-dev

History | Watch

Virtual trainer to help athletes prepare for events, e.g. marathons, ironman, etc.

  • Contact: N/A
  • License: N/A

Resources

user

Operations

Method and Path Description
GET /users

Search for a specific user. You must specify at least 1 parameter - either a guid or email - and will receive back either 0 or 1 users.
GET /users/:guid

Returns information about the user with this guid.
POST /users

Create a new user.
PUT /users/:guid

Updates information about the user with the specified guid.

Headers

No headers

Imports

No imports

Enums

No enums

Interfaces

No interfaces

Models

error

Example Json: Minimal | Full

Interfaces: None

Represents a validation error from the application.

Field Type Required? Default Description
code string Yes -

message string Yes -

healthcheck

Example Json: Minimal | Full

Interfaces: None

Healthcheck for the application itself

Field Type Required? Default Description
status string Yes -

Example: healthy

name

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
first string No -

last string No -

user

Example Json: Minimal | Full

Interfaces: None

A user is a top level person.

Field Type Required? Default Description
guid uuid Yes -

primary key of the user
email string Yes -

email address. lower(email) is unique system wide
name name No -

user_form

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
email string Yes -

name name No -

Unions

No unions

Annotations

No annotations