Merge branch 'master' into develop

Author: jaredcnance

.gitignore

@@ -1,4 +1,5 @@
 \.vs/
 
 *.user
-.couscous/
+.couscous/
+docs/Template-Dark/

Template-Dark

@@ -1,6 +1,6 @@
 template:
     # Name of the directory containing the website template (default is "website")
-    # directory: Template-Dark
+    # directory: docs/Template-Dark
     # Or if you are using a remote template, you can set the Git URL
     url: https://github.com/jaredcnance/Template-Dark.git
     # Name of the index file (default is "README.md")

couscous.yml

@@ -36,16 +36,20 @@ public void ConfigureServices(IServiceCollection services)
 If a DbContext is specified when adding the services, the context will be used to define the resources and their names. By default, these names will be hyphenated.
 
 ```csharp
-// this will be translated into "my-models"
-public DbSet<MyModel> MyModels { get; set; }
+public class AppDbContext : DbContext {
+    // this will be translated into "my-models"
+    public DbSet<MyModel> MyModels { get; set; }
+}
 ```
 
 However, you can specify a custom name like so:
 
 ```csharp
-// this will be translated into "someModels"
-[Resource("someModels")]
-public DbSet<MyModel> MyModels { get; set; }
+public class AppDbContext : DbContext {
+    // this will be translated into "someModels"
+    [Resource("someModels")]
+    public DbSet<MyModel> MyModels { get; set; }
+}
 ```
 
 

docs/ContextGraph.md

@@ -7,7 +7,6 @@ currentMenu: controllers
 You need to create controllers that inherit from [JsonApiController<TEntity>](https://github.com/Research-Institute/json-api-dotnet-core/blob/master/src/JsonApiDotNetCore/Controllers/JsonApiController.cs).
 
 ```csharp
-[Route("api/[controller]")]
 public class ThingsController : JsonApiController<Thing>
 {
     public ThingsController(
@@ -26,7 +25,6 @@ you should explicitly declare it in the controller
 and service generic type definitions:
 
 ```csharp
-[Route("api/[controller]")]
 public class ThingsController : JsonApiController<Thing, Guid>
                                 //---------------------- ^^^^
 {
@@ -44,7 +42,7 @@ public class ThingsController : JsonApiController<Thing, Guid>
 
 If you need to customize things at the controller level, you can override the virtual
 methods. Please be aware that this is not the place for advanced business logic
-which should be performed at the [service](resourceServices.html) or [repository](entityRepositories.html) layers. Here is an example override at the controller layer:
+which should be performed at the [service](resourceservices.html) or [repository](entityrepositories.html) layers. Here is an example override at the controller layer:
 
 ```csharp
 public class TodoItemsController : JsonApiController<TodoItem>

docs/Controllers.md

@@ -9,10 +9,13 @@ If you want to use EF, but need additional data access logic (such as authorizat
 methods defined in [DefaultEntityRepository<TEntity, TId>](https://github.com/Research-Institute/json-api-dotnet-core/blob/master/src/JsonApiDotNetCore/Data/DefaultEntityRepository.cs). 
 
 The repository should then be
-add to the service collection in `Startup.ConfigureServices` like so:
+add to the service collection in `Startup.cs` like so:
 
 ```csharp
-services.AddScoped<IEntityRepository<MyEntity,Guid>, MyAuthorizedEntityRepository>();
+public IServiceProvider ConfigureServices(IServiceCollection services) {
+    services.AddScoped<IEntityRepository<MyEntity,Guid>, MyAuthorizedEntityRepository>();
+    // ...
+}
 ```
 
 A sample implementation that performs data authorization might look like:

docs/EntityRepositories.md

@@ -43,8 +43,8 @@ public class MyEntityRepository : DefaultEntityRepository<MyEntity>
         // use the base filtering method    
         entities = base.Filter(entities, filterQuery);
 
-	// implement custom method
-	return ApplyMyCustomFilter(entities, filterQuery);
+        // implement custom method
+        return ApplyMyCustomFilter(entities, filterQuery);
     }
 }
 ```

docs/Filtering.md

@@ -4,6 +4,11 @@ currentMenu: installation
 
 # Installation
 
+- CLI
+```
+$ dotnet add package jsonapidotnetcore
+```
+
 - Visual Studio
 ```
 Install-Package JsonApiDotnetCore
@@ -17,11 +22,6 @@ Install-Package JsonApiDotnetCore
 </ItemGroup>
 ```
 
-- CLI
-```
-$ dotnet add package jsonapidotnetcore
-```
-
 Click [here](https://www.nuget.org/packages/JsonApiDotnetCore/) for the latest NuGet version.
 
 For pre-releases (develop branch), add the [MyGet](https://www.myget.org/feed/Details/research-institute) package feed 

docs/Installation.md

@@ -11,11 +11,11 @@ received with a client generated id. However, this can be allowed by setting the
 flag in the options:
 
 ```csharp
-services.AddJsonApi<AppDbContext>(opt =>
-{
-    opt.AllowClientGeneratedIds = true;
-    // ..
-});
+public IServiceProvider ConfigureServices(IServiceCollection services) {
+    services.AddJsonApi<AppDbContext>(
+        opt => opt.AllowClientGeneratedIds = true);
+    // ...
+}
 ```
 
 ## Pagination
@@ -24,18 +24,24 @@ If you would like pagination implemented by default, you can specify the page si
 when setting up the services:
 
 ```csharp
- services.AddJsonApi<AppDbContext>(
-     opt => opt.DefaultPageSize = 10);
+public IServiceProvider ConfigureServices(IServiceCollection services) {
+    services.AddJsonApi<AppDbContext>(
+        opt => opt.DefaultPageSize = 10);
+    // ...
+}
 ```
 
 ### Total Record Count
 
 The total number of records can be added to the document meta by setting it in the options:
 
 ```csharp
-services.AddJsonApi<AppDbContext>(opt =>
-{
-    opt.DefaultPageSize = 5;
-    opt.IncludeTotalRecordCount = true;
-});
+public IServiceProvider ConfigureServices(IServiceCollection services) {
+    services.AddJsonApi<AppDbContext>(opt =>
+    {
+        opt.DefaultPageSize = 5;
+        opt.IncludeTotalRecordCount = true;
+    });
+    // ...
+}
 ```

docs/Options.md

@@ -6,20 +6,22 @@ currentMenu: routing
 
 By default the library will configure routes for each controller. 
 Based on the [recommendations](http://jsonapi.org/recommendations/)
-outlined in the JSONAPI spec, routes are hyphenated. For example:
+outlined in the JSONAPI spec, routes are hyphenated.
 
-```
-/todo-items --> TodoItemsController
-NOT /todoItems
+```http
+GET /api/compound-models HTTP/1.1
+Accept: application/vnd.api+json
 ```
 
 ## Namespacing and Versioning URLs
 
 You can add a namespace to the URL by specifying it in `ConfigureServices`:
 
 ```csharp
-services.AddJsonApi<AppDbContext>(
-    opt => opt.Namespace = "api/v1");
+public IServiceProvider ConfigureServices(IServiceCollection services) {
+    services.AddJsonApi<AppDbContext>(
+        opt => opt.Namespace = "api/v1");
+}
 ```
 
 ## Disable Convention
@@ -30,8 +32,7 @@ by using the `DisableRoutingConvention` Attribute.
 ```csharp
 [Route("[controller]")]
 [DisableRoutingConvention]
-public class CamelCasedModelsController : JsonApiController<CamelCasedModel>
-{
+public class CamelCasedModelsController : JsonApiController<CamelCasedModel> {
     public CamelCasedModelsController(
         IJsonApiContext jsonApiContext,
         IResourceService<CamelCasedModel> resourceService,
@@ -46,13 +47,19 @@ as the resource name. This is so that we can build accurrate resource links in t
 For example, if you define a resource as `MyModels` the controller route must match:
 
 ```csharp
-// resource definition
-builder.AddResource<TodoItem>("myModels");
+public IServiceProvider ConfigureServices(IServiceCollection services) {
+    services.AddJsonApi(options => {
+        options.BuildContextGraph((builder) => {
+            // resource definition
+            builder.AddResource<TodoItem>("myModels");
+        });
+    });
+}
 
 // controller definition
 [Route("api/myModels")]
 [DisableRoutingConvention]
-public class TodoItemsController : JsonApiController<TodoItem>
-{ //...
+public class TodoItemsController : JsonApiController<TodoItem> { 
+    //...
 }
 ```