raml-org / webapi-parser

API Spec parser based on AMF. Currently supports RAML 0.8, RAML 1.0, OAS 2.0 and OAS 3.0(beta).
Other
68 stars 24 forks source link

Add ability to preserve root definitions on resolution #78

Closed postatum closed 4 years ago

postatum commented 4 years ago

This PR adds the ability to preserve root definitions like RAML 1.0 types definitions (types:) when resolving a model. This is implemented by adding a new parameter to .resolve() methods - a boolean preserveDefinitions. It's false by default, but when true is passed, AMF "editing" pipeline is used to perform resolution (which preserves root definitions).


After the PR is merged:

$ ./scripts/generate-gh-pages-docs.sh

New version release notes:

New argument in .resolve() methods.

Second argument was added to .resolve() methods. It's an optional boolean which is false by default. When true boolean is provided, resolution process preserves root definitions like RAML 1.0 types definitions (types:). E.g. .resolve(model, true).

Please see Resolving documentation for more details.