python-openstackclient

OSC Command Naming Convention

Registered by Slade Baumann

In OSC when developers are implementing commands from their
specific project, there are no guidelines or convention for them to follow.
This can potentially cause issues where the user is left confused of what a
command actually does if the developer uses a broad command name.

Blueprint information

Status:
Complete
Approver:
None
Priority:
Undefined
Drafter:
Slade Baumann
Direction:
Needs approval
Assignee:
None
Definition:
Obsolete
Series goal:
None
Implementation:
Unknown
Milestone target:
None
Completed by
Dean Troyer

Related branches

Sprints

Whiteboard

The OSC developer docs (http://docs.openstack.org/developer/python-openstackclient/plugins.html) contain a list of all named resources in both the OSC repo and the plugins that choose to list theirs. This is the primary collision detector, as we can not force plugins to adhere to a specific set of rules.

The guidelines for naming resources are not published yet, but have been refined in the last month or two and will be added to our developer docs. In short, resources should be named descriptively enough to be unique.

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.
Edit subscription

Subscribers

No subscribers.