From c82240cb3bae761068d8e07ec0af8b06bf410e9c Mon Sep 17 00:00:00 2001 From: Justin Campbell Date: Mon, 21 Jun 2021 10:04:06 -0400 Subject: [PATCH] Create QueueList resource --- src/webqueue2api/api/resources/queue_list.py | 29 ++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 src/webqueue2api/api/resources/queue_list.py diff --git a/src/webqueue2api/api/resources/queue_list.py b/src/webqueue2api/api/resources/queue_list.py new file mode 100644 index 0000000..8833f52 --- /dev/null +++ b/src/webqueue2api/api/resources/queue_list.py @@ -0,0 +1,29 @@ +from flask_restful import Resource +from flask_jwt_extended import jwt_required +from webqueue2api.parser import get_queue_counts + + +class QueueList(Resource): + # @jwt_required + def get(self) -> tuple: + """Returns a list of dictionaries with the number of items in each queue. + + Return Codes: + 200 (OK): On success. + + Example: + [ + { + name: "me", + number_of_items: 42 + }, + { + name: "bidc", + number_of_items: 3 + } + ] + + Returns: + tuple: Queues and item counts as JSON and HTTP response code. + """ + return (get_queue_counts(), 200) \ No newline at end of file