api-ref docs: use correct type for UUIDs

Bug #1583701 reported by Louis Fourie
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Invalid
Undecided
Unassigned

Bug Description

Description
===========
In http://developer.openstack.org/api-ref/compute/
there many cases where the Type is a string instead of a uuid.
For example tenant_id:

Name In Type Description
tenant_id path string The UUID of the tenant in a multi-tenancy cloud.

should be:
Name In Type Description
tenant_id path uuid The UUID of the tenant in a multi-tenancy cloud.

Also:
Name In Type Description
servers body array List of server objects.
id body string The UUID of the server.

Name In Type Description
servers body array List of server objects.
id body uuid The UUID of the server.

Tags: doc
Louis Fourie (lfourie)
summary: - Use correct type for UUIDs
+ api-ref docs: use correct type for UUIDs
Gage Hugo (gagehugo)
Changed in nova:
assignee: nobody → Gage Hugo (gagehugo)
Revision history for this message
Gage Hugo (gagehugo) wrote :

Do we need to change it? It seems like we are wanting a string that contains the UUID for each of those fields.

tags: added: doc
Revision history for this message
Markus Zoeller (markus_z) (mzoeller) wrote :

I guess we're talking about JSON data types [1] in the api-ref. There is no "UUID" type in JSON. Which means, for "tenant_id" (and others) it has to be a JSON data type "string" which is a valid UUID. IOW, I think the api-ref uses the correct type.

References:
[1] http://www.tutorialspoint.com/json/json_data_types.htm

Changed in nova:
status: New → Invalid
assignee: Gage Hugo (gagehugo) → nobody
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.