From 49dc0b2346a56ef167bcba7f91864844d9dab073 Mon Sep 17 00:00:00 2001 From: Dec Kolakowski Date: Mon, 12 Jun 2023 10:12:06 +0100 Subject: [PATCH] reword descriptions to be declarative --- sns/README.md | 4 ++-- sns/json_schemas/operation.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/sns/README.md b/sns/README.md index 6aede9c6..26a78576 100644 --- a/sns/README.md +++ b/sns/README.md @@ -112,8 +112,8 @@ We support an array of consumers via the **consumers** field. This allows you to | Field Name | Type | Description | |---|:---:|---| | `protocol` | string | **Required.** The protocol that this endpoint receives messages by. Can be `http`, `https`, `email`, `email-json`, `sms`, `sqs`, `application`, `lambda` or `firehose` | -| `endpoint` |[identifier](#identifier)| **Required.** Where are messages being delivered to?| -| `filterPolicy` | [filterPolicy](#filter-policy) | **Optional.** Only receive a subset of messages from the channel, determined by this policy.| +| `endpoint` |[identifier](#identifier)| **Required.** The endpoint messages are delivered to. | +| `filterPolicy` | [filterPolicy](#filter-policy) | **Optional.** Only receive a subset of messages from the channel, determined by this policy. | | `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. | | `redrivePolicy` | [redrivePolicy](#redrive-policy) | **Optional.** Prevent poison pill messages by moving un-processable messages to an SQS dead letter queue. | | `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). | diff --git a/sns/json_schemas/operation.json b/sns/json_schemas/operation.json index c8408cf8..df59a327 100644 --- a/sns/json_schemas/operation.json +++ b/sns/json_schemas/operation.json @@ -76,7 +76,7 @@ }, "properties": { "protocol": { - "description": "What protocol will this endpoint receive messages by?", + "description": "The protocol that this endpoint receives messages by.", "type": "string", "enum": [ "http", @@ -91,7 +91,7 @@ ] }, "endpoint": { - "description": "Where are messages being delivered to?", + "description": "The endpoint messages are delivered to.", "$ref": "#/definitions/identifier" }, "filterPolicy": {