[api-ref]Orchestration create stack post body incorrectly documented

Bug #1407630 reported by Steven Hardy
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Heat
Fix Released
Wishlist
Qiming Teng

Bug Description

http://developer.openstack.org/api-ref-orchestration-v1.html#stacks

The POST body arguments are incorrectly titled "Response parameters" which could be confusing to users.

Tags: api-ref heat
Revision history for this message
Anne Gentle (annegentle) wrote :

Steve, is it for POST/v1/​{tenant_id}​/stacks only?

Changed in openstack-api-site:
status: New → Incomplete
Revision history for this message
Qiming Teng (tengqim) wrote :

Anne, there are other inaccuracies as well. Will report bugs and propose fixes later on.

Changed in openstack-api-site:
status: Incomplete → Confirmed
assignee: nobody → Qiming Teng (tengqim)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to api-site (master)

Fix proposed to branch: master
Review: https://review.openstack.org/146020

Changed in openstack-api-site:
status: Confirmed → In Progress
Revision history for this message
Steven Hardy (shardy) wrote : Re: Orchestration create stack post body incorrectly documented

Anne, I think it's only POST/v1/​{tenant_id}​/stacks which has the "Response parameters" error.

I'm sure there are other innacuracies too, as mentioned by Qiming, but we can report those independently, the scope of this bug is just fixing the POST for create.

Anne Gentle (annegentle)
Changed in openstack-api-site:
importance: Undecided → Wishlist
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on api-site (master)

Change abandoned by Qiming Teng (<email address hidden>) on branch: master
Review: https://review.openstack.org/146020
Reason: this is frustrating, won't do it this way.

Revision history for this message
Atsushi SAKAI (sakaia) wrote : Re: Orchestration create stack post body incorrectly documented

From seeing #1 and #2, it needs a description which argument has problem.
Also Currently no patch is submitted yet.

tags: added: heat
Changed in openstack-api-site:
status: In Progress → Incomplete
Revision history for this message
Steven Hardy (shardy) wrote :

> From seeing #1 and #2, it needs a description which argument has problem.

I already provided that in comment #4, it's all of the "Response parameters" fields, which aren't responses at all, but really part of the POST body, e.g part of the request.

http://developer.openstack.org/api-ref-orchestration-v1.html#stack_create

> Also Currently no patch is submitted yet.

That is not a reason to mark a bug incomplete :\

Revision history for this message
Steven Hardy (shardy) wrote :

So, looking at the patch (which has been submitted, many months ago):

https://review.openstack.org/#/c/146020/

The reason this is stalled, is because of problems with clouddocs-maven-plugin, Anne and Qiming had a discussion in the review which resulted in the determination that there weren't resources right now to fix clouddocs-maven-plugin.

So, either this remains open and we wait for that to change, someone steps up to fix clouddocs-maven-plugin, or we look again at the implementation and look for a workaround to the issues discussed there.

Or, this could be closed wont fix I guess, which would be disappointing given that this presumably is a common issue for all POST body documentation (otherwise there'd be a pattern we could look at and reuse to solve the problem).

Changed in openstack-api-site:
status: Incomplete → New
Atsushi SAKAI (sakaia)
Changed in openstack-api-site:
status: New → Confirmed
Atsushi SAKAI (sakaia)
affects: openstack-api-site → heat
summary: - Orchestration create stack post body incorrectly documented
+ [api-ref]Orchestration create stack post body incorrectly documented
tags: added: api-ref
Thomas Herve (therve)
Changed in heat:
status: Confirmed → Fix Released
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.