Skip to content
This repository has been archived by the owner on Jan 21, 2024. It is now read-only.

Rework using webapi-parser #77

Merged
merged 24 commits into from
Jul 28, 2020
Merged

Rework using webapi-parser #77

merged 24 commits into from
Jul 28, 2020

Conversation

postatum
Copy link
Contributor

@postatum postatum commented Feb 27, 2020

Major changes (BREAKING):

  • Rewrote to work with webapi-parser (Rework using webapi-parser #77);
  • New dev dependency: webapi-parser;
  • New dependency: raml-sanitize;
  • Dropped dependency: raml-1-parser;
  • All the library API now accepts webapi-parser objects instead of JS Objects/JSON;

Minor changes:

  • Updated dependencies' versions;
  • Switched to const/let instead of var;

Making a release:

  • Release dependencies PRs;
  • Bump major version and make a release;

PR depends on:

Performance:
Performance changes are described (and can be updated) in the osprey-profiling repo.

To test the PR locally with all the reworked Osprey sub-dependencies, use this Makefile.

Limitation: Only top-level response body example values are
now sanitized.

E.g. if response body is specified as

type: object
properties:
  age: number
example:
  age: 67

example will be sanitized to {"age": 67}

On the other hand, if response body is nested like so

type: object
properties:
  nested:
    type: object
    properties:
      age: number
example:
  nested:
    age: 67

it won't be sanitize and response body will be {"nested": {"age": "67"}}
@postatum postatum merged commit 6c79b76 into develop Jul 28, 2020
@postatum postatum deleted the rework_webapi_parser branch July 28, 2020 08:39
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant