v3.0.0

After 3 months, it's finally here. There have been no functional modifications since v3.0.0-beta7, only improved error checks and messages. The following is a summary of all the changes that went out in the beta versions.

---

Breaking Changes

• DocumentData replaced by ResourceObject. Thanks @btecu! (#400 via #403)
• #317 via #428: rename ContextGraph to ResourceGraph
• #359 via #416 Nested Sort. Thanks @milosloub!
  • SortQuery: use public attribute string name when constructing
    • SortQuery(SortDirection, AttrAttribute) to SortQuery(SortDirection, string)
    • SortedAttribute to Attribute
  • IQueryableExtension
    • Sort<T>(IQueryable<TSource>, List<SortQuery>) to
      Sort<T>(IQueryable<TSource>, IJsonApiContext, List<SortQuery>)
    • Sort<T>(IQueryable<TSource>, SortQuery) to
      Sort<T>(IQueryable<TSource>, IJsonApiContext, SortQuery)
    • Sort<T>(IOrderedQueryable<TSource>, SortQuery) to
      Sort<T>(IOrderedQueryable<TSource>, IJsonApiContext, SortQuery)

Non-Breaking Changes

• #425 via #427: fix DocumentBuilder; includes member missing when fetching HasManyThrough. Thanks @maurei!
• Naming conventions (#293 via #409)

[Attr] // → "compound-name"
public string CompoundName { get; set; }

builder.AddResource<TestResource>();  // → "test-resources"

• API for easy service/repo registration (#384 via #409)

services.AddResourceService<FooService>();

• ResourceDefinition improvements: Custom filters and default sort (#402 via #409)

public class FooResource : ResourceDefinition<Foo>
{
  protected override QueryFilters GetQueryFilters() => new QueryFilters { 
        { "key1", (query, value) => query.Where(x => x == value) },
        { "key2", (query, value) => query.Where(x => x != value) },
   };

  public override PropertySortOrder<Foo> GetDefaultSortOrder() => new PropertySortOrder { 
     (foo => foo.Bar, SortDirection.Ascending),
     (foo => foo.Baz, SortDirection.Descending),
  }
}

• Many-to-Many support via [HasManyThrough] (#151 via #419)

public class Article : Identifiable
{
    [NotMapped] // ← tells EF to ignore this property
    [HasManyThrough(nameof(ArticleTags))] // ← tells JADNC to use this as an alias to ArticleTags.Tags
    public List<Tag> Tags { get; set; }

    // this is the EF join relationship
    public List<ArticleTag> ArticleTags { get; set; }
}

• #382 via #395: Identifiable causes exceptions in Post
• #39 via #378: Deeply Nested Inclusions. Thanks @NullVoxPopuli for all the help landing this!
• #388 Exact Error Codes for Error Collections thanks @rtablada !
• #387 Additional filter operations: isnull and isnotnull thanks @NullVoxPopuli !

Usage

This change introduces two new filter operators isnull and isnotnull. Like all other operators, it is appended by a colon (:), however, any value provided after the colon is ignored.

GET /api/v1/todo-items?filter[updated-date]=isnull: HTTP/1.1
Accept: application/vnd.api+json

• #377: Fix TypeLocator bug that results in app crashing at startup
• #241 via #376 Auto Resource/Service Discovery