OpenBankProject / OpenBankProject/OBP-API
404 response codes are being returned but not defined in the spec
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Scala
- Sterne
- 1.7k
- Forks
- 482
- Ø Merge
- 1 T. 12 Std.
- Gemergte PRs (30 T.)
- 15
Beschreibung
Spec definition issue
All expected response codes should be defined in the OAS as follows:
'The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.'
Example:
404 response codes are being returned but not defined in the spec
{
"httpMethod": "POST",
"url": "http://apisandbox.openbankproject.com/obp/v3.0.0/banks/nordea/accounts/nordea-test-160273",
"apiRequestParameters": [{
"paramIn": "body",
"parameterName": "body",
"parameterValue": "Enter_value_here",
"required": true
}, {
"paramIn": "path",
"parameterName": "ACCOUNT_ID",
"parameterValue": "nordea-test-160273",
"required": true
}, {
"paramIn": "path",
"parameterName": "BANK_ID",
"parameterValue": "nordea",
"required": true
}
],
"apiRequestResponses": [{
"responseCode": "400"
}
],
"authorization": {
"locatedIn": "Header",
"authKey": "Authorization",
"authValue": "DirectLogin token=\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyIiOiIifQ.tQDG3T1wOpEtQYultU8U6iyPWx2mBV2UM3SAOHpaRjo\""
},
"apiRequestResult": {
"statusCode": "404",
"body": "<!DOCTYPE html>\n<html> <body>The Requested URL /obp/v3.0.0/banks/nordea/accounts/nordea-test-160273 was not found on this server</body> </html> \n ",
"assertedResult": 5
}
}
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die OpenAPI-Definition für den im Beispiel gezeigten POST-Endpunkt zu finden, und vergleiche die darin deklarierten Antworten mit der beobachteten 404-Antwort. Aktualisiere die Spezifikation, um die erfolgreiche Antwort und die bekannten Fehlerantworten zu dokumentieren, und überprüfe anschließend, dass die dokumentierten Codes dem Verhalten des Endpunkts entsprechen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- openapi, scala
- Bereich
- api, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100