Need something to denote admin calls in docs

Bug #1419591 reported by Brian Curtin
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack SDK
Confirmed
Medium
Unassigned

Bug Description

In Volume V2, calls like create_type and delete_type require admin privileges. Right now they're denoted in a ".. note" admonition near the top of the docstring (along with being sorted to the bottom of the listing), but something slightly stronger and more specific should be used for them. After looking around for a bit, a custom sphinx extension may be the answer.

Revision history for this message
Terry Howe (thowe-g) wrote :

I just wanted to note that the identity stuff uses a special service:

https://github.com/stackforge/python-openstacksdk/blob/master/openstack/identity/v2/tenant.py#L21

Changed in python-openstacksdk:
status: New → Confirmed
milestone: none → 1.0
tags: added: documentation
Revision history for this message
Brian Curtin (brian.curtin) wrote :

I don't think we're going to get to any sort of fancy feature here for 1.0 so taking it out of the milestone. We should of course still document admin things in some way, probably like they are in block_store at least for the time being.

Changed in python-openstacksdk:
milestone: 1.0 → none
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.