1+ openapi : 3.0.0
2+ info :
3+ title : WES-ELIXIR STDOUT & STDERR OpenAPI specification
4+ contact :
5+ name : ELIXIR Cloud & AAI group
6+ email : alexander.kanitz@alumni.ethz.ch
7+ license :
8+ name : Apache 2.0
9+ url : https://www.apache.org/licenses/LICENSE-2.0
10+ version : 0.14.0
11+ servers :
12+ - url : /wes-elixir/v1
13+ paths :
14+ /stdout/{run_id} :
15+ get :
16+ summary : |-
17+ Retrieves the content of the indicated run's STDOUT stream and returns
18+ it as plain text.
19+ parameters :
20+ - in : path
21+ name : run_id
22+ schema :
23+ type : string
24+ required : true
25+ description : Run identifier.
26+ operationId : get_stdout
27+ responses :
28+ 200 :
29+ description : |-
30+ STDOUT stream of indicated run as plain text.
31+ content :
32+ text/plain :
33+ schema :
34+ type : string
35+ example : " This is STDOUT."
36+ 400 :
37+ description : The request is malformed.
38+ content :
39+ application/json :
40+ schema :
41+ $ref : ' #/components/schemas/ErrorResponse'
42+ 401 :
43+ description : The request is unauthorized.
44+ content :
45+ application/json :
46+ schema :
47+ $ref : ' #/components/schemas/ErrorResponse'
48+ 403 :
49+ description : The requester is not authorized to perform this action.
50+ content :
51+ application/json :
52+ schema :
53+ $ref : ' #/components/schemas/ErrorResponse'
54+ 404 :
55+ description : The requested resource was not found.
56+ content :
57+ application/json :
58+ schema :
59+ $ref : ' #/components/schemas/ErrorResponse'
60+ 500 :
61+ description : An unexpected error occurred.
62+ content :
63+ application/json :
64+ schema :
65+ $ref : ' #/components/schemas/ErrorResponse'
66+ x-openapi-router-controller : api.controllers
67+ /stderr/{run_id} :
68+ get :
69+ summary : |-
70+ Retrieves the content of the indicated run's STDERR stream and returns
71+ it as plain text.
72+ operationId : get_stderr
73+ parameters :
74+ - in : path
75+ name : run_id
76+ schema :
77+ type : string
78+ required : true
79+ description : Run identifier.
80+ responses :
81+ 200 :
82+ description : |-
83+ STDERR stream of indicated run as plain text.
84+ content :
85+ text/plain :
86+ schema :
87+ type : string
88+ example : " This is STDERR."
89+ 400 :
90+ description : The request is malformed.
91+ content :
92+ application/json :
93+ schema :
94+ $ref : ' #/components/schemas/ErrorResponse'
95+ 401 :
96+ description : The request is unauthorized.
97+ content :
98+ application/json :
99+ schema :
100+ $ref : ' #/components/schemas/ErrorResponse'
101+ 403 :
102+ description : The requester is not authorized to perform this action.
103+ content :
104+ application/json :
105+ schema :
106+ $ref : ' #/components/schemas/ErrorResponse'
107+ 404 :
108+ description : The requested resource was not found.
109+ content :
110+ application/json :
111+ schema :
112+ $ref : ' #/components/schemas/ErrorResponse'
113+ 500 :
114+ description : An unexpected error occurred.
115+ content :
116+ application/json :
117+ schema :
118+ $ref : ' #/components/schemas/ErrorResponse'
119+ x-openapi-router-controller : api.controllers
120+ components :
121+ schemas :
122+ Error :
123+ required :
124+ - message
125+ - reason
126+ type : object
127+ properties :
128+ message :
129+ type : string
130+ description : |-
131+ A human readable message providing more details about the error.
132+ example :
133+ Required parameter 'xyz' is missing.
134+ reason :
135+ type : string
136+ description : |-
137+ Unique identifier for this error, but *not* the HTTP response code
138+ (e.g., name of exception).
139+ example : ValueError
140+ description : An individual error message.
141+ ErrorResponse :
142+ required :
143+ - code
144+ - errors
145+ - message
146+ type : object
147+ properties :
148+ code :
149+ type : integer
150+ description : HTTP status code (e.g., 400, 404).
151+ format : int64
152+ example : 400
153+ errors :
154+ type : array
155+ description : List of associated errors and warnings.
156+ items :
157+ $ref : ' #/components/schemas/Error'
158+ message :
159+ type : string
160+ description : |-
161+ A human readable message providing more details about the error.
162+ example : The request could not be interpreted.
163+ description : A response object for detailed error messages.
0 commit comments