From 26f2fd192b1eb3856d38f13c5f3b708ca6e42c3c Mon Sep 17 00:00:00 2001 From: simonredfern Date: Mon, 26 Jan 2026 10:51:33 +0100 Subject: [PATCH] Docfix: Mentioning content=dynamic for resource docs --- .../main/scala/code/api/util/Glossary.scala | 21 +++++++++++++++++++ .../scala/code/api/v4_0_0/APIMethods400.scala | 16 ++++++++++++++ 2 files changed, 37 insertions(+) diff --git a/obp-api/src/main/scala/code/api/util/Glossary.scala b/obp-api/src/main/scala/code/api/util/Glossary.scala index fbab12e00..faf074d32 100644 --- a/obp-api/src/main/scala/code/api/util/Glossary.scala +++ b/obp-api/src/main/scala/code/api/util/Glossary.scala @@ -367,6 +367,8 @@ object Glossary extends MdcLoggable { | |Dynamic Entities can be found under the **More** list of API Versions. Look for versions starting with `OBPdynamic-entity` or similar in the version selector. | + |To programmatically discover all Dynamic Entity endpoints, use: `GET /resource-docs/API_VERSION/obp?content=dynamic` + | |For more information about Dynamic Entities see ${getGlossaryItemLink("Dynamic-Entities")} | |### Creating Favorites @@ -3316,6 +3318,25 @@ object Glossary extends MdcLoggable { |* PUT /management/system-dynamic-entities/DYNAMIC_ENTITY_ID - Update entity definition |* DELETE /management/system-dynamic-entities/DYNAMIC_ENTITY_ID - Delete entity (and all its data) | +|**Discovering Dynamic Entity Endpoints (for application developers):** +| +|Once Dynamic Entities are created, their auto-generated CRUD endpoints are documented in the Resource Docs API. To programmatically discover all available Dynamic Entity endpoints, use: +| +|``` +|GET /resource-docs/API_VERSION/obp?content=dynamic +|``` +| +|For example: `GET /resource-docs/v5.1.0/obp?content=dynamic` +| +|This returns documentation for all dynamic endpoints (both Dynamic Entities and Dynamic Endpoints) including: +| +|* Endpoint paths and HTTP methods +|* Request and response schemas with examples +|* Required roles and authentication +|* Field descriptions and types +| +|You can also get this documentation in OpenAPI/Swagger format for code generation and API client tooling. +| |**Required roles to manage Dynamic Entities:** | |* CanCreateSystemLevelDynamicEntity 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 123c6390f..efd26036a 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 @@ -2221,6 +2221,14 @@ trait APIMethods400 extends MdcLoggable { | |FYI Dynamic Entities and Dynamic Endpoints are listed in the Resource Doc endpoints by adding content=dynamic to the path. They are cached differently to static endpoints. | + |**Discovering the generated endpoints:** + | + |After creating a Dynamic Entity, OBP automatically generates CRUD endpoints. To discover these endpoints programmatically, use: + | + |`GET /resource-docs/API_VERSION/obp?content=dynamic` + | + |This returns documentation for all dynamic endpoints including paths, schemas, and required roles. + | |For more information about Dynamic Entities see ${Glossary .getGlossaryItemLink("Dynamic-Entities")} | @@ -2430,6 +2438,14 @@ trait APIMethods400 extends MdcLoggable { | |FYI Dynamic Entities and Dynamic Endpoints are listed in the Resource Doc endpoints by adding content=dynamic to the path. They are cached differently to static endpoints. | + |**Discovering the generated endpoints:** + | + |After creating a Dynamic Entity, OBP automatically generates CRUD endpoints. To discover these endpoints programmatically, use: + | + |`GET /resource-docs/API_VERSION/obp?content=dynamic` + | + |This returns documentation for all dynamic endpoints including paths, schemas, and required roles. + | |For more information about Dynamic Entities see ${Glossary .getGlossaryItemLink("Dynamic-Entities")} |