-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
147 lines (147 loc) · 4.84 KB
/
openapi.yaml
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
openapi: "3.0.0"
info:
title: Papermill Jupyter Report
version: "1.1.0"
paths:
/:
get:
summary: Display a form to generate a report
responses:
"200":
description: Form to generate a report
content:
application/html:
schema:
type: string
post:
description: Callback for the template generation form
responses:
"201":
description: The generated report
content:
application/html:
schema:
type: string
"500":
description: Error at report generation
content:
application/html:
schema:
type: string
/{templatePath}:
get:
summary: Generate the report
parameters:
- name: templatePath
in: path
required: true
description: Notebook path (should end with .ipynb)
schema:
type: string
example: subfolder/simple_execute.ipynb
- name: variable
in: query
description: name=value to be passed to the report template
schema:
type: string
example: msg=hello&a=11
responses:
"200":
description: The generated report
content:
application/html:
schema:
type: string
"404":
description: Template not found
content:
application/html:
schema:
type: string
"500":
description: Unexpected error
content:
application/html:
schema:
type: string
/api/templates/:
get:
summary: List all report templates
responses:
"200":
description: The list of available report templates
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
templates:
type: array
items:
type: object
additionalProperties: false
properties:
path:
type: string
parameters:
type: array
items:
type: object
additionalProperties: false
properties:
name:
type: string
description: Parameter name
inferred_type_name:
type: string
description: Parameter inferred type
default:
type: string
description: Default parameter value
help:
type: string
description: Parameter help
example:
{
"templates": [
{
"path": "broken_parameters.ipynb",
"parameters": [
{
"name": "msg",
"inferred_type_name": "None",
"default": "None",
"help": ""
},
{
"name": "a",
"inferred_type_name": "float",
"default": "2.25",
"help": "Variable a"
},
{
"name": "b",
"inferred_type_name": "List[str]",
"default": "['Hello','World']",
"help": "Nice list"
}
]
},
{
"path": "no_parameters.ipynb",
"parameters": []
},
{
"path": "subfolder/simple_execute.ipynb",
"parameters": [
{
"name": "msg",
"inferred_type_name": "None",
"default": "None",
"help": ""
}
]
}
]
}