Cinder

api documentation missing for many actions

Bug #1607539 reported by Matthew Edmonds
12
This bug affects 2 people
Affects Status Importance Assigned to Milestone
Cinder
In Progress
Medium
Matt Riedemann

Bug Description

There is no API documentation for any of the snapshots/{snapshot_id}/action calls (os-update_snapshot_status defined in api/contrib/snapshot_actions.py, os-force_delete and os-reset_status defined in api/contrib/admin_actions.py). Documentation for other actions is spotty... e.g. os-force_delete is documented for backup/{backup_id}/action but not os-reset_status, and while many actions are documented for volumes/{volume_id}/action, many more such as os-migrate_volume are not.

Justin A Wilson (justin-wilson)
Changed in cinder:
assignee: nobody → Justin A Wilson (justin-wilson)
Kendall Nelson (kjnelson)
Changed in cinder:
status: New → Invalid
Revision history for this message
Matthew Edmonds (edmondsw) wrote :

Why was this marked invalid with no explanation? Still looks like a problem to me...

Changed in cinder:
status: Invalid → New
Kendall Nelson (kjnelson)
tags: added: api-ref
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to cinder (master)

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

Changed in cinder:
assignee: Justin A Wilson (justin-wilson) → luqitao (qtlu)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to cinder (master)

Reviewed: https://review.openstack.org/470232
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=e9acdab68795e9e4716aabb2d8035fbb12062765
Submitter: Jenkins
Branch: master

commit e9acdab68795e9e4716aabb2d8035fbb12062765
Author: luqitao <email address hidden>
Date: Fri Jun 2 05:08:00 2017 -0400

    [api-ref]Adds API documentation for 'os-set_bootable' action

    There is no document about update a volume's bootable status,
    so add the missing doc.

    Change-Id: If706205678cfd7a803e2d7733bec34494b47fc66
    Partial-Bug: #1607539

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to cinder (master)

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

Changed in cinder:
assignee: luqitao (qtlu) → lihaijing (lihaijing)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to cinder (master)

Reviewed: https://review.openstack.org/477429
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=57330a12a851a72b781fb48ad23bfda894d051b8
Submitter: Jenkins
Branch: master

commit 57330a12a851a72b781fb48ad23bfda894d051b8
Author: lihaijing <email address hidden>
Date: Mon Jun 26 15:18:09 2017 +0800

    Api-ref: add documentation for v2/v3 backup 'os-reset_status' action

    There is no document about v2/v3 backup 'os-reset_status' action. This
    action explicitly updates the backup state. So add the missing content.

    Change-Id: Ie0dd2b4e184d09e957c4ba296544f5019d05fda3
    Partial-Bug: #1607539

Revision history for this message
Matt Riedemann (mriedem) wrote :

Would probably be better to break this out into separate bugs for specific APIs that are missing documentation.

Changed in cinder:
importance: Undecided → Medium
tags: added: documentation
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to cinder (master)

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

Changed in cinder:
assignee: lihaijing (lihaijing) → Matt Riedemann (mriedem)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to cinder (master)

Reviewed: https://review.openstack.org/595379
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=76cc9bd02b805356ce60cd5810a93900448f03d5
Submitter: Zuul
Branch: master

commit 76cc9bd02b805356ce60cd5810a93900448f03d5
Author: Matt Riedemann <email address hidden>
Date: Wed Aug 22 20:38:22 2018 -0400

    api-ref: add docs for os-migrate_volume API

    Adds the v2 and v3 API reference documentation for the
    admin-only (by default) os-migrate_volume volume action
    API. The only major difference with the v3 API is the
    cluster parameter introduced in the 3.16 microversion.

    Change-Id: I70f6b2cc4d25ea155ce09ddeec26b995890a2db3
    Partial-Bug: #1607539

Brian Rosmaita (brian-rosmaita)
tags: added: doc
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.