Incomplete API Documentation

[tlawrie]

Describe the bug For v4 of Flow, the REST API has a full swagger API spec that we can generate documentation from.

We would need the documentation to be generated to be in Markdown for the use in the Docs site.

Considerations/Options

1. Is there a way to generate API docs in MD from a Swagger spec
2. We manually add it in

Context The Docs site is being converted to a Remix based site.

[tlawrie]

Have put the call out for someone to help, either through broader community or extended work colleagues.

[kanz-1805]

Hi @tlawrie , I was looking into the API documentation requirement. If it is REST API, I'd love to help you with the documentation. Thanks!

[tlawrie]

Hi @kanz-1805 it is REST API. I have updated the description to better match the required task. Let me know if you would like to work on it.

[kanz-1805]

Hey @tlawrie, I'd like to take up this.

[tlawrie]

@kanz-1805 fantastic.

So we have now moved the docs to the docs repo which are then rendered via the website. It can be viewed at https://useboomerang/docs

Ultimate aim is finding a way to add API docs through rendered markdown (or swagger converted to Markdown and then rendered) - allowing the Markdown to then be rendered like the rest of the docs, could have a pre-workflow that runs whatever is needed.

Format would be similar to

• https://usefathom.com/api#intro
• https://vercel.com/docs/rest-api/endpoints/access-groups#creates-an-access-group

[Ashleycodesseo]

hi @tlawrie I saw that this documentation issue was still open. If you still need help with your REST API documentation please let me know how I can help! thanks