Skip to content

Commit 3d45e81

Browse files
committed
inital change
1 parent f7e9733 commit 3d45e81

File tree

3 files changed

+16
-0
lines changed

3 files changed

+16
-0
lines changed

fern/apis/generators-yml/definition/generators.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,8 @@ types:
8484
bannerLink: optional<string>
8585
introduction: optional<string>
8686
apiReferenceLink: optional<string>
87+
apiName: optional<string>
88+
disabledSections: optional<list<string>>
8789
defaultEndpoint:
8890
type: optional<ReadmeEndpointSchema>
8991
docs: "If set, use this endpoint's snippet as the default whenever possible"

fern/products/sdks/guides/configure-readme.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ You can add custom introductions, showcase key endpoints, and organize your SDK
1010
readme:
1111
introduction: "Welcome to our API"
1212
apiReferenceLink: "https://docs.example.com"
13+
apiName: "Example Product"
14+
disabledSections:
15+
- "contributing"
1316
defaultEndpoint:
1417
method: "POST"
1518
path: "/users"

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -337,6 +337,9 @@ readme:
337337
bannerLink: "https://example.com/banner"
338338
introduction: "Welcome to our API"
339339
apiReferenceLink: "https://docs.example.com"
340+
apiName: "Example Product"
341+
disabledSections:
342+
- "contributing"
340343
defaultEndpoint:
341344
method: "POST"
342345
path: "/users"
@@ -365,6 +368,14 @@ readme:
365368
URL to your external API documentation or reference guide.
366369
</ParamField>
367370

371+
<ParamField path="apiName" type="string" required={false} toc={true}>
372+
Name of the API that appears in the README. Will appear as `Your Api Name SDK` or `Your Api Name API`. Defaults to organization name if not set.
373+
</ParamField>
374+
375+
<ParamField path="disabledSections" type="string[]" required={false} toc={true}>
376+
Sections to disable in the README (e.g. `contributing`).
377+
</ParamField>
378+
368379
<ParamField path="defaultEndpoint" type="ReadmeEndpointSchema" required={false} toc={true}>
369380
Specifies which endpoint's code snippet to showcase as the primary example in the README.
370381
</ParamField>

0 commit comments

Comments
 (0)