mirror of
https://github.com/Redocly/redoc.git
synced 2025-02-06 21:10:33 +03:00
big refactoring of injectPropertyData method
This commit is contained in:
parent
0d3d9213de
commit
ac7116ad04
|
@ -71,11 +71,13 @@ export default class JsonSchema extends BaseComponent {
|
|||
|
||||
let discriminatorFieldIdx = -1;
|
||||
let props = Object.keys(schema.properties).map((prop, idx) => {
|
||||
let propData = schema.properties[prop];
|
||||
let propertySchema = schema.properties[prop];
|
||||
let propPointer = JsonPointer.join(this.pointer, ['properties', prop]);
|
||||
propData = JsonSchema.injectPropData(propData, prop, propPointer, this.requiredMap, schema);
|
||||
if (propData.isDiscriminator) discriminatorFieldIdx = idx;
|
||||
return propData;
|
||||
propertySchema = JsonSchema.injectPropertyData(propertySchema, prop, propPointer);
|
||||
propertySchema.required = !!this.requiredMap[prop];
|
||||
propertySchema.isDiscriminator = (schema.discriminator === prop);
|
||||
if (propertySchema.isDiscriminator) discriminatorFieldIdx = idx;
|
||||
return propertySchema;
|
||||
});
|
||||
// Move discriminator field to the end of properties list
|
||||
if (discriminatorFieldIdx > -1) {
|
||||
|
@ -85,49 +87,81 @@ export default class JsonSchema extends BaseComponent {
|
|||
this.data.properties = props;
|
||||
}
|
||||
|
||||
static injectPropData(propData, propName, propPointer, requiredMap, schema) {
|
||||
let propEnum;
|
||||
static injectPropertyData(propertySchema, propertyName, propPointer) {
|
||||
propertySchema = Object.assign({}, propertySchema);
|
||||
|
||||
propData = Object.assign({}, propData);
|
||||
propData._name = propName;
|
||||
propData.required = propData.required || (requiredMap && requiredMap[propName]);
|
||||
propData._displayType = propData.type;
|
||||
propData.isDiscriminator = (schema && schema.discriminator === propName);
|
||||
propEnum = propData.enum;
|
||||
if (propData.type === 'array') {
|
||||
let itemType = propData.items.type;
|
||||
let itemFormat = propData.items.format;
|
||||
propEnum = propData.items.enum;
|
||||
if (itemType === 'object' || !itemType) {
|
||||
itemType = propData.items.title || 'object';
|
||||
propData._pointer = propData.items._pointer
|
||||
|| JsonPointer.join(propPointer, ['items']);
|
||||
}
|
||||
propData._displayType = `${itemType}`;
|
||||
propData.format = itemFormat;
|
||||
propData._isArray = true;
|
||||
propData.type = 'array ' + propData.items.type;
|
||||
} else if (propData.type === 'object' && propData.properties) {
|
||||
propData._displayType = propData.title || 'object';
|
||||
} else if (!propData.type) {
|
||||
propData._displayType = '< * >';
|
||||
propData._displayTypeHint = 'This field may contain data of any type';
|
||||
} else {
|
||||
// here we are sure that property has simple type (integer, string, object withou properties)
|
||||
// delete pointer for simple types to not show it as subschema
|
||||
if (propData._pointer) {
|
||||
propData._pointer = undefined;
|
||||
propData._displayType = propData.title ? `${propData.title} (${propData.type})` : propData.type;
|
||||
}
|
||||
}
|
||||
propertySchema._name = propertyName;
|
||||
runInjectors(propertySchema, propertySchema, propPointer);
|
||||
|
||||
if (propData.format) propData._displayFormat = `<${propData.format}>`;
|
||||
if (propEnum) {
|
||||
propData.enum = propEnum.map((value) => {
|
||||
return {val: value, type: typeof value};
|
||||
});
|
||||
}
|
||||
|
||||
return propData;
|
||||
return propertySchema;
|
||||
}
|
||||
}
|
||||
|
||||
function runInjectors(injectTo, propertySchema, propertyPointer) {
|
||||
for (var injName in injectors) {
|
||||
let injector = injectors[injName];
|
||||
if (injector.check(propertySchema)) {
|
||||
injector.inject(injectTo, propertySchema, propertyPointer);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const injectors = {
|
||||
general: {
|
||||
check: () => true,
|
||||
inject: (injectTo, propertySchema) => {
|
||||
injectTo._displayType = propertySchema.type;
|
||||
if (propertySchema.format) injectTo._displayFormat = `<${propertySchema.format}>`;
|
||||
if (propertySchema.enum) {
|
||||
injectTo.enum = propertySchema.enum.map((value) => {
|
||||
return {val: value, type: typeof value};
|
||||
});
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
array: {
|
||||
check: (propertySchema) => {
|
||||
return propertySchema.type === 'array';
|
||||
},
|
||||
inject: (injectTo, propertySchema = injectTo, propPointer) => {
|
||||
injectTo._isArray = true;
|
||||
injectTo._pointer = propertySchema.items._pointer
|
||||
|| JsonPointer.join(propPointer, ['items']);
|
||||
|
||||
runInjectors(injectTo, propertySchema.items, propPointer);
|
||||
}
|
||||
},
|
||||
|
||||
object: {
|
||||
check: (propertySchema) => {
|
||||
return propertySchema.type === 'object' && propertySchema.properties;
|
||||
},
|
||||
inject: (injectTo, propertySchema = injectTo) => {
|
||||
injectTo._displayType = propertySchema.title || 'object';
|
||||
}
|
||||
},
|
||||
noType: {
|
||||
check: (propertySchema) => !propertySchema.type,
|
||||
inject: (injectTo) => {
|
||||
injectTo._displayType = '< * >';
|
||||
injectTo._displayTypeHint = 'This field may contain data of any type';
|
||||
}
|
||||
},
|
||||
|
||||
simpleType: {
|
||||
check: (propertySchema) => {
|
||||
if (propertySchema.type === 'object') {
|
||||
return !propertySchema.properties;
|
||||
}
|
||||
return (propertySchema.type !== 'array') && propertySchema.type;
|
||||
},
|
||||
inject: (injectTo, propertySchema = injectTo) => {
|
||||
if (injectTo._pointer) {
|
||||
injectTo._pointer = undefined;
|
||||
injectTo._displayType = propertySchema.title ?
|
||||
`${propertySchema.title} (${propertySchema.type})` : propertySchema.type;
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
|
|
@ -27,7 +27,7 @@ export default class ParamsList extends BaseComponent {
|
|||
paramsList = paramsList.map((paramData) => {
|
||||
let propPointer = paramData._pointer;
|
||||
if (paramData.in === 'body') return paramData;
|
||||
return JsonSchema.injectPropData(paramData, paramData.name, propPointer);
|
||||
return JsonSchema.injectPropertyData(paramData, paramData.name, propPointer);
|
||||
});
|
||||
|
||||
let paramsMap = this.orderParams(paramsList);
|
||||
|
|
Loading…
Reference in New Issue
Block a user