OpenBankProject / OpenBankProject/OBP-API

Revise endpoints for adding/updating counterparty metadata

Offen
#218 1 Kommentar 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

Please review endpoints which add/update Counterparty metadata:

"metadata":{
    "public_alias":"ALIAS_1C5520",
    "private_alias":null,
    "more_info":null,
    "URL":null,
    "image_URL":null,
    "open_corporates_URL":null,
    "corporate_location":null,
    "physical_location":null
 }

For instance we have one endpoint for adding and one for updating of field "more_info":

  • POST /banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info
  • PUT /banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/other_accounts/OTHER_ACCOUNT_ID/metadata/more_info
    which use next type of JSON as input :
{  "more_info":"More info..."}

We should consider can we reduce two endpoints into one.

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 mit der Überprüfung der POST- und PUT-Endpunkte für das Feld other_accounts metadata/more_info und vergleiche deren JSON-Eingabe und Verhalten mit den aufgeführten Metadatenfeldern für Gegenparteien. Die Arbeit ist abgeschlossen, wenn die Strategie für die Endpunkte festgelegt ist und die Add/Update-Operationen eine konsistente, dokumentierte API-Struktur haben.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
scala
Bereich
api
Issue-Typ
Refactoring
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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