initial openapi file #481
initial openapi file #481
Conversation
|
👷 Deploy request for upswyng accepted. 🔨 Explore the source changes: 9fa4b74 🔍 Inspect the deploy log: https://app.netlify.com/sites/upswyng/deploys/60f8ce28a61dfa00076f1d18 |
I'll update this PR and migrate changes to the README and support for waiting for docker to be ready into their own branch to keep things clean |
|
heavily updated -- reverted everything not the docs file docs file has complete or stubs for nearly every endpoint |
| @@ -4,7 +4,6 @@ import { | |||
| TLegacyResource, | |||
There was a problem hiding this comment.
removed unused import & fix typo
| @@ -6,7 +6,7 @@ import mq from "../../../worker/mq"; | |||
| async function makeTestJob(req, res, _next, user: TUser) { | |||
| const jobName = getName("-"); | |||
|
|
|||
| // Command can be like /testjob 35, where the second part is the delay to apply to the job | |||
| // Command can be like /test-job 35, where the second part is the delay to apply to the job | |||
There was a problem hiding this comment.
the actual command includes the -
| @@ -12,6 +13,19 @@ export async function get(req, res, _next) { | |||
| "Content-Type": "application/json", | |||
| }); | |||
There was a problem hiding this comment.
this matches the singleton and other draft responses
There was a problem hiding this comment.
Wow, this looks like a lot of work! I think this will be in a good place once we can address Jacob's feedback. As for generating schemas via type definitions - a quick search did not find a good tool, but one may exist. We also could just define the return schema by referencing the type when appropriate? Like Code: 200, Description: TResource[] & { totalFound: 800 } etc.... This would add an extra step for an engineer to need to go reference the type - but I almost prefer that over having two sources of truth?
|
updated based on comments from @jacobvenable thank you for the detailed review in terms of keeping them up to date -- sadly there isn't much out of the box available as @jollyjerr found there's a lot that could be done with a custom script -- if that's a priority I'll tackle that next vs the default sorting |
Yep that works for me 👍 One tool I had briefly looked into was tsoa. Seems nifty but is an extra layer of maintenance for our endpoints. |
This PR closes #257
What does this PR do?
Creates OpenAPI doc & some grooming
How does this PR make you feel?
![good]