Document X-Openstack-Request-Id in all responses

Swift returns `X-Openstack-Request-Id` for container and object requests as well as account. A couple api-ref docs are missing this value in the response examples. Change-Id: Ifcd67a620e04be5e92b43c7749ee4acb50bb171d
2016-11-15 13:15:59 -06:00 · 2016-11-15 13:15:59 -06:00 · 8e122c6fe8
commit 8e122c6fe8
parent 72e413a9ef
2 changed files with 31 additions and 0 deletions
--- a/api-ref/source/storage-container-services.inc
+++ b/api-ref/source/storage-container-services.inc
@ -88,6 +88,7 @@ Response Parameters
   - X-History-Location: X-History-Location_resp
   - X-Timestamp: X-Timestamp
   - X-Trans-Id: X-Trans-Id
+   - X-Openstack-Request-Id: X-Openstack-Request-Id
   - Content_Type: Content-Type_listing_resp
   - Date: Date
   - hash: hash
@ -146,6 +147,7 @@ Example requests and responses:
     Content-Length: 0
     Content-Type: text/html; charset=UTF-8
     X-Trans-Id: tx7f6b7fa09bc2443a94df0-0052d58b56
+     X-Openstack-Request-Id: tx7f6b7fa09bc2443a94df0-0052d58b56
     Date: Tue, 14 Jan 2014 19:09:10 GMT


@ -164,6 +166,7 @@ Example requests and responses:
     Content-Length: 0
     Content-Type: text/html; charset=UTF-8
     X-Trans-Id: tx06021f10fc8642b2901e7-0052d58f37
+     X-Openstack-Request-Id: tx06021f10fc8642b2901e7-0052d58f37
     Date: Tue, 14 Jan 2014 19:25:43 GMT

 - Create a container with an ACL to allow anybody to get an object in the
@ -180,6 +183,7 @@ Example requests and responses:
     Content-Length: 0
     Content-Type: text/html; charset=UTF-8
     X-Trans-Id: tx06021f10fc8642b2901e7-0052d58f37
+     X-Openstack-Request-Id: tx06021f10fc8642b2901e7-0052d58f37
     Date: Tue, 14 Jan 2014 19:25:43 GMT

 Error response codes:201,204,
@ -222,6 +226,7 @@ Response Parameters
   - Content-Length: Content-Length_cud_resp
   - Content-Type: Content-Type_cud_resp
   - X-Trans-Id: X-Trans-Id
+   - X-Openstack-Request-Id: X-Openstack-Request-Id



@ -273,6 +278,7 @@ Example requests and responses:
     Content-Length: 0
     Content-Type: text/html; charset=UTF-8
     X-Trans-Id: tx05dbd434c651429193139-0052d82635
+     X-Openstack-Request-Id: tx05dbd434c651429193139-0052d82635
     Date: Thu, 16 Jan 2014 18:34:29 GMT


@ -291,6 +297,7 @@ Example requests and responses:
     Content-Length: 0
     Content-Type: text/html; charset=UTF-8
     X-Trans-Id: txe60c7314bf614bb39dfe4-0052d82653
+     X-Openstack-Request-Id: txe60c7314bf614bb39dfe4-0052d82653
     Date: Thu, 16 Jan 2014 18:34:59 GMT


@ -309,6 +316,7 @@ Example requests and responses:
     Content-Length: 0
     Content-Type: text/html; charset=UTF-8
     X-Trans-Id: tx7997e18da2a34a9e84ceb-0052d826d0
+     X-Openstack-Request-Id: tx7997e18da2a34a9e84ceb-0052d826d0
     Date: Thu, 16 Jan 2014 18:37:04 GMT


@ -360,6 +368,7 @@ Response Parameters
   - Content-Length: Content-Length_cud_resp
   - Content-Type: Content-Type_cud_resp
   - X-Trans-Id: X-Trans-Id
+   - X-Openstack-Request-Id: X-Openstack-Request-Id



@ -393,6 +402,7 @@ Show container metadata request:
   X-Container-Bytes-Used: 14
   Content-Type: text/plain; charset=utf-8
   X-Trans-Id: tx0287b982a268461b9ec14-0052d826e2
+   X-Openstack-Request-Id: tx0287b982a268461b9ec14-0052d826e2
   Date: Thu, 16 Jan 2014 18:37:22 GMT


@ -439,6 +449,7 @@ Response Parameters
   - X-Container-Sync-To: X-Container-Sync-To_resp
   - Date: Date
   - X-Trans-Id: X-Trans-Id
+   - X-Openstack-Request-Id: X-Openstack-Request-Id
   - Content-Type: Content-Type_cud_resp
   - X-Versions-Location: X-Versions-Location_resp
   - X-History-Location: X-History-Location_resp
@ -473,6 +484,7 @@ If the container does not exist, the response is:
   Content-Length: 70
   Content-Type: text/html; charset=UTF-8
   X-Trans-Id: tx4d728126b17b43b598bf7-0052d81e34
+   X-Openstack-Request-Id: tx4d728126b17b43b598bf7-0052d81e34
   Date: Thu, 16 Jan 2014 18:00:20 GMT


@ -484,6 +496,7 @@ If the container exists and the deletion succeeds, the response is:
   Content-Length: 0
   Content-Type: text/html; charset=UTF-8
   X-Trans-Id: txf76c375ebece4df19c84c-0052d81f14
+   X-Openstack-Request-Id: txf76c375ebece4df19c84c-0052d81f14
   Date: Thu, 16 Jan 2014 18:04:04 GMT


@ -495,6 +508,7 @@ If the container exists but is not empty, the response is:
   Content-Length: 95
   Content-Type: text/html; charset=UTF-8
   X-Trans-Id: tx7782dc6a97b94a46956b5-0052d81f6b
+   X-Openstack-Request-Id: tx7782dc6a97b94a46956b5-0052d81f6b
   Date: Thu, 16 Jan 2014 18:05:31 GMT
   <html>
   <h1>Conflict
@ -528,6 +542,7 @@ Response Parameters
   - Content-Length: Content-Length_cud_resp
   - Content-Type: Content-Type_cud_resp
   - X-Trans-Id: X-Trans-Id
+   - X-Openstack-Request-Id: X-Openstack-Request-Id



--- a/api-ref/source/storage-object-services.inc
+++ b/api-ref/source/storage-object-services.inc
@ -51,6 +51,7 @@ Example requests and responses:
     X-Object-Meta-Orig-Filename: goodbyeworld.txt
     Content-Type: application/octet-stream
     X-Trans-Id: tx8145a190241f4cf6b05f5-0052d82a34
+     X-Openstack-Request-Id: tx8145a190241f4cf6b05f5-0052d82a34
     Date: Thu, 16 Jan 2014 18:51:32 GMT
     Goodbye World!

@ -71,6 +72,7 @@ Example requests and responses:
     Content-Length: 70
     Content-Type: text/html; charset=UTF-8
     X-Trans-Id: tx073f7cbb850c4c99934b9-0052d82b04
+     X-Openstack-Request-Id: tx073f7cbb850c4c99934b9-0052d82b04
     Date: Thu, 16 Jan 2014 18:55:00 GMT
     <html>
     <h1>Not Found
@ -134,6 +136,7 @@ Response Parameters
   - ETag: ETag_obj_resp
   - X-Timestamp: X-Timestamp
   - X-Trans-Id: X-Trans-Id
+   - X-Openstack-Request-Id: X-Openstack-Request-Id
   - Date: Date
   - X-Static-Large-Object: X-Static-Large-Object

@ -187,6 +190,7 @@ Example requests and responses:
     Etag: 8b1a9953c4611296a827abf8c47804d7
     Content-Type: text/html; charset=UTF-8
     X-Trans-Id: tx4d5e4f06d357462bb732f-0052d96843
+     X-Openstack-Request-Id: tx4d5e4f06d357462bb732f-0052d96843
     Date: Fri, 17 Jan 2014 17:28:35 GMT


@ -207,6 +211,7 @@ Example requests and responses:
     Etag: f688ae26e9cfa3ba6235477831d5122e
     Content-Type: text/html; charset=UTF-8
     X-Trans-Id: tx4d5e4f06d357462bb732f-0052d96843
+     X-Openstack-Request-Id: tx4d5e4f06d357462bb732f-0052d96843
     Date: Fri, 17 Jan 2014 17:28:35 GMT


@ -263,6 +268,7 @@ Response Parameters
   - ETag: ETag_obj_received
   - X-Timestamp: X-Timestamp
   - X-Trans-Id: X-Trans-Id
+   - X-Openstack-Request-Id: X-Openstack-Request-Id
   - Date: Date
   - Content-Type: Content-Type_obj_resp
   - last_modified: last_modified
@ -337,6 +343,7 @@ Example requests and responses:
     Content-Type: text/html; charset=UTF-8
     X-Object-Meta-Movie: AmericanPie
     X-Trans-Id: txdcb481ad49d24e9a81107-0052d97501
+     X-Openstack-Request-Id: txdcb481ad49d24e9a81107-0052d97501
     Date: Fri, 17 Jan 2014 18:22:57 GMT


@ -363,6 +370,7 @@ Example requests and responses:
     Content-Type: text/html; charset=UTF-8
     X-Object-Meta-Movie: AmericanPie
     X-Trans-Id: txdcb481ad49d24e9a81107-0052d97501
+     X-Openstack-Request-Id: txdcb481ad49d24e9a81107-0052d97501
     Date: Fri, 17 Jan 2014 18:22:57 GMT


@ -407,6 +415,7 @@ Response Parameters
   - ETag: ETag_obj_copied
   - X-Timestamp: X-Timestamp
   - X-Trans-Id: X-Trans-Id
+   - X-Openstack-Request-Id: X-Openstack-Request-Id
   - Date: Date
   - Content-Type: Content-Type_obj_resp

@ -450,6 +459,7 @@ Example request and response:
     Content-Length: 0
     Content-Type: text/html; charset=UTF-8
     X-Trans-Id: tx36c7606fcd1843f59167c-0052d6fdac
+     X-Openstack-Request-Id: tx36c7606fcd1843f59167c-0052d6fdac
     Date: Wed, 15 Jan 2014 21:29:16 GMT


@ -485,6 +495,7 @@ Response Parameters
   - Content-Length: Content-Length_cud_resp
   - Content-Type: Content-Type_cud_resp
   - X-Trans-Id: X-Trans-Id
+   - X-Openstack-Request-Id: X-Openstack-Request-Id



@ -521,6 +532,7 @@ Example requests and responses:
     X-Object-Meta-Book: GoodbyeColumbus
     Content-Type: application/octet-stream
     X-Trans-Id: tx37ea34dcd1ed48ca9bc7d-0052d84b6f
+     X-Openstack-Request-Id: tx37ea34dcd1ed48ca9bc7d-0052d84b6f
     Date: Thu, 16 Jan 2014 21:13:19 GMT

  Note: The ``--head`` option was used in the above example. If we had
@ -571,6 +583,7 @@ Response Parameters
   - ETag: ETag_obj_resp
   - X-Timestamp: X-Timestamp
   - X-Trans-Id: X-Trans-Id
+   - X-Openstack-Request-Id: X-Openstack-Request-Id
   - Date: Date
   - X-Static-Large-Object: X-Static-Large-Object
   - Content-Type: Content-Type_obj_resp
@ -653,6 +666,7 @@ Example requests and responses:
     Content-Length: 76
     Content-Type: text/html; charset=UTF-8
     X-Trans-Id: txb5fb5c91ba1f4f37bb648-0052d84b3f
+     X-Openstack-Request-Id: txb5fb5c91ba1f4f37bb648-0052d84b3f
     Date: Thu, 16 Jan 2014 21:12:31 GMT
     <html>
     <h1>Accepted
@ -677,6 +691,7 @@ Example requests and responses:
     Content-Length: 76
     Content-Type: text/html; charset=UTF-8
     X-Trans-Id: tx5ec7ab81cdb34ced887c8-0052d84ca4
+     X-Openstack-Request-Id: tx5ec7ab81cdb34ced887c8-0052d84ca4
     Date: Thu, 16 Jan 2014 21:18:28 GMT
     <html>
     <h1>Accepted
@ -719,6 +734,7 @@ Response Parameters
   - Content-Length: Content-Length_cud_resp
   - Content-Type: Content-Type_cud_resp
   - X-Trans-Id: X-Trans-Id
+   - X-Openstack-Request-Id: X-Openstack-Request-Id