Fixed: make relationship links non-required

bkoelman · bkoelman · commit 6b6cf384c763 · 2024-03-27T07:50:32.000+01:00
diff --git a/src/Examples/JsonApiDotNetCoreExample/GeneratedSwagger/JsonApiDotNetCoreExample.json b/src/Examples/JsonApiDotNetCoreExample/GeneratedSwagger/JsonApiDotNetCoreExample.json
@@ -4977,9 +4977,6 @@
         "additionalProperties": false
       },
       "nullableToOnePersonInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -5854,9 +5851,6 @@
         "additionalProperties": false
       },
       "toManyTagInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -5898,9 +5892,6 @@
         "additionalProperties": false
       },
       "toManyTodoItemInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -5943,9 +5934,6 @@
         "additionalProperties": false
       },
       "toOnePersonInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/NullableToOneRelationshipInResponse.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/NullableToOneRelationshipInResponse.cs
@@ -11,7 +11,7 @@ namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
 internal sealed class NullableToOneRelationshipInResponse<TResource> : NullableSingleData<ResourceIdentifier<TResource>>
     where TResource : IIdentifiable
 {
-    [Required]
+    // Non-required because the related controller may be unavailable when used in an include.
     [JsonPropertyName("links")]
     public RelationshipLinks Links { get; set; } = null!;
 
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToManyRelationshipInResponse.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToManyRelationshipInResponse.cs
@@ -11,7 +11,7 @@ namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
 internal sealed class ToManyRelationshipInResponse<TResource> : ManyData<ResourceIdentifier<TResource>>
     where TResource : IIdentifiable
 {
-    [Required]
+    // Non-required because the related controller may be unavailable when used in an include.
     [JsonPropertyName("links")]
     public RelationshipLinks Links { get; set; } = null!;
 
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToOneRelationshipInResponse.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/Relationships/ToOneRelationshipInResponse.cs
@@ -1,4 +1,3 @@
-using System.ComponentModel.DataAnnotations;
 using System.Text.Json.Serialization;
 using JetBrains.Annotations;
 using JsonApiDotNetCore.OpenApi.JsonApiObjects.Links;
@@ -11,7 +10,7 @@ namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;
 internal sealed class ToOneRelationshipInResponse<TResource> : SingleData<ResourceIdentifier<TResource>>
     where TResource : IIdentifiable
 {
-    [Required]
+    // Non-required because the related controller may be unavailable when used in an include.
     [JsonPropertyName("links")]
     public RelationshipLinks Links { get; set; } = null!;
 
diff --git a/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/ResourceDataInResponse.cs b/src/JsonApiDotNetCore.OpenApi/JsonApiObjects/ResourceObjects/ResourceDataInResponse.cs
@@ -15,7 +15,7 @@ internal sealed class ResourceDataInResponse<TResource> : ResourceData
     [JsonPropertyName("relationships")]
     public RelationshipsInResponse<TResource> Relationships { get; set; } = null!;
 
-    // This would normally be { "self": "/people/5" } for GET /todoItems/1/assignee, but it is null when PeopleController is unavailable.
+    // Non-required because the related controller may be unavailable when used in an include.
     [JsonPropertyName("links")]
     public ResourceLinks Links { get; set; } = null!;
 
diff --git a/test/OpenApiTests/ClientIdGenerationModes/GeneratedSwagger/swagger.g.json b/test/OpenApiTests/ClientIdGenerationModes/GeneratedSwagger/swagger.g.json
@@ -1098,9 +1098,6 @@
         "additionalProperties": false
       },
       "toManyGameInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -1142,9 +1139,6 @@
         "additionalProperties": false
       },
       "toManyPlayerGroupInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -1186,9 +1180,6 @@
         "additionalProperties": false
       },
       "toManyPlayerInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
diff --git a/test/OpenApiTests/Headers/GeneratedSwagger/swagger.g.json b/test/OpenApiTests/Headers/GeneratedSwagger/swagger.g.json
@@ -1803,9 +1803,6 @@
         "additionalProperties": false
       },
       "toManyLanguageInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
diff --git a/test/OpenApiTests/LegacyOpenApi/GeneratedSwagger/swagger.g.json b/test/OpenApiTests/LegacyOpenApi/GeneratedSwagger/swagger.g.json
@@ -7463,9 +7463,6 @@
         "additionalProperties": false
       },
       "nullable-to-one-flight-attendant-in-response": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -7906,9 +7903,6 @@
         "additionalProperties": false
       },
       "to-many-flight-attendant-in-response": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -7950,9 +7944,6 @@
         "additionalProperties": false
       },
       "to-many-flight-in-response": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -7994,9 +7985,6 @@
         "additionalProperties": false
       },
       "to-many-passenger-in-response": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -8039,9 +8027,6 @@
         "additionalProperties": false
       },
       "to-one-flight-attendant-in-response": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
diff --git a/test/OpenApiTests/LegacyOpenApi/expected-swagger.json b/test/OpenApiTests/LegacyOpenApi/expected-swagger.json
@@ -7463,9 +7463,6 @@
         "additionalProperties": false
       },
       "nullable-to-one-flight-attendant-in-response": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -7906,9 +7903,6 @@
         "additionalProperties": false
       },
       "to-many-flight-attendant-in-response": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -7950,9 +7944,6 @@
         "additionalProperties": false
       },
       "to-many-flight-in-response": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -7994,9 +7985,6 @@
         "additionalProperties": false
       },
       "to-many-passenger-in-response": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -8039,9 +8027,6 @@
         "additionalProperties": false
       },
       "to-one-flight-attendant-in-response": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
diff --git a/test/OpenApiTests/NamingConventions/CamelCase/GeneratedSwagger/swagger.g.json b/test/OpenApiTests/NamingConventions/CamelCase/GeneratedSwagger/swagger.g.json
@@ -2806,9 +2806,6 @@
         "additionalProperties": false
       },
       "nullableToOneStaffMemberInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -3701,9 +3698,6 @@
         "additionalProperties": false
       },
       "toManyStaffMemberInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -3746,9 +3740,6 @@
         "additionalProperties": false
       },
       "toOneStaffMemberInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
diff --git a/test/OpenApiTests/NamingConventions/KebabCase/GeneratedSwagger/swagger.g.json b/test/OpenApiTests/NamingConventions/KebabCase/GeneratedSwagger/swagger.g.json
@@ -2806,9 +2806,6 @@
         "additionalProperties": false
       },
       "nullable-to-one-staff-member-in-response": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -3701,9 +3698,6 @@
         "additionalProperties": false
       },
       "to-many-staff-member-in-response": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -3746,9 +3740,6 @@
         "additionalProperties": false
       },
       "to-one-staff-member-in-response": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
diff --git a/test/OpenApiTests/NamingConventions/PascalCase/GeneratedSwagger/swagger.g.json b/test/OpenApiTests/NamingConventions/PascalCase/GeneratedSwagger/swagger.g.json
@@ -2806,9 +2806,6 @@
         "additionalProperties": false
       },
       "NullableToOneStaffMemberInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -3701,9 +3698,6 @@
         "additionalProperties": false
       },
       "ToManyStaffMemberInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -3746,9 +3740,6 @@
         "additionalProperties": false
       },
       "ToOneStaffMemberInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
diff --git a/test/OpenApiTests/QueryStrings/GeneratedSwagger/swagger.g.json b/test/OpenApiTests/QueryStrings/GeneratedSwagger/swagger.g.json
@@ -4100,9 +4100,6 @@
         "additionalProperties": false
       },
       "nullableToOneNodeInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -4245,9 +4242,6 @@
         "additionalProperties": false
       },
       "toManyNameValuePairInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -4289,9 +4283,6 @@
         "additionalProperties": false
       },
       "toManyNodeInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -4334,9 +4325,6 @@
         "additionalProperties": false
       },
       "toOneNodeInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
diff --git a/test/OpenApiTests/ResourceFieldValidation/NullableReferenceTypesOff/ModelStateValidationOff/GeneratedSwagger/swagger.g.json b/test/OpenApiTests/ResourceFieldValidation/NullableReferenceTypesOff/ModelStateValidationOff/GeneratedSwagger/swagger.g.json
@@ -2864,9 +2864,6 @@
         "additionalProperties": false
       },
       "nullableToOneEmptyInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
@@ -3430,9 +3427,6 @@
         "additionalProperties": false
       },
       "toManyEmptyInResponse": {
-        "required": [
-          "links"
-        ],
         "type": "object",
         "properties": {
           "links": {
diff --git a/test/OpenApiTests/ResourceFieldValidation/NullableReferenceTypesOff/ModelStateValidationOn/GeneratedSwagger/swagger.g.json b/test/OpenApiTests/ResourceFieldValidation/NullableReferenceTypesOff/ModelStateValidationOn/GeneratedSwagger/swagger.g.json
diff --git a/test/OpenApiTests/ResourceFieldValidation/NullableReferenceTypesOn/ModelStateValidationOff/GeneratedSwagger/swagger.g.json b/test/OpenApiTests/ResourceFieldValidation/NullableReferenceTypesOn/ModelStateValidationOff/GeneratedSwagger/swagger.g.json
diff --git a/test/OpenApiTests/ResourceFieldValidation/NullableReferenceTypesOn/ModelStateValidationOn/GeneratedSwagger/swagger.g.json b/test/OpenApiTests/ResourceFieldValidation/NullableReferenceTypesOn/ModelStateValidationOn/GeneratedSwagger/swagger.g.json
diff --git a/test/OpenApiTests/RestrictedControllers/GeneratedSwagger/swagger.g.json b/test/OpenApiTests/RestrictedControllers/GeneratedSwagger/swagger.g.json

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ namespace JsonApiDotNetCore.OpenApi.JsonApiObjects.Relationships;`
`11`	`11`	`internal sealed class NullableToOneRelationshipInResponse<TResource> : NullableSingleData<ResourceIdentifier<TResource>>`
`12`	`12`	`where TResource : IIdentifiable`
`13`	`13`	`{`
`14`		`- [Required]`
	`14`	`+ // Non-required because the related controller may be unavailable when used in an include.`
`15`	`15`	`[JsonPropertyName("links")]`
`16`	`16`	`public RelationshipLinks Links { get; set; } = null!;`
`17`	`17`