Fix readme response header for open api 3.0 #518
Merged
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
jtannas
approved these changes
May 18, 2022
There was a problem hiding this comment.
@BookOfGreg just a correction to the README
Both the orginal version and the new one in the PR function, but this update puts it in line with the Swagger Docs.
https://swagger.io/docs/specification/describing-parameters/#header-parameters
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
OAS3 defines the response header needs to specify the schema, if you follow the example in the README, there will be a syntax error
Solution
Update README.md
This concerns this parts of the Open API Specification:
The changes I made are compatible with:
Related Issues
Links to any related issues.
Checklist