APIIDA · Schema

APIIDA API

An API managed within the APIIDA API Control Plane, representing a logical API resource that can be versioned and deployed to gateways.

API GatewayAPI ManagementFederated API ManagementGovernanceLayer7

Properties

Name Type Description
id string Unique identifier for the API
name string Display name of the API
description string Human-readable description of the API
status string Current lifecycle status of the API
tags array Tags for categorizing the API
currentVersion string The current active version identifier
createdAt string Timestamp when the API was created
updatedAt string Timestamp when the API was last updated
View JSON Schema on GitHub

JSON Schema

apiida-api.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "apiida-api.json",
  "title": "APIIDA API",
  "description": "An API managed within the APIIDA API Control Plane, representing a logical API resource that can be versioned and deployed to gateways.",
  "type": "object",
  "required": ["id", "name"],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the API"
    },
    "name": {
      "type": "string",
      "description": "Display name of the API"
    },
    "description": {
      "type": "string",
      "description": "Human-readable description of the API"
    },
    "status": {
      "type": "string",
      "enum": ["draft", "published", "deprecated", "retired"],
      "description": "Current lifecycle status of the API"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Tags for categorizing the API"
    },
    "currentVersion": {
      "type": "string",
      "description": "The current active version identifier"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the API was created"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the API was last updated"
    }
  }
}