docs(bindings): Amazon SNS docs

asyncapi · May 14, 2024 · 3ed73ea · 3ed73ea
1 parent 3596d19
commit 3ed73ea
Show file tree

Hide file tree

Showing 20 changed files with 56 additions and 24 deletions.
diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/SNSChannelBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/SNSChannelBinding.java
@@ -7,13 +7,12 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * This class MUST NOT contain any properties. Its name is reserved for future use.
- * <p>
  * Describes SNS channel binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#channel-binding-object">SNS channel binding</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
+ * @since 1.0.0-RC2
  */
 @JsonTypeInfo(
         use = JsonTypeInfo.Id.NAME,

diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/SNSMessageBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/SNSMessageBinding.java
@@ -7,13 +7,12 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * This class MUST NOT contain any properties. Its name is reserved for future use.
- * <p>
  * Describes SNS message binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#message-binding-object">SNS message binding</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
+ * @since 1.0.0-RC2
  */
 @JsonTypeInfo(
         use = JsonTypeInfo.Id.NAME,

diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/SNSOperationBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/SNSOperationBinding.java
@@ -7,13 +7,12 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * This class MUST NOT contain any properties. Its name is reserved for future use.
- * <p>
  * Describes SNS operation binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#operation-binding-object">SNS operation binding</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
+ * @since 1.0.0-RC2
  */
 @JsonTypeInfo(
         use = JsonTypeInfo.Id.NAME,

diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/SNSServerBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/SNSServerBinding.java
@@ -7,13 +7,12 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * This class MUST NOT contain any properties. Its name is reserved for future use.
- * <p>
  * Describes SNS server binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#server-binding-object">SNS server binding</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
+ * @since 1.0.0-RC2
  */
 @JsonTypeInfo(
         use = JsonTypeInfo.Id.NAME,

diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/channel/SNSChannelBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/channel/SNSChannelBinding.java
@@ -10,7 +10,7 @@
  * Describes SNS channel binding.
  *
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#channel-binding-object">SNS channel binding</a>
- * @see <a href="https://aws.amazon.com/sns/">SNS</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
  * @version 0.1.0
  * @since 1.0.0-RC2

diff --git a/...capi-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/channel/SNSChannelOrdering.java b/...capi-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/channel/SNSChannelOrdering.java
@@ -11,7 +11,7 @@
  * By default, we assume an unordered SNS topic. This field allows configuration of a FIFO SNS Topic.
  *
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#channel-binding-object">SNS channel binding</a>
- * @see <a href="https://aws.amazon.com/sns/">SNS</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
  * @version 0.1.0
  * @since 1.0.0-RC2

diff --git a/...-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/channel/SNSChannelOrderingType.java b/...-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/channel/SNSChannelOrderingType.java
@@ -6,7 +6,7 @@
  * Defines the type of SNS Topic.
  *
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#channel-binding-object">SNS channel binding</a>
- * @see <a href="https://aws.amazon.com/sns/">SNS</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
  * @version 0.1.0
  * @since 1.0.0-RC2

diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/channel/SNSChannelPolicy.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/channel/SNSChannelPolicy.java
@@ -13,7 +13,7 @@
  * The security policy for the SNS Topic.
  *
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#channel-binding-object">SNS channel binding</a>
- * @see <a href="https://aws.amazon.com/sns/">SNS</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
  * @version 0.1.0
  * @since 1.0.0-RC2

diff --git a/...re/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/channel/SNSChannelPolicyStatement.java b/...re/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/channel/SNSChannelPolicyStatement.java
@@ -12,7 +12,7 @@
  * The security policy for the SNS Topic.
  *
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#channel-binding-object">SNS channel binding</a>
- * @see <a href="https://aws.amazon.com/sns/">SNS</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
  * @version 0.1.0
  * @since 1.0.0-RC2

diff --git a/.../main/java/com/asyncapi/bindings/sns/v0/_1_0/channel/SNSChannelPolicyStatementEffect.java b/.../main/java/com/asyncapi/bindings/sns/v0/_1_0/channel/SNSChannelPolicyStatementEffect.java
@@ -2,6 +2,15 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+/**
+ * The security policy effect for the SNS Topic.
+ *
+ * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#channel-binding-object">SNS channel binding</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
+ * @author Pavel Bodiachevskii
+ * @version 0.1.0
+ * @since 1.0.0-RC2
+ */
 public enum SNSChannelPolicyStatementEffect {
 
     @JsonProperty("Allow")

diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/message/SNSMessageBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/message/SNSMessageBinding.java
@@ -11,7 +11,7 @@
  * Describes SNS message binding.
  *
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#message-binding-object">SNS message binding</a>
- * @see <a href="https://aws.amazon.com/sns/">SNS</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
  * @version 0.1.0
  * @since 1.0.0-RC2

diff --git a/...i-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/operation/SNSOperationBinding.java b/...i-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/operation/SNSOperationBinding.java
@@ -11,7 +11,7 @@
  * Describes SNS operation binding.
  *
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#operation-binding-object">SNS operation binding</a>
- * @see <a href="https://aws.amazon.com/sns/">SNS</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
  * @version 0.1.0
  * @since 1.0.0-RC2

diff --git a/...-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/operation/SNSOperationConsumer.java b/...-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/operation/SNSOperationConsumer.java
@@ -11,7 +11,7 @@
  * Describes SNS operation topic consumer.
  *
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#operation-binding-object">SNS operation binding</a>
- * @see <a href="https://aws.amazon.com/sns/">SNS</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
  * @version 0.1.0
  * @since 1.0.0-RC2

diff --git a/.../java/com/asyncapi/bindings/sns/v0/_1_0/operation/SNSOperationConsumerDeliveryPolicy.java b/.../java/com/asyncapi/bindings/sns/v0/_1_0/operation/SNSOperationConsumerDeliveryPolicy.java
@@ -10,7 +10,7 @@
  * Describes SNS operation delivery policy.
  *
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#operation-binding-object">SNS operation binding</a>
- * @see <a href="https://aws.amazon.com/sns/">SNS</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
  * @version 0.1.0
  * @since 1.0.0-RC2

diff --git a/...api/bindings/sns/v0/_1_0/operation/SNSOperationConsumerDeliveryPolicyBackoffFunction.java b/...api/bindings/sns/v0/_1_0/operation/SNSOperationConsumerDeliveryPolicyBackoffFunction.java
@@ -2,6 +2,15 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+/**
+ * Describes SNS operation delivery policy backoff function.
+ *
+ * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#operation-binding-object">SNS operation binding</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
+ * @author Pavel Bodiachevskii
+ * @version 0.1.0
+ * @since 1.0.0-RC2
+ */
 public enum SNSOperationConsumerDeliveryPolicyBackoffFunction {
 
     @JsonProperty("arithmetic")

diff --git a/...va/com/asyncapi/bindings/sns/v0/_1_0/operation/SNSOperationConsumerFilterPolicyScope.java b/...va/com/asyncapi/bindings/sns/v0/_1_0/operation/SNSOperationConsumerFilterPolicyScope.java
@@ -2,6 +2,15 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+/**
+ * Describes SNS consumer filter policy scope.
+ *
+ * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#operation-binding-object">SNS operation binding</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
+ * @author Pavel Bodiachevskii
+ * @version 0.1.0
+ * @since 1.0.0-RC2
+ */
 public enum SNSOperationConsumerFilterPolicyScope {
 
     @JsonProperty("MessageAttributes")

diff --git a/...c/main/java/com/asyncapi/bindings/sns/v0/_1_0/operation/SNSOperationConsumerProtocol.java b/...c/main/java/com/asyncapi/bindings/sns/v0/_1_0/operation/SNSOperationConsumerProtocol.java
@@ -2,6 +2,15 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+/**
+ * Describes SNS consumer protocol.
+ *
+ * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#operation-binding-object">SNS operation binding</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
+ * @author Pavel Bodiachevskii
+ * @version 0.1.0
+ * @since 1.0.0-RC2
+ */
 public enum SNSOperationConsumerProtocol {
 
     @JsonProperty("http")

diff --git a/...n/java/com/asyncapi/bindings/sns/v0/_1_0/operation/SNSOperationConsumerRedrivePolicy.java b/...n/java/com/asyncapi/bindings/sns/v0/_1_0/operation/SNSOperationConsumerRedrivePolicy.java
@@ -13,7 +13,7 @@
  * Prevent poison pill messages by moving un-processable messages to an SQS dead letter queue.
  *
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#operation-binding-object">SNS operation binding</a>
- * @see <a href="https://aws.amazon.com/sns/">SNS</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
  * @version 0.1.0
  * @since 1.0.0-RC2

diff --git a/...n/java/com/asyncapi/bindings/sns/v0/_1_0/operation/SNSOperationDestinationIdentifier.java b/...n/java/com/asyncapi/bindings/sns/v0/_1_0/operation/SNSOperationDestinationIdentifier.java
@@ -10,7 +10,7 @@
  * Describes SNS operation destination identifier.
  *
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#operation-binding-object">SNS operation binding</a>
- * @see <a href="https://aws.amazon.com/sns/">SNS</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
  * @version 0.1.0
  * @since 1.0.0-RC2

diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/server/SNSServerBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/sns/v0/_1_0/server/SNSServerBinding.java
@@ -11,7 +11,7 @@
  * Describes SNS server binding.
  *
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/sns#server-binding-object">SNS server binding</a>
- * @see <a href="https://aws.amazon.com/sns/">SNS</a>
+ * @see <a href="https://aws.amazon.com/sns/">Amazon SNS</a>
  * @author Pavel Bodiachevskii
  * @version 0.1.0
  * @since 1.0.0-RC2