Skip to content

RFC: Type rename proposals #317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jaredcnance opened this issue Jun 28, 2018 · 1 comment
Closed

RFC: Type rename proposals #317

jaredcnance opened this issue Jun 28, 2018 · 1 comment
Labels
help wanted RFC Request for comments. These issues have major impact on the direction of the library.

Comments

@jaredcnance
Copy link
Contributor

jaredcnance commented Jun 28, 2018

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?

@jaredcnance jaredcnance added help wanted RFC Request for comments. These issues have major impact on the direction of the library. labels Jun 28, 2018
@jaredcnance jaredcnance added this to the v3.0 milestone Jun 29, 2018
@jaredcnance jaredcnance modified the milestones: v3.0, v4.0 Dec 2, 2018
@wisepotato wisepotato removed this from the v4.0 milestone Oct 9, 2019
@maurei
Copy link
Member

maurei commented Oct 22, 2019

All but the proposal for IQueryBuilder have been processed in #589. We think that the repository layer is more broad than the responsibility as implied by the name IQueryBuilder

@maurei maurei closed this as completed Oct 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted RFC Request for comments. These issues have major impact on the direction of the library.
Development

No branches or pull requests

3 participants