18 lines
774 B
Markdown
18 lines
774 B
Markdown
# Scavenger Hunt API
|
|
|
|
REST API to support a community scavenger hunt app.
|
|
|
|
## Environment variables
|
|
* `DB_PASSWORD` Password for the database
|
|
* `DB_URL` JDBC URL for the database
|
|
* `DB_USER` Username for the database
|
|
* `JWT_SECRET` Secret pass for the JWT
|
|
|
|
## TODO:
|
|
### User Endpoints
|
|
* upload photo for hunt item POST `/hunt/{huntId}/team/{teamId}/item/{itemId}/photo` - body: image binary
|
|
* delete photo for hunt item DELETE `/hunt/{huntId}/team/{teamId}/item/{itemId}/photo/{photoId}`
|
|
* list hunt teams with scores for hunt `GET /lead/hunt/{huntId}/team`
|
|
* list hunters with scores for hunt GET `/lead/hunt/{huntId}/hunter`
|
|
### Admin Endpoints
|
|
* approve photo for hunt item POST `/admin/hunt/{huntId}/team/{teamId}/item/{itemId}/photo/{photoId}` - body: approval status |