Skip to content

docs(openapi): document validate-linked-issue + check-before-start routes (#9304) #9440

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

Closed
RealDiligent wants to merge 1 commit into from
Closed

docs(openapi): document validate-linked-issue + check-before-start routes (#9304) #9440

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
253 changes: 253 additions & 0 deletions apps/loopover-ui/public/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16134,6 +16134,137 @@
]
}
}
},
"ValidateLinkedIssueRequest": {
"type": "object",
"properties": {
"owner": {
"type": "string"
},
"repo": {
"type": "string"
},
"issueNumber": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true
},
"plannedChange": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"changedFiles": {
"type": "array",
"items": {
"type": "string"
}
},
"contributorLogin": {
"type": "string"
}
}
}
},
"required": [
"owner",
"repo",
"issueNumber"
]
},
"ValidateLinkedIssueResponse": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"repoFullName": {
"type": "string"
},
"issueNumber": {
"type": "number"
},
"found": {
"type": "boolean"
},
"multiplierStatus": {
"type": "string"
},
"multiplierWouldApply": {
"type": "boolean"
},
"blockingReason": {
"type": "string"
},
"reasons": {
"nullable": true
},
"report": {
"nullable": true
}
}
},
"CheckBeforeStartRequest": {
"type": "object",
"properties": {
"owner": {
"type": "string"
},
"repo": {
"type": "string"
},
"issueNumber": {
"type": "integer",
"minimum": 0,
"exclusiveMinimum": true
},
"title": {
"type": "string"
},
"plannedPaths": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"owner",
"repo"
]
},
"CheckBeforeStartResponse": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"repoFullName": {
"type": "string"
},
"found": {
"type": "boolean"
},
"claimStatus": {
"type": "string"
},
"duplicateClusterRisk": {
"type": "string"
},
"recommendation": {
"type": "string"
},
"reasons": {
"nullable": true
},
"blockers": {
"nullable": true
},
"report": {
"nullable": true
}
}
}
},
"parameters": {},
Expand Down Expand Up @@ -21768,6 +21899,128 @@
}
]
}
},
"/v1/repos/{owner}/{repo}/validate-linked-issue": {
"post": {
"summary": "Validate a linked issue for a planned change — REST mirror of loopover_validate_linked_issue (#9304)",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
"name": "owner",
"in": "path"
},
{
"schema": {
"type": "string"
},
"required": true,
"name": "repo",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateLinkedIssueRequest"
}
}
}
},
"responses": {
"200": {
"description": "Linked-issue validation over the planned change — mirrors the loopover_validate_linked_issue MCP tool's output shape",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidateLinkedIssueResponse"
}
}
}
},
"400": {
"description": "Invalid validate-linked-issue request body"
},
"401": {
"description": "Missing or invalid static protected API token"
},
"403": {
"description": "Static mcp credential is outside MCP_READ_REPO_ALLOWLIST for this repo"
}
},
"security": [
{
"LoopOverBearer": []
},
{
"LoopOverSessionCookie": []
}
]
}
},
"/v1/repos/{owner}/{repo}/check-before-start": {
"post": {
"summary": "Pre-work claim/duplicate check before starting an issue — REST mirror of loopover_check_before_start (#9304)",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
"name": "owner",
"in": "path"
},
{
"schema": {
"type": "string"
},
"required": true,
"name": "repo",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckBeforeStartRequest"
}
}
}
},
"responses": {
"200": {
"description": "Claim status, duplicate-cluster risk, and a start recommendation — mirrors the loopover_check_before_start MCP tool's output shape",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckBeforeStartResponse"
}
}
}
},
"400": {
"description": "Invalid check-before-start request body"
},
"401": {
"description": "Missing or invalid static protected API token"
},
"403": {
"description": "Static mcp credential is outside MCP_READ_REPO_ALLOWLIST for this repo"
}
},
"security": [
{
"LoopOverBearer": []
},
{
"LoopOverSessionCookie": []
}
]
}
}
},
"servers": [
Expand Down
70 changes: 70 additions & 0 deletions src/openapi/schemas.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2039,6 +2039,76 @@ export const EvaluateEscalationResponseSchema = z
})
.openapi("EvaluateEscalationResponse");

/**
* Request body for POST /v1/repos/{owner}/{repo}/validate-linked-issue. Field-level parity with
* `validateLinkedIssueShape` (the `loopover_validate_linked_issue` MCP tool `inputSchema`) in
* src/mcp/server.ts — #9304. owner/repo are also path params; the body carries the planned-change context.
*/
export const ValidateLinkedIssueRequestSchema = z
.object({
owner: z.string(),
repo: z.string(),
issueNumber: z.number().int().positive(),
plannedChange: z
.object({
title: z.string().optional(),
changedFiles: z.array(z.string()).optional(),
contributorLogin: z.string().optional(),
})
.optional(),
})
.openapi("ValidateLinkedIssueRequest");

/**
* Response body for POST /v1/repos/{owner}/{repo}/validate-linked-issue. Field-level parity with
* `validateLinkedIssueOutputSchema` (the `loopover_validate_linked_issue` MCP tool `outputSchema`) — #9304.
*/
export const ValidateLinkedIssueResponseSchema = z
.object({
status: z.string().optional(),
repoFullName: z.string().optional(),
issueNumber: z.number().optional(),
found: z.boolean().optional(),
multiplierStatus: z.string().optional(),
multiplierWouldApply: z.boolean().optional(),
blockingReason: z.string().optional(),
reasons: z.unknown().optional(),
report: z.unknown().optional(),
})
.openapi("ValidateLinkedIssueResponse");

/**
* Request body for POST /v1/repos/{owner}/{repo}/check-before-start. Field-level parity with
* `checkBeforeStartShape` (the `loopover_check_before_start` MCP tool `inputSchema`) in src/mcp/server.ts — #9304.
*/
export const CheckBeforeStartRequestSchema = z
.object({
owner: z.string(),
repo: z.string(),
issueNumber: z.number().int().positive().optional(),
title: z.string().optional(),
plannedPaths: z.array(z.string()).optional(),
})
.openapi("CheckBeforeStartRequest");

/**
* Response body for POST /v1/repos/{owner}/{repo}/check-before-start. Field-level parity with
* `checkBeforeStartOutputSchema` (the `loopover_check_before_start` MCP tool `outputSchema`) — #9304.
*/
export const CheckBeforeStartResponseSchema = z
.object({
status: z.string().optional(),
repoFullName: z.string().optional(),
found: z.boolean().optional(),
claimStatus: z.string().optional(),
duplicateClusterRisk: z.string().optional(),
recommendation: z.string().optional(),
reasons: z.unknown().optional(),
blockers: z.unknown().optional(),
report: z.unknown().optional(),
})
.openapi("CheckBeforeStartResponse");

/**
* Request body for POST /v1/loop/results-payload. Field-level parity with `buildResultsPayloadShape`
* (the `loopover_build_results_payload` MCP tool `inputSchema`) in src/mcp/server.ts — #9309.
Expand Down
Loading
Loading