Merge "api-ref: fix some header definitions"

api-ref/source/parameters.yaml

@@ -93,9 +93,11 @@ Content-Type_cud_resp:
   type: string
 Content-Type_listing_resp:
   description: |
-    The MIME type of the list of names. If the
+    If the operation succeeds, this value is the MIME type of the list
-    operation fails, this value is the MIME type of the error text in
+    response. The MIME type is determined by the listing format specified by
-    the response body.
+    the request and will be one of ``text/plain``, ``application/json``,
+    ``application/xml``, or ``text/xml``. If the operation fails, this value is
+    the MIME type of the error text in the response body.
   in: header
   required: true
   type: string
@@ -107,7 +109,9 @@ Content-Type_obj_cu_req:
   type: string
 Content-Type_obj_resp:
   description: |
-    The MIME type of the object.
+    If the operation succeeds, this value is the MIME type of the object. If
+    the operation fails, this value is the MIME type of the error text in the
+    response body.
   in: header
   required: true
   type: string
@@ -296,19 +300,31 @@ X-Account-Meta-Quota-Bytes_resp:
   in: header
   required: false
   type: string
-X-Account-Meta-Temp-URL-Key:
+X-Account-Meta-Temp-URL-Key-2_req:
   description: |
-    The secret key value for temporary URLs. If not
+    A second secret key value for temporary URLs.
-    set, this header is not returned in the response.
+    The second key enables you to rotate keys by having
+    two active keys at the same time.
   in: header
   required: false
   type: string
-X-Account-Meta-Temp-URL-Key-2:
+X-Account-Meta-Temp-URL-Key-2_resp:
   description: |
-    A second secret key value for temporary URLs. If
+    The second secret key value for temporary URLs. If
     not set, this header is not returned in the response.
-    The second key enables you to rotate keys by having
+  in: header
-    two active keys at the same time.
+  required: false
+  type: string
+X-Account-Meta-Temp-URL-Key_req:
+  description: |
+    The secret key value for temporary URLs.
+  in: header
+  required: false
+  type: string
+X-Account-Meta-Temp-URL-Key_resp:
+  description: |
+    The secret key value for temporary URLs. If not
+    set, this header is not returned in the response.
   in: header
   required: false
   type: string
@@ -377,14 +393,15 @@ X-Container-Meta-Access-Control-Expose-Headers:
     Headers the Object Storage service exposes to the
     browser (technically, through the ``user-agent`` setting), in the
     request response, separated by spaces.  By default the Object
-    Storage service returns the following values for this header:  -
+    Storage service returns the following headers:
-    All “simple response headers” as listed on
+
-    `http://www.w3.org/TR/cors/#simple-response-header
+    - All “simple response headers” as listed on
-    <http://www.w3.org/TR/cors/#simple-response-header>`_.  - The
+      `http://www.w3.org/TR/cors/#simple-response-header
-    headers ``etag``, ``x-timestamp``, ``x-trans-id``.  - All metadata
+      <http://www.w3.org/TR/cors/#simple-response-header>`_.
-    headers (``X-Container-Meta-*`` for containers and
+    - The headers ``etag``, ``x-timestamp``, ``x-trans-id``.
-    ``X-Object-Meta-*`` for objects) headers listed in
+    - All metadata headers (``X-Container-Meta-*`` for containers and
-    ``X-Container-Meta-Access-Control-Expose-Headers``.
+      ``X-Object-Meta-*`` for objects).
+    - headers listed in ``X-Container-Meta-Access-Control-Expose-Headers``.
   in: header
   required: false
   type: string
@@ -428,6 +445,13 @@ X-Container-Meta-Quota-Bytes:
   in: header
   required: false
   type: string
+X-Container-Meta-Quota-Bytes_resp:
+  description: |
+    The maximum size of the container, in bytes. If not set, this header is not
+    returned by this operation.
+  in: header
+  required: false
+  type: string
 X-Container-Meta-Quota-Count:
   description: |
     Sets maximum object count of the container.
@@ -441,17 +465,38 @@ X-Container-Meta-Quota-Count:
   in: header
   required: false
   type: string
-X-Container-Meta-Temp-URL-Key:
+X-Container-Meta-Quota-Count_resp:
+  description: |
+    The maximum object count of the container. If not set, this header is not
+    returned by this operation.
+  in: header
+  required: false
+  type: string
+X-Container-Meta-Temp-URL-Key-2_req:
+  description: |
+    A second secret key value for temporary URLs.
+    The second key enables you to rotate keys by having
+    two active keys at the same time.
+  in: header
+  required: false
+  type: string
+X-Container-Meta-Temp-URL-Key-2_resp:
+  description: |
+    The second secret key value for temporary URLs. If
+    not set, this header is not returned in the response.
+  in: header
+  required: false
+  type: string
+X-Container-Meta-Temp-URL-Key_req:
   description: |
     The secret key value for temporary URLs.
   in: header
   required: false
   type: string
-X-Container-Meta-Temp-URL-Key-2:
+X-Container-Meta-Temp-URL-Key_resp:
   description: |
-    A second secret key value for temporary URLs. The
+    The secret key value for temporary URLs. If not
-    second key enables you to rotate keys by having two active keys at
+    set, this header is not returned in the response.
-    the same time.
   in: header
   required: false
   type: string

api-ref/source/storage-account-services.inc

@@ -96,8 +96,8 @@ Response Parameters
 
    - Content-Length: Content-Length_listing_resp
    - X-Account-Meta-name: X-Account-Meta-name
-   - X-Account-Meta-Temp-URL-Key: X-Account-Meta-Temp-URL-Key
+   - X-Account-Meta-Temp-URL-Key: X-Account-Meta-Temp-URL-Key_resp
-   - X-Account-Meta-Temp-URL-Key-2: X-Account-Meta-Temp-URL-Key-2
+   - X-Account-Meta-Temp-URL-Key-2: X-Account-Meta-Temp-URL-Key-2_resp
    - X-Timestamp: X-Timestamp
    - X-Trans-Id: X-Trans-Id
    - Date: Date
@@ -249,8 +249,8 @@ Request
    - account: account
    - X-Auth-Token: X-Auth-Token
    - X-Service-Token: X-Service-Token
-   - X-Account-Meta-Temp-URL-Key: X-Account-Meta-Temp-URL-Key
+   - X-Account-Meta-Temp-URL-Key: X-Account-Meta-Temp-URL-Key_req
-   - X-Account-Meta-Temp-URL-Key-2: X-Account-Meta-Temp-URL-Key-2
+   - X-Account-Meta-Temp-URL-Key-2: X-Account-Meta-Temp-URL-Key-2_req
    - X-Account-Meta-name: X-Account-Meta-name_req
    - X-Remove-Account-name: X-Remove-Account-name
    - X-Trans-Id-Extra: X-Trans-Id-Extra
@@ -340,8 +340,8 @@ Response Parameters
 
    - Content-Length: Content-Length_cud_resp
    - X-Account-Meta-name: X-Account-Meta-name
-   - X-Account-Meta-Temp-URL-Key: X-Account-Meta-Temp-URL-Key
+   - X-Account-Meta-Temp-URL-Key: X-Account-Meta-Temp-URL-Key_resp
-   - X-Account-Meta-Temp-URL-Key-2: X-Account-Meta-Temp-URL-Key-2
+   - X-Account-Meta-Temp-URL-Key-2: X-Account-Meta-Temp-URL-Key-2_resp
    - X-Timestamp: X-Timestamp
    - X-Trans-Id: X-Trans-Id
    - Date: Date

api-ref/source/storage-container-services.inc

@@ -59,8 +59,8 @@ Request
    - X-Service-Token: X-Service-Token
    - X-Newest: X-Newest
    - Accept: Accept
-   - X-Container-Meta-Temp-URL-Key: X-Container-Meta-Temp-URL-Key
+   - X-Container-Meta-Temp-URL-Key: X-Container-Meta-Temp-URL-Key_req
-   - X-Container-Meta-Temp-URL-Key-2: X-Container-Meta-Temp-URL-Key-2
+   - X-Container-Meta-Temp-URL-Key-2: X-Container-Meta-Temp-URL-Key-2_req
    - X-Trans-Id-Extra: X-Trans-Id-Extra
    - X-Storage-Policy: X-Storage-Policy
 
@@ -75,8 +75,10 @@ Response Parameters
    - X-Container-Object-Count: X-Container-Object-Count
    - X-Container-Bytes-Used: X-Container-Bytes-Used
    - Accept-Ranges: Accept-Ranges
-   - X-Container-Meta-Temp-URL-Key: X-Container-Meta-Temp-URL-Key
+   - X-Container-Meta-Temp-URL-Key: X-Container-Meta-Temp-URL-Key_resp
-   - X-Container-Meta-Temp-URL-Key-2: X-Container-Meta-Temp-URL-Key-2
+   - X-Container-Meta-Temp-URL-Key-2: X-Container-Meta-Temp-URL-Key-2_resp
+   - X-Container-Meta-Quota-Count: X-Container-Meta-Quota-Count_resp
+   - X-Container-Meta-Quota-Bytes: X-Container-Meta-Quota-Bytes_resp
    - X-Storage-Policy: X-Storage-Policy
    - X-Container-Read: X-Container-Read_resp
    - X-Container-Write: X-Container-Write_resp
@@ -202,8 +204,10 @@ Request
    - X-Container-Meta-Access-Control-Allow-Origin: X-Container-Meta-Access-Control-Allow-Origin
    - X-Container-Meta-Access-Control-Max-Age: X-Container-Meta-Access-Control-Max-Age
    - X-Container-Meta-Access-Control-Expose-Headers: X-Container-Meta-Access-Control-Expose-Headers
-   - X-Container-Meta-Temp-URL-Key: X-Container-Meta-Temp-URL-Key
+   - X-Container-Meta-Quota-Bytes: X-Container-Meta-Quota-Bytes
-   - X-Container-Meta-Temp-URL-Key-2: X-Container-Meta-Temp-URL-Key-2
+   - X-Container-Meta-Quota-Count: X-Container-Meta-Quota-Count
+   - X-Container-Meta-Temp-URL-Key: X-Container-Meta-Temp-URL-Key_req
+   - X-Container-Meta-Temp-URL-Key-2: X-Container-Meta-Temp-URL-Key-2_req
    - X-Trans-Id-Extra: X-Trans-Id-Extra
    - X-Storage-Policy: X-Storage-Policy
 
@@ -340,8 +344,8 @@ Request
    - X-Container-Meta-Quota-Bytes: X-Container-Meta-Quota-Bytes
    - X-Container-Meta-Quota-Count: X-Container-Meta-Quota-Count
    - X-Container-Meta-Web-Directory-Type: X-Container-Meta-Web-Directory-Type
-   - X-Container-Meta-Temp-URL-Key: X-Container-Meta-Temp-URL-Key
+   - X-Container-Meta-Temp-URL-Key: X-Container-Meta-Temp-URL-Key_req
-   - X-Container-Meta-Temp-URL-Key-2: X-Container-Meta-Temp-URL-Key-2
+   - X-Container-Meta-Temp-URL-Key-2: X-Container-Meta-Temp-URL-Key-2_req
    - X-Trans-Id-Extra: X-Trans-Id-Extra
 
 
@@ -420,13 +424,13 @@ Response Parameters
    - X-Container-Object-Count: X-Container-Object-Count
    - X-Container-Bytes-Used: X-Container-Bytes-Used
    - X-Container-Write: X-Container-Write_resp
-   - X-Container-Meta-Quota-Bytes: X-Container-Meta-Quota-Bytes
+   - X-Container-Meta-Quota-Bytes: X-Container-Meta-Quota-Bytes_resp
-   - X-Container-Meta-Quota-Count: X-Container-Meta-Quota-Count
+   - X-Container-Meta-Quota-Count: X-Container-Meta-Quota-Count_resp
    - Accept-Ranges: Accept-Ranges
    - X-Container-Read: X-Container-Read_resp
    - X-Container-Meta-Access-Control-Expose-Headers: X-Container-Meta-Access-Control-Expose-Headers
-   - X-Container-Meta-Temp-URL-Key: X-Container-Meta-Temp-URL-Key
+   - X-Container-Meta-Temp-URL-Key: X-Container-Meta-Temp-URL-Key_resp
-   - X-Container-Meta-Temp-URL-Key-2: X-Container-Meta-Temp-URL-Key-2
+   - X-Container-Meta-Temp-URL-Key-2: X-Container-Meta-Temp-URL-Key-2_resp
    - X-Timestamp: X-Timestamp
    - X-Container-Meta-Access-Control-Allow-Origin: X-Container-Meta-Access-Control-Allow-Origin
    - X-Container-Meta-Access-Control-Max-Age: X-Container-Meta-Access-Control-Max-Age