Exdocs for Ash rest api
Hi
Is there a recommended way to document the JsonApi in Ash. Should we use the ex_docs, where the end points are declared. Or are there any other recommendations.
-Sriky
3 Replies
So we’re close to some open api integrations which should be pretty slick: https://github.com/ash-project/ash_json_api/pull/68
GitHub
Feat/open api spex helpers by mohammedzeglam-pg · Pull Request #68 ...
Contributor checklist
Bug fixes include regression tests
Features include unit/acceptance tests
But we aren’t quite there yet unfortunately
And I haven’t had time to revisit it.
Barring something like that, you’d need to hand document it and/or generate docs from the “json schema” that we provide
Which can be accessed at the /schema route of your api
Thank you so much. This helps