Skip to content

Commit 013184b

Browse files
simonredfernsimonredfern
committed
docfix: Resource Docs for Dynamic Entities link to Glossary Item on the
subject
1 parent 84792c1 commit 013184b

File tree

2 files changed

+31
-10
lines changed

2 files changed

+31
-10
lines changed

‎obp-api/src/main/scala/code/api/util/Glossary.scala‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2826,7 +2826,7 @@ object Glossary extends MdcLoggable {
28262826

28272827

28282828
glossaryItems += GlossaryItem(
2829-
title = "Dynamic Entity Intro",
2829+
title = "Dynamic-Entity-Intro",
28302830
description =
28312831
s"""
28322832
|
@@ -2877,7 +2877,7 @@ object Glossary extends MdcLoggable {
28772877
""".stripMargin)
28782878

28792879
glossaryItems += GlossaryItem(
2880-
title = "Dynamic Entities",
2880+
title = "Dynamic-Entities",
28812881
description =
28822882
s"""
28832883
|
@@ -2936,7 +2936,7 @@ object Glossary extends MdcLoggable {
29362936
| * PUT /CustomerPreferences/ID
29372937
| * DELETE /CustomerPreferences/ID
29382938
|
2939-
|2. **Personal 'my' endpoints** - User-scoped access (see ${getGlossaryItemLink("My Dynamic Entities")})
2939+
|2. **Personal 'my' endpoints** - User-scoped access (see ${getGlossaryItemLink("My-Dynamic-Entities")})
29402940
| * POST /my/CustomerPreferences
29412941
| * GET /my/CustomerPreferences
29422942
| * GET /my/CustomerPreferences/ID
@@ -2983,14 +2983,14 @@ object Glossary extends MdcLoggable {
29832983
|* Rapid prototyping of new features
29842984
|* Extension of core banking data model
29852985
|
2986-
|For user-scoped Dynamic Entities, see ${getGlossaryItemLink("My Dynamic Entities")}
2986+
|For user-scoped Dynamic Entities, see ${getGlossaryItemLink("My-Dynamic-Entities")}
29872987
|
2988-
|For more detailed information about managing Dynamic Entities, see ${getGlossaryItemLink("Dynamic Entity Intro")}
2988+
|For more detailed information about managing Dynamic Entities, see ${getGlossaryItemLink("Dynamic-Entity-Intro")}
29892989
|
29902990
""".stripMargin)
29912991

29922992
glossaryItems += GlossaryItem(
2993-
title = "My Dynamic Entities",
2993+
title = "My-Dynamic-Entities",
29942994
description =
29952995
s"""
29962996
|
@@ -3054,7 +3054,7 @@ object Glossary extends MdcLoggable {
30543054
|* CanCreateSystemLevelDynamicEntity - To create system level dynamic entities
30553055
|* CanCreateBankLevelDynamicEntity - To create bank level dynamic entities
30563056
|
3057-
|For general information about Dynamic Entities, see ${getGlossaryItemLink("Dynamic Entities")}
3057+
|For general information about Dynamic Entities, see ${getGlossaryItemLink("Dynamic-Entities")}
30583058
|
30593059
""".stripMargin)
30603060

‎obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1535,7 +1535,9 @@ trait APIMethods400 extends MdcLoggable {
15351535
"GET",
15361536
"/management/system-dynamic-entities",
15371537
"Get System Dynamic Entities",
1538-
s"""Get all System Dynamic Entities """,
1538+
s"""Get all System Dynamic Entities.
1539+
|
1540+
|For more information see ${Glossary.getGlossaryItemLink("Dynamic-Entities")} """,
15391541
EmptyBody,
15401542
ListResult(
15411543
"dynamic_entities",
@@ -1570,7 +1572,9 @@ trait APIMethods400 extends MdcLoggable {
15701572
"GET",
15711573
"/management/banks/BANK_ID/dynamic-entities",
15721574
"Get Bank Level Dynamic Entities",
1573-
s"""Get all the bank level Dynamic Entities for one bank.""",
1575+
s"""Get all the bank level Dynamic Entities for one bank.
1576+
|
1577+
|For more information see ${Glossary.getGlossaryItemLink("Dynamic-Entities")}""",
15741578
EmptyBody,
15751579
ListResult(
15761580
"dynamic_entities",
@@ -1624,6 +1628,8 @@ trait APIMethods400 extends MdcLoggable {
16241628
"/management/system-dynamic-entities",
16251629
"Create System Level Dynamic Entity",
16261630
s"""Create a system level Dynamic Entity.
1631+
|
1632+
|For more information about Dynamic Entities see ${Glossary.getGlossaryItemLink("Dynamic-Entities")}
16271633
|
16281634
|
16291635
|${userAuthenticationMessage(true)}
@@ -1670,6 +1676,8 @@ trait APIMethods400 extends MdcLoggable {
16701676
"/management/banks/BANK_ID/dynamic-entities",
16711677
"Create Bank Level Dynamic Entity",
16721678
s"""Create a Bank Level DynamicEntity.
1679+
|
1680+
|For more information about Dynamic Entities see ${Glossary.getGlossaryItemLink("Dynamic-Entities")}
16731681
|
16741682
|${userAuthenticationMessage(true)}
16751683
|
@@ -1735,6 +1743,8 @@ trait APIMethods400 extends MdcLoggable {
17351743
"/management/system-dynamic-entities/DYNAMIC_ENTITY_ID",
17361744
"Update System Level Dynamic Entity",
17371745
s"""Update a System Level Dynamic Entity.
1746+
|
1747+
|For more information see ${Glossary.getGlossaryItemLink("Dynamic-Entities")}
17381748
|
17391749
|
17401750
|${userAuthenticationMessage(true)}
@@ -1778,6 +1788,8 @@ trait APIMethods400 extends MdcLoggable {
17781788
"/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID",
17791789
"Update Bank Level Dynamic Entity",
17801790
s"""Update a Bank Level DynamicEntity.
1791+
|
1792+
|For more information see ${Glossary.getGlossaryItemLink("Dynamic-Entities")}
17811793
|
17821794
|
17831795
|${userAuthenticationMessage(true)}
@@ -1821,6 +1833,8 @@ trait APIMethods400 extends MdcLoggable {
18211833
"/management/system-dynamic-entities/DYNAMIC_ENTITY_ID",
18221834
"Delete System Level Dynamic Entity",
18231835
s"""Delete a DynamicEntity specified by DYNAMIC_ENTITY_ID.
1836+
|
1837+
|For more information see ${Glossary.getGlossaryItemLink("Dynamic-Entities")}/
18241838
|
18251839
|""",
18261840
EmptyBody,
@@ -1862,6 +1876,8 @@ trait APIMethods400 extends MdcLoggable {
18621876
"/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID",
18631877
"Delete Bank Level Dynamic Entity",
18641878
s"""Delete a Bank Level DynamicEntity specified by DYNAMIC_ENTITY_ID.
1879+
|
1880+
|For more information see ${Glossary.getGlossaryItemLink("Dynamic-Entities")}/
18651881
|
18661882
|""",
18671883
EmptyBody,
@@ -1888,7 +1904,9 @@ trait APIMethods400 extends MdcLoggable {
18881904
"GET",
18891905
"/my/dynamic-entities",
18901906
"Get My Dynamic Entities",
1891-
s"""Get all my Dynamic Entities.""",
1907+
s"""Get all my Dynamic Entities (definitions I created).
1908+
|
1909+
|For more information see ${Glossary.getGlossaryItemLink("My-Dynamic-Entities")}""",
18921910
EmptyBody,
18931911
ListResult(
18941912
"dynamic_entities",
@@ -1922,6 +1940,8 @@ trait APIMethods400 extends MdcLoggable {
19221940
"/my/dynamic-entities/DYNAMIC_ENTITY_ID",
19231941
"Update My Dynamic Entity",
19241942
s"""Update my DynamicEntity.
1943+
|
1944+
|For more information see ${Glossary.getGlossaryItemLink("My-Dynamic-Entities")}/
19251945
|
19261946
|
19271947
|${userAuthenticationMessage(true)}
@@ -1984,6 +2004,7 @@ trait APIMethods400 extends MdcLoggable {
19842004
"Delete My Dynamic Entity",
19852005
s"""Delete my DynamicEntity specified by DYNAMIC_ENTITY_ID.
19862006
|
2007+
|For more information see ${Glossary.getGlossaryItemLink("My-Dynamic-Entities")}
19872008
|""",
19882009
EmptyBody,
19892010
EmptyBody,

0 commit comments

Comments
 (0)