joglog api 0.0.1-dev

JogLog API documentation

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

Resources

time

Operations

Method and Path Description
POST /times

Create a time entry

GET /times

List all times

GET /times/:id

Get a specific time entry

PATCH /times

Patch a time entry

DELETE /times/:id

Remove a specific time entry

user

Operations

Method and Path Description
POST /users/authenticate

Authentication

POST /users

Create a user

GET /users

List all users

GET /users/:id

Get a specific user

PATCH /users

Patch a user

DELETE /users/:id

Remove a specific user

Headers

Name Type Required? Default Description
Authorization string No -

A base64-encoded JWT token looking like ‘Authorization : Bearer {token}’

Imports

No imports

Enums

patch.operation

Patch operation

Name Value Description
test test

replace replace

stringOrInteger

Integer for ID or string for any other

Name Value Description
string string

integer integer

time.patch.path

Time patch field path (id only for test)

Name Value Description
distance distance

time time

id id

user.patch.path

User patch field path (id only for test)

Name Value Description
username username

password password

role role

id id

user.role

User Role

Name Value Description
user user

Regular user

manager manager

User manager

admin admin

The God himself

Interfaces

No interfaces

Models

time

Example Json: Minimal | Full

Interfaces: None

Time entry

Field Type Required? Default Description
id integer Yes -

Unique time id

distance integer Yes -

Distance in meters

time integer Yes -

Time in seconds

createdAt date-time-iso8601 Yes -

Creation date-time

updatedAt date-time-iso8601 Yes -

Last update date-time

time.minimal

Example Json: Minimal | Full

Interfaces: None

Time entry

Field Type Required? Default Description
distance integer Yes -

Distance in meters

time integer Yes -

Time in seconds

time.patch.entry

Example Json: Minimal | Full

Interfaces: None

Time patch entry

Field Type Required? Default Description
op patch.operation Yes -

path time.patch.path Yes -

value integer Yes -

user

Example Json: Minimal | Full

Interfaces: None

User

Field Type Required? Default Description
id integer Yes -

Unique user id

username string Yes -

Username

role user.role Yes -

User Role

createdAt date-time-iso8601 Yes -

Creation date-time

updatedAt date-time-iso8601 Yes -

Last update date-time

user.minimal

Example Json: Minimal | Full

Interfaces: None

User

Field Type Required? Default Description
username string Yes -

Username

password string Yes -

Password

user.patch.entry

Example Json: Minimal | Full

Interfaces: None

User patch entry

Field Type Required? Default Description
op patch.operation Yes -

path user.patch.path Yes -

value stringOrInteger Yes -

Unions

No unions

Annotations

No annotations