You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
What's the actual output vs expected output? -> see the test
[Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
Starting with OpenAPI 3.1, it is allowed for $ref-objects to have sibling properties and those sibling properties should not be lost. A simple example would be:
Expected: when generating code, I have access to refProperty's title field.
Reality: The value of title (and other fields, such as description) are lost.
For example, if I try to generate TypeScript code that includes a model's title using a custom template (but the issue is not TypeScript-specific):
this works for regular properties, but title and description are always empty for properties that include a $ref.
openapi-generator version
7.10.0 (actually latest master, d29196a).
As far as I understand, this is not a regression, but just a yet undetected bug for OpenAPI 3.1 schemas.
Steps to reproduce
I opened a complimentary pull request that adds a test case showcasing the problem: #20303
Suggest a fix
Best lead I found while debugging was that ModelUtils#unaliasSchema seems to just 100% forward the $ref'ed schema if it detects a ref that doesn't fall into one of the special cases like isObjectSchema(...).
The text was updated successfully, but these errors were encountered:
Bug Report Checklist
Have you validated the input using an OpenAPI validator (example)?The correctness of the snippets I'm trying to parse were discussed in Parser ignore readOnly/writeOnly on property with $ref swagger-api/swagger-parser#2036Description
Starting with OpenAPI 3.1, it is allowed for $ref-objects to have sibling properties and those sibling properties should not be lost. A simple example would be:
Expected: when generating code, I have access to
refProperty
'stitle
field.Reality: The value of
title
(and other fields, such asdescription
) are lost.For example, if I try to generate TypeScript code that includes a model's title using a custom template (but the issue is not TypeScript-specific):
this works for regular properties, but
title
anddescription
are always empty for properties that include a$ref
.openapi-generator version
7.10.0 (actually latest master, d29196a).
As far as I understand, this is not a regression, but just a yet undetected bug for OpenAPI 3.1 schemas.
Steps to reproduce
I opened a complimentary pull request that adds a test case showcasing the problem: #20303
Suggest a fix
Best lead I found while debugging was that
ModelUtils#unaliasSchema
seems to just 100% forward the $ref'ed schema if it detects a ref that doesn't fall into one of the special cases likeisObjectSchema(...)
.The text was updated successfully, but these errors were encountered: