api2swagger/lib/errorCodes/command.js

Generate Swagger 2.0 (Open API) spec from Curl like API Call.

module.exports = {
  errorMessage: errorMessage
};

var errorCodes = {
  '01': {
    title: 'Input missing',
    message: 'API Endpoint is missing to make a call',
    details: 'Make sure you specify endpoint using -e option. For Example ' +
    'swaggergen -e http://example.com/helloWorld'
  },
  '02': {
    title: 'Invalid hostname',
    message: 'API Endpoint is invalid to make a call',
    details: 'Make sure you specify http endpoint using -e option. For Example ' +
    'swaggergen -e http://example.com/helloWorld'
  },
  '03': {
    title: 'Invalid hostname',
    message: 'API Endpoint is invalid only http, https, ws, wss supported',
    details: 'Make sure you specify http endpoint using -e option. For Example ' +
    'swaggergen -e http://example.com/helloWorld'
  },
  '04': {
    title: 'Invalid Method Name',
    message: 'Method name is invalid only HEAD, GET, POST, PUT, DELETE supported',
    details: 'Make sure you specify http method using -X option. For Example ' +
    'swaggergen -e http://example.com/helloWorld -X POST'
  },
  '05': {
    title: 'Swagger Output file missing',
    message: 'Swagger Output file missing.',
    details: 'Make sure you specify output file using -o option. For Example ' +
    'swaggergen -e http://example.com/helloWorld -X POST -o /Users/Anils/Desktop/swagger.json'
  },
  '06': {
    title: "Host Name, doesn't match",
    message: "Please check your API or Create a new swagger file..",
    details: "Existing swagger file you have mentioned doesn't match new API hostname."
  },
  '07': {
    title: "Base Path Name, doesn't match",
    message: "Please check your API or Create a new swagger file..",
    details: "Existing swagger file you have mentioned doesn't match new API base path."
  }
};

function errorMessage(code) {
  return errorCodes[code];
}