Skip to content

Commit df30ed7

Browse files
committed
review
1 parent 03b52ec commit df30ed7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

website/docs/contributing/add-new-api-client.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,12 @@ Path definition of the paths defined in the [spec file](#specyml-file). See [gui
5858

5959
> [Detailed issue](https://github.com/algolia/api-clients-automation/issues/891)
6060
61-
In some cases, you can encounter wrongly named `requestBody` from the specs, which is due to:
61+
In some cases, you can encounter wrongly named `requestBody` from the specs, which could be due to:
6262

6363
- The type is too complex/too broad to be generated. (e.g. [An object with `additionalProperties`](https://github.com/algolia/api-clients-automation/tree/main/specs/search/paths/objects/partialUpdate.yml#L24-L33))
64-
- The body is an alias of its sub type (e.g. [A list of sub models](https://github.com/algolia/api-clients-automation/tree/main/specs/search/paths/rules/saveRules.yml#L12-L20))
64+
- The type is an alias of its model (e.g. [A list of `model`](https://github.com/algolia/api-clients-automation/tree/main/specs/search/paths/rules/saveRules.yml#L12-L20))
6565

66-
The `x-codegen-request-body-name` property can be added at the root of the spec, to force the name of the generated `requestBody` property.
66+
The [`x-codegen-request-body-name`](https://openapi-generator.tech/docs/swagger-codegen-migration/#body-parameter-name) property can be added at the root of the spec, to force the name of the generated `requestBody` property.
6767

6868
You can find an example of this implementation [on this PR](https://github.com/algolia/api-clients-automation/pull/896).
6969

0 commit comments

Comments
 (0)