merge master into fork

Author: jaredcnance

Build.ps1

@@ -22,12 +22,18 @@ dotnet build .\src\JsonApiDotNetCore -c Release
 
 echo "APPVEYOR_REPO_TAG: $env:APPVEYOR_REPO_TAG"
 
-
 If($env:APPVEYOR_REPO_TAG -eq $true) {
     $revision = Get-Version-Suffix-From-Tag
     echo "VERSION-SUFFIX: $revision"
-    echo "RUNNING dotnet pack .\src\JsonApiDotNetCore -c Release -o .\artifacts --version-suffix=$revision"
-    dotnet pack .\src\JsonApiDotNetCore -c Release -o .\artifacts --version-suffix=$revision 
+
+    IF ([string]::IsNullOrWhitespace($revision)){
+        echo "RUNNING dotnet pack .\src\JsonApiDotNetCore -c Release -o .\artifacts"
+        dotnet pack .\src\JsonApiDotNetCore -c Release -o .\artifacts
+    }
+    Else {
+        echo "RUNNING dotnet pack .\src\JsonApiDotNetCore -c Release -o .\artifacts --version-suffix=$revision"
+        dotnet pack .\src\JsonApiDotNetCore -c Release -o .\artifacts --version-suffix=$revision 
+    }
 }
 Else { 
     echo "VERSION-SUFFIX: alpha1-$revision"

README.md

@@ -1,23 +1,72 @@
+<p align="center">
+<img src ="https://raw.githubusercontent.com/json-api-dotnet/JsonApiDotnetCore/master/logo.png" />
+</p>
+
 # JSON API .Net Core
 
 [![Build status](https://ci.appveyor.com/api/projects/status/9fvgeoxdikwkom10?svg=true)](https://ci.appveyor.com/project/jaredcnance/json-api-dotnet-core)
-[![Travis](https://img.shields.io/travis/Research-Institute/json-api-dotnet-core.svg?maxAge=3600&label=travis)](https://travis-ci.org/Research-Institute/json-api-dotnet-core)
+[![Travis](https://travis-ci.org/json-api-dotnet/JsonApiDotNetCore.svg?branch=master)](https://travis-ci.org/json-api-dotnet/JsonApiDotNetCore)
 [![NuGet](https://img.shields.io/nuget/v/JsonApiDotNetCore.svg)](https://www.nuget.org/packages/JsonApiDotNetCore/)
 [![MyGet CI](https://img.shields.io/myget/research-institute/vpre/JsonApiDotNetCore.svg)](https://www.myget.org/feed/research-institute/package/nuget/JsonApiDotNetCore)
 [![Join the chat at https://gitter.im/json-api-dotnet-core/Lobby](https://badges.gitter.im/json-api-dotnet-core/Lobby.svg)](https://gitter.im/json-api-dotnet-core/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![FIRST-TIMERS](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](http://www.firsttimersonly.com/)
 
 A framework for building [json:api](http://jsonapi.org/) compliant web APIs. The ultimate goal of this library is to eliminate as much boilerplate as possible by offering out-of-the-box features such as sorting, filtering and pagination. You just need to focus on defining the resources and implementing your custom business logic. This library has been designed around dependency injection making extensibility incredibly easy.
 
+## Examples
+
+See the [examples](https://github.com/json-api-dotnet/JsonApiDotNetCore/tree/master/src/Examples) directory for up-to-date sample applications. There is also a [Todo List App](https://github.com/json-api-dotnet/TodoListExample) that includes a JADNC API and an EmberJs client.
+
 ## Installation And Usage
 
-See the documentation [here](https://research-institute.github.io/json-api-dotnet-core)
+See [the documentation](https://json-api-dotnet.github.io/JsonApiDotNetCore/) for detailed usage. 
+
+### Models
+
+```csharp
+public class Article : Identifiable
+{ 
+    [Attr("name")]
+    public string Name { get; set; }
+}
+```
+
+### Controllers
+
+```csharp
+public class ArticlesController : JsonApiController<Article>
+{
+    public ArticlesController(
+        IJsonApiContext jsonApiContext,
+        IResourceService<Article> resourceService) 
+    : base(jsonApiContext, resourceService) { }
+}
+```
+
+### Middleware
+
+```csharp
+public class Startup 
+{
+    public IServiceProvider ConfigureServices(IServiceCollection services) {
+        services.AddJsonApi<AppDbContext>();
+        // ...
+    }
 
+    public void Configure(IApplicationBuilder app)  {
+        app.UseJsonApi()
+        // ...
+    }
+}
+```
 
-## .Net Core v2 Notes
+## Development Priorities
 
-Branch `feat/core-2` is where I am working on .Net Core 2 compatibility tests and package upgrades.
-There are several blockers to be aware of:
+The current priorities for future development (in order): 
+1. Operations Support ([#150](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/150))
+2. ASP.Net Core 2.0 Support ([#161](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/161))
+3. Minor features ([#105](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/105), [#144](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/144), [#162](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/162))
+4. Resource to Entity Mapping ([#112](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/112))
 
-- Microsoft.AspNetCore.* packages target the runtime (netcoreapp) instead of netstandard. [This will be changed in future versions.](https://blogs.msdn.microsoft.com/webdev/2017/05/10/aspnet-2-preview-1/).
-- Can't run acceptance testing against postgres on preview runtime [pgsql.EntityFrameworkCore.PostgreSQL#171](https://github.com/npgsql/Npgsql.EntityFrameworkCore.PostgreSQL/issues/171#issuecomment-301287257)
+If you're interested in working on any of the above features, take a look at the [Contributing Guide](https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/CONTRIBUTING.MD)
+or hop on the project Gitter for more direct communication.

couscous.yml

@@ -34,7 +34,7 @@ branch: gh-pages
 
 # Base URL of the published website (no "/" at the end!)
 # You are advised to set and use this variable to write your links in the HTML layouts
-baseUrl: https://research-institute.github.io/json-api-dotnet-core
+baseUrl: https://json-api-dotnet.github.io/JsonApiDotNetCore/
 github:
     user: research-institute
     repo: json-api-dotnet-core
@@ -78,6 +78,9 @@ menu:
                 filtering:
                     text: Filtering
                     relativeUrl: filtering.html
+                includingrelationships:
+                    text: Including Relationships
+                    relativeUrl: includingrelationships.html
                 pagination:
                     text: Pagination
                     relativeUrl: pagination.html
@@ -107,4 +110,7 @@ menu:
                     relativeUrl: entityrepositories.html
                 middleware:
                     text: Middleware
-                    relativeUrl: middleware.html
+                    relativeUrl: middleware.html
+                customqueryformat:
+                    text: Custom Query Formats
+                    relativeUrl: customqueryformat.html

docs/CustomQueryFormat.md

@@ -0,0 +1,13 @@
+---
+currentMenu: customqueryformat
+---
+
+# Custom Query Formats
+
+For information on the default query parameter formats, see the documentation for each query method.
+
+In order to customize the query formats, you need to implement the `IQueryParser` interface and inject it like so:
+
+```csharp
+services.AddScoped<IQueryParser, FooQueryParser>();
+```

docs/IncludingRelationships.md

@@ -0,0 +1,54 @@
+---
+currentMenu: includingrelationships
+---
+
+# Including Relationships
+
+JADNC supports [request include params](http://jsonapi-resources.com/v0.9/guide/resources.html#Included-relationships-side-loading-resources) out of the box, for side loading related resources.
+
+Here’s an example from the spec:
+
+```http
+GET /articles/1?include=comments HTTP/1.1
+Accept: application/vnd.api+json
+```
+
+Will get you the following payload:
+
+```json
+{
+  "data": {
+    "type": "articles",
+    "id": "1",
+    "attributes": {
+      "title": "JSON API paints my bikeshed!"
+    },
+    "relationships": {
+      "comments": {
+        "links": {
+          "self": "http://example.com/articles/1/relationships/comments",
+          "related": "http://example.com/articles/1/comments"
+        },
+        "data": [
+          { "type": "comments", "id": "5" },
+          { "type": "comments", "id": "12" }
+        ]
+      }
+    }
+  },
+  "included": [{
+    "type": "comments",
+    "id": "5",
+    "attributes": {
+      "body": "First!"
+    }
+  }, {
+    "type": "comments",
+    "id": "12",
+    "attributes": {
+      "body": "I like XML better"
+    }
+  }]
+}
+```
+

docs/Options.md

@@ -45,3 +45,67 @@ public IServiceProvider ConfigureServices(IServiceCollection services) {
     // ...
 }
 ```
+
+## Relative Links
+
+All links are absolute by default. However, you can configure relative links:
+
+```csharp
+public IServiceProvider ConfigureServices(IServiceCollection services) {
+    services.AddJsonApi<AppDbContext>(
+        opt => opt.RelativeLinks = true);
+    // ...
+}
+```
+
+
+```http
+GET /api/v1/articles/4309 HTTP/1.1
+Accept: application/vnd.api+json
+```
+
+```json
+{
+    "type": "articles",
+    "id": "4309",
+    "attributes": {
+        "name": "Voluptas iure est molestias."
+    },
+    "relationships": {
+        "author": {
+            "links": {
+                "self": "/api/v1/articles/4309/relationships/author",
+                "related": "/api/v1/articles/4309/author"
+            }
+        }
+    }
+}
+```
+
+## Custom Query Parameters
+
+If you would like to use custom query params (parameters not reserved by the json:api specification), you can set `AllowCustomQueryParameters = true`. The default behavior is to return an `HTTP 400 Bad Request` for unknown query parameters.
+
+```csharp
+public IServiceProvider ConfigureServices(IServiceCollection services) {
+    services.AddJsonApi<AppDbContext>(
+        opt => opt.AllowCustomQueryParameters = true);
+    // ...
+}
+```
+
+## Custom Serializer Settings
+
+We use Json.Net for all serialization needs. If you want to change the default serializer settings, you can:
+
+```csharp
+public IServiceProvider ConfigureServices(IServiceCollection services) {
+    services.AddJsonApi<AppDbContext>(
+        opt => opt.SerializerSettings = new JsonSerializerSettings()
+        {
+            NullValueHandling = NullValueHandling.Ignore,
+            ContractResolver = new DasherizedResolver()
+        });
+    // ...
+}
+```