Updated documentation to match with new style

Author: Bart Koelman

README.md

@@ -42,7 +42,7 @@ See [our documentation](https://www.jsonapi.net/) for detailed usage.
 
 ### Models
 
-```csharp
+```c#
 public class Article : Identifiable
 {
     [Attr]
@@ -52,7 +52,7 @@ public class Article : Identifiable
 
 ### Controllers
 
-```csharp
+```c#
 public class ArticlesController : JsonApiController<Article>
 {
     public ArticlesController(IJsonApiOptions options, IResourceService<Article> resourceService,
@@ -65,7 +65,7 @@ public class ArticlesController : JsonApiController<Article>
 
 ### Middleware
 
-```csharp
+```c#
 public class Startup
 {
     public IServiceProvider ConfigureServices(IServiceCollection services)

docs/README.md

@@ -4,15 +4,18 @@ In addition, the example request/response pairs are generated by executing `curl
 
 # Installation
 Run the following commands once to setup your system:
+
 ```
 choco install docfx -y
 ```
+
 ```
 npm install -g httpserver
 ```
 
 # Running
 The next command regenerates the documentation website and opens it in your default browser:
+
 ```
 pwsh ./build-dev.ps1
 ```

docs/getting-started/install.md

@@ -3,16 +3,19 @@
 Click [here](https://www.nuget.org/packages/JsonApiDotnetCore/) for the latest NuGet version.
 
 ### CLI
+
 ```
 dotnet add package JsonApiDotnetCore
 ```
 
 ### Visual Studio
+
 ```powershell
 Install-Package JsonApiDotnetCore
 ```
 
 ### *.csproj
+
 ```xml
 <ItemGroup>
   <!-- Be sure to check NuGet for the latest version # -->

docs/getting-started/step-by-step.md

@@ -53,7 +53,9 @@ Nothing special here, just an ordinary `DbContext`
 public class AppDbContext : DbContext
 {
     public AppDbContext(DbContextOptions<AppDbContext> options)
-        : base(options) { }
+        : base(options)
+    {
+    }
 
     public DbSet<Person> People { get; set; }
 }
@@ -67,12 +69,11 @@ where `TResource` is the model that inherits from `Identifiable<TId>`
 ```c#
 public class PeopleController : JsonApiController<Person>
 {
-    public PeopleController(
-        IJsonApiOptions options,
-        ILoggerFactory loggerFactory,
+    public PeopleController(IJsonApiOptions options, ILoggerFactory loggerFactory,
         IResourceService<Person> resourceService)
-    : base(options, loggerFactory, resourceService)
-    { }
+        : base(options, loggerFactory, resourceService)
+    {
+    }
 }
 ```
 
@@ -123,6 +124,7 @@ public void Configure(IApplicationBuilder app, AppDbContext context)
         {
             Name = "John Doe"
         });
+
         context.SaveChanges();
     }
 

docs/usage/errors.md

@@ -5,6 +5,7 @@ You can create a custom error by throwing a `JsonApiException` (which accepts an
 Please keep in mind that JSON:API requires Title to be a generic message, while Detail should contain information about the specific problem occurence.
 
 From a controller method:
+
 ```c#
 return Conflict(new Error(HttpStatusCode.Conflict)
 {
@@ -14,6 +15,7 @@ return Conflict(new Error(HttpStatusCode.Conflict)
 ```
 
 From other code:
+
 ```c#
 throw new JsonApiException(new Error(HttpStatusCode.Conflict)
 {

docs/usage/extensibility/controllers.md

@@ -5,12 +5,11 @@ You need to create controllers that inherit from `JsonApiController<TResource>`
 ```c#
 public class ArticlesController : JsonApiController<Article>
 {
-    public ArticlesController(
-        IJsonApiOptions options,
-        ILoggerFactory loggerFactory,
+    public ArticlesController(IJsonApiOptions options, ILoggerFactory loggerFactory,
         IResourceService<Article> resourceService)
         : base(options, loggerFactory, resourceService)
-    { }
+    {
+    }
 }
 ```
 
@@ -22,13 +21,12 @@ If your model is using a type other than `int` for the primary key, you must exp
 public class ArticlesController : JsonApiController<Article, Guid>
 //---------------------------------------------------------- ^^^^
 {
-    public ArticlesController(
-        IJsonApiOptions options,
-        ILoggerFactory loggerFactory,
+    public ArticlesController(IJsonApiOptions options, ILoggerFactory loggerFactory,
         IResourceService<Article, Guid> resourceService)
         //----------------------- ^^^^
         : base(options, loggerFactory, resourceService)
-    { }
+    {
+    }
 }
 ```
 
@@ -43,12 +41,11 @@ This approach is ok, but introduces some boilerplate that can easily be avoided.
 ```c#
 public class ArticlesController : BaseJsonApiController<Article>
 {
-    public ArticlesController(
-        IJsonApiOptions options,
-        ILoggerFactory loggerFactory,
+    public ArticlesController(IJsonApiOptions options, ILoggerFactory loggerFactory,
         IResourceService<Article> resourceService)
         : base(options, loggerFactory, resourceService)
-    { }
+    {
+    }
 
     [HttpGet]
     public override async Task<IActionResult> GetAsync(CancellationToken cancellationToken)
@@ -80,12 +77,11 @@ An attempt to use one of the blacklisted methods will result in a HTTP 405 Metho
 [HttpReadOnly]
 public class ArticlesController : BaseJsonApiController<Article>
 {
-    public ArticlesController(
-        IJsonApiOptions options,
-        ILoggerFactory loggerFactory,
+    public ArticlesController(IJsonApiOptions options, ILoggerFactory loggerFactory,
         IResourceService<Article> resourceService)
         : base(options, loggerFactory, resourceService)
-    { }
+    {
+    }
 }
 ```
 
@@ -100,12 +96,11 @@ For more information about resource injection, see the next section titled Resou
 ```c#
 public class ReportsController : BaseJsonApiController<Report>
 {
-    public ReportsController(
-        IJsonApiOptions options,
-        ILoggerFactory loggerFactory,
+    public ReportsController(IJsonApiOptions options, ILoggerFactory loggerFactory,
         IResourceService<Report> resourceService)
         : base(options, loggerFactory, resourceService)
-    { }
+    {
+    }
 
     [HttpGet]
     public override async Task<IActionResult> GetAsync(CancellationToken cancellationToken)

docs/usage/extensibility/middleware.md

@@ -5,14 +5,16 @@ It is possible to replace JsonApiDotNetCore middleware components by configuring
 ## Configuring the IoC container 
 
 The following example replaces the internal exception filter with a custom implementation.
+
 ```c#
 /// In Startup.ConfigureServices
-services.AddService<IAsyncJsonApiExceptionFilter, CustomAsyncExceptionFilter>()
+services.AddService<IAsyncJsonApiExceptionFilter, CustomAsyncExceptionFilter>();
 ```
 
 ## Configuring `MvcOptions`
 
 The following example replaces all internal filters with a custom filter.
+
 ```c#
 public class Startup
 {
@@ -22,7 +24,7 @@ public class Startup
     {
         services.AddSingleton<CustomAsyncQueryStringActionFilter>();
 
-        var builder = services.AddMvcCore();
+        IMvcCoreBuilder builder = services.AddMvcCore();
         services.AddJsonApi<AppDbContext>(mvcBuilder: builder);
 
         // Ensure this call is placed after the AddJsonApi call.
@@ -35,8 +37,8 @@ public class Startup
     public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
     {
         // Ensure this call is placed before the UseEndpoints call.
-        _postConfigureMvcOptions = mvcOptions => 
-        { 
+        _postConfigureMvcOptions = mvcOptions =>
+        {
             mvcOptions.Filters.Clear();
             mvcOptions.Filters.Insert(0,
                 app.ApplicationServices.GetService<CustomAsyncQueryStringActionFilter>());

docs/usage/extensibility/repositories.md

@@ -36,12 +36,9 @@ public class ArticleRepository : EntityFrameworkCoreRepository<Article>
 {
     private readonly IAuthenticationService _authenticationService;
 
-    public ArticleRepository(
-        IAuthenticationService authenticationService,
-        ITargetedFields targetedFields,
-        IDbContextResolver contextResolver,
-        IResourceGraph resourceGraph,
-        IGenericServiceFactory genericServiceFactory,
+    public ArticleRepository(IAuthenticationService authenticationService,
+        ITargetedFields targetedFields, IDbContextResolver contextResolver,
+        IResourceGraph resourceGraph, IGenericServiceFactory genericServiceFactory,
         IResourceFactory resourceFactory,
         IEnumerable<IQueryConstraintProvider> constraintProviders,
         ILoggerFactory loggerFactory)
@@ -68,13 +65,15 @@ This example shows a single `DbContextARepository` for all entities that are mem
 public class DbContextARepository<TResource> : EntityFrameworkCoreRepository<TResource>
     where TResource : class, IIdentifiable<int>
 {
-    public DbContextARepository(ITargetedFields targetedFields, DbContextResolver<DbContextA> contextResolver,
-        //                                                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    public DbContextARepository(ITargetedFields targetedFields,
+        DbContextResolver<DbContextA> contextResolver,
+    //  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
         IResourceGraph resourceGraph, IGenericServiceFactory genericServiceFactory,
-        IResourceFactory resourceFactory, IEnumerable<IQueryConstraintProvider> constraintProviders,
+        IResourceFactory resourceFactory,
+        IEnumerable<IQueryConstraintProvider> constraintProviders,
         ILoggerFactory loggerFactory)
-        : base(targetedFields, contextResolver, resourceGraph, genericServiceFactory, resourceFactory,
-            constraintProviders, loggerFactory)
+        : base(targetedFields, contextResolver, resourceGraph, genericServiceFactory,
+            resourceFactory, constraintProviders, loggerFactory)
     {
     }
 }
@@ -91,5 +90,5 @@ services.AddDbContext<DbContextB>(options => options.UseSqlite("Data Source=B.db
 services.AddScoped<IResourceRepository<ResourceA>, DbContextARepository<ResourceA>>();
 services.AddScoped<IResourceRepository<ResourceB>, DbContextBRepository<ResourceB>>();
 
-services.AddJsonApi(dbContextTypes: new[] {typeof(DbContextA), typeof(DbContextB)});
+services.AddJsonApi(dbContextTypes: new[] { typeof(DbContextA), typeof(DbContextB) });
 ```

docs/usage/extensibility/services.md

@@ -15,22 +15,19 @@ public class TodoItemService : JsonApiResourceService<TodoItem>
 {
     private readonly INotificationService _notificationService;
 
-    public TodoItemService(
-        IResourceRepositoryAccessor repositoryAccessor,
-        IQueryLayerComposer queryLayerComposer,
-        IPaginationContext paginationContext,
-        IJsonApiOptions options,
-        ILoggerFactory loggerFactory,
-        IJsonApiRequest request,
+    public TodoItemService(IResourceRepositoryAccessor repositoryAccessor,
+        IQueryLayerComposer queryLayerComposer, IPaginationContext paginationContext,
+        IJsonApiOptions options, ILoggerFactory loggerFactory, IJsonApiRequest request,
         IResourceChangeTracker<TodoItem> resourceChangeTracker,
         IResourceHookExecutorFacade hookExecutor)
-        : base(repositoryAccessor, queryLayerComposer, paginationContext, options, loggerFactory,
-            request, resourceChangeTracker, hookExecutor)
+        : base(repositoryAccessor, queryLayerComposer, paginationContext, options,
+            loggerFactory, request, resourceChangeTracker, hookExecutor)
     {
         _notificationService = notificationService;
     }
 
-    public override async Task<TodoItem> CreateAsync(TodoItem resource, CancellationToken cancellationToken)
+    public override async Task<TodoItem> CreateAsync(TodoItem resource,
+        CancellationToken cancellationToken)
     {
         // Call the base implementation
         var newResource = await base.CreateAsync(resource, cancellationToken);
@@ -69,7 +66,8 @@ public class ProductService : IResourceService<Product>
         _dao = dao;
     }
 
-    public async Task<IReadOnlyCollection<Product>> GetAsync(CancellationToken cancellationToken)
+    public async Task<IReadOnlyCollection<Product>> GetAsync(
+        CancellationToken cancellationToken)
     {
         return await _dao.GetProductsAsync(cancellationToken);
     }
@@ -152,22 +150,22 @@ Then in the controller, you should inherit from the base controller and pass the
 ```c#
 public class ArticlesController : BaseJsonApiController<Article>
 {
-    public ArticlesController(
-        IJsonApiOptions options,
-        ILoggerFactory loggerFactory,
-        ICreateService<Article, int> create,
-        IDeleteService<Article, int> delete)
+    public ArticlesController(IJsonApiOptions options, ILoggerFactory loggerFactory,
+        ICreateService<Article, int> create, IDeleteService<Article, int> delete)
         : base(options, loggerFactory, create: create, delete: delete)
-    { }
+    {
+    }
 
     [HttpPost]
-    public override async Task<IActionResult> PostAsync([FromBody] Article resource, CancellationToken cancellationToken)
+    public override async Task<IActionResult> PostAsync([FromBody] Article resource,
+        CancellationToken cancellationToken)
     {
         return await base.PostAsync(resource, cancellationToken);
     }
 
     [HttpDelete("{id}")]
-    public override async Task<IActionResult>DeleteAsync(int id, CancellationToken cancellationToken)
+    public override async Task<IActionResult>DeleteAsync(int id,
+        CancellationToken cancellationToken)
     {
         return await base.DeleteAsync(id, cancellationToken);
     }

docs/usage/meta.md

@@ -18,7 +18,7 @@ public sealed class CopyrightResponseMeta : IResponseMeta
         return new Dictionary<string, object>
         {
             ["copyright"] = "Copyright (C) 2002 Umbrella Corporation.",
-            ["authors"] = new[] {"Alice", "Red Queen"}
+            ["authors"] = new[] { "Alice", "Red Queen" }
         };
     }
 }
@@ -44,7 +44,8 @@ Resource-specific metadata can be added by implementing `IResourceDefinition<TRe
 ```c#
 public class PersonDefinition : JsonApiResourceDefinition<Person>
 {
-    public PersonDefinition(IResourceGraph resourceGraph) : base(resourceGraph)
+    public PersonDefinition(IResourceGraph resourceGraph)
+        : base(resourceGraph)
     {
     }
 
@@ -54,7 +55,8 @@ public class PersonDefinition : JsonApiResourceDefinition<Person>
         {
             return new Dictionary<string, object>
             {
-                ["notice"] = "Check our intranet at http://www.example.com/employees/" + person.StringId + " for personal details."
+                ["notice"] = "Check our intranet at http://www.example.com/employees/" +
+                    person.StringId + " for personal details."
             };
         }