feat(api): Ultrafast tier, structured MCP and websocket errors, separate websocket events - #62
Conversation
jbeckwith-oai
left a comment
jbeckwith-oai
left a comment
There was a problem hiding this comment.
Reviewed the exact current head. Stable and beta ultrafast service-tier help is aligned and accurate, file-content wording now matches the existing response behavior, generated provenance is coherent, and all CI is green. No runtime, compatibility, structure, or file-size issue found.
There was a problem hiding this comment.
Pull request overview
This PR updates CLI help text and the generated OpenAPI reference to reflect new/clarified API behaviors and schema details (notably the ultrafast service tier guidance and richer streaming/WebSocket/MCP error modeling).
Changes:
- Document the access-controlled
ultrafastservice tier in both stable and beta Responses command help output. - Clarify that file-content retrieval returns an HTTP response object containing the file bytes/content (CLI + OpenAPI example/description).
- Expand the transformed OpenAPI spec with additional response codes (e.g., many
429s) and new/adjusted schemas for streaming/WebSocket/MCP errors and event unions.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| pkg/cmd/response.go | Adds ultrafast tier documentation to stable Responses CLI flag help. |
| pkg/cmd/betaresponse.go | Adds ultrafast tier documentation to beta Responses CLI flag help. |
| pkg/cmd/file.go | Clarifies files content returns a response containing file data. |
| api_reference/openapi.transformed.yml | Updates generated OpenAPI: adds many 429 responses, adjusts file-content docs/example, and introduces/changes schemas for MCP/WebSocket/streaming errors & events. |
| .castiron.stats.yml | Updates generated spec/codegen metadata hashes/IDs. |
Suppressed comments (1)
api_reference/openapi.transformed.yml:77836
BetaResponsesWebSocketStreamEventsimilarly omitsBetaResponseWsErrorfrom itsanyOf, so beta WebSocket stream event typing cannot representtype: errorevents.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| ResponsesWebSocketStreamEvent: | ||
| allOf: | ||
| - $ref: '#/components/schemas/ResponseStreamEvent' | ||
| - anyOf: | ||
| - $ref: '#/components/schemas/ResponseAudioDeltaEvent' |
| '429': | ||
| $ref: '#/components/responses/TooManyRequests' |
…ate websocket events Castiron-Internal-PR: openai/openai-cli-internal#23 Castiron-Source-SHA: 470147ba303ae858096e09fcf01b1bad9abd72ac Castiron-Public-Base-SHA: 033612a
f08b144 to
cdceb51
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.
Suppressed comments (1)
api_reference/openapi.transformed.yml:55021
- The PR description summary only mentions CLI help/documentation changes, but this diff also includes large OpenAPI spec updates (e.g., new 429 responses, structured MCP/WebSocket error schemas, model fields). Please update the PR description to reflect the full scope so reviewers and release notes consumers aren’t surprised.
Summary
ultrafastResponses service tier in stable and beta command help so callers understand the request and response values.