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

Add documentation for exec websocket #9679

Merged
merged 18 commits into from
Jan 8, 2021
Merged

Add documentation for exec websocket #9679

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
b3c88f1
Initial draft of Alloc Exec websocket endpoint
Oct 31, 2019
601d751
Change resize message for consistency
backspace Dec 18, 2020
8180347
Add authentication message documentation
backspace Dec 18, 2020
9186caf
Fix message syntax
backspace Dec 18, 2020
c6a4473
Update message introduction wording
backspace Dec 18, 2020
82bf50a
Add documentation for ws_handshake query parameter
backspace Dec 18, 2020
fd8e602
Fix typo
backspace Dec 18, 2020
014f5c4
Fix capitalisations
backspace Dec 18, 2020
b7c2691
Add missing word
backspace Dec 18, 2020
17fe7d1
Change parameter wording for consistency
backspace Dec 18, 2020
6fe6077
Update wording
backspace Dec 18, 2020
b7f841e
Fix wording
backspace Dec 18, 2020
60d0cec
Fix syntax
backspace Dec 18, 2020
f0eb3cb
Add missing word
backspace Dec 18, 2020
07ffffe
Remove unnecessary whitespace
backspace Jan 7, 2021
ace546f
Merge branch 'master' into d-doc-alloc-exec-websocket-redux
backspace Jan 7, 2021
0f8c91c
Add sample request and response
backspace Jan 7, 2021
d5bd0c2
Move response explanation to separate line
backspace Jan 8, 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
Prev Previous commit
Next Next commit
Add missing word
  • Loading branch information
@backspace
backspace committed Dec 18, 2020
commit f0eb3cb449518460530a4d4f1f70293929df53ec
2 changes: 1 addition & 1 deletion website/pages/api-docs/allocations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -737,7 +737,7 @@ The table below shows this endpoint's support for
part of the path.
- `command` `(string: <required>)` - Specifies the command to be executed. This
must be a JSON-encoded array of the command to be executed, e.g. `["echo", "hi"]`
or `["/bin/bash"]`. This is specified as query parameter.
or `["/bin/bash"]`. This is specified as a query parameter.
- `task` `(string: <required>)` - Specifies the task name, as a query parameter.
- `tty` `(bool: false)` - Specifies whether a TTY is allocated for this task, as
a query parameter.
Expand Down