Skip to content

fix(omnichannel): correct vi to v1 in transcript path#220

Open
mvanhorn wants to merge 1 commit into
RocketChat:mainfrom
mvanhorn:osc/219-fix-vi-v1-omnichannel
Open

fix(omnichannel): correct vi to v1 in transcript path#220
mvanhorn wants to merge 1 commit into
RocketChat:mainfrom
mvanhorn:osc/219-fix-vi-v1-omnichannel

Conversation

@mvanhorn
Copy link
Copy Markdown

Summary

Closes #219. omnichannel.yaml:7201 declared the Request PDF Transcript endpoint at /api/vi/omnichannel/{rid}/request-transcript (with vi instead of v1), and the matching operationId at line 7216 carried the same vi -> v1 typo. Because client SDKs and generated bindings consume this spec directly, the entry shipped a path that resolves to a non-existent endpoint at runtime.

Why this matters

Every other endpoint in omnichannel.yaml lives under /api/v1/omnichannel/... - the corrected path is the namespace the actual Rocket.Chat backend serves. Without this fix, anyone consuming the OpenAPI spec to drive a generated client gets a 404 on the transcript-request endpoint until they manually patch the path. The operationId typo also leaks into generated code (postApiViOmnichannelRidRequestTranscript), so the bug is also visible in the names client developers end up working with.

Changes

  • omnichannel.yaml:7201 - path vi -> v1.
  • omnichannel.yaml:7216 - operationId vi -> v1.

No other content in the file touched. The schema below the path (parameters, responses, request body refs) was already pointed at the correct Rocket.Chat omnichannel components.

How to test

$ grep -n "vi/omnichannel\|vi-omnichannel" omnichannel.yaml
(empty)
$ grep -n "v1/omnichannel/{rid}/request-transcript\|v1-omnichannel-rid-request-transcript" omnichannel.yaml
7201:  '/api/v1/omnichannel/{rid}/request-transcript':
7216:      operationId: post-api-v1-omnichannel-rid-request-transcript

Fixes #219

AI-assisted.

`omnichannel.yaml:7201` declared the Request PDF Transcript endpoint at
`/api/vi/omnichannel/{rid}/request-transcript` (with `vi` instead of
`v1`), and the matching `operationId` at line 7216 carried the same
`vi` -> `v1` typo. Because client SDKs and generated bindings consume
this spec directly, the entry shipped a path that resolves to a
non-existent endpoint at runtime.

Replace `vi` with `v1` in both the path and the operationId so the
spec matches the actual Rocket.Chat REST API namespace used by every
other endpoint in the same file (e.g. `/api/v1/omnichannel/contact`,
`/api/v1/omnichannel/contacts`).

Fixes RocketChat#219
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented May 22, 2026

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix: typo in path for omnichannel request-transcript endpoint

2 participants