Skip to content

Commit 04168af

Browse files
js2megenaby
andcommitted
Release 1.4.1 (#24)
* chore: prettier ignore test generated apis * [Bugfix] TypeScript 3.7.5 error in the strict mode inside addQueryParams method * bump: up version to 1.4.1; docs: update CHANGELOG; Co-authored-by: Henadz Yermakavets <[email protected]>
1 parent b4379b0 commit 04168af

31 files changed

+821
-376
lines changed

.prettierignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
tests/**/*.ts

.prettierrc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"printWidth": 100,
3+
"tabWidth": 2,
4+
"trailingComma": "all"
5+
}

CHANGELOG.md

+97-66
Original file line numberDiff line numberDiff line change
@@ -1,97 +1,128 @@
1-
# 1.4.0
2-
Breaking Changes:
3-
- Rename default typescript output api file name (prev `api.ts`, now `Api.ts`)
4-
Features:
5-
- `-d, --default-as-success` option. Allows to use "default" status codes as success response type
6-
- `-r, --responses` option. Response declarations in request rescription
7-
This option adds comments of the possible responses from request
8-
![responses comments](./assets/changelog_assets/responses-comments.jpg)
9-
Also typings for `.catch()` callback
10-
![responses catch types](./assets/changelog_assets/responses-catch-types.jpg)
11-
- Improve response body type definitions
12-
- Types for bad responses
13-
Changes:
14-
- \[minor\] fix jsdoc comments space
15-
![right comments space](./assets/changelog_assets/right-comments-space.jpg)
16-
17-
# 1.3.0
18-
Features:
19-
- Api module description from schema info
20-
![api description](./assets/changelog_assets/api-module-description.jpg)
21-
- Generate API type declarations (CLI flag `--route-types`)
22-
![route types](./assets/changelog_assets/route-types.jpg)
23-
- Ability to not generate clint API class (CLI flag `--no-client`)
24-
25-
Fixes:
26-
- Improve response body type definition
27-
28-
Internal:
29-
- refactored `generate` and `validate` test scripts
30-
31-
# 1.2.6
32-
Fixes: create api without `-o` option (use default `./` output)
33-
34-
# 1.2.5
1+
# next release
2+
3+
# 1.4.1
4+
5+
Fixes:
6+
7+
- Fix TS problem with `addQueryParams` Api class method (issue [#22](https://github.com/acacode/swagger-typescript-api/issues/22), thanks [genaby](https://github.com/genaby))
8+
9+
# 1.4.0
10+
11+
Breaking Changes:
12+
13+
- Rename default typescript output api file name (prev `api.ts`, now `Api.ts`)
14+
Features:
15+
- `-d, --default-as-success` option. Allows to use "default" status codes as success response type
16+
- `-r, --responses` option. Response declarations in request rescription
17+
This option adds comments of the possible responses from request
18+
![responses comments](./assets/changelog_assets/responses-comments.jpg)
19+
Also typings for `.catch()` callback
20+
![responses catch types](./assets/changelog_assets/responses-catch-types.jpg)
21+
- Improve response body type definitions
22+
- Types for bad responses
23+
Changes:
24+
- \[minor\] fix jsdoc comments space
25+
![right comments space](./assets/changelog_assets/right-comments-space.jpg)
26+
27+
# 1.3.0
28+
29+
Features:
30+
31+
- Api module description from schema info
32+
![api description](./assets/changelog_assets/api-module-description.jpg)
33+
- Generate API type declarations (CLI flag `--route-types`, thanks [azz](https://github.com/azz))
34+
![route types](./assets/changelog_assets/route-types.jpg)
35+
- Ability to not generate clint API class (CLI flag `--no-client`, thanks [azz](https://github.com/azz))
36+
37+
Fixes:
38+
39+
- Improve response body type definition
40+
41+
Internal:
42+
43+
- refactored `generate` and `validate` test scripts
44+
45+
# 1.2.6
46+
47+
Fixes: create api without `-o` option (use default `./` output)
48+
49+
# 1.2.5
50+
3551
Features: better naming of routes without `operationId`
3652
![route naming](./assets/changelog_assets/1.2.5_route_naming.jpg)
3753
Changes: rename `@security true` -> `@secure`, `@duplicate true` -> `@duplicate`
38-
Fixes: Support generated swagger schemes from tsoa 3.x with complex types (Omit, Pick, etc)
54+
Fixes: Support generated swagger schemes from tsoa 3.x with complex types (Omit, Pick, etc)
55+
56+
# 1.2.4
3957

40-
# 1.2.4
4158
Features: add .d.ts file into npm package
4259
Changes: update help block in CLI
43-
Internal: add greenkeeper, update npm keywords
60+
Internal: add greenkeeper, update npm keywords
61+
62+
# 1.2.3
4463

45-
# 1.2.3
4664
Features: @summary, @description comments at each route
4765
Fixes: parsing schema without routes
4866
Changes: update documentation
49-
Internal: add anyOf, allOf test schemas, slack notifications in CI
67+
Internal: add anyOf, allOf test schemas, slack notifications in CI
68+
69+
# 1.2.2
70+
71+
Fixes: fix complex types (oneOf, anyOf), required fields of object type was not required
5072

51-
# 1.2.2
52-
Fixes: fix complex types (oneOf, anyOf), required fields of object type was not required
73+
# 1.2.0
5374

54-
# 1.2.0
5575
Changes: rename `ApiParams` to `RequestParams`, secure module always exist in generated API module, update documentation
5676
Fixes: Query params was all required, parse yaml files, typescript minor warnings (;)
57-
Internal: test schemas + manual testing, add travis CI/CD
77+
Internal: test schemas + manual testing, add travis CI/CD
78+
79+
# 1.1.0
80+
81+
Fixes: catching http errors with use API module
5882

59-
# 1.1.0
60-
Fixes: catching http errors with use API module
83+
# 1.0.9
6184

62-
# 1.0.9
6385
Features: add description to interfaces and their fields
64-
Changes: update documentation
86+
Changes: update documentation
6587

66-
# 1.0.8
67-
Changes: update documentation
88+
# 1.0.8
89+
90+
Changes: update documentation
91+
92+
# 1.0.7
6893

69-
# 1.0.7
70-
Changes: update documentation (+ add logo), add comment about author in generated module
94+
Changes: update documentation (+ add logo), add comment about author in generated module
95+
96+
# 1.0.6
7197

72-
# 1.0.6
7398
Fixes: route naming, http(s) requests for getting swagger schema, integer enums
74-
Changes: include only required files into npm pacakge
99+
Changes: include only required files into npm pacakge
75100

76-
# 1.0.5
77-
Changes: update documentation
101+
# 1.0.5
102+
103+
Changes: update documentation
104+
105+
# 1.0.4
78106

79-
# 1.0.4
80107
Changes: disable linters rules for generated API module
81-
Fixes: TS issues in template
108+
Fixes: TS issues in template
82109

83-
# 1.0.3
84-
Fixes: NodeJS main script cannot been called on Unix* machines
85-
Changes: add LICENSE, update README
110+
# 1.0.3
86111

87-
# 1.0.2
88-
Changes(Internal): change dependencies
112+
Fixes: NodeJS main script cannot been called on Unix\* machines
113+
Changes: add LICENSE, update README
114+
115+
# 1.0.2
116+
117+
Changes(Internal): change dependencies
118+
119+
# 1.0.1
89120

90-
# 1.0.1
91121
New features: query params, separating routes on submodules, common params in constructor, swagger v2 + yaml parsers
92122
Enhancements: better type extracting.
93123
Fixes: mustache escaping chars
94-
Changes: order of request params, emojis messages in console
124+
Changes: order of request params, emojis messages in console
125+
126+
# 1.0.0
95127

96-
# 1.0.0
97-
Initial project.
128+
Initial project.

_config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
theme: jekyll-theme-minimal
1+
theme: jekyll-theme-minimal

0 commit comments

Comments
 (0)