feat(api): add pagination page for v3 api#1869
Conversation
laviniat1996
added
the
scope: api
This comment has been minimized.
This comment has been minimized.
|
/review |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| "now": 1771226782 | ||
| } | ||
| ], | ||
| "address_book": { ... } |
There was a problem hiding this comment.
[HIGH] JSON examples use invalid ellipsis
In the first “Response (abbreviated)” JSON example, the line at L85 uses "address_book": { ... } inside a json code block, which is not valid JSON and cannot be parsed or copy‑pasted safely. This violates the style rule against literal ellipses that change code syntax while hiding content, and can mislead readers about what constitutes valid JSON. The same non‑syntactic ellipsis pattern appears in subsequent examples on this page (e.g., the next page response around L125 and the sort=asc example around L235), so the issue repeats across multiple snippets. Per the extended style guide on comments and omissions (https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L627-L632), examples should remain syntactically correct even when abbreviated.
| "address_book": { ... } | |
| "address_book": {} |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| | Endpoint | Default limit | Max limit | Sortable | | ||
| | --------------------------------------------------------------------------------------------------------------------- | :-----------: | :-------: | :------: | |
There was a problem hiding this comment.
[HIGH] Numeric columns in pagination table are not right-aligned
The pagination endpoints table defines Default limit, Max limit, and Sortable columns whose values are numeric or boolean-like, but the alignment row centers these columns (:-----------:, :-------:, :------:). This makes it harder to scan and compare numbers vertically and conflicts with the style guidance that numeric columns should be right-aligned. Correcting the alignment improves readability and consistency across documentation tables.
| | Endpoint | Default limit | Max limit | Sortable | | |
| | --------------------------------------------------------------------------------------------------------------------- | :-----------: | :-------: | :------: | | |
| | Endpoint | Default limit | Max limit | Sortable | | |
| | --------------------------------------------------------------------------------------------------------------------- | -----------: | -------: | ------: | |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
| "now": 1771226782 | ||
| } | ||
| ], | ||
| "address_book": { ... } |
There was a problem hiding this comment.
[HIGH] JSON responses use literal ellipses that break syntax
The JSON example at L85 uses "address_book": { ... }, which is not valid JSON and will fail if copied into tools, tests, or scripts. The same invalid ellipsis pattern is repeated in the later JSON examples at L125 and L235 in the same file, so all three response blocks are non–copy-pasteable. The extended style guide (see https://github.com/ton-org/docs/blob/main/contribute/style-guide-extended.mdx?plain=1#L620-L633) forbids ellipses that change code syntax and requires examples to be executable as written, making this a HIGH-severity documentation defect. Keeping these examples syntactically valid reduces friction and prevents readers from silently adopting broken payloads.
| "address_book": { ... } | |
| "address_book": {} |
Please leave a reaction 👍/👎 to this suggestion to improve future reviews for everyone!
3 participants
closes #1043
This PR adds a new page which contains in-depth details about how API v3 pagination works.