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.

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

Jump to bottom

Fix remaining docs for /tx APIs #727

Merged
merged 1 commit into from
Feb 12, 2020
Merged

Fix remaining docs for /tx APIs #727

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ If you're using a custom control container, or want to make the API calls direct

```
apiclient -u /settings -m PATCH -d '{"host-containers": {"admin": {"enabled": true}}}'
apiclient -u /settings/commit_and_apply -m POST
apiclient -u /tx/commit_and_apply -m POST
```

Once you're in the admin container, you can run `sheltie` to get a full root shell in the Thar host.
Expand Down Expand Up @@ -306,7 +306,7 @@ As long as you define the three fields above -- `source` with a URI, and `enable
Here's an example of adding a custom host container:
```
apiclient -u /settings -X PATCH -d '{"host-containers": {"custom": {"source": "MY-CONTAINER-URI", "enabled": true, "superpowered": false}}}'
apiclient -u /settings/commit_and_apply -X POST
apiclient -u /tx/commit_and_apply -X POST
```

If the `enabled` flag is `true`, it will be started automatically.
Expand Down
2 changes: 1 addition & 1 deletion workspaces/api/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ paths:
type: array
items:
type: string
# `style: form` and `explode: false` format parameters as such: /settings/apply?keys=settings.foo,settings.bar
# `style: form` and `explode: false` format parameters as such: /tx/apply?keys=settings.foo,settings.bar
style: form
explode: false
required: false
Expand Down