open_api_spex spec declaration with ash_json_api

generated Open API spec has either some basic or nil descriptions, summaries, etc. open_api_spex documentation suggests using macros like operation/2 to describe my API. i've searched ash_json_api docs for some information but to no success. is there a way to do describe my domains' / resources' routes like so in ash_json_api?
Solution:
You add descriptions to the attributes and actions etc. directly
Jump to solution
5 Replies
Solution
ZachDaniel
ZachDaniel•3d ago
You add descriptions to the attributes and actions etc. directly
ZachDaniel
ZachDaniel•3d ago
read :read do
description "..."
end
read :read do
description "..."
end
Most things support descriptions
kira🌺
kira🌺OP•2d ago
understood, thanks! the resulting spec though is a bit strange... it has doubled parameters on routes with arguments
No description
ZachDaniel
ZachDaniel•2d ago
That looks like a bug to me 🙂 Please open a bug, with a reproduction if possible 🙂
kira🌺
kira🌺OP•2d ago
sure thing! i will file an issue a bit later i've opened an issue at ash_json_api

Did you find this page helpful?