From 0e9a69dfe675008430156e0b30d9346b947f326e Mon Sep 17 00:00:00 2001 From: simonredfern Date: Tue, 20 Jan 2026 06:28:28 +0100 Subject: [PATCH] docfix: hasPersonalEntity flag note --- .../main/scala/code/api/v4_0_0/APIMethods400.scala | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala b/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala index 1e52b797a..123c6390f 100644 --- a/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala +++ b/obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala @@ -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 |