File size: 3,045 Bytes
d1ceb73 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
openapi: 3.0.1
info:
title: Jupyter Server Terminals API
description: Terminals API
contact:
name: Jupyter Project
url: https://jupyter.org
version: "1"
servers:
- url: /
paths:
/api/terminals:
get:
tags:
- terminals
summary: Get available terminals
responses:
200:
description: A list of all available terminal ids.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Terminal"
403:
description: Forbidden to access
content: {}
404:
description: Not found
content: {}
post:
tags:
- terminals
summary: Create a new terminal
responses:
200:
description: Successfully created a new terminal
content:
application/json:
schema:
$ref: "#/components/schemas/Terminal"
403:
description: Forbidden to access
content: {}
404:
description: Not found
content: {}
/api/terminals/{terminal_id}:
get:
tags:
- terminals
summary: Get a terminal session corresponding to an id.
parameters:
- name: terminal_id
in: path
description: ID of terminal session
required: true
schema:
type: string
responses:
200:
description: Terminal session with given id
content:
application/json:
schema:
$ref: "#/components/schemas/Terminal"
403:
description: Forbidden to access
content: {}
404:
description: Not found
content: {}
delete:
tags:
- terminals
summary: Delete a terminal session corresponding to an id.
parameters:
- name: terminal_id
in: path
description: ID of terminal session
required: true
schema:
type: string
responses:
204:
description: Successfully deleted terminal session
content: {}
403:
description: Forbidden to access
content: {}
404:
description: Not found
content: {}
components:
schemas:
Terminal:
required:
- name
type: object
properties:
name:
type: string
description: name of terminal
last_activity:
type: string
description: |
ISO 8601 timestamp for the last-seen activity on this terminal. Use
this to identify which terminals have been inactive since a given time.
Timestamps will be UTC, indicated 'Z' suffix.
description: A Terminal object
parameters:
terminal_id:
name: terminal_id
in: path
description: ID of terminal session
required: true
schema:
type: string
|