Skip to content

docs: add example OpenAPI spec to SDK quickstart pages#5602

Merged
devalog merged 3 commits into
mainfrom
devin/1779467650-add-example-spec-to-quickstarts
May 22, 2026
Merged

docs: add example OpenAPI spec to SDK quickstart pages#5602
devalog merged 3 commits into
mainfrom
devin/1779467650-add-example-spec-to-quickstarts

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot commented May 22, 2026

Summary

Adds an "Example (Petstore)" tab to the existing <CodeBlocks> in the SDK quickstart init step. Users who don't have their own OpenAPI spec can use the public Swagger Petstore URL to try out SDK generation immediately.

Previously the quickstarts had a Fern Definition option with a built-in imdb.yml example, but it was removed when the init flow was streamlined to only show the OpenAPI path. This restores a "try it out" path as a third code block alongside the existing local and URL options.

The change is in the shared init-fern-folder.mdx snippet, so it appears on all language-specific quickstart pages and the top-level SDKs quickstart.

Review & Testing Checklist for Human

  • Verify the third code block tab renders correctly on a quickstart page (e.g., /learn/sdks/generators/typescript/quickstart)
  • Run fern init --openapi https://petstore3.swagger.io/api/v3/openapi.json --organization my-org and confirm fern generate produces a valid SDK

Notes

Uses the Swagger Petstore v3 spec — a well-known, stable public spec maintained by the Swagger/OpenAPI team.

Link to Devin session: https://app.devin.ai/sessions/d2f0eef7747d47958b1f81c0c2163fd6
Requested by: @devalog

Co-Authored-By: Devin Logan <devinannlogan@gmail.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 and CI monitoring

@github-actions
Copy link
Copy Markdown
Contributor

devin-ai-integration Bot and others added 2 commits May 22, 2026 17:05
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
…ppet

Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
@devalog devalog merged commit be0e253 into main May 22, 2026
4 checks passed
@devalog devalog deleted the devin/1779467650-add-example-spec-to-quickstarts branch May 22, 2026 18:10
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.

1 participant