Skip to content

Commit 6160ad0

Browse files
committed
Renamed variables and types to be consistent with JSON:API spec, where the vocabulary is 'RelationshipsObject' with its members being a 'Relationship'.
1 parent c948a6a commit 6160ad0

16 files changed

+125
-126
lines changed

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/NonPrimaryDocumentTypeFactory.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
using System;
22
using JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
3-
using JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData;
3+
using JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
44
using JsonApiDotNetCore.Resources.Annotations;
55

66
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects
@@ -10,8 +10,8 @@ internal sealed class NonPrimaryDocumentTypeFactory
1010
private static readonly DocumentOpenTypes SecondaryResponseDocumentOpenTypes = new(typeof(ResourceCollectionResponseDocument<>),
1111
typeof(NullableSecondaryResourceResponseDocument<>), typeof(SecondaryResourceResponseDocument<>));
1212

13-
private static readonly DocumentOpenTypes RelationshipRequestDocumentOpenTypes = new(typeof(ToManyRelationshipRequestData<>),
14-
typeof(NullableToOneRelationshipRequestData<>), typeof(ToOneRelationshipRequestData<>));
13+
private static readonly DocumentOpenTypes RelationshipRequestDocumentOpenTypes = new(typeof(ToManyRelationshipInRequest<>),
14+
typeof(NullableToOneRelationshipInRequest<>), typeof(ToOneRelationshipInRequest<>));
1515

1616
private static readonly DocumentOpenTypes RelationshipResponseDocumentOpenTypes = new(typeof(ResourceIdentifierCollectionResponseDocument<>),
1717
typeof(NullableResourceIdentifierResponseDocument<>), typeof(ResourceIdentifierResponseDocument<>));

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/RelationshipDataTypeFactory.cs renamed to src/JsonApiDotNetCore.OpenApi/JsonApiObjects/RelationshipTypeFactory.cs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
using System;
2-
using JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData;
2+
using JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
33
using JsonApiDotNetCore.Resources.Annotations;
44

55
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects
66
{
7-
internal sealed class RelationshipDataTypeFactory
7+
internal sealed class RelationshipTypeFactory
88
{
9-
public static RelationshipDataTypeFactory Instance { get; } = new();
9+
public static RelationshipTypeFactory Instance { get; } = new();
1010

11-
private RelationshipDataTypeFactory()
11+
private RelationshipTypeFactory()
1212
{
1313
}
1414

@@ -26,10 +26,10 @@ public Type GetForResponse(RelationshipAttribute relationship)
2626
// @formatter:nested_ternary_style expanded
2727

2828
Type relationshipDataOpenType = relationship is HasManyAttribute
29-
? typeof(ToManyRelationshipResponseData<>)
29+
? typeof(ToManyRelationshipInResponse<>)
3030
: relationship.IsNullable()
31-
? typeof(NullableToOneRelationshipResponseData<>)
32-
: typeof(ToOneRelationshipResponseData<>);
31+
? typeof(NullableToOneRelationshipInResponse<>)
32+
: typeof(ToOneRelationshipInResponse<>);
3333

3434
// @formatter:nested_ternary_style restore
3535

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
33
using JsonApiDotNetCore.Resources;
44

5-
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData
5+
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships
66
{
77
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
8-
internal sealed class NullableToOneRelationshipRequestData<TResource> : NullableSingleData<ResourceIdentifierObject<TResource>>
8+
internal sealed class NullableToOneRelationshipInRequest<TResource> : NullableSingleData<ResourceIdentifierObject<TResource>>
99
where TResource : IIdentifiable
1010
{
1111
}
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
66
using JsonApiDotNetCore.Resources;
77

8-
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData
8+
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships
99
{
1010
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
11-
internal sealed class NullableToOneRelationshipResponseData<TResource> : NullableSingleData<ResourceIdentifierObject<TResource>>
11+
internal sealed class NullableToOneRelationshipInResponse<TResource> : NullableSingleData<ResourceIdentifierObject<TResource>>
1212
where TResource : IIdentifiable
1313
{
1414
[Required]

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/RelationshipData/ToManyRelationshipRequestData.cs renamed to src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToManyRelationshipInRequest.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
33
using JsonApiDotNetCore.Resources;
44

5-
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData
5+
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships
66
{
77
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
8-
internal sealed class ToManyRelationshipRequestData<TResource> : ManyData<ResourceIdentifierObject<TResource>>
8+
internal sealed class ToManyRelationshipInRequest<TResource> : ManyData<ResourceIdentifierObject<TResource>>
99
where TResource : IIdentifiable
1010
{
1111
}
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
66
using JsonApiDotNetCore.Resources;
77

8-
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData
8+
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships
99
{
1010
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
11-
internal sealed class ToManyRelationshipResponseData<TResource> : ManyData<ResourceIdentifierObject<TResource>>
11+
internal sealed class ToManyRelationshipInResponse<TResource> : ManyData<ResourceIdentifierObject<TResource>>
1212
where TResource : IIdentifiable
1313
{
1414
[Required]

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/RelationshipData/ToOneRelationshipRequestData.cs renamed to src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToOneRelationshipInRequest.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
33
using JsonApiDotNetCore.Resources;
44

5-
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData
5+
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships
66
{
77
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
8-
internal sealed class ToOneRelationshipRequestData<TResource> : SingleData<ResourceIdentifierObject<TResource>>
8+
internal sealed class ToOneRelationshipInRequest<TResource> : SingleData<ResourceIdentifierObject<TResource>>
99
where TResource : IIdentifiable
1010
{
1111
}

src/JsonApiDotNetCore.OpenApi/JsonApiObjects/RelationshipData/ToOneRelationshipResponseData.cs renamed to src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToOneRelationshipInResponse.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
using JsonApiDotNetCore.OpenApi.JsonApiObjects.ResourceObjects;
66
using JsonApiDotNetCore.Resources;
77

8-
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData
8+
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships
99
{
1010
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
11-
internal sealed class ToOneRelationshipResponseData<TResource> : SingleData<ResourceIdentifierObject<TResource>>
11+
internal sealed class ToOneRelationshipInResponse<TResource> : SingleData<ResourceIdentifierObject<TResource>>
1212
where TResource : IIdentifiable
1313
{
1414
[Required]

src/JsonApiDotNetCore.OpenApi/JsonApiOperationIdSelector.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
using JsonApiDotNetCore.Configuration;
77
using JsonApiDotNetCore.Middleware;
88
using JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
9-
using JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData;
9+
using JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
1010
using Microsoft.AspNetCore.Mvc;
1111
using Microsoft.AspNetCore.Mvc.ApiExplorer;
1212
using Microsoft.AspNetCore.Mvc.Controllers;
@@ -32,9 +32,9 @@ internal sealed class JsonApiOperationIdSelector
3232
[typeof(ResourceIdentifierCollectionResponseDocument<>)] = RelationshipOperationIdTemplate,
3333
[typeof(ResourceIdentifierResponseDocument<>)] = RelationshipOperationIdTemplate,
3434
[typeof(NullableResourceIdentifierResponseDocument<>)] = RelationshipOperationIdTemplate,
35-
[typeof(ToOneRelationshipRequestData<>)] = RelationshipOperationIdTemplate,
36-
[typeof(NullableToOneRelationshipRequestData<>)] = RelationshipOperationIdTemplate,
37-
[typeof(ToManyRelationshipRequestData<>)] = RelationshipOperationIdTemplate
35+
[typeof(ToOneRelationshipInRequest<>)] = RelationshipOperationIdTemplate,
36+
[typeof(NullableToOneRelationshipInRequest<>)] = RelationshipOperationIdTemplate,
37+
[typeof(ToManyRelationshipInRequest<>)] = RelationshipOperationIdTemplate
3838
};
3939

4040
private readonly IControllerResourceMapping _controllerResourceMapping;

src/JsonApiDotNetCore.OpenApi/JsonApiRequestFormatMetadataProvider.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
using System.Threading.Tasks;
55
using JsonApiDotNetCore.Middleware;
66
using JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
7-
using JsonApiDotNetCore.OpenApi.JsonApiObjects.RelationshipData;
7+
using JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
88
using Microsoft.AspNetCore.Mvc.ApiExplorer;
99
using Microsoft.AspNetCore.Mvc.Formatters;
1010
using Microsoft.Net.Http.Headers;
@@ -15,9 +15,9 @@ internal sealed class JsonApiRequestFormatMetadataProvider : IInputFormatter, IA
1515
{
1616
private static readonly Type[] JsonApiRequestObjectOpenType =
1717
{
18-
typeof(ToManyRelationshipRequestData<>),
19-
typeof(ToOneRelationshipRequestData<>),
20-
typeof(NullableToOneRelationshipRequestData<>),
18+
typeof(ToManyRelationshipInRequest<>),
19+
typeof(ToOneRelationshipInRequest<>),
20+
typeof(NullableToOneRelationshipInRequest<>),
2121
typeof(ResourcePostRequestDocument<>),
2222
typeof(ResourcePatchRequestDocument<>)
2323
};

0 commit comments

Comments
 (0)