mirror of
https://github.com/Redocly/redoc.git
synced 2025-07-09 05:23:04 +03:00
Allow oneOf / anyOf to be used & displayed for root schema definitions
This commit is contained in:
parent
34defb0d74
commit
074872b7ee
|
@ -46,9 +46,17 @@
|
||||||
[nestOdd]="!nestOdd" [isRequestSchema]="isRequestSchema"> </json-schema>
|
[nestOdd]="!nestOdd" [isRequestSchema]="isRequestSchema"> </json-schema>
|
||||||
</ng-template>
|
</ng-template>
|
||||||
<ng-template ngSwitchCase="object">
|
<ng-template ngSwitchCase="object">
|
||||||
|
<div class="one-of-selector" *ngIf="schema._wrapped.length > 1">
|
||||||
|
{{schema._choiceTitle}}
|
||||||
|
<drop-down (change)="selectChoice($event)" [active]="activeChoice">
|
||||||
|
<option *ngFor="let item of schema._wrapped; let i=index"
|
||||||
|
[value]="i" [attr.selected]="activeChoice === i ? '' : null" >{{item.title}}</option>
|
||||||
|
</drop-down>
|
||||||
|
</div>
|
||||||
|
|
||||||
<table class="params-wrap" [ngClass]="{'params-array': _isArray}">
|
<table class="params-wrap" [ngClass]="{'params-array': _isArray}">
|
||||||
<!-- <caption> {{_displayType}} </caption> -->
|
<!-- <caption> {{_displayType}} </caption> -->
|
||||||
<ng-template ngFor [ngForOf]="properties" let-prop="$implicit" let-last="last" [ngForTrackBy]="trackByName">
|
<ng-template ngFor [ngForOf]="schema._wrapped[activeChoice].displayProperties" let-prop="$implicit" let-last="last" [ngForTrackBy]="trackByName">
|
||||||
<tr class="param" [ngClass]="{'last': last,
|
<tr class="param" [ngClass]="{'last': last,
|
||||||
'discriminator': prop.isDiscriminator,
|
'discriminator': prop.isDiscriminator,
|
||||||
'complex': prop._pointer,
|
'complex': prop._pointer,
|
||||||
|
@ -103,5 +111,4 @@
|
||||||
</ng-template>
|
</ng-template>
|
||||||
</table>
|
</table>
|
||||||
</ng-template>
|
</ng-template>
|
||||||
|
|
||||||
</ng-container>
|
</ng-container>
|
||||||
|
|
|
@ -179,6 +179,10 @@ table {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.one-of-selector {
|
||||||
|
text-align: right;
|
||||||
|
}
|
||||||
|
|
||||||
ul, li {
|
ul, li {
|
||||||
margin: 0;
|
margin: 0;
|
||||||
}
|
}
|
||||||
|
|
|
@ -37,6 +37,7 @@ export class JsonSchema extends BaseSearchableComponent implements OnInit {
|
||||||
_isArray: boolean;
|
_isArray: boolean;
|
||||||
normalizer: SchemaNormalizer;
|
normalizer: SchemaNormalizer;
|
||||||
descendants: DescendantInfo[];
|
descendants: DescendantInfo[];
|
||||||
|
activeChoice: number;
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
specMgr: SpecManager,
|
specMgr: SpecManager,
|
||||||
|
@ -96,6 +97,11 @@ export class JsonSchema extends BaseSearchableComponent implements OnInit {
|
||||||
this.selectDescendantByIdx(0);
|
this.selectDescendantByIdx(0);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
selectChoice(index) {
|
||||||
|
if (typeof index === "object") return;
|
||||||
|
this.activeChoice = index
|
||||||
|
}
|
||||||
|
|
||||||
init() {
|
init() {
|
||||||
if (!this.pointer) return;
|
if (!this.pointer) return;
|
||||||
if (!this.absolutePointer) this.absolutePointer = this.pointer;
|
if (!this.absolutePointer) this.absolutePointer = this.pointer;
|
||||||
|
@ -112,29 +118,38 @@ export class JsonSchema extends BaseSearchableComponent implements OnInit {
|
||||||
this._isArray = this.schema._isArray;
|
this._isArray = this.schema._isArray;
|
||||||
this.absolutePointer += (this._isArray ? '/items' : '');
|
this.absolutePointer += (this._isArray ? '/items' : '');
|
||||||
this.initDescendants();
|
this.initDescendants();
|
||||||
|
this.selectChoice(0);
|
||||||
this.preprocessSchema();
|
this.preprocessSchema();
|
||||||
}
|
}
|
||||||
|
|
||||||
preprocessSchema() {
|
preprocessSchema() {
|
||||||
SchemaHelper.preprocess(this.schema, this.normPointer, this.pointer);
|
SchemaHelper.preprocess(this.schema, this.normPointer, this.pointer);
|
||||||
|
|
||||||
if (!this.schema.isTrivial) {
|
if (!this.schema.isTrivial && !this.schema._wrapped) {
|
||||||
SchemaHelper.preprocessProperties(this.schema, this.normPointer, {
|
SchemaHelper.preprocessProperties(this.schema, this.normPointer, {
|
||||||
childFor: this.childFor,
|
childFor: this.childFor,
|
||||||
discriminator: this.discriminator
|
discriminator: this.discriminator
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
this.properties = this.schema._properties || [];
|
if (this.schema._wrapped) {
|
||||||
|
this.schema._wrapped.forEach((schema) => {
|
||||||
|
SchemaHelper.preprocessProperties(schema, this.normPointer, {
|
||||||
|
childFor: this.childFor,
|
||||||
|
discriminator: this.discriminator
|
||||||
|
});
|
||||||
|
|
||||||
|
let properties = schema._properties || [];
|
||||||
|
|
||||||
if (this.isRequestSchema) {
|
if (this.isRequestSchema) {
|
||||||
this.properties = this.properties.filter(prop => !prop.readOnly);
|
properties = properties.filter(prop => !prop.readOnly);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (this.optionsService.options.requiredPropsFirst) {
|
if (this.optionsService.options.requiredPropsFirst) {
|
||||||
SchemaHelper.moveRequiredPropsFirst(this.properties, this.schema.required);
|
SchemaHelper.moveRequiredPropsFirst(properties, schema.required);
|
||||||
}
|
}
|
||||||
|
|
||||||
this._hasSubSchemas = this.properties && this.properties.some(
|
this._hasSubSchemas = properties && properties.some(
|
||||||
propSchema => {
|
propSchema => {
|
||||||
if (propSchema.type === 'array') {
|
if (propSchema.type === 'array') {
|
||||||
propSchema = propSchema.items;
|
propSchema = propSchema.items;
|
||||||
|
@ -142,8 +157,12 @@ export class JsonSchema extends BaseSearchableComponent implements OnInit {
|
||||||
return (propSchema && propSchema.type === 'object' && propSchema._pointer);
|
return (propSchema && propSchema.type === 'object' && propSchema._pointer);
|
||||||
});
|
});
|
||||||
|
|
||||||
if (this.properties.length === 1) {
|
if (properties.length === 1) {
|
||||||
this.properties[0].expanded = true;
|
properties[0].expanded = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
schema.displayProperties = properties
|
||||||
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -85,17 +85,33 @@ const injectors = {
|
||||||
},
|
},
|
||||||
object: {
|
object: {
|
||||||
check: (propertySchema) => {
|
check: (propertySchema) => {
|
||||||
return propertySchema.type === 'object' && (propertySchema.properties ||
|
let isObject = propertySchema.type === 'object' && (propertySchema.properties ||
|
||||||
typeof propertySchema.additionalProperties === 'object');
|
typeof propertySchema.additionalProperties === 'object');
|
||||||
|
|
||||||
|
let isChoiceObject = propertySchema.oneOf && propertySchema.oneOf.length > 0 ||
|
||||||
|
propertySchema.anyOf && propertySchema.anyOf.length > 0
|
||||||
|
|
||||||
|
return isObject || isChoiceObject;
|
||||||
},
|
},
|
||||||
inject: (injectTo, propertySchema = injectTo) => {
|
inject: (injectTo, propertySchema = injectTo) => {
|
||||||
|
injectTo._widgetType = 'object';
|
||||||
|
if (propertySchema.type === 'object') {
|
||||||
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';
|
injectTo._wrapped = [propertySchema];
|
||||||
|
} else if (propertySchema.oneOf) {
|
||||||
|
injectTo._displayType = 'oneOf';
|
||||||
|
injectTo._choiceTitle = 'One of';
|
||||||
|
injectTo._wrapped = propertySchema.oneOf
|
||||||
|
} else if (propertySchema.anyOf) {
|
||||||
|
injectTo._displayType = 'anyOf';
|
||||||
|
injectTo._choiceTitle = 'Any of';
|
||||||
|
injectTo._wrapped = propertySchema.anyOf
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
noType: {
|
noType: {
|
||||||
check: (propertySchema) => !propertySchema.type,
|
check: (propertySchema) => !propertySchema.type && !propertySchema.oneOf && !propertySchema.anyOf,
|
||||||
inject: (injectTo) => {
|
inject: (injectTo) => {
|
||||||
injectTo._displayType = '< anything >';
|
injectTo._displayType = '< anything >';
|
||||||
injectTo._displayTypeHint = 'This field may contain data of any type';
|
injectTo._displayTypeHint = 'This field may contain data of any type';
|
||||||
|
@ -110,7 +126,7 @@ const injectors = {
|
||||||
return (!propertySchema.properties || !Object.keys(propertySchema.properties).length)
|
return (!propertySchema.properties || !Object.keys(propertySchema.properties).length)
|
||||||
&& (typeof propertySchema.additionalProperties !== 'object');
|
&& (typeof propertySchema.additionalProperties !== 'object');
|
||||||
}
|
}
|
||||||
return (propertySchema.type !== 'array') && propertySchema.type;
|
return (propertySchema.type !== 'array' && !propertySchema.oneOf && !propertySchema.anyOf) && propertySchema.type;
|
||||||
},
|
},
|
||||||
inject: (injectTo, propertySchema = injectTo) => {
|
inject: (injectTo, propertySchema = injectTo) => {
|
||||||
injectTo.isTrivial = true;
|
injectTo.isTrivial = true;
|
||||||
|
|
|
@ -13,6 +13,8 @@ interface Reference {
|
||||||
interface Schema {
|
interface Schema {
|
||||||
properties: any;
|
properties: any;
|
||||||
allOf: any;
|
allOf: any;
|
||||||
|
oneOf: any;
|
||||||
|
anyOf: any;
|
||||||
items: any;
|
items: any;
|
||||||
additionalProperties: any;
|
additionalProperties: any;
|
||||||
}
|
}
|
||||||
|
@ -73,6 +75,16 @@ class SchemaWalker {
|
||||||
SchemaWalker.walkEach(obj.allOf, ptr, visitor);
|
SchemaWalker.walkEach(obj.allOf, ptr, visitor);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (obj.oneOf) {
|
||||||
|
let ptr = JsonPointer.join(pointer, ['oneOf']);
|
||||||
|
SchemaWalker.walkEach(obj.oneOf, ptr, visitor);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (obj.anyOf) {
|
||||||
|
let ptr = JsonPointer.join(pointer, ['anyOf']);
|
||||||
|
SchemaWalker.walkEach(obj.anyOf, ptr, visitor);
|
||||||
|
}
|
||||||
|
|
||||||
if (obj.items) {
|
if (obj.items) {
|
||||||
let ptr = JsonPointer.join(pointer, ['items']);
|
let ptr = JsonPointer.join(pointer, ['items']);
|
||||||
if (Array.isArray(obj.items)) {
|
if (Array.isArray(obj.items)) {
|
||||||
|
|
Loading…
Reference in New Issue
Block a user