Skip to content
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

Image error subfield pictureId should be generalized, context-sensitive #14

Open
JamesBeach opened this issue May 20, 2016 · 0 comments

Comments

@JamesBeach
Copy link
Collaborator

A nullable field in the error type returned to the client called pictureId is nominally intended to carry the unique ID of an image when an image-related error has been generated. It may be desirable that this should instead be generalized so that it can accompany other kinds of errors, when applicable.

For example, it is possible that a client may try to verify a photo or, in later iterations, train further against a facId that does not exist for its corresponding facType. Though this error doesn't yet have a specific code, it probably should. And, to enable the client to take appropriate action, it may be desirable to embed the facType in the error payload.

It may be called simply id, given that it identifies a problematic parameter in the request. While we could maintain fields with different names that show up sometimes and not others--pictureId, facType, and so on--this would introduce additional complications to the JSON parsing or mappings. Simpler to have it be context-sensitive, its meaning derived from its associated error code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant