- Replaced ResourceContext with ResourceType and calls to ResourceType.ClrType

    - Applied NRT
    - Renamed methods that used TryXXX pattern
    - For files in JsonApiObjects folder: instead of adding null! to every property assignment, decided to disable the warning here. This seems reasonable these types have been introduces with the guarantee they will not be instantiated. They only exist to pass static type information to the ApiExplorer.

Author: maurei

src/JsonApiDotNetCore.OpenApi.Client/ArgumentGuard.cs

@@ -1,5 +1,6 @@
 using System;
 using JetBrains.Annotations;
+using SysNotNull = System.Diagnostics.CodeAnalysis.NotNullAttribute;
 
 #pragma warning disable AV1008 // Class should not be static
 
@@ -8,8 +9,7 @@ namespace JsonApiDotNetCore.OpenApi.Client
     internal static class ArgumentGuard
     {
         [AssertionMethod]
-        [ContractAnnotation("value: null => halt")]
-        public static void NotNull<T>([CanBeNull] [NoEnumeration] T value, [NotNull] [InvokerParameterName] string name)
+        public static void NotNull<T>([NoEnumeration] [SysNotNull] T? value, [InvokerParameterName] string name)
             where T : class
         {
             if (value is null)

src/JsonApiDotNetCore.OpenApi.Client/IJsonApiClient.cs

@@ -32,7 +32,7 @@ public interface IJsonApiClient
         /// <c>using</c> statement, so the registrations are cleaned up after executing the request.
         /// </returns>
         IDisposable RegisterAttributesForRequestDocument<TRequestDocument, TAttributesObject>(TRequestDocument requestDocument,
-            params Expression<Func<TAttributesObject, object>>[] alwaysIncludedAttributeSelectors)
+            params Expression<Func<TAttributesObject, object?>>[] alwaysIncludedAttributeSelectors)
             where TRequestDocument : class;
     }
 }

src/JsonApiDotNetCore.OpenApi.Client/JsonApiClient.cs

@@ -27,14 +27,14 @@ protected void SetSerializerSettingsForJsonApi(JsonSerializerSettings settings)
 
         /// <inheritdoc />
         public IDisposable RegisterAttributesForRequestDocument<TRequestDocument, TAttributesObject>(TRequestDocument requestDocument,
-            params Expression<Func<TAttributesObject, object>>[] alwaysIncludedAttributeSelectors)
+            params Expression<Func<TAttributesObject, object?>>[] alwaysIncludedAttributeSelectors)
             where TRequestDocument : class
         {
             ArgumentGuard.NotNull(requestDocument, nameof(requestDocument));
 
             var attributeNames = new HashSet<string>();
 
-            foreach (Expression<Func<TAttributesObject, object>> selector in alwaysIncludedAttributeSelectors)
+            foreach (Expression<Func<TAttributesObject, object?>> selector in alwaysIncludedAttributeSelectors)
             {
                 if (RemoveConvert(selector.Body) is MemberExpression selectorBody)
                 {

src/JsonApiDotNetCore.OpenApi/ActionDescriptorExtensions.cs

@@ -16,22 +16,22 @@ public static MethodInfo GetActionMethod(this ActionDescriptor descriptor)
             return ((ControllerActionDescriptor)descriptor).MethodInfo;
         }
 
-        public static TFilterMetaData GetFilterMetadata<TFilterMetaData>(this ActionDescriptor descriptor)
+        public static TFilterMetaData? GetFilterMetadata<TFilterMetaData>(this ActionDescriptor descriptor)
             where TFilterMetaData : IFilterMetadata
         {
             ArgumentGuard.NotNull(descriptor, nameof(descriptor));
 
-            IFilterMetadata filterMetadata = descriptor.FilterDescriptors.Select(filterDescriptor => filterDescriptor.Filter)
+            IFilterMetadata? filterMetadata = descriptor.FilterDescriptors.Select(filterDescriptor => filterDescriptor.Filter)
                 .FirstOrDefault(filter => filter is TFilterMetaData);
 
-            return (TFilterMetaData)filterMetadata;
+            return (TFilterMetaData?)filterMetadata;
         }
 
-        public static ControllerParameterDescriptor GetBodyParameterDescriptor(this ActionDescriptor descriptor)
+        public static ControllerParameterDescriptor? GetBodyParameterDescriptor(this ActionDescriptor descriptor)
         {
             ArgumentGuard.NotNull(descriptor, nameof(descriptor));
 
-            return (ControllerParameterDescriptor)descriptor.Parameters.FirstOrDefault(parameterDescriptor =>
+            return (ControllerParameterDescriptor?)descriptor.Parameters.FirstOrDefault(parameterDescriptor =>
                 // ReSharper disable once ConstantConditionalAccessQualifier        Motivation: see https://github.com/dotnet/aspnetcore/issues/32538
                 parameterDescriptor.BindingInfo?.BindingSource == BindingSource.Body);
         }

src/JsonApiDotNetCore.OpenApi/JsonApiActionDescriptorCollectionProvider.cs

@@ -67,7 +67,7 @@ private static bool IsVisibleJsonApiEndpoint(ActionDescriptor descriptor)
             return descriptor is ControllerActionDescriptor controllerAction && controllerAction.Properties.ContainsKey(typeof(ApiDescriptionActionData));
         }
 
-        private static IList<ActionDescriptor> AddJsonApiMetadataToAction(ActionDescriptor endpoint, IJsonApiEndpointMetadata jsonApiEndpointMetadata)
+        private static IList<ActionDescriptor> AddJsonApiMetadataToAction(ActionDescriptor endpoint, IJsonApiEndpointMetadata? jsonApiEndpointMetadata)
         {
             switch (jsonApiEndpointMetadata)
             {
@@ -102,16 +102,16 @@ private static void UpdateProducesResponseTypeAttribute(ActionDescriptor endpoin
         {
             if (ProducesJsonApiResponseBody(endpoint))
             {
-                var producesResponse = endpoint.GetFilterMetadata<ProducesResponseTypeAttribute>();
+                var producesResponse = endpoint.GetFilterMetadata<ProducesResponseTypeAttribute>()!;
                 producesResponse.Type = responseTypeToSet;
             }
         }
 
         private static bool ProducesJsonApiResponseBody(ActionDescriptor endpoint)
         {
-            var produces = endpoint.GetFilterMetadata<ProducesAttribute>();
+            var produces = endpoint.GetFilterMetadata<ProducesAttribute>()!;
 
-            return produces != null && produces.ContentTypes.Any(contentType => contentType == HeaderConstants.MediaType);
+            return produces.ContentTypes.Any(contentType => contentType == HeaderConstants.MediaType);
         }
 
         private static IList<ActionDescriptor> Expand(ActionDescriptor genericEndpoint, ExpansibleEndpointMetadata metadata,
@@ -123,7 +123,7 @@ private static IList<ActionDescriptor> Expand(ActionDescriptor genericEndpoint,
             {
                 ActionDescriptor expandedEndpoint = Clone(genericEndpoint);
                 RemovePathParameter(expandedEndpoint.Parameters, JsonApiPathParameter.RelationshipName);
-                ExpandTemplate(expandedEndpoint.AttributeRouteInfo, relationshipName);
+                ExpandTemplate(expandedEndpoint.AttributeRouteInfo!, relationshipName);
 
                 expansionCallback(expandedEndpoint, relationshipType, relationshipName);
 
@@ -133,9 +133,9 @@ private static IList<ActionDescriptor> Expand(ActionDescriptor genericEndpoint,
             return expansion;
         }
 
-        private static void UpdateBodyParameterDescriptor(ActionDescriptor endpoint, Type bodyType, string parameterName = null)
+        private static void UpdateBodyParameterDescriptor(ActionDescriptor endpoint, Type bodyType, string? parameterName = null)
         {
-            ControllerParameterDescriptor requestBodyDescriptor = endpoint.GetBodyParameterDescriptor();
+            ControllerParameterDescriptor requestBodyDescriptor = endpoint.GetBodyParameterDescriptor()!;
             requestBodyDescriptor.ParameterType = bodyType;
             ParameterInfo replacementParameterInfo = requestBodyDescriptor.ParameterInfo.WithParameterType(bodyType);
 
@@ -151,7 +151,7 @@ private static ActionDescriptor Clone(ActionDescriptor descriptor)
         {
             var clonedDescriptor = (ActionDescriptor)descriptor.MemberwiseClone();
 
-            clonedDescriptor.AttributeRouteInfo = (AttributeRouteInfo)descriptor.AttributeRouteInfo.MemberwiseClone();
+            clonedDescriptor.AttributeRouteInfo = (AttributeRouteInfo)descriptor.AttributeRouteInfo!.MemberwiseClone();
 
             clonedDescriptor.FilterDescriptors = new List<FilterDescriptor>();
 

src/JsonApiDotNetCore.OpenApi/JsonApiMetadata/EndpointResolver.cs

@@ -18,7 +18,7 @@ internal sealed class EndpointResolver
                 return null;
             }
 
-            HttpMethodAttribute method = controllerAction.GetCustomAttributes(true).OfType<HttpMethodAttribute>().FirstOrDefault();
+            HttpMethodAttribute? method = controllerAction.GetCustomAttributes(true).OfType<HttpMethodAttribute>().FirstOrDefault();
 
             return ResolveJsonApiEndpoint(method);
         }
@@ -33,7 +33,7 @@ private static bool IsOperationsController(MethodInfo controllerAction)
             return typeof(BaseJsonApiOperationsController).IsAssignableFrom(controllerAction.ReflectedType);
         }
 
-        private static JsonApiEndpoint? ResolveJsonApiEndpoint(HttpMethodAttribute httpMethod)
+        private static JsonApiEndpoint? ResolveJsonApiEndpoint(HttpMethodAttribute? httpMethod)
         {
             return httpMethod switch
             {

src/JsonApiDotNetCore.OpenApi/JsonApiMetadata/JsonApiEndpointMetadataContainer.cs

@@ -5,8 +5,8 @@ namespace JsonApiDotNetCore.OpenApi.JsonApiMetadata
     /// </summary>
     internal sealed class JsonApiEndpointMetadataContainer
     {
-        public IJsonApiRequestMetadata RequestMetadata { get; init; }
+        public IJsonApiRequestMetadata? RequestMetadata { get; init; }
 
-        public IJsonApiResponseMetadata ResponseMetadata { get; init; }
+        public IJsonApiResponseMetadata? ResponseMetadata { get; init; }
     }
 }

src/JsonApiDotNetCore.OpenApi/JsonApiMetadata/JsonApiEndpointMetadataProvider.cs

@@ -40,16 +40,16 @@ public JsonApiEndpointMetadataContainer Get(MethodInfo controllerAction)
                 throw new NotSupportedException($"Unable to provide metadata for non-JsonApiDotNetCore endpoint '{controllerAction.ReflectedType!.FullName}'.");
             }
 
-            Type primaryResourceType = _controllerResourceMapping.GetResourceTypeForController(controllerAction.ReflectedType);
+            ResourceType primaryResourceType = _controllerResourceMapping.GetResourceTypeForController(controllerAction.ReflectedType)!;
 
             return new JsonApiEndpointMetadataContainer
             {
-                RequestMetadata = GetRequestMetadata(endpoint.Value, primaryResourceType),
-                ResponseMetadata = GetResponseMetadata(endpoint.Value, primaryResourceType)
+                RequestMetadata = GetRequestMetadata(endpoint.Value, primaryResourceType.ClrType),
+                ResponseMetadata = GetResponseMetadata(endpoint.Value, primaryResourceType.ClrType)
             };
         }
 
-        private IJsonApiRequestMetadata GetRequestMetadata(JsonApiEndpoint endpoint, Type primaryResourceType)
+        private IJsonApiRequestMetadata? GetRequestMetadata(JsonApiEndpoint endpoint, Type primaryResourceType)
         {
             switch (endpoint)
             {
@@ -76,23 +76,21 @@ private IJsonApiRequestMetadata GetRequestMetadata(JsonApiEndpoint endpoint, Typ
 
         private static PrimaryRequestMetadata GetPostRequestMetadata(Type primaryResourceType)
         {
-            return new()
-            {
-                Type = typeof(ResourcePostRequestDocument<>).MakeGenericType(primaryResourceType)
-            };
+            Type documentType = typeof(ResourcePostRequestDocument<>).MakeGenericType(primaryResourceType);
+
+            return new PrimaryRequestMetadata(documentType);
         }
 
         private static PrimaryRequestMetadata GetPatchRequestMetadata(Type primaryResourceType)
         {
-            return new()
-            {
-                Type = typeof(ResourcePatchRequestDocument<>).MakeGenericType(primaryResourceType)
-            };
+            Type documentType = typeof(ResourcePatchRequestDocument<>).MakeGenericType(primaryResourceType);
+
+            return new PrimaryRequestMetadata(documentType);
         }
 
         private RelationshipRequestMetadata GetRelationshipRequestMetadata(Type primaryResourceType, bool ignoreHasOneRelationships)
         {
-            IEnumerable<RelationshipAttribute> relationships = _resourceGraph.GetResourceContext(primaryResourceType).Relationships;
+            IEnumerable<RelationshipAttribute> relationships = _resourceGraph.GetResourceType(primaryResourceType).Relationships;
 
             if (ignoreHasOneRelationships)
             {
@@ -101,16 +99,13 @@ private RelationshipRequestMetadata GetRelationshipRequestMetadata(Type primaryR
 
             IDictionary<string, Type> resourceTypesByRelationshipName = relationships.ToDictionary(relationship => relationship.PublicName,
                 relationship => relationship is HasManyAttribute
-                    ? typeof(ToManyRelationshipRequestData<>).MakeGenericType(relationship.RightType)
-                    : typeof(ToOneRelationshipRequestData<>).MakeGenericType(relationship.RightType));
+                    ? typeof(ToManyRelationshipRequestData<>).MakeGenericType(relationship.RightType.ClrType)
+                    : typeof(ToOneRelationshipRequestData<>).MakeGenericType(relationship.RightType.ClrType));
 
-            return new RelationshipRequestMetadata
-            {
-                RequestBodyTypeByRelationshipName = resourceTypesByRelationshipName
-            };
+            return new RelationshipRequestMetadata(resourceTypesByRelationshipName);
         }
 
-        private IJsonApiResponseMetadata GetResponseMetadata(JsonApiEndpoint endpoint, Type primaryResourceType)
+        private IJsonApiResponseMetadata? GetResponseMetadata(JsonApiEndpoint endpoint, Type primaryResourceType)
         {
             switch (endpoint)
             {
@@ -138,12 +133,10 @@ private IJsonApiResponseMetadata GetResponseMetadata(JsonApiEndpoint endpoint, T
 
         private static PrimaryResponseMetadata GetPrimaryResponseMetadata(Type primaryResourceType, bool endpointReturnsCollection)
         {
-            Type documentType = endpointReturnsCollection ? typeof(ResourceCollectionResponseDocument<>) : typeof(PrimaryResourceResponseDocument<>);
+            Type documentOpenType = endpointReturnsCollection ? typeof(ResourceCollectionResponseDocument<>) : typeof(PrimaryResourceResponseDocument<>);
+            Type documentType = documentOpenType.MakeGenericType(primaryResourceType);
 
-            return new PrimaryResponseMetadata
-            {
-                Type = documentType.MakeGenericType(primaryResourceType)
-            };
+            return new PrimaryResponseMetadata(documentType);
         }
 
         private SecondaryResponseMetadata GetSecondaryResponseMetadata(Type primaryResourceType)
@@ -154,19 +147,16 @@ private SecondaryResponseMetadata GetSecondaryResponseMetadata(Type primaryResou
                     ? typeof(ResourceCollectionResponseDocument<>)
                     : typeof(SecondaryResourceResponseDocument<>);
 
-                return documentType.MakeGenericType(relationship.RightType);
+                return documentType.MakeGenericType(relationship.RightType.ClrType);
             });
 
-            return new SecondaryResponseMetadata
-            {
-                ResponseTypesByRelationshipName = responseTypesByRelationshipName
-            };
+            return new SecondaryResponseMetadata(responseTypesByRelationshipName);
         }
 
         private IDictionary<string, Type> GetMetadataByRelationshipName(Type primaryResourceType,
             Func<RelationshipAttribute, Type> extractRelationshipMetadataCallback)
         {
-            IReadOnlyCollection<RelationshipAttribute> relationships = _resourceGraph.GetResourceContext(primaryResourceType).Relationships;
+            IReadOnlyCollection<RelationshipAttribute> relationships = _resourceGraph.GetResourceType(primaryResourceType).Relationships;
 
             return relationships.ToDictionary(relationship => relationship.PublicName, extractRelationshipMetadataCallback);
         }
@@ -175,13 +165,10 @@ private RelationshipResponseMetadata GetRelationshipResponseMetadata(Type primar
         {
             IDictionary<string, Type> responseTypesByRelationshipName = GetMetadataByRelationshipName(primaryResourceType,
                 relationship => relationship is HasManyAttribute
-                    ? typeof(ResourceIdentifierCollectionResponseDocument<>).MakeGenericType(relationship.RightType)
-                    : typeof(ResourceIdentifierResponseDocument<>).MakeGenericType(relationship.RightType));
+                    ? typeof(ResourceIdentifierCollectionResponseDocument<>).MakeGenericType(relationship.RightType.ClrType)
+                    : typeof(ResourceIdentifierResponseDocument<>).MakeGenericType(relationship.RightType.ClrType));
 
-            return new RelationshipResponseMetadata
-            {
-                ResponseTypesByRelationshipName = responseTypesByRelationshipName
-            };
+            return new RelationshipResponseMetadata(responseTypesByRelationshipName);
         }
     }
 }

src/JsonApiDotNetCore.OpenApi/JsonApiMetadata/PrimaryRequestMetadata.cs

@@ -4,6 +4,11 @@ namespace JsonApiDotNetCore.OpenApi.JsonApiMetadata
 {
     internal sealed class PrimaryRequestMetadata : IJsonApiRequestMetadata
     {
-        public Type Type { get; init; }
+        public Type Type { get; }
+
+        public PrimaryRequestMetadata(Type type)
+        {
+            Type = type;
+        }
     }
 }

src/JsonApiDotNetCore.OpenApi/JsonApiMetadata/PrimaryResponseMetadata.cs

@@ -4,6 +4,11 @@ namespace JsonApiDotNetCore.OpenApi.JsonApiMetadata
 {
     internal sealed class PrimaryResponseMetadata : IJsonApiResponseMetadata
     {
-        public Type Type { get; init; }
+        public Type Type { get; }
+
+        public PrimaryResponseMetadata(Type type)
+        {
+            Type = type;
+        }
     }
 }