OpenBankProject / OpenBankProject/OBP-API

Revise endpoints for adding/updating counterparty metadata

Open
#218 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
1.7k
Forks
482
Avg merge
1d 12h
Merged PRs (30d)
15

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the POST and PUT endpoints for the other_accounts metadata/more_info field and compare their JSON input and behavior with the listed counterparty metadata fields. The work is done when the endpoint strategy is decided and the add/update operations have a consistent, documented API shape.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
api
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.