docs: fix incorrect claim about Schema component type discovery #3432
+2
−2
Conversation
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
The documentation incorrectly stated that types exclusively used by webhooks or websockets won't be available. After investigating the fern-platform codebase, I found that: 1. Types from webhooks and websockets ARE included in the API definition 2. The IrGraph.build() method recursively adds types from endpoints, webhooks, and websocket channels 3. The actual limitation is that types must be defined as named schemas in the OpenAPI spec (under components/schemas) to be discoverable This commit updates the documentation to accurately reflect the behavior. Co-Authored-By: ryanstep@buildwithfern.com <ryanstep@umich.edu>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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
Updates the Schema component documentation to correct an inaccurate claim about type discovery. The previous documentation stated that "types exclusively used by websockets or webhooks won't be available," but after investigating the fern-platform codebase, I found that the
IrGraph.build()method does include types from webhooks and websocket channels.The actual limitation is that types must be defined as named schemas in the OpenAPI spec (under
components/schemas) to be discoverable - inline schemas that aren't extracted as named types won't be available.Review & Testing Checklist for Human
IrGraph.build()in fern-platform), not empirically tested.<Schema type="SomeWebhookType" />with a type that's only referenced by a webhook to confirm it works.ACHDetailstype not being found. The new docs suggest this is because it might be an inline schema - verify this is the actual root cause.Notes
WebhookExamplesClient.tsx,generateWebhookExample.ts). If webhook examples aren't appearing for Square, it may be a separate issue with their specific OpenAPI spec.