Skip to Content
Last modified by Danniar Firdausy on 2024/09/30 17:12
From version 23.1
edited by eMagiz
on 2022/06/10 09:34
Change comment: There is no comment for this version
To version 27.1
edited by Eva Torken
on 2023/08/25 11:31
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.eMagiz
1 +XWiki.etorken
Default language
... ... @@ -1,0 +1,1 @@
1 +en
Content
... ... @@ -4,9 +4,6 @@
4 4  
5 5  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
6 6  
7 -* Last update: June 28th, 2021
8 -* Required reading time: 6 minutes
9 -
10 10  == 1. Prerequisites ==
11 11  
12 12  * Basic knowledge of the eMagiz platform
... ... @@ -21,8 +21,6 @@
21 21  * Updating can happen from Create
22 22  * Both situations have a different impact
23 23  
24 -
25 -
26 26  == 3. Updating your API Gateway Operations ==
27 27  
28 28  In our crash course on the API Gateway pattern, we have learned about setting up the API Gateway. However, we did not yet delve into the specifics of how to update your existing API Gateway solution. In this microlearning, we will focus on updating the Design phase of your API Gateway (and the subsequent steps) and we will focus on updating the Create phase of your API Gateway (and the subsequent steps). This to learn the impact of updates and to learn how we can achieve this.
... ... @@ -43,7 +43,7 @@
43 43  * When you change something to the configuration of the backend operation (i.e. endpoint, parameter, system request/response) the change will **only** impact the specific exit gate
44 44  * When you change the gateway request/response message (with transformation) the change will impact **both** the all-entry and the specific exit gate
45 45  
46 -In all cases, you need a version bump of the flow to which you can relate the change. For exit gates, this process is identical to when you do a version bump of any messaging flow after updating for example a CDM message or message mapping. However, when you update something on the all-entry level this becomes less simple. Because eMagiz does not only pre-configure the resources for you in Create but the complete all-entry flow you **need** a reset of the all-entry to reflect these changes. To reset a flow simply access the context menu on flow level in Create (via a right-mouse click) and press Reset flow.
41 +In some cases, version bumps are needed to confirm the change in Create. For exit gates, this process is identical to when you do a version bump of any messaging flow after updating for example a CDM message or message mapping. However, when you update something on the all-entry level what is needed differs. In case of a security change you need to reset the all-entry flow. To reset a flow simply access the context menu on flow level in Create (via a right-mouse click) and press Reset flow. In case of all other changes, no reset is needed, just a version bump.
47 47  
48 48  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--reset-flow-context-menu.png]]
49 49  
... ... @@ -51,15 +51,6 @@
51 51  
52 52  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--reset-flow-warning.png]]
53 53  
54 -After you reset your all-entry eMagiz will update the following:
55 -
56 -* Swagger UI that is shown to clients via the Swagger documentation page
57 -* Parameter references
58 -* Error Handling
59 -* Many more
60 -
61 -This all depends on which changes you **made** on the Design level.
62 -
63 63  === 3.2 Updating from Create ===
64 64  
65 65  Apart from updating your API Gateway solution in Create, you can only update parts of the API Gateway solution in Create. Here we mainly talk about changing the gateway messages. Any other changes on the 'exit gate' level have no special impact compared to changing parts of other flows. We discern two parts of updating a (gateway) message that you can execute in the Create phase:
... ... @@ -71,15 +71,8 @@
71 71  
72 72  As is the case with all new versions in Create the changes will only be effectuated when you deploy your solution via the Deploy phase of eMagiz.
73 73  
60 +== 4. Key takeaways ==
74 74  
75 -
76 -== 4. Assignment ==
77 -
78 -Think of three changes you want to apply to an API Gateway solution and see if you can determine which flow in Create needs an update.
79 -This assignment can be completed with the help of the (Academy) project that you have created/used in the previous assignment.
80 -
81 -== 5. Key takeaways ==
82 -
83 83  * Updating can happen from Design
84 84  * Updating can happen from Create
85 85  * Both situations have a different impact
... ... @@ -87,14 +87,9 @@
87 87  * Updating from Create does not involve a reset
88 88  * Updating from Design involves a reset
89 89  
69 +== 5. Suggested Additional Readings ==
90 90  
91 -
92 -== 6. Suggested Additional Readings ==
93 -
94 94  If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
95 95  
96 -== 7. Silent demonstration video ==
97 97  
98 -As this is a more theoretical microlearning we did not provide a video for this one.
99 -
100 100  )))((({{toc/}}))){{/container}}{{/container}}