From aae3d8d2ca762aea3d65148a6274a36a571704c3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Victor=20L=C3=B6fgren?= <viclo211@student.liu.se>
Date: Fri, 21 May 2021 00:35:14 +0200
Subject: [PATCH] Update api descriptions
---
server/app/apis/auth.py | 4 +++-
server/app/apis/misc.py | 2 +-
server/app/apis/users.py | 4 +++-
3 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/server/app/apis/auth.py b/server/app/apis/auth.py
index dd31c561..1075d5a6 100644
--- a/server/app/apis/auth.py
+++ b/server/app/apis/auth.py
@@ -20,7 +20,9 @@ from flask_smorest import Blueprint, abort, arguments
from . import http_codes, protect_route
-blp = Blueprint("auth", "auth", url_prefix="/api/auth", description="Operations related to authorization")
+blp = Blueprint(
+ "auth", "auth", url_prefix="/api/auth", description="Logging in as a user or with a code, and logging out"
+)
class UserLoginArgsSchema(ma.Schema):
diff --git a/server/app/apis/misc.py b/server/app/apis/misc.py
index 21054b20..902407dd 100644
--- a/server/app/apis/misc.py
+++ b/server/app/apis/misc.py
@@ -24,7 +24,7 @@ from marshmallow_sqlalchemy import auto_field
from . import http_codes
-blp = Blueprint("misc", "misc", url_prefix="/api/misc", description="Miscellaneous operations")
+blp = Blueprint("misc", "misc", url_prefix="/api/misc", description="Roles, regions, types and statistics")
class TypesResponseSchema(BaseSchema):
diff --git a/server/app/apis/users.py b/server/app/apis/users.py
index fb7adf28..a7b90e44 100644
--- a/server/app/apis/users.py
+++ b/server/app/apis/users.py
@@ -17,7 +17,9 @@ from marshmallow import fields
from . import http_codes
-blp = Blueprint("users", "users", url_prefix="/api/users", description="Operations on users")
+blp = Blueprint(
+ "users", "users", url_prefix="/api/users", description="Adding, updating, deleting and searching for users"
+)
class UserAddArgsSchema(BaseSchema):
--
GitLab