From a9006d82f5ba54054c3fe239dbf38361365e11b8 Mon Sep 17 00:00:00 2001 From: Joe Banks Date: Wed, 16 Dec 2020 23:26:45 +0000 Subject: Document forms routes --- backend/routes/forms/discover.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'backend/routes/forms/discover.py') diff --git a/backend/routes/forms/discover.py b/backend/routes/forms/discover.py index bba6fd4..9400f05 100644 --- a/backend/routes/forms/discover.py +++ b/backend/routes/forms/discover.py @@ -1,11 +1,13 @@ """ Return a list of all publicly discoverable forms to unauthenticated users. """ +from spectree.response import Response from starlette.requests import Request from starlette.responses import JSONResponse -from backend.models import Form +from backend.models import Form, FormList from backend.route import Route +from backend.validation import api class DiscoverableFormsList(Route): @@ -16,7 +18,9 @@ class DiscoverableFormsList(Route): name = "discoverable_forms_list" path = "/discoverable" + @api.validate(resp=Response(HTTP_200=FormList), tags=["forms"]) async def get(self, request: Request) -> JSONResponse: + """List all discoverable forms that should be shown on the homepage.""" forms = [] cursor = request.state.db.forms.find({"features": "DISCOVERABLE"}) -- cgit v1.2.3