1.23.2 • Published 10 months ago

@ibm-cloud/openapi-ruleset v1.23.2

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
10 months ago

OpenAPI Ruleset

This package contains a custom Spectral ruleset for validating OpenAPI documents. It extends the spectral:oas ruleset, for which it defines custom severity levels. It also contains a number of additional rules based on API design requirements and guidance from IBM Cloud. This is the default ruleset used in the ibm-openapi-validator package.

Installation

npm install @ibm-cloud/openapi-ruleset

Note that installation is only required if using this package programmatically or extending it in a Spectral config file written in JavaScript. It is not required if extending the ruleset in a Spectral config file written in YAML or JSON.

Usage

Spectral config file - YAML or JSON

  • Note - no installation required. Spectral handles the import internally.
# .spectral.yaml
extends: '@ibm-cloud/openapi-ruleset'
rules:
  content-entry-provided: off

Spectral config file - JavaScript

// .spectral.js
const ibmOpenapiRuleset = require('@ibm-cloud/openapi-ruleset');

module.exports = {
  extends: ibmOpenapiRuleset,
  rules: {
    'content-entry-provided': 'off'
  }
};

Programmatically running Spectral

// your-module.js
const ibmOpenapiRuleset = require('@ibm-cloud/openapi-ruleset');
const { Spectral } = require('@stoplight/spectral-core');

function async runSpectral(openapiDocument) {
  const spectral = new Spectral();
  spectral.setRuleset(ibmOpenapiRuleset);
  results = await spectral.run(openapiDocument);
  console.log(results);
}
1.23.2

10 months ago

1.23.0

10 months ago

1.23.1

10 months ago

1.21.0

11 months ago

1.21.1

11 months ago

1.21.2

10 months ago

1.22.0

10 months ago

1.20.0

11 months ago

1.18.1

1 year ago

1.18.0

1 year ago

1.18.2

1 year ago

1.19.0

12 months ago

1.17.1

1 year ago

1.17.0

1 year ago

1.16.0

1 year ago

1.15.9

1 year ago

1.15.8

1 year ago

1.15.7

1 year ago

1.15.6

1 year ago

1.15.5

1 year ago

1.15.4

1 year ago

1.15.3

1 year ago

1.15.2

1 year ago

1.15.0

1 year ago

1.15.1

1 year ago

1.14.1

2 years ago

1.2.0

2 years ago

1.14.0

2 years ago

1.14.2

2 years ago

1.6.3

2 years ago

1.6.2

2 years ago

1.6.1

2 years ago

1.6.0

2 years ago

1.9.0

2 years ago

1.5.0

2 years ago

1.10.0

2 years ago

1.12.0

2 years ago

1.8.0

2 years ago

1.4.1

2 years ago

1.4.0

2 years ago

1.11.0

2 years ago

1.13.0

2 years ago

1.7.0

2 years ago

1.3.0

2 years ago

1.0.2

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago

1.0.0-rc.3

2 years ago

1.0.0-rc.1

2 years ago

1.0.0-rc.2

2 years ago

0.45.5

2 years ago

0.45.4

2 years ago

0.44.4

3 years ago

0.44.3

3 years ago

0.45.3

3 years ago

0.45.1

3 years ago

0.45.2

3 years ago

0.45.0

3 years ago

0.44.2

3 years ago

0.44.1

3 years ago

0.43.0

3 years ago

0.41.0

3 years ago

0.38.0

3 years ago

0.44.0

3 years ago

0.42.0

3 years ago

0.40.0

3 years ago

0.39.0

3 years ago

0.36.0

3 years ago

0.32.3

3 years ago

0.34.0

3 years ago

0.32.2

3 years ago

0.32.1

3 years ago

0.32.0

3 years ago

0.30.1

3 years ago

0.30.0

3 years ago

0.37.3

3 years ago

0.37.2

3 years ago

0.37.1

3 years ago

0.37.0

3 years ago

0.35.0

3 years ago

0.33.2

3 years ago

0.33.1

3 years ago

0.33.0

3 years ago

0.31.1

3 years ago

0.31.0

3 years ago

0.29.0

3 years ago

0.28.0

3 years ago

0.27.0

3 years ago

0.26.1

3 years ago

0.25.2

3 years ago

0.26.0

3 years ago

0.25.1

3 years ago

0.25.0

3 years ago

0.21.0

3 years ago

0.20.0

3 years ago

0.19.0

3 years ago

0.11.0

3 years ago

0.12.0

3 years ago

0.11.1

3 years ago

0.13.0

3 years ago

0.14.0

3 years ago

0.15.0

3 years ago

0.14.1

3 years ago

0.16.0

3 years ago

0.17.0

3 years ago

0.18.0

3 years ago

0.10.0

3 years ago

0.24.0

3 years ago

0.23.0

3 years ago

0.22.0

3 years ago

0.9.0

3 years ago

0.7.2

3 years ago

0.8.0

3 years ago

0.7.1

3 years ago

0.7.0

3 years ago

0.3.0

3 years ago

0.2.1

3 years ago

0.1.2

4 years ago

0.2.0

3 years ago

0.1.1

4 years ago

0.6.2

3 years ago

0.5.0

3 years ago

0.4.0

3 years ago

0.6.1

3 years ago

0.6.0

3 years ago

0.5.1

3 years ago

0.1.0

4 years ago

0.0.1

4 years ago