Improve documentation of what data is used in checks
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
oslo.policy |
Fix Released
|
High
|
Raildo Mascena de Sousa Filho |
Bug Description
The examples in the documentation[0] use a number of "magic" values such as project_id and user_id, but don't discuss where they come from or how someone writing a policy would find out all of the values available to them. Further, there is little/no discussion of how to determine what data is available in the target object[1]. I've included a very brief mention of that in [2], but I think it would be good to make it a more prominent part of the docs as it is very important for anyone writing their own policy rules.
0: https:/
1: This is further confused by the fact that "target" is an overloaded term. The docs use it to refer to the name of the rule, while the code uses it to refer to the object being operated on by the API call. We should also address that.
2: https:/
Fix proposed to branch: master /review. opendev. org/743318
Review: https:/