Skip to content

Commit 4170eaa

Browse files
authored
Move --api flag info into quickstarts (SDKs) (#573)
1 parent 0e3f0d1 commit 4170eaa

File tree

8 files changed

+79
-31
lines changed

8 files changed

+79
-31
lines changed

fern/products/sdks/overview/csharp/quickstart.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,19 @@ This command adds the following `group` to `generators.yml`:
3939
```
4040
### Generate the SDK
4141
42-
Run the following command to generate your SDK:
42+
Run the following command to generate your SDK:
43+
44+
```bash
45+
fern generate --group csharp-sdk
46+
```
47+
48+
<Note>
49+
If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate:
4350

4451
```bash
45-
fern generate --group csharp-sdk
46-
```
52+
fern generate --group csharp-sdk --api your-api-name
53+
```
54+
</Note>
4755

4856
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
4957

fern/products/sdks/overview/go/quickstart.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,19 @@ This command adds the following `group` to `generators.yml`:
3939
4040
### Generate the SDK
4141
42-
Run the following command to generate your SDK:
42+
Run the following command to generate your SDK:
43+
44+
```bash
45+
fern generate --group go-sdk
46+
```
47+
48+
<Note>
49+
If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate:
4350

4451
```bash
45-
fern generate --group go-sdk
46-
```
52+
fern generate --group go-sdk --api your-api-name
53+
```
54+
</Note>
4755

4856
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
4957

fern/products/sdks/overview/java/quickstart.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,19 @@ This command adds the following `group` to `generators.yml`:
3939
4040
### Generate the SDK
4141
42-
Run the following command to generate your SDK:
42+
Run the following command to generate your SDK:
43+
44+
```bash
45+
fern generate --group java-sdk
46+
```
47+
48+
<Note>
49+
If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate:
4350

4451
```bash
45-
fern generate --group java-sdk
46-
```
52+
fern generate --group java-sdk --api your-api-name
53+
```
54+
</Note>
4755

4856
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
4957

fern/products/sdks/overview/php/quickstart.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,19 @@ This command adds the following `group` to `generators.yml`:
4040
4141
### Generate the SDK
4242
43-
Run the following command to generate your SDK:
43+
Run the following command to generate your SDK:
44+
45+
```bash
46+
fern generate --group php-sdk
47+
```
48+
49+
<Note>
50+
If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate:
4451

4552
```bash
46-
fern generate --group php-sdk
47-
```
53+
fern generate --group php-sdk --api your-api-name
54+
```
55+
</Note>
4856

4957
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
5058

fern/products/sdks/overview/python/quickstart.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,19 @@ This command adds the following `group` to `generators.yml`:
3939
4040
### Generate the SDK
4141
42-
Run the following command to generate your SDK:
42+
Run the following command to generate your SDK:
43+
44+
```bash
45+
fern generate --group python-sdk
46+
```
47+
48+
<Note>
49+
If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate:
4350

4451
```bash
45-
fern generate --group python-sdk
46-
```
52+
fern generate --group python-sdk --api your-api-name
53+
```
54+
</Note>
4755

4856
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
4957

fern/products/sdks/overview/ruby/quickstart.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,19 @@ This command adds the following `group` to `generators.yml`:
4040
4141
### Generate the SDK
4242
43-
Run the following command to generate your SDK:
43+
Run the following command to generate your SDK:
44+
45+
```bash
46+
fern generate --group ruby-sdk
47+
```
48+
49+
<Note>
50+
If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate:
4451

4552
```bash
46-
fern generate --group ruby-sdk
47-
```
53+
fern generate --group ruby-sdk --api your-api-name
54+
```
55+
</Note>
4856

4957
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
5058

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

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,21 @@ This command adds the following `group` to `generators.yml`:
3939
```
4040
## Generate the SDK
4141
42-
Run the following command to generate your SDK:
42+
Run the following command to generate your SDK:
43+
44+
```bash
45+
fern generate --group ts-sdk
46+
```
47+
48+
<Note>
49+
If you have multiple APIs, use the [`--api` flag](/cli-api-reference/cli-reference/commands#api) to specify the API you want to generate:
4350

4451
```bash
45-
fern generate --group ts-sdk
46-
```
52+
fern generate --group ts-sdk --api your-api-name
53+
```
54+
</Note>
4755

48-
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
56+
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
4957

5058
```bash
5159
fern/ # created by fern init

fern/snippets/multiple-apis.mdx

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,4 @@ fern/
1515
├─ generators.yml # Required: points to API spec
1616
└─ openapi/
1717
├─ openapi.yml # API Definition file
18-
```
19-
20-
### SDK generation
21-
22-
To [specify the API for SDK generation](/cli-api-reference/cli-reference/commands#api) use the `--api` flag:
23-
24-
```bash
25-
fern generate --api public-api
26-
```
18+
```

0 commit comments

Comments
 (0)