rs-client-libraries 0.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- config/staging_templates/README.md +17 -0
- config/staging_templates/yaml/additionalParameter.yaml +30 -0
- config/staging_templates/yaml/bbox.yaml +34 -0
- config/staging_templates/yaml/binaryInputValue.yaml +15 -0
- config/staging_templates/yaml/confClasses.yaml +22 -0
- config/staging_templates/yaml/descriptionType.yaml +36 -0
- config/staging_templates/yaml/dpr_openapi_schema.yaml +223 -0
- config/staging_templates/yaml/exception.yaml +31 -0
- config/staging_templates/yaml/execute.yaml +34 -0
- config/staging_templates/yaml/format.yaml +25 -0
- config/staging_templates/yaml/inlineOrRefData.yaml +18 -0
- config/staging_templates/yaml/inputDescription.yaml +32 -0
- config/staging_templates/yaml/inputValue.yaml +17 -0
- config/staging_templates/yaml/inputValueNoObject.yaml +22 -0
- config/staging_templates/yaml/jobControlOptions.yaml +19 -0
- config/staging_templates/yaml/jobList.yaml +27 -0
- config/staging_templates/yaml/landingPage.yaml +28 -0
- config/staging_templates/yaml/link.yaml +31 -0
- config/staging_templates/yaml/metadata.yaml +22 -0
- config/staging_templates/yaml/output.yaml +20 -0
- config/staging_templates/yaml/outputDescription.yaml +22 -0
- config/staging_templates/yaml/process.yaml +23 -0
- config/staging_templates/yaml/processList.yaml +27 -0
- config/staging_templates/yaml/processSummary.yaml +37 -0
- config/staging_templates/yaml/qualifiedInputValue.yaml +22 -0
- config/staging_templates/yaml/reference.yaml +21 -0
- config/staging_templates/yaml/results.yaml +16 -0
- config/staging_templates/yaml/schema.yaml +144 -0
- config/staging_templates/yaml/staging_openapi_schema.yaml +223 -0
- config/staging_templates/yaml/statusCode.yaml +22 -0
- config/staging_templates/yaml/statusInfo.yaml +52 -0
- config/staging_templates/yaml/subscriber.yaml +33 -0
- config/staging_templates/yaml/transmissionMode.yaml +19 -0
- rs_client/__init__.py +18 -0
- rs_client/ogcapi/__init__.py +15 -0
- rs_client/ogcapi/dpr_client.py +231 -0
- rs_client/ogcapi/ogcapi_client.py +282 -0
- rs_client/ogcapi/staging_client.py +178 -0
- rs_client/rs_client.py +277 -0
- rs_client/stac/__init__.py +15 -0
- rs_client/stac/auxip_client.py +70 -0
- rs_client/stac/cadip_client.py +70 -0
- rs_client/stac/catalog_client.py +479 -0
- rs_client/stac/stac_base.py +313 -0
- rs_client_libraries-0.2.dist-info/LICENSE +201 -0
- rs_client_libraries-0.2.dist-info/METADATA +44 -0
- rs_client_libraries-0.2.dist-info/RECORD +62 -0
- rs_client_libraries-0.2.dist-info/WHEEL +4 -0
- rs_common/__init__.py +20 -0
- rs_common/config.py +69 -0
- rs_common/init_opentelemetry.py +250 -0
- rs_common/logging.py +107 -0
- rs_common/prefect_utils.py +407 -0
- rs_common/utils.py +70 -0
- rs_workflows/__init__.py +15 -0
- rs_workflows/auxip_flow.py +70 -0
- rs_workflows/cadip_flow.py +69 -0
- rs_workflows/catalog_flow.py +71 -0
- rs_workflows/dpr_flow.py +272 -0
- rs_workflows/flow_utils.py +127 -0
- rs_workflows/on_demand_processing.py +243 -0
- rs_workflows/staging_flow.py +78 -0
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Copyright 2024 CS Group
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
type: object
|
|
16
|
+
properties:
|
|
17
|
+
title:
|
|
18
|
+
type: string
|
|
19
|
+
role:
|
|
20
|
+
type: string
|
|
21
|
+
href:
|
|
22
|
+
type: string
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Copyright 2024 CS Group
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
type: object
|
|
16
|
+
properties:
|
|
17
|
+
format:
|
|
18
|
+
$ref: "format.yaml"
|
|
19
|
+
transmissionMode:
|
|
20
|
+
$ref: "transmissionMode.yaml"
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Copyright 2024 CS Group
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
allOf:
|
|
16
|
+
- $ref: "descriptionType.yaml"
|
|
17
|
+
- type: object
|
|
18
|
+
required:
|
|
19
|
+
- schema
|
|
20
|
+
properties:
|
|
21
|
+
schema:
|
|
22
|
+
$ref: "schema.yaml"
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Copyright 2024 CS Group
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
allOf:
|
|
16
|
+
- type: object
|
|
17
|
+
properties:
|
|
18
|
+
inputs:
|
|
19
|
+
additionalProperties:
|
|
20
|
+
$ref: "inputDescription.yaml"
|
|
21
|
+
outputs:
|
|
22
|
+
additionalProperties:
|
|
23
|
+
$ref: "outputDescription.yaml"
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Copyright 2024 CS Group
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
type: object
|
|
16
|
+
required:
|
|
17
|
+
- processes
|
|
18
|
+
- links
|
|
19
|
+
properties:
|
|
20
|
+
processes:
|
|
21
|
+
type: array
|
|
22
|
+
items:
|
|
23
|
+
$ref: "processSummary.yaml"
|
|
24
|
+
links:
|
|
25
|
+
type: array
|
|
26
|
+
items:
|
|
27
|
+
$ref: "link.yaml"
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Copyright 2024 CS Group
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
allOf:
|
|
16
|
+
- $ref: "descriptionType.yaml"
|
|
17
|
+
- type: object
|
|
18
|
+
required:
|
|
19
|
+
- id
|
|
20
|
+
- version
|
|
21
|
+
properties:
|
|
22
|
+
id:
|
|
23
|
+
type: string
|
|
24
|
+
version:
|
|
25
|
+
type: string
|
|
26
|
+
jobControlOptions:
|
|
27
|
+
type: array
|
|
28
|
+
items:
|
|
29
|
+
$ref: "jobControlOptions.yaml"
|
|
30
|
+
outputTransmission:
|
|
31
|
+
type: array
|
|
32
|
+
items:
|
|
33
|
+
$ref: "transmissionMode.yaml"
|
|
34
|
+
links:
|
|
35
|
+
type: array
|
|
36
|
+
items:
|
|
37
|
+
$ref: "link.yaml"
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Copyright 2024 CS Group
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
allOf:
|
|
16
|
+
- $ref: "format.yaml"
|
|
17
|
+
- type: object
|
|
18
|
+
required:
|
|
19
|
+
- value
|
|
20
|
+
properties:
|
|
21
|
+
value:
|
|
22
|
+
$ref: "inputValue.yaml"
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Copyright 2024 CS Group
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
type: object
|
|
16
|
+
required:
|
|
17
|
+
- "$ref"
|
|
18
|
+
properties:
|
|
19
|
+
"$ref":
|
|
20
|
+
type: string
|
|
21
|
+
format: uri-reference
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Copyright 2024 CS Group
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
additionalProperties:
|
|
16
|
+
$ref: "inlineOrRefData.yaml"
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
# Copyright 2024 CS Group
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
oneOf:
|
|
16
|
+
- $ref: reference.yaml
|
|
17
|
+
- type: object
|
|
18
|
+
properties:
|
|
19
|
+
title:
|
|
20
|
+
type: string
|
|
21
|
+
multipleOf:
|
|
22
|
+
type: number
|
|
23
|
+
minimum: 0
|
|
24
|
+
exclusiveMinimum: true
|
|
25
|
+
maximum:
|
|
26
|
+
type: number
|
|
27
|
+
exclusiveMaximum:
|
|
28
|
+
type: boolean
|
|
29
|
+
default: false
|
|
30
|
+
minimum:
|
|
31
|
+
type: number
|
|
32
|
+
exclusiveMinimum:
|
|
33
|
+
type: boolean
|
|
34
|
+
default: false
|
|
35
|
+
maxLength:
|
|
36
|
+
type: integer
|
|
37
|
+
minimum: 0
|
|
38
|
+
minLength:
|
|
39
|
+
type: integer
|
|
40
|
+
minimum: 0
|
|
41
|
+
default: 0
|
|
42
|
+
pattern:
|
|
43
|
+
type: string
|
|
44
|
+
format: regex
|
|
45
|
+
maxItems:
|
|
46
|
+
type: integer
|
|
47
|
+
minimum: 0
|
|
48
|
+
minItems:
|
|
49
|
+
type: integer
|
|
50
|
+
minimum: 0
|
|
51
|
+
default: 0
|
|
52
|
+
uniqueItems:
|
|
53
|
+
type: boolean
|
|
54
|
+
default: false
|
|
55
|
+
maxProperties:
|
|
56
|
+
type: integer
|
|
57
|
+
minimum: 0
|
|
58
|
+
minProperties:
|
|
59
|
+
type: integer
|
|
60
|
+
minimum: 0
|
|
61
|
+
default: 0
|
|
62
|
+
required:
|
|
63
|
+
type: array
|
|
64
|
+
items:
|
|
65
|
+
type: string
|
|
66
|
+
minItems: 1
|
|
67
|
+
uniqueItems: true
|
|
68
|
+
enum:
|
|
69
|
+
type: array
|
|
70
|
+
items: {}
|
|
71
|
+
minItems: 1
|
|
72
|
+
uniqueItems: false
|
|
73
|
+
type:
|
|
74
|
+
type: string
|
|
75
|
+
enum:
|
|
76
|
+
- array
|
|
77
|
+
- boolean
|
|
78
|
+
- integer
|
|
79
|
+
- number
|
|
80
|
+
- object
|
|
81
|
+
- string
|
|
82
|
+
not:
|
|
83
|
+
oneOf:
|
|
84
|
+
- $ref: "schema.yaml"
|
|
85
|
+
- $ref: "reference.yaml"
|
|
86
|
+
allOf:
|
|
87
|
+
type: array
|
|
88
|
+
items:
|
|
89
|
+
oneOf:
|
|
90
|
+
- $ref: "schema.yaml"
|
|
91
|
+
- $ref: "reference.yaml"
|
|
92
|
+
oneOf:
|
|
93
|
+
type: array
|
|
94
|
+
items:
|
|
95
|
+
oneOf:
|
|
96
|
+
- $ref: "schema.yaml"
|
|
97
|
+
- $ref: "reference.yaml"
|
|
98
|
+
anyOf:
|
|
99
|
+
type: array
|
|
100
|
+
items:
|
|
101
|
+
oneOf:
|
|
102
|
+
- $ref: "schema.yaml"
|
|
103
|
+
- $ref: "reference.yaml"
|
|
104
|
+
items:
|
|
105
|
+
oneOf:
|
|
106
|
+
- $ref: "schema.yaml"
|
|
107
|
+
- $ref: "reference.yaml"
|
|
108
|
+
properties:
|
|
109
|
+
type: object
|
|
110
|
+
additionalProperties:
|
|
111
|
+
oneOf:
|
|
112
|
+
- $ref: "schema.yaml"
|
|
113
|
+
- $ref: "reference.yaml"
|
|
114
|
+
additionalProperties:
|
|
115
|
+
oneOf:
|
|
116
|
+
- $ref: "schema.yaml"
|
|
117
|
+
- $ref: "reference.yaml"
|
|
118
|
+
- type: boolean
|
|
119
|
+
default: true
|
|
120
|
+
description:
|
|
121
|
+
type: string
|
|
122
|
+
format:
|
|
123
|
+
type: string
|
|
124
|
+
default: {}
|
|
125
|
+
nullable:
|
|
126
|
+
type: boolean
|
|
127
|
+
default: false
|
|
128
|
+
readOnly:
|
|
129
|
+
type: boolean
|
|
130
|
+
default: false
|
|
131
|
+
writeOnly:
|
|
132
|
+
type: boolean
|
|
133
|
+
default: false
|
|
134
|
+
example: {}
|
|
135
|
+
deprecated:
|
|
136
|
+
type: boolean
|
|
137
|
+
default: false
|
|
138
|
+
contentMediaType:
|
|
139
|
+
type: string
|
|
140
|
+
contentEncoding:
|
|
141
|
+
type: string
|
|
142
|
+
contentSchema:
|
|
143
|
+
type: string
|
|
144
|
+
additionalProperties: false
|
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
# Copyright 2024 CS Group
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
# -------------- CAUTON: this schema is defined both in rs-server and rs-client-libraries
|
|
16
|
+
# repos (/config/staging_templates/staging_openapi_schema.yaml) - if the current file
|
|
17
|
+
# is updated, don't forget to update the file from the other repository
|
|
18
|
+
|
|
19
|
+
openapi: 3.0.0
|
|
20
|
+
info:
|
|
21
|
+
title: RS Staging API
|
|
22
|
+
version: 1.0.0
|
|
23
|
+
paths:
|
|
24
|
+
/processes:
|
|
25
|
+
get:
|
|
26
|
+
summary: Get a list of processes
|
|
27
|
+
responses:
|
|
28
|
+
'200':
|
|
29
|
+
description: Returns list of all available processes from config.
|
|
30
|
+
content:
|
|
31
|
+
application/json:
|
|
32
|
+
schema:
|
|
33
|
+
$ref: './processList.yaml'
|
|
34
|
+
/processes/{process_id}:
|
|
35
|
+
get:
|
|
36
|
+
summary: Get information on a specific process
|
|
37
|
+
parameters:
|
|
38
|
+
- name: process_id
|
|
39
|
+
in: path
|
|
40
|
+
required: true
|
|
41
|
+
schema:
|
|
42
|
+
type: string
|
|
43
|
+
responses:
|
|
44
|
+
'200':
|
|
45
|
+
description: Returns a description of a specific process
|
|
46
|
+
content:
|
|
47
|
+
application/json:
|
|
48
|
+
schema:
|
|
49
|
+
$ref: './process.yaml'
|
|
50
|
+
'404':
|
|
51
|
+
description: The requested URI was not found.
|
|
52
|
+
content:
|
|
53
|
+
application/json:
|
|
54
|
+
schema:
|
|
55
|
+
$ref: './exception.yaml'
|
|
56
|
+
text/html:
|
|
57
|
+
schema:
|
|
58
|
+
type: string
|
|
59
|
+
/processes/{process_id}/execution:
|
|
60
|
+
post:
|
|
61
|
+
summary: Execute a process
|
|
62
|
+
parameters:
|
|
63
|
+
- name: process_id
|
|
64
|
+
in: path
|
|
65
|
+
required: true
|
|
66
|
+
schema:
|
|
67
|
+
type: string
|
|
68
|
+
# Here both the request and the response need to be validates according to yaml schemas
|
|
69
|
+
requestBody:
|
|
70
|
+
description: Check the body from the request used to execute the process
|
|
71
|
+
content:
|
|
72
|
+
application/json:
|
|
73
|
+
schema:
|
|
74
|
+
$ref: './execute.yaml'
|
|
75
|
+
required: true
|
|
76
|
+
|
|
77
|
+
responses:
|
|
78
|
+
'200':
|
|
79
|
+
description: Result of synchronous execution
|
|
80
|
+
content:
|
|
81
|
+
application/json:
|
|
82
|
+
schema:
|
|
83
|
+
$ref: './statusInfo.yaml'
|
|
84
|
+
'201':
|
|
85
|
+
description: Started asynchronous execution. Created job.
|
|
86
|
+
content:
|
|
87
|
+
application/json:
|
|
88
|
+
schema:
|
|
89
|
+
$ref: './statusInfo.yaml'
|
|
90
|
+
"404":
|
|
91
|
+
description: The requested URI was not found.
|
|
92
|
+
content:
|
|
93
|
+
application/json:
|
|
94
|
+
schema:
|
|
95
|
+
$ref: './exception.yaml'
|
|
96
|
+
"500":
|
|
97
|
+
description: A server error occurred.
|
|
98
|
+
content:
|
|
99
|
+
application/json:
|
|
100
|
+
schema:
|
|
101
|
+
$ref: './exception.yaml'
|
|
102
|
+
/jobs:
|
|
103
|
+
get:
|
|
104
|
+
summary: Returns the status of all jobs.
|
|
105
|
+
responses:
|
|
106
|
+
'200':
|
|
107
|
+
description: Returns the status of all jobs.
|
|
108
|
+
content:
|
|
109
|
+
application/json:
|
|
110
|
+
schema:
|
|
111
|
+
$ref: './jobList.yaml'
|
|
112
|
+
'404':
|
|
113
|
+
description: The requested URI was not found.
|
|
114
|
+
content:
|
|
115
|
+
application/json:
|
|
116
|
+
schema:
|
|
117
|
+
$ref: './exception.yaml'
|
|
118
|
+
text/html:
|
|
119
|
+
schema:
|
|
120
|
+
type: string
|
|
121
|
+
/jobs/{job-id}:
|
|
122
|
+
get:
|
|
123
|
+
summary: Returns the status of a job.
|
|
124
|
+
parameters:
|
|
125
|
+
- name: job-id
|
|
126
|
+
in: path
|
|
127
|
+
description: local identifier of a job
|
|
128
|
+
required: true
|
|
129
|
+
schema:
|
|
130
|
+
type: string
|
|
131
|
+
responses:
|
|
132
|
+
'200':
|
|
133
|
+
description: The status of a job.
|
|
134
|
+
content:
|
|
135
|
+
application/json:
|
|
136
|
+
schema:
|
|
137
|
+
$ref: 'statusInfo.yaml'
|
|
138
|
+
'404':
|
|
139
|
+
description: The requested URI was not found.
|
|
140
|
+
content:
|
|
141
|
+
application/json:
|
|
142
|
+
schema:
|
|
143
|
+
$ref: './exception.yaml'
|
|
144
|
+
text/html:
|
|
145
|
+
schema:
|
|
146
|
+
type: string
|
|
147
|
+
'500':
|
|
148
|
+
description: A server error occurred.
|
|
149
|
+
content:
|
|
150
|
+
application/json:
|
|
151
|
+
schema:
|
|
152
|
+
$ref: './exception.yaml'
|
|
153
|
+
text/html:
|
|
154
|
+
schema:
|
|
155
|
+
type: string
|
|
156
|
+
delete:
|
|
157
|
+
summary: Deletes a specific job.
|
|
158
|
+
parameters:
|
|
159
|
+
- name: job-id
|
|
160
|
+
in: path
|
|
161
|
+
required: true
|
|
162
|
+
schema:
|
|
163
|
+
type: string
|
|
164
|
+
description: The ID of the job to be deleted.
|
|
165
|
+
responses:
|
|
166
|
+
'200':
|
|
167
|
+
description: Deletes a specific job.
|
|
168
|
+
content:
|
|
169
|
+
application/json:
|
|
170
|
+
schema:
|
|
171
|
+
$ref: './statusInfo.yaml'
|
|
172
|
+
'404':
|
|
173
|
+
description: The requested URI was not found.
|
|
174
|
+
content:
|
|
175
|
+
application/json:
|
|
176
|
+
schema:
|
|
177
|
+
$ref: './exception.yaml'
|
|
178
|
+
text/html:
|
|
179
|
+
schema:
|
|
180
|
+
type: string
|
|
181
|
+
'500':
|
|
182
|
+
description: A server error occurred.
|
|
183
|
+
content:
|
|
184
|
+
application/json:
|
|
185
|
+
schema:
|
|
186
|
+
$ref: './exception.yaml'
|
|
187
|
+
text/html:
|
|
188
|
+
schema:
|
|
189
|
+
type: string
|
|
190
|
+
/jobs/{job-id}/results:
|
|
191
|
+
get:
|
|
192
|
+
summary: Returns the results of a given job
|
|
193
|
+
parameters:
|
|
194
|
+
- name: job-id
|
|
195
|
+
in: path
|
|
196
|
+
required: true
|
|
197
|
+
schema:
|
|
198
|
+
type: string
|
|
199
|
+
responses:
|
|
200
|
+
'200':
|
|
201
|
+
description: Returns the status of all jobs.
|
|
202
|
+
content:
|
|
203
|
+
application/json:
|
|
204
|
+
schema:
|
|
205
|
+
$ref: './results.yaml'
|
|
206
|
+
'404':
|
|
207
|
+
description: The requested URI was not found.
|
|
208
|
+
content:
|
|
209
|
+
application/json:
|
|
210
|
+
schema:
|
|
211
|
+
$ref: './exception.yaml'
|
|
212
|
+
text/html:
|
|
213
|
+
schema:
|
|
214
|
+
type: string
|
|
215
|
+
'500':
|
|
216
|
+
description: A server error occurred.
|
|
217
|
+
content:
|
|
218
|
+
application/json:
|
|
219
|
+
schema:
|
|
220
|
+
$ref: './exception.yaml'
|
|
221
|
+
text/html:
|
|
222
|
+
schema:
|
|
223
|
+
type: string
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Copyright 2024 CS Group
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
type: string
|
|
16
|
+
nullable: false
|
|
17
|
+
enum:
|
|
18
|
+
- accepted
|
|
19
|
+
- running
|
|
20
|
+
- successful
|
|
21
|
+
- failed
|
|
22
|
+
- dismissed
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Copyright 2024 CS Group
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
type: object
|
|
16
|
+
required:
|
|
17
|
+
- jobID
|
|
18
|
+
- status
|
|
19
|
+
- type
|
|
20
|
+
properties:
|
|
21
|
+
processID:
|
|
22
|
+
type: string
|
|
23
|
+
type:
|
|
24
|
+
type: string
|
|
25
|
+
enum:
|
|
26
|
+
- process
|
|
27
|
+
jobID:
|
|
28
|
+
type: string
|
|
29
|
+
status:
|
|
30
|
+
$ref: "statusCode.yaml"
|
|
31
|
+
message:
|
|
32
|
+
type: string
|
|
33
|
+
created:
|
|
34
|
+
type: string
|
|
35
|
+
format: date-time
|
|
36
|
+
started:
|
|
37
|
+
type: string
|
|
38
|
+
format: date-time
|
|
39
|
+
finished:
|
|
40
|
+
type: string
|
|
41
|
+
format: date-time
|
|
42
|
+
updated:
|
|
43
|
+
type: string
|
|
44
|
+
format: date-time
|
|
45
|
+
progress:
|
|
46
|
+
type: integer
|
|
47
|
+
minimum: 0
|
|
48
|
+
maximum: 100
|
|
49
|
+
links:
|
|
50
|
+
type: array
|
|
51
|
+
items:
|
|
52
|
+
$ref: "link.yaml"
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Copyright 2024 CS Group
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
description: |-
|
|
16
|
+
Optional URIs for callbacks for this job.
|
|
17
|
+
|
|
18
|
+
Support for this parameter is not required and the parameter may be
|
|
19
|
+
removed from the API definition, if conformance class **'callback'**
|
|
20
|
+
is not listed in the conformance declaration under `/conformance`.
|
|
21
|
+
type: object
|
|
22
|
+
required:
|
|
23
|
+
- successUrl
|
|
24
|
+
properties:
|
|
25
|
+
successUri:
|
|
26
|
+
type: string
|
|
27
|
+
format: uri
|
|
28
|
+
inProgressUri:
|
|
29
|
+
type: string
|
|
30
|
+
format: uri
|
|
31
|
+
failedUri:
|
|
32
|
+
type: string
|
|
33
|
+
format: uri
|