docs: hide in-progress transcribe pages in server SDK#298
Merged
Conversation
Contributor
Author
|
Requested by: Adam Kalsey |
Contributor
🌿 Previewhttps://signalwire-preview-0ca0dbdb-e346-4c39-8eca-1cbe04c5943b.docs.buildwithfern.com/docs ✅ All links are valid. |
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
Hides the server SDK docs for the Relay
transcribe/TranscribeActionAPIs 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):
hidden: trueto the frontmatter ofreference/<lang>/relay/actions/transcribe-action/(index +stop) andreference/<lang>/relay/call/transcribe.relay/actionsandrelay/callindex pages.missing-redirectscheck is not triggered.OpenAPI spec:
calling.transcribeandcalling.transcribe.stopcommands from the TypeSpec source underspecs/signalwire-rest/calling-api/calls/:CallTranscribeRequest/CallTranscribeStopRequestinmodels/requests.tsp(and their entries in the command union).transcribeCallExample/transcribeStopCallExampleinmodels/examples.tsp.@opExampleblocks and table rows inmain.tsp.fern/apis/signalwire-rest/openapi.yamlby running thebuildscript inspecs/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.calling/transcribe/transcribe-stoprecording-file transcription — different feature.transcribe— kept solive_transcribedocs stay complete.Review & Testing Checklist for Human
live_transcribe/liveTranscribeare still present.calling.transcribeandcalling.transcribe.stopshould no longer appear in the command table, example dropdown, or request body union;calling.live_transcribeand the rest should be unchanged.missing-redirectsor broken-link errors introduced).Notes
Requested by: Fern Support