openstack-api-site

API references don't have post condition information

Bug #1390528 reported by Masahito Muroi
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-api-site
Fix Released
High
Masahito Muroi
openstack-api-site liberty

Bug Description

Most of api references don't have post-conditions which are resulted by execution of API call.

A lot of API in OpenStack are executed asyncronus.
All components execute asyncronuslly its API.
User need to check status or some infomations to confirm if the execution is success or not.
But most of references don't have a way to confirm the result of execution.

For example:
 If execution of creates server API (http://developer.openstack.org/api-ref-compute-v2.html#compute_servers) success the new server's status becomes ACTIVE.
 If the execution fails the new server's status becomes ERROR.

Tags: api-site
Masahito Muroi (muroi-masahito)
tags: added: api-site
Tom Fifield (fifieldt)
affects: openstack-manuals → openstack-api-site
Masahito Muroi (muroi-masahito)
Changed in openstack-api-site:
assignee: nobody → Masahito Muroi (muroi-masahito)
OpenStack Infra (hudson-openstack)
Changed in openstack-api-site:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to api-site (master)

Reviewed: https://review.openstack.org/141087
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=77cd46a24121bf0b49095ecbcf7bca384f57a1c0
Submitter: Jenkins
Branch: master

commit 77cd46a24121bf0b49095ecbcf7bca384f57a1c0
Author: Masahito Muroi <email address hidden>
Date: Thu Dec 11 12:35:36 2014 +0000

    Add pre and post condition in volume section

    Add pre and post conditions to volume section in volume API.

    Partial-bug: #1390523
    Partial-bug: #1390528
    Change-Id: I40a94119e2bb5caa3200d854f7eab4561c932348

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/145185

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to api-site (master)

Reviewed: https://review.openstack.org/145185
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=8f56a9a01c4c9f71aa3ea7c20fcf72e7c6e4536c
Submitter: Jenkins
Branch: master

commit 8f56a9a01c4c9f71aa3ea7c20fcf72e7c6e4536c
Author: Masahito Muroi <email address hidden>
Date: Tue Jan 6 09:18:11 2015 +0000

    Add conditions and troubleshoot in Images and Image data section

    Adding preconditions, postconditions and troubleshooting
    information in Image and Image data section.

    Partial-bug: #1390523
    Partial-bug: #1390528

    Change-Id: I3bb83ddd5fee06f0be7bb74d20a21a8aa0a8360d

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/147486

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to api-site (master)

Reviewed: https://review.openstack.org/147486
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=729c87307407ca9ba3fc54b3d7a90be36b1aa4ea
Submitter: Jenkins
Branch: master

commit 729c87307407ca9ba3fc54b3d7a90be36b1aa4ea
Author: Masahito Muroi <email address hidden>
Date: Thu Jan 15 12:13:45 2015 +0000

    Add conditions and troubleshoot in Members section

    Add preconditions, synchronous postconditions and troubleshooting
    to Members section of Image Service v2.

    Change-Id: Ic24222927a04de54b697a937bf9080869442e33a
    Partial-bug: #1390523
    Partial-bug: #1390528

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/153970

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to api-site (master)

Reviewed: https://review.openstack.org/149227
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=72b9480fff6de4a1535bfdb6bd45653e7c95c528
Submitter: Jenkins
Branch: master

commit 72b9480fff6de4a1535bfdb6bd45653e7c95c528
Author: Masahito Muroi <email address hidden>
Date: Thu Jan 22 11:55:19 2015 +0000

    Add conditions and troubleshoot in Servers section

    Adding preconditions, postconditions and troubleshooting
    information in Servers section.

    Change-Id: I0cc1f1cf8ccbfb5eb376a5d5fa2226200964b8b0
    Partial-bug: #1390523
    Partial-bug: #1390528

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/155718
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=237dc86495283a78bdbd1349f8ea56208851165b
Submitter: Jenkins
Branch: master

commit 237dc86495283a78bdbd1349f8ea56208851165b
Author: Masahito Muroi <email address hidden>
Date: Fri Feb 13 11:28:22 2015 +0000

    Add conditions and troubleshoot in Shelve and Start section

    Adding preconditions, postconditions and troubleshooting
    information in Shelve and Startsection.

    Change-Id: I814fb2e444be5a82465771592f507cf08114dfc4
    Partial-bug: #1390523
    Partial-bug: #1390528

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/160630

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to api-site (master)

Reviewed: https://review.openstack.org/153970
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=13eb529a2172829a3aaa17c213d57bc25840ff90
Submitter: Jenkins
Branch: master

commit 13eb529a2172829a3aaa17c213d57bc25840ff90
Author: Masahito Muroi <email address hidden>
Date: Fri Feb 6 09:12:33 2015 +0000

    Add conditions and troubleshoot in Flavors and Action section

    Adding preconditions, postconditions and troubleshooting
    information in Flavors and Action section.

    Change-Id: I91d584638797ca510757062ba239705ee1d27dff
    Partial-bug: #1390523
    Partial-bug: #1390528

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

commit f10da2b1097ba97dec3c106cb3f2de9888fbbe32
Author: Masahito Muroi <email address hidden>
Date: Mon Feb 16 11:38:07 2015 +0000

    Add conditions and troubleshoot in Volume Attachment section

    Add preconditions, synchronous postconditions and troubleshooting
    to Volume Attachments section of Compute API v2.

    Change-Id: I1aa460457c7f641fef54781a77ea6360b7caa07a
    Partial-bug: #1390523
    Partial-bug: #1390528

Diane Fleming (diane-fleming)
Changed in openstack-api-site:
importance: Undecided → High
milestone: none → liberty
Revision history for this message
Atsushi SAKAI (sakaia) wrote :

Muroi-san

I want to close this ticket for api-site.
OR you need to keep please change project like other project (nova etc).

Revision history for this message
Masahito Muroi (muroi-masahito) wrote :

please close this.

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

A lot got done here, closing.

Changed in openstack-api-site:
status: In Progress → Fix Released
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.