OpenBankProject / OpenBankProject/OBP-API

Revise endpoints for adding/updating counterparty metadata

Aperta
#218 1 commento 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

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.

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 esaminando gli endpoint POST e PUT per il campo other_accounts metadata/more_info e confronta il relativo input JSON e comportamento con i campi metadata della controparte elencati. Il lavoro è completato quando la strategia degli endpoint è stata decisa e le operazioni di add/update hanno una forma API coerente e documentata.

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

Valutazione

Stack tecnologico
scala
Ambito
api
Tipo di issue
Refactoring
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.