Releases: raml-org/raml-js-parser-2
1.1.38
NPM installation: npm install [email protected]
The new JSON format is available via the new API. Old JSON format is unchanged.
This document describes the basics of usage and the differences between the new and the old format: https://github.com/raml-org/raml-js-parser-2/blob/master/documentation/TheNewApi.md
This document provides the overview of the API methods, both old and new ones: https://github.com/raml-org/raml-js-parser-2/blob/master/documentation/ApiOverview.md
Here is the Getting Started guide for the new API: https://github.com/raml-org/raml-js-parser-2/blob/master/documentation/GettingStartedNewApi.md
Here is the JSON schema for the new format: https://github.com/raml-org/raml-js-parser-2/tree/master/tckJSONSchema-newFormat
Here is the description of the exposed (non-JSON) high-level API, targeted for experienced users (IDE developers): https://github.com/raml-org/raml-js-parser-2/blob/master/documentation/RAML10Classes.html
It is now possible to expand type expressions in the new API by setting expandExpressions option to true. Here are the gist samples: https://gist.github.com/ddenisenko/b76a71701cd4fdec42de28f5003cd5bf
It is now possible to expand all types in the new API by setting expandTypes option to true. Here are the gist samples: https://gist.github.com/ddenisenko/e787a521a6dfdb616729c98a7c9f58fd
1.1.37
NPM installation: npm install [email protected]
Bug fixes:
- Rename for traits throws an exception in certain case
- The expressions expansion mechanism must understand trailing '?' as nilable type mark.
- Type expansion fails to process recursion in a certain case
- Serialization to JSON ignores rule of calculating default types
Enhancements:
- Remote type expansion: RAML model serialization.
- Remote type expansion: applying the type expansion mechanism.
1.1.36
NPM installation: npm install [email protected]
Bug fixes:
- Null 'example' and 'default' values must be serialized and validated as null (not "null") for RAML 0.8
- Type default value is not converted to string for RAML 0.8 #643
Enhancements:
- Export typings as NPM
- Remote type expansion: RAML model restoration.
1.1.35
NPM installation: npm install [email protected]
Bug fixes:
- OOM error trying to parse RAML API
- Parser errors UNKNOWN_PROPERTY and RESTRICTIONS_CONFLICT
- The parser throws NPE for a certain API
1.1.34
NPM installation: npm install [email protected]
Bug fixes:
- Invalid JSON examples must be non null strings in dumped JSON.
- INVALID_JSON_SCHEMA_DETAILS warning thrown (with valid json schemas)
- The parser hangs on processing certain platform RAML spec
- Failing to validate XML example against schema which uses a custom namespace #589
- strange error messages with empty
examplesfacet #630 - Parsing of GlobalSchemas in RAML 0.8 raises unexpected errors
Enhancements:
- Connect JSON typings to the parser
- Provide a way for obtainig new format JSON by string which contains RAML definition
- Add cross-references to JSON output
- Extract tooling code
- Update parser dependencies
- Introduce 'sourceMap' field in the old JSON format
- wrench is deprecated -> use fs-extra instead
1.1.32
NPM installation: npm install [email protected]
Important: typescript version is updated, dependency on typings is removed across the parser modules sub-tree.
Bug fixes:
- Invalid RAML error: Invalid type Null, expected Object
- Unvalued template parameters used in keys cause excessive error reports
- Property type not being imported correctly
- Library expansion must consider as used those types which are referenced by discriminator value
- Typings is deprecated
- Request headers are a map, but response headers are an array.
Enhancements:
- JS-doc for errors should say that column, line number and position start from zero.
- Update the JS parser README
- Get rid of typings dependency
- Upgrade typescript version
1.1.31
NPM installation: npm install [email protected]
Bug fixes:
- Invalide path in sourceMap for included schema fragments
- Failing to resolve references inside JOSN schema with relative URI as ID
- Invalid error for template parameter used as type name
- Invalid library chaining is not detected for expanded APIs
- Empty example value must be always accepted when 'strict' is set to 'false'
- Wrong property order in new JSON output
- XML type requires a tag as root element that should not
- SPACES_IN_KEY error triggered with !functions
- Failing to parse of
<<param>>.<<param>>[]type - The parser doe not produce errors for unknown nodes obtained from template parameters
- A missing separating space in template parameters object must be reported as such
- JS RAML parser should not allow an empty title
- Low level reference patching does not process queryString
Enhancements:
- Improve type reporting for examples validation
- Improve error messages for nodes that are not allowed on other nodes as per spec
- Improve error messages for library chaining
- Create documentation for high-level
- Add simple getting started to README
1.1.30
NPM installation: npm install [email protected]
Bug fixes:
- Example validation for union does not report missing fields
- Trailing spaces should be treated the same way by all loading methods of the YAML parser
- Properties from included DataType (as a base type) overrides properties from current DataType
Enhancements:
- Error messages on JSON schema validation not really helpful
- Not very helpful error message
- Move references patching procedure to low level AST
- Move the expansion procedure to low level AST model
- An initial version of type expansion implemented.
1.1.29
NPM installation: npm install [email protected]
Intermediate release with several emerging issue fixes.
Bug fixes:
1.1.28
NPM installation: npm install [email protected]
Technical release to fix 1.1.27 npm package corruption, functionally equal to 1.1.27.
Bug fixes:
- Multiple inheritance shortcut does not work correctly for property declarations
- Unused template parameter should be reported by warning rather then error
- Validation support for primitive JSON values
- API JSON contains 'Uses' nodes of included fragments
- Update commons-beanutils to 1.9.3
- The YAML parser produces undefined end positions for "pairs" type.
- Strange behaviour when including an empty file
- A cross-library type hierarchy cycle causes exception.
- 'usage' must not be a valid node inside a type declaration
- !include no longer works as array item
- Incorrect call to fsResolver.content method when contentAsync is defined
- Prepare the parser code for the https://github.com/mulesoft-labs/yaml-ast-parser/pull/15 PR
- The parser produces error for parametrized response definitions
- Invalid serialization of paramterized response properties
- Parser does incorrectly validate resource type parameter for a key node
- Parser wrongly complain about non-existing subtypes
- Issue with overlays, default media type, and resource type fragments
- Strange issue with custom facets
- includes might not be resolved correctly