diff --git a/packages/utils/README.md b/packages/utils/README.md index 3e5df61..f77cde5 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -15,10 +15,19 @@ Spec parser that takes care of the usage of `$ref`. ```ts import { getDereferencedOpenAPIDocument } from '@adaptate/utils'; -let dereferencedOpenAPIDocument = await getDereferencedOpenAPIDocument( - import.meta.url, - '../fixtures/base-schema.yml' -); +// from local disk +let dereferencedOpenAPIDocument = await getDereferencedOpenAPIDocument({ + environment: 'server', + callSiteURL: import.meta.url, + relativePathToSpecFile: '../fixtures/base-schema.yml', +}); + +// or from web + +let dereferencedOpenAPIDocument = await getDereferencedOpenAPIDocument({ + environment: 'browser', + webURL: 'https://api.apis.guru/v2/specs/googleapis.com/books/v1/openapi.yaml', +}); for (let [name, schema] of Object.entries( dereferencedOpenAPIDocument.components.schemas diff --git a/packages/utils/package.json b/packages/utils/package.json index a27946e..761613b 100644 --- a/packages/utils/package.json +++ b/packages/utils/package.json @@ -1,6 +1,6 @@ { "name": "@adaptate/utils", - "version": "0.1.0-beta", + "version": "0.1.0-beta.1", "author": { "name": "Peramanathan Sathyamoorthy", "url": "https://github.com/p10ns11y/adaptate.git"