API v1: all endpoints conform to OpenAPI spec

[jonnyspicer]

Pull Request: API v1 - all endpoints conform to OpenAPI spec

Related Issue

[Asana ref](API v1: all endpoints conform to OpenAPI spec)

Changes Made

• Added zod-prisma-types library and generated zod types from prisma schema
• Added return types to all public-facing APIs
• Updated getQuestion and createQuestion APIs to be compliant with OpenAPI schema
• Bumped API version to v1
• Added debug config for Jest tests
• Refactored utility functions in question_router.tsx into their own files

Testing

Wrote basic unit tests for public-facing APIs, tested all endpoints in Preview with Postman

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
forecast-bot	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 17, 2024 1:25pm

[jonnyspicer]

TODO: try to fix CORS issue from Discord (will do this after initial review)

[adam-binks]

(fyi, useful for changes like these to know if you just moved it to a new file or if there are any changes, it's tricky to notice small changes otherwise)

[adam-binks]

@jonnyspicer This QuestionSchema doesn't include questions.forecasts, question.options, sharedWithLists, comments, tags, etc. The same is true for getQuestionsApiProcedure below, and I think other cases where we use the zod generated schemas as outputs in this file.

This is a moderate issue, because:

1. The schema in the openAPI JSON (as shown on /api-setup doesn't include these properties, which are important (e.g., most usecases of getQuestion for MCQs will want to see the options, and in general people will want to see the forecasts on the question).

2. Additionally, it looks like the Swagger UI only shows parts of the output that conform to the output spec in the web UI when you click execute, so it omits forecasts, options, tags, etc. However, when I test the endpoint using curl I do see the full output.

Do you have a suggestion for how to fix the schema not including prisma-included relations?

I think a temporary fix to allow us to merge this would be to set the schema as .output(z.any()), though I agree that it would be nice to have the actual schema shown in the UI setup page without needing to run an example.