CHANGELOG.md

0.51.3 (2021-10-11)

Bug Fixes

• remove npm_force_resolutions from pre-install step to fix user package install (#337) (0a02977)

0.51.2 (2021-10-08)

Bug Fixes

• pac-resolver force dependency to 5.0.0 (#335) (03154e3)

0.51.1 (2021-10-01)

Bug Fixes

• false positive when minLength, maxLength are 0 (#334) (e8c5220)

0.51.0 (2021-09-30)

Features

• add configFileOverride to in-code validator (#331) (9a259d1)

0.50.1 (2021-09-29)

Bug Fixes

• handle multi-file spec circular reference edge case (#333) (172c027)

0.50.0 (2021-09-29)

Features

• examples' name should not contain space (#332) (053d9da)

0.49.0 (2021-09-27)

Features

• prohibit sentence style summaries (20bf923)

0.48.0 (2021-09-16)

Features

• server variables must have default value (#322) (483f4bf)

0.47.1 (2021-09-13)

Bug Fixes

• add 101 and 202 responses as exceptions for content-entry-provided rule (#320) (cdb0e47)

0.47.0 (2021-09-03)

Features

• check for missing required properties (#314) (c6ebc28)
• string schema should define enum or pattern, minLength, maxLength (#315) (27b7c7d)

0.46.4 (2021-07-26)

Bug Fixes

• enable disabling of operation_id_case_convention (#313) (5ffb9fb)

0.46.3 (2021-07-23)

Bug Fixes

• vulnerability fix updating package (#309) (2418feb)

0.46.2 (2021-07-14)

Bug Fixes

• don't crash when parameter is missing required "in" property (#308) (8bf7df5)

0.46.1 (2021-06-16)

Bug Fixes

• allow null values inside enum property (#306) (cbe6269)

0.46.0 (2021-05-05)

Features

• validate x-sdk-operations extension (#290) (019c06f)

0.45.0 (2021-05-04)

Features

• error for non-object request bodies (#288) (ba00a8d)

0.44.0 (2021-04-28)

Features

• warn for / content types (733b534)
• warn when error response content type is not application/json (82f6398)

0.43.1 (2021-04-28)

Bug Fixes

• false positive when limit and offset properties included in allOf (#284) (33f8a1c)

0.43.0 (2021-04-21)

Features

• error for parameter without schema or content (8b6e8bd)

0.42.0 (2021-04-14)

Features

• add rule to check for consistent major version in path (b6c8e65)

0.41.0 (2021-04-14)

Features

• show path to component that caused error in verbose mode (#272) (3c1c458)

0.40.3 (2021-04-14)

Bug Fixes

• soften the response-example-provided rule to look only at success responses (#273) (b5dac3e)

0.40.2 (2021-04-14)

Bug Fixes

• cannot find ajv module when ibm:oas ruleset extended (#279) (fd2cb29)

0.40.1 (2021-04-07)

Bug Fixes

• set the exit code for json output (#269) (b6e9899)

0.40.0 (2021-04-06)

Features

• validate x-sdk-operations extension (#268) (b025eac)

0.39.0 (2021-03-26)

Features

• remove error for partial path templating (#262) (2838875)

0.38.0 (2021-03-19)

Features

• warn for missing response examples (#265) (0f10376)

0.37.1 (2021-03-16)

Bug Fixes

• correct the minimum required version of Node (#264) (8b3bad4)

0.37.0 (2021-03-16)

Features

• custom Spectral rule to ensure content objects contain schema (#258) (bb9e419)

0.36.0 (2021-03-12)

Features

• synchronize the inCodeValidator output to match the CLI -json output (#260) (e61f803)

0.35.2 (2021-03-09)

Bug Fixes

• bundle original spec to account for multi-file API definitions (#252) (f241c8b)

0.35.1 (2021-03-08)

Bug Fixes

• no error for inline array schema when items field is a ref (#257) (4dd3708)

0.35.0 (2021-03-05)

Features

• include the validator version in the JSON output (#256) (6442a0b)

0.34.4 (2021-03-01)

Bug Fixes

• properly handle circular regressions to prevent call stack exceptions (#253) (3696487)

0.34.3 (2021-02-22)

Bug Fixes

• fix object type validations (#242) (c08c5c7)

0.34.2 (2021-02-18)

Bug Fixes

• add validation for use of 101 status code (#237) (52e1319)
• run travis deploy step on main branch (#239) (6b5abbb)
• update releaserc to use main branch (#238) (4b1569b)
• update semantic-release dependencies (#240) (6edf60c)

0.34.1 (2021-01-27)

Bug Fixes

• allow rules with flexible second options (2b1d876)

0.34.0 (2021-01-26)

Features

• exclude common inconsistent property names (#230) (d1b9909)

0.33.2 (2021-01-11)

Bug Fixes

• allow null values for default property (#227) (b7e2aa8)

0.33.1 (2021-01-04)

Bug Fixes

• specify rule name for all configurable rules (38526f3)

0.33.0 (2020-12-30)

Features

• command line option to print config option associated with each message (7a56dde)

0.32.0 (2020-12-28)

Features

• spectral: allow spectral ruleset file to be specified with command line option (db60c11)
• spectral: rework default spectral rules and expose as static "ibm:oas" ruleset (cafad9e)

0.31.1 (2020-10-23)

Bug Fixes

• findOctetSequencePaths: Show path to erring element (#190) (0247888), closes #180

0.31.0 (2020-10-15)

Features

• allow spectral rule severity to be modified in the validaterc (#202) (dc81079)

0.30.1 (2020-10-02)

Bug Fixes

• fix spectral file path resolving (#201) (8227946)

0.30.0 (2020-09-23)

Features

• initial Spectral integration (#195) (ccbc7a6)

0.29.4 (2020-09-22)

Bug Fixes

• recognize application/merge-patch+json media type as JSON (#198) (958b6af)

0.29.3 (2020-09-02)

Bug Fixes

• dont validate schema properties called 'responses' as responses (#194) (4277079)

0.29.2 (2020-08-27)

Bug Fixes

• validator: typo in isURL function call (#189) (58f75a0)

0.29.1 (2020-08-26)

Bug Fixes

• Required properties warning now checked in child refs (#187) (5f2ae83)

0.29.0 (2020-08-11)

Features

• Validate missing response descriptions (#186) (751c18d)

0.28.1 (2020-08-06)

Bug Fixes

• Reduce default severity of enum case convention (d09c4e8)

0.28.0 (2020-06-23)

Features

• rule unused_tag renamed to undefined_tag (#171) (95a4308)

0.27.1 (2020-05-04)

Bug Fixes

• dont crash when only a subset of ops contain redundant path params (#168) (d9000d2)

0.27.0 (2020-04-28)

Features

• adds check for case-insensitive property name collisions (#162) (85a797e)

0.26.1 (2020-04-11)

Bug Fixes

• Only check operationId naming convention for resource-oriented operations (8da9d37)
• Tweak message text for better summarization (80f2302)

0.26.0 (2020-03-16)

Features

• adds a check for 422 and 302 status codes (#154) (4d5ba65)

0.25.0 (2020-03-11)

Features

• flag properties with the same name but different type (#140) (3ab9c3a)

0.24.3 (2020-03-11)

Bug Fixes

• Fix crashes found on real API docs (ddab1a0)
• Pass path as array to preseve path segments containing periods. (d1ed5c0)

0.24.2 (2020-03-09)

Bug Fixes

• Add debug option (2bb6df9)

0.24.1 (2020-03-04)

Bug Fixes

• make operationId naming convention check configurable (#149) (c8b07ff)

0.24.0 (2020-02-25)

Features

• list valid types and formats in error messages (#145) (600bf8e)

0.23.0 (2020-02-24)

Features

• error for oneOf, anyOf, allOf schema that does not use array (#143) (1db6b27)

0.22.0 (2020-02-21)

Features

• flag definitions that are defined but never used (#144) (a131408)

0.21.0 (2020-02-18)

Features

• add validator warning for binary string in "application/json" or parameter (#139) (9497333)

0.20.0 (2020-02-17)

Features

• validator should check for mandatory swagger or openapi field (#137) (b4275d3)

0.19.3 (2020-02-12)

Bug Fixes

• print usage menu for an unknown flag (#130) (def7dcc)

0.19.2 (2020-02-11)

Bug Fixes

• resolve refs when checking for success response schemas (#136) (b286c69)

0.19.1 (2020-02-11)

Bug Fixes

• updated code and test to reflect updated naming convention (#133) (c44f2fa)

0.19.0 (2020-02-10)

Features

• added configurable warning limits through .thresholdrc file (#132) (2c3a919)

0.18.0 (2020-02-07)

Features

• add warning, non-204 success response should have response body (#127) (90689c8)

0.17.1 (2020-02-07)

Bug Fixes

• use correct property case for tokenUrl (#134) (4395600)

0.17.0 (2020-01-29)

Features

• operationId should conform to naming convention (#124) (79ca9b8)

0.16.2 (2020-01-27)

Bug Fixes

• swagger2 validator should only report error if there's body parameter but no consume (#123) (1d97cb2)

0.16.1 (2020-01-16)

Bug Fixes

• add command name for improved usage output (#122) (53382eb)

0.16.0 (2019-12-10)

Features

• Add rule to check pagination list operations conform to API Handbook (#118) (875ea4c)

0.15.2 (2019-11-25)

Bug Fixes

• Fix duplicate parameter checking when all parameters are defined at the path level (#116) (f40bd6f)

Reverts

• Back out duplicated tests for duplicate path parameter rule (#115) (4d58a82)

0.15.1 (2019-10-04)

Bug Fixes

• allow multiple schemes in a security requirement object (#109) (f02ef2b), closes #108

0.15.0 (2019-10-01)

Features

• validate discriminator properties conform to specifications (#107) (0ecd539)

0.14.0 (2019-09-10)

Features

• adds k8s_camel_case validator for k8s API conventions (#106) (bb82222)

0.13.6 (2019-09-09)

Bug Fixes

• prevent crash when parameters is illegally not an array (#104) (5d8a429)

0.13.5 (2019-08-28)

Bug Fixes

• do not crash when operation has illegal $ref, print error instead (#103) (3d34205)

0.13.4 (2019-08-27)

Bug Fixes

• treat response schemas with an items field as arrays, even if there is no type (#99) (3383114)

0.13.3 (2019-08-06)

Bug Fixes

• use parameter-determining method in all parameters validations (#97) (ee1168f)

0.13.2 (2019-07-23)

Bug Fixes

• filter out #9d chars from input (#89) (0b154d4)

0.13.1 (2019-07-22)

Bug Fixes

• Skip case_convention checks on deprecated parameters and properties (#88) (6b195aa)

0.13.0 (2019-07-17)

Features

• change default for all case convention validations to error (#86) (#86) (873d6035cc72a04e58bbe6142cbce22ebb3f041a)

  • This applies to the following rules: param_name_case_convention, paths_case_convention, property_case_convention, enum_case_convention

  • The rule snake_case_only (in categories paths and schemas) is now set to off by default. They will be deprecated in a future release.

0.12.5 (2019-07-17)

Bug Fixes

• add more specific checks for parameter objects (#83) (9282e17)

0.12.4 (2019-07-04)

Bug Fixes

• make $ref pattern check configurable - new rule incorrect_ref_pattern (#78) (20f0911)

0.12.3 (2019-07-01)

Bug Fixes

• remove support for links in swagger2 (#76) (8b28d67)

0.12.2 (2019-06-28)

Bug Fixes

• response schema support for oneOf, anyOf, and allOf refs (#70) - real (10d99a4)

0.12.1 (2019-06-28)

Bug Fixes

• flag any operations with array responses (#73) (7b1a9d3)

0.12.0 (2019-06-24)

Features

• new cli option, --errors_only, for printing only the errors (#68) (a338bf0)

0.11.2 (2019-06-19)

Bug Fixes

• response links are not validated as responses (#63) (061b09b)

0.11.1 (2019-06-19)

Bug Fixes

• skips validation for non-string enum values (#67) (fe4211f)

0.11.0 (2019-06-18)

Features

• add security definition validations for OAS3 (0a44980)

0.10.5 (2019-06-18)

Bug Fixes

• use correct working dir when resolving multi-file definitions (43a22b8)

0.10.4 (2019-06-18)

Bug Fixes

• skips warning for non-ref response schemas when not content is not json (624d41a)

0.10.3 (2019-06-13)

Bug Fixes

• raises warning for tag that hasnt been defined in global tags list (b0ac126)

0.10.2 (2019-06-05)

Bug Fixes

• don't crash validator when path has a period in it (01aa679)

0.10.1 (2019-06-04)

Bug Fixes

• alllow absolute filepaths to be passed to --config (ab2e7ff)

0.10.0 (2019-06-04)

Features

• add script to build platform specific standalone binaries (f821707)

0.9.1 (2019-06-04)

Bug Fixes

• replace jsSpec with resolvedSpec in security-definitons-ibm (bb460c4)

0.9.0 (2019-06-04)

Features

• Added --config option, adding support for explicit config file (ab6bcc2)

0.8.0 (2019-05-31)

Features

• Added -j/--json output option to cli-validator (759856f), closes #43

0.7.0 (2019-05-31)

Features

• added explicit control of case conventions in paths, schema properties and schema enums (ecde7da), closes #38 #40

0.6.0 (2019-05-24)

Features

• added check in the validator for info section. (8d21781)

0.5.0 (2019-05-16)

Features

• new-validation: flag descriptions sibling to $ref if identical to referenced description (91178cf)

0.4.0 (2019-05-14)

Features

• flag operations with non-form request bodies that do not specify a name (a229fc0)

0.3.1 (2019-04-22)

Bug Fixes

• Fix operationID case convention to match API Handbook (lower_snake_case) (b7fafe2)

0.3.0 (2019-04-22)

Bug Fixes

• handle null values for descriptions and schemas properties (9ecbfbe)

Features

• validate for null values in the api document, return an error (cc53855)

0.2.4 (2019-04-11)

Bug Fixes

• exapand check for operation id duplciates to include referenced paths (21e2460)

0.2.3 (2019-02-19)

Bug Fixes

• dont error on schemas with type file for oas2 specs (eeb826a)

0.2.2 (2019-02-05)

Features

• (new-validation) warn when top-level schemas do not have descriptions

Bug Fixes

• $ref format issues are now warnings and only internal refs are checked
• handle "allOf", "anyOf", and "oneOf" properly
• run security validations on security objects only (59f26b0)

0.2.0

• The options -v or --version now prints the semantic version of the validator
• The --print_validator_modules short-hand option is renamed to -p