Do we have any way to generate documentation for our policies, like we do with OpenAPI?

[cleitonfelipe]

Hello everybody, I would like to know if there is any tool or way to generate documentation for the policies we create with OPA/Rego, for example, as is done with OpenAPI, to generate endpoint documentation. If there is, could you indicate it, and if not, how do you document your policies?

[anderseknert]

Hi there!

It's been a while since anyone touched them, but OTOH, OPA's REST API hasn't really changed much since then: https://github.com/open-policy-agent/contrib/tree/main/open_api

That's only documenting the REST API endpoints though. I'm not aware of a tool that generates something like JSON schemas for the possible decisions your policy may provide. I'd love to see someone do that though!

[cleitonfelipe]

Hi @anderseknert,
Okay, I got it. I'll take a look at this OPA Rest API. I think it can help my development team. Regarding the policy documentation, I'll continue analyzing the possibilities, and if I manage to implement something, I'll come up with the idea here for you, too, because I believe it can help everyone.

Thank you so much!!!

[anderseknert]

Great!