OpenBankProject / OpenBankProject/OBP-API

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

Offen
#690 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

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

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die API-Definition zu finden, die den Pfad /banks/{BANK_ID}/atms/ATM_ID enthält, und überprüfe ihre GET-Operation. Bestätige, wie dort Pfadparameter deklariert sind, aktualisiere dann die Definition so, dass ATM_ID konsistent mit BANK_ID dargestellt wird, und verifiziere, dass Pfad- und Parameterdeklarationen übereinstimmen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
api
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.