Object Storage API Reference for Account does not document DELETE

Bug #1704200 reported by Trey Duskin
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Object Storage (swift)
Fix Released
Undecided
Nicholas Njihia

Bug Description

This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:

- [x] This doc is inaccurate in this way: Account API does not document 'DELETE' verb, which is a valid request to delete an account
- [x] This is a doc addition request.
- [ ] I have a fix to the document that I can paste below including example: input and output.

If you have a troubleshooting or support issue, use the following resources:

 - Ask OpenStack: http://ask.openstack.org
 - The mailing list: http://lists.openstack.org
 - IRC: 'openstack' channel on Freenode

-----------------------------------
Release: 2.14.1.dev142 on 'Fri Jul 7 02:07:14 2017, commit 63c4215'
SHA:
Source: https://git.openstack.org/cgit/openstack/swift/tree/api-ref/source/index.rst
URL: https://developer.openstack.org/api-ref/object-storage/

Tags: api-ref
Revision history for this message
Donagh McCabe (donagh-mccabe) wrote :

Originally, the reason for this is that delete account was something only an reseller-admin would do and that end users cannot/should not do -- and the api docs were aimed at end users. However, given that a) we documented create (aka PUT) account and b) reseller-admins need an API reference, I think the original thinking is invalid, so delete account should be documented.

I've seen people, playing with curl, delete their own account by forgetting to specify a container, so at the very least it would be a good place to warn users that delete account is a one-way operation and not easily recovered from -- and more importantly, you cannot simply create an account with the same name again; specifically in OpenStack context: delete account should only be done *after* the project/tenant has been deleted from Keystone.

Changed in swift:
status: New → Confirmed
Changed in swift:
assignee: nobody → Nicholas Njihia (nicknjihian)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to swift (master)

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

Changed in swift:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to swift (master)

Reviewed: https://review.opendev.org/c/openstack/swift/+/805808
Committed: https://opendev.org/openstack/swift/commit/dfd1bdc9e2eae0a31cc5abbbf8e2584e1545598a
Submitter: "Zuul (22348)"
Branch: master

commit dfd1bdc9e2eae0a31cc5abbbf8e2584e1545598a
Author: Nicholas Njihia <email address hidden>
Date: Tue Aug 24 12:55:35 2021 +0300

     Add documentation for DELETE method for Swift Object Store API.

       Account API does not document 'DELETE' verb, which is a valid request to
    delete an account.
       This is a doc addition request.

     Closes-Bug: 1704200

    Change-Id: Iab53c574cc226e9505f28d3443fd7972b90a463a

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

This issue was fixed in the openstack/swift 2.29.0 release.

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.