Experimental
Schema
InteractRequest
Type:
object
InteractRequest is one frame on the bidirectional interaction stream.
Exactly one alternative must match
Type:
object
attach
· required
Schema:
ProcessAttach
attach opens or resumes the interaction.
All schema constraints and annotations
{
"$ref": "#/components/schemas/ProcessAttach",
"description": "attach opens or resumes the interaction."
}All schema constraints and annotations
{
"properties": {
"attach": {
"$ref": "#/components/schemas/ProcessAttach",
"description": "attach opens or resumes the interaction."
}
},
"required": [
"attach"
],
"title": "attach",
"type": "object"
}Type:
object
closeStdin
· required
Type:
boolean
close_stdin closes standard input when true; false has no effect, including on a PTY.
On a PTY, true delivers the terminal's VEOF input through the line discipline and
does not close the PTY master; subsequent stdin frames remain valid. Terminal mode
owns interpretation: canonical mode treats VEOF as marking the end of input, while
raw mode delivers it as an ordinary input byte, so this promises delivery, never
interpretation. Each true frame on a PTY delivers exactly one VEOF input; unlike the
pipe path, repeated frames are not a no-op.
All schema constraints and annotations
{
"description": "close_stdin closes standard input when true; false has no effect, including on a PTY.\nOn a PTY, true delivers the terminal's VEOF input through the line discipline and\ndoes not close the PTY master; subsequent stdin frames remain valid. Terminal mode\nowns interpretation: canonical mode treats VEOF as marking the end of input, while\nraw mode delivers it as an ordinary input byte, so this promises delivery, never\ninterpretation. Each true frame on a PTY delivers exactly one VEOF input; unlike the\npipe path, repeated frames are not a no-op.",
"type": "boolean"
}All schema constraints and annotations
{
"properties": {
"closeStdin": {
"description": "close_stdin closes standard input when true; false has no effect, including on a PTY.\nOn a PTY, true delivers the terminal's VEOF input through the line discipline and\ndoes not close the PTY master; subsequent stdin frames remain valid. Terminal mode\nowns interpretation: canonical mode treats VEOF as marking the end of input, while\nraw mode delivers it as an ordinary input byte, so this promises delivery, never\ninterpretation. Each true frame on a PTY delivers exactly one VEOF input; unlike the\npipe path, repeated frames are not a no-op.",
"type": "boolean"
}
},
"required": [
"closeStdin"
],
"title": "close_stdin",
"type": "object"
}Type:
object
resize
· required
Schema:
TerminalSize
resize changes terminal size; portable-range dimensions on a running process without a PTY return FAILED_PRECONDITION.
All schema constraints and annotations
{
"$ref": "#/components/schemas/TerminalSize",
"description": "resize changes terminal size; portable-range dimensions on a running process without a PTY return FAILED_PRECONDITION."
}All schema constraints and annotations
{
"properties": {
"resize": {
"$ref": "#/components/schemas/TerminalSize",
"description": "resize changes terminal size; portable-range dimensions on a running process without a PTY return FAILED_PRECONDITION."
}
},
"required": [
"resize"
],
"title": "resize",
"type": "object"
}Type:
object
stdin
· required
Type:
string
stdin writes process standard input.
All schema constraints and annotations
{
"description": "stdin writes process standard input.",
"format": "byte",
"type": "string"
}All schema constraints and annotations
{
"properties": {
"stdin": {
"description": "stdin writes process standard input.",
"format": "byte",
"type": "string"
}
},
"required": [
"stdin"
],
"title": "stdin",
"type": "object"
}All schema constraints and annotations
{
"description": "InteractRequest is one frame on the bidirectional interaction stream.",
"oneOf": [
{
"properties": {
"attach": {
"$ref": "#/components/schemas/ProcessAttach",
"description": "attach opens or resumes the interaction."
}
},
"required": [
"attach"
],
"title": "attach",
"type": "object"
},
{
"properties": {
"closeStdin": {
"description": "close_stdin closes standard input when true; false has no effect, including on a PTY.\nOn a PTY, true delivers the terminal's VEOF input through the line discipline and\ndoes not close the PTY master; subsequent stdin frames remain valid. Terminal mode\nowns interpretation: canonical mode treats VEOF as marking the end of input, while\nraw mode delivers it as an ordinary input byte, so this promises delivery, never\ninterpretation. Each true frame on a PTY delivers exactly one VEOF input; unlike the\npipe path, repeated frames are not a no-op.",
"type": "boolean"
}
},
"required": [
"closeStdin"
],
"title": "close_stdin",
"type": "object"
},
{
"properties": {
"resize": {
"$ref": "#/components/schemas/TerminalSize",
"description": "resize changes terminal size; portable-range dimensions on a running process without a PTY return FAILED_PRECONDITION."
}
},
"required": [
"resize"
],
"title": "resize",
"type": "object"
},
{
"properties": {
"stdin": {
"description": "stdin writes process standard input.",
"format": "byte",
"type": "string"
}
},
"required": [
"stdin"
],
"title": "stdin",
"type": "object"
}
],
"title": "InteractRequest",
"type": "object",
"unevaluatedProperties": false
}