New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
External dependency: swagger2openapi loses descriptions on complex objects #2067
Comments
The kind folks over at OAS-Kit have given some advice on this Mermade/oas-kit#597 (comment)
Testing using I'll do a bit more testing and submit a PR for review. |
As per Redocly#2067, `swagger2openapi` needs `refSiblings: 'preserve'` to bring additional fields into the converted open-api object. This makes the description field available to the `fieldSchema` objects, but it also needs to be merged into the field model to be shown in the UI.
I've created an issue Mermade/oas-kit#597 over at swagger2openapi regarding an anomaly with converting field descriptions on swagger 2.0 documents.
I wanted to lodge it here as well in the advent of a fix.
The the descriptions on fields for complex objects are overwritten with the description of the object definition itself, and losing context for the user e.g. instead of displaying "The weight (in kg)..." and "The volume (in m3)..." of a reusable measurement object definition, it displays "A generic measurement." for both fields.
(I'll come back to update this as the issue progresses, if this is the right way to handle things?)
The text was updated successfully, but these errors were encountered: