@@ -378,7 +378,7 @@ metadata:
378378</ParamField>
379379
380380# # readme
381- Controls what goes into the generated README files across all SDKs.
381+ Controls what goes into the generated README files across all SDKs, allowing you to customize the content and structure of your SDK documentation .
382382
383383` ` ` yaml
384384readme:
@@ -401,42 +401,41 @@ readme:
401401 path: "/users"
402402` ` `
403403
404- <ParamField path="readme" type="ReadmeSchema" required={false} toc={true}>
405- Configuration for customizing the generated README files.
406- </ParamField>
407-
408- <ParamField path="readme.bannerLink" type="string" required={false} toc={true}>
404+ <ParamField path="bannerLink" type="string" required={false} toc={true}>
409405 URL for a banner image or link that appears at the top of the README.
410406</ParamField>
411407
412- <ParamField path="readme. introduction" type="string" required={false} toc={true}>
408+ <ParamField path="introduction" type="string" required={false} toc={true}>
413409 Custom introduction text that appears at the beginning of the README.
414410</ParamField>
415411
416- <ParamField path="readme. apiReferenceLink" type="string" required={false} toc={true}>
412+ <ParamField path="apiReferenceLink" type="string" required={false} toc={true}>
417413 URL to your external API documentation or reference guide.
418414</ParamField>
419415
420- <ParamField path="readme. defaultEndpoint" type="ReadmeEndpointSchema" required={false} toc={true}>
416+ <ParamField path="defaultEndpoint" type="ReadmeEndpointSchema" required={false} toc={true}>
421417 Specifies which endpoint's code snippet to showcase as the primary example in the README.
422418</ParamField>
423419
424- <ParamField path="readme.defaultEndpoint.method" type="string" required={true} toc={true}>
420+ <ParamField path="features" type="map<string, list<ReadmeEndpointSchema>>" required={false} toc={true}>
421+ Groups endpoints by feature name for organized README sections. Each feature becomes a section in the README with example code snippets for the listed endpoints.
422+ </ParamField>
423+
424+ # ## defaultEndpoint
425+ Specifies which endpoint's code snippet to showcase as the primary example in the README.
426+
427+ <ParamField path="method" type="string" required={true} toc={true}>
425428 HTTP method of the default endpoint (e.g., `GET`, `POST`, `PUT`, `DELETE`).
426429</ParamField>
427430
428- <ParamField path="readme.defaultEndpoint. path" type="string" required={true} toc={true}>
431+ <ParamField path="path" type="string" required={true} toc={true}>
429432 Endpoint path for the default example (e.g., `/users`, `/auth/login`).
430433</ParamField>
431434
432- <ParamField path="readme.defaultEndpoint. stream" type="boolean" required={false} toc={true}>
435+ <ParamField path="stream" type="boolean" required={false} toc={true}>
433436 Whether the endpoint is a streaming endpoint. Defaults to `false`.
434437</ParamField>
435438
436- <ParamField path="readme.features" type="map<string, list<ReadmeEndpointSchema>>" required={false} toc={true}>
437- Groups endpoints by feature name for organized README sections. Each feature becomes a section in the README with example code snippets for the listed endpoints.
438- </ParamField>
439-
440439# # default-group
441440Which group to use when none is specified.
442441
0 commit comments