Skip to content

docs: add health and hasInfrastructureIssue to revision schema (PCC-698) #671

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markbackman merged 1 commit into from
Mar 30, 2026
Merged

docs: add health and hasInfrastructureIssue to revision schema (PCC-698) #671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 73 additions & 42 deletions deployment/pipecat-cloud/rest-reference/openapi-agent-create.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,52 +539,83 @@
}
},
"currentRevision": {
"type": "object",
"nullable": true,
"description": "Status of the current (latest) deployment revision",
"properties": {
"deploymentID": {
"type": "string",
"description": "ID of the deployment for this revision"
},
"phase": {
"type": "string",
"description": "Current phase of the revision (e.g., Running, Validating, ScalingDown)"
},
"readyReplicas": {
"type": "integer",
"description": "Number of ready replicas for this revision"
},
"phaseStartedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the current phase started"
}
}
"nullable": true,
"allOf": [{ "$ref": "#/components/schemas/RevisionInfo" }]
},
"previousRevision": {
"type": "object",
"nullable": true,
"description": "Status of the previous deployment revision (present during rolling updates)",
"properties": {
"deploymentID": {
"type": "string",
"description": "ID of the deployment for this revision"
},
"phase": {
"type": "string",
"description": "Current phase of the revision (e.g., ScalingDown, Running)"
},
"readyReplicas": {
"type": "integer",
"description": "Number of ready replicas for this revision"
},
"phaseStartedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the current phase started"
}
}
"nullable": true,
"allOf": [{ "$ref": "#/components/schemas/RevisionInfo" }]
}
}
},
"RevisionInfo": {
"type": "object",
"properties": {
"deploymentID": {
"type": "string",
"description": "ID of the deployment for this revision"
},
"phase": {
"type": "string",
"enum": ["Creating", "Validating", "Active", "Draining", "Failed"],
"description": "Current phase of the revision"
},
"readyReplicas": {
"type": "integer",
"description": "Number of ready replicas for this revision"
},
"phaseStartedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the current phase started"
},
"health": {
"$ref": "#/components/schemas/RevisionHealth"
},
"hasInfrastructureIssue": {
"type": "boolean",
"description": "Set to true when an internal infrastructure component is experiencing issues. If absent, infrastructure is healthy. Contact support if this flag appears."
}
}
},
"RevisionHealth": {
"type": "object",
"description": "Health summary for the agent's code. Present once replicas have started running.",
"properties": {
"ready": {
"type": "boolean",
"description": "Whether the agent code is passing readiness checks"
},
"state": {
"type": "string",
"enum": ["running", "waiting", "terminated"],
"description": "Current state of the agent code"
},
"restartCount": {
"type": "integer",
"description": "Total number of restarts across all replicas"
},
"replicasStarted": {
"type": "integer",
"description": "Number of replicas that have been started (may or may not be ready)"
},
"reason": {
"type": "string",
"description": "Reason for the current state (e.g., CrashLoopBackOff, ImagePullBackOff, OOMKilled, Error)"
},
"lastExitCode": {
"type": "integer",
"description": "Exit code from the most recent crash (e.g., 1 for application error, 137 for out-of-memory)"
},
"lastTerminationReason": {
"type": "string",
"description": "Why the agent code last exited. When reason is CrashLoopBackOff, this reveals the underlying cause (e.g., OOMKilled, Error)"
},
"message": {
"type": "string",
"description": "Detailed error output from the crash, such as a Python traceback. Captured from the agent's stderr/stdout on non-zero exit."
}
}
},
Expand Down
125 changes: 81 additions & 44 deletions deployment/pipecat-cloud/rest-reference/openapi-agent-list-one.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,15 @@
"agentProfile": "agent-1x",
"currentRevision": {
"deploymentID": "4cab03c7-8f53-418d-9c3c-91a1265d179e",
"phase": "Running",
"phase": "Active",
"readyReplicas": 1,
"phaseStartedAt": "2025-04-18T20:30:00.000Z"
"phaseStartedAt": "2025-04-18T20:30:00.000Z",
"health": {
"ready": true,
"state": "running",
"restartCount": 0,
"replicasStarted": 1
}
},
"previousRevision": null
}
Expand Down Expand Up @@ -343,52 +349,83 @@
"nullable": true
},
"currentRevision": {
"type": "object",
"nullable": true,
"description": "Status of the current (latest) deployment revision",
"properties": {
"deploymentID": {
"type": "string",
"description": "ID of the deployment for this revision"
},
"phase": {
"type": "string",
"description": "Current phase of the revision (e.g., Running, Validating, ScalingDown)"
},
"readyReplicas": {
"type": "integer",
"description": "Number of ready replicas for this revision"
},
"phaseStartedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the current phase started"
}
}
"nullable": true,
"allOf": [{ "$ref": "#/components/schemas/RevisionInfo" }]
},
"previousRevision": {
"type": "object",
"nullable": true,
"description": "Status of the previous deployment revision (present during rolling updates)",
"properties": {
"deploymentID": {
"type": "string",
"description": "ID of the deployment for this revision"
},
"phase": {
"type": "string",
"description": "Current phase of the revision (e.g., ScalingDown, Running)"
},
"readyReplicas": {
"type": "integer",
"description": "Number of ready replicas for this revision"
},
"phaseStartedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the current phase started"
}
}
"nullable": true,
"allOf": [{ "$ref": "#/components/schemas/RevisionInfo" }]
}
}
},
"RevisionInfo": {
"type": "object",
"properties": {
"deploymentID": {
"type": "string",
"description": "ID of the deployment for this revision"
},
"phase": {
"type": "string",
"enum": ["Creating", "Validating", "Active", "Draining", "Failed"],
"description": "Current phase of the revision"
},
"readyReplicas": {
"type": "integer",
"description": "Number of ready replicas for this revision"
},
"phaseStartedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the current phase started"
},
"health": {
"$ref": "#/components/schemas/RevisionHealth"
},
"hasInfrastructureIssue": {
"type": "boolean",
"description": "Set to true when an internal infrastructure component is experiencing issues. If absent, infrastructure is healthy. Contact support if this flag appears."
}
}
},
"RevisionHealth": {
"type": "object",
"description": "Health summary for the agent's code. Present once replicas have started running.",
"properties": {
"ready": {
"type": "boolean",
"description": "Whether the agent code is passing readiness checks"
},
"state": {
"type": "string",
"enum": ["running", "waiting", "terminated"],
"description": "Current state of the agent code"
},
"restartCount": {
"type": "integer",
"description": "Total number of restarts across all replicas"
},
"replicasStarted": {
"type": "integer",
"description": "Number of replicas that have been started (may or may not be ready)"
},
"reason": {
"type": "string",
"description": "Reason for the current state (e.g., CrashLoopBackOff, ImagePullBackOff, OOMKilled, Error)"
},
"lastExitCode": {
"type": "integer",
"description": "Exit code from the most recent crash (e.g., 1 for application error, 137 for out-of-memory)"
},
"lastTerminationReason": {
"type": "string",
"description": "Why the agent code last exited. When reason is CrashLoopBackOff, this reveals the underlying cause (e.g., OOMKilled, Error)"
},
"message": {
"type": "string",
"description": "Detailed error output from the crash, such as a Python traceback. Captured from the agent's stderr/stdout on non-zero exit."
}
}
},
Expand Down
Loading
Loading