Clarify routes and responses following REST design principals

cloudmesh / cloudmesh-cc

Cloudmesh compute coordinator the execute compute intensife workflows on remote resources

https://cloudmesh.github.io/cloudmesh-cc/

Other

2 stars 0 forks source link

Clarify routes and responses following REST design principals #17

Closed laszewsk closed 1 year ago

laszewsk commented 2 years ago

[x] service: lots of errors also in cc.py where we call it
[ ] add_job has no return (bool)
[x] needs complete review and partial reimplementation
[x] graoh should refresh upon detection of SVG file change
[x] table implementation from datatables is missing
[x] example is not documenting all methods using REST

jpfleischer commented 1 year ago

not sure if add_job needs a boolean return. https://github.com/cloudmesh/cloudmesh-cc/blob/c47bd689d1e34b6636d3a5192c1349fd45e6a37a/cloudmesh/cc/service/service.py#L1429

as it is, it returns the workflow and its jobs, for user confirmation that the new job is in there. if it fails then it throws some exception.

and i dont think cc.py has any errors when it is called so maybe this is just a really old issue.

laszewsk commented 1 year ago

maybe we need to do

https://restfulapi.net/http-status-codes/

here is more info, so we need to learn better what all needs to go in a response if we use fastapi

jpfleischer commented 1 year ago

rest test is finished https://github.com/cloudmesh/cloudmesh-cc/blob/main/tests/test_012_service_localhost.py the status code that these provide are consistent with the rest status codes, including 200 for OK, 307 for redirect, 405 for method not allowed, etc. most are already implemented automatically by FastAPI but others are coded and ensured by me.