@datafire/openapi_converter_herokuapp

Client library for Swagger2OpenAPI Converter

Installation and Usage

npm install --save @datafire/openapi_converter_herokuapp

let openapi_converter_herokuapp = require('@datafire/openapi_converter_herokuapp').create();

.then(data => {
  console.log(data);
});

Description

Converter and validator for Swagger 2.0 to OpenAPI 3.0.x definitions

Actions

getBadge

Return a redirect to a badge svg file depending on a source definition's validity

openapi_converter_herokuapp.getBadge({
  "url": ""
}, context)

Input

• input object
  • url required string: The URL to retrieve the OpenAPI 3.0.x definition from

Output

Output schema unknown

convertUrl

Convert a Swagger 2.0 definition to OpenAPI 3.0.x from a URL

openapi_converter_herokuapp.convertUrl({
  "url": ""
}, context)

Input

• input object
  • url required string: The URL to retrieve the OpenAPI 2.0 definition from

Output

Output schema unknown

convert

Convert a Swagger 2.0 definition passed in the body to OpenAPI 3.0.x

openapi_converter_herokuapp.convert({}, context)

Input

• input object
  • filename string: The file to upload and convert
  • source string: The text of a Swagger 2.0 definition to convert
  • validate string (values: on)

Output

Output schema unknown

getStatus

Get the status of the API

openapi_converter_herokuapp.getStatus(null, context)

Input

This action has no parameters

Output

Output schema unknown

validateUrl

Validate an OpenAPI 3.0.x definition

openapi_converter_herokuapp.validateUrl({
  "url": ""
}, context)

Input

• input object
  • url required string: The URL to retrieve the OpenAPI 3.0.x definition from

Output

• output validationResult

validate

Validate an OpenAPI 3.0.x definition supplied in the body of the request

openapi_converter_herokuapp.validate({}, context)

Input

• input object
  • filename string: The file to upload and validate
  • source string: The text of an OpenAPI 3.0.x definition to validate

Output

• output validationResult

Definitions

validationResult

• validationResult object
  • openapi required string