Fixed spelling errors (#663)

Author: Bart Koelman

src/Examples/GettingStarted/ResourceDefinitionExample/Model.cs

@@ -5,6 +5,6 @@ namespace GettingStarted.ResourceDefinitionExample
     public class Model : Identifiable
     {
         [Attr]
-        public string DontExpose { get; set; }
+        public string DoNotExpose { get; set; }
     }
-}
+}

src/Examples/GettingStarted/ResourceDefinitionExample/ModelDefinition.cs

@@ -13,7 +13,7 @@ public ModelDefinition(IResourceGraph resourceGraph) : base(resourceGraph)
             // this might be used if the incoming value gets hashed or
             // encrypted prior to being persisted and this value should
             // never be sent back to the client
-            HideFields(model => model.DontExpose);
+            HideFields(model => model.DoNotExpose);
         }
     }
 }

src/Examples/GettingStarted/Startup.cs

@@ -22,7 +22,7 @@ public void ConfigureServices(IServiceCollection services)
 
         public void Configure(IApplicationBuilder app, SampleDbContext context)
         {
-            context.Database.EnsureDeleted(); // indicies need to be reset
+            context.Database.EnsureDeleted(); // indices need to be reset
             app.UseJsonApi();
         }
     }

src/JsonApiDotNetCore/Configuration/DefaultAttributeResponseBehavior.cs

@@ -1,14 +1,14 @@
-namespace JsonApiDotNetCore.Configuration
+namespace JsonApiDotNetCore.Configuration
 {
     /// <summary>
-    /// Allows default valued attributes to be ommitted from the response payload
+    /// Allows default valued attributes to be omitted from the response payload
     /// </summary>
     public struct DefaultAttributeResponseBehavior
     {
 
         /// <param name="omitNullValuedAttributes">Do not serialize default value attributes</param>
         /// <param name="allowClientOverride">
-        /// Allow clients to override the serialization behavior through a query parmeter.
+        /// Allow clients to override the serialization behavior through a query parameter.
         /// <example>
         /// ```
         /// GET /articles?omitDefaultValuedAttributes=true

src/JsonApiDotNetCore/Configuration/ILinksConfiguration.cs

@@ -1,4 +1,4 @@
-using JsonApiDotNetCore.Models.Links;
+using JsonApiDotNetCore.Models.Links;
 
 namespace JsonApiDotNetCore.Configuration
 {
@@ -33,20 +33,20 @@ public interface ILinksConfiguration
         /// <summary>
         /// Configures globally which links to show in the <see cref="TopLevelLinks"/>
         /// object for a requested resource. Setting can be overriden per resource by
-        /// adding a <see cref="LinksAttribute"/> to the class definitio of that resource.
+        /// adding a <see cref="LinksAttribute"/> to the class definition of that resource.
         /// </summary>
         Link TopLevelLinks { get; }
 
         /// <summary>
         /// Configures globally which links to show in the <see cref="ResourceLinks"/>
         /// object for a requested resource. Setting can be overriden per resource by
-        /// adding a <see cref="LinksAttribute"/> to the class definitio of that resource.
+        /// adding a <see cref="LinksAttribute"/> to the class definition of that resource.
         /// </summary>
         Link ResourceLinks { get; }
         /// <summary>
         /// Configures globally which links to show in the <see cref="RelationshipLinks"/>
         /// object for a requested resource. Setting can be overriden per resource by
-        /// adding a <see cref="LinksAttribute"/> to the class definitio of that resource.
+        /// adding a <see cref="LinksAttribute"/> to the class definition of that resource.
         /// Option can also be specified per relationship by using the associated links argument
         /// in the constructor of <see cref="RelationshipAttribute"/>.
         /// </summary>
@@ -68,4 +68,4 @@ public interface ILinksConfiguration
         Link RelationshipLinks { get; }
 
     }
-}
+}

src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs

@@ -83,7 +83,7 @@ public class JsonApiOptions : IJsonApiOptions
         /// <summary>
         /// Whether or not clients can provide ids when creating resources.
         /// Defaults to false.  When disabled the application will respond 
-        /// with a 403 Forbidden respponse if a client attempts to create a 
+        /// with a 403 Forbidden response if a client attempts to create a 
         /// resource with a defined id.
         /// </summary>
         /// <example>

src/JsonApiDotNetCore/Configuration/NullAttributeResponseBehavior.cs

@@ -1,13 +1,13 @@
 namespace JsonApiDotNetCore.Configuration
 {
     /// <summary>
-    /// Allows null attributes to be ommitted from the response payload
+    /// Allows null attributes to be omitted from the response payload
     /// </summary>
     public struct NullAttributeResponseBehavior
     {
         /// <param name="omitNullValuedAttributes">Do not serialize null attributes</param>
         /// <param name="allowClientOverride">
-        /// Allow clients to override the serialization behavior through a query parmeter.
+        /// Allow clients to override the serialization behavior through a query parameter.
         /// <example>
         /// ```
         /// GET /articles?omitNullValuedAttributes=true

src/JsonApiDotNetCore/Data/DefaultResourceRepository.cs

@@ -147,7 +147,7 @@ private bool IsHasOneRelationship(string internalRelationshipName, Type type)
                 return false;
             }
             // relationshipAttr is null when we don't put a [RelationshipAttribute] on the inverse navigation property.
-            // In this case we use relfection to figure out what kind of relationship is pointing back.
+            // In this case we use reflection to figure out what kind of relationship is pointing back.
             return !type.GetProperty(internalRelationshipName).PropertyType.Inherits(typeof(IEnumerable));
         }
 
@@ -359,12 +359,12 @@ public async Task<IReadOnlyList<TResource>> ToListAsync(IQueryable<TResource> en
 
         /// <summary>
         /// Before assigning new relationship values (UpdateAsync), we need to
-        /// attach the current database values of the relationship to the dbcontext, else 
+        /// attach the current database values of the relationship to the dbContext, else 
         /// it will not perform a complete-replace which is required for 
         /// one-to-many and many-to-many.
         /// <para />
-        /// For example: a person `p1` has 2 todoitems: `t1` and `t2`.
-        /// If we want to update this todoitem set to `t3` and `t4`, simply assigning
+        /// For example: a person `p1` has 2 todo-items: `t1` and `t2`.
+        /// If we want to update this todo-item set to `t3` and `t4`, simply assigning
         /// `p1.todoItems = [t3, t4]` will result in EF Core adding them to the set,
         /// resulting in `[t1 ... t4]`. Instead, we should first include `[t1, t2]`,
         /// after which the reassignment  `p1.todoItems = [t3, t4]` will actually 
@@ -383,7 +383,7 @@ protected void LoadCurrentRelationships(TResource oldEntity, RelationshipAttribu
         }
 
         /// <summary>
-        /// Given a iidentifiable relationshipvalue, verify if an entity of the underlying 
+        /// Given a IIdentifiable relationship value, verify if an entity of the underlying 
         /// type with the same ID is already attached to the dbContext, and if so, return it.
         /// If not, attach the relationship value to the dbContext.
         /// 

src/JsonApiDotNetCore/Extensions/IServiceCollectionExtensions.cs

@@ -76,7 +76,7 @@ public static IServiceCollection AddResourceService<T>(this IServiceCollection s
             {
                 foreach (var openGenericType in ServiceDiscoveryFacade.ServiceInterfaces)
                 {
-                    // A shorthand interface is one where the id type is ommitted
+                    // A shorthand interface is one where the id type is omitted
                     // e.g. IResourceService<T> is the shorthand for IResourceService<T, TId>
                     var isShorthandInterface = (openGenericType.GetTypeInfo().GenericTypeParameters.Length == 1);
                     if (isShorthandInterface && resourceDescriptor.IdType != typeof(int))
@@ -102,7 +102,7 @@ public static IServiceCollection AddResourceService<T>(this IServiceCollection s
 
         private static HashSet<ResourceDescriptor> GetResourceTypesFromServiceImplementation(Type type)
         {
-            var resourceDecriptors = new HashSet<ResourceDescriptor>();
+            var resourceDescriptors = new HashSet<ResourceDescriptor>();
             var interfaces = type.GetInterfaces();
             foreach (var i in interfaces)
             {
@@ -111,11 +111,11 @@ private static HashSet<ResourceDescriptor> GetResourceTypesFromServiceImplementa
                     var firstGenericArgument = i.GenericTypeArguments.FirstOrDefault();
                     if (TypeLocator.TryGetResourceDescriptor(firstGenericArgument, out var resourceDescriptor) == true)
                     {
-                        resourceDecriptors.Add(resourceDescriptor);
+                        resourceDescriptors.Add(resourceDescriptor);
                     }
                 }
             }
-            return resourceDecriptors;
+            return resourceDescriptors;
         }
     }
 }

src/JsonApiDotNetCore/Formatters/JsonApiWriter.cs

@@ -13,7 +13,7 @@ namespace JsonApiDotNetCore.Formatters
     /// <summary>
     /// Formats the response data used  https://docs.microsoft.com/en-us/aspnet/core/web-api/advanced/formatting?view=aspnetcore-3.0.
     /// It was intended to have as little dependencies as possible in formatting layer for greater extensibility.
-    /// It onls depends on <see cref="IJsonApiSerializer"/>.
+    /// It only depends on <see cref="IJsonApiSerializer"/>.
     /// </summary>
     public class JsonApiWriter : IJsonApiWriter
     {
@@ -57,7 +57,7 @@ public async Task WriteAsync(OutputFormatterWriteContext context)
                 }
                 catch (Exception e)
                 {
-                    _logger?.LogError(new EventId(), e, "An error ocurred while formatting the response");
+                    _logger?.LogError(new EventId(), e, "An error occurred while formatting the response");
                     var errors = new ErrorCollection();
                     errors.Add(new Error(500, e.Message, ErrorMeta.FromException(e)));
                     responseContent = _serializer.Serialize(errors);