OpenAPI Ruleset Utilities

This package contains a number of JS functions that may be useful in developing a custom Spectral ruleset for validating OpenAPI documents.

Installation

npm install @ibm-cloud/openapi-ruleset-utilities

Documentation

See this page for comprehensive documentation on all functionality available in this package.

@ibm-cloud/openapi-ruleset-utilities 1.9.0 (2025-04-23)

Features

• openapi-ruleset-utilities: add type declaration files (#743) (e8c6a0e)

@ibm-cloud/openapi-ruleset-utilities 1.8.1 (2025-04-16)

Bug Fixes

• include response header content schemas in schema collection (739ccca)

@ibm-cloud/openapi-ruleset-utilities 1.8.0 (2025-04-07)

Features

• add helpers to extract processed api from spectral context (47d3841)

@ibm-cloud/openapi-ruleset-utilities 1.7.1 (2025-02-12)

Bug Fixes

• build: add override for jsonpath-plus to avoid CVE (#729) (ef4f34d)

@ibm-cloud/openapi-ruleset-utilities 1.7.0 (2025-01-07)

Features

• track logical paths in recursive validation functions (#709) (b1f2fbf)

@ibm-cloud/openapi-ruleset-utilities 1.6.0 (2024-12-23)

Features

• add collectFromComposedSchemas() and getExamplesForSchema() to utilities (#708) (bfbee14)

@ibm-cloud/openapi-ruleset-utilities 1.5.0 (2024-11-15)

Features

• add utility for checking composite schemas with a looser constraint (8ae0e07)

@ibm-cloud/openapi-ruleset-utilities 1.4.0 (2024-09-24)

Features

• ibm-required-array-properties-in-response: add new validator rule (#684) (7cc4be2)

@ibm-cloud/openapi-ruleset-utilities 1.3.2 (2024-03-22)

Bug Fixes

• build: build executables with correct dependency versions (#654) (7b8192d)

@ibm-cloud/openapi-ruleset-utilities 1.3.1 (2024-02-23)

Bug Fixes

• adjust header parameter casing convention check (#648) (bd95f03)

@ibm-cloud/openapi-ruleset-utilities 1.3.0 (2023-09-08)

Features

• ibm-no-nullable-properties: add new 'ibm-no-nullable-properties' rule (#626) (7e090aa)

@ibm-cloud/openapi-ruleset-utilities 1.2.1 (2023-08-21)

Bug Fixes

• build: run all release steps for validator build (#624) (96ef1c8)

@ibm-cloud/openapi-ruleset-utilities 1.2.0 (2023-08-11)

Bug Fixes

• support type list in existing rules (dd4506f)

Features

• ibm-pattern-properties: add new spectral-style rule (26cdf89)

@ibm-cloud/openapi-ruleset-utilities 1.1.0 (2023-05-24)

Features

• ibm-unique-parameter-request-property-names: added new validation rule (#595) (2a1832d)

@ibm-cloud/openapi-ruleset-utilities 1.0.2 (2023-05-11)

Bug Fixes

• collections: use correct http method names in collections (#589) (9a63ca9)

@ibm-cloud/openapi-ruleset-utilities 1.0.1 (2023-05-01)

Bug Fixes

• bump spectral dependencies (#587) (9d15d68)

@ibm-cloud/openapi-ruleset-utilities 1.0.0 (2023-03-31)

Build System

• require node v16 as minimum version (#574) (dc7c8fe)

BREAKING CHANGES

• Node v16 is now the minimum supported version of Node for running this tool.

@ibm-cloud/openapi-ruleset-utilities 0.0.2-rc.1 (2023-03-03)

Bug Fixes

• add copyright prologs to source files (#558) (39714c6)