Document JSON API implementation defs and progress in class #1482
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
| # ☐ toplevel_errors (required) | ||
| # ☐ toplevel_meta | ||
| # ☑ toplevel_jsonapi | ||
| def failure |
There was a problem hiding this comment.
| # | ||
| # description: | ||
| # An object describing the server's implementation | ||
| def toplevel_jsonapi |
There was a problem hiding this comment.
bf4
changed the title
| error, | ||
| error | ||
| ] | ||
| end |
There was a problem hiding this comment.
these should be comments with # @example and the implementation is raise NotImplementedError
bf4
force-pushed
the
jsonapify
branch
2 times, most recently
from
9e10660
to
ab6af9d
Compare
bf4
changed the title
bf4
added a commit
that referenced
this pull request
Mar 13, 2016
Document JSON API implementation defs and progress in class
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.
Update 2016-03-08
Added specs as comments in code... call to attention spec boundaries versus method boundaries
original description
I was thinking of breaking down the parts of the JSON API
spec that we need to implement into a kind of interface like
this so that we could highlight the areas that are complete or incomplete.
Refs: