Skip to Content
Last modified by Danniar Firdausy on 2024/09/30 17:12
From version 35.98
edited by Danniar Firdausy
on 2024/09/30 17:04
Change comment: There is no comment for this version
To version 35.87
edited by Danniar Firdausy
on 2024/09/30 13:01
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -69,7 +69,7 @@
69 69  
70 70  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--tags-summary.png]]
71 71  
72 -Additionally, the value that you use as a "Tags" of an operation will also be reflected in the Gateway message definition page of that integration operation (see the screenshot below).
72 +Additionally, the value that you use as a "Tags" of an operation will also be reflected in the gateway message definition page of that (see the screenshot below).
73 73  
74 74  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--gateway-message-tags.png]]
75 75  
... ... @@ -85,26 +85,22 @@
85 85  
86 86  ==== 3.3.4 Edit Request ====
87 87  
88 -Quite similar with the "Parameters" tab, in the "Request" tab of the API Catalog page, you can also specify the description (see the orange box) and whether the request body is required in the request. Next to that, you can also specify yourself the schema and the example value for the request message (see the blue box). **Note** that this tab is only visible for non-GET operation.
88 +Quite similar with the "Parameters" tab, in the "Request" tab of the API Catalog page, you can also specify the description and whether the request body is required in the request. Note that this tab is only visible for non-GET operation.
89 89  
90 90  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--edit-request.png]]
91 91  
92 -The screenshot below shows how the request's description, schema, and example value are reflected in the Swagger UI.
92 +The screenshot below shows how the Request "Description" is reflected in the Swagger UI.
93 93  
94 -{{info}}eMagiz will generate the schema and example value of the request message for you by default if you leave them empty.{{/info}}
95 -
96 96  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--request-description.png]]
97 97  
98 98  ==== 3.3.5 Edit Responses ====
99 99  
100 -Lastly, the "Responses" tab of the API Catalog page allows you to specify the response description (see the orange box) and example response for a specific HTTP status code. Similar to the "Request", when you edit the response for a certain HTTP status code, under the "Content" section, you can specify the expected "Media type", example message (see the blue box), as well as the schema of the response message (see the green box).
98 +Lastly, the "Responses" tab of the API Catalog page also allows you to specify the response description and example response (along with its "Media type") for a specific HTTP status code.
101 101  
102 102  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--edit-responses.png]]
103 103  
104 -The screenshot below shows what are listed in the "Responses" tab is reflected in the Swagger UI. Note that in the example below we show the example message for the 400 HTTP status code.
102 +The screenshot below shows what are listed in the "Responses" tab is reflected in the Swagger UI.
105 105  
106 -{{info}}eMagiz will generate the schema and example value of the response message for you by default if you leave them empty.{{/info}}
107 -
108 108  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--responses-description.png]]
109 109  
110 110  == 4. Key takeaways ==