Skip to content

Updated the Swagger UI title & description for better readability and clarity. #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
iam-madukapaul wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updated the Swagger UI title & description for better readability and clarity. #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions app/app/settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
}