openstackdocstheme

API references don't have parameter's range

Bug #1390531 reported by Masahito Muroi
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstackdocstheme
Confirmed
Medium
Unassigned

Bug Description

Parameters in api references rack range of the parameters.
All parameters in current refernces only has types of the param, but parameters usually have some limitations for thier format.

For example:
 length of server's name specified in creates server API has to range 1-255

Tags: api-site
Masahito Muroi (muroi-masahito)
tags: added: api-site
Tom Fifield (fifieldt)
affects: openstack-manuals → openstack-api-site
Revision history for this message
Anne Gentle (annegentle) wrote :

Would love to see these documented, thanks. Let me know if you need help implementing.

Changed in openstack-api-site:
status: New → Confirmed
importance: Undecided → Medium
Revision history for this message
Masahito Muroi (muroi-masahito) wrote :

I'm wondering where I document these in the references. To append a new column at parameter table, updating maven-plugin is needed. However, you said the plugin isn't updated frequently.

Revision history for this message
Anne Gentle (annegentle) wrote :

We are moving to Swagger (Open API) instead of WADL. Apologies for the delayed response. So ideally the swagger files would contain this info:

http://developer.openstack.org/draft/swagger

However, we'll have to complete the migration for that task to be completed.

Changed in openstack-api-site:
status: Confirmed → Triaged
Revision history for this message
Anne Gentle (annegentle) wrote :

This could go into the RST + YAML parameters tables somehow... let's track in openstack-doc-tools.

Changed in openstack-doc-tools:
status: New → Confirmed
no longer affects: openstack-api-site
Changed in openstack-doc-tools:
importance: Undecided → Medium
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

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