Skip to content

Commit cd7b294

Browse files
docs: add license configuration examples for SDK generators
- Add license field example to metadata section in generators-yml-reference.mdx - Add ParamField documentation for license configuration - Add license example to Python publishing guide Co-Authored-By: [email protected] <[email protected]>
1 parent 1c7c1fd commit cd7b294

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

fern/products/sdks/overview/python/publishing-to-pypi.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ groups:
8787
You can add metadata to your PyPI package to improve discoverability and provide additional information to users. This metadata appears on your package's PyPI page and includes `keywords` for PyPI search and discovery, `documentation-link` for your package documentation, and `homepage-link` for your project homepage.
8888

8989

90-
```yaml title="generators.yml" {9-12}
90+
```yaml title="generators.yml" {9-13}
9191
groups:
9292
python-sdk:
9393
generators:
@@ -100,6 +100,8 @@ groups:
100100
keywords: ["api", "sdk", "client"]
101101
documentation-link: "https://docs.yourcompany.com"
102102
homepage-link: "https://yourcompany.com"
103+
metadata:
104+
license: MIT
103105
config:
104106
client_class_name: YourClientName
105107
```

fern/products/sdks/reference/generators-yml-reference.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,7 @@ Package metadata like description and authors that gets included in all generate
288288
```yaml title="generators.yml"
289289
metadata:
290290
description: "My API SDK"
291+
license: MIT
291292
authors:
292293
- name: "John Doe"
293294
@@ -299,6 +300,10 @@ metadata:
299300
A brief description of the SDK that will be included in package metadata. This description helps users understand what your SDK does when they discover it in package repositories.
300301
</ParamField>
301302

303+
<ParamField path="license" type="'MIT' | 'Apache-2.0'" required={false} toc={true}>
304+
Software license for the generated SDK. Supported values are `MIT` or `Apache-2.0`. This populates the license field in package manifests (e.g., `pyproject.toml` for Python, `package.json` for TypeScript).
305+
</ParamField>
306+
302307
### `authors`
303308
A list of authors who will be credited in the generated SDK's package metadata.
304309

0 commit comments

Comments
 (0)