@ismael1361/router 1.1.0 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/HandleError.esm.js +127 -0
- package/dist/HandleError.esm.js.map +1 -0
- package/dist/HandleError.js +129 -0
- package/dist/HandleError.js.map +1 -0
- package/dist/Layer.esm.js +251 -0
- package/dist/Layer.esm.js.map +1 -0
- package/dist/Layer.js +253 -0
- package/dist/Layer.js.map +1 -0
- package/dist/Middlewares.esm.js +188 -0
- package/dist/Middlewares.esm.js.map +1 -0
- package/dist/Middlewares.js +195 -0
- package/dist/Middlewares.js.map +1 -0
- package/dist/handler.esm.js +171 -0
- package/dist/handler.esm.js.map +1 -0
- package/dist/handler.js +174 -0
- package/dist/handler.js.map +1 -0
- package/dist/index.esm.js +141 -1
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +152 -1
- package/dist/index.js.map +1 -1
- package/dist/middleware.esm.js +152 -0
- package/dist/middleware.esm.js.map +1 -0
- package/dist/middleware.js +155 -0
- package/dist/middleware.js.map +1 -0
- package/dist/node_modules/tslib/tslib.es6.esm.js +46 -0
- package/dist/node_modules/tslib/tslib.es6.esm.js.map +1 -0
- package/dist/node_modules/tslib/tslib.es6.js +49 -0
- package/dist/node_modules/tslib/tslib.es6.js.map +1 -0
- package/dist/redocUi/index.esm.js +75 -0
- package/dist/redocUi/index.esm.js.map +1 -0
- package/dist/redocUi/index.js +77 -0
- package/dist/redocUi/index.js.map +1 -0
- package/dist/router.esm.js +435 -0
- package/dist/router.esm.js.map +1 -0
- package/dist/router.js +437 -0
- package/dist/router.js.map +1 -0
- package/dist/swagger-markdown/index.esm.js +129 -0
- package/dist/swagger-markdown/index.esm.js.map +1 -0
- package/dist/swagger-markdown/index.js +135 -0
- package/dist/swagger-markdown/index.js.map +1 -0
- package/dist/swagger-markdown/lib/anchor.esm.js +7 -0
- package/dist/swagger-markdown/lib/anchor.esm.js.map +1 -0
- package/dist/swagger-markdown/lib/anchor.js +9 -0
- package/dist/swagger-markdown/lib/anchor.js.map +1 -0
- package/dist/swagger-markdown/lib/inArray.esm.js +21 -0
- package/dist/swagger-markdown/lib/inArray.esm.js.map +1 -0
- package/dist/swagger-markdown/lib/inArray.js +23 -0
- package/dist/swagger-markdown/lib/inArray.js.map +1 -0
- package/dist/swagger-markdown/models/schema.esm.js +65 -0
- package/dist/swagger-markdown/models/schema.esm.js.map +1 -0
- package/dist/swagger-markdown/models/schema.js +67 -0
- package/dist/swagger-markdown/models/schema.js.map +1 -0
- package/dist/swagger-markdown/transformers/contact.esm.js +24 -0
- package/dist/swagger-markdown/transformers/contact.esm.js.map +1 -0
- package/dist/swagger-markdown/transformers/contact.js +26 -0
- package/dist/swagger-markdown/transformers/contact.js.map +1 -0
- package/dist/swagger-markdown/transformers/dataTypes.esm.js +60 -0
- package/dist/swagger-markdown/transformers/dataTypes.esm.js.map +1 -0
- package/dist/swagger-markdown/transformers/dataTypes.js +62 -0
- package/dist/swagger-markdown/transformers/dataTypes.js.map +1 -0
- package/dist/swagger-markdown/transformers/definitions.esm.js +76 -0
- package/dist/swagger-markdown/transformers/definitions.esm.js.map +1 -0
- package/dist/swagger-markdown/transformers/definitions.js +81 -0
- package/dist/swagger-markdown/transformers/definitions.js.map +1 -0
- package/dist/swagger-markdown/transformers/externalDocs.esm.js +14 -0
- package/dist/swagger-markdown/transformers/externalDocs.esm.js.map +1 -0
- package/dist/swagger-markdown/transformers/externalDocs.js +16 -0
- package/dist/swagger-markdown/transformers/externalDocs.js.map +1 -0
- package/dist/swagger-markdown/transformers/info.esm.js +37 -0
- package/dist/swagger-markdown/transformers/info.esm.js.map +1 -0
- package/dist/swagger-markdown/transformers/info.js +39 -0
- package/dist/swagger-markdown/transformers/info.js.map +1 -0
- package/dist/swagger-markdown/transformers/license.esm.js +21 -0
- package/dist/swagger-markdown/transformers/license.esm.js.map +1 -0
- package/dist/swagger-markdown/transformers/license.js +23 -0
- package/dist/swagger-markdown/transformers/license.js.map +1 -0
- package/dist/swagger-markdown/transformers/path.esm.js +72 -0
- package/dist/swagger-markdown/transformers/path.esm.js.map +1 -0
- package/dist/swagger-markdown/transformers/path.js +77 -0
- package/dist/swagger-markdown/transformers/path.js.map +1 -0
- package/dist/swagger-markdown/transformers/pathParameters.esm.js +63 -0
- package/dist/swagger-markdown/transformers/pathParameters.esm.js.map +1 -0
- package/dist/swagger-markdown/transformers/pathParameters.js +65 -0
- package/dist/swagger-markdown/transformers/pathParameters.js.map +1 -0
- package/dist/swagger-markdown/transformers/pathResponses.esm.js +46 -0
- package/dist/swagger-markdown/transformers/pathResponses.esm.js.map +1 -0
- package/dist/swagger-markdown/transformers/pathResponses.js +48 -0
- package/dist/swagger-markdown/transformers/pathResponses.js.map +1 -0
- package/dist/swagger-markdown/transformers/security.esm.js +42 -0
- package/dist/swagger-markdown/transformers/security.esm.js.map +1 -0
- package/dist/swagger-markdown/transformers/security.js +44 -0
- package/dist/swagger-markdown/transformers/security.js.map +1 -0
- package/dist/swagger-markdown/transformers/securityDefinitions.esm.js +52 -0
- package/dist/swagger-markdown/transformers/securityDefinitions.esm.js.map +1 -0
- package/dist/swagger-markdown/transformers/securityDefinitions.js +58 -0
- package/dist/swagger-markdown/transformers/securityDefinitions.js.map +1 -0
- package/dist/utils.esm.js +245 -0
- package/dist/utils.esm.js.map +1 -0
- package/dist/utils.js +257 -0
- package/dist/utils.js.map +1 -0
- package/package.json +2 -2
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
+
|
|
5
|
+
var dataTypes = require('./dataTypes.js');
|
|
6
|
+
var inArray = require('../lib/inArray.js');
|
|
7
|
+
var schema = require('../models/schema.js');
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* If Property field is present parse them.
|
|
11
|
+
* @param name of the definition
|
|
12
|
+
* @param definition definition object
|
|
13
|
+
*/
|
|
14
|
+
const parseProperties = (name, definition) => {
|
|
15
|
+
const required = "required" in definition ? definition.required : [];
|
|
16
|
+
const res = [];
|
|
17
|
+
Object.keys(definition.properties).map((propName) => {
|
|
18
|
+
const prop = definition.properties[propName];
|
|
19
|
+
const typeCell = dataTypes(new schema(prop));
|
|
20
|
+
const descriptionCell = ("description" in prop ? prop.description : "").replace(/[\r\n]/g, " ");
|
|
21
|
+
const requiredCell = inArray(propName, required) ? "Yes" : "No";
|
|
22
|
+
res.push(`| ${propName} | ${typeCell} | ${descriptionCell} | ${requiredCell} |`);
|
|
23
|
+
});
|
|
24
|
+
return res.filter((v) => (v || "").trim() !== "");
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* Parse allOf definition
|
|
28
|
+
* @param name of the definition
|
|
29
|
+
* @param definition definition object
|
|
30
|
+
*/
|
|
31
|
+
const parsePrimitive = (name, definition) => {
|
|
32
|
+
const res = [];
|
|
33
|
+
const typeCell = "type" in definition ? definition.type : "";
|
|
34
|
+
const descriptionCell = ("description" in definition ? definition.description : "").replace(/[\r\n]/g, " ");
|
|
35
|
+
const requiredCell = "";
|
|
36
|
+
res.push(`| ${name} | ${typeCell} | ${descriptionCell} | ${requiredCell} |`);
|
|
37
|
+
return res.filter((v) => (v || "").trim() !== "");
|
|
38
|
+
};
|
|
39
|
+
/**
|
|
40
|
+
* @param {type} name
|
|
41
|
+
* @param {type} definition
|
|
42
|
+
* @return {type} Description
|
|
43
|
+
*/
|
|
44
|
+
const processDefinition = (name, definition) => {
|
|
45
|
+
let res = [];
|
|
46
|
+
let parsedDef = [];
|
|
47
|
+
res.push("");
|
|
48
|
+
res.push(`#### ${name}`);
|
|
49
|
+
res.push("");
|
|
50
|
+
if (definition.description) {
|
|
51
|
+
res.push(definition.description);
|
|
52
|
+
res.push("");
|
|
53
|
+
}
|
|
54
|
+
res.push("| Name | Type | Description | Required |");
|
|
55
|
+
res.push("| ---- | ---- | ----------- | -------- |");
|
|
56
|
+
if ("properties" in definition) {
|
|
57
|
+
parsedDef = parseProperties(name, definition);
|
|
58
|
+
}
|
|
59
|
+
else {
|
|
60
|
+
parsedDef = parsePrimitive(name, definition);
|
|
61
|
+
}
|
|
62
|
+
res = res.concat(parsedDef);
|
|
63
|
+
return res.length ? res.filter((v) => (v || "").trim() !== "").join("\n") : null;
|
|
64
|
+
};
|
|
65
|
+
/**
|
|
66
|
+
* @param {type} definitions
|
|
67
|
+
* @return {type} Description
|
|
68
|
+
*/
|
|
69
|
+
var transformDefinition = (definitions) => {
|
|
70
|
+
const res = [];
|
|
71
|
+
Object.keys(definitions).map((definitionName) => res.push(processDefinition(definitionName, definitions[definitionName])));
|
|
72
|
+
if (res.length > 0) {
|
|
73
|
+
res.unshift("### Models\n");
|
|
74
|
+
return res.filter((v) => typeof v === "string").join("\n");
|
|
75
|
+
}
|
|
76
|
+
return null;
|
|
77
|
+
};
|
|
78
|
+
|
|
79
|
+
exports.default = transformDefinition;
|
|
80
|
+
exports.processDefinition = processDefinition;
|
|
81
|
+
//# sourceMappingURL=definitions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"definitions.js","sources":["../../../src/swagger-markdown/transformers/definitions.ts"],"sourcesContent":[null],"names":["dataTypeTransformer","Schema"],"mappings":";;;;;;;;AAKA;;;;AAIG;AACH,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,UAAe,KAAI;AACzD,IAAA,MAAM,QAAQ,GAAG,UAAU,IAAI,UAAU,GAAG,UAAU,CAAC,QAAQ,GAAG,EAAE,CAAC;IACrE,MAAM,GAAG,GAAa,EAAE,CAAC;AACzB,IAAA,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,KAAI;QACnD,MAAM,IAAI,GAAG,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAGA,SAAmB,CAAC,IAAIC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QACvD,MAAM,eAAe,GAAG,CAAC,aAAa,IAAI,IAAI,GAAG,IAAI,CAAC,WAAW,GAAG,EAAE,EAAE,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAChG,QAAA,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC;AAChE,QAAA,GAAG,CAAC,IAAI,CAAC,CAAA,EAAA,EAAK,QAAQ,CAAA,GAAA,EAAM,QAAQ,CAAA,GAAA,EAAM,eAAe,CAAA,GAAA,EAAM,YAAY,CAAA,EAAA,CAAI,CAAC,CAAC;AAClF,KAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF;;;;AAIG;AACH,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,UAAe,KAAI;IACxD,MAAM,GAAG,GAAa,EAAE,CAAC;AACzB,IAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,UAAU,GAAG,UAAU,CAAC,IAAI,GAAG,EAAE,CAAC;IAC7D,MAAM,eAAe,GAAG,CAAC,aAAa,IAAI,UAAU,GAAG,UAAU,CAAC,WAAW,GAAG,EAAE,EAAE,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IAC5G,MAAM,YAAY,GAAG,EAAE,CAAC;AACxB,IAAA,GAAG,CAAC,IAAI,CAAC,CAAA,EAAA,EAAK,IAAI,CAAA,GAAA,EAAM,QAAQ,CAAA,GAAA,EAAM,eAAe,CAAA,GAAA,EAAM,YAAY,CAAA,EAAA,CAAI,CAAC,CAAC;IAC7E,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF;;;;AAIG;MACU,iBAAiB,GAAG,CAAC,IAAY,EAAE,UAAe,KAAI;IAClE,IAAI,GAAG,GAAa,EAAE,CAAC;IACvB,IAAI,SAAS,GAAG,EAAE,CAAC;AACnB,IAAA,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACb,IAAA,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAA,CAAE,CAAC,CAAC;AACzB,IAAA,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACb,IAAA,IAAI,UAAU,CAAC,WAAW,EAAE;AAC3B,QAAA,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;AACjC,QAAA,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;KACb;AACD,IAAA,GAAG,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;AACrD,IAAA,GAAG,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;AAErD,IAAA,IAAI,YAAY,IAAI,UAAU,EAAE;AAC/B,QAAA,SAAS,GAAG,eAAe,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;KAC9C;SAAM;AACN,QAAA,SAAS,GAAG,cAAc,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;KAC7C;AACD,IAAA,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;AAE5B,IAAA,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAClF,EAAE;AAEF;;;AAGG;AACH,0BAAe,CAAC,WAA2C,KAAI;IAC9D,MAAM,GAAG,GAAyB,EAAE,CAAC;AACrC,IAAA,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,cAAc,KAAK,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAC,cAAc,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3H,IAAA,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;AACnB,QAAA,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;AAC5B,QAAA,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KAC3D;AACD,IAAA,OAAO,IAAI,CAAC;AACb,CAAC;;;;;"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
const DEFAULT_TEXT = "Find more info here";
|
|
2
|
+
var transformExternalDocs = (externalDocs) => {
|
|
3
|
+
const res = [];
|
|
4
|
+
if ("description" in externalDocs && "url" in externalDocs) {
|
|
5
|
+
res.push(`[${externalDocs.description}](${externalDocs.url})`);
|
|
6
|
+
}
|
|
7
|
+
else if ("url" in externalDocs) {
|
|
8
|
+
res.push(`[${DEFAULT_TEXT}](${externalDocs.url})`);
|
|
9
|
+
}
|
|
10
|
+
return res.length ? res.filter((v) => typeof v === "string").join("\n") : null;
|
|
11
|
+
};
|
|
12
|
+
|
|
13
|
+
export { transformExternalDocs as default };
|
|
14
|
+
//# sourceMappingURL=externalDocs.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"externalDocs.esm.js","sources":["../../../src/swagger-markdown/transformers/externalDocs.ts"],"sourcesContent":[null],"names":[],"mappings":"AAEA,MAAM,YAAY,GAAG,qBAAqB,CAAC;AAE3C,4BAAe,CAAC,YAAgD,KAAI;IACnE,MAAM,GAAG,GAAyB,EAAE,CAAC;IACrC,IAAI,aAAa,IAAI,YAAY,IAAI,KAAK,IAAI,YAAY,EAAE;AAC3D,QAAA,GAAG,CAAC,IAAI,CAAC,CAAA,CAAA,EAAI,YAAY,CAAC,WAAW,CAAA,EAAA,EAAK,YAAY,CAAC,GAAG,CAAA,CAAA,CAAG,CAAC,CAAC;KAC/D;AAAM,SAAA,IAAI,KAAK,IAAI,YAAY,EAAE;QACjC,GAAG,CAAC,IAAI,CAAC,CAAI,CAAA,EAAA,YAAY,CAAK,EAAA,EAAA,YAAY,CAAC,GAAG,CAAG,CAAA,CAAA,CAAC,CAAC;KACnD;AACD,IAAA,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAChF,CAAC;;;;"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
const DEFAULT_TEXT = "Find more info here";
|
|
4
|
+
var transformExternalDocs = (externalDocs) => {
|
|
5
|
+
const res = [];
|
|
6
|
+
if ("description" in externalDocs && "url" in externalDocs) {
|
|
7
|
+
res.push(`[${externalDocs.description}](${externalDocs.url})`);
|
|
8
|
+
}
|
|
9
|
+
else if ("url" in externalDocs) {
|
|
10
|
+
res.push(`[${DEFAULT_TEXT}](${externalDocs.url})`);
|
|
11
|
+
}
|
|
12
|
+
return res.length ? res.filter((v) => typeof v === "string").join("\n") : null;
|
|
13
|
+
};
|
|
14
|
+
|
|
15
|
+
module.exports = transformExternalDocs;
|
|
16
|
+
//# sourceMappingURL=externalDocs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"externalDocs.js","sources":["../../../src/swagger-markdown/transformers/externalDocs.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAEA,MAAM,YAAY,GAAG,qBAAqB,CAAC;AAE3C,4BAAe,CAAC,YAAgD,KAAI;IACnE,MAAM,GAAG,GAAyB,EAAE,CAAC;IACrC,IAAI,aAAa,IAAI,YAAY,IAAI,KAAK,IAAI,YAAY,EAAE;AAC3D,QAAA,GAAG,CAAC,IAAI,CAAC,CAAA,CAAA,EAAI,YAAY,CAAC,WAAW,CAAA,EAAA,EAAK,YAAY,CAAC,GAAG,CAAA,CAAA,CAAG,CAAC,CAAC;KAC/D;AAAM,SAAA,IAAI,KAAK,IAAI,YAAY,EAAE;QACjC,GAAG,CAAC,IAAI,CAAC,CAAI,CAAA,EAAA,YAAY,CAAK,EAAA,EAAA,YAAY,CAAC,GAAG,CAAG,CAAA,CAAA,CAAC,CAAC;KACnD;AACD,IAAA,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAChF,CAAC;;;;"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import transformContact from './contact.esm.js';
|
|
2
|
+
import transformLicense from './license.esm.js';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* http://swagger.io/specification/#infoObject
|
|
6
|
+
* Prepare page header
|
|
7
|
+
* Leave description with no changes
|
|
8
|
+
* @param {Object} info
|
|
9
|
+
* @returns {String}
|
|
10
|
+
*/
|
|
11
|
+
var transformInfo = (info) => {
|
|
12
|
+
const res = [];
|
|
13
|
+
if (info !== null && typeof info === "object") {
|
|
14
|
+
if (info.title) {
|
|
15
|
+
res.push(`# ${info.title}`);
|
|
16
|
+
}
|
|
17
|
+
if (info.description) {
|
|
18
|
+
res.push(`${info.description}\n`);
|
|
19
|
+
}
|
|
20
|
+
if (info.version) {
|
|
21
|
+
res.push(`## Version: ${info.version}\n`);
|
|
22
|
+
}
|
|
23
|
+
if (info.termsOfService) {
|
|
24
|
+
res.push(`### Terms of service\n${info.termsOfService}\n`);
|
|
25
|
+
}
|
|
26
|
+
if (info.contact) {
|
|
27
|
+
res.push(transformContact(info.contact));
|
|
28
|
+
}
|
|
29
|
+
if (info.license) {
|
|
30
|
+
res.push(transformLicense(info.license));
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
return res.length ? res.filter((v) => typeof v === "string").join("\n") : null;
|
|
34
|
+
};
|
|
35
|
+
|
|
36
|
+
export { transformInfo as default };
|
|
37
|
+
//# sourceMappingURL=info.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"info.esm.js","sources":["../../../src/swagger-markdown/transformers/info.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAIA;;;;;;AAMG;AACH,oBAAe,CAAC,IAA8B,KAAI;IACjD,MAAM,GAAG,GAAyB,EAAE,CAAC;IAErC,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;AAC9C,QAAA,IAAI,IAAI,CAAC,KAAK,EAAE;YACf,GAAG,CAAC,IAAI,CAAC,CAAA,EAAA,EAAK,IAAI,CAAC,KAAK,CAAE,CAAA,CAAC,CAAC;SAC5B;AAED,QAAA,IAAI,IAAI,CAAC,WAAW,EAAE;YACrB,GAAG,CAAC,IAAI,CAAC,CAAA,EAAG,IAAI,CAAC,WAAW,CAAI,EAAA,CAAA,CAAC,CAAC;SAClC;AAED,QAAA,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,GAAG,CAAC,IAAI,CAAC,CAAA,YAAA,EAAe,IAAI,CAAC,OAAO,CAAI,EAAA,CAAA,CAAC,CAAC;SAC1C;AAED,QAAA,IAAI,IAAI,CAAC,cAAc,EAAE;YACxB,GAAG,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,IAAI,CAAC,cAAc,CAAI,EAAA,CAAA,CAAC,CAAC;SAC3D;AAED,QAAA,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;SACzC;AAED,QAAA,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,GAAG,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;SACzC;KACD;AAED,IAAA,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAChF,CAAC;;;;"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var contact = require('./contact.js');
|
|
4
|
+
var license = require('./license.js');
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* http://swagger.io/specification/#infoObject
|
|
8
|
+
* Prepare page header
|
|
9
|
+
* Leave description with no changes
|
|
10
|
+
* @param {Object} info
|
|
11
|
+
* @returns {String}
|
|
12
|
+
*/
|
|
13
|
+
var transformInfo = (info) => {
|
|
14
|
+
const res = [];
|
|
15
|
+
if (info !== null && typeof info === "object") {
|
|
16
|
+
if (info.title) {
|
|
17
|
+
res.push(`# ${info.title}`);
|
|
18
|
+
}
|
|
19
|
+
if (info.description) {
|
|
20
|
+
res.push(`${info.description}\n`);
|
|
21
|
+
}
|
|
22
|
+
if (info.version) {
|
|
23
|
+
res.push(`## Version: ${info.version}\n`);
|
|
24
|
+
}
|
|
25
|
+
if (info.termsOfService) {
|
|
26
|
+
res.push(`### Terms of service\n${info.termsOfService}\n`);
|
|
27
|
+
}
|
|
28
|
+
if (info.contact) {
|
|
29
|
+
res.push(contact(info.contact));
|
|
30
|
+
}
|
|
31
|
+
if (info.license) {
|
|
32
|
+
res.push(license(info.license));
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
return res.length ? res.filter((v) => typeof v === "string").join("\n") : null;
|
|
36
|
+
};
|
|
37
|
+
|
|
38
|
+
module.exports = transformInfo;
|
|
39
|
+
//# sourceMappingURL=info.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"info.js","sources":["../../../src/swagger-markdown/transformers/info.ts"],"sourcesContent":[null],"names":["transformContact","transformLicense"],"mappings":";;;;;AAIA;;;;;;AAMG;AACH,oBAAe,CAAC,IAA8B,KAAI;IACjD,MAAM,GAAG,GAAyB,EAAE,CAAC;IAErC,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;AAC9C,QAAA,IAAI,IAAI,CAAC,KAAK,EAAE;YACf,GAAG,CAAC,IAAI,CAAC,CAAA,EAAA,EAAK,IAAI,CAAC,KAAK,CAAE,CAAA,CAAC,CAAC;SAC5B;AAED,QAAA,IAAI,IAAI,CAAC,WAAW,EAAE;YACrB,GAAG,CAAC,IAAI,CAAC,CAAA,EAAG,IAAI,CAAC,WAAW,CAAI,EAAA,CAAA,CAAC,CAAC;SAClC;AAED,QAAA,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,GAAG,CAAC,IAAI,CAAC,CAAA,YAAA,EAAe,IAAI,CAAC,OAAO,CAAI,EAAA,CAAA,CAAC,CAAC;SAC1C;AAED,QAAA,IAAI,IAAI,CAAC,cAAc,EAAE;YACxB,GAAG,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,IAAI,CAAC,cAAc,CAAI,EAAA,CAAA,CAAC,CAAC;SAC3D;AAED,QAAA,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,GAAG,CAAC,IAAI,CAACA,OAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;SACzC;AAED,QAAA,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,GAAG,CAAC,IAAI,CAACC,OAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;SACzC;KACD;AAED,IAAA,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAChF,CAAC;;;;"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* http://swagger.io/specification/#licenseObject
|
|
3
|
+
* License object transformer
|
|
4
|
+
*/
|
|
5
|
+
var transformLicense = (license) => {
|
|
6
|
+
const res = [];
|
|
7
|
+
if ("url" in license || "name" in license) {
|
|
8
|
+
res.push("**License:** ");
|
|
9
|
+
if ("url" in license && "name" in license) {
|
|
10
|
+
res.push(`[${license.name}](${license.url})`);
|
|
11
|
+
}
|
|
12
|
+
else {
|
|
13
|
+
res.push(license.name || license.url || null);
|
|
14
|
+
}
|
|
15
|
+
res.push("\n");
|
|
16
|
+
}
|
|
17
|
+
return res.length > 0 ? res.filter((v) => typeof v === "string").join("") : null;
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
export { transformLicense as default };
|
|
21
|
+
//# sourceMappingURL=license.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"license.esm.js","sources":["../../../src/swagger-markdown/transformers/license.ts"],"sourcesContent":[null],"names":[],"mappings":"AAEA;;;AAGG;AACH,uBAAe,CAAC,OAA6B,KAAI;IAChD,MAAM,GAAG,GAAyB,EAAE,CAAC;IACrC,IAAI,KAAK,IAAI,OAAO,IAAI,MAAM,IAAI,OAAO,EAAE;AAC1C,QAAA,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC1B,IAAI,KAAK,IAAI,OAAO,IAAI,MAAM,IAAI,OAAO,EAAE;AAC1C,YAAA,GAAG,CAAC,IAAI,CAAC,CAAA,CAAA,EAAI,OAAO,CAAC,IAAI,CAAA,EAAA,EAAK,OAAO,CAAC,GAAG,CAAA,CAAA,CAAG,CAAC,CAAC;SAC9C;aAAM;AACN,YAAA,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;SAC9C;AACD,QAAA,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KACf;AACD,IAAA,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;AAClF,CAAC;;;;"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* http://swagger.io/specification/#licenseObject
|
|
5
|
+
* License object transformer
|
|
6
|
+
*/
|
|
7
|
+
var transformLicense = (license) => {
|
|
8
|
+
const res = [];
|
|
9
|
+
if ("url" in license || "name" in license) {
|
|
10
|
+
res.push("**License:** ");
|
|
11
|
+
if ("url" in license && "name" in license) {
|
|
12
|
+
res.push(`[${license.name}](${license.url})`);
|
|
13
|
+
}
|
|
14
|
+
else {
|
|
15
|
+
res.push(license.name || license.url || null);
|
|
16
|
+
}
|
|
17
|
+
res.push("\n");
|
|
18
|
+
}
|
|
19
|
+
return res.length > 0 ? res.filter((v) => typeof v === "string").join("") : null;
|
|
20
|
+
};
|
|
21
|
+
|
|
22
|
+
module.exports = transformLicense;
|
|
23
|
+
//# sourceMappingURL=license.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"license.js","sources":["../../../src/swagger-markdown/transformers/license.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAEA;;;AAGG;AACH,uBAAe,CAAC,OAA6B,KAAI;IAChD,MAAM,GAAG,GAAyB,EAAE,CAAC;IACrC,IAAI,KAAK,IAAI,OAAO,IAAI,MAAM,IAAI,OAAO,EAAE;AAC1C,QAAA,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC1B,IAAI,KAAK,IAAI,OAAO,IAAI,MAAM,IAAI,OAAO,EAAE;AAC1C,YAAA,GAAG,CAAC,IAAI,CAAC,CAAA,CAAA,EAAI,OAAO,CAAC,IAAI,CAAA,EAAA,EAAK,OAAO,CAAC,GAAG,CAAA,CAAA,CAAG,CAAC,CAAC;SAC9C;aAAM;AACN,YAAA,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;SAC9C;AACD,QAAA,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KACf;AACD,IAAA,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;AAClF,CAAC;;;;"}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import inArray from '../lib/inArray.esm.js';
|
|
2
|
+
import transformResponses from './pathResponses.esm.js';
|
|
3
|
+
import transformParameters from './pathParameters.esm.js';
|
|
4
|
+
import security from './security.esm.js';
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Allowed methods
|
|
8
|
+
* @type {string[]}
|
|
9
|
+
*/
|
|
10
|
+
const ALLOWED_METHODS = ["get", "post", "put", "patch", "delete", "options"];
|
|
11
|
+
var transformPath = (path, data, parameters) => {
|
|
12
|
+
const res = [];
|
|
13
|
+
let pathParameters = undefined;
|
|
14
|
+
if (path && data) {
|
|
15
|
+
res.push("\n---\n");
|
|
16
|
+
// Make path as a header
|
|
17
|
+
res.push(`### ${path} {#${path}}\n`);
|
|
18
|
+
// Set summary
|
|
19
|
+
if (data.summary) {
|
|
20
|
+
res.push(`#### Summary:\n\n${data.summary}\n`);
|
|
21
|
+
}
|
|
22
|
+
// Check if parameter for path are in the place
|
|
23
|
+
if (data.parameters) {
|
|
24
|
+
pathParameters = data.parameters;
|
|
25
|
+
}
|
|
26
|
+
// Go further method by methods
|
|
27
|
+
Object.keys(data).map((method) => {
|
|
28
|
+
if (inArray(method, ALLOWED_METHODS)) {
|
|
29
|
+
const methodLine = [];
|
|
30
|
+
// Set method as a subheader
|
|
31
|
+
methodLine.push(`#### ${method.toUpperCase()} {#${path}-${method}}`);
|
|
32
|
+
const pathInfo = data[method];
|
|
33
|
+
methodLine.push(`##### Path:\n\n**${path}**\n`);
|
|
34
|
+
// Set summary
|
|
35
|
+
if (pathInfo.summary) {
|
|
36
|
+
methodLine.push(`##### Summary:\n\n${pathInfo.summary}\n`);
|
|
37
|
+
}
|
|
38
|
+
// Set description
|
|
39
|
+
if (pathInfo.description) {
|
|
40
|
+
methodLine.push(`##### Description:\n\n${pathInfo.description}\n`);
|
|
41
|
+
}
|
|
42
|
+
// Build parameters
|
|
43
|
+
if (pathInfo.parameters || pathParameters) {
|
|
44
|
+
methodLine.push(`${transformParameters(pathInfo.parameters || [], pathParameters, parameters)}\n`);
|
|
45
|
+
}
|
|
46
|
+
// Build responses
|
|
47
|
+
if (pathInfo.responses) {
|
|
48
|
+
methodLine.push(`${transformResponses(pathInfo.responses)}\n`);
|
|
49
|
+
}
|
|
50
|
+
// Build security
|
|
51
|
+
if (pathInfo.security) {
|
|
52
|
+
methodLine.push(`${security(pathInfo.security)}\n`);
|
|
53
|
+
}
|
|
54
|
+
if ("x-codeSamples" in pathInfo) {
|
|
55
|
+
methodLine.push(`\n---\n`);
|
|
56
|
+
for (const { lang, label, source } of pathInfo["x-codeSamples"]) {
|
|
57
|
+
methodLine.push(`##### ${label || lang}:\n`);
|
|
58
|
+
methodLine.push(`\`\`\`${lang.toLowerCase()}`);
|
|
59
|
+
methodLine.push(...source.split("\n"));
|
|
60
|
+
methodLine.push(`\`\`\`\n`);
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
res.push(...methodLine.filter((v) => typeof v === "string").map((v) => `> ${v.split("\n").join("\n> ")}`));
|
|
64
|
+
res.push(`\n`);
|
|
65
|
+
}
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
return res.length ? res.filter((v) => typeof v === "string").join("\n") : null;
|
|
69
|
+
};
|
|
70
|
+
|
|
71
|
+
export { ALLOWED_METHODS, transformPath as default };
|
|
72
|
+
//# sourceMappingURL=path.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"path.esm.js","sources":["../../../src/swagger-markdown/transformers/path.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAOA;;;AAGG;AACU,MAAA,eAAe,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE;AAEpF,oBAAe,CAAC,IAAY,EAAE,IAA2B,EAAE,UAAmD,KAAI;IACjH,MAAM,GAAG,GAAyB,EAAE,CAAC;IACrC,IAAI,cAAc,GAAqD,SAAS,CAAC;AAEjF,IAAA,IAAI,IAAI,IAAI,IAAI,EAAE;AACjB,QAAA,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;;QAGpB,GAAG,CAAC,IAAI,CAAC,CAAA,IAAA,EAAO,IAAI,CAAM,GAAA,EAAA,IAAI,CAAK,GAAA,CAAA,CAAC,CAAC;;AAGrC,QAAA,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,GAAG,CAAC,IAAI,CAAC,CAAA,iBAAA,EAAoB,IAAI,CAAC,OAAO,CAAI,EAAA,CAAA,CAAC,CAAC;SAC/C;;AAGD,QAAA,IAAI,IAAI,CAAC,UAAU,EAAE;AACpB,YAAA,cAAc,GAAG,IAAI,CAAC,UAAiB,CAAC;SACxC;;QAGD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,KAAI;AAChC,YAAA,IAAI,OAAO,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;gBACrC,MAAM,UAAU,GAAyB,EAAE,CAAC;;AAG5C,gBAAA,UAAU,CAAC,IAAI,CAAC,CAAA,KAAA,EAAQ,MAAM,CAAC,WAAW,EAAE,CAAA,IAAA,EAAO,IAAI,CAAA,CAAA,EAAI,MAAM,CAAA,CAAA,CAAG,CAAC,CAAC;AACtE,gBAAA,MAAM,QAAQ,GAA2B,IAAI,CAAC,MAAM,CAAC,CAAC;AAEtD,gBAAA,UAAU,CAAC,IAAI,CAAC,oBAAoB,IAAI,CAAA,IAAA,CAAM,CAAC,CAAC;;AAGhD,gBAAA,IAAI,QAAQ,CAAC,OAAO,EAAE;oBACrB,UAAU,CAAC,IAAI,CAAC,CAAA,kBAAA,EAAqB,QAAQ,CAAC,OAAO,CAAI,EAAA,CAAA,CAAC,CAAC;iBAC3D;;AAGD,gBAAA,IAAI,QAAQ,CAAC,WAAW,EAAE;oBACzB,UAAU,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,QAAQ,CAAC,WAAW,CAAI,EAAA,CAAA,CAAC,CAAC;iBACnE;;AAGD,gBAAA,IAAI,QAAQ,CAAC,UAAU,IAAI,cAAc,EAAE;AAC1C,oBAAA,UAAU,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,QAAQ,CAAC,UAAU,IAAI,EAAE,EAAE,cAAc,EAAE,UAAU,CAAC,CAAA,EAAA,CAAI,CAAC,CAAC;iBACnG;;AAGD,gBAAA,IAAI,QAAQ,CAAC,SAAS,EAAE;AACvB,oBAAA,UAAU,CAAC,IAAI,CAAC,CAAA,EAAG,kBAAkB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAI,EAAA,CAAA,CAAC,CAAC;iBAC/D;;AAGD,gBAAA,IAAI,QAAQ,CAAC,QAAQ,EAAE;AACtB,oBAAA,UAAU,CAAC,IAAI,CAAC,CAAA,EAAG,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAI,EAAA,CAAA,CAAC,CAAC;iBACpD;AAED,gBAAA,IAAI,eAAe,IAAI,QAAQ,EAAE;AAChC,oBAAA,UAAU,CAAC,IAAI,CAAC,CAAA,OAAA,CAAS,CAAC,CAAC;AAE3B,oBAAA,KAAK,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,QAAQ,CAAC,eAAe,CAA2D,EAAE;wBAC1H,UAAU,CAAC,IAAI,CAAC,CAAA,MAAA,EAAS,KAAK,IAAI,IAAI,CAAK,GAAA,CAAA,CAAC,CAAC;wBAE7C,UAAU,CAAC,IAAI,CAAC,CAAS,MAAA,EAAA,IAAI,CAAC,WAAW,EAAE,CAAE,CAAA,CAAC,CAAC;wBAC/C,UAAU,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;AACvC,wBAAA,UAAU,CAAC,IAAI,CAAC,CAAA,QAAA,CAAU,CAAC,CAAC;qBAC5B;iBACD;AAED,gBAAA,GAAG,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAK,EAAA,EAAA,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAE,CAAA,CAAC,CAAC,CAAC;AAE3G,gBAAA,GAAG,CAAC,IAAI,CAAC,CAAA,EAAA,CAAI,CAAC,CAAC;aACf;AACF,SAAC,CAAC,CAAC;KACH;AAED,IAAA,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAChF,CAAC;;;;"}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, '__esModule', { value: true });
|
|
4
|
+
|
|
5
|
+
var inArray = require('../lib/inArray.js');
|
|
6
|
+
var pathResponses = require('./pathResponses.js');
|
|
7
|
+
var pathParameters = require('./pathParameters.js');
|
|
8
|
+
var security = require('./security.js');
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Allowed methods
|
|
12
|
+
* @type {string[]}
|
|
13
|
+
*/
|
|
14
|
+
const ALLOWED_METHODS = ["get", "post", "put", "patch", "delete", "options"];
|
|
15
|
+
var transformPath = (path, data, parameters) => {
|
|
16
|
+
const res = [];
|
|
17
|
+
let pathParameters$1 = undefined;
|
|
18
|
+
if (path && data) {
|
|
19
|
+
res.push("\n---\n");
|
|
20
|
+
// Make path as a header
|
|
21
|
+
res.push(`### ${path} {#${path}}\n`);
|
|
22
|
+
// Set summary
|
|
23
|
+
if (data.summary) {
|
|
24
|
+
res.push(`#### Summary:\n\n${data.summary}\n`);
|
|
25
|
+
}
|
|
26
|
+
// Check if parameter for path are in the place
|
|
27
|
+
if (data.parameters) {
|
|
28
|
+
pathParameters$1 = data.parameters;
|
|
29
|
+
}
|
|
30
|
+
// Go further method by methods
|
|
31
|
+
Object.keys(data).map((method) => {
|
|
32
|
+
if (inArray(method, ALLOWED_METHODS)) {
|
|
33
|
+
const methodLine = [];
|
|
34
|
+
// Set method as a subheader
|
|
35
|
+
methodLine.push(`#### ${method.toUpperCase()} {#${path}-${method}}`);
|
|
36
|
+
const pathInfo = data[method];
|
|
37
|
+
methodLine.push(`##### Path:\n\n**${path}**\n`);
|
|
38
|
+
// Set summary
|
|
39
|
+
if (pathInfo.summary) {
|
|
40
|
+
methodLine.push(`##### Summary:\n\n${pathInfo.summary}\n`);
|
|
41
|
+
}
|
|
42
|
+
// Set description
|
|
43
|
+
if (pathInfo.description) {
|
|
44
|
+
methodLine.push(`##### Description:\n\n${pathInfo.description}\n`);
|
|
45
|
+
}
|
|
46
|
+
// Build parameters
|
|
47
|
+
if (pathInfo.parameters || pathParameters$1) {
|
|
48
|
+
methodLine.push(`${pathParameters(pathInfo.parameters || [], pathParameters$1, parameters)}\n`);
|
|
49
|
+
}
|
|
50
|
+
// Build responses
|
|
51
|
+
if (pathInfo.responses) {
|
|
52
|
+
methodLine.push(`${pathResponses(pathInfo.responses)}\n`);
|
|
53
|
+
}
|
|
54
|
+
// Build security
|
|
55
|
+
if (pathInfo.security) {
|
|
56
|
+
methodLine.push(`${security(pathInfo.security)}\n`);
|
|
57
|
+
}
|
|
58
|
+
if ("x-codeSamples" in pathInfo) {
|
|
59
|
+
methodLine.push(`\n---\n`);
|
|
60
|
+
for (const { lang, label, source } of pathInfo["x-codeSamples"]) {
|
|
61
|
+
methodLine.push(`##### ${label || lang}:\n`);
|
|
62
|
+
methodLine.push(`\`\`\`${lang.toLowerCase()}`);
|
|
63
|
+
methodLine.push(...source.split("\n"));
|
|
64
|
+
methodLine.push(`\`\`\`\n`);
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
res.push(...methodLine.filter((v) => typeof v === "string").map((v) => `> ${v.split("\n").join("\n> ")}`));
|
|
68
|
+
res.push(`\n`);
|
|
69
|
+
}
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
return res.length ? res.filter((v) => typeof v === "string").join("\n") : null;
|
|
73
|
+
};
|
|
74
|
+
|
|
75
|
+
exports.ALLOWED_METHODS = ALLOWED_METHODS;
|
|
76
|
+
exports.default = transformPath;
|
|
77
|
+
//# sourceMappingURL=path.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"path.js","sources":["../../../src/swagger-markdown/transformers/path.ts"],"sourcesContent":[null],"names":["pathParameters","transformParameters","transformResponses"],"mappings":";;;;;;;;;AAOA;;;AAGG;AACU,MAAA,eAAe,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE;AAEpF,oBAAe,CAAC,IAAY,EAAE,IAA2B,EAAE,UAAmD,KAAI;IACjH,MAAM,GAAG,GAAyB,EAAE,CAAC;IACrC,IAAIA,gBAAc,GAAqD,SAAS,CAAC;AAEjF,IAAA,IAAI,IAAI,IAAI,IAAI,EAAE;AACjB,QAAA,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;;QAGpB,GAAG,CAAC,IAAI,CAAC,CAAA,IAAA,EAAO,IAAI,CAAM,GAAA,EAAA,IAAI,CAAK,GAAA,CAAA,CAAC,CAAC;;AAGrC,QAAA,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,GAAG,CAAC,IAAI,CAAC,CAAA,iBAAA,EAAoB,IAAI,CAAC,OAAO,CAAI,EAAA,CAAA,CAAC,CAAC;SAC/C;;AAGD,QAAA,IAAI,IAAI,CAAC,UAAU,EAAE;AACpB,YAAAA,gBAAc,GAAG,IAAI,CAAC,UAAiB,CAAC;SACxC;;QAGD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,KAAI;AAChC,YAAA,IAAI,OAAO,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;gBACrC,MAAM,UAAU,GAAyB,EAAE,CAAC;;AAG5C,gBAAA,UAAU,CAAC,IAAI,CAAC,CAAA,KAAA,EAAQ,MAAM,CAAC,WAAW,EAAE,CAAA,IAAA,EAAO,IAAI,CAAA,CAAA,EAAI,MAAM,CAAA,CAAA,CAAG,CAAC,CAAC;AACtE,gBAAA,MAAM,QAAQ,GAA2B,IAAI,CAAC,MAAM,CAAC,CAAC;AAEtD,gBAAA,UAAU,CAAC,IAAI,CAAC,oBAAoB,IAAI,CAAA,IAAA,CAAM,CAAC,CAAC;;AAGhD,gBAAA,IAAI,QAAQ,CAAC,OAAO,EAAE;oBACrB,UAAU,CAAC,IAAI,CAAC,CAAA,kBAAA,EAAqB,QAAQ,CAAC,OAAO,CAAI,EAAA,CAAA,CAAC,CAAC;iBAC3D;;AAGD,gBAAA,IAAI,QAAQ,CAAC,WAAW,EAAE;oBACzB,UAAU,CAAC,IAAI,CAAC,CAAA,sBAAA,EAAyB,QAAQ,CAAC,WAAW,CAAI,EAAA,CAAA,CAAC,CAAC;iBACnE;;AAGD,gBAAA,IAAI,QAAQ,CAAC,UAAU,IAAIA,gBAAc,EAAE;AAC1C,oBAAA,UAAU,CAAC,IAAI,CAAC,GAAGC,cAAmB,CAAC,QAAQ,CAAC,UAAU,IAAI,EAAE,EAAED,gBAAc,EAAE,UAAU,CAAC,CAAA,EAAA,CAAI,CAAC,CAAC;iBACnG;;AAGD,gBAAA,IAAI,QAAQ,CAAC,SAAS,EAAE;AACvB,oBAAA,UAAU,CAAC,IAAI,CAAC,CAAA,EAAGE,aAAkB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAI,EAAA,CAAA,CAAC,CAAC;iBAC/D;;AAGD,gBAAA,IAAI,QAAQ,CAAC,QAAQ,EAAE;AACtB,oBAAA,UAAU,CAAC,IAAI,CAAC,CAAA,EAAG,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAI,EAAA,CAAA,CAAC,CAAC;iBACpD;AAED,gBAAA,IAAI,eAAe,IAAI,QAAQ,EAAE;AAChC,oBAAA,UAAU,CAAC,IAAI,CAAC,CAAA,OAAA,CAAS,CAAC,CAAC;AAE3B,oBAAA,KAAK,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,QAAQ,CAAC,eAAe,CAA2D,EAAE;wBAC1H,UAAU,CAAC,IAAI,CAAC,CAAA,MAAA,EAAS,KAAK,IAAI,IAAI,CAAK,GAAA,CAAA,CAAC,CAAC;wBAE7C,UAAU,CAAC,IAAI,CAAC,CAAS,MAAA,EAAA,IAAI,CAAC,WAAW,EAAE,CAAE,CAAA,CAAC,CAAC;wBAC/C,UAAU,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;AACvC,wBAAA,UAAU,CAAC,IAAI,CAAC,CAAA,QAAA,CAAU,CAAC,CAAC;qBAC5B;iBACD;AAED,gBAAA,GAAG,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAK,EAAA,EAAA,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAE,CAAA,CAAC,CAAC,CAAC;AAE3G,gBAAA,GAAG,CAAC,IAAI,CAAC,CAAA,EAAA,CAAI,CAAC,CAAC;aACf;AACF,SAAC,CAAC,CAAC;KACH;AAED,IAAA,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAChF,CAAC;;;;;"}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import dataTypeResolver from './dataTypes.esm.js';
|
|
2
|
+
import Schema from '../models/schema.esm.js';
|
|
3
|
+
|
|
4
|
+
// const transformDataTypes = require('./dataTypes');
|
|
5
|
+
// const Schema = require('../models/schema');
|
|
6
|
+
var transformParameters = (parameters = [], pathParameters = [], globalParameters = {}) => {
|
|
7
|
+
const res = [];
|
|
8
|
+
[...pathParameters, ...parameters].map((keys) => {
|
|
9
|
+
if (keys) {
|
|
10
|
+
let parametersKeys;
|
|
11
|
+
// Check it for the reference
|
|
12
|
+
if (keys.$ref) {
|
|
13
|
+
const ref = keys.$ref.replace(/^#\/parameters\//, "");
|
|
14
|
+
if (ref in globalParameters) {
|
|
15
|
+
parametersKeys = globalParameters[ref];
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
if (typeof keys === "object") {
|
|
19
|
+
parametersKeys = keys;
|
|
20
|
+
}
|
|
21
|
+
if (!parametersKeys) {
|
|
22
|
+
return;
|
|
23
|
+
}
|
|
24
|
+
const line = [];
|
|
25
|
+
// Name first
|
|
26
|
+
line.push(parametersKeys.name || "");
|
|
27
|
+
// Scope (in)
|
|
28
|
+
line.push(parametersKeys.in || "");
|
|
29
|
+
// description
|
|
30
|
+
if (parametersKeys.description) {
|
|
31
|
+
line.push(parametersKeys.description.replace(/[\r\n]/g, " "));
|
|
32
|
+
}
|
|
33
|
+
else {
|
|
34
|
+
line.push("");
|
|
35
|
+
}
|
|
36
|
+
line.push(parametersKeys.required ? "Yes" : "No");
|
|
37
|
+
// Prepare schema to be transformed
|
|
38
|
+
let schema = null;
|
|
39
|
+
if ("schema" in parametersKeys) {
|
|
40
|
+
schema = new Schema(parametersKeys.schema);
|
|
41
|
+
}
|
|
42
|
+
else {
|
|
43
|
+
schema = new Schema();
|
|
44
|
+
schema.type = "type" in parametersKeys ? parametersKeys.type : null;
|
|
45
|
+
schema.format = "format" in parametersKeys ? parametersKeys.format : null;
|
|
46
|
+
schema.ref = "$ref" in parametersKeys ? parametersKeys.$ref : null;
|
|
47
|
+
schema.items = "items" in parametersKeys ? parametersKeys.items : null;
|
|
48
|
+
}
|
|
49
|
+
line.push(dataTypeResolver(schema));
|
|
50
|
+
// Add spaces and glue with pipeline
|
|
51
|
+
res.push(`|${line.map((el) => ` ${el} `).join("|")}|`);
|
|
52
|
+
}
|
|
53
|
+
});
|
|
54
|
+
if (res.length > 0) {
|
|
55
|
+
res.unshift("| ---- | ---------- | ----------- | -------- | ---- |");
|
|
56
|
+
res.unshift("| Name | Located in | Description | Required | Schema |");
|
|
57
|
+
res.unshift("##### Parameters\n");
|
|
58
|
+
}
|
|
59
|
+
return res.length ? res.filter((v) => typeof v === "string").join("\n") : null;
|
|
60
|
+
};
|
|
61
|
+
|
|
62
|
+
export { transformParameters as default };
|
|
63
|
+
//# sourceMappingURL=pathParameters.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pathParameters.esm.js","sources":["../../../src/swagger-markdown/transformers/pathParameters.ts"],"sourcesContent":[null],"names":["transformDataTypes"],"mappings":";;;AAAA;AACA;AAMA,0BAAe,CAAC,UAAmD,GAAA,EAAE,EAAE,cAAA,GAAuD,EAAE,EAAE,gBAAA,GAA2D,EAAE,KAAI;IAClM,MAAM,GAAG,GAAyB,EAAE,CAAC;AAErC,IAAA,CAAC,GAAG,cAAc,EAAE,GAAG,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,IAAqD,KAAI;QAChG,IAAI,IAAI,EAAE;AACT,YAAA,IAAI,cAAkD,CAAC;;AAEvD,YAAA,IAAI,IAAI,CAAC,IAAI,EAAE;AACd,gBAAA,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;AACtD,gBAAA,IAAI,GAAG,IAAI,gBAAgB,EAAE;AAC5B,oBAAA,cAAc,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;iBACvC;aACD;AAED,YAAA,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;gBAC7B,cAAc,GAAG,IAA8B,CAAC;aAChD;YAED,IAAI,CAAC,cAAc,EAAE;gBACpB,OAAO;aACP;YAED,MAAM,IAAI,GAAG,EAAE,CAAC;;YAEhB,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;;YAErC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;;AAEnC,YAAA,IAAI,cAAc,CAAC,WAAW,EAAE;AAC/B,gBAAA,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;aAC9D;iBAAM;AACN,gBAAA,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aACd;AACD,YAAA,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,GAAG,KAAK,GAAG,IAAI,CAAC,CAAC;;YAGlD,IAAI,MAAM,GAAG,IAAI,CAAC;AAClB,YAAA,IAAI,QAAQ,IAAI,cAAc,EAAE;gBAC/B,MAAM,GAAG,IAAI,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;aAC3C;iBAAM;AACN,gBAAA,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;AACtB,gBAAA,MAAM,CAAC,IAAI,GAAG,MAAM,IAAI,cAAc,GAAG,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC;AACpE,gBAAA,MAAM,CAAC,MAAM,GAAG,QAAQ,IAAI,cAAc,GAAG,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC;AAC1E,gBAAA,MAAM,CAAC,GAAG,GAAG,MAAM,IAAI,cAAc,GAAG,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC;AACnE,gBAAA,MAAM,CAAC,KAAK,GAAG,OAAO,IAAI,cAAc,GAAG,cAAc,CAAC,KAAK,GAAG,IAAI,CAAC;aACvE;YAED,IAAI,CAAC,IAAI,CAACA,gBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;;YAEtC,GAAG,CAAC,IAAI,CAAC,CAAI,CAAA,EAAA,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAI,CAAA,EAAA,EAAE,CAAG,CAAA,CAAA,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAG,CAAA,CAAA,CAAC,CAAC;SACvD;AACF,KAAC,CAAC,CAAC;AAEH,IAAA,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;AACnB,QAAA,GAAG,CAAC,OAAO,CAAC,uDAAuD,CAAC,CAAC;AACrE,QAAA,GAAG,CAAC,OAAO,CAAC,yDAAyD,CAAC,CAAC;AACvE,QAAA,GAAG,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;KAClC;AAED,IAAA,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAChF,CAAC;;;;"}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var dataTypes = require('./dataTypes.js');
|
|
4
|
+
var schema = require('../models/schema.js');
|
|
5
|
+
|
|
6
|
+
// const transformDataTypes = require('./dataTypes');
|
|
7
|
+
// const Schema = require('../models/schema');
|
|
8
|
+
var transformParameters = (parameters = [], pathParameters = [], globalParameters = {}) => {
|
|
9
|
+
const res = [];
|
|
10
|
+
[...pathParameters, ...parameters].map((keys) => {
|
|
11
|
+
if (keys) {
|
|
12
|
+
let parametersKeys;
|
|
13
|
+
// Check it for the reference
|
|
14
|
+
if (keys.$ref) {
|
|
15
|
+
const ref = keys.$ref.replace(/^#\/parameters\//, "");
|
|
16
|
+
if (ref in globalParameters) {
|
|
17
|
+
parametersKeys = globalParameters[ref];
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
if (typeof keys === "object") {
|
|
21
|
+
parametersKeys = keys;
|
|
22
|
+
}
|
|
23
|
+
if (!parametersKeys) {
|
|
24
|
+
return;
|
|
25
|
+
}
|
|
26
|
+
const line = [];
|
|
27
|
+
// Name first
|
|
28
|
+
line.push(parametersKeys.name || "");
|
|
29
|
+
// Scope (in)
|
|
30
|
+
line.push(parametersKeys.in || "");
|
|
31
|
+
// description
|
|
32
|
+
if (parametersKeys.description) {
|
|
33
|
+
line.push(parametersKeys.description.replace(/[\r\n]/g, " "));
|
|
34
|
+
}
|
|
35
|
+
else {
|
|
36
|
+
line.push("");
|
|
37
|
+
}
|
|
38
|
+
line.push(parametersKeys.required ? "Yes" : "No");
|
|
39
|
+
// Prepare schema to be transformed
|
|
40
|
+
let schema$1 = null;
|
|
41
|
+
if ("schema" in parametersKeys) {
|
|
42
|
+
schema$1 = new schema(parametersKeys.schema);
|
|
43
|
+
}
|
|
44
|
+
else {
|
|
45
|
+
schema$1 = new schema();
|
|
46
|
+
schema$1.type = "type" in parametersKeys ? parametersKeys.type : null;
|
|
47
|
+
schema$1.format = "format" in parametersKeys ? parametersKeys.format : null;
|
|
48
|
+
schema$1.ref = "$ref" in parametersKeys ? parametersKeys.$ref : null;
|
|
49
|
+
schema$1.items = "items" in parametersKeys ? parametersKeys.items : null;
|
|
50
|
+
}
|
|
51
|
+
line.push(dataTypes(schema$1));
|
|
52
|
+
// Add spaces and glue with pipeline
|
|
53
|
+
res.push(`|${line.map((el) => ` ${el} `).join("|")}|`);
|
|
54
|
+
}
|
|
55
|
+
});
|
|
56
|
+
if (res.length > 0) {
|
|
57
|
+
res.unshift("| ---- | ---------- | ----------- | -------- | ---- |");
|
|
58
|
+
res.unshift("| Name | Located in | Description | Required | Schema |");
|
|
59
|
+
res.unshift("##### Parameters\n");
|
|
60
|
+
}
|
|
61
|
+
return res.length ? res.filter((v) => typeof v === "string").join("\n") : null;
|
|
62
|
+
};
|
|
63
|
+
|
|
64
|
+
module.exports = transformParameters;
|
|
65
|
+
//# sourceMappingURL=pathParameters.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pathParameters.js","sources":["../../../src/swagger-markdown/transformers/pathParameters.ts"],"sourcesContent":[null],"names":["schema","Schema","transformDataTypes"],"mappings":";;;;;AAAA;AACA;AAMA,0BAAe,CAAC,UAAmD,GAAA,EAAE,EAAE,cAAA,GAAuD,EAAE,EAAE,gBAAA,GAA2D,EAAE,KAAI;IAClM,MAAM,GAAG,GAAyB,EAAE,CAAC;AAErC,IAAA,CAAC,GAAG,cAAc,EAAE,GAAG,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,IAAqD,KAAI;QAChG,IAAI,IAAI,EAAE;AACT,YAAA,IAAI,cAAkD,CAAC;;AAEvD,YAAA,IAAI,IAAI,CAAC,IAAI,EAAE;AACd,gBAAA,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;AACtD,gBAAA,IAAI,GAAG,IAAI,gBAAgB,EAAE;AAC5B,oBAAA,cAAc,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;iBACvC;aACD;AAED,YAAA,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;gBAC7B,cAAc,GAAG,IAA8B,CAAC;aAChD;YAED,IAAI,CAAC,cAAc,EAAE;gBACpB,OAAO;aACP;YAED,MAAM,IAAI,GAAG,EAAE,CAAC;;YAEhB,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;;YAErC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;;AAEnC,YAAA,IAAI,cAAc,CAAC,WAAW,EAAE;AAC/B,gBAAA,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;aAC9D;iBAAM;AACN,gBAAA,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;aACd;AACD,YAAA,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,GAAG,KAAK,GAAG,IAAI,CAAC,CAAC;;YAGlD,IAAIA,QAAM,GAAG,IAAI,CAAC;AAClB,YAAA,IAAI,QAAQ,IAAI,cAAc,EAAE;gBAC/BA,QAAM,GAAG,IAAIC,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;aAC3C;iBAAM;AACN,gBAAAD,QAAM,GAAG,IAAIC,MAAM,EAAE,CAAC;AACtB,gBAAAD,QAAM,CAAC,IAAI,GAAG,MAAM,IAAI,cAAc,GAAG,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC;AACpE,gBAAAA,QAAM,CAAC,MAAM,GAAG,QAAQ,IAAI,cAAc,GAAG,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC;AAC1E,gBAAAA,QAAM,CAAC,GAAG,GAAG,MAAM,IAAI,cAAc,GAAG,cAAc,CAAC,IAAI,GAAG,IAAI,CAAC;AACnE,gBAAAA,QAAM,CAAC,KAAK,GAAG,OAAO,IAAI,cAAc,GAAG,cAAc,CAAC,KAAK,GAAG,IAAI,CAAC;aACvE;YAED,IAAI,CAAC,IAAI,CAACE,SAAkB,CAACF,QAAM,CAAC,CAAC,CAAC;;YAEtC,GAAG,CAAC,IAAI,CAAC,CAAI,CAAA,EAAA,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAI,CAAA,EAAA,EAAE,CAAG,CAAA,CAAA,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAG,CAAA,CAAA,CAAC,CAAC;SACvD;AACF,KAAC,CAAC,CAAC;AAEH,IAAA,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;AACnB,QAAA,GAAG,CAAC,OAAO,CAAC,uDAAuD,CAAC,CAAC;AACrE,QAAA,GAAG,CAAC,OAAO,CAAC,yDAAyD,CAAC,CAAC;AACvE,QAAA,GAAG,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;KAClC;AAED,IAAA,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAChF,CAAC;;;;"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import Schema from '../models/schema.esm.js';
|
|
2
|
+
import dataTypeResolver from './dataTypes.esm.js';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Build responses table
|
|
6
|
+
* @param {object} responses
|
|
7
|
+
* @returns {null|string}
|
|
8
|
+
*/
|
|
9
|
+
var transformResponses = (responses) => {
|
|
10
|
+
const res = [];
|
|
11
|
+
// Check if schema somewhere
|
|
12
|
+
const schemas = Object.keys(responses).reduce((acc, response) => acc || "schema" in responses[response], false);
|
|
13
|
+
Object.keys(responses).forEach((response) => {
|
|
14
|
+
const line = [];
|
|
15
|
+
// Response
|
|
16
|
+
line.push(response);
|
|
17
|
+
// Description
|
|
18
|
+
if ("description" in responses[response]) {
|
|
19
|
+
const description = responses[response].description.replace(/[\r\n]/g, " ");
|
|
20
|
+
line.push(description);
|
|
21
|
+
}
|
|
22
|
+
else {
|
|
23
|
+
line.push("");
|
|
24
|
+
}
|
|
25
|
+
// Schema
|
|
26
|
+
if ("schema" in responses[response]) {
|
|
27
|
+
const schema = new Schema(responses[response].schema);
|
|
28
|
+
line.push(dataTypeResolver(schema));
|
|
29
|
+
}
|
|
30
|
+
else if (schemas) {
|
|
31
|
+
line.push("");
|
|
32
|
+
}
|
|
33
|
+
// Combine all together
|
|
34
|
+
res.push(`|${line
|
|
35
|
+
.filter((v) => typeof v === "string")
|
|
36
|
+
.map((el) => ` ${el} `)
|
|
37
|
+
.join("|")}|`);
|
|
38
|
+
});
|
|
39
|
+
res.unshift(`| ---- | ----------- |${schemas ? " ------ |" : ""}`);
|
|
40
|
+
res.unshift(`| Code | Description |${schemas ? " Schema |" : ""}`);
|
|
41
|
+
res.unshift("##### Responses\n");
|
|
42
|
+
return res.filter((v) => typeof v === "string").join("\n");
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
export { transformResponses as default };
|
|
46
|
+
//# sourceMappingURL=pathResponses.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pathResponses.esm.js","sources":["../../../src/swagger-markdown/transformers/pathResponses.ts"],"sourcesContent":[null],"names":["transformDataTypes"],"mappings":";;;AAKA;;;;AAIG;AACH,yBAAe,CAAC,SAAiC,KAAI;IACpD,MAAM,GAAG,GAAyB,EAAE,CAAC;;AAErC,IAAA,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,QAAQ,KAAK,GAAG,IAAI,QAAQ,IAAI,SAAS,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;IAEhH,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,KAAI;QAC3C,MAAM,IAAI,GAAyB,EAAE,CAAC;;AAEtC,QAAA,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;;AAGpB,QAAA,IAAI,aAAa,IAAI,SAAS,CAAC,QAAQ,CAAC,EAAE;AACzC,YAAA,MAAM,WAAW,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAC5E,YAAA,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SACvB;aAAM;AACN,YAAA,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACd;;AAED,QAAA,IAAI,QAAQ,IAAI,SAAS,CAAC,QAAQ,CAAC,EAAE;AACpC,YAAA,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;YACtD,IAAI,CAAC,IAAI,CAACA,gBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;SACtC;aAAM,IAAI,OAAO,EAAE;AACnB,YAAA,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACd;;AAED,QAAA,GAAG,CAAC,IAAI,CACP,CAAA,CAAA,EAAI,IAAI;aACN,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC;aACpC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAA,CAAA,EAAI,EAAE,CAAA,CAAA,CAAG,CAAC;AACtB,aAAA,IAAI,CAAC,GAAG,CAAC,CAAA,CAAA,CAAG,CACd,CAAC;AACH,KAAC,CAAC,CAAC;AAEH,IAAA,GAAG,CAAC,OAAO,CAAC,CAAA,sBAAA,EAAyB,OAAO,GAAG,WAAW,GAAG,EAAE,CAAA,CAAE,CAAC,CAAC;AACnE,IAAA,GAAG,CAAC,OAAO,CAAC,CAAA,sBAAA,EAAyB,OAAO,GAAG,WAAW,GAAG,EAAE,CAAA,CAAE,CAAC,CAAC;AACnE,IAAA,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAEjC,IAAA,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5D,CAAC;;;;"}
|