v2: allowing a strict next to the human api #36
Merged
Conversation
This file contains 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
use `AttributesObject` to manage attribute api use `::fromX()` instead `->setX()` to fill with array use `->toArray()` instead of guessing another object's structure use `->add()` instead `->addData()` for adding primary properties move validation and conversion to centralized place
fix ErrorsDocument containing an object with one ErrorObject instead of an array with multiple fix sending http response body if status code was `204 No Content` define interfaces for documents and objects
- simplify checking & marking used fields, testing showed forgetting marking, or mark+check in wrong order, gives unexpected results - fix one use-statement bug - use scripts to rule them all
also block adding links using an already used key
also make it easier to add a self link at a resource document's root level also make sure relationships output an empty data property if no resource(s) is set also make clear included resources can be added when they can't be determined from the relations being added
also don't add a /errors/0/title for exceptions as we only used /errors/0/code before indent left for diff readability, cleanup in next commit
start with a verb, tell what we do, not what we don't
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.
This is a work-in-progress for an upcoming v2. The main feature is having a strict specification-based interface for building documents, next to keeping the human friendly interface for people who don't (want to get to) know the spec.
This will very probably be a backwards compatibility breaking release, although I'm thinking about a runtime migration.
It is also more ready for jsonapi 1.1, but that's not the purpose of this PR.
Any feedback is welcome! Both on what would be nice changes since we already break BC, and on how the v2 WIP could be improved.