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.md
+3Lines changed: 3 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,9 @@ Exposing an [OpenAPI document](https://swagger.io/specification/) for your JSON:
7
7
The [JsonApiDotNetCore.OpenApi.Swashbuckle](https://github.com/json-api-dotnet/JsonApiDotNetCore/pkgs/nuget/JsonApiDotNetCore.OpenApi.Swashbuckle) NuGet package
8
8
provides OpenAPI support for JSON:API by integrating with [Swashbuckle](https://github.com/domaindrivendev/Swashbuckle.AspNetCore).
9
9
10
+
> [!WARNING]
11
+
> OpenAPI support for JSON:API is currently experimental. The API and the structure of the OpenAPI document may change in future versions.
12
+
10
13
## Getting started
11
14
12
15
1. Install the `JsonApiDotNetCore.OpenApi.Swashbuckle` NuGet package:
#pragma warning disable JADNC_OA_001// Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
#pragma warning restore JADNC_OA_001// Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
Copy file name to clipboardExpand all lines: test/OpenApiTests/OpenApiStartup.cs
+2Lines changed: 2 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,9 @@ public override void ConfigureServices(IServiceCollection services)
15
15
{
16
16
base.ConfigureServices(services);
17
17
18
+
#pragma warning disable JADNC_OA_001// Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
#pragma warning restore JADNC_OA_001// Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
0 commit comments