Skip to content

Commit 468f309

Browse files
committed
refactor(api): update user query parameters for clarity
- Modified the `limit` parameter in the user query schema to remove the maximum cap description, simplifying the API documentation. - Updated corresponding OpenAPI specifications in both admin and server JSON files to reflect the change in the `limit` parameter description. These changes enhance the clarity of the API documentation and improve user understanding of the query parameters.
1 parent f0f48be commit 468f309

3 files changed

Lines changed: 7 additions & 7 deletions

File tree

apps/backend/src/app/api/latest/users/crud.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,7 @@ export const usersCrudHandlers = createLazyProxy(() => createCrudHandlers(usersC
520520
}),
521521
querySchema: yupObject({
522522
team_id: yupString().uuid().optional().meta({ openapiField: { onlyShowInOperations: [ 'List' ], description: "Only return users who are members of the given team" } }),
523-
limit: yupNumber().integer().min(1).max(200).optional().meta({ openapiField: { onlyShowInOperations: [ 'List' ], description: "The maximum number of items to return (capped at 200)." } }),
523+
limit: yupNumber().integer().min(1).optional().meta({ openapiField: { onlyShowInOperations: [ 'List' ], description: "The maximum number of items to return" } }),
524524
cursor: yupString().uuid().optional().meta({ openapiField: { onlyShowInOperations: [ 'List' ], description: "The cursor to start the result set from." } }),
525525
order_by: yupString().oneOf(['signed_up_at', 'last_active_at']).optional().meta({ openapiField: { onlyShowInOperations: [ 'List' ], description: "The field to sort the results by. Defaults to signed_up_at" } }),
526526
desc: yupString().oneOf(["true", "false"]).optional().meta({ openapiField: { onlyShowInOperations: [ 'List' ], description: "Whether to sort the results in descending order. Defaults to false" } }),

docs-mintlify/openapi/admin.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9353,9 +9353,9 @@
93539353
"in": "query",
93549354
"schema": {
93559355
"type": "integer",
9356-
"description": "The maximum number of items to return (capped at 200)."
9356+
"description": "The maximum number of items to return"
93579357
},
9358-
"description": "The maximum number of items to return (capped at 200).",
9358+
"description": "The maximum number of items to return",
93599359
"required": false
93609360
},
93619361
{
@@ -11365,4 +11365,4 @@
1136511365
}
1136611366
}
1136711367
}
11368-
}
11368+
}

docs-mintlify/openapi/server.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8604,9 +8604,9 @@
86048604
"in": "query",
86058605
"schema": {
86068606
"type": "integer",
8607-
"description": "The maximum number of items to return (capped at 200)."
8607+
"description": "The maximum number of items to return"
86088608
},
8609-
"description": "The maximum number of items to return (capped at 200).",
8609+
"description": "The maximum number of items to return",
86108610
"required": false
86118611
},
86128612
{
@@ -10616,4 +10616,4 @@
1061610616
}
1061710617
}
1061810618
}
10619-
}
10619+
}

0 commit comments

Comments
 (0)