Skip to content

Releases: KittyHeaven/blue_bird

Introduce request title

30 Nov 10:32
Compare
Choose a tag to compare
  • 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

v0.4.1

04 Apr 00:38
a7c9e72
Compare
Choose a tag to compare
  • Enable local aglio
  • Update dependencies

v0.3.8

13 Sep 08:30
Compare
Choose a tag to compare
  • 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

v0.3.6

27 Jul 16:43
Compare
Choose a tag to compare
  • handle deprecation warning from Exunit 1.5

v0.3.4

27 Jul 16:45
Compare
Choose a tag to compare
  • add status code to documented response

v0.3.3

27 Jul 16:45
Compare
Choose a tag to compare
  • fix doc_path and ignore_headers config not working

v0.3.2

19 Jun 10:35
Compare
Choose a tag to compare
  • add pipeline configuration
  • return conn from ConnLogger.save/1 to allow piping in tests

v0.3.1

14 Jun 11:48
Compare
Choose a tag to compare
  • group actions by resource to avoid aglio warnings

v0.3.0

27 Jul 16:48
Compare
Choose a tag to compare

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