Apiman · JSON Structure

Apiman Plan Structure

Structure representing an API plan in Apiman with associated policies

Type: object Properties: 7
API GatewayAPI ManagementDeveloper PortalJavaOpen Source

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

Properties

organizationId id name description createdBy createdOn policies

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/apiman/main/json-structure/apiman-plan-structure.json",
  "title": "Apiman Plan",
  "description": "Structure representing an API plan in Apiman with associated policies",
  "type": "object",
  "properties": {
    "organizationId": { "type": "string", "description": "Organization identifier" },
    "id": { "type": "string", "description": "Unique identifier for the plan" },
    "name": { "type": "string", "description": "Name of the plan" },
    "description": { "type": "string", "description": "Description of the plan" },
    "createdBy": { "type": "string", "description": "Creator username" },
    "createdOn": { "type": "datetime", "description": "Creation timestamp" },
    "policies": {
      "type": "array",
      "description": "Policies applied to this plan",
      "items": {
        "type": "object",
        "properties": {
          "policyDefinitionId": { "type": "string" },
          "configuration": { "type": "string" }
        }
      }
    }
  }
}