Skip to content

docs(openapi): document respect-parameter-content setting - #6713

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1787331997-respect-parameter-content
Open

docs(openapi): document respect-parameter-content setting#6713
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1787331997-respect-parameter-content

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

OpenAPI lets a parameter describe its value with a content map instead of schema, which is how a header carrying a JSON-encoded object is expressed. Fern previously read only parameter.schema, so those headers became a plain string: SDK users passed a hand-serialized string, and the API Reference showed a single text box instead of the object's fields. The new respect-parameter-content OpenAPI 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 OpenAPI settings reference, included by both the SDKs generators.yml reference and the API Definitions OpenAPI generators reference): added respect-parameter-content: true to the example generators.yml block and a <ParamField path="settings.respect-parameter-content" type="boolean" default="false"> entry alongside the other respect-* settings. The entry covers what it does, a short spec example of a content header, that it is off by default because it changes SDK signatures, and that query parameters declared with content stay string (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 settings keys (sibling settings such as object-query-parameters and respect-readonly-schemas have no cross-references either), so no additional pointers were warranted.

Link to Devin session: https://app.devin.ai/sessions/5f06456e784a43a4b67fc484372bce80

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants