search

apdavison / ebrains-validation-client

BSD 3-Clause "New" or "Revised" License
1 stars 4 forks source link

Python Client v0.3.0 #4

Closed appukuttan-shailesh closed 7 years ago

appukuttan-shailesh commented 7 years ago

Updates the python client to work with the new validation framework. Documentation: http://hbp-validation-client.readthedocs.io

appukuttan-shailesh commented 7 years ago

in general the full URI should be accepted as an object ID, and methods that currently return UUIDs should return the full URI.

Regarding UUID vs URI.... I think it would be much better to change this on the server-side. Currently the APIs return the UUIDs, and demand the UUIDs (not URIs) as input for retrieving models/test/results.

We could certainly compensate for this on the client-side (by converting the UUID to URI, and vice versa), but it seems more appropriate to have the changes on the server end. The prototype VF had this handled on the server.

If you agree, I will create a ticket on hbp-validation-framework_dev.

apdavison commented 7 years ago

Yes, this should be changed server-side.

appukuttan-shailesh commented 7 years ago

access control for models should depend on the collab id, not the app id. This will probably need some changes to the API.

Yes, Lungsi and me actually came across some problems of having it linked to the app_id. Have raised a ticket: https://github.com/joffreygonin/hbp-validation-framework_dev/issues/89

forbidding the user to change a test instance if there are already results from that test instance

Created a ticket for the above: https://github.com/joffreygonin/hbp-validation-framework_dev/issues/91 @apdavison : Should a similar restriction be kept on model instances?

Also, created a ticket for the UUID to URI change: https://github.com/joffreygonin/hbp-validation-framework_dev/issues/92

appukuttan-shailesh commented 7 years ago

All the minor and easy changes have been taken care of. The more elaborate ones are: 1) changing methods to accept a single parameter and determining the type of input internally 2) the change from UUID to URI - awaits changes on the API 3) the change from app ID to collab ID - awaits changes on the API ... (plus any others I have missed above, and shall re-check later)

As the client is in a usable state, we can attend to these a bit later I suppose. Will move on to the other tasks now.

apdavison commented 7 years ago

ok, so how about changing the version to 0.3.0 for now (don't forget to change it in setup.py as well as in the docs), and I will merge the PR? - the more extensive changes we can do later.

appukuttan-shailesh commented 7 years ago

That is a good idea. We could probably address the few pending minor issues above, and I will change to 0.3.0.

appukuttan-shailesh commented 7 years ago

@apdavison : Ready to be merged.