fix: update openapi snapshot by vnv-varun · Pull Request #2489 · inkeep/agents

vnv-varun · 2026-03-03T04:12:59Z

Summary

Updates the OpenAPI snapshot to match the current schema. The snapshot drifted in #2038 which removed agentName/projectName fields and added maxLength constraints, but the snapshot wasn't updated to match, causing CI to fail on every subsequent PR.

changeset-bot · 2026-03-03T04:13:03Z

⚠️ No Changeset found

Latest commit: 58bb63a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2026-03-03T04:13:03Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
agents-api	Ready	Preview, Comment	Mar 3, 2026 4:16am
agents-manage-ui	Ready	Preview, Comment	Mar 3, 2026 4:16am

1 Skipped Deployment

Project	Deployment	Actions	Updated (UTC)
agents-docs	Skipped		Mar 3, 2026 4:16am

pullfrog · 2026-03-03T04:13:35Z

Updates the OpenAPI snapshot to reflect two recent changes in the codebase.

Middleware rename: Replaces manageBearerOrSessionAuth with manageApiKeyOrSessionAuth in x-authz descriptions across 10 routes in agents-api/__snapshots__/openapi.json
Schema cleanup: Removes the teamDomain property from a Slack integration response schema

^{｜ View workflow run ｜ Using Claude Code ｜ Triggered by Pullfrog ｜ pullfrog.com ｜ 𝕏}

pullfrog

This snapshot does not match what the source code generates. The changes appear to be hand-edited rather than produced by regenerating the snapshot, and two out of two change categories diverge from the actual schemas/middleware. The PR description also mentions agentName/projectName removal and maxLength additions that are not present in the diff.

^{｜ Fix all ➔ ｜ Fix 👍s ➔ ｜ View workflow run ｜ pullfrog.com ｜ 𝕏}

pullfrog · 2026-03-03T04:14:56Z

agents-api/__snapshots__/openapi.json

        ],
        "x-authz": {
-          "description": "Requires organization membership. Auth is enforced by the manageBearerOrSessionAuth middleware in createApp.ts.",
+          "description": "Requires organization membership. Auth is enforced by the manageApiKeyOrSessionAuth middleware in createApp.ts.",


This rename from manageBearerOrSessionAuth to manageApiKeyOrSessionAuth does not match the source code. inheritedManageTenantAuth() in packages/agents-core/src/middleware/inherited-auth.ts still emits manageBearerOrSessionAuth in its description string. Regenerating the snapshot would revert all 10 of these renames.

Either update the source string in inherited-auth.ts first and then regenerate, or revert this change in the snapshot.

pullfrog · 2026-03-03T04:14:56Z

agents-api/__snapshots__/openapi.json

-                          "teamDomain": {
-                            "type": "string"
-                          },
                          "teamId": {


teamDomain is still defined in the Zod schema at packages/agents-work-apps/src/slack/routes/workspaces.ts (teamDomain: z.string().optional()). Removing it from the snapshot without removing it from the schema means the snapshot will fail on regeneration.

Either remove teamDomain from the Zod schema first, or keep it here.

claude

PR Review Summary

(2) Total Issues | Risk: High

🔴❗ Critical (2) ❗🔴

This PR introduces factually incorrect snapshot changes that do not match the actual API specification. Both changes in this PR are invalid.

Inline Comments:

🔴 Critical: openapi.json:10722 Incorrect middleware name — reverting a valid rename from PR #2478
🔴 Critical: openapi.json:38559-38561 Incorrectly removing teamDomain field that exists in source code

Analysis

1. Middleware name change is backwards

The PR changes 10 occurrences of manageBearerOrSessionAuth → manageApiKeyOrSessionAuth in the snapshot. However:

The actual middleware in manageAuth.ts:173 is named manageBearerOrSessionAuth
PR #2478 (merged March 2) intentionally renamed it from manageApiKeyOrSessionAuth to manageBearerOrSessionAuth and updated the snapshot
This PR is reverting that correct change

2. teamDomain removal is incorrect

The PR removes the teamDomain field from the Slack workspaces schema, but:

The source code at workspaces.ts:104 explicitly includes teamDomain: z.string().optional()
This field is part of the API contract and should not be removed

3. PR description is misleading

The description claims this fixes drift from PR #2038 involving agentName/projectName fields and maxLength constraints. However:

None of these fields appear in the actual diff
The actual changes are the middleware rename and teamDomain removal

Recommendation

Do not merge this PR. The snapshot on main is already correct. If CI is failing on subsequent PRs, the issue is likely elsewhere (possibly a test environment mismatch or stale snapshot regeneration).

To verify the current snapshot is correct, run:

pnpm --filter @inkeep/agents-api openapi:update-snapshot
git diff agents-api/__snapshots__/openapi.json

If there are no changes, the current snapshot is correct.

🚫 REQUEST CHANGES

Summary: This PR makes the OpenAPI snapshot inconsistent with the actual codebase. The middleware name change reverts a valid rename from PR #2478, and the teamDomain removal contradicts the source schema definition. The snapshot on main is correct and should not be changed in this way.

Reviewers (1)

Reviewer	Returned	Main Findings	Consider	While You're Here	Inline Comments	Pending Recs	Discarded
`orchestrator`	2	0	0	0	2	0	0
Total	2	0	0	0	2	0	0

Note: This was a simple snapshot-only PR that required direct orchestrator analysis rather than domain-specific sub-reviewers.

claude · 2026-03-03T04:16:16Z

agents-api/__snapshots__/openapi.json

        ],
        "x-authz": {
-          "description": "Requires organization membership. Auth is enforced by the manageBearerOrSessionAuth middleware in createApp.ts.",
+          "description": "Requires organization membership. Auth is enforced by the manageApiKeyOrSessionAuth middleware in createApp.ts.",


🔴 CRITICAL: Incorrect middleware name — reverting a valid rename

Issue: This change renames manageBearerOrSessionAuth → manageApiKeyOrSessionAuth, but the actual middleware in the codebase is named manageBearerOrSessionAuth.

Why: PR #2478 (merged March 2) intentionally renamed the middleware from manageApiKeyOrSessionAuth to manageBearerOrSessionAuth and updated the snapshot accordingly. This PR is reverting that correct change, which will cause the snapshot to reference a middleware name that doesn't exist.

Fix: Do not change this line. The current snapshot on main is correct.

Refs:

manageAuth.ts:173 — actual middleware name

PR #2478 — the rename commit

claude · 2026-03-03T04:16:23Z

agents-api/__snapshots__/openapi.json

                          "hasDefaultAgent": {
                            "type": "boolean"
                          },


🔴 CRITICAL: Incorrectly removing teamDomain field

Issue: This change removes the teamDomain field from the Slack workspaces response schema, but the source code explicitly includes this field.

Why: The source code at packages/agents-work-apps/src/slack/routes/workspaces.ts:104 defines the response schema with teamDomain: z.string().optional(). Removing it from the snapshot makes the snapshot inconsistent with the actual API response.

Fix: Do not remove these lines. The teamDomain field is part of the API contract.

Refs:

workspaces.ts:104 — schema definition

fix: update openapi snapshot to match current schema

58bb63a

vercel bot temporarily deployed to Preview – agents-docs March 3, 2026 04:13 Inactive

pullfrog bot reviewed Mar 3, 2026

View reviewed changes

vercel bot deployed to Preview – agents-api March 3, 2026 04:15 View deployment

vercel bot deployed to Preview – agents-manage-ui March 3, 2026 04:16 View deployment

claude bot reviewed Mar 3, 2026

View reviewed changes

github-actions bot deleted a comment from claude bot Mar 3, 2026

vnv-varun closed this Mar 3, 2026

vnv-varun deleted the fix/openapi-snapshot branch March 3, 2026 04:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: update openapi snapshot#2489

fix: update openapi snapshot#2489
vnv-varun wants to merge 1 commit intomainfrom
fix/openapi-snapshot

vnv-varun commented Mar 3, 2026

Uh oh!

changeset-bot bot commented Mar 3, 2026

Uh oh!

vercel bot commented Mar 3, 2026 •

edited

Loading

Uh oh!

pullfrog bot commented Mar 3, 2026

Uh oh!

pullfrog bot left a comment •

edited

Loading

Uh oh!

pullfrog bot Mar 3, 2026

Uh oh!

pullfrog bot Mar 3, 2026

Uh oh!

claude bot left a comment

Uh oh!

claude bot Mar 3, 2026

Uh oh!

claude bot Mar 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

vnv-varun commented Mar 3, 2026

Summary

Uh oh!

changeset-bot bot commented Mar 3, 2026

⚠️ No Changeset found

Uh oh!

vercel bot commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pullfrog bot commented Mar 3, 2026

Uh oh!

pullfrog bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pullfrog bot Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

pullfrog bot Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

claude bot left a comment

Choose a reason for hiding this comment

PR Review Summary

🔴❗ Critical (2) ❗🔴

Analysis

Recommendation

🚫 REQUEST CHANGES

Uh oh!

claude bot Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

claude bot Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

vercel bot commented Mar 3, 2026 •

edited

Loading

pullfrog bot left a comment •

edited

Loading