Skip to content

Commit 2b575b0

Browse files
authored
Merge pull request #4729 from telefonicaid/issue-4728-kafka-notifications-doc
FIX kafka notifications documentation
2 parents a57aa34 + 4377d45 commit 2b575b0

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/manuals/orion-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5053,8 +5053,8 @@ A `notification` object contains the following subfields:
50535053
| `lastNotification` | Only on retrieval | ISO8601 | Not editable, only present in GET operations. Last notification timestamp in ISO8601 format. |
50545054
| `lastFailure` | Only on retrieval | ISO8601 | Not editable, only present in GET operations. Last failure timestamp in ISO8601 format. Not present if subscription has never had a problem with notifications. |
50555055
| `lastSuccess` | Only on retrieval | ISO8601 | Not editable, only present in GET operations. Timestamp in ISO8601 format for last successful notification. Not present if subscription has never had a successful notification. |
5056-
| `lastFailureReason` | Only on retrieval | string | Not editable, only present in GET operations. Describes the cause of the last failure (i.e. the failure occurred at `lastFailure` time). Not included in MQTT subscriptions.|
5057-
| `lastSuccessCode` | Only on retrieval | number | Not editable, only present in GET operations. the HTTP code (200, 400, 404, 500, etc.) returned by receiving endpoint last time a successful notification was sent (i.e. the success occurred at `lastSuccess` time). Not included in MQTT subscriptions.|
5056+
| `lastFailureReason` | Only on retrieval | string | Not editable, only present in GET operations. Describes the cause of the last failure (i.e. the failure occurred at `lastFailure` time). Not included in MQTT and KAFKA subscriptions.|
5057+
| `lastSuccessCode` | Only on retrieval | number | Not editable, only present in GET operations. the HTTP code (200, 400, 404, 500, etc.) returned by receiving endpoint last time a successful notification was sent (i.e. the success occurred at `lastSuccess` time). Not included in MQTT and KAFKA subscriptions.|
50585058
| `failsCounter` | Only on retrieval | number | Not editable, only present in GET operations. The number of consecutive failing notifications associated to the subscription. `failsCounter` is increased by one each time a notification attempt fails and reset to 0 if a notification attempt successes (`failsCounter` is ommitted in this case).|
50595059
| `maxFailsLimit` || number | Establishes a maximum allowed number of consecutive fails. If the number of fails overpasses the value of `maxFailsLimit` (i.e. at a given moment `failsCounter` is greater than `maxFailsLimit`) then Orion automatically passes the subscription to `inactive` state. A subscription update operation (`PATCH /v2/subscription/subId`) is needed to re-enable the subscription (setting its state `active` again). |
50605060

0 commit comments

Comments
 (0)