opa icon indicating copy to clipboard operation
opa copied to clipboard

Write comprehensive docs section on annotations

Open tsandall opened this issue 3 years ago • 3 comments

With the schema support expanding on OPA/Rego to include annotations on rules, it would be useful to include a docs page on annotations. Perhaps it could exist on the existing Policy Language page. The docs should include the current sections on overriding as well as descriptions of the various fields with examples. We should pull in the example docs from @aavarghese's external repo as well.

tsandall avatar Apr 22 '21 22:04 tsandall

related #3398

tsandall avatar Apr 22 '21 22:04 tsandall

Moving this back to TODO. This will be easier to complete when we have other annotation types (e.g., rule metadata, entrypoints, etc.)

tsandall avatar Jul 08 '21 00:07 tsandall

@tsandall is this covered by our current documentation of metadata annotations and schemas?

anderseknert avatar Jun 07 '22 15:06 anderseknert

OPA docs has a page on Annotations. It can be found here.

ashutosh-narkar avatar Feb 13 '23 22:02 ashutosh-narkar