fix: openapi edge case for empty payloads #1383
Closed
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
|
@acdn-tsmith is attempting to deploy a commit to the WunderGraph Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Ignored Deployment
|
acdn-tsmith
commented
Apr 25, 2024
| @@ -211,6 +211,8 @@ describe('OpenAPI builder', () => { | |||
| PathName: 'MutationPath', | |||
| OperationType: OperationType.MUTATION, | |||
| AuthenticationConfig: { required: true }, | |||
| VariablesSchema: personSchema, | |||
There was a problem hiding this comment.
While running the tests, I noticed that this annotate operations test will throw an error in the changed mutateOperations function due to not having a VariablesSchema. Adding a dummy VariablesSchema and ResponseSchema now.
|
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
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.
Motivation and Context
The generated
wundergraph.openapi.jsonspecification doesn't currently handle mutations that have no input. The requestBody shouldn't be required per the OpenAPI 3.1.0 docs, but theopenapibuildercode currently assumes that we always have an input.Now, for mutations that have no input, instead of of a payload that shows as an empty object...
We have a payload that just shows as empty and non-required:
This will correct the generated spec for the small subset mutation operations that don't consume an input.
Marketing Changelog
OpenAPI Generated Spec now formats POST's with empty payloads correctly
Checklist
make test