chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

client-api: Clarify that get_context always returns 'event' even if limit is zero

Browse Source
This commit is contained in:
Kévin Commaille 2022-12-14 12:59:45 +01:00 committed by Kévin Commaille
parent 675e6f43cd
commit 803fdc52f7
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
crates/ruma-client-api/src/context/get_context.rs
View File

@ -39,7 +39,10 @@ pub mod v3 {
#[ruma_api(path)] #[ruma_api(path)]
pub event_id: OwnedEventId, pub event_id: OwnedEventId,
/// The maximum number of events to return. /// The maximum number of context events to return.
///
/// This limit applies to the sum of the `events_before` and `events_after` arrays. The
/// requested event ID is always returned in `event` even if the limit is `0`.
/// ///
/// Defaults to 10. /// Defaults to 10.
#[ruma_api(query)] #[ruma_api(query)]