Normal response codes of "Suspend stack" should be 200

[Yutaro Iwakiri]

In http://developer.openstack.org/api-ref-orchestration-v1.html#stack_action_suspend,
the normal response code for "Suspend stack" is described 201.

However, heat returns 200.

But, it should probably be 202 in both!

[Yutaro Iwakiri (iwakiri-yutaro)]

CLI debug log
----
stack@vagrant-ubuntu-trusty-64:~$ heat --debug action-suspend stack

...

DEBUG (session) REQ: curl -g -i -X POST http://xxx.xxx.xxx.xxx:8004/v1/7e9157722a414d69b472d1b176478789/stacks/stack/actions -H "Accept: application/json" -H "User-Agent: python-heatclient" -H "X-Region-Name: RegionOne" -H "X-Auth-Token: {SHA1}b0b670a34442188f567f6ab6e2a336a9a3803f4f" -H "Content-Type: application/json" -H "X-Auth-Url: http://xxx.xxx.xxx.xxx:5000/v2.0" -d '{"suspend": null}'

...

DEBUG (connectionpool) "POST /v1/7e9157722a414d69b472d1b176478789/stacks/stack/19380f52-4f41-4701-8054-5fae1d8e8b4d/actions HTTP/1.1" 200 4
DEBUG (session) RESP: [200] date: Wed, 22 Jul 2015 03:36:04 GMT connection: keep-alive content-type: application/json; charset=UTF-8 content-length: 4 x-openstack-request-id: req-01557cb0-37f5-4fb8-b388-edfb56cabd01
RESP BODY: null

...
----

[OpenStack Infra (hudson-openstack)]

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

[Anne Gentle (annegentle)]

However, for an asynchronous response, the heat code should make sure it follows the API working group guideline here: http://specs.openstack.org/openstack/api-wg/guidelines/http.html#xx-success-codes

I believe that suspend stack should return a URI of a status resource and also should return a 202 Accepted. Please log a bug against heat itself rather than the docs, and do not work on a doc change until the doc bug is triaged and set to Confirmed.

[Yutaro Iwakiri (iwakiri-yutaro)]

I agree with you that suspend stack should return a URI and 202 Accepted.

[Tom Fifield (fifieldt)]

I updated this bug to be in the heat tracker

[Angus Salkeld (asalkeld)]

I agree with this in principle, but wonder if we can pull this off without upsetting our users.

I'll see what I can do...

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/214032

[Angus Salkeld (asalkeld)]

Consensus seems to be that we change this in the next major API version. Doing this now would cause havoc to REST clients.

[OpenStack Infra (hudson-openstack)]

Change abandoned by Angus Salkeld (<email address hidden>) on branch: master
Review: https://review.openstack.org/211454

[OpenStack Infra (hudson-openstack)]

Change abandoned by Angus Salkeld (<email address hidden>) on branch: master
Review: https://review.openstack.org/214032

[Tom Fifield (fifieldt)]

Hi,

any update on the status of this bug?

[Atsushi SAKAI (sakaia)]

Andras

Would you notice me? When is the planned date for the heat next major API version?

> Consensus seems to be that we change this in the next major API version.

[Anne Gentle (annegentle)]

Sounds like the docs should be revised to indicate what it really is.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/205346
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=75d5026333b26c880bdabc6efb6bab5ff459037e
Submitter: Jenkins
Branch: master

commit 75d5026333b26c880bdabc6efb6bab5ff459037e
Author: Yutaro Iwakiri <email address hidden>
Date: Fri Jul 24 10:56:37 2015 +0900

    Fix a wrong response code in Heat API Reference

    Fix the response code for "Suspend stack" in Heat API Reference
    from 201 to 200.

    Change-Id: I8dbef4b09a61efa4e0b36006a89eed53cdcf0e9d
    Closes-Bug: #1477109