PipelineDebuggerResponse interface
Response DTO returned by the pipeline debugger POST endpoint.
Properties
| analysis |
When the analysis has already completed for this build, contains the cached result so the caller does not need a separate GET request. Null when the job is newly queued or still in progress. |
| auth |
GitHub OAuth authorization URL. Present only when NeedsAuth is true. |
| message | Human-readable status message (e.g. "queued successfully", "already running", or "Analysis already completed"). |
| needs |
True when the user needs to authorize the GitHub Copilot app before analysis can proceed. The client should open a popup to AuthUrl and retry after authorization completes. |
Property Details
analysisResult
When the analysis has already completed for this build, contains the cached result so the caller does not need a separate GET request. Null when the job is newly queued or still in progress.
analysisResult: PipelineDebuggerAnalysisOutputProperty Value
authUrl
GitHub OAuth authorization URL. Present only when NeedsAuth is true.
authUrl: stringProperty Value
string
message
Human-readable status message (e.g. "queued successfully", "already running", or "Analysis already completed").
message: stringProperty Value
string
needsAuth
True when the user needs to authorize the GitHub Copilot app before analysis can proceed. The client should open a popup to AuthUrl and retry after authorization completes.
needsAuth: booleanProperty Value
boolean