WSO2 · Schema

PolicyAdherenceDetails

Provides adherence details of a policy.

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name	Type	Description
id	string	UUID of the policy.
name	string	Name of the policy.
status	string	Status of the policy's governance compliance.
evaluatedArtifacts	array	Compliance status of the artifacts evaluated against the policy.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/governance-api-policy-adherence-details-schema.json",
  "title": "PolicyAdherenceDetails",
  "description": "Provides adherence details of a policy.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of the policy.",
      "example": "123e4567-e89b-12d3-a456-426614174000"
    },
    "name": {
      "type": "string",
      "description": "Name of the policy.",
      "example": "Policy1"
    },
    "status": {
      "type": "string",
      "description": "Status of the policy's governance compliance.",
      "enum": [
        "FOLLOWED",
        "VIOLATED",
        "UNAPPLIED"
      ],
      "example": "FOLLOWED"
    },
    "evaluatedArtifacts": {
      "type": "array",
      "description": "Compliance status of the artifacts evaluated against the policy.",
      "items": {
        "$ref": "#/components/schemas/ArtifactComplianceForPolicy"
      }
    }
  }
}