docs(openapi): document respect-parameter-content setting - #6713
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
docs(openapi): document respect-parameter-content setting#6713devin-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
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
OpenAPI lets a parameter describe its value with a
contentmap instead ofschema, which is how a header carrying a JSON-encoded object is expressed. Fern previously read onlyparameter.schema, so those headers became a plainstring: SDK users passed a hand-serialized string, and the API Reference showed a single text box instead of the object's fields. The newrespect-parameter-contentOpenAPI setting types such headers from the referenced schema, giving real typed objects in SDKs and per-field playground inputs in the API Reference. It is opt-in because turning it on changes generated SDK method signatures.Implements docs for: feat(openapi): add respect-parameter-content setting to type parameters declared with content (fern-api/fern#17327)
Changes
fern/snippets/openapi-specs.mdx(the OpenAPIsettingsreference, included by both the SDKs generators.yml reference and the API Definitions OpenAPI generators reference): addedrespect-parameter-content: trueto the examplegenerators.ymlblock and a<ParamField path="settings.respect-parameter-content" type="boolean" default="false">entry alongside the otherrespect-*settings. The entry covers what it does, a short spec example of acontentheader, that it is off by default because it changes SDK signatures, and that query parameters declared withcontentstaystring(Fern serializes object query parameters as deep key-value pairs, not a single JSON-encoded value).No changelog entry: this is an SDK/CLI-side setting, and those changelogs are generated separately. Cross-referencing sweep found no other page that documents individual OpenAPI
settingskeys (sibling settings such asobject-query-parametersandrespect-readonly-schemashave no cross-references either), so no additional pointers were warranted.Link to Devin session: https://app.devin.ai/sessions/5f06456e784a43a4b67fc484372bce80