@@ -152,15 +152,21 @@ The file [`config/clients.config.json`](https://github.com/algolia/api-clients-a
152152
153153The following fields are required :
154154
155- | Option | Description |
156- | -------------------- | ------------------------------------------------------------------------------------------------- |
157- | `folder` | Path to the parent folder of every client for this language. |
158- | `gitRepoId` | Name of the repository for this API client. |
159- | `packageVersion` | Initial version number to publish for the generated client. It will be automatically incremented. |
160- | `modelFolder` | Path to the `model` folder that will host the generated code. |
161- | `apiFolder` | Path to the `api` folder that will host the generated code. |
162- | `tests.extension` | Test file extension, such as `.test.java` or `_test.py` |
163- | `tests.outputFolder` | Path to the folder that holds the tests for this language, such as `tests/` |
155+ | Option | Description |
156+ | ---------------------- | ------------------------------------------------------------------------------------------------- |
157+ | `clients` | The clients to generate, either a list of string (matching the api name), or see below |
158+ | `clients.name` | The name of the client to generate (matching the API name) |
159+ | `clients.output` | The output folder |
160+ | `folder` | Path to the parent folder of every client for this language. |
161+ | `gitRepoId` | Name of the repository for this API client. |
162+ | `packageVersion` | Initial version number to publish for the generated client. It will be automatically incremented. |
163+ | `modelFolder` | Path to the `model` folder that will host the generated code. |
164+ | `apiFolder` | Path to the `api` folder that will host the generated code. |
165+ | `dockerImage` | The name of the docker image that runs this client `apic_base` | `apic_ruby` | `apic_swift` |
166+ | `tests.extension` | Test file extension, such as `.test.java` or `_test.py` |
167+ | `tests.outputFolder` | Path to the folder that holds the tests for this language, such as `tests/` |
168+ | `snippets.extension` | Snippet file extension, such as `.java` or `.py` |
169+ | `snippets.outputFolder`| Path to the folder that holds the snippets for this language, such as `lib/` |
164170
165171# # 3. Generate the client
166172
0 commit comments