openstack/zaqar
Code Issues Proposed changes

The doc of bp support-md5-of-body

Browse Source 
blueprint: support-md5-of-body
Change-Id: I7238971df284f5cd146e3013092b353649cffc6f
This commit is contained in:
yangzhenyu 2018-01-16 14:13:16 +08:00 committed by wangxiyuan
parent a8215f72f9
commit f605dd9bae
5 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api-ref/source/messages.inc
View File

@ -174,7 +174,8 @@ URI that the client can use to uniquely identify a message resource and
interact with it. ``ttl`` is the TTL that was set on the message when it was interact with it. ``ttl`` is the TTL that was set on the message when it was
posted. The message expires after (ttl - age) seconds. ``age`` is the number posted. The message expires after (ttl - age) seconds. ``age`` is the number
of seconds relative to the server's clock. ``body`` is the arbitrary document of seconds relative to the server's clock. ``body`` is the arbitrary document
that was submitted with the original request to post the message. that was submitted with the original request to post the message. ``checksum``
is the hash digest of the ``body``, default algorithm is MD5.
@ -268,7 +269,8 @@ the client can use to uniquely identify a message resource and interact with
it. ``ttl`` is the TTL that was set on the message when it was posted. The it. ``ttl`` is the TTL that was set on the message when it was posted. The
message expires after (ttl - age) seconds. ``age`` is the number of seconds message expires after (ttl - age) seconds. ``age`` is the number of seconds
relative to the server's clock. ``body`` is the arbitrary document that was relative to the server's clock. ``body`` is the arbitrary document that was
submitted with the original request to post the message. submitted with the original request to post the message. ``checksum`` is the
hash digest of the ``body``, default algorithm is MD5.

3
api-ref/source/samples/claim_messages_response.json
View File

@ -6,7 +6,8 @@
}, },
"age": 239, "age": 239,
"href": "/v2/queues/demoqueue/messages/51db6f78c508f17ddc924357?claim_id=51db7067821e727dc24df754", "href": "/v2/queues/demoqueue/messages/51db6f78c508f17ddc924357?claim_id=51db7067821e727dc24df754",
"ttl": 300 "ttl": 300,
"checksum": "MD5:82eb2714b7c0237d373947c046cac78d"
} }
] ]
} }

3
api-ref/source/samples/messages-get-response.json
View File

@ -7,5 +7,6 @@
"age": 1110, "age": 1110,
"href": "/v2/queues/beijing/messages/578f0055508f153f256f717f", "href": "/v2/queues/beijing/messages/578f0055508f153f256f717f",
"id": "578f0055508f153f256f717f", "id": "578f0055508f153f256f717f",
"ttl": 3600 "ttl": 3600,
"checksum": "MD5:abf7213555626e29c3cb3e5dc58b3515"
} }

6
api-ref/source/samples/messages-list-response.json
View File

@ -9,7 +9,8 @@
"age": 482, "age": 482,
"href": "/v2/queues/beijing/messages/578edfe6508f153f256f717b", "href": "/v2/queues/beijing/messages/578edfe6508f153f256f717b",
"id": "578edfe6508f153f256f717b", "id": "578edfe6508f153f256f717b",
"ttl": 3600 "ttl": 3600,
"checksum": "MD5:abf7213555626e29c3cb3e5dc58b3515"
}, },
{ {
"body": { "body": {
@ -20,7 +21,8 @@
"age": 456, "age": 456,
"href": "/v2/queues/beijing/messages/578ee000508f153f256f717d", "href": "/v2/queues/beijing/messages/578ee000508f153f256f717d",
"id": "578ee000508f153f256f717d", "id": "578ee000508f153f256f717d",
"ttl": 3600 "ttl": 3600,
"checksum": "MD5:abf7213555626e29c3cb3e5dc58b3515"
} }
], ],
"links": [ "links": [

9
releasenotes/notes/support_md5_of_body-84c1cdc6809b6417.yaml Normal file
View File

@ -0,0 +1,9 @@
---
features:
- |
Support non-URL encoded message body checksum function, the default algorithm
is MD5. Back-end support for MongoDB, Redis and Swift. With this feature, when
a user sends a message to the queue, Zaqar calculates a "checksum" value for
the body of the non-URL encoded message, which the user can then get after the
message is got or claimed. Finally, the user can use it to verify that the
body of the newly obtained message is correct.