diff --git a/deployment/pipecat-cloud/rest-reference/openapi-agent-create.json b/deployment/pipecat-cloud/rest-reference/openapi-agent-create.json index c8b5e330..b800c826 100644 --- a/deployment/pipecat-cloud/rest-reference/openapi-agent-create.json +++ b/deployment/pipecat-cloud/rest-reference/openapi-agent-create.json @@ -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." } } }, diff --git a/deployment/pipecat-cloud/rest-reference/openapi-agent-list-one.json b/deployment/pipecat-cloud/rest-reference/openapi-agent-list-one.json index 2acfc992..fd81f98e 100644 --- a/deployment/pipecat-cloud/rest-reference/openapi-agent-list-one.json +++ b/deployment/pipecat-cloud/rest-reference/openapi-agent-list-one.json @@ -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 } @@ -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." } } }, diff --git a/deployment/pipecat-cloud/rest-reference/openapi-agent-update.json b/deployment/pipecat-cloud/rest-reference/openapi-agent-update.json index 76fc8317..d37bcfb6 100644 --- a/deployment/pipecat-cloud/rest-reference/openapi-agent-update.json +++ b/deployment/pipecat-cloud/rest-reference/openapi-agent-update.json @@ -124,9 +124,15 @@ }, "currentRevision": { "deploymentID": "19db578d-808c-420a-a047-87edde4410c1", - "phase": "Running", + "phase": "Active", "readyReplicas": 1, - "phaseStartedAt": "2025-04-19T01:26:00.000Z" + "phaseStartedAt": "2025-04-19T01:26:00.000Z", + "health": { + "ready": true, + "state": "running", + "restartCount": 0, + "replicasStarted": 1 + } }, "previousRevision": null } @@ -310,9 +316,15 @@ }, "currentRevision": { "deploymentID": "19db578d-808c-420a-a047-87edde4410c1", - "phase": "Running", + "phase": "Active", "readyReplicas": 1, - "phaseStartedAt": "2025-04-19T01:26:00.000Z" + "phaseStartedAt": "2025-04-19T01:26:00.000Z", + "health": { + "ready": true, + "state": "running", + "restartCount": 0, + "replicasStarted": 1 + } }, "previousRevision": null } @@ -727,52 +739,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." } } },