Blue Bird Versions Save

• Adds option to name test requests and show that request title in final documentation. (Thanks to @elvanja)

https://hex.pm/packages/blue_bird/0.4.2

• Enable local aglio
• Update dependencies

• add terms_of_service, contact and license fields
• add bird.gen.examples mix task for generating example tests with aglio (for development)
• take first steps to integrate swagger (nothing usable yet)
• render api group description

This release is a complete rewrite of the library.

Breaking Changes

• The parameter field of the api/3 macro now requires a keyword list as the third parameter.
• The group and resource fields of the api/3 macro have been removed.
• The group now depends on the controller.

Non-breaking changes

• No more subsections under groups. Only two levels of headers (group and action).

New features

• Added apigroup macro to define the group name and description per controller (the description isn't rendered yet).
• Added configuration option to ignore certain headers.
• Query parameters are now being collected from the requests and added to the documentation. Note that they will only be rendered by aglio if they are present in the api/3 definition.

Improvements

• better code quality
• better test coverage (from 41% to 94%)
• better documentation
• numerous fixes

• fix doc_path and ignore_headers config not working

• add status code to documented response

• handle deprecation warning from Exunit 1.5

• add pipeline configuration
• return conn from ConnLogger.save/1 to allow piping in tests

• group actions by resource to avoid aglio warnings