Skip to content

Commit 0b2f692

Browse files
committed
add copy of uws-responses.yaml to repo
1 parent 77b697a commit 0b2f692

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

openapi/uws/uws-responses.yaml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# UWS create job response
2+
created:
3+
description: standard UWS 1.1 redirect to the created job URL
4+
headers:
5+
location:
6+
schema:
7+
type: string
8+
format: uri
9+
invalid-phase-change:
10+
description: the requested phase change is invalid
11+
content:
12+
text/plain:
13+
schema:
14+
type: string
15+
job-listing:
16+
description: list of jobs owned by the caller
17+
content:
18+
text/xml:
19+
schema:
20+
type: object
21+
xml:
22+
name: jobs
23+
prefix: uws
24+
namespace: http://www.ivoa.net/xml/UWS/v1.0
25+
example: |
26+
<uws:jobs xmlns:uws="http://www.ivoa.net/xml/UWS/v1.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1">
27+
<uws:jobref id="loqqxg8jlah0r8wp">
28+
<uws:phase>PENDING</uws:phase>
29+
<uws:runId>TEST</uws:runId>
30+
<uws:ownerId>somebody</uws:ownerId>
31+
<uws:creationTime>2024-07-16T16:38:33.090Z</uws:creationTime>
32+
</uws:jobref>
33+
...
34+
</uws:job>
35+
36+
job:
37+
description: a single UWS Job
38+
content:
39+
text/xml:
40+
schema:
41+
type: object
42+
xml:
43+
name: job
44+
prefix: uws
45+
namespace: http://www.ivoa.net/xml/UWS/v1.0
46+
example: |
47+
<uws:job xmlns:uws="http://www.ivoa.net/xml/UWS/v1.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1">
48+
<uws:jobId>loqqxg8jlah0r8wp</uws:jobId>
49+
<uws:ownerId>somebody</uws:ownerId>
50+
<uws:phase>PENDING</uws:phase>
51+
<uws:quote>2024-07-17T16:38:33.089Z</uws:quote>
52+
<uws:creationTime>2024-07-16T16:38:33.090Z</uws:creationTime>
53+
<uws:startTime xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true" />
54+
<uws:endTime xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true" />
55+
<uws:executionDuration>28800</uws:executionDuration>
56+
<uws:destruction>2024-07-23T16:38:33.089Z</uws:destruction>
57+
<uws:parameters />
58+
<uws:results />
59+
</uws:job>
60+
61+

0 commit comments

Comments
 (0)