diff --git a/CHANGELOG.md b/CHANGELOG.md index 6a8f10e..988d53b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,146 +1,164 @@ # Change Log -## [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) +## [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:** + +- Update dependencies [\#83](https://github.com/inaka/cowboy_swagger/issues/83) +- This project should be moved to cowboy\_swagger [\#75](https://github.com/inaka/cowboy_swagger/issues/75) +- 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:** + +- \[\#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) +- Broken implementation of jsx [\#79](https://github.com/inaka/cowboy_swagger/issues/79) **Closed issues:** -- 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) +- 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:** -- 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)) +- \[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) +## [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) +- .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) +- 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)) +- \[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) +## [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)) +- 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) +- 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)) +- 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) +## [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) +- 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)) +- \[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) +## [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)) -- Update deps in rebar.config according to Makefile [\#45](https://github.com/inaka/cowboy-swagger/pull/45) ([define-null](https://github.com/define-null)) -- Hex Package [\#33](https://github.com/inaka/cowboy-swagger/pull/33) ([elbrujohalcon](https://github.com/elbrujohalcon)) +- \[\#quick\] upgrade hexer.mk [\#46](https://github.com/inaka/cowboy_swagger/pull/46) ([elbrujohalcon](https://github.com/elbrujohalcon)) +- Update deps in rebar.config according to Makefile [\#45](https://github.com/inaka/cowboy_swagger/pull/45) ([define-null](https://github.com/define-null)) +- 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) +## [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) +- 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) +## [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)) +- /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) +- 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) +- \[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) **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) +- 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)) +- \[\#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)) diff --git a/src/cowboy_swagger.app.src b/src/cowboy_swagger.app.src index 8d078ee..d5c3239 100644 --- a/src/cowboy_swagger.app.src +++ b/src/cowboy_swagger.app.src @@ -2,7 +2,7 @@ [ {description, "Swagger for Cowboy Erlang projects"}, - {vsn, "1.2.0"}, + {vsn, "1.2.1"}, {applications, [kernel, stdlib,