feat: improve error serialization #111
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
john-goldsmith
changed the title
danivek
reviewed
Jul 1, 2020
Improves the serialization of errors to be compliant with the JSON:API spec: * Remove explicit check for `Error` instances and, instead, validate both instances of `Error` and POJOs using `validateError` * Restrict `links` object properties to `about` * Restrict `links.about` object property type to string * Restrict `source` object properties to `pointer` and `parameter` * Restrict `meta` object property type to object * Add function for validating `status` against a list of known HTTP status codes * Restrict `status` object property type to number * Add tests for new functionality * Update tests for changed functionality * Update README.md with additional usage examples
Improves the serialization of errors: * Update `title` to use the constructor name only if it's not 'Object' * Support both `status` and `statusCode` properties * Update JSDoc blocks to include more information * Fix `status` typo in `README.md` * Update `README.md` to indicate support for both `status` and `statusCode`
john-goldsmith
force-pushed
the
improved-error-serialization
branch
from
1ce8a70 to
b4876fb
Compare
danivek
approved these changes
Jul 2, 2020
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.
Improves the serialization of errors to be compliant with the JSON:API
spec:
Errorinstances and, instead, validateboth instances of
Errorand POJOs usingvalidateErrorlinksobject properties toaboutlinks.aboutobject property type to stringsourceobject properties topointerandparametermetaobject property type to objectstatusagainst a list of known HTTPstatus codes
statusobject property type to numberREADME.mdwith additional usage examplesAddresses issue #110