Skip to content
Merged
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
87 changes: 55 additions & 32 deletions clickhouseapi.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ function generateDocusaurusMarkdown(spec, groupedEndpoints, prefix) {
if (operation.responses && operation.responses['200'].content["application/json"]) {
const rawSchema = operation.responses['200'].content["application/json"].schema
const result = rawSchema.properties.result

if (result) {
markdownContent += `\n### Response\n\n`;

Expand All @@ -96,54 +96,77 @@ function generateDocusaurusMarkdown(spec, groupedEndpoints, prefix) {
const schema = rawSchema.properties.result.type === 'array' ?
result.items['$ref'].split('/').pop() : result['$ref'].split('/').pop()

const bodyParamAttrs = spec.components.schemas[schema].properties
const bodyParams = Object.keys(bodyParamAttrs)
const sampleResponseObj = {}

const extractedFields = extractFields(result, spec.components.schemas, undefined);
markdownContent += `| Name | Type | Description |\n`
markdownContent += `| :--- | :--- | :---------- |\n`
markdownContent += extractedFields.markdown
markdownContent += '\n'
markdownContent += `\n#### Sample response\n\n`;
markdownContent += '```\n'
markdownContent += `${JSON.stringify(extractedFields.json, 0, 2)}`
markdownContent += '\n```\n'
}
}
}
}

return markdownContent;
}

function extractFields(result, schemas, fieldPrefix) {
const schemaRef = result.type === 'array' ? result.items['$ref'].split('/').pop() : result['$ref'].split('/').pop();
const bodyParamAttrs = schemas[schemaRef].properties;
const bodyParams = Object.keys(bodyParamAttrs);
const resObj = {
markdown: '',
json: {}
}
for (const parameter of bodyParams) {
const newPrefix = fieldPrefix ? `${fieldPrefix}.${parameter}` : parameter;
if (bodyParamAttrs[parameter]['$ref']) {

const nestedObj = extractFields(bodyParamAttrs[parameter], schemas, newPrefix)
resObj.markdown += nestedObj.markdown
resObj.json[parameter] = nestedObj.json
}
else {
const paramType = bodyParamAttrs[parameter].format || bodyParamAttrs[parameter].type;
resObj.markdown += `| ${newPrefix} | ${paramType || ''} | ${bodyParamAttrs[parameter].description || ''} | \n`;
resObj.json[parameter] = returnParamTypeSample(bodyParamAttrs[parameter].format || bodyParamAttrs[parameter].type);
}
}
return resObj;
}

for (const parameter of bodyParams) {
const paramType = bodyParamAttrs[parameter].format || bodyParamAttrs[parameter].type
markdownContent += `| ${parameter} | ${paramType || ''} | ${bodyParamAttrs[parameter].description || ''} | \n`

switch (paramType) {
case 'uuid':
sampleResponseObj[parameter] = 'uuid';
function returnParamTypeSample(paramType) {
let result;
switch(paramType) {
case 'uuid':
result = 'uuid';
break;
case 'string':
sampleResponseObj[parameter] = 'string';
result = 'string';
break;
case 'number':
sampleResponseObj[parameter] = 0;
result = 0;
break;
case 'array':
sampleResponseObj[parameter] = 'Array';
result = 'Array';
break;
case 'boolean':
sampleResponseObj[parameter] = 'boolean';
result = 'boolean';
break;
case 'date-time':
sampleResponseObj[parameter] = 'date-time';
result = 'date-time';
break;
case 'date':
result = 'date';
break;
case 'email':
sampleResponseObj[parameter] = 'email';
result = 'email';
break;
}
}

markdownContent += `\n#### Sample response\n\n`;
markdownContent += '```\n'
markdownContent += `${JSON.stringify(sampleResponseObj, 0, 2)}`
markdownContent += '\n```\n'
}


}
}
}

return markdownContent;
return result;
}

async function main() {
Expand Down