From a13aeafe3041a0574366d826ff7c8f00a3648bef Mon Sep 17 00:00:00 2001 From: Yuval Lifshitz Date: Tue, 21 Apr 2020 14:08:28 +0300 Subject: [PATCH] rgw/doc: clarify topic creation format also, fix some typos, and 'push-endpoint' parameter Signed-off-by: Yuval Lifshitz --- doc/radosgw/notifications.rst | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/doc/radosgw/notifications.rst b/doc/radosgw/notifications.rst index 4c47c211394..fefe56a0eb3 100644 --- a/doc/radosgw/notifications.rst +++ b/doc/radosgw/notifications.rst @@ -50,6 +50,10 @@ Bucket Notification REST API Topics ~~~~~~ +.. note:: + + In all topic actions, the parameters are URL encoded, and sent in the message body using ``application/x-www-form-urlencoded`` content type + Create a Topic `````````````` @@ -63,9 +67,9 @@ To update a topic, use the same command used for topic creation, with the topic :: POST + Action=CreateTopic &Name= - &push-endpoint= [&Attributes.entry.1.key=amqp-exchange&Attributes.entry.1.value=] [&Attributes.entry.2.key=amqp-ack-level&Attributes.entry.2.value=none|broker] [&Attributes.entry.3.key=verify-ssl&Attributes.entry.3.value=true|false] @@ -73,11 +77,12 @@ To update a topic, use the same command used for topic creation, with the topic [&Attributes.entry.5.key=use-ssl&Attributes.entry.5.value=true|false] [&Attributes.entry.6.key=ca-location&Attributes.entry.6.value=] [&Attributes.entry.7.key=OpaqueData&Attributes.entry.7.value=] + [&Attributes.entry.8.key=push-endpoint&Attributes.entry.8.value=] Request parameters: - push-endpoint: URI of an endpoint to send push notification to -- OpaqueData: opaque data is set in the topic configuration and added to all notifications triggered by the ropic +- OpaqueData: opaque data is set in the topic configuration and added to all notifications triggered by the topic - HTTP endpoint @@ -144,7 +149,9 @@ Returns information about specific topic. This includes push-endpoint informatio :: POST - Action=GetTopic&TopicArn= + + Action=GetTopic + &TopicArn= Response will have the following format: @@ -183,7 +190,9 @@ Delete Topic :: POST - Action=DeleteTopic&TopicArn= + + Action=DeleteTopic + &TopicArn= Delete the specified topic. Note that deleting a deleted topic should result with no-op and not a failure. @@ -204,7 +213,8 @@ List all topics that user defined. :: - POST + POST + Action=ListTopics Response will have the following format: @@ -242,7 +252,6 @@ Detailed under: `Bucket Operations`_. .. note:: - "Abort Multipart Upload" request does not emit a notification - - "Delete Multiple Objects" request does not emit a notification - Both "Initiate Multipart Upload" and "POST Object" requests will emit an ``s3:ObjectCreated:Post`` notification @@ -315,9 +324,9 @@ pushed or pulled using the pubsub sync module. For example: - s3.object.version: object version in case of versioned bucket - s3.object.sequencer: monotonically increasing identifier of the change per object (hexadecimal format) - s3.object.metadata: any metadata set on the object sent as: ``x-amz-meta-`` (an extension to the S3 notification API) -- s3.object.tags: any tags set on the objcet (an extension to the S3 notification API) +- s3.object.tags: any tags set on the object (an extension to the S3 notification API) - s3.eventId: unique ID of the event, that could be used for acking (an extension to the S3 notification API) -- s3.opaqueData: opaque data is set in the topic configuration and added to all notifications triggered by the ropic (an extension to the S3 notification API) +- s3.opaqueData: opaque data is set in the topic configuration and added to all notifications triggered by the topic (an extension to the S3 notification API) .. _PubSub Module : ../pubsub-module .. _S3 Notification Compatibility: ../s3-notification-compatibility -- 2.39.5