Skip to content

Commit bec68a3

Browse files
committed
bump: up version to 1.4.1; docs: update CHANGELOG;
1 parent 3cbbeb2 commit bec68a3

File tree

3 files changed

+99
-71
lines changed

3 files changed

+99
-71
lines changed

CHANGELOG.md

Lines changed: 97 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,128 @@
1-
# next release
2-
3-
4-
# 1.4.0
5-
Breaking Changes:
6-
- Rename default typescript output api file name (prev `api.ts`, now `Api.ts`)
7-
Features:
8-
- `-d, --default-as-success` option. Allows to use "default" status codes as success response type
9-
- `-r, --responses` option. Response declarations in request rescription
10-
This option adds comments of the possible responses from request
11-
![responses comments](./assets/changelog_assets/responses-comments.jpg)
12-
Also typings for `.catch()` callback
13-
![responses catch types](./assets/changelog_assets/responses-catch-types.jpg)
14-
- Improve response body type definitions
15-
- Types for bad responses
16-
Changes:
17-
- \[minor\] fix jsdoc comments space
18-
![right comments space](./assets/changelog_assets/right-comments-space.jpg)
19-
20-
# 1.3.0
21-
Features:
22-
- Api module description from schema info
23-
![api description](./assets/changelog_assets/api-module-description.jpg)
24-
- Generate API type declarations (CLI flag `--route-types`)
25-
![route types](./assets/changelog_assets/route-types.jpg)
26-
- Ability to not generate clint API class (CLI flag `--no-client`)
27-
28-
Fixes:
29-
- Improve response body type definition
30-
31-
Internal:
32-
- refactored `generate` and `validate` test scripts
33-
34-
# 1.2.6
35-
Fixes: create api without `-o` option (use default `./` output)
36-
37-
# 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+
3851
Features: better naming of routes without `operationId`
3952
![route naming](./assets/changelog_assets/1.2.5_route_naming.jpg)
4053
Changes: rename `@security true` -> `@secure`, `@duplicate true` -> `@duplicate`
41-
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
4257

43-
# 1.2.4
4458
Features: add .d.ts file into npm package
4559
Changes: update help block in CLI
46-
Internal: add greenkeeper, update npm keywords
60+
Internal: add greenkeeper, update npm keywords
61+
62+
# 1.2.3
4763

48-
# 1.2.3
4964
Features: @summary, @description comments at each route
5065
Fixes: parsing schema without routes
5166
Changes: update documentation
52-
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
5372

54-
# 1.2.2
55-
Fixes: fix complex types (oneOf, anyOf), required fields of object type was not required
73+
# 1.2.0
5674

57-
# 1.2.0
5875
Changes: rename `ApiParams` to `RequestParams`, secure module always exist in generated API module, update documentation
5976
Fixes: Query params was all required, parse yaml files, typescript minor warnings (;)
60-
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
6182

62-
# 1.1.0
63-
Fixes: catching http errors with use API module
83+
# 1.0.9
6484

65-
# 1.0.9
6685
Features: add description to interfaces and their fields
67-
Changes: update documentation
86+
Changes: update documentation
6887

69-
# 1.0.8
70-
Changes: update documentation
88+
# 1.0.8
89+
90+
Changes: update documentation
91+
92+
# 1.0.7
7193

72-
# 1.0.7
73-
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
7497

75-
# 1.0.6
7698
Fixes: route naming, http(s) requests for getting swagger schema, integer enums
77-
Changes: include only required files into npm pacakge
99+
Changes: include only required files into npm pacakge
78100

79-
# 1.0.5
80-
Changes: update documentation
101+
# 1.0.5
102+
103+
Changes: update documentation
104+
105+
# 1.0.4
81106

82-
# 1.0.4
83107
Changes: disable linters rules for generated API module
84-
Fixes: TS issues in template
108+
Fixes: TS issues in template
85109

86-
# 1.0.3
87-
Fixes: NodeJS main script cannot been called on Unix* machines
88-
Changes: add LICENSE, update README
110+
# 1.0.3
89111

90-
# 1.0.2
91-
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
92120

93-
# 1.0.1
94121
New features: query params, separating routes on submodules, common params in constructor, swagger v2 + yaml parsers
95122
Enhancements: better type extracting.
96123
Fixes: mustache escaping chars
97-
Changes: order of request params, emojis messages in console
124+
Changes: order of request params, emojis messages in console
125+
126+
# 1.0.0
98127

99-
# 1.0.0
100-
Initial project.
128+
Initial project.

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "swagger-typescript-api",
3-
"version": "1.4.0",
3+
"version": "1.4.1",
44
"description": "Create typescript api module from swagger schema",
55
"scripts": {
66
"cli": "node index.js -d -p ./swagger-test-cli.json -n swagger-test-cli.ts",

0 commit comments

Comments
 (0)