search

SkipLabs / skip

Skip is a framework for building reactive services
https://skiplabs.io
MIT License
155 stars 10 forks source link

Document runService #514

Closed jberdine closed 17 hours ago

jberdine commented 4 days ago

I would like to have @beauby check this for correctness.

jberdine commented 4 days ago

I'm happy to have #515 first and I can rebase and update this. Updating the docs myself and having you check them is a good way to check that I understand what is going on.

beauby commented 4 days ago

I'm happy to have #515 first and I can rebase and update this. Updating the docs myself and having you check them is a good way to check that I understand what is going on.

Perfect then, I'm currently fixing the examples but the meat of #515 is ready.

jberdine commented 4 days ago

I'm happy to have #515 first and I can rebase and update this. Updating the docs myself and having you check them is a good way to check that I understand what is going on.

Perfect then, I'm currently fixing the examples but the meat of #515 is ready.

Looking now.

jberdine commented 3 days ago

Some rewording still to do, but here is a version that I think is updated for the dual-port service.

jberdine commented 19 hours ago

I think this is ready now. I reworded to improve consistency and, I think, clarity. The main thing is I removed all mention of instantiating resources "if necessary" and the docs read as if the instantiation always happens now. The reuse should not be visible to clients IIUC. The main point though is that stating that resource instances might be reused lets in a complication and unclear interaction with DELETE, where it may not be clear whether DELETE on a uuid for a reused resource deletes the original or not. To resolve this, the distinction between resource instances and stream ids would need to be exposed in the documentation, and that seems like a valueless complication.

beauby commented 17 hours ago

LGTM!