Block Storage API V3 - Typo in Workers Cleanup Request Example

Bug #1970135 reported by James Palmer
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Cinder
Fix Released
Low
James Palmer

Bug Description

- [x] This doc is inaccurate in this way: In the request example, key "cluster" should be named "cluster_name" per the request documentation above the example.
- [x] I have a fix to the document that I can paste below including example:
{
    "cluster_name": "test",
    "disabled": true,
    "host": "host1@lvmdriver",
    "service_id": 1,
    "is_up": true,
    "binary": "cinder-volume",
    "resource_id": "b122f668-d15a-40f8-af21-38d218796ab8",
    "resource_type": "Volume"
}

-----------------------------------
Release: on 2022-04-20 15:48:49
SHA: 7671d505b7459965e53a5339f5c6c3d5f44f06be
Source: https://opendev.org/openstack/cinder/src/api-ref/source/v3/index.rst
URL: https://docs.openstack.org/api-ref/block-storage/v3/index.html

Tags: api-ref
Revision history for this message
James Palmer (jpalmer7698) wrote :

Would like to confirm with someone else that this is a typo. Once confirmed, I can make a commit and fix the typo.

Changed in cinder:
status: New → Confirmed
importance: Undecided → Low
Changed in cinder:
assignee: nobody → James Palmer (jpalmer7698)
Changed in cinder:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to cinder (master)

Fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/cinder/+/839256

Revision history for this message
James Palmer (jpalmer7698) wrote :

Pushed commit 839256 to Gerrit, but the following CI Systems failed even though I didn't modify any python code in Cinder: LightbitsCI, DellEMC PowerStoreCI, DellEMC VNX CI, Nexenta CI, Cisco Cinder CI, and DellEMC Unity CI.

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

Reviewed: https://review.opendev.org/c/openstack/cinder/+/839256
Committed: https://opendev.org/openstack/cinder/commit/0e6ba483477daf19908e704fe8daf2d60977a158
Submitter: "Zuul (22348)"
Branch: master

commit 0e6ba483477daf19908e704fe8daf2d60977a158
Author: James Palmer <email address hidden>
Date: Mon Apr 25 19:10:41 2022 +0000

    Change key "cluster" to "cluster_name"

    According to the request documentation above this sample,
    the key "cluster" should be "cluster_name".

    Closes-Bug: #1970135
    Signed-off-by: James Palmer <email address hidden>
    Change-Id: Ifd64ba39a46cdbf7d75bc17baa2862790a7a39c1

Changed in cinder:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/cinder 21.0.0.0rc1

This issue was fixed in the openstack/cinder 21.0.0.0rc1 release candidate.

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.