Lack of documentation for role inheritance

[Amelia Cordwell]

- [ ] This doc is inaccurate in this way: ______
- [X] This is a doc addition request.
- [ ] I have a fix to the document that I can paste below including example: input and output.

It can be seen in code and through running tests on the API that the scope of role assignments can be filtered by inheritance scope. This is documented and included in the client but not on the API reference.

Relevant line in client:
https://github.com/openstack/python-keystoneclient/blob/master/keystoneclient/v3/role_assignments.py#L70

-----------------------------------
Release: v3.8 on 'Thu Dec 7 13:25:34 2017, commit cfbc2aa'
SHA:
Source: https://git.openstack.org/cgit/openstack/keystone/tree/api-ref/source/v3/index.rst
URL: https://developer.openstack.org/api-ref/identity/v3/index.html

[wangxiyuan (wangxiyuan)]

It is included here:
https://developer.openstack.org/api-ref/identity/v3/index.html#list-role-assignments

I guess you mean here:
https://developer.openstack.org/api-ref/identity/v3/index.html#id318

I think the first one is duplicated. And the second one missed "scope.OS-INHERIT:inherited_to"

[Amelia Cordwell (ameliacordwell)]

That makes sense I was only looking at the one under roles, and missed the detail down on the other one.

[Lance Bragstad (lbragstad)]

Based on the first comment, is there anything to clarify in the documentation for this bug?

[Lance Bragstad (lbragstad)]

I suppose we could add a section to the administrator guides [0] that explains role inheritance and how it works. I don't see any documentation describing inheritance outside of the one query parameter in the API reference.

[0] https://docs.openstack.org/keystone/latest/#administrator-guides

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/741085

[OpenStack Infra (hudson-openstack)]

Change abandoned by "Gage Hugo <email address hidden>" on branch: master
Review: https://review.opendev.org/c/openstack/keystone/+/741085
Reason: Abandoning since there hasn't been any recent activity, if anyone wants to continue this work, please feel free to restore this or create a new change.