{"_id":"@readme/openapi-schemas","_rev":"13-760353ded7e460ec11827ec75cdbe613","name":"@readme/openapi-schemas","dist-tags":{"latest":"4.0.0"},"versions":{"3.0.1":{"name":"@readme/openapi-schemas","version":"3.0.1","keywords":["openapi","open-api","swagger","oas","api","rest","json","specification","definition","schema"],"author":{"url":"https://readme.com","name":"ReadMe","email":"support@readme.io"},"license":"MIT","_id":"@readme/openapi-schemas@3.0.1","maintainers":[{"name":"gratcliff","email":"gabriel@readme.io"},{"name":"dannobytes","email":"dannlee@gmail.com"},{"name":"gkoberger","email":"gkoberger@gmail.com"},{"name":"domharrington","email":"domharrington+npm@protonmail.com"},{"name":"mjcuva","email":"marc@readme.io"},{"name":"kanadgupta","email":"npm@kanad.dev"},{"name":"jonursenbach","email":"jon@ursenba.ch"},{"name":"rafegoldberg","email":"rafegoldberg@gmail.com"},{"name":"dashron","email":"ahh@fastmail.com"},{"name":"iliast","email":"iliastsangaris@gmail.com"}],"homepage":"https://github.com/readmeio/openapi-schemas#readme","bugs":{"url":"https://github.com/readmeio/openapi-schemas/issues"},"dist":{"shasum":"ffed3202de7f8e490667487cfca7a17e7f8f5c58","tarball":"https://registry.npmjs.org/@readme/openapi-schemas/-/openapi-schemas-3.0.1.tgz","fileCount":9,"integrity":"sha512-XtS26dGvM/iPOU1MbQLXEKE5rZGwkVYri/z6o7Yk7moLE/+Ng9eg26Wj80WuHIYkuxYxvHlsy1/OiTqfiXjzcQ==","signatures":[{"sig":"MEUCIA0yrouRLNuCOdGgnX40+E3wq+WbaYyoFl/HC3eg4YLTAiEA9uWXIkAdvHkfThBwxXuRXEqfXmkeK0uzaAsLciLWDt0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":843139},"main":"dist/index.js","types":"dist/index.d.ts","engines":{"node":">=18"},"exports":{".":{"import":"./dist/index.mjs","require":"./dist/index.js"},"./package.json":"./package.json"},"gitHead":"1f3b499fc8a6055cec73756fc4314e81280b4329","scripts":{"attw":"attw --pack --format table-flipped","lint":"tsc --noEmit && eslint . --ext .js,.ts --ignore-path .gitignore && prettier -c .","test":"vitest run","build":"npm run build:schemas && npm run build:typescript","prelint":"npm run build:schemas","prepack":"npm run build","pretest":"npm run lint","prebuild":"rm -rf .tmp/ dist/ schemas/","prettier":"prettier --check --write .","build:schemas":"rm -rf .tmp/ && git clone https://github.com/OAI/OpenAPI-Specification.git .tmp && cp -r .tmp/schemas src/schemas","build:typescript":"tsup"},"_npmUser":{"name":"jonursenbach","email":"jon@ursenba.ch"},"prettier":"@readme/eslint-config/prettier","repository":{"url":"git://github.com/readmeio/openapi-schemas.git","type":"git"},"_npmVersion":"10.2.4","description":"JSON Schemas for every version of the OpenAPI Specification","directories":{},"sideEffects":false,"_nodeVersion":"20.11.1","_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.0.2","eslint":"^8.57.0","vitest":"^1.6.0","prettier":"^3.2.5","typescript":"^5.4.5","@types/node":"^20.12.11","@readme/eslint-config":"^14.0.0"},"_npmOperationalInternal":{"tmp":"tmp/openapi-schemas_3.0.1_1715615636681_0.3354504576521036","host":"s3://npm-registry-packages"}},"3.1.0":{"name":"@readme/openapi-schemas","version":"3.1.0","keywords":["openapi","open-api","swagger","oas","api","rest","json","specification","definition","schema"],"author":{"url":"https://readme.com","name":"ReadMe","email":"support@readme.io"},"license":"MIT","_id":"@readme/openapi-schemas@3.1.0","maintainers":[{"name":"darrenyong","email":"contact.darrenyong@gmail.com"},{"name":"gratcliff","email":"gabriel@readme.io"},{"name":"dannobytes","email":"dannlee@gmail.com"},{"name":"gkoberger","email":"gkoberger@gmail.com"},{"name":"domharrington","email":"domharrington+npm@protonmail.com"},{"name":"mjcuva","email":"marc@readme.io"},{"name":"kanadgupta","email":"npm@kanad.dev"},{"name":"jonursenbach","email":"jon@ursenba.ch"},{"name":"rafegoldberg","email":"rafegoldberg@gmail.com"},{"name":"dashron","email":"ahh@fastmail.com"},{"name":"iliast","email":"iliastsangaris@gmail.com"}],"homepage":"https://github.com/readmeio/openapi-schemas#readme","bugs":{"url":"https://github.com/readmeio/openapi-schemas/issues"},"dist":{"shasum":"5ff4b704af6a8b108f9d577fd87cf73e9e7b3178","tarball":"https://registry.npmjs.org/@readme/openapi-schemas/-/openapi-schemas-3.1.0.tgz","fileCount":9,"integrity":"sha512-9FC/6ho8uFa8fV50+FPy/ngWN53jaUu4GRXlAjcxIRrzhltJnpKkBG2Tp0IDraFJeWrOpk84RJ9EMEEYzaI1Bw==","signatures":[{"sig":"MEUCIEBkX3m9cv6UKDuL/tLOKDXXGLNA3Y/jBSyRuuZjUsUwAiEA+AYE3yh09Ow9JQLFdbSxHOyyvBkyres/17qI8ZCoif0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1098377},"main":"dist/index.js","types":"dist/index.d.ts","engines":{"node":">=18"},"exports":{".":{"import":"./dist/index.mjs","require":"./dist/index.js"},"./package.json":"./package.json"},"gitHead":"9ca59def5e155c3d3114a3ac58149d6859e73cf5","scripts":{"attw":"attw --pack --format table-flipped","lint":"tsc --noEmit && eslint . --ext .js,.ts --ignore-path .gitignore && prettier -c .","test":"vitest run","build":"npm run build:schemas && npm run build:typescript","prelint":"npm run build:schemas","prepack":"npm run build","pretest":"npm run lint","prebuild":"rm -rf .tmp/ dist/ schemas/","prettier":"prettier --check --write .","build:schemas":"rm -rf .tmp/ src/schemas/ && git clone https://github.com/OAI/OpenAPI-Specification.git .tmp && cp -r .tmp/schemas src/schemas && tsx src/create-legacy-schema.ts","build:typescript":"tsup"},"_npmUser":{"name":"darrenyong","email":"contact.darrenyong@gmail.com"},"prettier":"@readme/eslint-config/prettier","repository":{"url":"git://github.com/readmeio/openapi-schemas.git","type":"git"},"_npmVersion":"10.2.4","description":"JSON Schemas for every version of the OpenAPI Specification","directories":{},"sideEffects":false,"_nodeVersion":"20.11.1","_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.10.4","tsup":"^8.0.2","eslint":"^8.57.0","vitest":"^1.6.0","prettier":"^3.2.5","typescript":"^5.4.5","@types/node":"^20.12.11","@readme/eslint-config":"^14.0.0"},"_npmOperationalInternal":{"tmp":"tmp/openapi-schemas_3.1.0_1716412250733_0.3792810963107387","host":"s3://npm-registry-packages"}},"4.0.0":{"name":"@readme/openapi-schemas","version":"4.0.0","description":"JSON Schemas for every version of the OpenAPI Specification","license":"MIT","author":{"name":"ReadMe","email":"support@readme.io","url":"https://readme.com"},"sideEffects":false,"exports":{".":{"require":"./dist/index.js","import":"./dist/index.mjs"},"./package.json":"./package.json"},"main":"dist/index.js","types":"dist/index.d.ts","engines":{"node":">=20"},"keywords":["openapi","open-api","swagger","oas","api","rest","json","specification","definition","schema"],"repository":{"type":"git","url":"git://github.com/readmeio/oas.git","directory":"packages/schemas"},"bugs":{"url":"https://github.com/readmeio/oas/issues"},"scripts":{"attw":"attw --pack --format ascii --profile node16","build":"npm run build:schemas && npm run build:typescript","build:schemas":"rm -rf .tmp/ src/schemas/ && git clone --depth 1 https://github.com/OAI/spec.openapis.org.git .tmp/spec.openapis.org && git clone --depth 1 https://github.com/OAI/OpenAPI-Specification.git .tmp/OpenAPI-Specification && tsx src/build-schemas.ts","build:typescript":"tsup","lint":"npm run lint:types","lint:types":"tsc --noEmit","prebuild":"rm -rf .tmp/ dist/ schemas/","prelint":"npm run build:schemas","prepack":"npm run build","test":"echo 'Please run tests from the root!' && exit 1"},"dependencies":{"@types/json-schema":"^7.0.15"},"devDependencies":{"@types/node":"^25.3.0","tsup":"^8.5.0","tsx":"^4.23.0","typescript":"^5.4.4","vitest":"^4.1.5"},"_id":"@readme/openapi-schemas@4.0.0","gitHead":"358bf2947ac439b341622ca12a9b24db0b87afd1","homepage":"https://github.com/readmeio/oas#readme","_nodeVersion":"22.21.0","_npmVersion":"10.9.4","dist":{"integrity":"sha512-hrG//9/+RpOZTrUDirU4OzfMqaxCdY5BMpr3YuLf3Rje9rfNsydQJsH9iCPTie9ZRu9xe+0OUD4fHe0JmGwa2w==","shasum":"dab8f2bf1a60f506f3dd7698e78e0d6eb4218a14","tarball":"https://registry.npmjs.org/@readme/openapi-schemas/-/openapi-schemas-4.0.0.tgz","fileCount":9,"unpackedSize":1237289,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIARU8ziHjX7zR2b0j6RM3BRZbSDH1OZztjSSe2OM4+BcAiAuSmzymXysXEYy588Yqr8XPV+wWwuK6aQN3Yk9DiP7vQ=="}]},"_npmUser":{"name":"jonursenbach","email":"jon@ursenba.ch"},"directories":{},"maintainers":[{"name":"gkoberger","email":"gkoberger@gmail.com"},{"name":"domharrington","email":"warm.cord4996@fastmail.com"},{"name":"mjcuva","email":"marc@readme.io"},{"name":"jonursenbach","email":"jon@ursenba.ch"},{"name":"rafegoldberg","email":"rafegoldberg@gmail.com"},{"name":"darrenyong","email":"contact.darrenyong@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/openapi-schemas_4.0.0_1783399254402_0.11147159531424444"},"_hasShrinkwrap":false}},"time":{"created":"2024-05-13T15:53:56.529Z","modified":"2026-07-07T04:40:54.756Z","3.0.1":"2024-05-13T15:53:56.818Z","3.1.0":"2024-05-22T21:10:50.931Z","4.0.0":"2026-07-07T04:40:54.535Z"},"bugs":{"url":"https://github.com/readmeio/oas/issues"},"author":{"name":"ReadMe","email":"support@readme.io","url":"https://readme.com"},"license":"MIT","homepage":"https://github.com/readmeio/oas#readme","keywords":["openapi","open-api","swagger","oas","api","rest","json","specification","definition","schema"],"repository":{"type":"git","url":"git://github.com/readmeio/oas.git","directory":"packages/schemas"},"description":"JSON Schemas for every version of the OpenAPI Specification","maintainers":[{"name":"gkoberger","email":"gkoberger@gmail.com"},{"name":"domharrington","email":"warm.cord4996@fastmail.com"},{"name":"mjcuva","email":"marc@readme.io"},{"name":"jonursenbach","email":"jon@ursenba.ch"},{"name":"rafegoldberg","email":"rafegoldberg@gmail.com"},{"name":"darrenyong","email":"contact.darrenyong@gmail.com"}],"readme":"# @readme/openapi-schemas\n\n[![Build](https://github.com/readmeio/oas/workflows/CI/badge.svg)](https://github.com/readmeio/openapi-schemas/) [![](https://img.shields.io/npm/v/@readme/openapi-schemas)](https://npm.im/@readme/openapi-schemas)\n\n[![](https://raw.githubusercontent.com/readmeio/.github/main/oss-header.png)](https://readme.io)\n\nThis package contains [**the official JSON Schemas**](https://github.com/OAI/spec.openapis.org/tree/main/oas) for every version of Swagger/OpenAPI Specification:\n\n<!-- prettier-ignore-start -->\n| Version | Schema | Docs |\n| :--- | :--- | :--- |\n| Swagger 1.2 | [v1.2 schema](https://github.com/OAI/OpenAPI-Specification/tree/main/_archive_/schemas/v1.2) | [v1.2 docs](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/1.2.md) |\n| Swagger 2.0 | [v2.0 schema](https://github.com/OAI/spec.openapis.org/tree/main/oas/2.0/schema) | [v2.0 docs](https://spec.openapis.org/oas/v2.0.html) |\n| OpenAPI 3.0.x | [v3.0.x schema](https://github.com/OAI/spec.openapis.org/tree/main/oas/3.0/schema) | [v3.0.x docs](https://spec.openapis.org/oas/v3.0.4.html) |\n| OpenAPI 3.1.x | [v3.1.x schema](https://github.com/OAI/spec.openapis.org/tree/main/oas/3.1/schema) | [v3.1.x docs](https://spec.openapis.org/oas/v3.1.2.html) |\n| OpenAPI 3.2.x | [v3.2.x schema](https://github.com/OAI/spec.openapis.org/tree/main/oas/3.2/schema) | [v3.2.x docs](https://spec.openapis.org/oas/v3.2.0.html) |\n<!-- prettier-ignore-end -->\n\n## Installation\n\nYou can install OpenAPI Schemas via [npm](https://docs.npmjs.com/about-npm/).\n\n```bash\nnpm install @readme/openapi-schemas\n```\n\n## Usage\n\nThe library contains all OpenAPI Specification versions:\n\n```js\nimport { openapi } from '@readme/openapi-schemas';\n\nconsole.log(openapi.v1); // { $schema, id, properties, definitions, ... }\nconsole.log(openapi.v2); // { $schema, id, properties, definitions, ... }\nconsole.log(openapi.v3); // { $schema, id, properties, definitions, ... }\nconsole.log(openapi.v31); // { $schema, id, properties, definitions, ... }\nconsole.log(openapi.v32); // { $schema, id, properties, definitions, ... }\n```\n\nYou can use a JSON Schema validator such as [Z-Schema](https://npm.im/z-schema) or [AJV](https://npm.im/ajv) to validate OpenAPI definitions against the specification.\n\n```js\nimport { openapi } from '@readme/openapi-schemas';\nimport ZSchema from 'z-schema';\n\n// Create a ZSchema validator\nlet validator = new ZSchema();\n\n// Validate an OpenAPI definition against the OpenAPI v3.0 specification\nvalidator.validate(openapiDefinition, openapi.v31);\n```\n","readmeFilename":"README.md"}