fix: use method-specific Schema types for calling REST client pages#344
Merged
Conversation
Replace generic EndpointSchemaSnippet (which rendered all 35 command variants) with Fern's Schema component pointing to each method's specific type (e.g. Calling.CallPlayRequest for play, Calling.CallCreateRequest for dial). Also excludes the 'command' property since the SDK sets it automatically based on the method called. Affects both TypeScript and Python reference pages (74 files total). Co-Authored-By: bot_apk <apk@cognition.ai>
Contributor
Contributor
Author
|
Requested by: Devon White |
- Add '## **Request**' header above the Schema component - Replace '## **Response Example**' with '## **Response**' - Replace EndpointResponseSnippet with Schema type='Calling.CallResponse' to show the structured response type definition Co-Authored-By: bot_apk <apk@cognition.ai>
Devon-White
approved these changes
Jun 2, 2026
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
1 participant
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
Every calling REST client method page (dial, play, record, etc.) was using
<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />, which rendered the fullCalling.CallRequestunion — all 35 command variants on every single page.Replaced with Fern's
<Schema>component pointing to each method's specific type:Changes:
Calling.CallCreateRequestfor dial,Calling.CallPlayRequestfor play)commandproperty excluded viaexclude={["command"]}since the SDK sets it automatically## **Request**and## **Response**headers for better page organization<Schema type="Calling.CallResponse">instead ofEndpointResponseSnippetAffects 74 files total — both TypeScript and Python reference pages.
Requested by: Fern Support