Skip to content

Commit c6e6e37

Browse files
committed
Add comment to AddOpenApi, introduced authors tag and build property in project files
1 parent 6c61da6 commit c6e6e37

File tree

4 files changed

+8
-2
lines changed

4 files changed

+8
-2
lines changed

Directory.Build.props

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
<EFCoreVersion>5.0.*</EFCoreVersion>
66
<NpgsqlPostgreSQLVersion>5.0.*</NpgsqlPostgreSQLVersion>
77
<SwashbuckleVersion>6.2.*</SwashbuckleVersion>
8+
<JsonApiDotNetCoreVersionPrefix>4.2.0</JsonApiDotNetCoreVersionPrefix>
89
<CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)CodingGuidelines.ruleset</CodeAnalysisRuleSet>
910
</PropertyGroup>
1011

src/JsonApiDotNetCore.OpenApi/JsonApiDotNetCore.OpenApi.csproj

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22
<PropertyGroup>
3-
<VersionPrefix>4.2.0</VersionPrefix>
3+
<VersionPrefix>$(JsonApiDotNetCoreVersionPrefix)</VersionPrefix>
44
<TargetFramework>$(NetCoreAppVersion)</TargetFramework>
55
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
66
</PropertyGroup>
77

88
<PropertyGroup>
99
<PackageTags>jsonapidotnetcore;jsonapi;json:api;dotnet;asp.net;openapi;swagger;swaggerui;swashbuckle</PackageTags>
1010
<Description>A Swashbuckle integration that enables you to describe a JsonApiDotNetCore API with an OpenAPI specification.</Description>
11+
<Authors>json-api-dotnet</Authors>
1112
<PackageProjectUrl>https://www.jsonapi.net/</PackageProjectUrl>
1213
<PackageLicenseExpression>MIT</PackageLicenseExpression>
1314
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>

src/JsonApiDotNetCore.OpenApi/ServiceCollectionExtensions.cs

+3
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ namespace JsonApiDotNetCore.OpenApi
66
{
77
public static class ServiceCollectionExtensions
88
{
9+
/// <summary>
10+
/// Adds the OpenAPI integration to JsonApiDotNetCore by configuring Swashbuckle.
11+
/// </summary>
912
public static void AddOpenApi(this IServiceCollection services, IMvcCoreBuilder mvcBuilder, Action<SwaggerGenOptions> setupSwaggerGenAction = null)
1013
{
1114
ArgumentGuard.NotNull(services, nameof(services));

src/JsonApiDotNetCore/JsonApiDotNetCore.csproj

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22
<PropertyGroup>
3-
<VersionPrefix>4.2.0</VersionPrefix>
3+
<VersionPrefix>$(JsonApiDotNetCoreVersionPrefix)</VersionPrefix>
44
<TargetFramework>$(NetCoreAppVersion)</TargetFramework>
55
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
66
</PropertyGroup>
77

88
<PropertyGroup>
99
<PackageTags>jsonapidotnetcore;jsonapi;json:api;dotnet;asp.net</PackageTags>
1010
<Description>A framework for building JSON:API compliant REST APIs using .NET Core and Entity Framework Core. Includes support for Atomic Operations. The ultimate goal of this library is to eliminate as much boilerplate as possible by offering out-of-the-box features such as sorting, filtering and pagination. You just need to focus on defining the resources and implementing your custom business logic. This library has been designed around dependency injection making extensibility incredibly easy.</Description>
11+
<Authors>json-api-dotnet</Authors>
1112
<PackageProjectUrl>https://www.jsonapi.net/</PackageProjectUrl>
1213
<PackageLicenseExpression>MIT</PackageLicenseExpression>
1314
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>

0 commit comments

Comments
 (0)