Skip to content

Review public API surface #734

Closed
@bart-degreed

Description

@bart-degreed

Things I'd like to change:

  • Rename 'entity' parameters to 'resource' in DefaultResourceService
  • Rename DefaultResourceRepository to EntityFrameworkCoreRepository (and update variable/parameter names likewise)
  • Move all types required for basic usage into JADNC's non-internal namespace. Advanced usage, like custom Service/Repository/ResourceDefinition and query filters can be in Internal namespaces. This should clarify our intent on taking breaking changes.
  • Make options.DefaultPageSize nullable (disallow setting to 0)
  • Rename T in JsonApiController<T> to TResource
  • Rename IQueryParameterParser to IQueryStringParser (it parses all types, not a single one)
  • Replace IEnumerable<> / List<> with IReadOnlyCollection<>
  • Review null checks
  • Validate input parameters on public members, validate options.
  • Rename CurrentRequest to JsonApiRequest

Other

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions