Open Quentigus opened 2 weeks ago
Version: 7.3.0 Regression: ?
JSDoc description are not generated on $ref properties.
description
$ref
/** * Class based documentation */ export interface Object1 { property: Object1; } /** * Class based documentation */ export interface Object2 { [k: string]: unknown; }
/** * Class based documentation */ export interface Object1 { /** * Property documentation */ property: Object1; } /** * Class based documentation */ export interface Object2 { [k: string]: unknown; }
npx openapi-generator-cli generate -g typescript-angular -i ./swagger.json -o ./output`
{ "swagger": "2.0", "info": { "description": "Backend", "version": "1.0.0", "title": "API" }, "basePath": "/api", "schemes": [ "http", "https" ], "paths": { "/sample": { "get": { "consumes": [ "application/json" ], "produces": [ "application/json" ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/Object1" } } } } } }, "definitions": { "Object1": { "type": "object", "description": "Class based documentation", "properties": { "property": { "description": "Property documentation", "$ref": "#/definitions/Object2" } } }, "Object2": { "description": "Class based documentation", "type": "object", "additionalProperties": true } } }
Bug Report Checklist
openapi-generator version
Version: 7.3.0 Regression: ?
Description
JSDoc
description
are not generated on$ref
properties.Actual Output
Expected Output
Steps to reproduce
OpenAPI declaration file content or url