@ibm-cloud/openapi-ruleset

v1.25.2

Spectral ruleset for validating IBM Cloud services For more information about how to use this package see README

Latest version published 9 days ago

License: Apache-2.0

NPM

GitHub

Package Health Score

86 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.25.2	\|	12/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.25.1	\|	11/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.24.0	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.45.5	\|	02/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.44.4	\|	12/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (181,768)

GitHub Stars: 510
Forks: 91
Contributors: -

Direct Usage Popularity

The npm package @ibm-cloud/openapi-ruleset receives a total of 181,768 downloads a week. As such, we scored @ibm-cloud/openapi-ruleset popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @ibm-cloud/openapi-ruleset, we found that it has been starred 510 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 0
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like @ibm-cloud/openapi-ruleset is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 9
Open PR: 3
Last Release: 9 days ago
Last Commit: 9 days ago

Further analysis of the maintenance status of @ibm-cloud/openapi-ruleset based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @ibm-cloud/openapi-ruleset demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=16.0.0

Age: 3 years
Dependencies: 10 Direct
Versions: 138
Install Size: 1.29 MB
Dist-tags: 2
# of Files: 307
Maintainers: 23
TS Typings: No

@ibm-cloud/openapi-ruleset has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

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);
}

@ibm-cloud/openapi-ruleset dependencies

@ibm-cloud/openapi-ruleset-utilities @stoplight/spectral-formats @stoplight/spectral-functions @stoplight/spectral-rulesets chalk lodash loglevel loglevel-plugin-prefix minimatch validator

@ibm-cloud/openapi-ruleset development dependencies

@stoplight/spectral-core jest

FAQs

What is @ibm-cloud/openapi-ruleset?

Spectral ruleset for validating IBM Cloud services. Visit Snyk Advisor to see a full health score report for @ibm-cloud/openapi-ruleset, including popularity, security, maintenance & community analysis.

Is @ibm-cloud/openapi-ruleset popular?

The npm package @ibm-cloud/openapi-ruleset receives a total of 181,768 weekly downloads. As such, @ibm-cloud/openapi-ruleset popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @ibm-cloud/openapi-ruleset well maintained?

We found that @ibm-cloud/openapi-ruleset demonstrated a healthy version release cadence and project activity. It has a community of 0 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @ibm-cloud/openapi-ruleset safe to use?

The npm package @ibm-cloud/openapi-ruleset was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 19 December-2024, at 10:09 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP