Skip to Content
Last modified by Danniar Firdausy on 2024/09/30 17:12
From version 35.64
edited by Danniar Firdausy
on 2024/09/30 11:42
Change comment: There is no comment for this version
To version 35.62
edited by Danniar Firdausy
on 2024/09/27 16:44
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -61,23 +61,23 @@
61 61  
62 62  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--edit-operation.png]]
63 63  
64 -In this "Edit Operation" pop-up page, you can specify the HTTP method of that operation. Next to that, you can also specify the "Tags" and the "Summary" of that operation. The "Summary" here shortly describes your resource path and will be shown beside the path of your resource. Whereas, the "Tags" here will group together the operations with the same tag names in your Swagger UI. Thus, the screenshot below shows an example of "Financials" (see the orange box below) as the tag for {{code language='xml'}}/debtor/{code}{{/code}} and {{code}}/invoice{{/code}} operations along with the summaries of each of the resource paths (see the red box below).
64 +In this "Edit Operation" pop-up page, you can specify the HTTP method of that operation. Next to that, you can also specify the "Tags" and the "Summary" of that operation. The "Summary" here shortly describes your resource path and will be shown beside the path of your resource. Whereas, the "Tags" here will group together the operations with the same tag names in your Swagger UI. Thus, the screenshot below shows an example of "Financials" as the tag for {{code language='xml'}}/debtor/{code}{{/code}} and {{code}}/invoice{{/code}} operations (see the orange box below) along with the summaries of each of the resource paths (see the red box below).
65 65  
66 66  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--tags-summary.png]]
67 67  
68 -==== 3.3.3 Edit Parameters ====
68 +==== 3.3.2 Edit Parameters ====
69 69  
70 70  Still in the API Catalog page, right next to that "Operations" of that resource, you will see "Parameters", "Request", and "Responses" tabs. In the "Parameters" tab, you can specify the parameter's name (see the yellow box below), description (see the orange box below), the location of the parameter (see the blue box below), as well as whether the parameter is required or not (see the green box below).
71 71  
72 72  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--parameters-description.png]]
73 73  
74 -==== 3.3.4 Edit Request ====
74 +==== 3.3.3 Edit Request ====
75 75  
76 76  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 screenshot below shows how the Request "Description" is reflected in the Swagger UI.
77 77  
78 78  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--request-description.png]]
79 79  
80 -==== 3.3.5 Edit Responses ====
80 +==== 3.3.4 Edit Responses ====
81 81  
82 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 HTTP status code. The screenshot below shows what are listed in the "Responses" tab is reflected in the Swagger UI.
83 83