Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

- adds the backward compatible option #21

Merged
merged 2 commits into from
Sep 29, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion OpenAPI/kiota/using.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ kiota generate (--openapi | -d) <path>
[(--namespace-name | -n) <name>]
[(--log-level | --ll) <level>]
[--backing-store | -b]
[--exclude-backward-compatible | --ebc]
[--additional-data | --ad]
[(--serializer | -s) <classes>]
[(--deserializer | --ds) <classes>]
Expand Down Expand Up @@ -236,9 +237,19 @@ Enables backing store for models. Defaults to `false`.
kiota generate --backing-store
```

### `--exclude-backward-compatible (--ebc)`

Whether to exclude the code generated only for backward compatibility reasons or not. Defaults to `false`.
jasonjoh marked this conversation as resolved.
Show resolved Hide resolved

To maintain compatibility with applications that depends on generated clients, kiota emits additional code marked as obsolete. New clients do not need this additional backward compatible code. The code marked as obsolete will be removed in the next major version of kiota. Use this option to omit emitting the backward compatible code when generating a new client, or when the application using the existing client being refreshed does not depend on backward compatible code.

```bash
kiota generate --exclude-backward-compatible
```

#### `--additional-data (--ad)`

Will include the 'AdditionalData' property for generated models. Defaults to 'true'.
Will include the 'AdditionalData' property for generated models. Defaults to `true`.

```bash
kiota generate --additional-data false
Expand Down