Add tables with model info

Author: beschoenen

.gitignore

@@ -26,3 +26,4 @@ doc/
 
 # Node
 node_modules
+source/includes/_models.md

Jenkinsfile

@@ -9,6 +9,7 @@ node('node') {
   stage('build') {
     sh 'npm install'
     sh 'npm run compile-docs-wrapper'
+    sh 'npm run generate-model-tables'
     sh 'sudo bundle install'
     sh 'bundle exec middleman build --clean'
   }

package.json

@@ -2,7 +2,8 @@
   "name": "api-docs",
   "version": "1.0.0",
   "scripts": {
-    "compile-docs-wrapper": "npx esdoc"
+    "compile-docs-wrapper": "npx esdoc",
+    "generate-model-tables": "node scripts/generateTables.js"
   },
   "dependencies": {
     "@mapcreator/maps4news": "^1.4.22",

scripts/generateTables.js

@@ -0,0 +1,75 @@
+const https = require('https');
+const fs = require('fs');
+
+function downloadDocs () {
+  return new Promise((resolve) => {
+    const docsUrl = "https://api.bleeding.maps4news.com/docs";
+
+    https.get(docsUrl, function (res) {
+      let body = '';
+
+      res.on('data', function (chunk) {
+        body += chunk;
+      });
+
+      res.on('end', function () {
+        resolve(JSON.parse(body));
+      });
+    }).on('error', function (e) {
+      reject(e);
+    });
+  });
+}
+
+function getModels (json) {
+  const models = [];
+
+  for (const name in json.components.schemas) {
+    const model = json.components.schemas[name];
+
+    if (model.hasOwnProperty('xml') && model.xml.hasOwnProperty('name')) {
+      models.push(model);
+    }
+  }
+
+  return models;
+}
+
+function generateTables (models) {
+  let string = '# Models\n\n';
+
+  for (const name in models) {
+    if (!models.hasOwnProperty(name)) continue;
+
+    const model = models[name];
+
+    // Add title
+    string += `## ${model.xml.name}\n\n`;
+
+    // Add columns
+    string += '| Attribute | Type | Description | Searchable | Sortable |\n';
+    string += '|---|---|---|---|---|\n';
+
+    // Add properties
+    for (const propertyName in model.properties) {
+      if (!model.properties.hasOwnProperty(propertyName)) continue;
+
+      const property = model.properties[propertyName];
+
+      string += `| ${propertyName} | ${property.type} | ${property.description} | ${property['x-searchable'] ? 'Yes' : 'No'} | ${property['x-sortable'] ? 'Yes' : 'No'} |\n`
+    }
+
+    string += '\n\n';
+  }
+
+  return string.trimRight();
+}
+
+function writeFile(content) {
+  fs.writeFileSync(`${__dirname}/../source/includes/_models.md`, content);
+}
+
+downloadDocs()
+  .then(getModels)
+  .then(generateTables)
+  .then(writeFile);

source/v1/index.html.md

@@ -9,6 +9,9 @@ toc_footers:
   - <a href='https://api.maps4news.com/register'>Sign up for Maps4News</a>
   - <a href='https://github.com/lord/slate'>Documentation Powered by Slate</a>
 
+includes:
+  - models
+
 search: true
 ---
 
@@ -266,7 +269,7 @@ So, for example: if the list has 600 items and the `offset` is set to 100, the `
 
 The API supports sorting ascending or descending sorting on multiple columns (separated by a comma) on the resources.
 
-**Sortable columns are whitelisted inside the API, there is currently no documentation on what columns are whitelisted**
+**Sortable columns are whitelisted inside the API, look in the model list below for supported columns**
 
 ### Searching