sudo docker run \
-it \
--name pocket --rm \
-p 5004:5004 --net ermiry \
-v /home/ermiry/Documents/ermiry/ermiry-web/pocket-service:/home/pocket \
-v /home/ermiry/Documents/ermiry/ermiry-web/keys:/home/keys \
-e RUNTIME=development \
-e PORT=5004 \
-e CERVER_RECEIVE_BUFFER_SIZE=4096 -e CERVER_TH_THREADS=4 \
-e CERVER_CONNECTION_QUEUE=4 \
-e MONGO_APP_NAME=pocket -e MONGO_DB=ermiry \
-e MONGO_URI=mongodb://pocket:password@mongo:27017/ermiry \
-e PUB_KEY=/home/keys/key.pub \
-e CONNECT_TO_REDIS=true -e REDIS_HOSTNAME=redis \
ermiry/pocket-service:development /bin/bash
Access: Public
Description: Pocket top level route
Returns:
- 200 on success
Access: Public
Description: Returns pocket service current version
Returns:
- 200 and version's json on success
Access: Private
Description: Used to test if JWT keys work correctly
Returns:
- 200 on success
- 401 on failed auth
Access: Private
Description: Get all the authenticated user's transactions
Returns:
- 200 on success
- 400 on bad request
- 401 on failed auth
- 500 on server error
Access: Private
Description: A user has requested to create a new transaction
Returns:
- 200 on success
- 400 on bad request
- 401 on failed auth
- 500 on server error
Access: Private
Description: Returns information about an existing transaction that belongs to a user
Returns:
- 200 and transaction's json on success
- 401 on failed auth
- 404 on transaction not found
Access: Private
Description: A user wants to update an existing transaction
Returns:
- 200 on success updating user's transaction
- 400 on bad request due to missing values
- 401 on failed auth
- 500 on server error
Access: Private
Description: Deletes an existing user's transaction
Returns:
- 200 on success deleting user's transaction
- 400 on bad request
- 401 on failed auth
- 500 on server error
Access: Private
Description: Get all the authenticated user's categories
Returns:
- 200 and categories json on success
- 401 on failed auth
Access: Private
Description: A user has requested to create a new category
Returns:
- 200 on success creating category
- 400 on failed to create new category
- 401 on failed auth
- 500 on server error
Access: Private
Description: Returns information about an existing category that belongs to a user
Returns:
- 200 and category's json on success
- 401 on failed auth
- 404 on category not found
Access: Private
Description: A user wants to update an existing category
Returns:
- 200 on success updating user's category
- 400 bad request due to missing values
- 401 on failed auth
- 500 on server error
Access: Private
Description: Deletes an existing user's category
Returns:
- 200 on success deleting user's category
- 400 on bad request
- 401 on failed auth
- 500 on server error
Access: Private
Description: Get all the authenticated user's places
Returns:
- 200 and places json on success
- 401 on failed auth
Access: Private
Description: A user has requested to create a new place
Returns:
- 200 on success creating place
- 400 on failed to create new place
- 401 on failed auth
- 500 on server error
Access: Private
Description: Returns information about an existing place that belongs to a user
Returns:
- 200 and place's json on success
- 401 on failed auth
- 404 on place not found
Access: Private
Description: A user wants to update an existing place
Returns:
- 200 on success updating user's place
- 400 bad request due to missing values
- 401 on failed auth
- 500 on server error
Access: Private
Description: Deletes an existing user's place
Returns:
- 200 on success deleting user's place
- 400 on bad request
- 401 on failed auth
- 500 on server error