From 6066ca75a0a0c2814b001e9ef56b56c5db53dac4 Mon Sep 17 00:00:00 2001 From: maduka paul <139281123+iam-madukapaul@users.noreply.github.com> Date: Tue, 8 Apr 2025 14:13:33 +0100 Subject: [PATCH] Updated swagger UI for better readability --- app/app/settings.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/app/app/settings.py b/app/app/settings.py index 1f6c3ab8f7..0afb719e10 100644 --- a/app/app/settings.py +++ b/app/app/settings.py @@ -149,6 +149,16 @@ 'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema', } +# Updated the Swagger UI title & description for better readability and clarity. SPECTACULAR_SETTINGS = { + 'TITLE': 'RECIPE-APP API', + 'DESCRIPTION': 'This API powers a recipe management application. \ + It supports Docker-based setup, GitHub Actions for CI/CD, and \ + provides endpoints for managing users, tags, ingredients, \ + and recipes. The API includes features like image uploads, \ + filtering, and deployment capabilities, all backed by \ + comprehensive unit testing.', + 'VERSION': '1.0.0', + 'SERVE_INCLUDE_SCHEMA': False, 'COMPONENT_SPLIT_REQUEST': True, }