ArchersLab API (0.1.0)

Download OpenAPI specification:

License: MIT

CCAPDEV MCO

user

Login

Authorizations:

JwtNone

Request Body schema: application/json

email required	string <email>
password required	string <password> (UserPassword)

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"password": "123456"
}

Response samples

400
404
500

Content type

application/json

{"message": "string"
}

Logout

Authorizations:

Jwt

Responses

Response samples

401
500

Content type

application/json

{"message": "string"
}

Create a user

Authorizations:

JwtNone

Request Body schema: application/json

email required	string <email>
password required	string <password> (UserPassword)
required	object (UserName)

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"password": "123456",
"name": {"first": "Juan",
"last": "Dela Cruz"
}
}

Response samples

201
400
409
500

Content type

application/json

"507f1f77bcf86cd799439011"

Get current user ID

Authorizations:

Jwt

Responses

Response samples

200
401
404
500

Content type

application/json

"507f1f77bcf86cd799439011"

Read a user

Authorizations:

JwtNone

path Parameters

id

required

string (UserId) ^[0-9a-fA-F]{24}$

Example: 507f1f77bcf86cd799439011

The unique identifier of the user

Responses

Response samples

200
400
404
500

Content type

application/json

{"name": {"first": "Juan",
"last": "Dela Cruz"
},
"description": "Epic gamer",
"id": "507f1f77bcf86cd799439011",
"admin": true,
"editable": true
}

Update a user

Authorizations:

Jwt

path Parameters

id

required

string (UserId) ^[0-9a-fA-F]{24}$

Example: 507f1f77bcf86cd799439011

The unique identifier of the user

Request Body schema: application/json

required	object (UserName)
description required	string
password	string <password> (UserPassword)

Responses

Request samples

Payload

Content type

application/json

{"name": {"first": "Juan",
"last": "Dela Cruz"
},
"description": "Epic gamer",
"password": "123456"
}

Response samples

400
401
404
500

Content type

application/json

{"message": "string"
}

Delete a user

Authorizations:

Jwt

path Parameters

id

required

string (UserId) ^[0-9a-fA-F]{24}$

Example: 507f1f77bcf86cd799439011

The unique identifier of the user

Responses

Response samples

400
401
404
500

Content type

application/json

{"message": "string"
}

Read a user image

Authorizations:

JwtNone

path Parameters

id

required

string (UserId) ^[0-9a-fA-F]{24}$

Example: 507f1f77bcf86cd799439011

The unique identifier of the user

Responses

Response samples

400
404
500

Content type

application/json

{"message": "string"
}

Update a user image

Authorizations:

Jwt

path Parameters

id

required

string (UserId) ^[0-9a-fA-F]{24}$

Example: 507f1f77bcf86cd799439011

The unique identifier of the user

Request Body schema: image/*

string <binary> (Image)

Responses

Response samples

400
401
404
500

Content type

application/json

{"message": "string"
}

Delete a user image

Authorizations:

Jwt

path Parameters

id

required

string (UserId) ^[0-9a-fA-F]{24}$

Example: 507f1f77bcf86cd799439011

The unique identifier of the user

Responses

Response samples

400
401
404
500

Content type

application/json

{"message": "string"
}

lab

Read all labs

Authorizations:

JwtNone

query Parameters

q	string The search query to filter labs
page	integer >= 1 Default: 1 Pagination query

Responses

Response samples

200
400
404
500

Content type

application/json

{"data": [{"name": "GK403",
"weeklySchedule": {"sunday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"monday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"tuesday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"wednesday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"thursday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"friday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"saturday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
}
},
"slots": [{"id": "1",
"x": 0,
"y": 0
}
],
"id": "507f1f77bcf86cd799439011",
"editable": true
}
],
"hasNextPage": true
}

Create a lab

Authorizations:

Jwt

Request Body schema: application/json
required

The lab to create

name required	string
required	object Weekly schedule of the lab
required	Array of objects Available slots in the lab

Responses

Request samples

Payload

Content type

application/json

{"name": "GK403",
"weeklySchedule": {"sunday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"monday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"tuesday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"wednesday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"thursday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"friday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"saturday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
}
},
"slots": [{"id": "1",
"x": 0,
"y": 0
}
]
}

Response samples

201
400
401
409
500

Content type

application/json

"507f1f77bcf86cd799439011"

Read a lab

Authorizations:

JwtNone

path Parameters

id

required

string (LabId) ^[0-9a-fA-F]{24}$

Example: 507f1f77bcf86cd799439011

The unique identifier of the lab

Responses

Response samples

200
400
404
500

Content type

application/json

{"name": "GK403",
"weeklySchedule": {"sunday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"monday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"tuesday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"wednesday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"thursday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"friday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"saturday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
}
},
"slots": [{"id": "1",
"x": 0,
"y": 0
}
],
"id": "507f1f77bcf86cd799439011",
"editable": true
}

Update a lab

Authorizations:

Jwt

path Parameters

id

required

string (LabId) ^[0-9a-fA-F]{24}$

Example: 507f1f77bcf86cd799439011

The unique identifier of the lab

Request Body schema: application/json

name required	string
required	object Weekly schedule of the lab
required	Array of objects Available slots in the lab

Responses

Request samples

Payload

Content type

application/json

{"name": "GK403",
"weeklySchedule": {"sunday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"monday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"tuesday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"wednesday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"thursday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"friday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"saturday": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
}
},
"slots": [{"id": "1",
"x": 0,
"y": 0
}
]
}

Response samples

400
401
404
500

Content type

application/json

{"message": "string"
}

Delete a lab

Authorizations:

Jwt

path Parameters

id

required

string (LabId) ^[0-9a-fA-F]{24}$

Example: 507f1f77bcf86cd799439011

The unique identifier of the lab

Responses

Response samples

400
401
404
500

Content type

application/json

{"message": "string"
}

reservation

Create a reservation

Authorizations:

Jwt

Request Body schema: application/json

anonymous	boolean
required	object (Interval) Time interval
slotIds required	Array of strings (SlotId) [ items non-empty ]
labId required	string (LabId) ^[0-9a-fA-F]{24}$ The unique identifier of a lab

Responses

Request samples

Payload

Content type

application/json

{"anonymous": true,
"schedule": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"slotIds": ["string"
],
"labId": "507f1f77bcf86cd799439011"
}

Response samples

Content type

application/json

"507f1f77bcf86cd799439011"

Update a reservation

Authorizations:

Jwt

path Parameters

id

required

string (ReservationId) ^[0-9a-fA-F]{24}$

Example: 507f1f77bcf86cd799439011

The unique identifier of the reservation

Request Body schema: application/json

anonymous	boolean
required	object (Interval) Time interval
slotIds required	Array of strings (SlotId) [ items non-empty ]

Responses

Request samples

Payload

Content type

application/json

{"anonymous": true,
"schedule": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"slotIds": ["string"
]
}

Response samples

400
401
404
500

Content type

application/json

{"message": "string"
}

Delete a reservation

Authorizations:

Jwt

path Parameters

id

required

string (ReservationId) ^[0-9a-fA-F]{24}$

Example: 507f1f77bcf86cd799439011

The unique identifier of the reservation

Responses

Response samples

400
401
404
500

Content type

application/json

{"message": "string"
}

Read the reservations of the user

Authorizations:

JwtNone

path Parameters

id

required

string (UserId) ^[0-9a-fA-F]{24}$

Example: 507f1f77bcf86cd799439011

The unique identifier of the user

Responses

Response samples

200
400
404
500

Content type

application/json

[{"anonymous": true,
"schedule": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"slotIds": ["string"
],
"labId": "507f1f77bcf86cd799439011",
"id": "507f1f77bcf86cd799439011",
"userId": "507f1f77bcf86cd799439011",
"editable": true
}
]

Read the reservations of the lab

Authorizations:

JwtNone

path Parameters

id

required

string (LabId) ^[0-9a-fA-F]{24}$

Example: 507f1f77bcf86cd799439011

The unique identifier of the lab

Responses

Response samples

200
400
404
500

Content type

application/json

[{"anonymous": true,
"schedule": {"start": "1970-01-01T00:00:00.000Z",
"end": "1970-01-01T00:00:00.000Z"
},
"slotIds": ["string"
],
"labId": "507f1f77bcf86cd799439011",
"id": "507f1f77bcf86cd799439011",
"userId": "507f1f77bcf86cd799439011",
"editable": true
}
]

ArchersLab API (0.1.0)

user

Login

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

Logout

Authorizations:

Responses

Response samples

Create a user

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

Get current user ID

Authorizations:

Responses

Response samples

Read a user

Authorizations:

path Parameters

Responses

Response samples

Update a user

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete a user

Authorizations:

path Parameters

Responses

Response samples

Read a user image

Authorizations:

path Parameters

Responses

Response samples

Update a user image

Authorizations:

path Parameters

Request Body schema: image/*

Responses

Response samples

Delete a user image

Authorizations:

path Parameters

Responses

Response samples

lab

Read all labs

Authorizations:

query Parameters

Responses

Response samples

Create a lab

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Read a lab

Authorizations:

path Parameters

Responses

Response samples

Update a lab

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete a lab

Request Body schema: application/json
required