Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions lib/generateOutput.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ exports.generateFunction = function generateFunction(obj, keywords) {
isUndefined(obj.description, keywords.descriptionText, outputArr);
addClosingParanthesis = true;
}
(obj.minLength === undefined) ? '' : outputArr.push(keywords.minimumLengthText + ' ' + obj.minLength);
(obj.maxLength === undefined) ? '' : outputArr.push(keywords.maximumLengthText + ' ' + obj.maxLength);
(obj.pattern === undefined) ? '' : outputArr.push((keywords.patternText + ' ' + obj.pattern));
(obj.format === undefined) ? '' : outputArr.push((keywords.formatText + ' ' + obj.format));
(obj.example === undefined) ? '' : outputArr.push((keywords.exampleText + ' ' + obj.example));
(obj.default === undefined) ? '' : outputArr.push((keywords.defaultText + ' ' + obj.default));
isUndefined(obj.minLength, keywords.minimumLengthText, outputArr);
isUndefined(obj.maxLength, keywords.maximumLengthText, outputArr);
isUndefined(obj.pattern, keywords.patternText, outputArr);
isUndefined(obj.format, keywords.formatText, outputArr);
isUndefined(obj.example, keywords.exampleText, outputArr);
isUndefined(obj.default, keywords.defaultText, outputArr);
str += outputArr.join(keywords.separator + ' ');
if (addClosingParanthesis) {
str += keywords.closingParanthesis;
Expand Down
10 changes: 6 additions & 4 deletions lib/keywords-mapping.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ var keywordMapping = {
discriminatorText: "-Discriminator",
minimumLengthText: "Minimum Length",
maximumLengthText: "Maximum Length",
patternText: "KPattern",
patternText: "Pattern",
exampleText: "Example",
formatText: "Format",
defaultText: "KDefault",
defaultText: "Default",
minimumText: "Minimum",
maximumText: "Maximum",
multipleOfText: "Multiple Of",
Expand All @@ -28,12 +28,14 @@ var keywordMapping = {
objectEnd: "}",
arrayStart: "[",
arrayEnd: "]",
arrayText: "array"
arrayText: "array",
enumSeperator: "-"
};

var formatMapping = {
formatStart: "<h>",
formatEnd: "</h>"
formatEnd: "</h>",
descTitle: "Description added by schematodoc module."

}

Expand Down
37 changes: 27 additions & 10 deletions lib/parseSchema.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ var _ = require('lodash');
var stream = require('fs');
var alternateFunc = require('./generateOutput');
var keywords = require('./keywords-mapping.js').keywordMapping;
var format = require('./keywords-mapping.js').formatMapping;

var yaml = require('js-yaml');
//var jsonToyaml = require('json2yaml'); //require('write-yaml');
Expand Down Expand Up @@ -32,8 +33,14 @@ var space10 = ' ';
fullInput = getDefinitionFromSwagger(inputFilePath, url, method, keyArr);
var obj = {};
var finaloutput = '';
var descTitle = '';
var finalObj = {};
var methDetail = 'For method ' + method + ', ';
if (options.serializer || '') {
_.merge(keywords, options.serializer);
}
descTitle = (format.formatStart || '') + (format.descTitle || '') + (format.formatEnd || '');
finaloutput = finaloutput + descTitle;
_.each(keyArr, function(key) {
_.set(obj, key.key, getToRoot(fullInput.definitions, key.key));
finalObj.method = method;
Expand All @@ -42,9 +49,7 @@ var space10 = ' ';
finalObj.fields = obj;
var title = methDetail + finalObj.type + ', ' + finalObj.code + ' \r\n ';

if (options.serializer || '') {
_.merge(keywords, options.serializer);
}

console.log(JSON.stringify(finalObj));
finaloutput = finaloutput + ' \r\n ' + title + buildStr((_.get(finalObj.fields, key.key)).properties, genFunc === undefined ? alternateFunc.generateFunction : genFunc, spacesToAdd, spacesToAdd, keywords);
});
Expand Down Expand Up @@ -297,7 +302,7 @@ function buildStr(obj, genFunc, spacesToAdd, origSpace, serializer) {
} else {

if (_.size(property.properties) === 1 && property.properties[0].type === 'string') {
formattedStr = formattedStr + serializer.objectStart + genFunc(property.properties[0], serializer) + serializer.objectEnd;
formattedStr = formattedStr + serializer.openningParanthesis + genFunc(property.properties[0], serializer) + serializer.closingParanthesis;

//formattedStr = formattedStr + '{' + buildStr(property.properties, genFunc, spacesToAdd + space2 , spacesToAdd, serializer) + '\r\n' + origSpace + ' ' +'}';
} else if (_.size(property.properties) === 1 && _.has(property.properties[0], 'itemType')) {
Expand Down Expand Up @@ -418,18 +423,22 @@ function processRef (item, itemObj) {

} else if (_.startsWith(propRef, '#')) {
var ref = _.last(propRef.split('/'));
if (_.get(fullInput.definitions, ref).type !== undefined) {
var refDefinition = _.get(fullInput.definitions, ref);
if (refDefinition.type !== undefined) {
var child = {};
processType(_.get(fullInput.definitions, ref), child);
processType(refDefinition, child);
itemObj.reference = ref;
if (_.has(child, 'child')) {
itemObj.properties = child.child;
} else {
itemObj.properties = [child];
}
} else {
} else if (refDefinition.properties !== undefined) {
itemObj.reference = ref;
itemObj.properties = processProperties(_.get(fullInput.definitions, ref).properties, _.get(fullInput.definitions, ref).required, _.get(fullInput.definitions, ref).discriminator, _.get(fullInput.definitions, ref).readOnly);
itemObj.properties = processProperties(refDefinition.properties, refDefinition.required, refDefinition.discriminator, refDefinition.readOnly);
} else if (_.has(refDefinition, 'enum')) {
itemObj.type = 'enum';
_.set(itemObj, 'values' ,_.join( refDefinition.enum, ','));
}

}
Expand Down Expand Up @@ -469,11 +478,12 @@ function buildStringData(item, itemObj) {
}

if (example !== '') {
itemObj.example = example;
itemObj.example = escapeColon(example);
}

if (defaultVal !== '') {
itemObj.default = defaultVal;
itemObj.default = escapeColon(defaultVal);
//console.log(itemObj.default);
}

if (enumVal !== '') {
Expand Down Expand Up @@ -603,6 +613,13 @@ function isUndefined(propItem) {
}
}

function escapeColon(value) {
if(value.indexOf(': ') !== -1) {
//console.log(value);
//console.log('i found');
return value.replace(': ', '\\:\\ ');
}
}
function appendTextToAnchorVariable(inputFilePath) {
var updated = [];
var swaggerFile = stream.readFileSync(inputFilePath, 'utf8');
Expand Down