Composite Inbound (Group Policies)

The Composite policy allows you to create groups of other policies, for easy reuse across multiple routes. Other policies are referenced by their name.

warning

Be careful not to create circular references which can cause your gateway to fail.

Configuration

The configuration shows how to configure the policy in the 'policies.json' document.

config/policies.json

{
  "name": "my-composite-inbound-policy",
  "policyType": "composite-inbound",
  "handler": {
    "export": "CompositeInboundPolicy",
    "module": "$import(@zuplo/runtime)",
    "options": {
      "policies": [
        "POLICY_1",
        "POLICY_2"
      ]
    }
  }
}

• name the name of your policy instance. This is used as a reference in your routes.
• policyType the identifier of the policy. This is used by the Zuplo UI. Value should be composite-inbound.
• handler/export The name of the exported type. Value should be CompositeInboundPolicy.
• handler/module the module containing the policy. Value should be $import(@zuplo/runtime).
• handler/options The options for this policy:
  • policies

    The list of policy references (beware circular references)

Read more about how policies work