in docfx/_exported_templates/default/RestApi.common.js [4:257]
exports.transform = function (model) {
var _fileNameWithoutExt = common.path.getFileNameWithoutExtension(model._path);
model._jsonPath = _fileNameWithoutExt + ".swagger.json";
model.title = model.title || model.name;
model.docurl = model.docurl || common.getImproveTheDocHref(model, model._gitContribute, model._gitUrlPattern);
model.sourceurl = model.sourceurl || common.getViewSourceHref(model, null, model._gitUrlPattern);
model.htmlId = common.getHtmlId(model.uid);
if (model.children) {
for (var i = 0; i < model.children.length; i++) {
var child = model.children[i];
child.docurl = child.docurl || common.getImproveTheDocHref(child, model._gitContribute, model._gitUrlPattern);
if (child.operation) {
child.operation = child.operation.toUpperCase();
}
child.path = appendQueryParamsToPath(child.path, child.parameters);
child.sourceurl = child.sourceurl || common.getViewSourceHref(child, null, model._gitUrlPattern);
child.conceptual = child.conceptual || ''; // set to empty incase mustache looks up
child.footer = child.footer || ''; // set to empty incase mustache looks up
child.remarks = child.remarks || ''; // set to empty incase mustache looks up
child.htmlId = common.getHtmlId(child.uid);
formatExample(child.responses);
resolveAllOf(child);
transformReference(child);
};
if (!model.tags || model.tags.length === 0) {
var childTags = [];
for (var i = 0; i < model.children.length; i++) {
var child = model.children[i];
if (child.tags && child.tags.length > 0) {
for (var k = 0; k < child.tags.length; k++) {
// for each tag in child, add unique tag string into childTags
if (childTags.indexOf(child.tags[k]) === -1) {
childTags.push(child.tags[k]);
}
}
}
}
// sort alphabetically
childTags.sort();
if (childTags.length > 0) {
model.tags = [];
for (var i = 0; i < childTags.length; i++) {
// add tags into model
model.tags.push({ "name": childTags[i] });
}
}
}
if (model.tags) {
for (var i = 0; i < model.tags.length; i++) {
var children = getChildrenByTag(model.children, model.tags[i].name);
if (children) {
// set children into tag section
model.tags[i].children = children;
}
model.tags[i].conceptual = model.tags[i].conceptual || ''; // set to empty incase mustache looks up
if (model.tags[i]["x-bookmark-id"]) {
model.tags[i].htmlId = model.tags[i]["x-bookmark-id"];
} else if (model.tags[i].uid) {
model.tags[i].htmlId = common.getHtmlId(model.tags[i].uid);
}
}
for (var i = 0; i < model.children.length; i++) {
var child = model.children[i];
if (child.includedInTags) {
// set child to undefined, which is already moved to tag section
model.children[i] = undefined;
if (!model.isTagLayout) {
// flags to indicate the model is tag layout
model.isTagLayout = true;
}
}
}
// remove undefined child
model.children = model.children.filter(function (o) { return o; });
}
}
return model;
function getChildrenByTag(children, tag) {
if (!children) return;
return children.filter(function (child) {
if (child.tags && child.tags.indexOf(tag) > -1) {
child.includedInTags = true;
return true;
}
})
}
function formatExample(responses) {
if (!responses) return;
for (var i = responses.length - 1; i >= 0; i--) {
var examples = responses[i].examples;
if (!examples) continue;
for (var j = examples.length - 1; j >= 0; j--) {
var content = examples[j].content;
if (!content) continue;
var mimeType = examples[j].mimeType;
if (mimeType === 'application/json') {
try {
var json = JSON.parse(content)
responses[i].examples[j].content = JSON.stringify(json, null, ' ');
} catch (e) {
console.warn("example is not a valid JSON object.");
}
}
}
}
}
function resolveAllOf(obj) {
if (Array.isArray(obj)) {
for (var i = 0; i < obj.length; i++) {
resolveAllOf(obj[i]);
}
}
else if (typeof obj === "object") {
for (var key in obj) {
if (obj.hasOwnProperty(key)) {
if (key === "allOf" && Array.isArray(obj[key])) {
// find 'allOf' array and process
processAllOfArray(obj[key], obj);
// delete 'allOf' value
delete obj[key];
} else {
resolveAllOf(obj[key]);
}
}
}
}
}
function processAllOfArray(allOfArray, originalObj) {
// for each object in 'allOf' array, merge the values to those in the same level with 'allOf'
for (var i = 0; i < allOfArray.length; i++) {
var item = allOfArray[i];
for (var key in item) {
if (originalObj.hasOwnProperty(key)) {
mergeObjByKey(originalObj[key], item[key]);
} else {
originalObj[key] = item[key];
}
}
}
}
function mergeObjByKey(targetObj, sourceObj) {
for (var key in sourceObj) {
// merge only when target object doesn't define the key
if (!targetObj.hasOwnProperty(key)) {
targetObj[key] = sourceObj[key];
}
}
}
function transformReference(obj) {
if (Array.isArray(obj)) {
for (var i = 0; i < obj.length; i++) {
transformReference(obj[i]);
}
}
else if (typeof obj === "object") {
for (var key in obj) {
if (obj.hasOwnProperty(key)) {
if (key === "schema") {
// transform schema.properties from obj to key value pair
transformProperties(obj[key]);
} else {
transformReference(obj[key]);
}
}
}
}
}
function transformProperties(obj) {
if (obj.properties) {
if (obj.required && Array.isArray(obj.required)) {
for (var i = 0; i < obj.required.length; i++) {
var field = obj.required[i];
if (obj.properties[field]) {
// add required field as property
obj.properties[field].required = true;
}
}
delete obj.required;
}
var array = [];
for (var key in obj.properties) {
if (obj.properties.hasOwnProperty(key)) {
var value = obj.properties[key];
// set description to null incase mustache looks up
value.description = value.description || null;
transformPropertiesValue(value);
array.push({ key: key, value: value });
}
}
obj.properties = array;
}
}
function transformPropertiesValue(obj) {
if (obj.type === "array" && obj.items) {
// expand array to transformProperties
obj.items.properties = obj.items.properties || null;
obj.items['x-internal-ref-name'] = obj.items['x-internal-ref-name'] || null;
obj.items['x-internal-loop-ref-name'] = obj.items['x-internal-loop-ref-name'] || null;
transformProperties(obj.items);
} else if (obj.properties && !obj.items) {
// fill obj.properties into obj.items.properties, to be rendered in the same way with array
obj.items = {};
obj.items.properties = obj.properties || null;
delete obj.properties;
if (obj.required) {
obj.items.required = obj.required;
delete obj.required;
}
obj.items['x-internal-ref-name'] = obj['x-internal-ref-name'] || null;
obj.items['x-internal-loop-ref-name'] = obj['x-internal-loop-ref-name'] || null;
transformProperties(obj.items);
}
}
function appendQueryParamsToPath(path, parameters) {
if (!path || !parameters) return path;
var requiredQueryParams = parameters.filter(function (p) { return p.in === 'query' && p.required; });
if (requiredQueryParams.length > 0) {
path = formatParams(path, requiredQueryParams, true);
}
var optionalQueryParams = parameters.filter(function (p) { return p.in === 'query' && !p.required; });
if (optionalQueryParams.length > 0) {
path += "[";
path = formatParams(path, optionalQueryParams, requiredQueryParams.length === 0);
path += "]";
}
return path;
}
function formatParams(path, parameters, isFirst) {
for (var i = 0; i < parameters.length; i++) {
if (i === 0 && isFirst) {
path += "?";
} else {
path += "&";
}
path += parameters[i].name;
}
return path;
}
}