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

Docfix: Mentioning content=dynamic for resource docs

Browse Source
This commit is contained in:
simonredfern 2026-01-26 10:51:33 +01:00
parent 7efbf6389a
commit 26f2fd192b
2 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
obp-api/src/main/scala/code/api/util/Glossary.scala
View File

@ -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

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

@ -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")}
|