Changes for page Updating your API Gateway Operations
Last modified by Danniar Firdausy on 2024/09/30 17:12
From version 35.53
edited by Danniar Firdausy
on 2024/09/27 15:47
on 2024/09/27 15:47
Change comment:
There is no comment for this version
To version 35.57
edited by Danniar Firdausy
on 2024/09/27 16:42
on 2024/09/27 16:42
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -51,8 +51,10 @@ 51 51 52 52 ==== 3.3.1 Edit Resource ==== 53 53 54 -To have these information explicitly mentioned in your Swagger UI, then you need to define them in your API Catalog in Design. In th atcatalog page, you can find the resource that you want to work with. Given that your account has an edit permission in Design, then you can click "Edit" of that resource to edit its resource path, which will later be reflected in your Swagger UI (see the blue box in the two screenshots below of the Swagger UI).54 +To have these information explicitly mentioned in your Swagger UI, then you need to define them in your API Catalog in Design. In this catalog page, you can find the resource that you want to work with. Given that your account has an edit permission in Design, then you can click "Edit" of that resource to edit its resource path, which will later be reflected in your Swagger UI (see the blue box in the two screenshots below of the Swagger UI). 55 55 56 +[[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--edit-resource.png]] 57 + 56 56 ==== 3.3.2 Edit Operation ==== 57 57 58 58 Next to that, when you click one of your resources in the API Catalog page, then you can also edit the "Operations" attached to that resource (see the screenshot below). ... ... @@ -77,6 +77,11 @@ 77 77 78 78 ==== 3.3.4 Edit Responses ==== 79 79 82 +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 HTTPS status code. The screenshot below shows what are listed in the "Responses" tab is reflected in the Swagger UI. 83 + 84 +[[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--request-description.png]] 85 + 86 + 80 80 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. 81 81 82 82 {{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}}