Skip to content

Doku: Dokumentation zu "access-forbidden" fehlt in der Liste der Fehlercode

Description of the bug:

Die Liste der Fehlercodes in der Dokumentation ist unvollständig, es fehlt die Beschreibung für den Fehler "access-forbidden". Der Fehler wird erzeugt, wenn beim Abruf eines Token der Scope "https://schema.fitko.de/fit-connect/oauth/scopes/manage-destinations" genutzt wird und versucht wird, mit diesem Token die Liste der Einreichungen abzurufen.

Current behavior:

In der Liste der Fehlercodes gibt es genau einen Treffer für den Status 403: Forbidden, der sich jedoch darauf bezieht, dass versucht wurde, mit einem Token auf eine Destination zuzugreifen, die nicht zu dem Subscriber Client gehört.

https://schema.fitko.de/fit-connect/submission-api/problems/invalid-subject-claim 403 Forbidden Der Abruf dieser Resource ist nur mit dem passenden Client (Token sub claim) möglich.

Expected behavior:

In der Dokumentation sollte die Liste der Fehlercodes einen Eintrag für "type": "https://schema.fitko.de/fit-connect/submission-api/problems/access-forbidden" enthalten und erklären, was der Grund für die Fehlermeldung ist.

https://schema.fitko.de/fit-connect/submission-api/problems/access-forbidden 403 Forbidden Der Abruf der wartenden Einreichungen ist nur möglich, wenn das Token den Scope "manage-destination" enthält.
  1. Spalte mit Endstring vorhanden, sodass verständlich ist, dass die Liste alphabetisch gelistet ist.

Environments:

DEV, TEST, STAGE, PROD

Additional Information:

Schritte zur Reproduktion:

  1. Token mit dem Scope https://schema.fitko.de/fit-connect/oauth/scopes/manage-destinations abrufen
  2. Erfolgreich eine Destination des Clients abrufen.
  3. Abruf der liste der Einreichungen des Clients mit GET ./v1/submissions erzeugt 403: Forbidden

Dependency / relationship to other issues:

Responsible person / team:

Contact persons including contact details:

Screenshots / Logs / Requests:

Seite mit der Liste der Fehlercodes: https://docs.fitko.de/fit-connect/docs/status-and-error-codes/#liste-von-fehlercodes

Fehlermeldung

{
    "type": "https://schema.fitko.de/fit-connect/submission-api/problems/access-forbidden",
    "title": "Forbidden",
    "status": 403,
    "instance": "/v1/submissions",
    "errorcode": "00e5c138-f016-43f3-abd9-9e30dd66d983"
}

Checklist:

  • Add Severity label
  • Add team label
  • Related/affected issues/stories/epics linked and explained in the bug issue
  • Creation of an automated test
  • Bugfix deployed on DEV
  • Bugfix tested on DEV
  • Bugfix deployed on TEST
  • Bugfix tested on TEST (possibly also by the connection project itself)
  • Successful fix reported to Team Operations (Teams channel)
  • Bugfix deployed on STAGE
  • Bugfix tested on STAGE if necessary
  • Bugfix deployed on PROD
  • Bugfix tested on PROD (possibly also by the connection project itself)
  • Final communication by Team Operations if necessary
  • Internal documentation was checked and updated if necessary
  • External documentation has been checked and updated if necessary
  • Updated changelog if necessary

Approach/Solution:

Release version of the artifact:

Edited by Laura Elges