Repository navigation
Conversation
The API types the `step_id` path parameter as a one-value enum that holds an example UUID. The patch dropped that enum, so the published spec no longer matched the API's. The fix belongs in the API spec. BREAKING CHANGE: `UpgradePipelineStepGet`, `UpgradePipelineStepUpdate` and `UpgradePipelineStepDelete` take a `StepIdType` instead of a `string` step ID. Resolves NEX-2978
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.
About this change - What it does
Removes the
step_idpatch fromopenapi_patch.yaml. The API types thestep_idpath parameter as a one-value enum that holds an example UUID. The patch dropped that enum, so the published spec no longer matched the API's.Breaking change:
UpgradePipelineStepGet,UpgradePipelineStepUpdateandUpgradePipelineStepDeletetake aStepIdTypeinstead of astringstep ID. The handler adds theStepIdTypetype, its one constant andStepIdTypeChoices(). No request or response struct changes.Resolves: NEX-2978
Why this way
The fix belongs in the API spec, where the UUID should be an
example, not anenum. Generated from today'sopenapi-uc.json; with the patch kept, the same spec generates exactly the committed client.