Skip to content

Commit 26dfa3d

Browse files
committed
Adding better documentation for GetPosts limit parameter
1 parent e52beda commit 26dfa3d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Sources/Lemmy-Swift-Client/Lemmy API/Requests/GetPosts.swift

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ public struct GetPostsRequest: APIRequest {
1717
public let community_id: Int?
1818
/// To get posts for a federated community by name, use `name@instance.tld`.
1919
public let community_name: String?
20+
/// The maximum number of posts to retrieve.
21+
///
22+
/// It is possible that less posts will be returned if the maximum is greater than the number of posts available.
23+
///
24+
/// The server will throw a `couldnt_get_posts` error if you pass in a limit greater than 50.
2025
public let limit: Int?
2126
public let page: Int?
2227
public let saved_only: Bool?

0 commit comments

Comments
 (0)