open-traffic-generator / openapiart

OpenAPI artifact generator
MIT License
6 stars 4 forks source link

No way to override description for $ref elements #357

Open ghost opened 2 years ago

ghost commented 2 years ago

Version information 0.1.47

Describe the bug I wrote an openApi schema and naively wrote descriptions for commonly-used elements next to the $ref tag, expecting it to replace the useless description on the $ref (e.g. IP addresses are used everywhere, but i need to describe what a particular occurrence does). After seeing that my description was not used, I googled it and found out that the unsupported allOf element is required to do the override. This dramatically decreases the effectiveness of the documentation.

To Reproduce Define a property with a $ref reference, along with a description field at the same level as the $ref.

Expected behavior The description should replace the generic one from the ref

Additional context A custom x-description or similar tag would be an acceptable work-around.