docs: clarify how Fern handles OpenAPI string validation keywords - #6505
Closed
devin-ai-integration[bot] wants to merge 1 commit into
Closed
docs: clarify how Fern handles OpenAPI string validation keywords#6505devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 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:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1785769805-openapi-validation-keywords.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
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
Users assume
maxLengthand friends are enforced by generated SDKs. The OpenAPI overview page said nothing about validation keywords, so there was nowhere in the public docs to correct that.Adds a two-sentence
## String validation keywordssection to the OpenAPI overview stating that Fern readsmaxLength,minLength,pattern, andformat, where they surface (API Reference type display, API Explorer input cap,fern checkexample validation), and that generated SDKs don't enforce them — that stays the API server's job.The equivalent statement already exists for Fern Definition on
api-def/ferndef/types.mdx("enforced by the server, but the generated client SDKs don't include validation logic"), so no new page and no changes elsewhere.Link to Devin session: https://app.devin.ai/sessions/13be6b5189344424adada59f49cd33fc