@windingtree/wt-search-api/management/resolve-swagger-references.js

NodeJS app that enables quick search over data from Winding Tree platform

const fs = require('fs');
const path = require('path');
const YAML = require('yamljs');

const MODEL_DEFINITIONS = [
  '@windingtree/wt-shared-schemas',
];

const normalizePath = (path) => {
  return path.replace('@', '').replace('/', '-');
};

const replaceReferences = (model, from, to) => {
  if (model.$ref) {
    model.$ref = model.$ref.replace(from, to);
  }
  if (typeof model === 'object') {
    for (let property in model) {
      replaceReferences(model[property], from, to);
    }
  }
  return model;
};

/**
 * Update $refs in model definition to local references.
 * @param model
 */
const resolveReferences = (model) => {
  if (model.$ref && model.$ref.startsWith('@windingtree/')) {
    for (let path of MODEL_DEFINITIONS) {
      // We cannot use nested schemas, because the swagger-model-validator does not support that
      model.$ref = model.$ref.replace(`${path}/swagger.yaml#/components/schemas/`, `#/components/schemas/${normalizePath(path)}-`);
    }
  }
  if (typeof model === 'object') {
    for (let property in model) {
      resolveReferences(model[property]);
    }
  }
  return model;
};

/**
 * Add referenced models to enable $ref resolution
 * @param model
 */
const addDefinitions = (model) => {
  for (let modelPath of MODEL_DEFINITIONS) {
    let refDef = YAML.load(path.resolve(__dirname, `../node_modules/${modelPath}/dist/swagger.yaml`));
    // We cannot use nested schemas, because the swagger-model-validator does not support that
    refDef = replaceReferences(refDef, '#/components/schemas/', `#/components/schemas/${normalizePath(modelPath)}-`);
    model.components.schemas = Object.assign({},
      model.components.schemas,
      Object.keys(refDef.components.schemas).reduce((agg, curr) => {
        agg[`${normalizePath(modelPath)}-${curr}`] = refDef.components.schemas[curr];
        return agg;
      }, {})
    );
  }
  return model;
};

const convertSchema = () => {
  let swaggerDocument = YAML.load(path.resolve(__dirname, '../docs/source.yaml'));
  swaggerDocument = resolveReferences(swaggerDocument);
  const processed = addDefinitions(swaggerDocument);
  fs.writeFileSync(path.resolve(__dirname, '../docs/swagger.yaml'), YAML.dump(processed, 4, 4));
};

module.exports = {
  resolveReferences,
  addDefinitions,
  convertSchema,
};

if (require.main === module) {
  convertSchema();
}