Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-01-31 18:14:07 +03:00
Code Issues Packages Projects Releases Wiki Activity

Refactor schema template

Browse Source
This commit is contained in:
Roman Hotsiy 2016-08-10 15:22:42 +03:00
parent 92f745d10f
commit d3d223a344
No known key found for this signature in database
GPG Key ID: 5CB7B3ACABA57CB0
4 changed files with 112 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

193
lib/components/JsonSchema/json-schema.html
View File

@ -1,92 +1,107 @@
<span *ngIf="schema.isFile" class="param-wrap"> <ng-container [ngSwitch]="schema._widgetType">
<span class="param-type-file">file</span> <template ngSwitchCase="file">
<div *ngIf="schema._produces && !isRequestSchema" class="file produces"> <span class="param-wrap">
<ul> <span class="param-type-file">file</span>
<li *ngFor="let type of schema._produces">{{type}}</li> <div *ngIf="schema._produces && !isRequestSchema" class="file produces">
</ul> <ul>
</div> <li *ngFor="let type of schema._produces">{{type}}</li>
<div *ngIf="schema._consumes && isRequestSchema" class="file consume"> </ul>
<ul> </div>
<li *ngFor="let type of schema._consumes">{{type}}</li> <div *ngIf="schema._consumes && isRequestSchema" class="file consume">
</ul> <ul>
</div> <li *ngFor="let type of schema._consumes">{{type}}</li>
</span> </ul>
<span *ngIf="schema.isTrivial && !schema.isFile" class="param-wrap"> </div>
<span class="param-type param-type-trivial {{schema.type}}" </span>
[ngClass]="{'with-hint': schema._displayTypeHint}" </template>
title="{{schema._displayTypeHint}}">{{schema._displayType}} {{schema._displayFormat}} <template ngSwitchCase="trivial">
<span class="param-range" *ngIf="schema._range"> {{schema._range}} </span> <span class="param-wrap">
</span> <span class="param-type param-type-trivial {{schema.type}}"
<div *ngIf="schema.enum" class="param-enum"> [ngClass]="{'with-hint': schema._displayTypeHint}"
<span *ngFor="let enumItem of schema.enum" class="enum-value {{enumItem.type}}"> {{enumItem.val | json}} </span> title="{{schema._displayTypeHint}}">{{schema._displayType}} {{schema._displayFormat}}
</div> <span class="param-range" *ngIf="schema._range"> {{schema._range}} </span>
</span> </span>
<div *ngIf="schema._isTuple" class="params-wrap params-array array-tuple"> <div *ngIf="schema.enum" class="param-enum">
<template ngFor [ngForOf]="schema.items" let-item="$implicit" let-idx="index" [ngForTrackBy]="trackByIdx"> <span *ngFor="let enumItem of schema.enum" class="enum-value {{enumItem.type}}"> {{enumItem.val | json}} </span>
<div class="tuple-item"> </div>
<span class="tuple-item-index"> [{{idx}}]: </span> </span>
<json-schema class="nested-schema" [pointer]="item._pointer" [isArray]='item._isArray' </template>
[nestOdd]="!nestOdd" [isRequestSchema]="isRequestSchema"> <template ngSwitchCase="tuple">
</json-schema> <div class="params-wrap params-array array-tuple">
<template ngFor [ngForOf]="schema.items" let-item="$implicit" let-idx="index" [ngForTrackBy]="trackByIdx">
<div class="tuple-item">
<span class="tuple-item-index"> [{{idx}}]: </span>
<json-schema class="nested-schema" [pointer]="item._pointer"
[nestOdd]="!nestOdd" [isRequestSchema]="isRequestSchema">
</json-schema>
</div>
</template>
</div> </div>
</template> </template>
</div> <template ngSwitchCase="array">
<table *ngIf="!schema.isTrivial && !schema.isTuple" class="params-wrap" [ngClass]="{'params-array': _isArray}"> <json-schema class="nested-schema" [pointer]="schema._pointer" [isArray]='true'
<!-- <caption> {{_displayType}} </caption> --> [nestOdd]="!nestOdd" [isRequestSchema]="isRequestSchema"> </json-schema>
<template ngFor [ngForOf]="properties" let-prop="$implicit" let-last="last" [ngForTrackBy]="trackByIdx">
<tr class="param" [ngClass]="{'last': last,
'discriminator': prop.isDiscriminator && !activeDescendant.empty,
'complex': prop._pointer,
'additional': prop._additional,
'expanded': subSchema.visible
}">
<td class="param-name">
<span class="param-name-wrap" (click)="subSchema.toggle()">
<span class="param-name-content" >{{prop._name}}</span>
<svg *ngIf="prop._pointer" xmlns="http://www.w3.org/2000/svg" version="1.1" x="0" y="0" viewBox="0 0 24 24" xml:space="preserve">
<polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "/>
</svg>
</span>
</td>
<td class="param-info">
<div>
<span class="param-type {{prop.type}}" [ngClass]="{'with-hint': prop._displayTypeHint, 'tuple': prop._isTuple}"
title="{{prop._displayTypeHint}}"> {{prop._displayType}} {{prop._displayFormat}}
<span class="param-range" *ngIf="prop._range"> {{prop._range}} </span>
</span>
<span *ngIf="prop._required" class="param-required">Required</span>
<div *ngIf="prop.default">Default: {{prop.default | json}}</div>
<div *ngIf="prop.enum && !prop.isDiscriminator" class="param-enum">
<span *ngFor="let enumItem of prop.enum" class="enum-value {{enumItem.type}}"> {{enumItem.val | json}} </span>
</div>
</div>
<div class="param-description" [innerHtml]="prop.description | marked"></div>
<div class="discriminator-info" *ngIf="prop.isDiscriminator">
<span>This field value determines the exact schema:</span>
<drop-down (change)="selectDescendant($event)">
<option *ngFor="let descendant of schema._descendants; let i=index"
[value]="i">{{descendant.name}}</option>
</drop-down>
</div>
</td>
</tr>
<tr class="param-schema" [ngClass]="{'last': last}" [hidden]="!prop._pointer">
<td colspan="2">
<zippy #subSchema title="Expand" [headless]="true" (open)="lazySchema.load()" [visible]="autoExpand">
<json-schema-lazy #lazySchema [auto]="autoExpand" class="nested-schema" [pointer]="prop._pointer" [isArray]='prop._isArray'
[nestOdd]="!nestOdd" [isRequestSchema]="isRequestSchema">
</json-schema-lazy>
</zippy>
</td>
</tr>
</template> </template>
<tr *ngIf="hasDescendants" class="param-wrap discriminator-wrap" [ngClass]="{empty:activeDescendant.empty}"> <template ngSwitchCase="object">
<td colspan="2"> <table class="params-wrap" [ngClass]="{'params-array': schema._isArray}">
<div class="derived-schema" *ngFor="let descendant of schema._descendants" [ngClass]="{active: descendant.active, empty: descendant.empty}"> <!-- <caption> {{_displayType}} </caption> -->
<json-schema class="discriminator-part" *ngIf="!descendant.empty" [childFor]="pointer" [nestOdd]="nestOdd" <template ngFor [ngForOf]="properties" let-prop="$implicit" let-last="last" [ngForTrackBy]="trackByIdx">
pointer="{{descendant.$ref}}" [final]="descendant.final" [isRequestSchema]="isRequestSchema"> <tr class="param" [ngClass]="{'last': last,
</json-schema> 'discriminator': prop.isDiscriminator && !activeDescendant.empty,
</div> 'complex': prop._pointer,
</td> 'additional': prop._additional,
</tr> 'expanded': subSchema.visible
</table> }">
<td class="param-name">
<span class="param-name-wrap" (click)="subSchema.toggle()">
<span class="param-name-content" >{{prop._name}}</span>
<svg *ngIf="prop._pointer" xmlns="http://www.w3.org/2000/svg" version="1.1" x="0" y="0" viewBox="0 0 24 24" xml:space="preserve">
<polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "/>
</svg>
</span>
</td>
<td class="param-info">
<div>
<span class="param-type {{prop.type}}" [ngClass]="{'with-hint': prop._displayTypeHint, 'tuple': prop._isTuple}"
title="{{prop._displayTypeHint}}"> {{prop._displayType}} {{prop._displayFormat}}
<span class="param-range" *ngIf="prop._range"> {{prop._range}} </span>
</span>
<span *ngIf="prop._required" class="param-required">Required</span>
<div *ngIf="prop.default">Default: {{prop.default | json}}</div>
<div *ngIf="prop.enum && !prop.isDiscriminator" class="param-enum">
<span *ngFor="let enumItem of prop.enum" class="enum-value {{enumItem.type}}"> {{enumItem.val | json}} </span>
</div>
</div>
<div class="param-description" [innerHtml]="prop.description | marked"></div>
<div class="discriminator-info" *ngIf="prop.isDiscriminator">
<span>This field value determines the exact schema:</span>
<drop-down (change)="selectDescendant($event)">
<option *ngFor="let descendant of schema._descendants; let i=index"
[value]="i">{{descendant.name}}</option>
</drop-down>
</div>
</td>
</tr>
<tr class="param-schema" [ngClass]="{'last': last}" [hidden]="!prop._pointer">
<td colspan="2">
<zippy #subSchema title="Expand" [headless]="true" (open)="lazySchema.load()" [visible]="autoExpand">
<json-schema-lazy #lazySchema [auto]="autoExpand" class="nested-schema" [pointer]="prop._pointer"
[nestOdd]="!nestOdd" [isRequestSchema]="isRequestSchema">
</json-schema-lazy>
</zippy>
</td>
</tr>
</template>
<tr *ngIf="hasDescendants" class="param-wrap discriminator-wrap" [ngClass]="{empty:activeDescendant.empty}">
<td colspan="2">
<div class="derived-schema" *ngFor="let descendant of schema._descendants" [ngClass]="{active: descendant.active, empty: descendant.empty}">
<json-schema class="discriminator-part" *ngIf="!descendant.empty" [childFor]="pointer" [nestOdd]="nestOdd"
pointer="{{descendant.$ref}}" [final]="descendant.final" [isRequestSchema]="isRequestSchema">
</json-schema>
</div>
</td>
</tr>
</table>
</template>
</ng-container>

2
lib/components/JsonSchema/json-schema.scss
View File

@ -212,7 +212,7 @@ li:before {
> span { > span {
flex: 0; flex: 0;
padding: 10px 15px; padding: 10px 15px 10px 0;
font-family: monospace; font-family: monospace;
} }

2
lib/components/JsonSchema/json-schema.ts
View File

@ -22,7 +22,6 @@ export class JsonSchema extends BaseComponent {
_hasSubSchemas: boolean = false; _hasSubSchemas: boolean = false;
properties: any; properties: any;
_isArray: boolean; _isArray: boolean;
@Input() isArray: boolean;
@Input() final: boolean = false; @Input() final: boolean = false;
@Input() nestOdd: boolean; @Input() nestOdd: boolean;
@Input() childFor: string; @Input() childFor: string;
@ -89,7 +88,6 @@ export class JsonSchema extends BaseComponent {
} }
this.properties = this.schema._properties; this.properties = this.schema._properties;
this._isArray = this.isArray || this.schema._isArray;
if (this.isRequestSchema) { if (this.isRequestSchema) {
this.properties = this.properties && this.properties.filter(prop => !prop.readOnly); this.properties = this.properties && this.properties.filter(prop => !prop.readOnly);
} }

10
lib/services/schema-helper.service.ts
View File

@ -69,6 +69,7 @@ const injectors = {
|| JsonPointer.join(propertySchema._pointer || propPointer, ['items']); || JsonPointer.join(propertySchema._pointer || propPointer, ['items']);
SchemaHelper.runInjectors(injectTo, propertySchema.items, propPointer); SchemaHelper.runInjectors(injectTo, propertySchema.items, propPointer);
injectTo._widgetType = 'array';
} }
}, },
tuple: { tuple: {
@ -83,7 +84,7 @@ const injectors = {
let itemSchema = propertySchema.items[i]; let itemSchema = propertySchema.items[i];
itemSchema._pointer = itemSchema._pointer || JsonPointer.join(itemsPtr, [i.toString()]); itemSchema._pointer = itemSchema._pointer || JsonPointer.join(itemsPtr, [i.toString()]);
} }
injectTo._widgetType = 'tuple';
// SchemaHelper.runInjectors(injectTo, propertySchema.items, propPointer); // SchemaHelper.runInjectors(injectTo, propertySchema.items, propPointer);
} }
}, },
@ -94,14 +95,16 @@ const injectors = {
inject: (injectTo, propertySchema = injectTo) => { inject: (injectTo, propertySchema = injectTo) => {
let baseName = propertySchema._pointer && JsonPointer.baseName(propertySchema._pointer); let baseName = propertySchema._pointer && JsonPointer.baseName(propertySchema._pointer);
injectTo._displayType = propertySchema.title || baseName || 'object'; injectTo._displayType = propertySchema.title || baseName || 'object';
injectTo._widgetType = 'object';
} }
}, },
noType: { noType: {
check: (propertySchema) => !propertySchema.type, check: (propertySchema) => !propertySchema.type,
inject: (injectTo) => { inject: (injectTo) => {
injectTo._displayType = '< * >'; injectTo._displayType = '< anything >';
injectTo._displayTypeHint = 'This field may contain data of any type'; injectTo._displayTypeHint = 'This field may contain data of any type';
injectTo.isTrivial = true; injectTo.isTrivial = true;
injectTo._widgetType = 'trivial';
} }
}, },
simpleType: { simpleType: {
@ -119,6 +122,7 @@ const injectors = {
injectTo._displayType = propertySchema.title ? injectTo._displayType = propertySchema.title ?
`${propertySchema.title} (${propertySchema.type})` : propertySchema.type; `${propertySchema.title} (${propertySchema.type})` : propertySchema.type;
} }
injectTo._widgetType = 'trivial';
} }
}, },
integer: { integer: {
@ -176,7 +180,7 @@ const injectors = {
let root = SpecManager.instance().schema; let root = SpecManager.instance().schema;
injectTo._produces = parentParam && parentParam.produces || root.produces; injectTo._produces = parentParam && parentParam.produces || root.produces;
injectTo._consumes = parentParam && parentParam.consumes || root.consumes; injectTo._consumes = parentParam && parentParam.consumes || root.consumes;
injectTo._widgetType = 'file';
} }
} }
}; };