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..41a2eb625 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` throughout the README. Defaults to organization name if not set. + + + + Sections to disable in the README. Supported values: `"contributing"`. + + Specifies which endpoint's code snippet to showcase as the primary example in the README.