Skip to content

Conversation

@clairep94
Copy link
Collaborator

@clairep94 clairep94 commented Oct 27, 2025

Proof of concept:
Enable devs to look at open api/swagger documentation site on local dev only

  • Follow-on project from the pr05 Typescript Migration
  • Currently only contains user routes while other server items are not yet migrated
Screen.Recording.2025-10-27.at.14.19.26.mov

Changes:

  • Create /common/openapi.yaml with basic formatting + user routes & schemas
  • Add dependencies for serving open api/swagger ui
  • Add /open-api route to local dev only

I have verified that this pull request:

  • has no linting errors (npm run lint)
  • has no test errors (npm run test)
  • is from a uniquely-named feature branch and is up to date with the develop branch.
  • is descriptively named and links to an issue number, i.e. Fixes #123
  • meets the standards outlined in the accessibility guidelines

@clairep94 clairep94 changed the title draft open API for users pr05 Typescript Migration - Followon Project: Swagger / OpenApi documentation & UI for server routes Oct 27, 2025
@clairep94 clairep94 added the pr05 Grant Projects pr05 Grant Projects label Oct 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr05 Grant Projects pr05 Grant Projects

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant