[
https://issues.apache.org/jira/browse/CLOUDSTACK-94?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13457496#comment-13457496
]
Jessica Tomechak commented on CLOUDSTACK-94:
--------------------------------------------
Not likely to be addressed by me in 4.0 timeframe. This is just one of about 30
requests for API doc improvements (see the old bugs.cloudstack.org), all of
which need to be addressed by some writer who is not currently on the writing
team. Volunteers?
> API command, listIsos documentation clarity
> -------------------------------------------
>
> Key: CLOUDSTACK-94
> URL: https://issues.apache.org/jira/browse/CLOUDSTACK-94
> Project: CloudStack
> Issue Type: Bug
> 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
> Assignee: Jessica Tomechak
> Priority: Minor
> Labels: api, documentation
> Fix For: pre-4.0.0
>
> 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