Skip to content

Update SDK quickstart snippets to use Files component #2453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −18
Open

Update SDK quickstart snippets to use Files component #2453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions fern/products/sdks/snippets/option-1-openapi.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,15 @@

This creates a `fern` folder in your current directory with the OpenAPI Specification. The exact folder structure might look different depending on your initial input files.

```bash
fern/
├─ fern.config.json # root-level configuration
└─ api/ # your API
├─ generators.yml # generators you're using
└─ openapi/
├─ openapi.yml # API-level configuration
```
</Accordion>
<Files>
<Folder name="fern" defaultOpen comment="root-level configuration">
<File name="fern.config.json" />
<Folder name="api" defaultOpen comment="your API">
<File name="generators.yml" comment="generators you're using" />
<Folder name="openapi" defaultOpen>
<File name="openapi.yml" comment="API-level configuration" />
</Folder>
</Folder>
</Folder>
</Files>
</Accordion>
20 changes: 11 additions & 9 deletions fern/products/sdks/snippets/option-2-fern-def.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,18 @@

This creates a `fern` folder in your current directory with the Fern Definition.

```bash
fern/
├─ fern.config.json # root-level configuration
├─ generators.yml # generators you're using
└─ definition/
├─ api.yml # API-level configuration
└─ imdb.yml # endpoints, types, and errors
```
<Files>
<Folder name="fern" defaultOpen>
<File name="fern.config.json" comment="root-level configuration" />
<File name="generators.yml" comment="generators you're using" />
<Folder name="definition" defaultOpen>
<File name="api.yml" comment="API-level configuration" />
<File name="imdb.yml" comment="endpoints, types, and errors" />
</Folder>
</Folder>
</Files>

<Note> `imdb.yml` contains an example movies API. If you’re just
<Note> `imdb.yml` contains an example movies API. If you're just
generating an SDK for test purposes, you can leave this file as it is. To
generate an SDK for your own API instead of the example movies API,
replace `imdb.yml` with your own endpoints, types, and errors before
Expand Down
Loading