From f58feac0aefb8998d5995a9e61f1a46f57e91124 Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Wed, 27 Sep 2023 11:33:55 -0400 Subject: [PATCH 1/2] - adds the backward compatible option --- OpenAPI/kiota/using.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/OpenAPI/kiota/using.md b/OpenAPI/kiota/using.md index 3210483..55860a4 100644 --- a/OpenAPI/kiota/using.md +++ b/OpenAPI/kiota/using.md @@ -198,6 +198,7 @@ kiota generate (--openapi | -d) [(--namespace-name | -n) ] [(--log-level | --ll) ] [--backing-store | -b] + [--exclude-backward-compatible | --ebc] [--additional-data | --ad] [(--serializer | -s) ] [(--deserializer | --ds) ] @@ -236,9 +237,17 @@ 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`. + +```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 From 08f8075d25f13d8eff10c7dfd0e552f80c3487ec Mon Sep 17 00:00:00 2001 From: Vincent Biret Date: Wed, 27 Sep 2023 12:36:18 -0400 Subject: [PATCH 2/2] - adds an abstract to what the bacward compatible optino does Signed-off-by: Vincent Biret --- OpenAPI/kiota/using.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/OpenAPI/kiota/using.md b/OpenAPI/kiota/using.md index 55860a4..10683ef 100644 --- a/OpenAPI/kiota/using.md +++ b/OpenAPI/kiota/using.md @@ -241,6 +241,8 @@ kiota generate --backing-store Whether to exclude the code generated only for backward compatibility reasons or not. Defaults to `false`. +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 ```