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

docfix: hasPersonalEntity flag note

Browse Source
This commit is contained in:
simonredfern 2026-01-20 06:28:28 +01:00
parent 18d1884703
commit 0e9a69dfe6
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2245,7 +2245,12 @@ trait APIMethods400 extends MdcLoggable {
|
|This endpoint returns all available reference types (both static OBP entities and dynamic entities) with example values showing the correct format.
|
|Note: if you set `hasPersonalEntity` = false, then OBP will not generate the CRUD my FooBar endpoints.
|**The hasPersonalEntity flag:**
|
|* If `hasPersonalEntity` = **true** (default): OBP generates both regular endpoints AND personal 'my' endpoints. Data is user-scoped - each user only sees their own records via 'my' endpoints.
|* If `hasPersonalEntity` = **false**: OBP generates ONLY regular endpoints (no 'my' endpoints). Data is shared - all authorized users see the same records.
|
|This flag also affects authorization (role-based vs user-scoped) and whether cascade delete is allowed. See the Dynamic-Entities glossary for full details on data storage differences.
|
|$dynamicEntityNamingExplanation
|
@ -2448,7 +2453,12 @@ trait APIMethods400 extends MdcLoggable {
|
|This endpoint returns all available reference types (both static OBP entities and dynamic entities) with example values showing the correct format.
|
|Note: if you set `hasPersonalEntity` = false, then OBP will not generate the CRUD my FooBar endpoints.
|**The hasPersonalEntity flag:**
|
|* If `hasPersonalEntity` = **true** (default): OBP generates both regular endpoints AND personal 'my' endpoints. Data is user-scoped - each user only sees their own records via 'my' endpoints.
|* If `hasPersonalEntity` = **false**: OBP generates ONLY regular endpoints (no 'my' endpoints). Data is shared - all authorized users see the same records.
|
|This flag also affects authorization (role-based vs user-scoped) and whether cascade delete is allowed. See the Dynamic-Entities glossary for full details on data storage differences.
|
|$dynamicEntityNamingExplanation
|