fix: resolve dangling StepLogPartial $ref breaking SDK generation#146
Merged
Conversation
Generation was failing validation with: ERROR resolution-json-schema - not found -- key StepLogPartial not found in sequencedmap.Map UnifiedLogsPartialLegacy.properties.step_requests.items refs #/components/schemas/StepLogPartial, which is not defined anywhere in stackone.json. Upstream renamed the schema to StepLogPartialLegacy but missed this reference. Confirmed the rename rather than guessing: the property set in the previously-generated stackone-client-typescript StepLogPartial model (request_id, http_method, is_worker, sub_resource, ...) is an exact match for today's StepLogPartialLegacy. Retargets the ref via overlay, matching the existing ActionsRpcResponse workaround in this file. The real fix belongs in the OAS producer. Verified locally with speakeasy 1.638.0: validation passes and the SDK generates successfully. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the Speakeasy Ruby overlay to fix a broken OpenAPI schema reference that causes SDK generation to fail during document validation.
Changes:
- Retarget
components.schemas.UnifiedLogsPartialLegacy.properties.step_requests.items.$reffrom the missingStepLogPartialto the existingStepLogPartialLegacy. - Preserve the existing overlay workaround pattern already used in this repo for missing/incorrect upstream schemas (e.g.,
ActionsRpcResponse).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jerann
approved these changes
Jul 21, 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.
Problem
SDK generation is failing at the Validating Document step:
In
https://api.eu1.stackone.com/oas/stackone.json:Upstream renamed that schema to
StepLogPartialLegacyand missed this one reference.Evidence for the rename
Not a guess. The property set in the previously-generated
stackone-client-typescriptStepLogPartialmodel —request_id,start_time,end_time,account_id,project_id,http_method,path,url,status,duration,success,provider,service,resource,child_resource,sub_resource,action,is_worker,id— is an exact match for today'sStepLogPartialLegacy.Fix
Retargets the
$refvia overlay, following the existingActionsRpcResponseworkaround already in this file (same class of bug, same file).Verification
speakeasy runlocally (v1.638.0): validation passes, SDK generated successfully ✓. The run only fails afterwards at Snapshotting Code Samples on a local auth-org mismatch (s1vsstackone), unrelated to the spec.Follow-up (not in this PR)
This is a band-aid. The dangling ref is in the OAS producer (
unified-cloud-api), so every SDK consuming this spec has the same broken ref. Worth fixing theUnifiedLogsPartialLegacyDTO at source and then dropping both overlay workarounds.🤖 Generated with Claude Code