Skip to content

Commit 6819f23

Browse files
committed
More helpful docstring for ActionView.get
1 parent 05b2747 commit 6819f23

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/labthings/views/__init__.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,12 @@ def __init_subclass__(cls):
171171
@classmethod
172172
def get(cls):
173173
"""
174-
Default method for GET requests. Returns the action queue (including already finished actions) for this action
174+
List running and completed actions.
175+
176+
Actions are run with `POST` requests. See the `POST` method for this URL for
177+
details of the action. Sending a `GET` request to an action endpoint will return
178+
action descriptions for each time the action has been run, including whether they
179+
have completed, and any return values.
175180
"""
176181
queue_schema = build_action_schema(cls.schema, cls.args)(many=True)
177182
return queue_schema.dump(cls._deque)

0 commit comments

Comments
 (0)