.changeset/wet-roses-call.md (1)

6-6: Clarify scope and cross-reference the tracking issue

Nit: s/"endpoints"/"endpoint"/ if only commands.get is migrated here, and add "Refs #34983" for traceability.

Apply this diff:

-Add OpenAPI support for the Rocket.Chat commands.get API endpoints by migrating to a modern chained route definition syntax and utilizing shared AJV schemas for validation to enhance API documentation and ensure type safety through response validation.
+Add OpenAPI support for the Rocket.Chat commands.get API endpoint by migrating to a modern chained route definition syntax and utilizing shared Ajv schemas for validation to enhance API documentation and ensure type safety through response validation. Refs #34983.

apps/meteor/app/api/server/v1/commands.ts (3)

65-65: Type the query params

Cast to CommandsGetParams to align with the validated schema and improve editor tooling.

Apply this diff:

-		const params = this.queryParams;
+		const params = this.queryParams as CommandsGetParams;

---

67-69: Redundant runtime check; Ajv already enforces this

query: isCommandsGetParams rejects missing/non-string command before action() runs. Drop this branch to avoid conflicting messages with schema errors.

Apply this diff:

-		if (typeof params.command !== 'string') {
-			return API.v1.failure('The query param "command" must be provided.');
-		}

---

29-31: Naming nit: singular endpoint const

It holds a single GET route; singular reads clearer and matches usage in the exported type alias.

Apply this diff:

-const commandsEndpoints = API.v1.get(
+const commandsGetEndpoint = API.v1.get(

and

-export type CommandsEndpoints = ExtractRoutesFromAPI<typeof commandsEndpoints>;
+export type CommandsEndpoints = ExtractRoutesFromAPI<typeof commandsGetEndpoint>;

Also applies to: 385-386

apps/meteor/tests/end-to-end/api/commands.ts (1)

25-25: Avoid brittle equality on Ajv error text

Ajv message wording can change across versions. Assert key fragment instead.

Apply this diff:

-					expect(res.body.error).to.be.equal(`must have required property 'command'`);
+					expect(res.body.error).to.include(`required property 'command'`);

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

Learnt from: CR
PR: RocketChat/Rocket.Chat#0
File: .cursor/rules/playwright.mdc:0-0
Timestamp: 2025-09-16T22:08:51.490Z
Learning: Applies to apps/meteor/tests/e2e/**/*.spec.ts : Use descriptive test names that clearly communicate expected behavior

apps/meteor/app/api/server/v1/commands.ts (2)

37-43: Consider using ISlashCommand for type consistency.

The generic type parameter uses SlashCommand (line 38) while the schema references ISlashCommand (line 43). Although functionally equivalent (ISlashCommand extends SlashCommand), using ISlashCommand consistently would improve clarity and maintain alignment with the schema reference.

Apply this diff for consistency:

-				command: SlashCommand;
+				command: ISlashCommand;
 				success: true;
 			}>({

---

55-66: Redundant runtime type check after query validation.

The typeof params.command !== 'string' check (line 58) is redundant because the isCommandsGetParams validator (line 33) already ensures command is a required string property. If query validation is properly wired in the framework, this condition will never be true.

Consider removing the redundant check or adding a comment explaining why it's kept (e.g., defense-in-depth):

 	async function action() {
 		const params = this.queryParams;
 
-		if (typeof params.command !== 'string') {
-			return API.v1.failure('The query param "command" must be provided.');
-		}
-
 		const cmd = slashCommands.commands[params.command.toLowerCase()];
 
 		if (!cmd) {
 			return API.v1.failure(`There is no command in the system by the name of: ${params.command}`);
 		}
 
 		return API.v1.success({ command: cmd });
 	},

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

apps/meteor/app/api/server/v1/commands.ts (1)

16-27: Consider adding minLength constraint to prevent empty command strings.

The query validation correctly requires the command parameter, but doesn't enforce a minimum length. While the current implementation gracefully handles empty strings (returning a failure at line 72), adding minLength: 1 would provide earlier validation feedback.

Optional refinement:

 const CommandsGetParamsSchema = {
 	type: 'object',
 	properties: {
-		command: { type: 'string' },
+		command: { type: 'string', minLength: 1 },
 	},
 	required: ['command'],
 	additionalProperties: false,
 };

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro