Skip to content

Commit ff36f1a

Browse files
committed
Fix OpenAPI nit, add todo for generators.yml, show generators.yml file after fern add command
1 parent cf85ae0 commit ff36f1a

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

fern/products/sdks/pages/typescript/quickstart.mdx

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Generate a TypeScript SDK by following the instructions on this page.
2222

2323
### Initialize the Fern Folder
2424

25-
You can use either the Open API definition or Fern Definition to generate your SDK.
25+
You can use either the OpenAPI definition or Fern Definition to generate your SDK.
2626

2727
<AccordionGroup>
2828
<Accordion title="Option 1: OpenAPI">
@@ -34,13 +34,13 @@ Generate a TypeScript SDK by following the instructions on this page.
3434

3535
<CodeBlocks>
3636

37-
<CodeBlock title="Spec stored locally">
37+
<CodeBlock title="Local file">
3838
```bash
3939
fern init --openapi path/to/openapi.yml
4040
```
4141
</CodeBlock>
4242

43-
<CodeBlock title="Spec hosted on web">
43+
<CodeBlock title="Web-hosted file">
4444
```bash
4545
fern init --openapi https://api.example.com/openapi.yml
4646
```
@@ -89,6 +89,9 @@ Generate a TypeScript SDK by following the instructions on this page.
8989
`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 proceeding with the rest of this page.
9090
</Note>
9191

92+
{/* TODO: show want generators.yml looks like, link out to configuration.md */}
93+
94+
9295
</Accordion>
9396
</AccordionGroup>
9497

@@ -102,15 +105,28 @@ Generate a TypeScript SDK by following the instructions on this page.
102105
[supported extensions](/learn/api-definition/openapi/extensions).
103106
</Note>
104107

105-
### Generate the SDK
108+
### Add the SDK generator
106109

107-
Add the TypeScript SDK using the following command:
110+
Add the TypeScript SDK generator:
108111

109112
```bash
110113
fern add fern-typescript-node-sdk --group sdk
111114
```
112115

113-
Then, generate the SDK:
116+
This command adds the following to `generators.yml`:
117+
118+
```yaml
119+
sdk:
120+
generators:
121+
- name: fernapi/fern-typescript-node-sdk
122+
version: 1.10.1
123+
output:
124+
location: local-file-system
125+
path: ../sdks/typescript
126+
```
127+
### Generate the SDK
128+
129+
Generate the SDK:
114130
115131
```bash
116132
fern generate --group sdk

0 commit comments

Comments
 (0)