spectral

A flexible JSON/YAML linter for creating automated style guides, with baked in support for OpenAPI v3.1, v3.0, and v2.0 as well as AsyncAPI v2.x.

APACHE-2.0 License

Downloads
22.3M
Stars
2.3K
Committers
92

Bot releases are visible (Hide)

spectral -

Published by stoplight-bot over 3 years ago

spectral -

Published by stoplight-bot over 3 years ago

spectral -

Published by stoplight-bot over 3 years ago

Fixed

  • duplicated-entry-in-enum rule complains about enum property in objects #1571
  • Dependencies upgrade, including proxy-agent #1552
spectral -

Published by stoplight-bot over 3 years ago

Added

  • Add duplicated-entry-in-enum rule to detect duplicated entry in enum #1478
  • Improve additionalProperties JSON Schema validation #1433

Changed

  • $refs in rulesets linking to json-schema.org are kept unresolved #1519

Fixed

  • Empty $refs should not be ignored #1540
  • Proper source detection of an error caused by an empty $ref #1515
  • Improve file $ref resolving on Windows #1514
  • Proxy settings not applied to all outgoing requests #1324
  • Pascal/Camel casing do not support single uppercase letters at the end #1500
  • Nested extends broken in rulesets Error disabling an extended ruleset in an extended ruleset #1352, #1380
  • Missing validation of child parameter child properties #1400
spectral -

Published by stoplight-bot over 3 years ago

Fixed

  • Address Immer potential security vulnerability, as well as update a few other dependencies #1499
spectral -

Published by stoplight-bot almost 4 years ago

Added

  • CLI: add JSON path to stylish formatter #1382
  • Support optional pointers and sources in except #1405, #1423

Fixed

  • OpenAPI path-params rule flags parameter override definitions as duplicate #1416
  • Falsy OpenAPI example fields are validated correctly #1418
  • OpenAPI examples in examples is asked to be OpenAPI compliant #1406
  • Allow single trailing slash for OpenAPI 3 server url #1427
  • Friendly error is thrown for empty ruleset #1407
spectral -

Published by stoplight-bot almost 4 years ago

Fixed

  • Documentation URL in rulesets point at legacy Stoplight platform #1395
spectral -

Published by stoplight-bot almost 4 years ago

spectral -

Published by stoplight-bot almost 4 years ago

Added

  • Introduce parser options #1350
  • Allow documentationUrl to be specified for each rule #1356
  • CLI: new --fail-on-unmatched-globs flag #1117

Deprecated

  • CLI: --fail-on-unmatched-globs should be used instead of --show-unmatched-globs

Fixed

  • CLI: JUnit formatter respects fail-severity #935
  • Respect nullable in case of OAS3 document #1353
  • Schema function handles non-string enum values #1377
  • oas-valid-example ignores externalValue #1379
  • Expose defined function correctly #1384
spectral -

Published by stoplight-bot about 4 years ago

Added

  • YAML merge keys can be used in rulesets #1325
  • New built-in function defined #1338
  • Enhance error message formatting #1339
  • JS API: Document format lookup functions takes filepath #1348
spectral - v5.5.0

Published by stoplight-bot about 4 years ago

Added

  • JS API: Support proxies #1081
  • Ruleset accepts documentationUrl property to specify the source of the documentation #1242
  • Introduce an experimental JSON Path engine to speed up the linting process #1136. Currently hidden behind USE_NIMMA env variable.

Fixed

  • Improve examples validation #1284
  • Path Params being applied to more than http operations #1187
  • Occasional out of memory errors caused by better-ajv-errors #1223, #455
  • Unexpected result while linting an empty document #1209
  • Casing function supports leading char #1256
  • operation-paramaters rule outputs better messages #1235
  • Document sources are not normalized correctly under Windows #1185
  • Various performance improvements #1184, #1188, #1189, #1300
spectral -

Published by stoplight-bot about 4 years ago

spectral -

Published by stoplight-bot about 4 years ago

spectral -

Published by stoplight-bot over 4 years ago

spectral -

Published by stoplight-bot over 4 years ago

spectral -

Published by stoplight-bot over 4 years ago

spectral -

Published by stoplight-bot over 4 years ago

spectral -

Published by stoplight-bot over 4 years ago

spectral -

Published by stoplight-bot over 4 years ago

spectral -

Published by stoplight-bot over 4 years ago

Package Rankings
Top 1.02% on Npmjs.org
Top 24.92% on Repo1.maven.org
Top 8.17% on Proxy.golang.org
Top 36.01% on Pypi.org
Badges
Extracted from project README
Demo of Spectral linting an OpenAPI document from the CLI CircleCI npm Downloads Stoplight Forest
Related Projects