[Refactor] Update package to use camel-case field names #530
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When this package was first being developed, the JSON API spec recommended dash-case (e.g.
created-at) for resource member names. This recommendation has since changed, and camel-case is now recommended (e.g.createdAt).This PR goes through the package an amends it to follow the most up-to-date recommendation of camel-case. There are actually very few implications on the package. These are:
SoftDeletesModeltrait, the default soft deletes field is now the camel-case version of the model column, not the dash case. Developers can easily continue to use dash-case by setting thesoftDeleteFieldon their adapters.createdAtandupdatedAt. If the developer is using dash-case, it is exceptionally simple to amend those two field names once the resource is generated.Because of the soft deletes change, this is a breaking change so will have to be released in the next major version (3.0).
Closes #393