WSO2 · JSON Structure

Governance Api Artifact Compliance Status Structure

Provides compliance status of an artifact.

Type: object Properties: 5
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

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

Properties

id status info policyAdherenceSummary severityBasedRuleViolationSummary

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-artifact-compliance-status-structure.json",
  "name": "ArtifactComplianceStatus",
  "description": "Provides compliance status of an artifact.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of the API.",
      "example": "123e4567-e89b-12d3-a456-426614174000"
    },
    "status": {
      "type": "string",
      "description": "Status of the API's governance compliance.",
      "enum": [
        "COMPLIANT",
        "NON-COMPLIANT",
        "NOT-APPLICABLE",
        "PENDING"
      ],
      "example": "COMPLIANT"
    },
    "info": {
      "$ref": "#/components/schemas/ArtifactInfo"
    },
    "policyAdherenceSummary": {
      "$ref": "#/components/schemas/PolicyAdherenceSummary"
    },
    "severityBasedRuleViolationSummary": {
      "type": "array",
      "description": "Summary of severity based rule violations.",
      "items": {
        "$ref": "#/components/schemas/SeverityBasedRuleViolationCount"
      }
    }
  }
}