Skip to content
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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

TC-MO
Copy link
Contributor

@TC-MO TC-MO commented Mar 26, 2025

add missing actor-tasks endpoint
add TODO's to be discussed regarding categorization & linking add missing endpoint to openapi.yaml

add missing actor-tasks endpoint
add TODO's to be discussed regarding categorization & linking
add missing endpoint to openapi.yaml
@TC-MO TC-MO self-assigned this Mar 26, 2025
@TC-MO TC-MO added documentation Improvements or additions to documentation. adhoc Ad-hoc unplanned task added during the sprint. t-docs Issues owned by technical writing team. labels Mar 26, 2025
@TC-MO TC-MO marked this pull request as ready for review March 27, 2025 13:53
@TC-MO
Copy link
Contributor Author

TC-MO commented Mar 27, 2025

Changed from draft too early, my mistake still needs work

@TC-MO TC-MO marked this pull request as draft March 27, 2025 14:04
@TC-MO TC-MO marked this pull request as ready for review April 3, 2025 09:04
Comment on lines +6 to +8
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.
Copy link
Contributor

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

Copy link
Contributor Author

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

Copy link
Contributor

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 🙂

Copy link
Contributor Author

@TC-MO TC-MO Apr 7, 2025

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

Get last run
Get run

and this would be the third like that.

Copy link
Contributor

@janbuchar janbuchar left a 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...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
adhoc Ad-hoc unplanned task added during the sprint. documentation Improvements or additions to documentation. t-docs Issues owned by technical writing team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants