forked from KittyHeaven/blue_bird
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CHANGELOG
101 lines (64 loc) · 2.48 KB
/
CHANGELOG
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# Changelog BlueBird
## v0.3.8
- 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.7
- fix FunctionClauseError in Formatter
## v0.3.6
- handle deprecation warning from Exunit 1.5
## v0.3.5
- add `trim_path` option to trim path prefixes
- allow to set ignore header options for request and response headers separately
- don't add empty headers to the documentation
## v0.3.4
- add status code to documented response
## v0.3.3
- fix `doc_path` and `ignore_headers` config not working
## v0.3.2
- add pipeline configuration
- return `conn` from `ConnLogger.save/1` to allow piping in tests
## v0.3.1
- group actions by resource to avoid aglio warnings
## v0.3.0
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
## v0.2.0
- Add warning as option
- Add resource as option
- Implement generic function to extract api options
- Improve function naming
- Fix indent of body area
- Remove "json" from request header
- Cleanup and small improvements
## v0.1.4
- Fix wrong pattern match
## v0.1.3
- Fix aglio rendering errors [!6](https://github.com/rhazdon/blue_bird/issues/6)
- Group requests by group and ressource [!6](https://github.com/rhazdon/blue_bird/issues/6)
- Sort requests by response status code (optimize docs rendering)
## v0.1.2
- Don't render body part in api.apib if body is empty
- Use `conn.body_params` instead of `conn.params` to fetch the body parameters [!5](https://github.com/rhazdon/blue_bird/issues/5)
- Improve testing framework