WSO2 · JSON Structure

Publisher Api Gateway Policy Mappings Structure

GatewayPolicyMappings schema from WSO2 API Manager

Type: object Properties: 5 Required: 2
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Gateway Policy Mappings is a JSON Structure definition published by WSO2, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id policyMapping description displayName appliedGatewayLabels

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-structure/publisher-api-gateway-policy-mappings-structure.json",
  "name": "Gateway Policy Mappings",
  "description": "GatewayPolicyMappings schema from WSO2 API Manager",
  "type": "object",
  "required": [
    "policyMapping",
    "displayName"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "121223q41-24141-124124124-12414"
    },
    "policyMapping": {
      "$ref": "#/components/schemas/APIOperationPolicies"
    },
    "description": {
      "type": "string",
      "description": "A brief description about the policy mapping",
      "example": "Set header value to the request with item type and response header set with served server name"
    },
    "displayName": {
      "type": "string",
      "description": "Meaningful name to identify the policy mapping",
      "example": "item_type_setter"
    },
    "appliedGatewayLabels": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "gatewayLabel_1"
      }
    }
  }
}