Skip to content

2692 add api docs#3334

Open
Tony-Villa wants to merge 6 commits into
developfrom
2692-api-docs
Open

2692 add api docs#3334
Tony-Villa wants to merge 6 commits into
developfrom
2692-api-docs

Conversation

@Tony-Villa

Copy link
Copy Markdown
Member

What changes did you make?

  • Added swagger api documentation

Why did you make the changes (we will use this info to test)?

  • This gives any backend or full stack engineer a ui to be able to see all the current endpoints.

Screenshots of Proposed Changes Of The Website (if any, please do not screen shot code changes)

Visuals before changes are applied

N/A

Visuals after changes are applied Screenshot 2026-06-23 at 12 03 44 AM

Dev Notes

  • Any new endpoints will have to be added to the schema in order to keep this up to date.
  • To be extra safe at least for now you have to be logged in as an admin to be able to access either of these urls
  • This is a fairly long PR, but most of the lines added are JSdoc or openAPI schemas.
  • Some of the schemas I generated with ai instead of hunting down the exact endpoint definitions, but they looked good to me, we can do a pass with someone who knows the api endpoints better than I do and I'll be happy to fix any errors.

@Tony-Villa
Tony-Villa requested a review from entrotech June 23, 2026 07:07
Comment thread server/server.js
if (process.env.ENABLE_API_DOCS === "true") {
app.get(
"/api-docs.json",
jwtSession.validateRoles(["isAdmin"]),

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think these pages need to be rate limited since it'll be only used internally, but I'll let @entrotech make the final decision here

Comment thread server/server.js
);
app.use(
"/api-docs",
jwtSession.validateRoles(["isAdmin"]),

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think these pages need to be rate limited since it'll be only used internally, but I'll let @entrotech make the final decision here

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.

Dev: Create Documentation for the APIs

2 participants