Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@apidevtools/openapi-schemas
Advanced tools
Readme
This package contains the official JSON Schemas for every version of Swagger/OpenAPI Specification:
Version | Schema | Docs |
---|---|---|
Swagger 1.2 | v1.2 schema | v1.2 docs |
Swagger 2.0 | v2.0 schema | v2.0 docs |
OpenAPI 3.0.x | v3.0.x schema | v3.0.3 docs |
OpenAPI 3.1.x | v3.1.x schema | v3.1.0 docs |
All schemas are kept up-to-date with the latest official definitions via an automated CI/CD job. 🤖📦
You can install OpenAPI Schemas via npm.
npm install @apidevtools/openapi-schemas
The default export contains all OpenAPI Specification versions:
const openapi = require("@apidevtools/openapi-schemas");
console.log(openapi.v1); // { $schema, id, properties, definitions, ... }
console.log(openapi.v2); // { $schema, id, properties, definitions, ... }
console.log(openapi.v3); // { $schema, id, properties, definitions, ... }
console.log(openapi.v31); // { $schema, id, properties, definitions, ... }
Or you can import the specific version(s) that you need:
const { openapiV1, openapiV2, openapiV3, openapiV31 } = require("@apidevtools/openapi-schemas");
console.log(openapiV1); // { $schema, id, properties, definitions, ... }
console.log(openapiV2); // { $schema, id, properties, definitions, ... }
console.log(openapiV3); // { $schema, id, properties, definitions, ... }
console.log(openapiV31); // { $schema, id, properties, definitions, ... }
You can use a JSON Schema validator such as Z-Schema or AJV to validate OpenAPI definitions against the specification.
const { openapiV31 } = require("@apidevtools/openapi-schemas");
const ZSchema = require("z-schema");
// Create a ZSchema validator
let validator = new ZSchema();
// Validate an OpenAPI definition against the OpenAPI v3.0 specification
validator.validate(openapiDefinition, openapiV31);
Contributions, enhancements, and bug-fixes are welcome! Open an issue on GitHub and submit a pull request.
To build the project locally on your computer:
Clone this repo
git clone https://github.com/APIDevTools/openapi-schemas.git
Install dependencies
npm install
Build the code
npm run build
Run the tests
npm test
OpenAPI Schemas is 100% free and open-source, under the MIT license. Use it however you want.
This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
Thanks to these awesome companies for their support of Open Source developers ❤
FAQs
JSON Schemas for every version of the OpenAPI Specification
The npm package @apidevtools/openapi-schemas receives a total of 1,545,756 weekly downloads. As such, @apidevtools/openapi-schemas popularity was classified as popular.
We found that @apidevtools/openapi-schemas demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.