Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-02-17 10:20:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

fix: respect description defined on the property level with $ref even if referred object has default description (#703)

Browse Source
This commit is contained in:
Vladimir L 2018-11-22 08:19:57 +01:00 committed by Roman Hotsiy
parent 46f5ea7b82
commit ce87174213
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
lib/services/schema-normalizer.service.ts
View File

@ -229,11 +229,18 @@ export class SchemaDereferencer {
if ( keysCount > 2 || (keysCount === 2 && !schema.description) ) { if ( keysCount > 2 || (keysCount === 2 && !schema.description) ) {
WarningsService.warn(`Other properties are defined at the same level as $ref at "#${pointer}". ` + WarningsService.warn(`Other properties are defined at the same level as $ref at "#${pointer}". ` +
'They are IGNORED according to the JsonSchema spec'); 'They are IGNORED according to the JsonSchema spec');
resolved.description = resolved.description || schema.description;
} }
resolved = this.normalizator.normalize(resolved, $ref); resolved = this.normalizator.normalize(resolved, $ref);
this._refCouner.exit($ref); this._refCouner.exit($ref);
// schema description should always override $ref description
if (schema.description) {
// make a copy of resolved object with updated description, do not globally override the description
resolved = Object.assign({}, resolved);
resolved.description = schema.description;
}
return resolved; return resolved;
} }
} }