From 3d45e81f53a053051e057f78f3824005539b50e4 Mon Sep 17 00:00:00 2001 From: jsklan Date: Wed, 3 Sep 2025 14:43:06 -0400 Subject: [PATCH 1/3] inital change --- fern/apis/generators-yml/definition/generators.yml | 2 ++ fern/products/sdks/guides/configure-readme.mdx | 3 +++ .../sdks/reference/generators-yml-reference.mdx | 11 +++++++++++ 3 files changed, 16 insertions(+) diff --git a/fern/apis/generators-yml/definition/generators.yml b/fern/apis/generators-yml/definition/generators.yml index 2c94d86a6..86ed229f8 100644 --- a/fern/apis/generators-yml/definition/generators.yml +++ b/fern/apis/generators-yml/definition/generators.yml @@ -84,6 +84,8 @@ types: bannerLink: optional introduction: optional apiReferenceLink: optional + apiName: optional + disabledSections: optional> defaultEndpoint: type: optional docs: "If set, use this endpoint's snippet as the default whenever possible" diff --git a/fern/products/sdks/guides/configure-readme.mdx b/fern/products/sdks/guides/configure-readme.mdx index fcbcaf290..7be1b17b1 100644 --- a/fern/products/sdks/guides/configure-readme.mdx +++ b/fern/products/sdks/guides/configure-readme.mdx @@ -10,6 +10,9 @@ You can add custom introductions, showcase key endpoints, and organize your SDK readme: introduction: "Welcome to our API" apiReferenceLink: "https://docs.example.com" + apiName: "Example Product" + disabledSections: + - "contributing" defaultEndpoint: method: "POST" path: "/users" diff --git a/fern/products/sdks/reference/generators-yml-reference.mdx b/fern/products/sdks/reference/generators-yml-reference.mdx index 85fd1661a..190e891e1 100644 --- a/fern/products/sdks/reference/generators-yml-reference.mdx +++ b/fern/products/sdks/reference/generators-yml-reference.mdx @@ -337,6 +337,9 @@ readme: bannerLink: "https://example.com/banner" introduction: "Welcome to our API" apiReferenceLink: "https://docs.example.com" + apiName: "Example Product" + disabledSections: + - "contributing" defaultEndpoint: method: "POST" path: "/users" @@ -365,6 +368,14 @@ readme: URL to your external API documentation or reference guide. + + 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. + + + + Sections to disable in the README (e.g. `contributing`). + + Specifies which endpoint's code snippet to showcase as the primary example in the README. From 6887c282e1809d2bf6ce8095bd0b39d7ea648946 Mon Sep 17 00:00:00 2001 From: jsklan Date: Wed, 3 Sep 2025 14:46:56 -0400 Subject: [PATCH 2/3] updates --- fern/products/sdks/reference/generators-yml-reference.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/sdks/reference/generators-yml-reference.mdx b/fern/products/sdks/reference/generators-yml-reference.mdx index 190e891e1..0c0e43d47 100644 --- a/fern/products/sdks/reference/generators-yml-reference.mdx +++ b/fern/products/sdks/reference/generators-yml-reference.mdx @@ -369,7 +369,7 @@ readme: - 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. + Name of the API that appears in the README. Will appear as `Your Api Name SDK` or `Your Api Name API` throughout the README. Defaults to organization name if not set. From 938bef7facc87f7308c258fa7641ec6e94d8dc3b Mon Sep 17 00:00:00 2001 From: jsklan Date: Thu, 4 Sep 2025 11:23:51 -0400 Subject: [PATCH 3/3] feedback --- fern/products/sdks/reference/generators-yml-reference.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/sdks/reference/generators-yml-reference.mdx b/fern/products/sdks/reference/generators-yml-reference.mdx index 0c0e43d47..41a2eb625 100644 --- a/fern/products/sdks/reference/generators-yml-reference.mdx +++ b/fern/products/sdks/reference/generators-yml-reference.mdx @@ -373,7 +373,7 @@ readme: - Sections to disable in the README (e.g. `contributing`). + Sections to disable in the README. Supported values: `"contributing"`.