fix(omnichannel): correct vi to v1 in transcript path#220
Open
mvanhorn wants to merge 1 commit into
Open
Conversation
`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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #219.
omnichannel.yaml:7201declared the Request PDF Transcript endpoint at/api/vi/omnichannel/{rid}/request-transcript(withviinstead ofv1), and the matchingoperationIdat line 7216 carried the samevi->v1typo. 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.yamllives 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. TheoperationIdtypo 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- pathvi->v1.omnichannel.yaml:7216- operationIdvi->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
Fixes #219
AI-assisted.