Versions Compared

Version Old Version 7 New Version 8
Changes made by

Janina Mincer-Daszkiewicz

Janina Mincer-Daszkiewicz

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

Levels of estimated error severity.

If an error is present in the context of an API (or endpoint), it applies only to that API (or endpoint).

Status
colourRed
titleCritical

This severity level implies that the process has completely shut down and no further action is possiblealways/usually works badly.

Status
colourYellow
titleMAJOR

This is a significant flaw that causes the system to fail. However, certain parts of the system remain functional.severity level implies that the process works badly in some cases.

Status
colourPurple
titleMEDIUM

This flaw results in unfavorable behavior but the system remains functioning.

Status
colourBlue
titleLOW

This type of flaw won’t cause any major breakdown in the system.

...

Expand
titleGEN-004: Attaching stack trace in error-response

Description

Full stack traces aren't helpful to other partners and are only making reports in the Stats Portal less readable.

Estimated severity

Status
colourBlue
titleLOW

Examples

 

Suggested action

In case of unknown errors it is enough to return some generic message, e.g. "Something went wrong. Administrators have been notified. We'll try to fix it ASAP.", as suggested in the specification.

How communicated

Monitoring system

Problem occurred for at least 2 providers in PROD (link1, link2).

Expand
titleGEN-005: Wrong answer to a CNR or GET as part of CNR

Description

According to specification “Once you receive a change notification, you respond with HTTP 200, and add the received identifiers to a queue. Later on, in the background, you will attempt to update your locally stored information on the received entities (e.g. by calling the get endpoints of the APIs which describe this entity).

You SHOULD NOT try to refresh your data before sending your CNR API response. Refreshing the data (e.g. calling the get endpoint) is a separate operation, and the result of this operation MUST NOT influence the HTTP response of your CNR API”

A number of partner send some error codes instead.

Estimated severity

Status
colourYellow
titleMAJOR

Examples

 

Suggested action

Enforceabsolutecompliance with the specification

How communicated

Email correspondence with providers, testing sessions, GitHub

This error was encountered in a number of mobility systems