fix(openapi): use status code from ir in openapi spec #5722
+6
−6
Conversation
This file contains 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
dsinghvi
approved these changes
Jan 24, 2025
There was a problem hiding this comment.
@gustavkauman https://github.com/fern-api/fern/blob/main/generators/openapi/versions.yml up to add a changelog here so that we can merge in this contribution
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.
Description
This PR fixes a bug where the response code defined in the Fern specification would not be reflected in the generated OpenAPI specification. This is achieved by using the response code from the intermediary representation instead of the hardcoded "200" success response.
If a status code is not explicitly defined in the specification it will default to 200, hence it will not break existing users.
Fixes #4777.
Changes Made
Testing
Test have been manually performed by verifying the outputted yaml file. Additionally, our own verification tool complained about the response code not matching the specification. This stopped with the updated file.
Our files and a diff between the two can be found attached.
openapi-fixed.json
openapi-origin.json
openapi-json-diff.txt