Skip to content

Commit

Permalink
Update QueueList docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Justin Campbell committed Nov 11, 2020
1 parent ffc049b commit 5b752de
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions api/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ def post(self) -> tuple:
200 (OK): On success.
401 (Unauthroized): When username or password are incorrect.
422 (Unprocessable Entitiy): When the username or password can't be parsed.
500 (Internal Server Error): On API error.
Example:
curl -X POST
Expand Down Expand Up @@ -106,7 +105,6 @@ def get(self, queue: str, number: int) -> tuple:
Return Codes:
200 (OK): On success.
500 (Internal Server Error): On API error.
Example:
/api/ce/100 returns:
Expand Down Expand Up @@ -143,7 +141,6 @@ def get(self, queues: str) -> tuple:
Return Codes:
200 (OK): On success.
500 (Internal Server Error): On API error.
Args:
queues (str): Plus (+) deliminited list of queues.
Expand All @@ -161,9 +158,12 @@ def get(self, queues: str) -> tuple:

class QueueList(Resource):
@jwt_required
def get(self) -> list:
def get(self) -> tuple:
"""Returns a list of dictionaries with the number of items in each queue.
Return Codes:
200 (OK): On success.
Example:
[
{
Expand All @@ -177,9 +177,9 @@ def get(self) -> list:
]
Returns:
list: Dictionaries with the number of items in each queue.
tuple: Queues and item counts as JSON and HTTP response code.
"""
return ECNQueue.getQueueCounts()
return (ECNQueue.getQueueCounts(), 200)



Expand Down

0 comments on commit 5b752de

Please sign in to comment.