Skip to content

Commit

Permalink
TASK: Updating RAML types, Postman and OAS definition
Browse files Browse the repository at this point in the history
  • Loading branch information
ct-sdks[bot] committed Jul 29, 2024
1 parent 5b7b1be commit 9dd4d7b
Showing 1 changed file with 19 additions and 18 deletions.
37 changes: 19 additions & 18 deletions oas/api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33916,7 +33916,7 @@ paths:
- "manage_subscriptions:{projectKey}"
operationId: ByProjectKeySubscriptionsPost
description: |-
A test message is sent to ensure the correct configuration of the Destination. If the message cannot be delivered, the Subscription will not be created. The payload of the test message is a notification of type [ResourceCreated](/../api/projects/subscriptions#resourcecreateddeliverypayload) for the `resourceTypeId` `subscription`.
A test notification is sent to ensure the correct configuration of the Destination. If the notification cannot be delivered, the Subscription will not be created. The payload of the test notification is of type [ResourceCreated](/../api/projects/subscriptions#resourcecreateddeliverypayload) for the `resourceTypeId` `subscription`.
requestBody:
content:
application/json:
Expand Down Expand Up @@ -75134,8 +75134,9 @@ components:
mode for backwards compatibility.n"
IAM: "Subscriptions with `IAM` authentication mode are authenticated using Identity
and Access Management (IAM). For this authentication mode, the following user
requires permissions to send messages to the queue or publish to the topic: `arn:aws-cn:iam::417094354346:user/subscriptions`
if the Project is hosted in the China (AWS, Ningxia) Region; `arn:aws:iam::362576667341:user/subscriptions`
requires permissions to send notifications to the queue or publish to the topic:
`arn:aws-cn:iam::417094354346:user/subscriptions` if the Project is hosted in
the China (AWS, Ningxia) Region; `arn:aws:iam::362576667341:user/subscriptions`
for all other [Regions](/../api/general-concepts#regions). This is the recommended
authentication mode, as it doesn't require additional key management.n"
AzureEventGridDestination:
Expand Down Expand Up @@ -75710,27 +75711,27 @@ components:
- ManuallySuspended
x-annotation-package: "Subscription"
x-annotation-enumDescriptions:
Healthy: "Delivers messages as expected."
ConfigurationError: "Messages cannot be delivered with the current configuration.
Healthy: "Delivers notifications as expected."
ConfigurationError: "Notifications cannot be delivered with the current configuration.
Common causes are deleting the Destination queue, deleting access credentials,
or removing the necessary permissions. The configuration can be fixed by re-creating
or removing necessary permissions. You can fix the configuration by re-creating
the configuration on the Destination side, or by setting a new configuration with
the [Change Destination](/../api/projects/subscriptions#change-destination) update
action. If the configuration is fixed, undelivered messages will be delivered
action. After the configuration is fixed, undelivered notifications will be delivered
and the `status` will change to [Healthy](ctp:api:type:SubscriptionHealthStatus).
`ConfigurationError` is automatically turned into `ConfigurationErrorDeliveryStopped`
after some time. For more information, see [Delivery Guarantees](#delivery-guarantees)."
ConfigurationErrorDeliveryStopped: "Does not deliver messages with the current configuration
and the delivery of the messages is no longer attempted. If the configuration
is fixed, undelivered messages are not retained and will not be delivered. The
`status` will change to [Healthy](ctp:api:type:SubscriptionHealthStatus) as soon
as new messages can be delivered."
TemporaryError: "Does not deliver messages temporarily due to reasons other than a
configuration error. For example, the Destination has a temporary outage."
ManuallySuspended: "Does not deliver messages with the current configuration and the
delivery of the messages is no longer attempted. Undelivered messages are not
retained and will not be delivered. The `status` will not automatically change
to [Healthy](ctp:api:type:SubscriptionHealthStatus). To return your subscriptions
ConfigurationErrorDeliveryStopped: "Does not deliver notifications with the current
configuration and the delivery of the notifications is no longer attempted. After
the configuration is fixed, undelivered notifications are not retained and will
not be delivered. The `status` will change to [Healthy](ctp:api:type:SubscriptionHealthStatus)
as soon as new notifications can be delivered."
TemporaryError: "Does not deliver notifications temporarily due to reasons other than
a configuration error. For example, the Destination has a temporary outage."
ManuallySuspended: "Does not deliver notifications with the current configuration
and the delivery of the notifications is no longer attempted. Undelivered notifications
are not retained and will not be delivered. The `status` will not automatically
change to [Healthy](ctp:api:type:SubscriptionHealthStatus). To return your subscriptions
to a [Healthy](ctp:api:type:SubscriptionHealthStatus) status, contact the [Composable
Commerce support team](https://support.commercetools.com/)."
SubscriptionPagedQueryResponse:
Expand Down

0 comments on commit 9dd4d7b

Please sign in to comment.