Changes for page Updating your API Gateway Operations
Last modified by Danniar Firdausy on 2024/09/30 17:12
From version 35.67
edited by Danniar Firdausy
on 2024/09/30 11:54
on 2024/09/30 11:54
Change comment:
There is no comment for this version
To version 35.78
edited by Danniar Firdausy
on 2024/09/30 12:39
on 2024/09/30 12:39
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -67,27 +67,35 @@ 67 67 68 68 ==== 3.3.3 Edit Parameters ==== 69 69 70 -Still in the API Catalog page, right next to that "Operations" of that resource, you will see "Parameters", "Request", and "Responses" tabs. 70 +Still in the API Catalog page, right next to that "Operations" of that resource, you will see "Parameters", "Request" (only for non-GET operation), and "Responses" tabs. 71 71 72 - 72 +[[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--edit-parameters.png]] 73 73 74 -In th e"Parameters" tab, you can specify the parameter's name (see the yellow boxbelow), description (see the orange boxbelow), the location of the parameter (see the blue boxbelow), as well as whether the parameter is required or not (see the green boxbelow).74 +In this "Parameters" tab, you can specify the parameter's name (see the yellow box), description (see the orange box), the location of the parameter (see the blue box), as well as whether the parameter is required or not (see the green box). 75 75 76 76 [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--parameters-description.png]] 77 77 78 78 ==== 3.3.4 Edit Request ==== 79 79 80 -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. The screenshotbelowshowshowthe Request"Description"isreflectedintheSwaggerUI.80 +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. 81 81 82 +[[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--edit-request.png]] 83 + 84 +The screenshot below shows how the Request "Description" is reflected in the Swagger UI. 85 + 82 82 [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--request-description.png]] 83 83 84 84 ==== 3.3.5 Edit Responses ==== 85 85 86 - 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.The screenshot below shows what are listed in the "Responses" tab is reflected in the Swagger UI.90 +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. 87 87 92 +[[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--edit-responses.png]] 93 + 94 +The screenshot below shows what are listed in the "Responses" tab is reflected in the Swagger UI. 95 + 88 88 [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--responses-description.png]] 89 89 90 - As is the case with all new versions in Create, the changes will only be effective when you deploy your solution via the eMagiz Deploy phase.98 +Lastly, as is the case with all new versions in Create, the changes will only be effective when you deploy your solution via the eMagiz Deploy phase. 91 91 92 92 {{info}}To ensure that the changes to your Swagger file generated by eMagiz are shown to the end-user, the latest version of the API Gateway runtime infra flow needs to be included in the release and deployed to the correct environment.{{/info}} 93 93