You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/usage/openapi-client.md
+26-6
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ The following code generators are supported, though you may try others as well:
12
12
13
13
# [NSwag](#tab/nswag)
14
14
15
-
For C# clients, we provide an additional package that provides workarounds for bugs in NSwag and enables using partial PATCH/POST requests.
15
+
For C# clients, we provide an additional package that provides workarounds for bugs in NSwag and enables using partial POST/PATCH requests.
16
16
17
17
To add it to your project, run the following command:
18
18
```
@@ -146,16 +146,36 @@ From here, continue from step 3 in the list of steps for Visual Studio.
146
146
147
147
# [Kiota](#tab/kiota)
148
148
149
-
To generate your C# client, install the Kiota tool by following the steps at https://learn.microsoft.com/en-us/openapi/kiota/install#install-as-net-tool.
150
-
151
-
Next, generate client code by running the [command line tool](https://learn.microsoft.com/en-us/openapi/kiota/using#client-generation). For example:
149
+
To generate your C# client, first add the Kiota tool to your solution:
> The `ExtraArguments` parameter is required for compatibility with JSON:API.
173
+
174
+
Next, build your project. It runs the kiota command-line tool, which generates files in the `GeneratedCode` subdirectory.
175
+
157
176
> [!CAUTION]
158
-
> The `--backing-store` switch is needed for JSON:API partial PATCH/POST requests to work correctly.
177
+
> If you're not using `<KiotaReference>`, at least make sure you're passing the `--backing-store` switch to the command-line tool,
178
+
> which is needed for JSON:API partial POST/PATCH requests to work correctly.
159
179
160
180
Kiota is pretty young and therefore still rough around the edges. At the time of writing, there are various bugs, for which we have workarounds
161
181
in place. For a full example, see the [example project](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/openapi/src/Examples/OpenApiKiotaClientExample).
0 commit comments