@@ -11,26 +11,18 @@ readme:
1111 path : " /users"
1212 stream : false
1313 customSections :
14- - title : " Usage "
15- language : " JAVA "
14+ - title : " Custom Section "
15+ language : " java "
1616 content : |
17- Add the following dependency to your project:
18-
19- ```xml
20- <dependency>
21- <groupId>{{ group }}</groupId>
22- <artifactId>{{ artifact }}</artifactId>
23- <version>{{ version }}</version>
24- </dependency>
25- ```
26- - title : " Getting Started"
27- language : " PYTHON"
17+ This is a custom section. Latest package info is {{ group }}:{{ artifact }}:{{ version }}.
18+ - title : " Custom Section"
19+ language : " typescript"
2820 content : |
29- Install the SDK using pip:
30-
31- ```bash
32- pip install {{ package }}=={{ version }}
33- ```
21+ Custom section for {{ packageName }}
22+ - title : " Another Custom Section "
23+ language : " typescript "
24+ content : |
25+ A second custom section for {{ packageName }}
3426 features :
3527 authentication :
3628 - method : " POST"
@@ -67,29 +59,6 @@ readme:
6759 Specifies which endpoint's code snippet to showcase as the primary example in the README.
6860</ParamField>
6961
70- <ParamField path="customSections" type="array" required={false} toc={true}>
71- Each item in the array defines a custom section with specific language, title, and content.
72- The sections are added to the generated README file for the specified language.
73-
74- <ParamField path="title" type="string" required={true}>
75- The title of the custom section.
76- </ParamField>
77- <ParamField path="language" type="'JAVA' | 'PYTHON' | 'TYPESCRIPT' | 'NODE' | 'C_SHARP' | 'GO' | 'PHP' | 'RUBY'" required={true}>
78- The language for which this section should be added. Use the values :
79- - ' JAVA'
80- - ' PYTHON'
81- - ' TYPESCRIPT'
82- - ' NODE'
83- - ' C_SHARP'
84- - ' GO'
85- - ' PHP'
86- - ' RUBY'
87- </ParamField>
88- <ParamField path="content" type="string" required={true}>
89- The Markdown content of the custom section. You can use template variables like `{{ group }}`, `{{ artifact }}`, and `{{ version }}` within the Markdown content.
90- </ParamField>
91- </ParamField>
92-
9362<ParamField path="features" type="map<string, list<ReadmeEndpointSchema>>" required={false} toc={true}>
9463 Organizes endpoints into named feature sections within the README. Each feature creates a dedicated section with example code snippets for the specified endpoints.
9564</ParamField>
@@ -108,4 +77,27 @@ Specifies which endpoint's code snippet to showcase as the primary example in th
10877
10978<ParamField path="defaultEndpoint.stream" type="boolean" required={false} default="false" toc={true}>
11079 Whether the endpoint is a streaming endpoint. Defaults to `false`.
80+ </ParamField>
81+
82+ # ## Custom sections
83+
84+ Define a custom section in the generated README for a specific SDK.
85+
86+ <ParamField path="customSections.title" type="string" required={true}>
87+ The title of the custom section as it will appear in the README.
88+ </ParamField>
89+ <ParamField path="customSections.language" type="'java' | 'typescript'" required={true}>
90+ The target SDK language for this section. The custom section will only appear in README files generated for the specified language.
91+ </ParamField>
92+ <ParamField path="customSections.content" type="string" required={true}>
93+ The Markdown content of the custom section. You can use template variables to dynamically insert package names and SDK version numbers.
94+
95+ | Language | Variable | Description |
96+ |----------|----------|-------------|
97+ | Java | `{{ group }}` | Maven groupId from `coordinate` field |
98+ | Java | `{{ artifact }}` | Maven artifactId from `coordinate` field |
99+ | Java | `{{ version }}` | SDK version |
100+ | TypeScript | `{{ packageName }}` | Name of your package, as specified in the `package-name` field |
101+ | TypeScript | `{{ version }}` | SDK version |
102+
111103</ParamField>
0 commit comments