APIIDA · Schema
APIIDA Deployment
An API deployment operation that provisions a specific API version to one or more managed gateways.
API GatewayAPI ManagementFederated API ManagementGovernanceLayer7
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique deployment identifier |
| apiId | string | Identifier of the API being deployed |
| version | string | Version of the API being deployed |
| targetGateways | array | List of target gateway identifiers |
| status | string | Current status of the deployment |
| createdAt | string | Timestamp when the deployment was initiated |
| completedAt | string | Timestamp when the deployment completed or failed |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "apiida-deployment.json",
"title": "APIIDA Deployment",
"description": "An API deployment operation that provisions a specific API version to one or more managed gateways.",
"type": "object",
"required": ["id", "apiId", "version", "targetGateways", "status"],
"properties": {
"id": {
"type": "string",
"description": "Unique deployment identifier"
},
"apiId": {
"type": "string",
"description": "Identifier of the API being deployed"
},
"version": {
"type": "string",
"description": "Version of the API being deployed"
},
"targetGateways": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of target gateway identifiers"
},
"status": {
"type": "string",
"enum": ["pending", "in_progress", "completed", "failed", "rolled_back"],
"description": "Current status of the deployment"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the deployment was initiated"
},
"completedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the deployment completed or failed"
}
}
}