You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: changelog.md
+60-59Lines changed: 60 additions & 59 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
19
19
20
20
### Fixed
21
21
22
-
* Fix `box.json` version of `swagger-sdk`
22
+
- Fix `box.json` version of `swagger-sdk`
23
23
24
24
## [3.0.0] - 2024-05-30
25
25
@@ -43,156 +43,157 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
43
43
44
44
### Added
45
45
46
-
* Added the ability to excludes routes by prefix
46
+
- Added the ability to excludes routes by prefix
47
47
48
48
## [2.5.1] => 2021-MAY-12
49
49
50
50
### Fixed
51
51
52
-
* Regression on `@tags` being json syntax
52
+
- Regression on `@tags` being json syntax
53
53
54
54
## [2.5.0] => 2021-MAY-10
55
55
56
56
### Added
57
57
58
-
* Added the ability to add `@tags` to annotations so they can show up on the operations metadata as array of `tags`
58
+
- Added the ability to add `@tags` to annotations so they can show up on the operations metadata as array of `tags`
59
59
60
60
## [2.4.0] => 2021-MAY-04
61
61
62
62
### Removed
63
63
64
-
* Removed `externalDocs` from the `info` struct as it is not supported on the OpenApi Spec v3.
64
+
- Removed `externalDocs` from the `info` struct as it is not supported on the OpenApi Spec v3.
65
65
66
66
### Changed
67
67
68
-
*`operationID` renamed to `x-coldbox-operation` since they are ColdBox centric. It was also causing issues using `operationID` as it needed to be unique across the entire swagger document.
68
+
-`operationID` renamed to `x-coldbox-operation` since they are ColdBox centric. It was also causing issues using `operationID` as it needed to be unique across the entire swagger document.
69
69
70
70
## [2.3.0] => 2020-SEP-08
71
71
72
72
### Added
73
73
74
-
* Add CORS support for cbswagger endpoint #25
74
+
- Add CORS support for cbswagger endpoint #25
75
75
76
76
## [2.2.1] => 2020-MAY-12
77
77
78
78
### Fixed
79
79
80
-
* On lucee the `displayName` defaults to `Component`, skipping this default to select the correct `operationId` for the resource
81
-
* The `moduleName` hint for the `appendFunctionInfo` was mispelled
80
+
- On lucee the `displayName` defaults to `Component`, skipping this default to select the correct `operationId` for the resource
81
+
- The `moduleName` hint for the `appendFunctionInfo` was mispelled
82
82
83
83
## [2.2.0] => 2020-MAY-12
84
84
85
85
### Added
86
86
87
-
* When defining external files in annotations, you can now prefix them with `~` and this will expand to the module setting of `samplesPath`. This way you can write your annotations in a more cleaner manner.
88
-
* Auto-publishing of changelog's to github
89
-
* New changelog looks according to keepachangelog.com
87
+
- When defining external files in annotations, you can now prefix them with `~` and this will expand to the module setting of `samplesPath`. This way you can write your annotations in a more cleaner manner.
88
+
- Auto-publishing of changelog's to github
89
+
- New changelog looks according to keepachangelog.com
90
90
91
91
## [2.1.1] => 2020-MAY-06
92
92
93
-
* Updates to support ColdBox 6
93
+
- Updates to support ColdBox 6
94
94
95
95
## [2.1.0] => 2020-APR-16
96
96
97
97
### Features
98
98
99
-
* Allow `@security` annotation to override the security mechanisms defined in config. The value can be a JSON array of security directives, a file pointer, or for convenience the name of a security schema. See readme for examples.
100
-
* Support for discovering responses and examples by conventions in the `resources/apidocs` folder convention. See readme for examples.
101
-
* Ability to exclude routes from the generated spec via the `excludeRoutes` configuration key.
99
+
- Allow `@security` annotation to override the security mechanisms defined in config. The value can be a JSON array of security directives, a file pointer, or for convenience the name of a security schema. See readme for examples.
100
+
- Support for discovering responses and examples by conventions in the `resources/apidocs` folder convention. See readme for examples.
101
+
- Ability to exclude routes from the generated spec via the `excludeRoutes` configuration key.
102
102
103
103
### Improvements
104
104
105
-
* Add default `samplesPath` config item to `resources/apidocs` in the ModuleConfig
106
-
* Add convention samples parsing and refactor segment parsing to separate methods
105
+
- Add default `samplesPath` config item to `resources/apidocs` in the ModuleConfig
106
+
- Add convention samples parsing and refactor segment parsing to separate methods
107
107
108
108
### Bugs
109
109
110
-
* Fixes for new router syntax not parsing actions correctly or not taking into account actions attached to verbs
110
+
- Fixes for new router syntax not parsing actions correctly or not taking into account actions attached to verbs
111
111
112
112
## [2.0.0] => 2019-SEP-02
113
113
114
-
*`feature`: Upgraded to swagger-sdk 2.0.0 to support OpenAPI 3.0.x. A great guide on migrating is here: <https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/>
114
+
-`feature`: Upgraded to swagger-sdk 2.0.0 to support OpenAPI 3.0.x. A great guide on migrating is here: <https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/>
115
115
116
-
* Migrated `cbswagger` settings to the `moduleSettings` struct instead of top-level in the `config/ColdBox.cfc`. Make sure you move your settings.
117
116
118
-
*`feature` : You can now pass a `format`to the `/cbswagger` endpoint to either get the OpenAPI doc as `json` or `yml`. Eg: `/cbswagger?format=yml`
117
+
- Migrated `cbSwagger` settings to the `moduleSettings` struct instead of top-level in the `config/ColdBox.cfc`. Make sure you move your settings.
119
118
120
-
*`feature` : You have two distinct routes for the json and yml formats: `/cbswagger/json`and `/cbswagger/yml`
119
+
-`feature` : You can now pass a `format` to the `/cbSwagger` endpoint to either get the OpenAPI doc as `json`or `yml`. Eg: `/cbswagger?format=yml`
121
120
122
-
* You can choose your default output format via the module settings: `defaultFormat` setting. Valid options are `json` and `yml`
121
+
-`feature` : You have two distinct routes for the json and yml formats: `/cbSwagger/json` and `/cbSwagger/yml`
123
122
124
-
*`features` : Support for ColdBox 5 event routing and response routing.
123
+
- You can choose your default output format via the module settings: `defaultFormat` setting. Valid options are `json` and `yml`
125
124
126
-
*`improvement` : You can now tag your handlers with a `displayName` that will be used for operation ID building
125
+
-`features` : Support for ColdBox 5 event routing and response routing.
127
126
128
-
*`improvement` : Improved the way operation Ids are reported so they can be unique when reusing handler actions.
127
+
-`improvement` : You can now tag your handlers with a `displayName` that will be used for operation ID building
0 commit comments