WSO2 · JSON Structure

Governance Api Action Structure

Action to be taken when a governance policy is violated.

Type: object Properties: 3
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Action is a JSON Structure definition published by WSO2, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

state ruleSeverity type

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/governance-api-action-structure.json",
  "name": "Action",
  "description": "Action to be taken when a governance policy is violated.",
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "description": "The state of the artifact to which the action is linked to.",
      "enum": [
        "API_CREATE",
        "API_UPDATE",
        "API_DEPLOY",
        "API_PUBLISH"
      ],
      "example": "API_DEPLOY",
      "x-enum-varnames": [
        "API_CREATE",
        "API_UPDATE",
        "API_DEPLOY",
        "API_PUBLISH"
      ]
    },
    "ruleSeverity": {
      "type": "string",
      "description": "The severity of the rule to which the action is linked to.",
      "enum": [
        "ERROR",
        "WARN",
        "INFO"
      ],
      "example": "ERROR"
    },
    "type": {
      "type": "string",
      "description": "The type of action to be taken when a governance policy is violated in the given state withe given rule severity.",
      "enum": [
        "BLOCK",
        "NOTIFY"
      ],
      "example": "BLOCK"
    }
  }
}