docs(openapi): document schema-level examples as selectable API Reference examples - #7020
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
…ence examples Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
devin-ai-integration
Bot
requested review from
devalog,
jkonrath-postman and
nerminamiller-postman
as code owners
September 19, 2026 17:06
Contributor
Author
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1789837557-openapi-schema-level-examples.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
Schema-level OpenAPI/JSON Schema
examplesarrays on a request or response body schema (including via$ref) now each appear as a separate, selectable example in the API Reference (Example 1,Example 2, …), and the response pane gained a second "example" dropdown next to the status-code dropdown when a status code has several examples. This matters for customers whose schemas already declare multiple examples (e.g. alternative response variants such as an async-job-id vs. a completed result): all of them now show up in the docs automatically, with no need to rewrite them asx-fern-examples.Implements docs for: feat(cli): surface every schema-level OpenAPI example as a selectable API reference example (fern-api/fern#17764) → fern-api/fern#17764
Implements docs for: feat(docs): split response example selector into status-code + example dropdowns (fern-api/fern-platform#14880) → https://github.com/fern-api/fern-platform/pull/14880
Pages changed
fern/products/api-def/openapi/extensions/examples.mdx— new "Schema-level examples" section: behavior, a component schema with twoexamplesentries, the precedence order (x-fern-examples> media-typeexample/examples> schema-level > autogenerated), and the status-code + example dropdowns in the response pane.fern/products/api-def/openapi/endpoints/rest.mdx— one-sentence pointer from the "Examples" section to the new section.Validation:
fern check --warnings(0 errors; remaining warnings are pre-existing and unrelated) and pre-commit/Vale on the changed files pass.Link to Devin session: https://app.devin.ai/sessions/66b756d12bde4e2baf8fb8062e1d1685
Open in Devin Desktop: https://app.devin.ai/desktop/session/66b756d12bde4e2baf8fb8062e1d1685?variant=devin