openstack/swift
Code Issues Proposed changes
dad8fb7c3c
swift/api-ref/source/storage_info.inc

47 lines
935 B
PHP
Raw Normal View History

Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
.. -*- rst -*-
===============
Discoverability
===============
If configured, lists the activated capabilities for this version of
the OpenStack Object Storage API.
List activated capabilities
===========================
.. rest_method:: GET /info
Lists the activated capabilities for this version of the OpenStack Object Storage API.
Corrections for the API specifications in api-ref Fixes a number of technical issues with the api-ref section including: - Added missing headers - The header descriptions were made specific to whether they are used in requests or responses and the verb in question (example: Content-Length in object HEAD is the object size, not the response body length). - Added references to API features such as bulk delete. - Many typographical fixes (e.g., spaces in the middle of header names) - Restored xml and json account/container listing examples. The following areas were not updated and it is proposed to defer them to a subsequent update. This is because I don't have time or their merit is debatable: - ACLs (as used in a Keystone context) are not described. - Account create/delete is not described. - I left List Endpoints as-is. Change-Id: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-08-12 15:52:55 +01:00
Most of the information is "public" i.e. visible to all callers. However, some
configuration and capability items are reserved for the administrators of the
system. To access this data, the ``swiftinfo_sig`` and ``swiftinfo_expires``
query parameters must be added to the request.
Adds migrated API reference files This brings in RST plus YAML files, migrated from the source for [0]. The migration explanation is found on the openstack-dev mailing list [1]. Project instruction is in the OpenStack Documentation Contributor Guide [2]. A patch for publishing this source is in [3]. The conf.py and the tox environment are standard across other projects. [0]http://developer.openstack.org/api-ref-objectstorage-v1.html [1]http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html [2]http://docs.openstack.org/contributor-guide/api-guides.html [3]https://review.openstack.org/#/c/313015/ Change-Id: Ifebc65b188c4f2ba35b61c0deae5ec24401df7f9
2016-05-04 02:00:53 +00:00
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
- swiftinfo_sig: swiftinfo_sig
- swiftinfo_expires: swiftinfo_expires
Response Example
----------------
.. literalinclude:: samples/capabilities-list-response.json
:language: javascript
Copy Permalink