feat: extending openAPI

app/main.py

@@ -5,8 +5,13 @@
 
 from app.internal.languages import set_ui_language
 from app.internal.security.ouath2 import auth_exception_handler
+from app.utils.extending_openapi import custom_openapi
 from app.routers.salary import routes as salary
 from fastapi import Depends, FastAPI, Request
+from fastapi.openapi.docs import (
+    get_swagger_ui_html,
+    get_swagger_ui_oauth2_redirect_html,
+)
 from fastapi.staticfiles import StaticFiles
 from starlette.status import HTTP_401_UNAUTHORIZED
 from sqlalchemy.orm import Session
@@ -25,7 +30,7 @@ def create_tables(engine, psql_environment):
 
 create_tables(engine, config.PSQL_ENVIRONMENT)
 
-app = FastAPI()
+app = FastAPI(title="Pylander", docs_url=None)
 app.mount("/static", StaticFiles(directory=STATIC_PATH), name="static")
 app.mount("/media", StaticFiles(directory=MEDIA_PATH), name="media")
 app.logger = logger
@@ -36,16 +41,31 @@ def create_tables(engine, psql_environment):
 # This MUST come before the app.routers imports.
 set_ui_language()
 
-
 from app.routers import (  # noqa: E402
-
     agenda, calendar, categories, celebrity, currency, dayview,
     email, event, export, four_o_four, invitation, login, logout, profile,
-    register, search, telegram, weekview, whatsapp,
+    register, search, telegram, user, weekview, whatsapp,
 )
 
 json_data_loader.load_to_db(next(get_db()))
 
+
+@app.get("/docs", include_in_schema=False)
+async def custom_swagger_ui_html():
+    return get_swagger_ui_html(
+        openapi_url=app.openapi_url,
+        title=app.title + " - Swagger UI",
+        oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url,
+        swagger_js_url="/static/swagger/swagger-ui-bundle.js",
+        swagger_css_url="/static/swagger/swagger-ui.css",
+    )
+
+
+@app.get(app.swagger_ui_oauth2_redirect_url, include_in_schema=False)
+async def swagger_ui_redirect():
+    return get_swagger_ui_oauth2_redirect_html()
+
+
 routers_to_include = [
     agenda.router,
     calendar.router,
@@ -66,6 +86,7 @@ def create_tables(engine, psql_environment):
     salary.router,
     search.router,
     telegram.router,
+    user.router,
     whatsapp.router,
 ]
 
@@ -75,11 +96,14 @@ def create_tables(engine, psql_environment):
 
 # TODO: I add the quote day to the home page
 # until the relevant calendar view will be developed.
-@app.get("/")
+@app.get("/", include_in_schema=False)
 @logger.catch()
 async def home(request: Request, db: Session = Depends(get_db)):
     quote = daily_quotes.quote_per_day(db)
     return templates.TemplateResponse("index.html", {
         "request": request,
         "quote": quote,
     })
+
+
+custom_openapi(app)

app/routers/agenda.py

@@ -27,7 +27,7 @@ def calc_dates_range_for_agenda(
     return start, end
 
 
-@router.get("/agenda")
+@router.get("/agenda", include_in_schema=False)
 def agenda(
         request: Request,
         db: Session = Depends(get_db),

app/routers/calendar.py

@@ -11,6 +11,7 @@
     prefix="/calendar/month",
     tags=["calendar"],
     responses={404: {"description": "Not found"}},
+    include_in_schema=False
 )
 
 ADD_DAYS_ON_SCROLL: int = 42

app/routers/categories.py

@@ -35,7 +35,7 @@ class Config:
 
 
 # TODO(issue#29): get current user_id from session
-@router.get("/")
+@router.get("/", include_in_schema=False)
 def get_categories(request: Request,
                    db_session: Session = Depends(get_db)) -> List[Category]:
     if validate_request_params(request.query_params):
@@ -46,6 +46,19 @@ def get_categories(request: Request,
                                    f"unallowed params.")
 
 
+@router.get("/list")
+def get_all_categories(
+        db_session: Session = Depends(get_db)) -> List[Category]:
+    return db_session.query(Category).all()
+
+
+@router.get("/")
+def get_categories_by_user_id(
+        user_id: int, db_session: Session = Depends(get_db)
+) -> List[Category]:
+    return get_user_categories(db_session, user_id)
+
+
 # TODO(issue#29): get current user_id from session
 @router.post("/")
 async def set_category(category: CategoryModel,

app/routers/dayview.py

@@ -122,7 +122,7 @@ def get_events_and_attributes(
             yield (event, DivAttributes(event, day))
 
 
-@router.get('/day/{date}')
+@router.get('/day/{date}', include_in_schema=False)
 async def dayview(
           request: Request, date: str, session=Depends(get_db), view='day',
       ):

app/routers/event.py

@@ -1,9 +1,10 @@
-from datetime import datetime
+from datetime import datetime as dt
 import json
 from operator import attrgetter
 from typing import Any, Dict, List, Optional, Tuple
 
 from fastapi import APIRouter, Depends, HTTPException, Request
+from pydantic import BaseModel
 from sqlalchemy.exc import SQLAlchemyError
 from sqlalchemy.orm import Session
 from sqlalchemy.orm.exc import MultipleResultsFound, NoResultFound
@@ -27,8 +28,8 @@
 START_FORMAT = '%A, %d/%m/%Y %H:%M'
 UPDATE_EVENTS_FIELDS = {
     'title': str,
-    'start': datetime,
-    'end': datetime,
+    'start': dt,
+    'end': dt,
     'availability': bool,
     'content': (str, type(None)),
     'location': (str, type(None)),
@@ -43,22 +44,49 @@
 )
 
 
+class EventModel(BaseModel):
+    title: str
+    start: dt
+    end: dt
+    content: str
+    owner_id: int
+    location: str
+
+
+@router.get("/")
+async def get_events(session=Depends(get_db)):
+    return session.query(Event).all()
+
+
+@router.post("/")
+async def create_event_api(event: EventModel, session=Depends(get_db)):
+    create_event(db=session,
+                 title=event.title,
+                 start=event.start,
+                 end=event.start,
+                 content=event.content,
+                 owner_id=event.owner_id,
+                 location=event.location)
+    return {'success': True}
+
+
+@router.get("/edit", include_in_schema=False)
 @router.get("/edit")
 async def eventedit(request: Request) -> Response:
     return templates.TemplateResponse("event/eventedit.html",
                                       {"request": request})
 
 
-@router.post("/edit")
+@router.post("/edit", include_in_schema=False)
 async def create_new_event(request: Request,
                            session=Depends(get_db)) -> Response:
     data = await request.form()
     title = data['title']
     content = data['description']
-    start = datetime.strptime(data['start_date'] + ' ' + data['start_time'],
-                              TIME_FORMAT)
-    end = datetime.strptime(data['end_date'] + ' ' + data['end_time'],
-                            TIME_FORMAT)
+    start = dt.strptime(data['start_date'] + ' ' +
+                        data['start_time'], TIME_FORMAT)
+    end = dt.strptime(data['end_date'] + ' ' + data['end_time'],
+                      TIME_FORMAT)
     owner_id = get_current_user(session).id
     availability = data.get('availability', 'True') == 'True'
     location = data['location']
@@ -83,7 +111,7 @@ async def create_new_event(request: Request,
                             status_code=status.HTTP_302_FOUND)
 
 
-@router.get("/{event_id}")
+@router.get("/{event_id}", include_in_schema=False)
 async def eventview(request: Request, event_id: int,
                     db: Session = Depends(get_db)) -> Response:
     event, comments, end_format = get_event_data(db, event_id)
@@ -127,8 +155,8 @@ def by_id(db: Session, event_id: int) -> Event:
     return event
 
 
-def is_end_date_before_start_date(start_date: datetime,
-                                  end_date: datetime) -> bool:
+def is_end_date_before_start_date(start_date: dt,
+                                  end_date: dt) -> bool:
     """Check if the start date is earlier than the end date"""
     return start_date > end_date
 
@@ -286,15 +314,15 @@ def delete_event(event_id: int,
     event = by_id(db, event_id)
     participants = get_participants_emails_by_event(db, event_id)
     _delete_event(db, event)
-    if participants and event.start > datetime.now():
+    if participants and event.start > dt.now():
         pass
         # TODO: Send them a cancellation notice
         # if the deletion is successful
     return RedirectResponse(
         url="/calendar", status_code=status.HTTP_200_OK)
 
 
-def is_date_before(start_time: datetime, end_time: datetime) -> bool:
+def is_date_before(start_time: dt, end_time: dt) -> bool:
     """Check if the start_date is smaller then the end_time"""
     try:
         return start_time < end_time
@@ -333,7 +361,7 @@ async def add_comment(request: Request, event_id: int,
         'user_id': get_current_user(session).id,
         'event_id': event_id,
         'content': form['comment'],
-        'time': datetime.now(),
+        'time': dt.now(),
     }
     create_model(session, Comment, **data)
     path = router.url_path_for('view_comments', event_id=event_id)

app/routers/invitation.py

@@ -17,7 +17,7 @@
 )
 
 
-@router.get("/")
+@router.get("/", include_in_schema=False)
 def view_invitations(request: Request, db: Session = Depends(get_db)):
     return templates.TemplateResponse("invitations.html", {
         "request": request,
@@ -29,7 +29,7 @@ def view_invitations(request: Request, db: Session = Depends(get_db)):
     })
 
 
-@router.post("/")
+@router.post("/", include_in_schema=False)
 async def accept_invitations(
         request: Request,
         db: Session = Depends(get_db)
@@ -44,7 +44,8 @@ async def accept_invitations(
     return RedirectResponse(url=url, status_code=HTTP_302_FOUND)
 
 
-def get_all_invitations(session: Session, **param) -> List[Invitation]:
+@router.get("/get_all_invitations")
+def get_all_invitations(session=Depends(get_db), **param) -> List[Invitation]:
     """Returns all invitations filter by param."""
 
     try:
@@ -55,9 +56,9 @@ def get_all_invitations(session: Session, **param) -> List[Invitation]:
         return invitations
 
 
-def get_invitation_by_id(
-        invitation_id: int, session: Session
-) -> Union[Invitation, None]:
+@router.post("/get_invitation_by_id")
+def get_invitation_by_id(invitation_id: int,
+                         session=Depends(get_db)) -> Union[Invitation, None]:
     """Returns a invitation by an id.
     if id does not exist, returns None."""
 

app/routers/profile.py

@@ -165,7 +165,7 @@ def get_image_crop_area(width, height):
 
 
 @router.post("/holidays/update")
-async def update_holidays(
+async def update(
         file: UploadFile = File(...), session=Depends(get_db)):
     icsfile = await file.read()
     holidays = get_holidays_from_file(icsfile.decode(), session)

app/routers/search.py

@@ -7,7 +7,7 @@
 router = APIRouter()
 
 
-@router.get("/search")
+@router.get("/search", include_in_schema=False)
 def search(request: Request):
     # Made up user details until there's a user login system
     current_username = "Chuck Norris"
@@ -18,7 +18,7 @@ def search(request: Request):
     })
 
 
-@router.post("/search")
+@router.post("/search", include_in_schema=False)
 async def show_results(
         request: Request,
         keywords: str = Form(None),

app/routers/telegram.py

@@ -12,7 +12,7 @@
 )
 
 
-@router.post("/")
+@router.post("/", include_in_schema=False)
 async def bot_client(req: dict = Body(...), session=Depends(get_db)):
     chat = Chat(req)
 

app/routers/user.py

@@ -1,10 +1,43 @@
 from typing import List
+from pydantic import BaseModel, Field
 
 from sqlalchemy.exc import SQLAlchemyError
 from sqlalchemy.orm import Session
 
+from app.dependencies import get_db
 from app.database.models import Event, User, UserEvent
 from app.internal.utils import save
+from fastapi import APIRouter, Depends
+
+router = APIRouter(
+    prefix="/user",
+    tags=["user"],
+    responses={404: {"description": "Not found"}},
+)
+
+
+class UserModel(BaseModel):
+    username: str
+    password: str
+    email: str = Field(regex='^\\S+@\\S+\\.\\S+$')
+    language: str
+    language_id: int
+
+
+@router.get("/list")
+async def get_all_users(session=Depends(get_db)):
+    return session.query(User).all()
+
+
+@router.get("/")
+async def get_user(id: int, session=Depends(get_db)):
+    return session.query(User).filter_by(id=id).first()
+
+
+@router.post("/")
+def manually_create_user(user: UserModel, session=Depends(get_db)):
+    create_user(**user.dict(), session=session)
+    return f'User {user.username} successfully created'
 
 
 def create_user(username: str,

app/routers/whatsapp.py

@@ -1,9 +1,9 @@
 from typing import Optional
-from urllib.parse import urlencode
 
 from fastapi import APIRouter
+from urllib.parse import urlencode
 
-router = APIRouter()
+router = APIRouter(tags=["utils"])
 
 
 @router.get("/whatsapp")