docs: update FilterPolicy config to match AWS API (#215)

* Update FilterPolicy config to match AWS API Currently, filterPolicy configuration outlined in this file does not match what is outlined in the AWS documentation and API - https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-subscription.html. The `filterPolicy` should only contain the JSON policy, so no need for the `attributes` property; which in itself was confusing as the policy can apply to the message attributes or body. Further to this, this definition file was missing the `filterPolicyScope` which is needed to determine whether the user wishes to filter on the message attributes or the body. * Minor: remove redundant ref * Minor: match Pascal casing * Minor: amend casing * Match AWS API casing and fix example * Update SNS README --------- Co-authored-by: Dec Kolakowski <[email protected]>
asyncapi · Sep 25, 2023 · 6a6cd4c · 6a6cd4c
1 parent 85b0037
commit 6a6cd4c
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 63 deletions.
diff --git a/sns/README.md b/sns/README.md
@@ -113,7 +113,8 @@ We support an array of consumers via the **consumers** field. This allows you to
 |---|:---:|---|
 | <a name="operationBindingObjectProtocol"></a>`protocol` | string | **Required.** The protocol that this endpoint receives messages by. Can be `http`, `https`, `email`, `email-json`, `sms`, `sqs`, `application`, `lambda` or `firehose` |
 | <a name="operationBindingObjectEndpoint"></a>`endpoint` |[identifier](#identifier)| **Required.** The endpoint messages are delivered to. |
-| <a name="operationBindingObjectFilerPolicy"></a>`filterPolicy` | [filterPolicy](#filter-policy) | **Optional.** Only receive a subset of messages from the channel, determined by this policy. |
+| <a name="operationBindingObjectFilterPolicy"></a>`filterPolicy` | object | **Optional.** Only receive a subset of messages from the channel, determined by this policy. |
+| <a name="operationBindingObjectFilterPolicyScope"></a>`filterPolicyScope` | string | **Optional.** Determines whether the FilterPolicy applies to MessageAttributes (default) or MessageBody. |
 | <a name="operationBindingObjectRawMessageDelivery"></a>`rawMessageDelivery` | boolean | **Required.** If *true* AWS SNS attributes are removed from the body, and for SQS, SNS message attributes are copied to SQS message attributes. If *false* the SNS attributes are included in the body. |
 | <a name="operationBindingObjectRedrivePolicy"></a>`redrivePolicy` | [redrivePolicy](#redrive-policy) | **Optional.** Prevent poison pill messages by moving un-processable messages to an SQS dead letter queue. |
 | <a name="operationBindingObjectDeliveryPolicy"></a>`deliveryPolicy` | [deliveryPolicy](#delivery-policy) | **Optional.** Policy for retries to HTTP. The parameter is for that [SNS Subscription](https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html) and overrides any policy on the [SNS Topic](https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html). |
@@ -132,11 +133,6 @@ We support an array of consumers via the **consumers** field. This allows you to
 | <a name="channelBindingDeliveryPolicyObjectBackoffFunction"></a>`backoffFunction` | string, one of: arithmetic, exponential, geometric or linear | **Optional.** The algorithm for backoff between retries |
 | <a name="channelBindingDeliveryPolicyObjectMaxReceivesPerSecond"></a>`maxReceivesPerSecond` | integer | **Optional.** The maximum number of deliveries per second, per subscription |
 
-#### Filter Policy
-|Field Name | Type | Description|
-|---|:---:|---|
-| <a name="filterPolicyObjectAttributes"></a>`attributes` |Map(string, array or string or object) | **Required.** A map of a message attribute to an array of possible matches. The match may be a simple string for an exact match, but it may also be an object that represents a constraint and values for that constraint  |
-
 #### Identifier
 |Field Name | Type | Description|
 |---|:---:|---|
@@ -221,9 +217,8 @@ channels:
               name: user-signedup-queue # refers to a queue defined in this file, but not shown in this example
             rawMessageDelivery: true  
             filterPolicy:
-              attributes:
-                reason: 
-                  anything-but: password-reset
+              reason: 
+                anything-but: password-reset
             redrivePolicy:
               deadLetterQueue:
                 name: user-signedup-queue-dlq # refers toa queue defined in this file, but not show in this example
@@ -281,9 +276,9 @@ channels:
           endpoint:
             url: http://login.my.com/user/new
           filterPolicy:
-            attributes:
-              reason: 
-                anything-but: password-reset
+            reason: 
+              anything-but: password-reset
+          filterPolicyScope: MessageBody
           deliveryPolicy:
             minDelayTarget: 1
             maxDelayTarget: 120

diff --git a/sns/json_schemas/operation.json b/sns/json_schemas/operation.json
@@ -95,7 +95,38 @@
           "$ref": "#/definitions/identifier"
         },
         "filterPolicy": {
-          "$ref": "#/definitions/filterPolicy"
+          "type": "object",
+          "description": "Only receive a subset of messages from the channel, determined by this policy. Depending on the FilterPolicyScope, a map of either a message attribute or message body to an array of possible matches. The match may be a simple string for an exact match, but it may also be an object that represents a constraint and values for that constraint.",
+          "patternProperties": {
+            "^x-[\\w\\d\\.\\-\\_]+$": {
+              "$ref": "https://raw.githubusercontent.com/asyncapi/spec-json-schemas/v2.14.0/schemas/2.4.0.json#/definitions/specificationExtension"
+            }
+          },
+          "additionalProperties": {
+            "oneOf": [
+              {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              {
+                "type": "string"
+              },
+              {
+                "type": "object"
+              }
+            ]
+          }
+        },
+        "filterPolicyScope": {
+          "type": "string",
+          "description": "Determines whether the FilterPolicy applies to MessageAttributes or MessageBody.",
+          "enum": [
+            "MessageAttributes",
+            "MessageBody"
+          ],
+          "default": "MessageAttributes"
         },
         "rawMessageDelivery": {
           "type": "boolean",
@@ -167,40 +198,6 @@
         }
       }
     },
-    "filterPolicy": {
-      "type": "object",
-      "description": "Only receive a subset of messages from the channel, determined by this policy.",
-      "patternProperties": {
-        "^x-[\\w\\d\\.\\-\\_]+$": {
-          "$ref": "https://raw.githubusercontent.com/asyncapi/spec-json-schemas/v2.14.0/schemas/2.4.0.json#/definitions/specificationExtension"
-        }
-      },
-      "properties": {
-        "attributes": {
-          "type": "object",
-          "description": "A map of a message attribute to an array of possible matches. The match may be a simple string for an exact match, but it may also be an object that represents a constraint and values for that constraint.",
-          "additionalProperties": {
-            "oneOf": [
-              {
-                "type": "array",
-                "items": {
-                  "type": "string"
-                }
-              },
-              {
-                "type": "string"
-              },
-              {
-                "type": "object"
-              }
-            ]
-          }
-        }
-      },
-      "required": [
-        "attributes"
-      ]
-    },
     "redrivePolicy": {
       "type": "object",
       "description": "Prevent poison pill messages by moving un-processable messages to an SQS dead letter queue.",
@@ -237,22 +234,21 @@
             "name": "someQueue"
           },
           "filterPolicy": {
-            "attributes": {
-              "store": [
-                "asyncapi_corp"
-              ],
-              "event": [
-                {
-                  "anything-but": "order_cancelled"
-                }
-              ],
-              "customer_interests": [
-                "rugby",
-                "football",
-                "baseball"
-              ]
-            }
+            "store": [
+              "asyncapi_corp"
+            ],
+            "event": [
+              {
+                "anything-but": "order_cancelled"
+              }
+            ],
+            "customer_interests": [
+              "rugby",
+              "football",
+              "baseball"
+            ]
           },
+          "filterPolicyScope": "MessageAttributes",
           "rawMessageDelivery": false,
           "redrivePolicy": {
             "deadLetterQueue": {
@@ -274,4 +270,4 @@
       ]
     }
   ]
-}
+}