-
Notifications
You must be signed in to change notification settings - Fork 87
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
docs: add missing actor-tasks endpoint #1510
base: master
Are you sure you want to change the base?
Conversation
add missing actor-tasks endpoint add TODO's to be discussed regarding categorization & linking add missing endpoint to openapi.yaml
Changed from draft too early, my mistake still needs work |
This is not a single endpoint, but an entire group of endpoints that lets you to | ||
retrieve and manage the last run of given actor task or any of its default storages. | ||
All the endpoints require an authentication token. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not gonna lie, this is confusing. Can you spare the time to split this into four endpoints instead, each with their own documentation?
Of course, if that's something you want to pursue later, we can merge this as is - it sure is better than nothing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh I fully agree. This is something that is next on TODO list, to split this and every other endpoint that is done this way into separate ones. This PR was meant to just reintroduce the missing endpoint so we have parity between old API Blueprint and current OpenAPI
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, right. I trust you to track that somewhere 🙂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If I'm not mistaken we have two like this already
and this would be the third like that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM - some doc is better than undocumented endpoints. I imagine you won't be able to use the "try it out" box in the docs that comfortably, which is a shame...
add missing actor-tasks endpoint
add TODO's to be discussed regarding categorization & linking add missing endpoint to openapi.yaml