Skip to content

docs: hide in-progress transcribe pages in server SDK#298

Merged
Devon-White merged 2 commits into
mainfrom
fern/hide-transcribe-page
Apr 22, 2026
Merged

docs: hide in-progress transcribe pages in server SDK#298
Devon-White merged 2 commits into
mainfrom
fern/hide-transcribe-page

Conversation

@fern-api
Copy link
Copy Markdown
Contributor

@fern-api fern-api Bot commented Apr 21, 2026

Summary

Hides the server SDK docs for the Relay transcribe / TranscribeAction APIs and removes the corresponding endpoints from the OpenAPI spec. The underlying post-recording transcription feature is not fully implemented — transcription runs but there is no facility to deliver the result to developers — so this should not be publicly exposed yet.

Docs (server SDK, Python + TypeScript):

  • Added hidden: true to the frontmatter of reference/<lang>/relay/actions/transcribe-action/ (index + stop) and reference/<lang>/relay/call/transcribe.
  • Removed the cards linking to those pages from the parent relay/actions and relay/call index pages.
  • URLs remain valid, so the missing-redirects check is not triggered.

OpenAPI spec:

  • Removed the calling.transcribe and calling.transcribe.stop commands from the TypeSpec source under specs/signalwire-rest/calling-api/calls/:
    • Request models CallTranscribeRequest / CallTranscribeStopRequest in models/requests.tsp (and their entries in the command union).
    • transcribeCallExample / transcribeStopCallExample in models/examples.tsp.
    • The two @opExample blocks and table rows in main.tsp.
  • Regenerated fern/apis/signalwire-rest/openapi.yaml by running the build script in specs/package.json (tsp compile). The regeneration also picked up a few pre-existing TypeSpec source changes for tag descriptions (Subscriber → [Subscriber](/docs/platform/subscribers) links) that weren't yet reflected in the built output.

Intentionally not affected:

  • live_transcribe / liveTranscribe — confirmed working.
  • REST calling/transcribe / transcribe-stop recording-file transcription — different feature.
  • Event / constant references that mention transcribe — kept so live_transcribe docs stay complete.

Review & Testing Checklist for Human

  • Confirm the four affected server-SDK pages are gone from the sidebar in the preview build (Python + TypeScript, under Relay → Actions and Relay → Call), and that live_transcribe / liveTranscribe are still present.
  • Spot-check the Calling API reference in the preview: calling.transcribe and calling.transcribe.stop should no longer appear in the command table, example dropdown, or request body union; calling.live_transcribe and the rest should be unchanged.
  • Sanity-check the incidental openapi.yaml tag-description updates (Subscriber link additions) are acceptable to ship alongside this change; if not, they should be split into a separate PR.
  • Confirm docs build / link-check CI passes (no missing-redirects or broken-link errors introduced).

Notes

Requested by: Fern Support

@fern-api
Copy link
Copy Markdown
Contributor Author

fern-api Bot commented Apr 21, 2026

Requested by: Adam Kalsey
Slack thread: View conversation

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 21, 2026

@Devon-White Devon-White merged commit 2780f5c into main Apr 22, 2026
2 checks passed
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.

1 participant