OpenBankProject / OpenBankProject/OBP-API
404 response codes are being returned but not defined in the spec
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Scala
- Estrellas
- 1.7k
- Forks
- 482
- Merge medio
- 1 d 12 h
- PR fusionados (30 d)
- 15
Descripción
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
}
}
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza localizando la definición de OpenAPI para el endpoint POST mostrado en el ejemplo y compara sus respuestas declaradas con la respuesta 404 observada. Actualiza la especificación para documentar la respuesta correcta y las respuestas de error conocidas; después, verifica que los códigos documentados coincidan con el comportamiento del endpoint.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- openapi, scala
- Área
- api, documentation
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 42/100