docs: general fixes to references (#5653)

* fixed typedoc plugin's escape strategy

* move props comments to the associated property

* regenerate references
This commit is contained in:
Shahed Nasser
2023-11-17 19:36:58 +02:00
committed by GitHub
parent b3093c3e3d
commit c51dce164d
869 changed files with 15238 additions and 7267 deletions
+14 -5
View File
@@ -142,12 +142,21 @@ export type RequestQueryFields = {
* @interface
*
* Pagination fields returned in the response of an API route.
*
* @prop limit - The maximum number of items that can be returned in the list.
* @prop offset - The number of items skipped before the returned items in the list.
* @prop count - The total number of items available.
*/
export type PaginatedResponse = { limit: number; offset: number; count: number }
export type PaginatedResponse = {
/**
* The maximum number of items that can be returned in the list.
*/
limit: number
/**
* The number of items skipped before the returned items in the list.
*/
offset: number
/**
* The total number of items available.
*/
count: number
}
/**
* @interface