Repository navigation
fix(openapi): make the served spec pass strict validation - #271
Merged
Merged
Conversation
Quote flow-style response descriptions containing commas and colons, fix mis-indented deploy-jobs responses, add responses to the MCP OAuth callback, replace unsupported null types and propertyNames, and add a validity test.
vigneshrajsb
marked this pull request as ready for review
October 23, 2026 21:38
binlab
approved these changes
Oct 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The spec served at
/api/docsfailed strict OpenAPI validation (orval 8, 16 errors), forcing generator consumers to disable validation. It now validates cleanly.Description
POST /environments403/422,PATCH /environments/{uuid}422,POST /tokensandPOST /me/tokens403); they were parsed as stray keys.GET /builds/{uuid}/services/{name}/deploys: fix indentation so 400/404/500/502 sit underresponses.GET /ai/agent/mcp-connections/{slug}/oauth/callback: add the missingresponses(HTML 200/400/404/409/410/422 matching the handler).SuccessApiResponse.errorandApiErrorResponse.data:type: 'null'becomesnullable: true(OpenAPI 3.0).AgentSessionStringRecord: drop unsupportedpropertyNames.AgentAdminThreadSummary.latestRun:$refwith siblingnullablebecomesnullable+allOf.Generated type impact
Generated clients may see small changes: the two
null-typed fields lose their explicitnulltype (now untyped nullable), andAgentSessionStringRecordno longer carries the keyminLengthconstraint (still enforced at runtime). No runtime behavior or response shapes change.Verifying Changes
orval@8.44.0withoutunsafeDisableValidation: no errors or warnings.openApiSpec.test.tsvalidates the spec with@scalar/openapi-parser(added as a dev dependency); it reports 16 errors on the old spec.pnpm lintandpnpm testpass.