Policy

An API governance policy composed of multiple guidelines.

API DesignAPI GovernanceBest PracticesComplianceGuidelinesStandards

Properties

Name	Type	Description
id	string	Policy identifier.
name	string	Policy name.
description	string	Policy description.
guidelines	array	List of guideline IDs included in this policy.
enforcement	string	How this policy is enforced.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apigovernance-dev/refs/heads/main/json-schema/apigovernance-policy-schema.json",
  "title": "Policy",
  "description": "An API governance policy composed of multiple guidelines.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Policy identifier.",
      "example": "pol-001"
    },
    "name": {
      "type": "string",
      "description": "Policy name.",
      "example": "API Security Policy"
    },
    "description": {
      "type": "string",
      "description": "Policy description."
    },
    "guidelines": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of guideline IDs included in this policy."
    },
    "enforcement": {
      "type": "string",
      "enum": [
        "blocking",
        "advisory",
        "informational"
      ],
      "description": "How this policy is enforced."
    }
  }
}