Skip to content

Commit 616c4fe

Browse files
authored
Merge pull request #1865 from slahirucd7/pe
Improve custom policy defining doc considering the same parameter names and order requirement
2 parents a7c641c + f145506 commit 616c4fe

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

en/developer-docs/docs/api-management/api-policies/attach-and-manage-policies.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,9 @@ public function validateResponseHeader(mediation:Context ctx, http:Request req,
194194
In this guide, you are not going to make any changes to the `Fault` flow. Therefore, you can remove the `Fault` flow stub from the `policy.bal` file.
195195

196196
!!! note
197-
The **@mediation:RequestFlow**, **@mediation:ResponseFlow**, and **@mediation:FaultFlow** annotations are bound with the keywords in the `Ballerina.toml`. Therefore, the changes you make to the policy stubs should reflect in the `Ballerina.toml` file. For example, if the policy is applicable only on the request and response paths, you can remove the **@mediation:FaultFlow** annotation from the policy. Then, you **MUST** also remove the **choreo-apim-mediation-fault-flow** keyword from the generated `Ballerina.toml` file. If you do not do so, the Ballerina compiler will show an error at compile time.
197+
- The **@mediation:RequestFlow**, **@mediation:ResponseFlow**, and **@mediation:FaultFlow** annotations are bound with the keywords in the `Ballerina.toml`. Therefore, the changes you make to the policy stubs should reflect in the `Ballerina.toml` file. For example, if the policy is applicable only on the request and response paths, you can remove the **@mediation:FaultFlow** annotation from the policy. Then, you **MUST** also remove the **choreo-apim-mediation-fault-flow** keyword from the generated `Ballerina.toml` file. If you do not do so, the Ballerina compiler will show an error at compile time.
198+
199+
- If you choose not to remove the Fault flow, ensure that the parameter order and names are consistent with defined Request and Response flows.
198200

199201
#### Publish as a private custom policy
200202

en/theme/material/partials/copyright_2.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
-#}
44
<div class="footer-copyright-right">
55
<div class="footer-copyright-top">
6-
Copyright &copy; <a href="https://wso2.com/">WSO2</a> LLC (2023-2024)
6+
Copyright &copy; <a href="https://wso2.com/">WSO2</a> LLC (2023-2025)
77
</div>
88
<div class="footer-copyright-bottom">
99
Content licensed under <a href="https://creativecommons.org/licenses/by/4.0">CC By 4.0.</a> | Sample code

0 commit comments

Comments
 (0)