[
https://issues.apache.org/jira/browse/CLOUDSTACK-94?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jessica Tomechak updated CLOUDSTACK-94:
---------------------------------------
Fix Version/s: (was: 4.1.0)
Assignee: (was: Jessica Tomechak)
Unassigning and removing the fix target, as there is no reason to prioritize
this API doc improvement bug above any others, and it's not currently being
worked on. We had a volunteer to work on all those API doc bugs at one point,
but they moved on to another task. What needs to happen here is that any valid
API doc bugs from the old bugs.cloudstack.org bugbase should be migrated to
this bugbase, with a common label like "apidoc," and no assignee or fix target.
> API command, listIsos documentation clarity
> -------------------------------------------
>
> Key: CLOUDSTACK-94
> URL: https://issues.apache.org/jira/browse/CLOUDSTACK-94
> Project: CloudStack
> Issue Type: Bug
> Security Level: Public(Anyone can view this level - this is the
> default.)
> Components: Doc
> Affects Versions: pre-4.0.0
> Environment: This document:
> http://download.cloud.com/releases/3.0.0/api_3.0.0/root_admin/listIsos.html
> Reporter: Jesse Callaway
> Priority: Minor
> Labels: api, documentation
> Original Estimate: 20m
> Remaining Estimate: 20m
>
> Bug description:
> The isofilter parameter copy does not list all valid arguments. Where they
> are listed, it is confusing to read.
> In particular, the "all" argument should be listed.
> Related bug:
> The description of the "id" parameter is incorrect. It does not list all
> iso's by id. It is the id of the ISO to be listed. The word _all_ in this
> context is not only confusing, but is incorrect, since a uuid is universally
> unique.
> Further consideration:
> "isofilter=all" should be the default behavior. However, that is not a
> documentation bug, but a usability preference.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
