json-api-dotnet · jaredcnance · Jul 2, 2017 · Jun 12, 2017 · Jun 12, 2017 · Jun 14, 2017
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@
 *.user
 .couscous/
 docs/Template-Dark/
+.idea/
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -6,7 +6,7 @@
     "isShellCommand": true,
     "args": [],
     "options": {
-      "cwd": "${workspaceRoot}/src/JsonApiDotNetCoreExample"
+      "cwd": "${workspaceRoot}/src/Examples/JsonApiDotNetCoreExample"
     },
     "tasks": [
         {

diff --git a/JsonApiDotnetCore.sln b/JsonApiDotnetCore.sln
@@ -4,7 +4,7 @@ VisualStudioVersion = 15.0.26228.9
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "JsonApiDotNetCore", "src\JsonApiDotNetCore\JsonApiDotNetCore.csproj", "{C0EC9E70-EB2E-436F-9D94-FA16FA774123}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "JsonApiDotNetCoreExample", "src\JsonApiDotNetCoreExample\JsonApiDotNetCoreExample.csproj", "{97EE048B-16C0-43F6-BDA9-4E762B2F579F}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "JsonApiDotNetCoreExample", "src\Examples\JsonApiDotNetCoreExample\JsonApiDotNetCoreExample.csproj", "{97EE048B-16C0-43F6-BDA9-4E762B2F579F}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{7A2B7ADD-ECB5-4D00-AA6A-D45BD11C97CF}"
 EndProject
@@ -18,12 +18,16 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		README.md = README.md
 	EndProjectSection
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NoEntityFrameworkExample", "src\NoEntityFrameworkExample\NoEntityFrameworkExample.csproj", "{570165EC-62B5-4684-A139-8D2A30DD4475}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NoEntityFrameworkExample", "src\Examples\NoEntityFrameworkExample\NoEntityFrameworkExample.csproj", "{570165EC-62B5-4684-A139-8D2A30DD4475}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NoEntityFrameworkTests", "test\NoEntityFrameworkTests\NoEntityFrameworkTests.csproj", "{73DA578D-A63F-4956-83ED-6D7102E09140}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UnitTests", "test\UnitTests\UnitTests.csproj", "{6D4BD85A-A262-44C6-8572-FE3A30410BF3}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Examples", "Examples", "{026FBC6C-AF76-4568-9B87-EC73457899FD}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ReportsExample", "src\Examples\ReportsExample\ReportsExample.csproj", "{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -94,6 +98,18 @@ Global
 		{6D4BD85A-A262-44C6-8572-FE3A30410BF3}.Release|x64.Build.0 = Release|x64
 		{6D4BD85A-A262-44C6-8572-FE3A30410BF3}.Release|x86.ActiveCfg = Release|x86
 		{6D4BD85A-A262-44C6-8572-FE3A30410BF3}.Release|x86.Build.0 = Release|x86
+		{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Debug|x64.ActiveCfg = Debug|x64
+		{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Debug|x64.Build.0 = Debug|x64
+		{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Debug|x86.ActiveCfg = Debug|x86
+		{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Debug|x86.Build.0 = Debug|x86
+		{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Release|Any CPU.Build.0 = Release|Any CPU
+		{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Release|x64.ActiveCfg = Release|x64
+		{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Release|x64.Build.0 = Release|x64
+		{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Release|x86.ActiveCfg = Release|x86
+		{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D}.Release|x86.Build.0 = Release|x86
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -105,5 +121,7 @@ Global
 		{570165EC-62B5-4684-A139-8D2A30DD4475} = {7A2B7ADD-ECB5-4D00-AA6A-D45BD11C97CF}
 		{73DA578D-A63F-4956-83ED-6D7102E09140} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
 		{6D4BD85A-A262-44C6-8572-FE3A30410BF3} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
+		{026FBC6C-AF76-4568-9B87-EC73457899FD} = {7A2B7ADD-ECB5-4D00-AA6A-D45BD11C97CF}
+		{FBFB0B0B-EA86-4B41-AB2A-E0249F70C86D} = {026FBC6C-AF76-4568-9B87-EC73457899FD}
 	EndGlobalSection
 EndGlobal
diff --git a/docs/Models.md b/docs/Models.md
@@ -56,6 +56,19 @@ public class Person : Identifiable<int>
 }
 ```
 
+### Immutability
+
+Attributes can be marked as immutable which will prevent `PATCH` requests
+from updating them:
+
+```csharp
+public class Person : Identifiable<int>
+{
+    [Attr("first-name", immutable: true)]
+    public string FirstName { get; set; }
+}
+```
+
 ## Relationships
 
 In order for navigation properties to be identified in the model, 

diff --git a/docs/ResourceServices.md b/docs/ResourceServices.md
@@ -75,4 +75,52 @@ public class MyModelService : IResourceService<MyModel>
         return await _dal.GetModelAsync();
     }
 }
+```
+
+### Limited Requirements
+
+In some cases it may be necessary to only expose a few methods on the resource.
+For this reason, we have created a hierarchy of service interfaces that can be used to get the
+exact implementation you require. Below is a table outlining these interfaces:
+
+![interfaces](service_table.png)
+
+
+ In order to take advantage of these interfaces you first need to inject the service for each implemented interface. 
+ Using Autofac, as an example, this is simply:
+
+```csharp
+public class MyResourceService : ICreateService<MyResource>, IDeleteService<MyResource> {
+   // ...
+}
+```
+
+```csharp
+public class Startup {
+  public IServiceProvider ConfigureServices(IServiceCollection services) {
+    builder.RegisterType<MyResourceService>().AsImplementedInterfaces();
+  }
+}
+```
+
+Then in the controller, you should inherit the base controller and pass the services into
+the named, optional base parameters:
+
+```csharp
+public class MyResourcesController : BaseJsonApiController<MyResource> {
+
+    public MyResourcesController(
+        IJsonApiContext jsonApiContext, 
+        ICreateService<MyResource> create,
+        IDeleteService<MyResource> delete
+    ) : base(jsonApiContext, create: create, delete: delete) { }
+
+    [HttpPost]
+    public override async Task<IActionResult> PostAsync([FromBody] MyResource entity) 
+        => await base.PostAsync(entity);
+
+    [HttpDelete("{id}")]
+    public override async Task<IActionResult>DeleteAsync(int id) 
+        => await base.DeleteAsync(id);
+}
 ```
diff --git a/docs/service_table.png b/docs/service_table.png
diff --git a/src/JsonApiDotNetCoreExample/.gitignore → ...mples/JsonApiDotNetCoreExample/.gitignore b/src/JsonApiDotNetCoreExample/.gitignore → ...mples/JsonApiDotNetCoreExample/.gitignore
diff --git a/...Controllers/CamelCasedModelsController.cs → ...Controllers/CamelCasedModelsController.cs b/...Controllers/CamelCasedModelsController.cs → ...Controllers/CamelCasedModelsController.cs
diff --git a/...reExample/Controllers/PeopleController.cs → ...reExample/Controllers/PeopleController.cs b/...reExample/Controllers/PeopleController.cs → ...reExample/Controllers/PeopleController.cs
diff --git a/...trollers/Restricted/ReadOnlyController.cs → ...trollers/Restricted/ReadOnlyController.cs b/...trollers/Restricted/ReadOnlyController.cs → ...trollers/Restricted/ReadOnlyController.cs
diff --git a/...ample/Controllers/TestValuesController.cs → ...ample/Controllers/TestValuesController.cs b/...ample/Controllers/TestValuesController.cs → ...ample/Controllers/TestValuesController.cs
diff --git a/.../Controllers/TodoCollectionsController.cs → .../Controllers/TodoCollectionsController.cs b/.../Controllers/TodoCollectionsController.cs → .../Controllers/TodoCollectionsController.cs
diff --git a/...xample/Controllers/TodoItemsController.cs → ...xample/Controllers/TodoItemsController.cs b/...xample/Controllers/TodoItemsController.cs → ...xample/Controllers/TodoItemsController.cs
diff --git a/.../Controllers/TodoItemsCustomController.cs → .../Controllers/TodoItemsCustomController.cs b/.../Controllers/TodoItemsCustomController.cs → .../Controllers/TodoItemsCustomController.cs
@@ -54,7 +54,7 @@ public CustomJsonApiController(
             IResourceService<T, TId> resourceService,
             ILoggerFactory loggerFactory)
         {
-            _jsonApiContext = jsonApiContext.ApplyContext<T>();
+            _jsonApiContext = jsonApiContext.ApplyContext<T>(this);
             _resourceService = resourceService;
             _logger = loggerFactory.CreateLogger<JsonApiDotNetCore.Controllers.JsonApiController<T, TId>>();
         }
@@ -63,7 +63,7 @@ public CustomJsonApiController(
             IJsonApiContext jsonApiContext,
             IResourceService<T, TId> resourceService)
         {
-            _jsonApiContext = jsonApiContext.ApplyContext<T>();
+            _jsonApiContext = jsonApiContext.ApplyContext<T>(this);
             _resourceService = resourceService;
         }
 

diff --git a/...le/Controllers/TodoItemsTestController.cs → ...le/Controllers/TodoItemsTestController.cs b/...le/Controllers/TodoItemsTestController.cs → ...le/Controllers/TodoItemsTestController.cs
diff --git a/...ApiDotNetCoreExample/Data/AppDbContext.cs → ...ApiDotNetCoreExample/Data/AppDbContext.cs b/...ApiDotNetCoreExample/Data/AppDbContext.cs → ...ApiDotNetCoreExample/Data/AppDbContext.cs
diff --git a/src/JsonApiDotNetCoreExample/Dockerfile → ...mples/JsonApiDotNetCoreExample/Dockerfile b/src/JsonApiDotNetCoreExample/Dockerfile → ...mples/JsonApiDotNetCoreExample/Dockerfile
diff --git a/...reExample/JsonApiDotNetCoreExample.csproj → ...reExample/JsonApiDotNetCoreExample.csproj b/...reExample/JsonApiDotNetCoreExample.csproj → ...reExample/JsonApiDotNetCoreExample.csproj
@@ -11,7 +11,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <ProjectReference Include="../JsonApiDotNetCore/JsonApiDotNetCore.csproj" />
+    <ProjectReference Include="../../JsonApiDotNetCore/JsonApiDotNetCore.csproj" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/...ations/20170315140127_initial.Designer.cs → ...ations/20170315140127_initial.Designer.cs b/...ations/20170315140127_initial.Designer.cs → ...ations/20170315140127_initial.Designer.cs
diff --git a/...mple/Migrations/20170315140127_initial.cs → ...mple/Migrations/20170315140127_initial.cs b/...mple/Migrations/20170315140127_initial.cs → ...mple/Migrations/20170315140127_initial.cs
diff --git a/...30020650_AddAssignedTodoItems.Designer.cs → ...30020650_AddAssignedTodoItems.Designer.cs b/...30020650_AddAssignedTodoItems.Designer.cs → ...30020650_AddAssignedTodoItems.Designer.cs
diff --git a/...ns/20170330020650_AddAssignedTodoItems.cs → ...ns/20170330020650_AddAssignedTodoItems.cs b/...ns/20170330020650_AddAssignedTodoItems.cs → ...ns/20170330020650_AddAssignedTodoItems.cs
diff --git a/...0170330234539_AddGuidProperty.Designer.cs → ...0170330234539_AddGuidProperty.Designer.cs b/...0170330234539_AddGuidProperty.Designer.cs → ...0170330234539_AddGuidProperty.Designer.cs
diff --git a/...rations/20170330234539_AddGuidProperty.cs → ...rations/20170330234539_AddGuidProperty.cs b/...rations/20170330234539_AddGuidProperty.cs → ...rations/20170330234539_AddGuidProperty.cs
diff --git a/...50_AddCreatesAndAchievedDates.Designer.cs → ...50_AddCreatesAndAchievedDates.Designer.cs b/...50_AddCreatesAndAchievedDates.Designer.cs → ...50_AddCreatesAndAchievedDates.Designer.cs
diff --git a/...70424180950_AddCreatesAndAchievedDates.cs → ...70424180950_AddCreatesAndAchievedDates.cs b/...70424180950_AddCreatesAndAchievedDates.cs → ...70424180950_AddCreatesAndAchievedDates.cs
diff --git a/...0426232509_AddCamelCasedModel.Designer.cs → ...0426232509_AddCamelCasedModel.Designer.cs b/...0426232509_AddCamelCasedModel.Designer.cs → ...0426232509_AddCamelCasedModel.Designer.cs
diff --git a/...ions/20170426232509_AddCamelCasedModel.cs → ...ions/20170426232509_AddCamelCasedModel.cs b/...ions/20170426232509_AddCamelCasedModel.cs → ...ions/20170426232509_AddCamelCasedModel.cs
diff --git a/...e/Migrations/AppDbContextModelSnapshot.cs → ...e/Migrations/AppDbContextModelSnapshot.cs b/...e/Migrations/AppDbContextModelSnapshot.cs → ...e/Migrations/AppDbContextModelSnapshot.cs
diff --git a/...tNetCoreExample/Models/CamelCasedModel.cs → ...tNetCoreExample/Models/CamelCasedModel.cs b/...tNetCoreExample/Models/CamelCasedModel.cs → ...tNetCoreExample/Models/CamelCasedModel.cs
diff --git a/...JsonApiDotNetCoreExample/Models/Person.cs → ...JsonApiDotNetCoreExample/Models/Person.cs b/...JsonApiDotNetCoreExample/Models/Person.cs → ...JsonApiDotNetCoreExample/Models/Person.cs
diff --git a/...onApiDotNetCoreExample/Models/TodoItem.cs → ...onApiDotNetCoreExample/Models/TodoItem.cs b/...onApiDotNetCoreExample/Models/TodoItem.cs → ...onApiDotNetCoreExample/Models/TodoItem.cs
diff --git a/...tCoreExample/Models/TodoItemCollection.cs → ...tCoreExample/Models/TodoItemCollection.cs b/...tCoreExample/Models/TodoItemCollection.cs → ...tCoreExample/Models/TodoItemCollection.cs
diff --git a/src/JsonApiDotNetCoreExample/Program.cs → ...mples/JsonApiDotNetCoreExample/Program.cs b/src/JsonApiDotNetCoreExample/Program.cs → ...mples/JsonApiDotNetCoreExample/Program.cs
diff --git a/...oreExample/Properties/launchSettings.json → ...oreExample/Properties/launchSettings.json b/...oreExample/Properties/launchSettings.json → ...oreExample/Properties/launchSettings.json
diff --git a/src/JsonApiDotNetCoreExample/Startup.cs → ...mples/JsonApiDotNetCoreExample/Startup.cs b/src/JsonApiDotNetCoreExample/Startup.cs → ...mples/JsonApiDotNetCoreExample/Startup.cs
diff --git a/...JsonApiDotNetCoreExample/appsettings.json → ...JsonApiDotNetCoreExample/appsettings.json b/...JsonApiDotNetCoreExample/appsettings.json → ...JsonApiDotNetCoreExample/appsettings.json
diff --git a/src/JsonApiDotNetCoreExample/web.config → ...mples/JsonApiDotNetCoreExample/web.config b/src/JsonApiDotNetCoreExample/web.config → ...mples/JsonApiDotNetCoreExample/web.config
diff --git a/src/NoEntityFrameworkExample/.gitignore → ...mples/NoEntityFrameworkExample/.gitignore b/src/NoEntityFrameworkExample/.gitignore → ...mples/NoEntityFrameworkExample/.gitignore
diff --git a/.../Controllers/CustomTodoItemsController.cs → .../Controllers/CustomTodoItemsController.cs b/.../Controllers/CustomTodoItemsController.cs → .../Controllers/CustomTodoItemsController.cs
diff --git a/...rkExample/NoEntityFrameworkExample.csproj → ...rkExample/NoEntityFrameworkExample.csproj b/...rkExample/NoEntityFrameworkExample.csproj → ...rkExample/NoEntityFrameworkExample.csproj
@@ -11,8 +11,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="../JsonApiDotNetCore/JsonApiDotNetCore.csproj" />
-    <ProjectReference Include="../JsonApiDotNetCoreExample/JsonApiDotNetCoreExample.csproj" />
+    <ProjectReference Include="../../JsonApiDotNetCore/JsonApiDotNetCore.csproj" />
+    <ProjectReference Include="../../Examples/JsonApiDotNetCoreExample/JsonApiDotNetCoreExample.csproj" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/NoEntityFrameworkExample/Program.cs → ...mples/NoEntityFrameworkExample/Program.cs b/src/NoEntityFrameworkExample/Program.cs → ...mples/NoEntityFrameworkExample/Program.cs
diff --git a/...orkExample/Properties/launchSettings.json → ...orkExample/Properties/launchSettings.json b/...orkExample/Properties/launchSettings.json → ...orkExample/Properties/launchSettings.json
diff --git a/...meworkExample/Services/TodoItemService.cs → ...meworkExample/Services/TodoItemService.cs b/...meworkExample/Services/TodoItemService.cs → ...meworkExample/Services/TodoItemService.cs
diff --git a/src/NoEntityFrameworkExample/Startup.cs → ...mples/NoEntityFrameworkExample/Startup.cs b/src/NoEntityFrameworkExample/Startup.cs → ...mples/NoEntityFrameworkExample/Startup.cs
diff --git a/...NoEntityFrameworkExample/appsettings.json → ...NoEntityFrameworkExample/appsettings.json b/...NoEntityFrameworkExample/appsettings.json → ...NoEntityFrameworkExample/appsettings.json
diff --git a/src/Examples/ReportsExample/.bowerrc b/src/Examples/ReportsExample/.bowerrc
@@ -0,0 +1,3 @@
+{
+  "directory": "wwwroot/lib"
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,3 +3,4 @@ @@
     *.user
     .couscous/
     docs/Template-Dark/
+    .idea/