Skip to content

Commit b442519

Browse files
author
Bart Koelman
authored
Move resource annotations into separate package (#1127)
* Moved resource-related attributes and (I)Identifiable to separate package * Fixed broken links in doc-comments * Update ROADMAP.md
1 parent b2abccb commit b442519

30 files changed

+108
-51
lines changed

‎JsonApiDotNetCore.sln‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Microsoft Visual Studio Solution File, Format Version 12.00
2-
# Visual Studio Version 16
3-
VisualStudioVersion = 16.0.28606.126
2+
# Visual Studio Version 17
3+
VisualStudioVersion = 17.0.31919.166
44
MinimumVisualStudioVersion = 10.0.40219.1
55
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{7A2B7ADD-ECB5-4D00-AA6A-D45BD11C97CF}"
66
EndProject
@@ -48,7 +48,9 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "JsonApiDotNetCore.SourceGen
4848
EndProject
4949
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SourceGeneratorDebugger", "test\SourceGeneratorDebugger\SourceGeneratorDebugger.csproj", "{87D066F9-3540-4AC7-A748-134900969EE5}"
5050
EndProject
51-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SourceGeneratorTests", "test\SourceGeneratorTests\SourceGeneratorTests.csproj", "{0E0B5C51-F7E2-4F40-A4E4-DED0E9731DC9}"
51+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SourceGeneratorTests", "test\SourceGeneratorTests\SourceGeneratorTests.csproj", "{0E0B5C51-F7E2-4F40-A4E4-DED0E9731DC9}"
52+
EndProject
53+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "JsonApiDotNetCore.Annotations", "src\JsonApiDotNetCore.Annotations\JsonApiDotNetCore.Annotations.csproj", "{83FF097C-C8C6-477B-9FAB-DF99B84978B5}"
5254
EndProject
5355
Global
5456
GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -252,6 +254,18 @@ Global
252254
{0E0B5C51-F7E2-4F40-A4E4-DED0E9731DC9}.Release|x64.Build.0 = Release|Any CPU
253255
{0E0B5C51-F7E2-4F40-A4E4-DED0E9731DC9}.Release|x86.ActiveCfg = Release|Any CPU
254256
{0E0B5C51-F7E2-4F40-A4E4-DED0E9731DC9}.Release|x86.Build.0 = Release|Any CPU
257+
{83FF097C-C8C6-477B-9FAB-DF99B84978B5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
258+
{83FF097C-C8C6-477B-9FAB-DF99B84978B5}.Debug|Any CPU.Build.0 = Debug|Any CPU
259+
{83FF097C-C8C6-477B-9FAB-DF99B84978B5}.Debug|x64.ActiveCfg = Debug|Any CPU
260+
{83FF097C-C8C6-477B-9FAB-DF99B84978B5}.Debug|x64.Build.0 = Debug|Any CPU
261+
{83FF097C-C8C6-477B-9FAB-DF99B84978B5}.Debug|x86.ActiveCfg = Debug|Any CPU
262+
{83FF097C-C8C6-477B-9FAB-DF99B84978B5}.Debug|x86.Build.0 = Debug|Any CPU
263+
{83FF097C-C8C6-477B-9FAB-DF99B84978B5}.Release|Any CPU.ActiveCfg = Release|Any CPU
264+
{83FF097C-C8C6-477B-9FAB-DF99B84978B5}.Release|Any CPU.Build.0 = Release|Any CPU
265+
{83FF097C-C8C6-477B-9FAB-DF99B84978B5}.Release|x64.ActiveCfg = Release|Any CPU
266+
{83FF097C-C8C6-477B-9FAB-DF99B84978B5}.Release|x64.Build.0 = Release|Any CPU
267+
{83FF097C-C8C6-477B-9FAB-DF99B84978B5}.Release|x86.ActiveCfg = Release|Any CPU
268+
{83FF097C-C8C6-477B-9FAB-DF99B84978B5}.Release|x86.Build.0 = Release|Any CPU
255269
EndGlobalSection
256270
GlobalSection(SolutionProperties) = preSolution
257271
HideSolutionNode = FALSE
@@ -273,6 +287,7 @@ Global
273287
{952C0FDE-AFC8-455C-986F-6CC882ED8953} = {7A2B7ADD-ECB5-4D00-AA6A-D45BD11C97CF}
274288
{87D066F9-3540-4AC7-A748-134900969EE5} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
275289
{0E0B5C51-F7E2-4F40-A4E4-DED0E9731DC9} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
290+
{83FF097C-C8C6-477B-9FAB-DF99B84978B5} = {7A2B7ADD-ECB5-4D00-AA6A-D45BD11C97CF}
276291
EndGlobalSection
277292
GlobalSection(ExtensibilityGlobals) = postSolution
278293
SolutionGuid = {A2421882-8F0A-4905-928F-B550B192F9A4}

‎ROADMAP.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ The need for breaking changes has blocked several efforts in the v4.x release, s
2626
- [x] Configuration validation [#170](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/170)
2727
- [x] Auto-generated controllers [#732](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/732) [#365](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/365)
2828
- [x] Support .NET 6 with EF Core 6 [#1109](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1109)
29+
- [x] Extract annotations into separate package [#730](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/730)
2930

3031
Aside from the list above, we have interest in the following topics. It's too soon yet to decide whether they'll make it into v5.x or in a later major version.
3132

3233
- Optimistic concurrency [#1004](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1004)
33-
- Extract annotations into separate package [#730](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/730)
3434
- OpenAPI (Swagger) [#1046](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1046)
3535
- Fluent API [#776](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/776)
3636
- Resource inheritance [#844](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/844)

‎src/JsonApiDotNetCore.Annotations/.editorconfig‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[*.cs]
2+
3+
# AV1505: Namespace should match with assembly name
4+
dotnet_diagnostic.AV1505.severity = none

‎src/JsonApiDotNetCore/ArgumentGuard.cs‎ renamed to ‎src/JsonApiDotNetCore.Annotations/ArgumentGuard.cs‎

File renamed without changes.

‎src/JsonApiDotNetCore/CollectionConverter.cs‎ renamed to ‎src/JsonApiDotNetCore.Annotations/CollectionConverter.cs‎

File renamed without changes.

‎src/JsonApiDotNetCore/Configuration/ResourceType.cs‎ renamed to ‎src/JsonApiDotNetCore.Annotations/Configuration/ResourceType.cs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,27 +48,27 @@ public sealed class ResourceType
4848
public IReadOnlyCollection<EagerLoadAttribute> EagerLoads { get; }
4949

5050
/// <summary>
51-
/// Configures which links to show in the <see cref="Serialization.Objects.TopLevelLinks" /> object for this resource type. Defaults to
52-
/// <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="IJsonApiOptions.TopLevelLinks" />.
51+
/// Configures which links to write in the top-level links object for this resource type. Defaults to <see cref="LinkTypes.NotConfigured" />, which falls
52+
/// back to TopLevelLinks in global options.
5353
/// </summary>
5454
/// <remarks>
5555
/// In the process of building the resource graph, this value is set based on <see cref="ResourceLinksAttribute.TopLevelLinks" /> usage.
5656
/// </remarks>
5757
public LinkTypes TopLevelLinks { get; }
5858

5959
/// <summary>
60-
/// Configures which links to show in the <see cref="Serialization.Objects.ResourceLinks" /> object for this resource type. Defaults to
61-
/// <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="IJsonApiOptions.ResourceLinks" />.
60+
/// Configures which links to write in the resource-level links object for this resource type. Defaults to <see cref="LinkTypes.NotConfigured" />, which
61+
/// falls back to ResourceLinks in global options.
6262
/// </summary>
6363
/// <remarks>
6464
/// In the process of building the resource graph, this value is set based on <see cref="ResourceLinksAttribute.ResourceLinks" /> usage.
6565
/// </remarks>
6666
public LinkTypes ResourceLinks { get; }
6767

6868
/// <summary>
69-
/// Configures which links to show in the <see cref="Serialization.Objects.RelationshipLinks" /> object for all relationships of this resource type.
70-
/// Defaults to <see cref="LinkTypes.NotConfigured" />, which falls back to <see cref="IJsonApiOptions.RelationshipLinks" />. This can be overruled per
71-
/// relationship by setting <see cref="RelationshipAttribute.Links" />.
69+
/// Configures which links to write in the relationship-level links object for all relationships of this resource type. Defaults to
70+
/// <see cref="LinkTypes.NotConfigured" />, which falls back to RelationshipLinks in global options. This can be overruled per relationship by setting
71+
/// <see cref="RelationshipAttribute.Links" />.
7272
/// </summary>
7373
/// <remarks>
7474
/// In the process of building the resource graph, this value is set based on <see cref="ResourceLinksAttribute.RelationshipLinks" /> usage.

‎src/JsonApiDotNetCore/Controllers/JsonApiEndpoints.cs‎ renamed to ‎src/JsonApiDotNetCore.Annotations/Controllers/JsonApiEndpoints.cs‎

File renamed without changes.

‎src/JsonApiDotNetCore.Annotations/JsonApiDotNetCore.Annotations.csproj‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
<PropertyGroup>
3+
<TargetFramework>$(TargetFrameworkName)</TargetFramework>
4+
<IsPackable>true</IsPackable>
5+
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
6+
<RootNamespace>JsonApiDotNetCore</RootNamespace>
7+
</PropertyGroup>
8+
9+
<PropertyGroup>
10+
<VersionPrefix>$(JsonApiDotNetCoreVersionPrefix)</VersionPrefix>
11+
<PackageTags>jsonapidotnetcore;jsonapi;json:api;dotnet;asp.net;rest;web-api</PackageTags>
12+
<Description>Annotations for JsonApiDotNetCore, a framework for building JSON:API compliant REST APIs using ASP.NET and Entity Framework Core.</Description>
13+
<Authors>json-api-dotnet</Authors>
14+
<PackageProjectUrl>https://www.jsonapi.net/</PackageProjectUrl>
15+
<PackageLicenseExpression>MIT</PackageLicenseExpression>
16+
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
17+
<PackageReleaseNotes>See https://github.com/json-api-dotnet/JsonApiDotNetCore/releases.</PackageReleaseNotes>
18+
<PackageIcon>logo.png</PackageIcon>
19+
<PublishRepositoryUrl>true</PublishRepositoryUrl>
20+
<EmbedUntrackedSources>true</EmbedUntrackedSources>
21+
<DebugType>embedded</DebugType>
22+
</PropertyGroup>
23+
24+
<ItemGroup>
25+
<None Include="..\..\logo.png" Visible="false">
26+
<Pack>True</Pack>
27+
<PackagePath></PackagePath>
28+
</None>
29+
</ItemGroup>
30+
</Project>

‎src/JsonApiDotNetCore/ObjectExtensions.cs‎ renamed to ‎src/JsonApiDotNetCore.Annotations/ObjectExtensions.cs‎

File renamed without changes.

‎src/JsonApiDotNetCore.Annotations/Properties/AssemblyInfo.cs‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
using System.Runtime.CompilerServices;
2+
3+
[assembly: InternalsVisibleTo("Benchmarks")]
4+
[assembly: InternalsVisibleTo("JsonApiDotNetCore")]
5+
[assembly: InternalsVisibleTo("JsonApiDotNetCoreTests")]
6+
[assembly: InternalsVisibleTo("UnitTests")]
7+
[assembly: InternalsVisibleTo("TestBuildingBlocks")]

0 commit comments

Comments
 (0)