Guideline

An API governance guideline or best practice.

API DesignAPI GovernanceBest PracticesComplianceGuidelinesStandards

Properties

Name	Type	Description
id	string	Unique identifier for the guideline.
category	string	Governance category (e.g., Security, Design, Documentation).
title	string	Short title of the guideline.
description	string	Detailed description of the guideline.
severity	string	Severity level of violation.
tags	array	Tags categorizing the guideline.

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-guideline-schema.json",
  "title": "Guideline",
  "description": "An API governance guideline or best practice.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the guideline.",
      "example": "gl-001"
    },
    "category": {
      "type": "string",
      "description": "Governance category (e.g., Security, Design, Documentation).",
      "example": "Security"
    },
    "title": {
      "type": "string",
      "description": "Short title of the guideline.",
      "example": "Use HTTPS for all API endpoints"
    },
    "description": {
      "type": "string",
      "description": "Detailed description of the guideline."
    },
    "severity": {
      "type": "string",
      "enum": [
        "critical",
        "high",
        "medium",
        "low",
        "info"
      ],
      "description": "Severity level of violation."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Tags categorizing the guideline."
    }
  }
}