OpenBankProject / OpenBankProject/OBP-API

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

Aperta
#690 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Scala
Stelle
1.7k
Fork
482
Merge medio
1g 12h
PR unite (30g)
15

Descrizione

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" } } } } }

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia individuando la definizione dell'API che contiene il percorso /banks/{BANK_ID}/atms/ATM_ID e esaminando la relativa operazione GET. Verifica come sono dichiarati i parametri del percorso, quindi aggiorna la definizione in modo che ATM_ID sia rappresentato in modo coerente con BANK_ID e verifica che le dichiarazioni del percorso e dei parametri corrispondano.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
api
Tipo di issue
Bug
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.