Skip to content

Commit

Permalink
explicit separate support for oas 3.0 and oas 3.1 from issue #90 + add
Browse files Browse the repository at this point in the history
…@deprecate jsdoc + update docs

update libs + normalize file names
  • Loading branch information
pjmolina committed Mar 27, 2023
1 parent 6bee6cf commit 602b0fe
Show file tree
Hide file tree
Showing 19 changed files with 1,853 additions and 2,807 deletions.
6 changes: 6 additions & 0 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog: openapi3-ts

## Version 4.0.0

2023.03.27

- Breaking change. Adds explicit support for OAS 3.0 and OAS 3.1 as separate implementations.

## Version 3.2.0

- PR [#94](https://github.com/metadevpro/openapi3-ts/pull/94) Export type `SchemaObjectType`.
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ TypeScript library to help building OpenAPI 3.x compliant API contracts.

[![NPM](https://nodei.co/npm/openapi3-ts.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/openapi3-ts/)

## Version 4

*Breaking change notice:*

Version 4.0 Adds explicit support for OAS 3.0 and OAS 3.1 as separate implementations.

## Includes

* `/src/model` TS typed interfaces for helping building a contract.
Expand Down Expand Up @@ -37,4 +43,4 @@ Licensed under the MIT License.

**Contact:** Pedro J. Molina | github: [pjmolina](https://github.com/pjmolina) | twitter: [pmolinam](https://twitter.com/pmolinam)

(c) 2017-2022. [Pedro J. Molina](http://pjmolina.com) at Metadev S.L. [https://metadev.pro](https://metadev.pro) & contributors.
(c) 2017-2023. [Pedro J. Molina](http://pjmolina.com) at Metadev S.L. [https://metadev.pro](https://metadev.pro) & contributors.
3,377 changes: 693 additions & 2,684 deletions package-lock.json

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "openapi3-ts",
"version": "3.2.0",
"version": "4.0.0",
"description": "TS Model & utils for OpenAPI 3.x specification.",
"main": "dist/cjs/index.js",
"module": "dist/mjs/index.js",
Expand Down Expand Up @@ -33,19 +33,19 @@
"yaml": "^2.2.1"
},
"devDependencies": {
"@types/node": "^18.14.0",
"@typescript-eslint/eslint-plugin": "^5.53.0",
"@typescript-eslint/parser": "^5.53.0",
"@vitest/coverage-c8": "^0.28.5",
"@types/node": "^18.15.10",
"@typescript-eslint/eslint-plugin": "^5.56.0",
"@typescript-eslint/parser": "^5.56.0",
"@vitest/coverage-c8": "^0.29.7",
"c8": "^7.13.0",
"coveralls": "^3.1.1",
"eslint": "^8.34.0",
"eslint-config-prettier": "^8.6.0",
"eslint": "^8.36.0",
"eslint-config-prettier": "^8.8.0",
"eslint-plugin-prettier": "^4.2.1",
"prettier": "^2.8.4",
"rimraf": "^4.1.2",
"typescript": "~4.9.5",
"vitest": "^0.28.5",
"vitest-teamcity-reporter": "^0.1.10"
"prettier": "^2.8.7",
"rimraf": "^4.4.1",
"typescript": "~5.0.2",
"vitest": "^0.29.7",
"vitest-teamcity-reporter": "^0.1.12"
}
}
2 changes: 1 addition & 1 deletion src/dsl/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export * from './OpenApiBuilder.js';
export * from './openapi-builder31.js';
Loading

0 comments on commit 602b0fe

Please sign in to comment.