aboutsummaryrefslogtreecommitdiffstats
path: root/backend/routes/forms/discover.py
diff options
context:
space:
mode:
authorGravatar Joe Banks <[email protected]>2020-12-16 23:26:45 +0000
committerGravatar Joe Banks <[email protected]>2020-12-16 23:26:45 +0000
commita9006d82f5ba54054c3fe239dbf38361365e11b8 (patch)
tree2eeb196e20af64a7942073fd876cf24f9320e93c /backend/routes/forms/discover.py
parentMake model changes (diff)
Document forms routes
Diffstat (limited to 'backend/routes/forms/discover.py')
-rw-r--r--backend/routes/forms/discover.py6
1 files changed, 5 insertions, 1 deletions
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"})