Support the use of string or number via $ref in path parameters #225
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.
Types of changes
Changes
Additional context
Currently, only
number
orstring
can be used for the path parameters.( This is validation on the side of aspida/aspida. https://github.com/aspida/aspida/blob/main/packages/aspida/src/createTemplateValues.ts#L9 )
In openapi2aspida, even if it is a string or a number, an error will occur if a
$ref
reference is interposed.In my use case, I want to define the path parameter string as follows:
openapi2aspida does not know that
"$ref": "#/components/schemas/InvoiceCategory"
is actually a string.Therefore,
So, in this PR, I added a process to check the destination of
$ref
and fallback if it is a simple string type.Community note
Please upvote with reacting as 👍 to express your agreement.