Skip to content

141 swagger setup#157

Open
chnnick wants to merge 5 commits into
mainfrom
141-swagger-setup
Open

141 swagger setup#157
chnnick wants to merge 5 commits into
mainfrom
141-swagger-setup

Conversation

@chnnick
Copy link
Copy Markdown

@chnnick chnnick commented May 12, 2026

ℹ️ Issue

Closes #141

📝 Description

Write a short summary of what you added. Why is it important? Any member of C4C should be able to read this and understand your contribution -- not just your team members.

Briefly list the changes made to the code:

  1. Put in template initialization of Swagger UI that only activates if a SWAGGER_ENABLED value in the .env file is set to true, logger also sends out a message saying that Swagger is enabled
  2. Put the SWAGGER_ENABLED value in the .env file with directions for only activating in local/staging environments
  3. Added documentation in README.md for TL to continue using Swagger throughout the development of the application

✔️ Verification

What steps did you take to verify your changes work? These should be clear enough for someone to be able to clone the branch and follow the steps themselves.

No SWAGGER_ENABLED variable in .env or SWAGGER_ENABLED=false
Screenshot 2026-05-11 at 6 49 37 PM
Screenshot 2026-05-11 at 6 47 43 PM

SWAGGER_ENABLED=true
Screenshot 2026-05-11 at 6 49 25 PM (Logger has a message saying Swagger is enabled)
Screenshot 2026-05-11 at 6 50 20 PM
Screenshot 2026-05-11 at 6 50 07 PM

Provide screenshots of any new components, styling changes, or pages.

🏕️ (Optional) Future Work / Notes

@chnnick chnnick requested a review from maxn990 as a code owner May 12, 2026 01:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Swagger Setup

1 participant