search

camaraproject / Commonalities

Repository to describe, develop, document and test the common guidelines and assets for CAMARA APIs
Apache License 2.0
14 stars 28 forks source link

Support of 504 Exception in Cloud Events Model #291

Open PedroDiez opened 2 months ago

PedroDiez commented 2 months ago

Problem description

Currently in CAMARA CloudEvents Model, Exception 504 (TIMEOUT) is not considered.

It is proposed to consider this exception for Timeout scenario where API Server generates a timeout (e.g. communication failure with BE component).

To be discussed within Commonalities.

Possible evolution

If agreed, to enhance Notifications and Subscription artifacts to incorporate this exception:

Also to check whether some description enhancement is required in section 12 of API Design Guidelines document.

Alternative solution N/A

Additional context Background discussion in: https://github.com/camaraproject/Commonalities/pull/189#discussion_r1587124198

Issue proposed for MetaRelease Spring 25 - https://github.com/camaraproject/Commonalities/issues/273

bigludo7 commented 1 month ago

Hello @PedroDiez Does this point is specific to the subscription or should it be tackled at whole CAMARA level?

I checked some other other API like in device location or QoD and I do not find the 504 while we have it for Carrier billing.

PedroDiez commented 1 month ago

Hi @bigludo7,

Raised the issue for subscription and notification specifically. Anyway it could be also considered at whole CAMARA level, as the scenario could appear for any API