api: Update changelog

This commit is contained in:
Jonas Platte 2021-04-17 19:14:43 +02:00
parent 976b1b8090
commit 309ba18b82
No known key found for this signature in database
GPG Key ID: CC154DE0E30B7C67

View File

@ -6,9 +6,9 @@ Breaking changes:
`request` and `response`. `request` and `response`.
* The `EndpointError` trait now requires `std::error::Error`. This allows integrating * The `EndpointError` trait now requires `std::error::Error`. This allows integrating
`EndpointError`s in the common rust error ecosystem like `thiserror` and `anyhow`. `EndpointError`s in the common rust error ecosystem like `thiserror` and `anyhow`.
* The `Endpoint` trait has been replaced by two new traits that each capture a subset of its * The `Endpoint` trait has been replaced by four of new traits that each capture a subset of its
previous functionality: `OutgoingRequest` for sending requests and receiving responses and previous functionality: `OutgoingRequest`, `OutgoingResponse`, `IncomingRequest`,
`IncomingRequest` for receiving requests and sending responses. `IncomingResponse`. See the API documentation for more details.
* Endpoint authentication is now more granularly defined by an enum `AuthScheme` * Endpoint authentication is now more granularly defined by an enum `AuthScheme`
instead of a boolean. The `ruma_api!` macro has been updated to require instead of a boolean. The `ruma_api!` macro has been updated to require
`authentication` instead of `requires_authentication`. `authentication` instead of `requires_authentication`.