express-jsdoc-swagger/transforms/basic/info.js

Swagger OpenAPI 3.x generator

const setProperty = require('../utils/setProperty')('info');
const getContact = require('./contact');
const license = require('./license');

const getInfo = (options = {}) => ({
  title: setProperty(options, 'title', {
    type: 'string',
    required: true,
  }),
  description: setProperty(options, 'description', {
    type: 'string',
    defaultValue: 'Add your description',
  }),
  ...(options.contact ? { contact: getContact(options.contact) } : {}),
  ...(options.license ? { license: license(options.license) } : {}),
  termsOfService: setProperty(options, 'termsOfService', {
    type: 'string',
    defaultValue: '',
  }),
  version: setProperty(options, 'version', {
    type: 'string',
    required: true,
  }),
});

module.exports = getInfo;