search

xebia / VisualReview

VisualReview, a human-friendly tool for testing and reviewing visual regressions.
https://github.com/xebia/VisualReview#see-it-in-action
Apache License 2.0
275 stars 24 forks source link

[API docs] missing info for meta and properties for endpoint /screenshot #48

Closed Klaasvaak closed 9 years ago

Klaasvaak commented 9 years ago

The API docs mention screenshotName and file but does not mention the meta and properties

RRMoelker commented 9 years ago

Thank you, we will add that information to the API docs (see PR #49). I understand you needed this for a Node.js implementation. Did you get it working?

We are aware that the API documentation is still lacking a bit at the moment. In the long run, we plan on generating the API docs from the back end models or from something like JSON schema.

Klaasvaak commented 9 years ago

Thanks for updating the docs!

I made a node.js client. I can open source it this week, will notify you.

Klaasvaak commented 9 years ago

Source is here: https://github.com/Klaasvaak/VisualReview-node-client

Did not use this version of the code yet in my project.