OpenBankProject / OpenBankProject/OBP-API
404 response codes are being returned but not defined in the spec
Personne n'a encore pris cette issue.
- Langage dominant
- Scala
- Étoiles
- 1.7k
- Forks
- 482
- Merge moyen
- 1 j 12 h
- PR mergées (30 j)
- 15
Description
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
}
}
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par localiser la définition OpenAPI du endpoint POST présenté dans l’exemple et comparez les réponses déclarées avec la réponse 404 observée. Mettez à jour la spécification pour documenter la réponse en cas de succès et les réponses d’erreur connues, puis vérifiez que les codes documentés correspondent au comportement de l’endpoint.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- openapi, scala
- Domaine
- api, documentation
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 42/100