Skip to content

refactor(api): migrate users.getUsernameSuggestion endpoint to openapi with ajv validation #39703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
CodeMatrix1 wants to merge 2 commits into from
Closed

refactor(api): migrate users.getUsernameSuggestion endpoint to openapi with ajv validation #39703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
417f333
refactor(api): migrate users.getUsernameSuggestion endpoint to new AP…
CodeMatrix1 Mar 18, 2026
36e7d3d
Comment : Bringing back rest-typing definition
CodeMatrix1 Mar 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/migrate-users-getUsernameSuggestion-to-AJV.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@rocket.chat/rest-typings': minor
'@rocket.chat/meteor': minor
---

Migrate users.getUsernameSuggestion endpoint to make it openAPI and AJV compatible
39 changes: 27 additions & 12 deletions apps/meteor/app/api/server/v1/users.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -878,6 +878,33 @@ const usersEndpoints = API.v1

return API.v1.success({ suggestions });
},
)
.get(
'users.getUsernameSuggestion',
{
authRequired: true,
userWithoutUsername: true,
response: {
200: ajv.compile({
type: 'object',
properties: {
result: { type: 'string' },
success: {
type: 'boolean',
enum: [true],
},
},
required: ['result', 'success'],
additionalProperties: false,
}),
401: validateUnauthorizedErrorResponse,
},
},
async function action() {
const result = await generateUsernameSuggestion(this.user);

return API.v1.success({ result });
},
);

API.v1.addRoute(
Expand Down Expand Up @@ -921,18 +948,6 @@ API.v1.addRoute(
},
);

API.v1.addRoute(
'users.getUsernameSuggestion',
{ authRequired: true, userWithoutUsername: true },
{
async get() {
const result = await generateUsernameSuggestion(this.user);

return API.v1.success({ result });
},
},
);

API.v1.addRoute(
'users.checkUsernameAvailability',
{
Expand Down