7 Commits

Author SHA1 Message Date
Jenkins
e07f9be8f5 Merge "api-ref: fix some header definitions" 2016-09-21 06:44:27 +00:00
Alistair Coles
cbfa79a159 api-ref: fix some header definitions
Clarify Content-Type header definition for listings.

Distinguish between request and response definitions for
X-Account-Meta-Temp-URL-Key* headers.

Insert X-Container-Meta-Quota-* headers missing from some
request/response definitions.

Improve X-Container-Meta-Access-Control-Expose-Headers
parameter formatting.

Distinguish between request and response definitions for
X-Container-Meta-Temp-URL-Key* headers.

Co-Authored-By: Christian Schwede <cschwede@redhat.com>
Change-Id: I8fc7610395973b520aa9ddd72c94e1eb75f602cd
Related-Change: I315b4e550b7d10880fbc00fce9311127ba609c2d
2016-09-20 14:30:27 +01:00
Jenkins
539c3d417c Merge "api-ref: clean up account listing examples" 2016-09-19 22:10:18 +00:00
Alistair Coles
5ec9a62f4d api-ref: clean up account listing examples
Move the account listing sample responses to follow the sample
requests, and to precede the request/response parameter definitions to
be consistent with other parts of the doc.

Related-Change: I315b4e550b7d10880fbc00fce9311127ba609c2d

Change-Id: Ia20acacd238db4a423b8cd89af1658222b4c5828
2016-09-19 09:46:06 +01:00
Alistair Coles
2355771d4b api-ref: Move repeated paragraph to an include file
Move repeated test re metadata header syntax to an include
file and make it be rendered as a note.

Also make already included text about metadata header value
encoding be a note.

Change-Id: I4795836587492954ad24dd5baaa5d668746d6040
2016-09-19 09:18:19 +01:00
Donagh McCabe
9ce596a5a6 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-09-14 10:10:20 +01:00
Cloud User
4b13879680 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-06-21 19:14:22 +02:00