From c19a4123795d7a2d583abb9f278ce1264b030a91 Mon Sep 17 00:00:00 2001 From: "ct-sdks[bot]" <153784748+ct-sdks[bot]@users.noreply.github.com> Date: Tue, 26 Mar 2024 14:04:39 +0000 Subject: [PATCH] Updated API from documentation release --- api-specs/api/resources/subscriptions.raml | 2 +- .../api/types/subscription/SubscriptionHealthStatus.raml | 5 ++++- api-specs/graphql/schema.sdl | 1 + 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/api-specs/api/resources/subscriptions.raml b/api-specs/api/resources/subscriptions.raml index a9f0dc1df..e760e6378 100644 --- a/api-specs/api/resources/subscriptions.raml +++ b/api-specs/api/resources/subscriptions.raml @@ -151,7 +151,7 @@ post: Healthy 400: description: | - ConfigurationError and ConfigurationErrorDeliveryStopped + ConfigurationError, ConfigurationErrorDeliveryStopped, ManuallySuspended 503: description: | TemporaryError diff --git a/api-specs/api/types/subscription/SubscriptionHealthStatus.raml b/api-specs/api/types/subscription/SubscriptionHealthStatus.raml index 3c156b032..6f27951ee 100644 --- a/api-specs/api/types/subscription/SubscriptionHealthStatus.raml +++ b/api-specs/api/types/subscription/SubscriptionHealthStatus.raml @@ -2,15 +2,18 @@ (package): Subscription displayName: SubscriptionHealthStatus description: | - The health status of the Subscription that indicates whether messages are being delivered to the Destination. + The health status of the Subscription that indicates whether messages are being delivered. type: string (enumDescriptions): Healthy: Delivers messages as expected. ConfigurationError: Messages 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 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 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 to a [Healthy](ctp:api:type:SubscriptionHealthStatus) status, please contact our [support team](https://commercetools.atlassian.net/servicedesk/customer/portal/22). + enum: - Healthy - ConfigurationError - ConfigurationErrorDeliveryStopped - TemporaryError + - ManuallySuspended diff --git a/api-specs/graphql/schema.sdl b/api-specs/graphql/schema.sdl index b48d96f9a..e7ff45d29 100644 --- a/api-specs/graphql/schema.sdl +++ b/api-specs/graphql/schema.sdl @@ -13685,6 +13685,7 @@ enum SubscriptionHealthStatus { ConfigurationErrorDeliveryStopped Healthy TemporaryError + ManuallySuspended } input SubscriptionUpdateAction {