Skip to content

Misc docs improvements #2163

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
May 11, 2021
Merged

Misc docs improvements #2163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cbb1308
Misc docs improvements
deliahu May 10, 2021
67bb232
Merge branch 'master' into misc-docs
deliahu May 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/clusters/management/create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ node_groups:
spot: false
# ...

# subnet visibility [public (instances will have public IPs) | private (instances will not have public IPs)]
# subnet visibility for instances [public (instances will have public IPs) | private (instances will not have public IPs)]
subnet_visibility: public

# NAT gateway (required when using private subnets) [none | single | highly_available (a NAT gateway per availability zone)]
Expand Down
2 changes: 1 addition & 1 deletion docs/workloads/async/example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ curl http://<load_balancer_url>/iris-classifier/<id> # <id> is the request id t

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

It is also possible to setup a webhook in your handler to get the response sent to a pre-defined web server once the
workload completes or fails. You can read more about it in the [webhook documentation](./webhooks.md).
Expand Down
5 changes: 3 additions & 2 deletions docs/workloads/async/handler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ class Handler:
request_id (optional): The request id string that identifies a workload

Returns:
Workload result or batch of results.
JSON-serializeable result.
"""
pass
```
Expand Down Expand Up @@ -192,7 +192,8 @@ class Handle:

## API responses

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

## Chaining APIs

Expand Down