Skip to content

Commit 432c741

Browse files
committed
add rest of languages
1 parent 5be63f1 commit 432c741

File tree

2 files changed

+20
-14
lines changed

2 files changed

+20
-14
lines changed

fern/products/cli-api-reference/cli-changelog/2025-09-22.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88

99
## 0.78.4
10-
**`(fix):`** Collapse any combination of optional and nullable to optional<nullable<T>>.
10+
**`(fix):`** Collapse any combination of optional and nullable to `optional<nullable<T>>`.
1111

1212
## 0.78.3
1313
**`(chore):`** Support IR v59 in the Rust SDK generator.

fern/products/sdks/snippets/readme-options.mdx

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,6 @@ readme:
5555
Sections to disable in the README. Supported values: `"contributing"`.
5656
</ParamField>
5757

58-
<ParamField path="defaultEndpoint" type="ReadmeEndpointSchema" required={false} toc={true}>
59-
Specifies which endpoint's code snippet to showcase as the primary example in the README.
60-
</ParamField>
61-
6258
<ParamField path="features" type="map<string, list<ReadmeEndpointSchema>>" required={false} toc={true}>
6359
Organizes endpoints into named feature sections within the README. Each feature creates a dedicated section with example code snippets for the specified endpoints.
6460
</ParamField>
@@ -83,21 +79,31 @@ Specifies which endpoint's code snippet to showcase as the primary example in th
8379

8480
Define a custom section in the generated README for a specific SDK.
8581

86-
<ParamField path="customSections.title" type="string" required={true}>
82+
<ParamField path="customSections.title" type="string" required={true} toc={true}>
8783
The title of the custom section as it will appear in the README.
8884
</ParamField>
89-
<ParamField path="customSections.language" type="'java' | 'typescript'" required={true}>
85+
<ParamField path="customSections.language" type="'java' | 'typescript'" required={true} toc={true}>
9086
The target SDK language for this section. The custom section will only appear in README files generated for the specified language.
9187
</ParamField>
92-
<ParamField path="customSections.content" type="string" required={true}>
93-
The Markdown content of the custom section. You can use template variables to dynamically insert package names and SDK version numbers.
88+
<ParamField path="customSections.content" type="string" required={true} toc={true}>
89+
The Markdown content of the custom section. You can use template variables in the format `{{ variable }}` that will be dynamically replaced with values specific to each SDK language when the README is generated.
90+
91+
Available template variables by language:
9492

9593
| Language | Variable | Description |
9694
|----------|----------|-------------|
97-
| Java | `{{ group }}` | Maven groupId from `coordinate` field |
98-
| Java | `{{ artifact }}` | Maven artifactId from `coordinate` field |
99-
| Java | `{{ version }}` | SDK version |
100-
| TypeScript | `{{ packageName }}` | Name of your package, as specified in the `package-name` field |
101-
| TypeScript | `{{ version }}` | SDK version |
95+
| TypeScript | `packageName` | Name of your package, as specified in the [`package-name` field](/sdks/generators/typescript/configuration#package-name) |
96+
| Python | `packageName` | Name of your package, as specified in the [`package-name` field](/sdks/generators/python/configuration#package-name) |
97+
| Go | `owner` | The owner of your Go module |
98+
| Go | `repo` | The [repository](/sdks/generators/go/publishing#configure-output-location) where your Go module is published |
99+
| Go | `version` | SDK version |
100+
| Java | `group` | Maven `groupId` [from `coordinate` field](/sdks/generators/java/publishing#configure-maven-coordinate) |
101+
| Java | `artifact` | Maven `artifactId` [from `coordinate` field](/sdks/generators/java/publishing#configure-maven-coordinate) |
102+
| Java | `version` | SDK version |
103+
| C#/.NET | `packageName` | Name of your package, as specified in the [`package-name` field](/sdks/generators/csharp/configuration#package-name) |
104+
| PHP | `packageName` | Name of your package, as specified in the [`package-name` field](/sdks/generators/php/configuration#package-name) |
105+
| Ruby | `packageName` | Name of your package, as specified in the [`package-name` field](/sdks/generators/ruby/configuration#package-name) |
106+
| Swift | `gitUrl` | The [URL](/sdks/generators/swift/publishing#verify-package-availability) where your Swift package is published. For example, `https://github.com/fern-api/basic-swift-sdk` |
107+
| Swift | `minVersion` | SDK version |
102108

103109
</ParamField>

0 commit comments

Comments
 (0)