Need list of all headers available for the Object Storage API 1.0

[Anne Gentle]

Would be great to include a listing and description of all headers for the Object Storage API. This listing is similar to how Ceph documents the Swift API at http://eu.ceph.com/docs/wip-rbd-parent/radosgw/swift/.

Name Description Required
X-Container-Read No
X-Container-Write No
X-Container-Meta-* No
ETag No
Content-Type No
Transfer-Encoding chunked No
X-Copy-From Yes (PUT)
Destination Yes (COPY)
If-Modified-Since No
If-Unmodified-Since No
Copy-If-Match No
Copy-If-None-Match No
Range No
If-Modified-Since No
If-Unmodified-Since No
If-Match No
If-None-Match No
Content-Range Data range, will only be returned if the range header field was specified in the request
Range No
If-Modified-Since No
If-Unmodified-Since No
If-Match No
If-None-Match No
X-Object-Meta-* String
X-Auth-Key String
X-Auth-User String
X-Storage-Url String
X-Storage-Token String

[Diane Fleming (diane-fleming)]

Kersten, Here's the specific file you should update:

https://github.com/openstack/object-api/blob/master/openstack-object-storage-dev/src/docbkx/object-api-general.xml

Add a faults section to it, similar to the Compute API Reference, and add the response codes in the link provided in this bug.

[Diane Fleming (diane-fleming)]

Kersten, Scratch my last comment! Yes, you should document the headers - but I'd add a section to the General API Information chapter.

[koolhead17 (koolhead17)]

Hi   Kersten,
Are you working on this?

[Kersten Richter (kersten-r)]

Yes. It is actually completed but I forgot/didn't know how to hook the defect to the review. Sorry!

[koolhead17 (koolhead17)]

Hi   Kersten,

Anne has explained how one can start contributing to our openstack-doc project. Kindly go through this link
https://wiki.openstack.org/wiki/How_To_Contribute#If_you.27re_into_doc.2C_we.27d_love_to_see_you:

If this is not sufficient and you have access to IRC join us on freenode server with IRC chat room #openstack-doc

Looking forward to see your patch. :)

[OpenStack Infra (hudson-openstack)]

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

commit 3da3bfd65f7b6617181e827f4ae8b78eb5800bee
Author: Diane Fleming <email address hidden>
Date: Tue Jan 7 15:43:06 2014 -0600

    Update object-api wadl for completeness and accuracy

    The point of this change is to ensure that
    these two docs are in sync and are complete with regards
    to the descriptions of each method and their request
    and response parameters:
    http://api.openstack.org/api-ref-objectstorage.html
      (API Reference page for Object Storage)
    http://docs.openstack.org/api/openstack-object-storage/1.0/content/
      (API Reference (or spec) for Object Storage)
    In addition, the current documents don’t describe ACLs, FormPOST, TempURLs,
    StaticWeb, Bulk Upload, Bulk Delete, the OPTIONS operation
    (though this is implicit in CORS support) and maybe a couple of other things.
    These items should be part of the https://review.openstack.org/#/c/64579/
    review, which I'm still working on.
    updated to add {name} for variables in metadata

    Co-Author: Donagh McCabe

    Partial-Bug: #1187119
    Partial-Bug: #1214139

    Change-Id: I82331b1c3cfc5b19f91f7ac1379476e6a9e6806d
    author: diane fleming

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/64579
Committed: https://git.openstack.org/cgit/openstack/object-api/commit/?id=ed4f3c4db9ba6b597d12925279c47868998238de
Submitter: Jenkins
Branch: master

commit ed4f3c4db9ba6b597d12925279c47868998238de
Author: Diane Fleming <email address hidden>
Date: Tue Dec 31 14:05:11 2013 -0600

    Update Object Storage API Reference

    Point to WADL files that generate the API Reference
      page so that the method descriptions and request
      and response parameters are consistent between
      these two docs:
        http://api.openstack.org/api-ref-objectstorage.html
          (API Reference page for Object Storage)
        http://docs.openstack.org/api/openstack-object-storage/1.0/
          (API Reference (or spec) for Object Storage)

    Add descriptions of ACLs, FormPOST, TempURLs,
      StaticWeb, Bulk Upload, Bulk Delete, the OPTIONS operation
      (though this is implicit in CORS support)

    Validate all code examples

    Remove duplication.

    Co-Author: Donagh McCabe

    Closes-Bug: #1187119
    Closes-Bug: #1214139
    Closes-Bug: #1074198
    Partial-Bug: #1255770

    Change-Id: I94054b046a94260ba8825bdb42439adfcaf9fdce
    author: diane fleming