Skip to content

Releases: wework/speccy

v0.8.0

10 Aug 00:28
b1425e5
Compare
Choose a tag to compare

Changed

  • Switched to using oas-kit for resolving and validating
  • Moved short-summary from wework to strict rules (#110)
  • YAML files were previously loaded in "JSON mode", which meant duplicate keys were allowed. They will now error (#108)

Added

  • Config files can be passed with -c (defaults to speccy.yaml). See README for more information
  • Enabled path-keys-no-trailing-slash now oas-resolver can handle keys for lint rules
  • Enabled better-ajv-errors for beautiful validation errors. Linter errors remain unchanged

Fixed

  • Resolving to a file would silently fail when writing to a folder that did not exist

Removed

  • Got rid of wework rules, as the last rule was moved to strict (#110)

v0.7.3

19 Jun 16:33
24557ac
Compare
Choose a tag to compare

image

Added

  • Provide "More Info" links in linter errors, so users understand the reasoning behind various rules. (#90)

image

v0.7.2

31 May 16:33
d5d6380
Compare
Choose a tag to compare

Fixed

  • Fix message is undefined error (#78)
  • Resolver was treating $ref with a URL like a file. (#80)

v0.7.0

10 May 18:46
2da2669
Compare
Choose a tag to compare

Breaking Change

  • Error now raised for all commands when $ref points to a file that does not exist, or cannot be opened

Fixed

  • Bumped json-schema-to-openapi-schema to v0.2.0 so subschemas will be converted
  • Invalid keywords will be stripped everywhere instead of just root

v0.6.0

10 May 18:28
eb436c8
Compare
Choose a tag to compare

Removed

  • Removed switch --watch as it didn't actually work, and was flagging "security issues" on npm (#46)

Added

  • Support URLs in --rules for lint command (#41)
  • New switch --json-schema / -j will tell speccy to resolve $refs as JSON Schema, converting them to OpenAPI on the fly (#45)

0.5.4

04 Apr 16:27
e2f5689
Compare
Choose a tag to compare

Changed

  • properties rule will now ignore extensions, so foo: 'a', x-bar: 'b' is only 1 property.

Fixed

  • Disabled reference-components-regex rule until resolver can allow it to work. Re-enabling this rule is being tracked in #43

Note
This release hoped to solve the overly verbose errors, where the entire object is flung into the CLI output. It's a known issue, and has been partially improved in #40, but more work needs to be done.

0.5.3

02 Apr 17:12
4d72e24
Compare
Choose a tag to compare

Fixed

  • Warn about YAML/JSON parsing errors in referenced files (#36)
  • Fixed max length (it was previously enforcing exact length) (#38)