Parse, Upgrade & Validate OpenAPI Documents

import { validate } from "@powerduck/openapi-parser";

const result = await validate(yamlString);
if (result.valid) {
  console.log("Document is valid OpenAPI");
} else {
  for (const issue of result.errors) {
    console.error(issue.message, issue.path);
  }
}

import { upgradeOasTo32 } from "@powerduck/openapi-parser";

// Upgrade OAS 2.0, 3.0, or 3.1 document to 3.2
const result = await upgradeOasTo32(oas2Document, {
  continueOnError: false,
});

if (result.ok) {
  console.log(result.document.openapi); // "3.2.0"
} else {
  throw new Error(result.error.message);
}

import { dereference } from "@powerduck/openapi-parser";

// Resolve all $ref pointers
const result = await dereference(document);
console.log(result.schema); // Fully resolved document

import type {
  Oas32Document,    // OpenAPI 3.2 document type
  Oas31Document,    // OpenAPI 3.1 document type
  Oas30Document,    // OpenAPI 3.0 document type
  Oas20Document,    // Swagger 2.0 document type
  SchemaObject,     // Schema object (3.2)
  OperationObject,  // Operation object (3.2)
} from "@powerduck/openapi-parser";