-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Document JSON API implementation defs and progress in class #1482
Conversation
# ☐ toplevel_errors (required) | ||
# ☐ toplevel_meta | ||
# ☑ toplevel_jsonapi | ||
def failure |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# | ||
# description: | ||
# An object describing the server's implementation | ||
def toplevel_jsonapi |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
error, | ||
error | ||
] | ||
end |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these should be comments with # @example
and the implementation is raise NotImplementedError
9e10660
to
ab6af9d
Compare
Document JSON API implementation defs and progress in class
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: