openstack team mailing list archive

[Dan Wendlandt <dan@xxxxxxxxxx>]

Hi Gary, this is an example of when I wish openstack APIs had a
"style-guide" to try to ensure some consistency across projects.

For those new to the conversation, the original topic of discussion is
whether "names" for API objects should be forced to be unique (presumably
within a tenant?) or allowed to be duplicated.  The general feeling from
the meeting was that since UUIDs are unique, the API itself would not
enforce name uniqueness.  That also led to the point that names should then
be optional, since they are really for informational/display purposes only.


Personally, I tend to think that "description" tends to imply a sentence
"private network for tenant1", rather than a simple name "tenant1-net".
 There's also the fact that other openstack services like nova and glance
use the term "name" with the similar (I believe) model that a name need not
be unique.

Would be curious to hear what others think.  The only thing I'm quite sure
about is that there would be value in creating some notion of "openstack
API consistency best practices" to give a more cohesive feel to APIs across
different projects in the openstack family.

Dan


On Mon, Jul 16, 2012 at 10:05 PM, Gary Kotton <gkotton@xxxxxxxxxx> wrote:

> Hi,
> If the name is intended to be a description then how about the idea of
> calling the field "description" instead. This is far more descriptive and
> does not lend the user to think that this should be unique.
> Thanks
> Gary
>
> ______________________________**_________________
> Mailing list: https://launchpad.net/~**openstack<https://launchpad.net/~openstack>
> Post to     : openstack@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~**openstack<https://launchpad.net/~openstack>
> More help   : https://help.launchpad.net/**ListHelp<https://help.launchpad.net/ListHelp>
>



-- 
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Dan Wendlandt
Nicira, Inc: www.nicira.com
twitter: danwendlandt
~~~~~~~~~~~~~~~~~~~~~~~~~~~