@visulima/jsdoc-open-api 1.1.1 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/README.md +4 -4
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,16 @@
|
|
|
1
|
+
## @visulima/jsdoc-open-api [1.2.0](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@1.1.1...@visulima/jsdoc-open-api@1.2.0) (2022-11-15)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Features
|
|
5
|
+
|
|
6
|
+
* added new packages for faster api creation ([#14](https://github.com/visulima/visulima/issues/14)) ([eb64fcf](https://github.com/visulima/visulima/commit/eb64fcf33f2a75ea48262ad6e71f80e159a93972))
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
### Dependencies
|
|
11
|
+
|
|
12
|
+
* **@visulima/readdir:** upgraded to 1.3.0
|
|
13
|
+
|
|
1
14
|
## @visulima/jsdoc-open-api [1.1.1](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@1.1.0...@visulima/jsdoc-open-api@1.1.1) (2022-10-31)
|
|
2
15
|
|
|
3
16
|
|
package/README.md
CHANGED
|
@@ -119,7 +119,7 @@ const withOpenApi = ({ definition, sources, verbose, output = "swagger/swagger.j
|
|
|
119
119
|
module.exports = withOpenApi;
|
|
120
120
|
```
|
|
121
121
|
|
|
122
|
-
####
|
|
122
|
+
#### Next.config.js
|
|
123
123
|
```js
|
|
124
124
|
const withOpenApi = require("./with-open-api");
|
|
125
125
|
|
|
@@ -147,7 +147,7 @@ module.exports = withOpenApi({
|
|
|
147
147
|
})(nextConfig);
|
|
148
148
|
```
|
|
149
149
|
|
|
150
|
-
## OpenApi
|
|
150
|
+
## OpenApi YAML syntax
|
|
151
151
|
|
|
152
152
|
The library will take the contents of @openapi (or @swagger):
|
|
153
153
|
|
|
@@ -246,7 +246,7 @@ For example, this JSON object:
|
|
|
246
246
|
}
|
|
247
247
|
```
|
|
248
248
|
|
|
249
|
-
|
|
249
|
+
Can be represented as:
|
|
250
250
|
|
|
251
251
|
```yaml
|
|
252
252
|
components:
|
|
@@ -263,7 +263,7 @@ components:
|
|
|
263
263
|
- name
|
|
264
264
|
```
|
|
265
265
|
|
|
266
|
-
|
|
266
|
+
And then referenced in the request body schema and response body schema as follows:
|
|
267
267
|
|
|
268
268
|
```js
|
|
269
269
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@visulima/jsdoc-open-api",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.2.0",
|
|
4
4
|
"description": "Generates swagger doc based on JSDoc.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"visulima",
|
|
@@ -65,13 +65,13 @@
|
|
|
65
65
|
"clean": "rimraf node_modules dist",
|
|
66
66
|
"coverage": "vitest run --coverage",
|
|
67
67
|
"dev": "pnpm predev && pnpm run build --watch",
|
|
68
|
-
"lint:eslint": "cross-env NO_LOGS=true eslint --ext js,jsx,ts,tsx --max-warnings=0 --config .eslintrc.cjs
|
|
68
|
+
"lint:eslint": "cross-env NO_LOGS=true eslint --ext js,jsx,ts,tsx --max-warnings=0 --config .eslintrc.cjs",
|
|
69
69
|
"lint:eslint:fix": "pnpm run lint:eslint --fix",
|
|
70
70
|
"test": "vitest"
|
|
71
71
|
},
|
|
72
72
|
"dependencies": {
|
|
73
73
|
"@apidevtools/swagger-parser": "^10.1.0",
|
|
74
|
-
"@visulima/readdir": "1.
|
|
74
|
+
"@visulima/readdir": "1.3.0",
|
|
75
75
|
"cli-progress": "^3.11.2",
|
|
76
76
|
"commander": "^9.4.1",
|
|
77
77
|
"comment-parser": "^1.3.1",
|