Skip to content

Commit 42088f6

Browse files
authored
Misc docs improvements (#2163)
1 parent 9780e27 commit 42088f6

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

docs/clusters/management/create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ node_groups:
5050
spot: false
5151
# ...
5252

53-
# subnet visibility [public (instances will have public IPs) | private (instances will not have public IPs)]
53+
# subnet visibility for instances [public (instances will have public IPs) | private (instances will not have public IPs)]
5454
subnet_visibility: public
5555

5656
# NAT gateway (required when using private subnets) [none | single | highly_available (a NAT gateway per availability zone)]

docs/workloads/async/example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ curl http://<load_balancer_url>/iris-classifier/<id> # <id> is the request id t
145145

146146
Depending on the status of your workload, you will get different responses back. The possible workload status
147147
are `in_queue | in_progress | failed | completed`. The `result` and `timestamp` keys are returned if the status
148-
is `completed`.
148+
is `completed`. The result will remain queryable for 7 days after the request was completed.
149149

150150
It is also possible to setup a webhook in your handler to get the response sent to a pre-defined web server once the
151151
workload completes or fails. You can read more about it in the [webhook documentation](./webhooks.md).

docs/workloads/async/handler.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ class Handler:
7373
request_id (optional): The request id string that identifies a workload
7474
7575
Returns:
76-
Workload result or batch of results.
76+
JSON-serializeable result.
7777
"""
7878
pass
7979
```
@@ -192,7 +192,8 @@ class Handle:
192192

193193
## API responses
194194

195-
Currently, AsyncAPI responses of your `handle_async()` method have to be a JSON-serializable dictionary.
195+
The return value of your `handle_async()` method must be a JSON-serializable dictionary. The result for
196+
each request will remain queryable for 7 days after the request was completed.
196197

197198
## Chaining APIs
198199

0 commit comments

Comments
 (0)