wip: swagger api docs

[mtuchi]

Description

This PR does 2 things,

• Generate a postman collection in priv/static/postman.json
• Generate API docs from @moduledoc, @doc comments in API controllers in priv/static/docs.json [Just few of them for proof of concept]

Validation steps

1. git checkout api-docs
2. mix deps.get
3. To test generating postman collection, run DOC=1 mix test. Once it's done, see priv/static/postman.json
4. To test generating API docs mix compile.docout. Once it's done, see priv/static/docs.json

Additional notes for the reviewer

The original issue request was to port lighting API docs to docs.openfn.org and See OpenFn/docs#715. Although this PR does not generate a Open API spec that can be used in docs.openfn.org, This change is 1 step closer towards that direction.

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to know!):

• Code generation (copilot but not intellisense)
• Learning or fact checking
• Strategy / design
• Optimisation / refactoring
• Translation / spellchecking / doc gen
• Other
• I have not used AI

You can read more details in our Responsible AI Policy

Pre-submission checklist

• I have performed a self-review of my code.
• I have implemented and tested all related authorization policies. (e.g., :owner, :admin, :editor, :viewer)
• I have updated the changelog.
• I have ticked a box in "AI usage" in this PR

[mtuchi]

This is how the API Documentation looks when imported in Postman

[mtuchi]

This is partly AI generated (80% ish). I am not sure what most of these codes mean but it does the job.
This is how i extract @moduledoc and @doc comments from API Controllers like workflows_controller.ex

The goal is to link these docs as description in postman collection requests

[mtuchi]

This 100% AI generated, I am not sure how useful they are. I had to ask help from AI because my formatter kept breaking when i was running mix compile.docout, Mostly the bug was related to data types and empty functions.