2020-12-28 18:35:48 +01:00
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog ](https://keepachangelog.com/en/1.0.0/ ),
and this project adheres to [Semantic Versioning ](https://semver.org/spec/v2.0.0.html ).
## [Unreleased]
2021-01-14 18:45:32 +01:00
### Added
- Support custom HTTP response headers
2021-01-18 00:05:30 +00:00
- New `endpoint` router extension with associated `Endpoint` trait ([!18])
2021-01-18 16:56:16 +00:00
- Support for custom endpoints using the `#[endpoint]` macro ([!19])
2021-02-03 22:58:08 +01:00
- Support for `anyhow::Error` (or any type implementing `Into<HandlerError>` ) in most responses
2021-02-25 00:37:55 +01:00
- `swagger_ui` method to the OpenAPI router to render the specification using Swagger UI
2021-01-14 18:45:32 +01:00
2021-01-01 16:44:55 +01:00
### Changed
- The cors handler can now copy headers from the request if desired
2021-01-14 18:45:32 +01:00
- All fields of `Response` are now private
2021-01-14 18:55:44 +01:00
- If not enabling the `openapi` feature, `without-openapi` has to be enabled
2021-01-18 00:05:30 +00:00
- The endpoint macro attributes (`read` , `create` , ...) no longer take the resource ident and reject all unknown attributes ([!18])
2021-02-27 15:40:34 +00:00
- The `ResourceResult` trait has been split into `IntoResponse` and `ResponseSchema`
2021-02-24 18:53:44 +00:00
- `HashMap` 's keys are included in the generated OpenAPI spec (they defaulted to `type: string` previously)
2021-01-18 00:05:30 +00:00
### Removed
- All pre-defined methods (`read` , `create` , ...) from our router extensions ([!18])
- All pre-defined method traits (`ResourceRead` , ...) ([!18])
2020-12-28 18:35:48 +01:00
## [0.1.1] - 2020-12-28
### Added
- Support for `&mut State` parameters in method handlers
- Support for `NonZeroU` types in the OpenAPI Specification
### Changed
- cookie auth does not require a middleware for parsing cookies anymore
- the derive macro produces no more private `mod` s which makes error message more readable
- documentation now makes use of the `[Type]` syntax introduced in Rust 1.48
## [0.1.0] - 2020-10-02
Previous changes are not tracked by this changelog file. Refer to the [releases ](https://gitlab.com/msrd0/gotham-restful/-/releases ) for the changelog.
2021-01-18 00:05:30 +00:00
[!18]: https://gitlab.com/msrd0/gotham-restful/-/merge_requests/18
2021-01-18 16:56:16 +00:00
[!19]: https://gitlab.com/msrd0/gotham-restful/-/merge_requests/19
