Skip to content
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.

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

Notes on adding a new API endpoint #206

Open
eatyourgreens opened this issue Nov 20, 2024 · 0 comments
Open

Notes on adding a new API endpoint #206

eatyourgreens opened this issue Nov 20, 2024 · 0 comments

Comments

@eatyourgreens
Copy link
Contributor

eatyourgreens commented Nov 20, 2024

  1. Add new columns to the running database.
  2. Make corresponding changes to backend/db/models.py.
  3. Add a new endpoint in backend/app/routers.
  4. If necessary, update backend/schemas.py with a description of the API response.
  5. Build and run the backend. Check that the OpenAPI schema is being served on http://localhost:8888/openapi.json.
  6. Run generate-client in the frontend, to rebuild the OpenAPI client.
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

No branches or pull requests

1 participant