Skip to content

fix(api): document /v1/contributors/:login/watches in OpenAPI spec #9410

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
nghetien wants to merge 1 commit into from
+311 −0
Closed

fix(api): document /v1/contributors/:login/watches in OpenAPI spec #9410

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
203 changes: 203 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 @@ -14856,6 +14856,78 @@
"recommendation",
"summary"
]
},
"WatchSubscriptionList": {
"type": "object",
"properties": {
"watching": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WatchSubscription"
}
}
},
"required": [
"watching"
]
},
"WatchSubscription": {
"type": "object",
"properties": {
"repoFullName": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"repoFullName",
"labels"
]
},
"WatchSubscriptionChange": {
"type": "object",
"properties": {
"watching": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WatchSubscription"
}
},
"changed": {
"type": "string"
}
},
"required": [
"watching",
"changed"
]
},
"WatchSubscriptionRequest": {
"type": "object",
"properties": {
"repoFullName": {
"type": "string",
"minLength": 3,
"maxLength": 200
},
"labels": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 50
}
},
"required": [
"repoFullName"
]
}
},
"parameters": {},
Expand Down Expand Up @@ -19370,6 +19442,137 @@
}
]
}
},
"/v1/contributors/{login}/watches": {
"get": {
"summary": "List contributor issue-watch subscriptions",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
"name": "login",
"in": "path"
}
],
"responses": {
"200": {
"description": "The contributor's own issue-watch subscriptions (self-scoped), mirroring loopover_watch_issues action=list.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WatchSubscriptionList"
}
}
}
}
},
"security": [
{
"LoopOverBearer": []
},
{
"LoopOverSessionCookie": []
}
]
},
"post": {
"summary": "Watch a repo for new grabbable issues",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
"name": "login",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WatchSubscriptionRequest"
}
}
}
},
"responses": {
"200": {
"description": "Subscribes the contributor to repoFullName (optional label filter) and returns the updated watch list, mirroring loopover_watch_issues action=watch.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WatchSubscriptionChange"
}
}
}
},
"400": {
"description": "Invalid watch request body"
},
"403": {
"description": "Forbidden when the repo cannot be watched by this login"
}
},
"security": [
{
"LoopOverBearer": []
},
{
"LoopOverSessionCookie": []
}
]
},
"delete": {
"summary": "Unwatch a repo",
"parameters": [
{
"schema": {
"type": "string"
},
"required": true,
"name": "login",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WatchSubscriptionRequest"
}
}
}
},
"responses": {
"200": {
"description": "Removes the contributor's subscription to repoFullName and returns the updated watch list, mirroring loopover_watch_issues action=unwatch.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WatchSubscriptionChange"
}
}
}
},
"400": {
"description": "Invalid watch request body"
},
"403": {
"description": "Forbidden when the repo cannot be watched by this login"
}
},
"security": [
{
"LoopOverBearer": []
},
{
"LoopOverSessionCookie": []
}
]
}
}
},
"servers": [
Expand Down
28 changes: 28 additions & 0 deletions src/openapi/schemas.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,6 +539,34 @@ export const NotificationsMarkedSchema = z
})
.openapi("NotificationsMarked");

// #9306: mirrors watchIssuesOutputSchema's `watching` shape (src/mcp/server.ts) for the REST surface.
export const WatchSubscriptionSchema = z
.object({
repoFullName: z.string(),
labels: z.array(z.string()),
})
.openapi("WatchSubscription");

export const WatchSubscriptionListSchema = z
.object({
watching: z.array(WatchSubscriptionSchema),
})
.openapi("WatchSubscriptionList");

export const WatchSubscriptionChangeSchema = z
.object({
watching: z.array(WatchSubscriptionSchema),
changed: z.string(),
})
.openapi("WatchSubscriptionChange");

export const WatchSubscriptionRequestSchema = z
.object({
repoFullName: z.string().min(3).max(200),
labels: z.array(z.string().min(1).max(100)).max(50).optional(),
})
.openapi("WatchSubscriptionRequest");

export const ContributorOpportunitySchema = z
.object({
repoFullName: z.string(),
Expand Down
49 changes: 49 additions & 0 deletions src/openapi/spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,9 @@ import {
UpstreamDriftReportSchema,
UpstreamRulesetSnapshotSchema,
UpstreamStatusSchema,
WatchSubscriptionChangeSchema,
WatchSubscriptionListSchema,
WatchSubscriptionRequestSchema,
WorkboardItemSchema,
} from "./schemas";

Expand Down Expand Up @@ -841,6 +844,52 @@ export function buildOpenApiSpec() {
400: { description: "Invalid mark-read body" },
},
});
registry.registerPath({
method: "get",
path: "/v1/contributors/{login}/watches",
summary: "List contributor issue-watch subscriptions",
request: { params: z.object({ login: z.string() }) },
responses: {
200: {
description: "The contributor's own issue-watch subscriptions (self-scoped), mirroring loopover_watch_issues action=list.",
content: { "application/json": { schema: WatchSubscriptionListSchema } },
},
},
});
registry.registerPath({
method: "post",
path: "/v1/contributors/{login}/watches",
summary: "Watch a repo for new grabbable issues",
request: {
params: z.object({ login: z.string() }),
body: { content: { "application/json": { schema: WatchSubscriptionRequestSchema } } },
},
responses: {
200: {
description: "Subscribes the contributor to repoFullName (optional label filter) and returns the updated watch list, mirroring loopover_watch_issues action=watch.",
content: { "application/json": { schema: WatchSubscriptionChangeSchema } },
},
400: { description: "Invalid watch request body" },
403: { description: "Forbidden when the repo cannot be watched by this login" },
},
});
registry.registerPath({
method: "delete",
path: "/v1/contributors/{login}/watches",
summary: "Unwatch a repo",
request: {
params: z.object({ login: z.string() }),
body: { content: { "application/json": { schema: WatchSubscriptionRequestSchema } } },
},
responses: {
200: {
description: "Removes the contributor's subscription to repoFullName and returns the updated watch list, mirroring loopover_watch_issues action=unwatch.",
content: { "application/json": { schema: WatchSubscriptionChangeSchema } },
},
400: { description: "Invalid watch request body" },
403: { description: "Forbidden when the repo cannot be watched by this login" },
},
});
registry.registerPath({
method: "get",
path: "/v1/contributors/{login}/repos/{owner}/{repo}/decision",
Expand Down
31 changes: 31 additions & 0 deletions test/unit/openapi.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ describe("OpenAPI contract", () => {
expect(spec.paths["/v1/contributors/{login}/decision-pack"]).toBeDefined();
expect(spec.paths["/v1/contributors/{login}/open-pr-monitor"]).toBeDefined();
expect(spec.paths["/v1/contributors/{login}/pr-outcomes"]).toBeDefined();
expect(spec.paths["/v1/contributors/{login}/watches"]?.get).toBeDefined();
expect(spec.paths["/v1/contributors/{login}/watches"]?.post).toBeDefined();
expect(spec.paths["/v1/contributors/{login}/watches"]?.delete).toBeDefined();
expect(spec.paths["/v1/contributors/{login}/repos/{owner}/{repo}/decision"]).toBeDefined();
expect(spec.paths["/v1/preflight/pr"]).toBeDefined();
expect(spec.paths["/v1/preflight/review-risk"]).toBeDefined();
Expand Down Expand Up @@ -101,6 +104,12 @@ describe("OpenAPI contract", () => {
expect(spec.components?.schemas?.PullRequestMaintainerPacket).toBeDefined();
expect(spec.components?.schemas?.PullRequestReviewability).toBeDefined();
expect(spec.components?.schemas?.LocalBranchAnalysis).toBeDefined();
expect(spec.components?.schemas?.WatchSubscriptionList).toBeDefined();
expect(spec.components?.schemas?.WatchSubscriptionChange).toBeDefined();
expect(spec.components?.schemas?.WatchSubscriptionRequest).toBeDefined();
expect(JSON.stringify(spec.components?.schemas?.WatchSubscriptionList)).toContain("watching");
expect(JSON.stringify(spec.components?.schemas?.WatchSubscriptionChange)).toContain("changed");
expect(JSON.stringify(spec.components?.schemas?.WatchSubscriptionRequest)).toContain("repoFullName");
expect(spec.components?.schemas?.RepoSettingsPreview).toBeDefined();
expect(spec.components?.schemas?.InstallationRepair).toBeDefined();
expect(spec.components?.schemas?.CommandPreviewResponse).toBeDefined();
Expand Down Expand Up @@ -162,4 +171,26 @@ describe("OpenAPI contract", () => {
}
}
});

// #9306: /v1/contributors/{login}/watches (GET/POST/DELETE) mirrors loopover_watch_issues (watchIssuesOutputSchema
// in src/mcp/server.ts) but had no OpenAPI documentation. Pin all three verbs plus their response schema refs.
it("documents all three verbs of /v1/contributors/{login}/watches with matching response schemas", () => {
const spec = buildOpenApiSpec();
const refName = (schema: unknown) => (schema as { $ref?: string }).$ref?.split("/").pop();
const watches = spec.paths["/v1/contributors/{login}/watches"] as {
get?: { responses: Record<string, { content?: Record<string, { schema: unknown }> }> };
post?: { responses: Record<string, { content?: Record<string, { schema: unknown }> }>; requestBody?: { content: Record<string, { schema: unknown }> } };
delete?: { responses: Record<string, { content?: Record<string, { schema: unknown }> }>; requestBody?: { content: Record<string, { schema: unknown }> } };
};

expect(refName(watches.get?.responses["200"]?.content?.["application/json"]?.schema)).toBe("WatchSubscriptionList");
expect(refName(watches.post?.responses["200"]?.content?.["application/json"]?.schema)).toBe("WatchSubscriptionChange");
expect(refName(watches.post?.requestBody?.content["application/json"]?.schema)).toBe("WatchSubscriptionRequest");
expect(watches.post?.responses["400"]).toBeDefined();
expect(watches.post?.responses["403"]).toBeDefined();
expect(refName(watches.delete?.responses["200"]?.content?.["application/json"]?.schema)).toBe("WatchSubscriptionChange");
expect(refName(watches.delete?.requestBody?.content["application/json"]?.schema)).toBe("WatchSubscriptionRequest");
expect(watches.delete?.responses["400"]).toBeDefined();
expect(watches.delete?.responses["403"]).toBeDefined();
});
});
Loading