{"_id":"@openapi-spec/types","_rev":"2-8525934926bf0e7f2d0ac8c5319c9f38","name":"@openapi-spec/types","dist-tags":{"latest":"0.1.0"},"versions":{"0.0.0":{"name":"@openapi-spec/types","version":"0.0.0","keywords":["oas","openapi","openapi-3.0","openapi-3.1","openapi-3.2","openapi-spec","openapi-types","specification","swagger","types","typescript"],"license":"MIT","_id":"@openapi-spec/types@0.0.0","maintainers":[{"name":"dinwwwh","email":"dinwwwh@gmail.com"}],"homepage":"https://github.com/middleapi/openapi-spec","dist":{"shasum":"76d4327280dbee96e40f78d2d5067d048143fb81","tarball":"https://registry.npmjs.org/@openapi-spec/types/-/types-0.0.0.tgz","fileCount":19,"integrity":"sha512-vhJj7F/se7YUn+ZsqczzPPP4qpTeb0QTjRNYLURA3AKcZkDHn7wofnEIDiMXjOXbH4rZcr9RI3bZtYiZqLFmkA==","signatures":[{"sig":"MEYCIQDCUuwDWkG3pbaHgoZWuuRFNxlF6+ncL6u4QHT5GqOE/gIhAPtjg9WVdR3uGVQBIsYpN8KhnryALsesxH/BlWnCcBkx","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":450369},"type":"module","exports":{".":{"types":"./dist/index.d.mts","import":"./dist/index.mjs","default":"./dist/index.mjs"},"./v3.0":{"types":"./dist/v3.0.d.mts","import":"./dist/v3.0.mjs","default":"./dist/v3.0.mjs"},"./v3.1":{"types":"./dist/v3.1.d.mts","import":"./dist/v3.1.mjs","default":"./dist/v3.1.mjs"},"./v3.2":{"types":"./dist/v3.2.d.mts","import":"./dist/v3.2.mjs","default":"./dist/v3.2.mjs"},"./package.json":"./package.json"},"funding":["https://github.com/sponsors/dinwwwh","https://opencollective.com/middleapi"],"scripts":{"type:check":"tsc -b"},"_npmUser":{"name":"dinwwwh","email":"dinwwwh@gmail.com"},"repository":{"url":"git+https://github.com/middleapi/openapi-spec.git","type":"git","directory":"packages/types"},"description":"TypeScript types for the OpenAPI Specification, covering versions 3.0, 3.1, and 3.2 with complete inline documentation","directories":{},"sideEffects":false,"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/types_0.0.0_1788771423406_0.03872335603758725","host":"s3://npm-registry-packages-npm-production"}},"0.1.0":{"name":"@openapi-spec/types","type":"module","version":"0.1.0","description":"TypeScript types for the OpenAPI Specification, covering versions 3.0, 3.1, and 3.2 with complete inline documentation","license":"MIT","funding":["https://github.com/sponsors/dinwwwh","https://opencollective.com/middleapi"],"homepage":"https://github.com/middleapi/openapi-spec","repository":{"type":"git","url":"git+https://github.com/middleapi/openapi-spec.git","directory":"packages/types"},"keywords":["oas","openapi","openapi-3.0","openapi-3.1","openapi-3.2","openapi-spec","openapi-types","specification","swagger","types","typescript"],"sideEffects":false,"exports":{"./package.json":"./package.json",".":{"types":"./dist/index.d.mts","import":"./dist/index.mjs","default":"./dist/index.mjs"},"./v3.0":{"types":"./dist/v3.0.d.mts","import":"./dist/v3.0.mjs","default":"./dist/v3.0.mjs"},"./v3.1":{"types":"./dist/v3.1.d.mts","import":"./dist/v3.1.mjs","default":"./dist/v3.1.mjs"},"./v3.2":{"types":"./dist/v3.2.d.mts","import":"./dist/v3.2.mjs","default":"./dist/v3.2.mjs"}},"scripts":{"type:check":"tsc -b"},"_id":"@openapi-spec/types@0.1.0","dist":{"integrity":"sha512-5m9GUj5ekwmJ5uXH0yctarqLGckGc8X7pX65dirukZDUAGmrUx5lKovvWA7YvEBKd480Q7R2oG3nE5C+SoVgNw==","shasum":"82565b372cef4baaf0c8e24a5a9b5d529e8b9c55","tarball":"https://registry.npmjs.org/@openapi-spec/types/-/types-0.1.0.tgz","fileCount":19,"unpackedSize":450369,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@openapi-spec%2ftypes@0.1.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDlNIGPOIg/G1/OC2I/TqRNQuJtLb5uiRsIzBXdPKGmAAIgacAl1wfCaAVgPVtNoba25qgMxC4A7TbMGScVjnPfqL8="}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:14186dc3-ff1a-45ca-a042-a25fa8a0cf8b"}},"directories":{},"maintainers":[{"name":"dinwwwh","email":"dinwwwh@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/types_0.1.0_1788772011894_0.5902699500039907"},"_hasShrinkwrap":false}},"time":{"created":"2026-09-07T08:57:03.164Z","modified":"2026-09-07T09:06:52.475Z","0.0.0":"2026-09-07T08:57:03.563Z","0.1.0":"2026-09-07T09:06:52.063Z"},"license":"MIT","homepage":"https://github.com/middleapi/openapi-spec","keywords":["oas","openapi","openapi-3.0","openapi-3.1","openapi-3.2","openapi-spec","openapi-types","specification","swagger","types","typescript"],"repository":{"type":"git","url":"git+https://github.com/middleapi/openapi-spec.git","directory":"packages/types"},"description":"TypeScript types for the OpenAPI Specification, covering versions 3.0, 3.1, and 3.2 with complete inline documentation","maintainers":[{"name":"dinwwwh","email":"dinwwwh@gmail.com"}],"readme":"

OpenAPI Spec

\n\n
\n \n \"codecov\"\n \n \n \"weekly\n \n \n \"MIT\n \n \n \"Discord\"\n \n \n \"Ask\n \n
\n\n`@openapi-spec/types` provides TypeScript types for the [OpenAPI Specification](https://spec.openapis.org/), covering versions 3.0, 3.1, and 3.2. Every object and field is modelled after the specification, and every field carries the specification's own description as JSDoc with a link to its section, so the spec is readable from your editor. The package ships types only, no runtime code.\n\nEach version module targets the latest patch release of its minor line:\n\n| Module | Specification | Notes |\n| -------------------------- | ---------------------------------------------------------- | ------------------------------------------------ |\n| `@openapi-spec/types/v3.0` | [OpenAPI 3.0.4](https://spec.openapis.org/oas/v3.0.4.html) | |\n| `@openapi-spec/types/v3.1` | [OpenAPI 3.1.2](https://spec.openapis.org/oas/v3.1.2.html) | Reuses 3.0 types for objects that did not change |\n| `@openapi-spec/types/v3.2` | [OpenAPI 3.2.0](https://spec.openapis.org/oas/v3.2.0.html) | Reuses 3.1 types for objects that did not change |\n\n## Usage\n\n```ts\n// Every version as a namespace\nimport type { OpenAPIV3_0, OpenAPIV3_1, OpenAPIV3_2 } from '@openapi-spec/types'\n\n// Or one version directly\nimport type { OpenAPIObject, SchemaObject } from '@openapi-spec/types/v3.1'\n\nconst doc: OpenAPIObject = {\n openapi: '3.1.2',\n info: { title: 'Pet Store', version: '1.0.0' },\n paths: {},\n}\n\n// SchemaObject takes an optional data type for its data-carrying fields:\n// `enum`, `default`, `example`, and from 3.1 on `const` and `examples`\nconst status = {\n type: 'string',\n enum: ['available', 'pending', 'sold'],\n default: 'available',\n} satisfies SchemaObject\n```\n\n## Conventions\n\n- Type names follow the specification's section names: `InfoObject`, `PathItemObject`, `SchemaObject`, and so on.\n- Fields the specification marks as deprecated carry an `@deprecated` tag.\n- Rules the type system can express are enforced: allowed fields, value shapes, and version-specific literals such as `style` values. Rules it cannot express, like mutually exclusive fields or \"at least one of\", are stated in the JSDoc instead.\n\nThe types are checked against the official example documents and the specification's own schema test corpus. See [tests/README.md](https://github.com/middleapi/openapi-spec/blob/main/packages/types/tests/README.md).\n\n## Sponsors\n\nLike what we build over at [middleapi](https://github.com/middleapi)? You can help keep it going through [GitHub Sponsors](https://github.com/sponsors/dinwwwh) or [Open Collective](https://opencollective.com/middleapi). Every bit helps! πŸš€\n\n\n \n \n \n \n \n \n \n \n \n
\"ScreenshotOne.com\"/ScreenshotOne.com
The screenshot API for developers
\"Yuzu\"/Yuzu
We're hiring NYC based engineers
\"MisskeyHQ\"/MisskeyHQ
Decentralized microblogging SNS born on Earth
\n\n### Organization Sponsors\n\n\n \n \n \n
\"LN
LN Markets
\n\n### Sponsors\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\"Reece
Reece McDonald		\"あわわわとーにゅ\"/
あわわわとーにゅ		\"nk\"/
nk		\"supastarter\"/
supastarter		\"Dexter
Dexter Miguel		\"herrfugbaum\"/
herrfugbaum
\"Ryota
Ryota Murakami		\"David
David Cramer		\"Valerii
Valerii Petryniak		\"Valerii
Valerii Strilets		\"Kyle
Kyle Mistele		\"christ12938\"/
christ12938
\"Ryan
Ryan Soderberg		\"shota\"/
shota		\"Ellis
Ellis Driscoll		\"Hoang
Hoang Nguyen		\"Orestis
Orestis Ioannou
\n\n### Backers\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\"David
David Walsh		\"IPv4Addr\"/
IPv4Addr		\"Robbe
Robbe Vaes		\"Aidan
Aidan Sunbury		\"soonoo\"/
soonoo		\"Kevin
Kevin Porten		\"Denis\"/
Denis
\"Christopher
Christopher Kapic		\"Tom
Tom Ballinger		\"Sam\"/
Sam		\"Titoine\"/
Titoine		\"Igor
Igor Makowski		\"hanayashiki\"/
hanayashiki		\"Lev
Lev Dubinets
\"Kelly
Kelly Peilin Chan		\"Guy
Guy Ariely		\"PaulSenon\"/
PaulSenon		\"Alex\"/
Alex		\"Andrey
Andrey Gubanov
\n\nWith thanks to [36 past sponsors](https://htmlpreview.github.io/?https://github.com/middleapi/static/blob/main/sponsors.svg) who helped get openapi-spec here.\n\n## License\n\nDistributed under the MIT License. See [LICENSE](https://github.com/middleapi/openapi-spec/blob/main/LICENSE) for more information.\n","readmeFilename":""}