Skip to content

RFC: Type rename proposals #317

Closed
Closed
@jaredcnance

Description

@jaredcnance

Feedback on this issue is desired

There are several types that could have better names. We can change the names and deprecate the old ones via inheritance.

Current Type Description Proposal(s) Final
ContextGraph A graph of all resources and their metadata ResourceGraph
JsonApiResourceGraph
JsonApiSchema
ContextGraphBuilder Constructs the resource graph ResourceGraphBuilder
JsonApiSchemaBuilder
ContextEntity A json:api resource and its metadata Resource
JsonApiResource
ResourceDefinition
DocumentData The json:api document resource object as defined in the spec ResourceObject ResourceObject
JsonApiException
.GetError()
Returns the exception as a json:api formatted error object JsonApiException.GetErrorCollection()
EntityResourceService ... DefaultResourceService
IEntity...Repository Used by the resource service to construct and materialize queries IQueryBuilder
IEntityReadRepository.Get() Used to get the base IQueryable for which most queries are built from. See #404 (comment) . GetQueryable(...)
GenericProcessor When updating relationships, it is helpful to be able to use generic methods even though the generic parameter is different from the controller's generic parameters. The GenericProcessor gets created and then used through a non-generic interface. However, all of this makes what it does a bit confusing. Really, all it is used for is updating relationships. The fact that we chose to do it this particular way should not influence the name. UpdateRelationshipProcessor
PatchRelationshipProcessor

Any other suggestions?

Metadata

Metadata

Assignees

No one assigned

    Labels

    RFCRequest for comments. These issues have major impact on the direction of the library.help wanted

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions