Fix generation of parameters with a dot in the description #986
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
axelhzf
commented
Nov 12, 2022
| @@ -20,7 +20,7 @@ describe("Paths Object", () => { | |||
| test("basic", () => { | |||
| const schema: PathsObject = { | |||
| "/api/v1/user/{user_id}": { | |||
| parameters: [{ name: "page", in: "query", schema: { type: "number" } }], | |||
| parameters: [{ name: "page", in: "query", schema: { type: "number" }, description: "Page number." }], | |||
There was a problem hiding this comment.
I'm not sure if I should create a new test instead of updating an existing one
There was a problem hiding this comment.
Yeah that’s always a tough one and there’s no right answer. I’d say this one is fine here but if we started collecting a lot of these we should break them out into its own test.
drwpow
approved these changes
Nov 12, 2022
|
@all-contributors please add @axelhzf for code, bug, test |
|
I've put up a pull request to add @axelhzf! 🎉 |
1 task
2 tasks
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.
Changes
What does this PR change? Link to any related issue(s).
Fixes the generation of parameters containing a
.in the description. See #985How to Review
How can a reviewer review your changes? What should be kept in mind for this review?
Checklist
examples/directory updated (if applicable)