Skip to content

Commit ebf4f10

Browse files
bkoelmanbkoelman
committed
JsonApiObjects consistency renames: ResourceObject -> ResourceData, ResourceIdentifier -> Identifier, drop Object suffixes
1 parent 36a21c6 commit ebf4f10

File tree

56 files changed

+632
-639
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+632
-639
lines changed

‎src/Examples/JsonApiDotNetCoreExampleClient/OpenAPIs/swagger.json

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2755,7 +2755,7 @@
27552755
},
27562756
"components": {
27572757
"schemas": {
2758-
"linksInRelationshipObject": {
2758+
"linksInRelationship": {
27592759
"required": [
27602760
"related",
27612761
"self"
@@ -2801,6 +2801,19 @@
28012801
},
28022802
"additionalProperties": false
28032803
},
2804+
"linksInResourceData": {
2805+
"required": [
2806+
"self"
2807+
],
2808+
"type": "object",
2809+
"properties": {
2810+
"self": {
2811+
"minLength": 1,
2812+
"type": "string"
2813+
}
2814+
},
2815+
"additionalProperties": false
2816+
},
28042817
"linksInResourceDocument": {
28052818
"required": [
28062819
"self"
@@ -2871,19 +2884,6 @@
28712884
},
28722885
"additionalProperties": false
28732886
},
2874-
"linksInResourceObject": {
2875-
"required": [
2876-
"self"
2877-
],
2878-
"type": "object",
2879-
"properties": {
2880-
"self": {
2881-
"minLength": 1,
2882-
"type": "string"
2883-
}
2884-
},
2885-
"additionalProperties": false
2886-
},
28872887
"nullablePersonIdentifierResponseDocument": {
28882888
"required": [
28892889
"data",
@@ -2974,7 +2974,7 @@
29742974
"links": {
29752975
"allOf": [
29762976
{
2977-
"$ref": "#/components/schemas/linksInRelationshipObject"
2977+
"$ref": "#/components/schemas/linksInRelationship"
29782978
}
29792979
]
29802980
},
@@ -3161,7 +3161,7 @@
31613161
"links": {
31623162
"allOf": [
31633163
{
3164-
"$ref": "#/components/schemas/linksInResourceObject"
3164+
"$ref": "#/components/schemas/linksInResourceData"
31653165
}
31663166
]
31673167
},
@@ -3536,7 +3536,7 @@
35363536
"links": {
35373537
"allOf": [
35383538
{
3539-
"$ref": "#/components/schemas/linksInResourceObject"
3539+
"$ref": "#/components/schemas/linksInResourceData"
35403540
}
35413541
]
35423542
},
@@ -3730,7 +3730,7 @@
37303730
"links": {
37313731
"allOf": [
37323732
{
3733-
"$ref": "#/components/schemas/linksInRelationshipObject"
3733+
"$ref": "#/components/schemas/linksInRelationship"
37343734
}
37353735
]
37363736
},
@@ -3774,7 +3774,7 @@
37743774
"links": {
37753775
"allOf": [
37763776
{
3777-
"$ref": "#/components/schemas/linksInRelationshipObject"
3777+
"$ref": "#/components/schemas/linksInRelationship"
37783778
}
37793779
]
37803780
},
@@ -3819,7 +3819,7 @@
38193819
"links": {
38203820
"allOf": [
38213821
{
3822-
"$ref": "#/components/schemas/linksInRelationshipObject"
3822+
"$ref": "#/components/schemas/linksInRelationship"
38233823
}
38243824
]
38253825
},
@@ -4035,7 +4035,7 @@
40354035
"links": {
40364036
"allOf": [
40374037
{
4038-
"$ref": "#/components/schemas/linksInResourceObject"
4038+
"$ref": "#/components/schemas/linksInResourceData"
40394039
}
40404040
]
40414041
},

‎src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/NullableResourceIdentifierResponseDocument.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
1010
// Types in the current namespace are never touched by ASP.NET ModelState validation, therefore using a non-nullable reference type for a property does not
1111
// imply this property is required. Instead, we use [Required] explicitly, because this is how Swashbuckle is instructed to mark properties as required.
1212
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
13-
internal sealed class NullableResourceIdentifierResponseDocument<TResource> : NullableSingleData<ResourceIdentifierObject<TResource>>
13+
internal sealed class NullableResourceIdentifierResponseDocument<TResource> : NullableSingleData<ResourceIdentifier<TResource>>
1414
where TResource : IIdentifiable
1515
{
1616
[JsonPropertyName("jsonapi")]
17-
public JsonapiObject Jsonapi { get; set; } = null!;
17+
public Jsonapi Jsonapi { get; set; } = null!;
1818

1919
[Required]
2020
[JsonPropertyName("links")]

‎src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/NullableSecondaryResourceResponseDocument.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
99

1010
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
11-
internal sealed class NullableSecondaryResourceResponseDocument<TResource> : NullableSingleData<ResourceObjectInResponse<TResource>>
11+
internal sealed class NullableSecondaryResourceResponseDocument<TResource> : NullableSingleData<ResourceDataInResponse<TResource>>
1212
where TResource : IIdentifiable
1313
{
1414
[JsonPropertyName("jsonapi")]
15-
public JsonapiObject Jsonapi { get; set; } = null!;
15+
public Jsonapi Jsonapi { get; set; } = null!;
1616

1717
[Required]
1818
[JsonPropertyName("links")]

‎src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/PrimaryResourceResponseDocument.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
99

1010
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
11-
internal sealed class PrimaryResourceResponseDocument<TResource> : SingleData<ResourceObjectInResponse<TResource>>
11+
internal sealed class PrimaryResourceResponseDocument<TResource> : SingleData<ResourceDataInResponse<TResource>>
1212
where TResource : IIdentifiable
1313
{
1414
[JsonPropertyName("jsonapi")]
15-
public JsonapiObject Jsonapi { get; set; } = null!;
15+
public Jsonapi Jsonapi { get; set; } = null!;
1616

1717
[Required]
1818
[JsonPropertyName("links")]

‎src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourceCollectionResponseDocument.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
99

1010
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
11-
internal sealed class ResourceCollectionResponseDocument<TResource> : ManyData<ResourceObjectInResponse<TResource>>
11+
internal sealed class ResourceCollectionResponseDocument<TResource> : ManyData<ResourceDataInResponse<TResource>>
1212
where TResource : IIdentifiable
1313
{
1414
[JsonPropertyName("jsonapi")]
15-
public JsonapiObject Jsonapi { get; set; } = null!;
15+
public Jsonapi Jsonapi { get; set; } = null!;
1616

1717
[Required]
1818
[JsonPropertyName("links")]

‎src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourceIdentifierCollectionResponseDocument.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
99

1010
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
11-
internal sealed class ResourceIdentifierCollectionResponseDocument<TResource> : ManyData<ResourceIdentifierObject<TResource>>
11+
internal sealed class ResourceIdentifierCollectionResponseDocument<TResource> : ManyData<ResourceIdentifier<TResource>>
1212
where TResource : IIdentifiable
1313
{
1414
[JsonPropertyName("jsonapi")]
15-
public JsonapiObject Jsonapi { get; set; } = null!;
15+
public Jsonapi Jsonapi { get; set; } = null!;
1616

1717
[Required]
1818
[JsonPropertyName("links")]

‎src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourceIdentifierResponseDocument.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
99

1010
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
11-
internal sealed class ResourceIdentifierResponseDocument<TResource> : SingleData<ResourceIdentifierObject<TResource>>
11+
internal sealed class ResourceIdentifierResponseDocument<TResource> : SingleData<ResourceIdentifier<TResource>>
1212
where TResource : IIdentifiable
1313
{
1414
[JsonPropertyName("jsonapi")]
15-
public JsonapiObject Jsonapi { get; set; } = null!;
15+
public Jsonapi Jsonapi { get; set; } = null!;
1616

1717
[Required]
1818
[JsonPropertyName("links")]

‎src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourcePatchRequestDocument.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
66

77
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
8-
internal sealed class ResourcePatchRequestDocument<TResource> : SingleData<ResourceObjectInPatchRequest<TResource>>
8+
internal sealed class ResourcePatchRequestDocument<TResource> : SingleData<ResourceDataInPatchRequest<TResource>>
99
where TResource : IIdentifiable;

‎src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/ResourcePostRequestDocument.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@
55
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
66

77
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
8-
internal sealed class ResourcePostRequestDocument<TResource> : SingleData<ResourceObjectInPostRequest<TResource>>
8+
internal sealed class ResourcePostRequestDocument<TResource> : SingleData<ResourceDataInPostRequest<TResource>>
99
where TResource : IIdentifiable;

‎src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Documents/SecondaryResourceResponseDocument.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Documents;
99

1010
[UsedImplicitly(ImplicitUseTargetFlags.Members)]
11-
internal sealed class SecondaryResourceResponseDocument<TResource> : SingleData<ResourceObjectInResponse<TResource>>
11+
internal sealed class SecondaryResourceResponseDocument<TResource> : SingleData<ResourceDataInResponse<TResource>>
1212
where TResource : IIdentifiable
1313
{
1414
[JsonPropertyName("jsonapi")]
15-
public JsonapiObject Jsonapi { get; set; } = null!;
15+
public Jsonapi Jsonapi { get; set; } = null!;
1616

1717
[Required]
1818
[JsonPropertyName("links")]

0 commit comments

Comments
 (0)