Current section

Files

Jump to
cowboy_swagger CHANGELOG.md
Raw

CHANGELOG.md

# Changelog
## [2.4.0](https://github.com/inaka/cowboy_swagger/tree/2.4.0) (2021-09-03)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/2.3.0...2.4.0)
**Closed issues:**
- New swagger UI version [\#136](https://github.com/inaka/cowboy_swagger/issues/136)
**Merged pull requests:**
- Swagger UI [\#139](https://github.com/inaka/cowboy_swagger/pull/139) ([DDDHuang](https://github.com/DDDHuang))
## [2.3.0](https://github.com/inaka/cowboy_swagger/tree/2.3.0) (2021-07-28)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/2.2.2...2.3.0)
**Closed issues:**
- Open API servers field & swagger basePath filed [\#134](https://github.com/inaka/cowboy_swagger/issues/134)
**Merged pull requests:**
- Allow for analysis under rebar3\_hank [\#137](https://github.com/inaka/cowboy_swagger/pull/137) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
- basePath & servers support; support more schema type [\#135](https://github.com/inaka/cowboy_swagger/pull/135) ([DDDHuang](https://github.com/DDDHuang))
## [2.2.2](https://github.com/inaka/cowboy_swagger/tree/2.2.2) (2021-07-01)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/2.2.1...2.2.2)
**Closed issues:**
- GlobalSpec not work [\#132](https://github.com/inaka/cowboy_swagger/issues/132)
- cowboy and ranch version not compatible ? [\#130](https://github.com/inaka/cowboy_swagger/issues/130)
**Merged pull requests:**
- fix: swagger & openapi root field [\#133](https://github.com/inaka/cowboy_swagger/pull/133) ([DDDHuang](https://github.com/DDDHuang))
- Update example app's rebar.lock [\#131](https://github.com/inaka/cowboy_swagger/pull/131) ([zmstone](https://github.com/zmstone))
- Increase consumer confidence [\#129](https://github.com/inaka/cowboy_swagger/pull/129) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
- Move to a GitHub action \(instead of container-based\) CI approach [\#128](https://github.com/inaka/cowboy_swagger/pull/128) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
## [2.2.1](https://github.com/inaka/cowboy_swagger/tree/2.2.1) (2021-02-08)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/2.2.0...2.2.1)
**Implemented enhancements:**
- Add support to others json libraries [\#52](https://github.com/inaka/cowboy_swagger/issues/52)
- The `cowboy\_swagger\_handler` should return also `swagger.yaml`. [\#20](https://github.com/inaka/cowboy_swagger/issues/20)
**Fixed bugs:**
- Actually run on different Erlang versions [\#125](https://github.com/inaka/cowboy_swagger/pull/125) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
**Closed issues:**
- Move from Travis CI to GitHub Actions? [\#122](https://github.com/inaka/cowboy_swagger/issues/122)
- Fix current resource path `/api-docs` according with Swagger 2.0 conventions \(`/swagger.json`\) [\#19](https://github.com/inaka/cowboy_swagger/issues/19)
**Merged pull requests:**
- Update dep.s to adapt to OTP 24 [\#127](https://github.com/inaka/cowboy_swagger/pull/127) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
- Bump OTP-24 -ready dep.s \(at least at the compilation level\) [\#126](https://github.com/inaka/cowboy_swagger/pull/126) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
- README.md: show `build` instead of `CI for cowboy\_swagger` [\#124](https://github.com/inaka/cowboy_swagger/pull/124) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
- Replace Travis CI with GitHub Actions [\#123](https://github.com/inaka/cowboy_swagger/pull/123) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
- Modernize CI [\#121](https://github.com/inaka/cowboy_swagger/pull/121) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
## [2.2.0](https://github.com/inaka/cowboy_swagger/tree/2.2.0) (2020-05-26)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/1.2.4...2.2.0)
**Closed issues:**
- Unknown type cowboy\_router:route\_match [\#115](https://github.com/inaka/cowboy_swagger/issues/115)
**Merged pull requests:**
- Release request [\#120](https://github.com/inaka/cowboy_swagger/pull/120) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
- Support 'components' section in openapi 3.0.0 [\#119](https://github.com/inaka/cowboy_swagger/pull/119) ([brucify](https://github.com/brucify))
- New function add\_definition\_array/2 in cowboy\_swagger [\#118](https://github.com/inaka/cowboy_swagger/pull/118) ([brucify](https://github.com/brucify))
- Fix/for xref and dialyzer [\#117](https://github.com/inaka/cowboy_swagger/pull/117) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
- handle openapi 3.0 format, use new swagger-ui [\#114](https://github.com/inaka/cowboy_swagger/pull/114) ([szlartibartfaszt79](https://github.com/szlartibartfaszt79))
## [1.2.4](https://github.com/inaka/cowboy_swagger/tree/1.2.4) (2019-02-27)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/2.1.0...1.2.4)
**Merged pull requests:**
- Fix a few static analysis warnings [\#116](https://github.com/inaka/cowboy_swagger/pull/116) ([paulo-ferraz-oliveira](https://github.com/paulo-ferraz-oliveira))
## [2.1.0](https://github.com/inaka/cowboy_swagger/tree/2.1.0) (2018-05-04)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/2.0.0...2.1.0)
**Closed issues:**
- Update sync by rebar3\_auto [\#95](https://github.com/inaka/cowboy_swagger/issues/95)
**Merged pull requests:**
- Update from @freke [\#113](https://github.com/inaka/cowboy_swagger/pull/113) ([elbrujohalcon](https://github.com/elbrujohalcon))
- Bump Version to 2.1.0 [\#112](https://github.com/inaka/cowboy_swagger/pull/112) ([elbrujohalcon](https://github.com/elbrujohalcon))
- Update Dependencies [\#111](https://github.com/inaka/cowboy_swagger/pull/111) ([elbrujohalcon](https://github.com/elbrujohalcon))
- Add rebar3 to root path to fix travis builds [\#110](https://github.com/inaka/cowboy_swagger/pull/110) ([elbrujohalcon](https://github.com/elbrujohalcon))
## [2.0.0](https://github.com/inaka/cowboy_swagger/tree/2.0.0) (2017-11-30)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/1.2.3...2.0.0)
**Closed issues:**
- Public hipchat room [\#105](https://github.com/inaka/cowboy_swagger/issues/105)
- Consider upgrading to cowboy 2 API [\#49](https://github.com/inaka/cowboy_swagger/issues/49)
**Merged pull requests:**
- Bump version to 2.0.0 [\#108](https://github.com/inaka/cowboy_swagger/pull/108) ([jfacorro](https://github.com/jfacorro))
- \[Closes \#49\] Update to Cowboy 2 [\#107](https://github.com/inaka/cowboy_swagger/pull/107) ([jfacorro](https://github.com/jfacorro))
- Update README.md [\#106](https://github.com/inaka/cowboy_swagger/pull/106) ([igaray](https://github.com/igaray))
## [1.2.3](https://github.com/inaka/cowboy_swagger/tree/1.2.3) (2017-06-13)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/1.2.2...1.2.3)
**Closed issues:**
- Bump Version to 1.2.3 [\#103](https://github.com/inaka/cowboy_swagger/issues/103)
- Version Bump to 1.2.2 [\#92](https://github.com/inaka/cowboy_swagger/issues/92)
**Merged pull requests:**
- \[Close \#103\] Version Bump to 1.2.3 [\#104](https://github.com/inaka/cowboy_swagger/pull/104) ([Euen](https://github.com/Euen))
- Use minified version of swagger-ui.js [\#102](https://github.com/inaka/cowboy_swagger/pull/102) ([egobrain](https://github.com/egobrain))
- Maintain original order in lists [\#101](https://github.com/inaka/cowboy_swagger/pull/101) ([jfacorro](https://github.com/jfacorro))
- Revert to local schema as default [\#100](https://github.com/inaka/cowboy_swagger/pull/100) ([lucafavatella](https://github.com/lucafavatella))
- Clean leftovers from jiffy -\> jsx transition [\#99](https://github.com/inaka/cowboy_swagger/pull/99) ([lucafavatella](https://github.com/lucafavatella))
- Plant CI [\#97](https://github.com/inaka/cowboy_swagger/pull/97) ([lucafavatella](https://github.com/lucafavatella))
- \[\#95\] update sync by rebar3\_auto [\#96](https://github.com/inaka/cowboy_swagger/pull/96) ([Euen](https://github.com/Euen))
## [1.2.2](https://github.com/inaka/cowboy_swagger/tree/1.2.2) (2017-01-27)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/1.2.1...1.2.2)
**Closed issues:**
- Update to the latest Swagger-UI assets [\#89](https://github.com/inaka/cowboy_swagger/issues/89)
- remove Makefile from the example [\#86](https://github.com/inaka/cowboy_swagger/issues/86)
**Merged pull requests:**
- \[\#92\] Version Bump to 1.2.2 [\#94](https://github.com/inaka/cowboy_swagger/pull/94) ([ferigis](https://github.com/ferigis))
- \[\#89\] upgrade Swagger-UI to 2.2.8 [\#91](https://github.com/inaka/cowboy_swagger/pull/91) ([ferigis](https://github.com/ferigis))
- \[\#86\] Fixing Example [\#90](https://github.com/inaka/cowboy_swagger/pull/90) ([ferigis](https://github.com/ferigis))
## [1.2.1](https://github.com/inaka/cowboy_swagger/tree/1.2.1) (2017-01-17)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/1.2.0...1.2.1)
**Closed issues:**
- This project should be moved to cowboy\_swagger [\#75](https://github.com/inaka/cowboy_swagger/issues/75)
- Version Bump to 1.2.1 [\#84](https://github.com/inaka/cowboy_swagger/issues/84)
- Update dependencies [\#83](https://github.com/inaka/cowboy_swagger/issues/83)
- hex.pm package is broken [\#82](https://github.com/inaka/cowboy_swagger/issues/82)
- CowboySwagger should support either binaries or io\_lists for descriptions [\#67](https://github.com/inaka/cowboy_swagger/issues/67)
- Update cowboy-swager dependency version in the example [\#50](https://github.com/inaka/cowboy_swagger/issues/50)
- Update documentation [\#44](https://github.com/inaka/cowboy_swagger/issues/44)
**Merged pull requests:**
- \[\#84\] Version Bump to 1.2.1 [\#88](https://github.com/inaka/cowboy_swagger/pull/88) ([ferigis](https://github.com/ferigis))
- \[\#44\] Adding 'Requirements' to README [\#87](https://github.com/inaka/cowboy_swagger/pull/87) ([ferigis](https://github.com/ferigis))
- \[\#83\] updating dependencies on rebar3 config file [\#85](https://github.com/inaka/cowboy_swagger/pull/85) ([ferigis](https://github.com/ferigis))
## [1.2.0](https://github.com/inaka/cowboy_swagger/tree/1.2.0) (2016-11-16)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/1.1.0...1.2.0)
**Fixed bugs:**
- Broken implementation of jsx [\#79](https://github.com/inaka/cowboy_swagger/issues/79)
**Closed issues:**
- Bump version to 1.2.0 [\#78](https://github.com/inaka/cowboy_swagger/issues/78)
- Definitions description in README [\#73](https://github.com/inaka/cowboy_swagger/issues/73)
- Update example to rebar3 [\#72](https://github.com/inaka/cowboy_swagger/issues/72)
**Merged pull requests:**
- \[Fix \#78\] Bump version to 1.2.0 [\#81](https://github.com/inaka/cowboy_swagger/pull/81) ([harenson](https://github.com/harenson))
- fixed dialyser error 'no local return' then definition includes an array [\#80](https://github.com/inaka/cowboy_swagger/pull/80) ([freke](https://github.com/freke))
- \[Close \#72\] update example build tool to rebar3 [\#77](https://github.com/inaka/cowboy_swagger/pull/77) ([Euen](https://github.com/Euen))
- Replace jiffy by jsx [\#76](https://github.com/inaka/cowboy_swagger/pull/76) ([BernardNotarianni](https://github.com/BernardNotarianni))
## [1.1.0](https://github.com/inaka/cowboy_swagger/tree/1.1.0) (2016-08-11)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/1.0.3...1.1.0)
**Fixed bugs:**
- .app missing jiffy in applications section [\#64](https://github.com/inaka/cowboy_swagger/issues/64)
**Closed issues:**
- Version Bump to 1.1.0 [\#70](https://github.com/inaka/cowboy_swagger/issues/70)
- Move from erlang.mk to rebar3 [\#68](https://github.com/inaka/cowboy_swagger/issues/68)
- Support for definitions and schemas [\#63](https://github.com/inaka/cowboy_swagger/issues/63)
- Hello can this project support the cowboy REST part? [\#61](https://github.com/inaka/cowboy_swagger/issues/61)
- Do whatever it takes to appears cowboy-swagger on "http://swagger.io/open-source-integrations/" [\#16](https://github.com/inaka/cowboy_swagger/issues/16)
**Merged pull requests:**
- \[Close \#70\] version bump 1.1.0 [\#71](https://github.com/inaka/cowboy_swagger/pull/71) ([Euen](https://github.com/Euen))
- \[Close \#68\] replace erlang.mk by rebar3 [\#69](https://github.com/inaka/cowboy_swagger/pull/69) ([Euen](https://github.com/Euen))
- \[Fix \#63\] Add support for definitions and schemas [\#66](https://github.com/inaka/cowboy_swagger/pull/66) ([harenson](https://github.com/harenson))
- Add missing jiffy app in .app.src [\#65](https://github.com/inaka/cowboy_swagger/pull/65) ([jeanparpaillon](https://github.com/jeanparpaillon))
## [1.0.3](https://github.com/inaka/cowboy_swagger/tree/1.0.3) (2016-04-14)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/1.0.2...1.0.3)
**Fixed bugs:**
- Use cp instead of symlink for example deps [\#59](https://github.com/inaka/cowboy_swagger/pull/59) ([elbrujohalcon](https://github.com/elbrujohalcon))
**Closed issues:**
- Switch build tools to erlang.mk and republish to hex.pm [\#47](https://github.com/inaka/cowboy_swagger/issues/47)
**Merged pull requests:**
- Version Bump to 1.0.3 [\#60](https://github.com/inaka/cowboy_swagger/pull/60) ([elbrujohalcon](https://github.com/elbrujohalcon))
- Handles the property parameter as json list when it's empty [\#57](https://github.com/inaka/cowboy_swagger/pull/57) ([joaohf](https://github.com/joaohf))
## [1.0.2](https://github.com/inaka/cowboy_swagger/tree/1.0.2) (2016-03-15)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/1.0.1...1.0.2)
**Closed issues:**
- Bump version to 1.0.2 [\#55](https://github.com/inaka/cowboy_swagger/issues/55)
- Update repo and make it ready for hex.pm [\#53](https://github.com/inaka/cowboy_swagger/issues/53)
- Wrong inaka\_mixer dependency [\#51](https://github.com/inaka/cowboy_swagger/issues/51)
**Merged pull requests:**
- \[Fix \#55\] Bump version to 1.0.2 [\#56](https://github.com/inaka/cowboy_swagger/pull/56) ([harenson](https://github.com/harenson))
- \[Fix \#53\] Update dependencies; Update erlang.mk; Add ruleset to elvis config [\#54](https://github.com/inaka/cowboy_swagger/pull/54) ([harenson](https://github.com/harenson))
- Example application uses local soruces [\#48](https://github.com/inaka/cowboy_swagger/pull/48) ([jeanparpaillon](https://github.com/jeanparpaillon))
## [1.0.1](https://github.com/inaka/cowboy_swagger/tree/1.0.1) (2016-01-08)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/0.1.0-otp17...1.0.1)
**Merged pull requests:**
- \[\#quick\] upgrade hexer.mk [\#46](https://github.com/inaka/cowboy_swagger/pull/46) ([elbrujohalcon](https://github.com/elbrujohalcon))
- Hex Package [\#33](https://github.com/inaka/cowboy_swagger/pull/33) ([elbrujohalcon](https://github.com/elbrujohalcon))
## [0.1.0-otp17](https://github.com/inaka/cowboy_swagger/tree/0.1.0-otp17) (2015-12-15)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/0.1.0...0.1.0-otp17)
**Closed issues:**
- Location in response headers is not reading path values [\#43](https://github.com/inaka/cowboy_swagger/issues/43)
## [0.1.0](https://github.com/inaka/cowboy_swagger/tree/0.1.0) (2015-12-03)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/0.0.1...0.1.0)
**Fixed bugs:**
- /api-docs not working as expected [\#38](https://github.com/inaka/cowboy_swagger/issues/38)
- The catch all path '...' added by cowboy-swagger introduces some confusion when expecting 404 [\#28](https://github.com/inaka/cowboy_swagger/issues/28)
- Fix validate\_metadata spec [\#27](https://github.com/inaka/cowboy_swagger/issues/27)
- static\_files as an env variable is not good for releases [\#26](https://github.com/inaka/cowboy_swagger/issues/26)
- swagger UI always sends JSON [\#24](https://github.com/inaka/cowboy_swagger/issues/24)
- Trails added by swagger itself should be ignored in swagger.json [\#23](https://github.com/inaka/cowboy_swagger/issues/23)
- basePath is misinterpreted [\#22](https://github.com/inaka/cowboy_swagger/pull/22) ([elbrujohalcon](https://github.com/elbrujohalcon))
**Closed issues:**
- Version Bump to 0.1.0 [\#37](https://github.com/inaka/cowboy_swagger/issues/37)
- Allow more than one server running on the same node [\#34](https://github.com/inaka/cowboy_swagger/issues/34)
- Add Meta Testing [\#30](https://github.com/inaka/cowboy_swagger/issues/30)
- basePath should be considered part of the trails path [\#25](https://github.com/inaka/cowboy_swagger/issues/25)
**Merged pull requests:**
- \[Fix \#37\] Bump version to 0.1.0 [\#42](https://github.com/inaka/cowboy_swagger/pull/42) ([harenson](https://github.com/harenson))
- \[Fix \#38\] Add redirect for /api-docs ... [\#41](https://github.com/inaka/cowboy_swagger/pull/41) ([harenson](https://github.com/harenson))
- \[\#25\] Add basePath to swaggerSpec [\#40](https://github.com/inaka/cowboy_swagger/pull/40) ([harenson](https://github.com/harenson))
- \[Fix \#34\] Allow more than one server running on the same node [\#39](https://github.com/inaka/cowboy_swagger/pull/39) ([harenson](https://github.com/harenson))
- \[Fix \#28\] Change catch-all path [\#36](https://github.com/inaka/cowboy_swagger/pull/36) ([harenson](https://github.com/harenson))
- \[Fix \#26\] Fix static\_files trail [\#35](https://github.com/inaka/cowboy_swagger/pull/35) ([harenson](https://github.com/harenson))
- Add meta testing [\#32](https://github.com/inaka/cowboy_swagger/pull/32) ([harenson](https://github.com/harenson))
- \[fix \#27\] Fix metadata spec [\#31](https://github.com/inaka/cowboy_swagger/pull/31) ([harenson](https://github.com/harenson))
- Ferigis.23.ignore swagger trails [\#29](https://github.com/inaka/cowboy_swagger/pull/29) ([ferigis](https://github.com/ferigis))
## [0.0.1](https://github.com/inaka/cowboy_swagger/tree/0.0.1) (2015-09-14)
[Full Changelog](https://github.com/inaka/cowboy_swagger/compare/8ea2dca534154b7453789eb6ed10cd6074385405...0.0.1)
**Closed issues:**
- Validate and/or set default values of `cowboy\_swagger:metadata\(\)`, according with swagger schema. [\#9](https://github.com/inaka/cowboy_swagger/issues/9)
- Implement static handler to serve the .html contained in `priv/swagger` folder [\#6](https://github.com/inaka/cowboy_swagger/issues/6)
- Implement `trails\_handler:trails/0` callback in Cowboy swagger handler module \(swagger\_handler\). [\#5](https://github.com/inaka/cowboy_swagger/issues/5)
- Implement `cowboy\_swagger:to\_json/1` function [\#4](https://github.com/inaka/cowboy_swagger/issues/4)
- Implement GET method in 'swagger\_handler' in order to retrieve the JSON specification \(swagger.json\) [\#3](https://github.com/inaka/cowboy_swagger/issues/3)
- Setup Swagger-UI into the project. [\#2](https://github.com/inaka/cowboy_swagger/issues/2)
- Fulfil the open-source check-list [\#1](https://github.com/inaka/cowboy_swagger/issues/1)
**Merged pull requests:**
- \[\#1\] Fixed documentation in modules. Fixed README. [\#21](https://github.com/inaka/cowboy_swagger/pull/21) ([cabol](https://github.com/cabol))
- Make link text and href point at the same URL [\#18](https://github.com/inaka/cowboy_swagger/pull/18) ([erszcz](https://github.com/erszcz))
- \[\#1\] fulfil open source list: README. [\#17](https://github.com/inaka/cowboy_swagger/pull/17) ([cabol](https://github.com/cabol))
- \[\#1\] Fulfil the open-source check-list: implemented example. [\#15](https://github.com/inaka/cowboy_swagger/pull/15) ([cabol](https://github.com/cabol))
- \[\#9\] Validate mandatory fields in the metadata. [\#14](https://github.com/inaka/cowboy_swagger/pull/14) ([cabol](https://github.com/cabol))
- Fixed cowboy-swagger to be a lib \(removed app and sup modules\). Added… [\#12](https://github.com/inaka/cowboy_swagger/pull/12) ([cabol](https://github.com/cabol))
- Cabol.3.cowboy swagger handler [\#10](https://github.com/inaka/cowboy_swagger/pull/10) ([cabol](https://github.com/cabol))
- Implemented cowboy\_swagger:to\_json/1 function. [\#8](https://github.com/inaka/cowboy_swagger/pull/8) ([cabol](https://github.com/cabol))
- Project and Swagger-UI setup. [\#7](https://github.com/inaka/cowboy_swagger/pull/7) ([cabol](https://github.com/cabol))
\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*