artin/OBP-API
1
0
Fork 0
mirror of https://github.com/OpenBankProject/OBP-API.git synced 2026-02-06 16:56:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

docfix regarding firehose endpoints

Browse Source
This commit is contained in:
simonredfern 2025-12-09 00:29:14 +01:00
parent 546363e4b6
commit 4836dee90c
2 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
obp-api/src/main/scala/code/api/v3_0_0/APIMethods300.scala
View File

@ -508,25 +508,25 @@ trait APIMethods300 {
"/banks/BANK_ID/firehose/accounts/views/VIEW_ID",
"Get Firehose Accounts at Bank",
s"""
|Get Accounts which have a firehose view assigned to them.
|Get all Accounts at a Bank.
|
|This endpoint allows bulk access to accounts.
|This endpoint allows bulk access to all accounts at the specified bank.
|
|Requires the CanUseFirehoseAtAnyBank Role
|Requires the CanUseFirehoseAtAnyBank Role or CanUseAccountFirehose Role
|
|To be shown on the list, each Account must have a firehose View linked to it.
|Returns all accounts at the bank. The VIEW_ID parameter determines what account data fields are visible according to the view's permissions.
|
|A firehose view has is_firehose = true
|The view specified must have is_firehose = true
|
|For VIEW_ID try 'owner'
|For VIEW_ID try 'owner' or 'firehose'
|
|optional request parameters for filter with attributes
|Optional request parameters for filtering by account attributes:
|URL params example:
| /banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1
| /banks/some-bank-id/firehose/accounts/views/owner?limit=50&offset=1
|
|to invalid Browser cache, add timestamp query parameter as follow, the parameter name must be `_timestamp_`
|To invalidate browser cache, add timestamp query parameter as follows (the parameter name must be `_timestamp_`):
|URL params example:
| `/banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1&_timestamp_=1596762180358`
| `/banks/some-bank-id/firehose/accounts/views/owner?limit=50&offset=1&_timestamp_=1596762180358`
|
|${userAuthenticationMessage(true)}
|

20
obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala
View File

@ -4392,25 +4392,25 @@ trait APIMethods400 extends MdcLoggable {
"/banks/BANK_ID/firehose/accounts/views/VIEW_ID",
"Get Firehose Accounts at Bank",
s"""
|Get Accounts which have a firehose view assigned to them.
|Get all Accounts at a Bank.
|
|This endpoint allows bulk access to accounts.
|This endpoint allows bulk access to all accounts at the specified bank.
|
|Requires the CanUseFirehoseAtAnyBank Role
|Requires the CanUseFirehoseAtAnyBank Role or CanUseAccountFirehose Role
|
|To be shown on the list, each Account must have a firehose View linked to it.
|Returns all accounts at the bank. The VIEW_ID parameter determines what account data fields are visible according to the view's permissions.
|
|A firehose view has is_firehose = true
|The view specified must have is_firehose = true
|
|For VIEW_ID try 'owner'
|For VIEW_ID try 'owner' or 'firehose'
|
|optional request parameters for filter with attributes
|Optional request parameters for filtering by account attributes:
|URL params example:
| /banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1
| /banks/some-bank-id/firehose/accounts/views/owner?limit=50&offset=1
|
|to invalid Browser cache, add timestamp query parameter as follow, the parameter name must be `_timestamp_`
|To invalidate browser cache, add timestamp query parameter as follows (the parameter name must be `_timestamp_`):
|URL params example:
| `/banks/some-bank-id/firehose/accounts/views/owner?&limit=50&offset=1&_timestamp_=1596762180358`
| `/banks/some-bank-id/firehose/accounts/views/owner?limit=50&offset=1&_timestamp_=1596762180358`
|
|${userAuthenticationMessage(true)}
|