OpenBankProject / OpenBankProject/OBP-API

ATM_ID is a parameter, but is not defined as a path parameter or in the parameters section.

Abierto
#690 0 comentarios 0 reacciones 0 asignados Ver en GitHub

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

Parameter definition issue
ATM_ID should clearly be defined as a parameter but is not currently defined correctly as a path parameter or in the parameters section.

atm_id_not_a_param

"/banks/{BANK_ID}/atms/ATM_ID": { "get": { "tags": ["2_1_0"], "summary": "Get Bank ATM", "security": [{ "directLogin": [] } ], "description": "<p>Returns information about ATM for a single bank specified by BANK_ID and ATM_ID including:</p><ul> <li>Address</li> <li>Geo Location</li> <li>License the data under this endpoint is released under</li></ul><p>Authentication is Optional</p>", "operationId": "2_1_0-getAtm", "parameters": [{ "in": "path", "name": "BANK_ID", "description": "The bank id", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AtmJson" } }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ErrorUserNotLoggedIn" } } } } }

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza localizando la definición de la API que contiene la ruta /banks/{BANK_ID}/atms/ATM_ID y revisando su operación GET. Confirma cómo se declaran allí los parámetros de ruta y, a continuación, actualiza la definición para que ATM_ID se represente de forma coherente con BANK_ID y verifica que las declaraciones de la ruta y de los parámetros coincidan.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Área
api
Tipo de issue
Error
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
48/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.