Skip to content

Commit 26e325b

Browse files
gfenoygfenoy
committed
Add required yaml files composed of various existing schemas
Add short documentation on how to generate the desired files. Small fix to make operationId unique
1 parent e98f6f7 commit 26e325b

File tree

6 files changed

+162
-22
lines changed

6 files changed

+162
-22
lines changed

‎openapi/ogcapi-processes.yaml

+28-7
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,36 @@ paths:
2929

3030
# OGC API - Processes - Part 1: Core
3131
/processes:
32-
oneOf:
33-
- $ref: 'paths/processes-core/pProcessList.yaml'
34-
- $ref: 'paths/processes-dru/pDeploy.yaml'
32+
# If OGC API - Part 1 only uncomment the line below
33+
#$ref: 'paths/processes-core/pProcessList.yaml'
34+
35+
# OGC API - Processes Part 2: Deploy, Replace, Undeploy
36+
# The file below is produced with the following command:
37+
#
38+
# rm paths/processes-dru/pProcessListDeploy.yaml ; \
39+
# for i in processes-core/pProcessList.yaml \
40+
# processes-dru/pDeploy.yaml ; \
41+
# do \
42+
# cat paths/$i >> paths/processes-dru/pProcessListDeploy.yaml;
43+
# done
44+
#
45+
$ref: 'paths/processes-dru/pProcessListDeploy.yaml'
3546

3647
/processes/{processId}:
37-
oneOf:
38-
- $ref: 'paths/processes-core/pProcessDescription.yaml'
39-
- $ref: 'paths/processes-dru/pReplace.yaml'
40-
- $ref: 'paths/processes-dru/pUndeploy.yaml'
48+
# OGC API - Processes Part 1: Core
49+
#$ref: 'paths/processes-core/pProcessDescription.yaml'
50+
51+
# OGC API - Processes Part 2: Deploy, Replace, Undeploy
52+
# Use the following command to generate the file :
53+
#
54+
# rm paths/processes-dru/pProcessDescriptionReplaceUndeploy.yaml; \
55+
# for i in processes-core/pProcessDescription.yaml \
56+
# processes-dru/pReplace.yaml \
57+
# processes-dru/pUndeploy.yaml ; \
58+
# do \
59+
# cat paths/$i >> paths/processes-dru/pProcessDescriptionReplaceUndeploy.yaml ;\
60+
# done
61+
$ref: 'paths/processes-dru/pProcessDescriptionReplaceUndeploy.yaml'
4162

4263
/processes/{processId}/execution:
4364
$ref: 'paths/processes-workflows/pExecution-workflows.yaml'

‎openapi/paths/processes-dru/pDeploy.yaml

+8-7
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ post:
44
Deploys a process.
55
66
For more information, see [Section 6.3](http://docs.ogc.org/DRAFTS/20-044.html#_87a6983e-d060-458c-95ab-27e232e64822).
7-
operationId: execute
7+
operationId: deploy
88
tags:
99
- DRU
1010
parameters:
@@ -14,12 +14,13 @@ post:
1414
An OGC Application Package used to deploy a new process.
1515
required: true
1616
content:
17-
oneOf:
18-
- application/ogcapppkg+json:
19-
schema:
20-
$ref: "../../schemas/processes-dru/ogcapppkg.yaml"
21-
- application/cwl
22-
- application/cwl+json
17+
application/ogcapppkg+json:
18+
schema:
19+
$ref: "../../schemas/processes-dru/ogcapppkg.yaml"
20+
application/cwl:
21+
example: "empty"
22+
application/cwl+json:
23+
example: "{empty}"
2324
responses:
2425
201:
2526
$ref: "../../schemas/processes-core/processSummary.yaml"

‎openapi/paths/processes-dru/pProcessDescriptionReplaceUndeploy.yaml

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Process Description
2+
get:
3+
summary: retrieve a process description
4+
description: |
5+
The process description contains information about inputs and outputs and a link to the execution-endpoint for the process. The Core does not mandate the use of a specific process description to specify the interface of a process. That said, the Core requirements class makes the following recommendation:
6+
7+
Implementations SHOULD consider supporting the OGC process description.
8+
9+
For more information, see [Section 7.8](https://docs.ogc.org/is/18-062r2/18-062r2.html#sc_process_description).
10+
operationId: getProcessDescription
11+
tags:
12+
- Processes
13+
parameters:
14+
- $ref: "../../parameters/processes-core/processId-path.yaml"
15+
responses:
16+
200:
17+
$ref: "../../responses/processes-core/rProcessDescription.yaml"
18+
404:
19+
$ref: "../../responses/common-core/rNotFound.yaml"
20+
put:
21+
summary: replace a process.
22+
description: |
23+
Replaces a process.
24+
25+
For more information, see [Section 6.4](http://docs.ogc.org/DRAFTS/20-044.html#_18582f42-ebc6-4284-9333-c089068f62b6).
26+
operationId: replace
27+
tags:
28+
- DRU
29+
parameters:
30+
- $ref: "../../parameters/processes-core/processId-path.yaml"
31+
requestBody:
32+
description: |-
33+
An OGC Application Package used to deploy a new process.
34+
required: true
35+
content:
36+
application/ogcapppkg+json:
37+
schema:
38+
$ref: "../../schemas/processes-dru/ogcapppkg.yaml"
39+
application/cwl:
40+
example: "empty"
41+
application/cwl+json:
42+
example: "{empty}"
43+
responses:
44+
204:
45+
$ref: "../../responses/processes-dru/rEmpty.yaml"
46+
403:
47+
$ref: "../../responses/processes-dru/rImmutableProcess.yaml"
48+
404:
49+
$ref: "../../responses/common-core/rNotFound.yaml"
50+
409:
51+
$ref: "../../responses/processes-dru/rDuplicateProcess.yaml"
52+
500:
53+
$ref: "../../responses/common-core/rServerError.yaml"
54+
delete:
55+
summary: undeploy a process.
56+
description: |
57+
Undeploys a process.
58+
59+
For more information, see [Section 6.5](http://docs.ogc.org/DRAFTS/20-044.html#_16391f9e-538f-4a84-9710-72a6bab82842).
60+
operationId: undeploy
61+
tags:
62+
- DRU
63+
parameters:
64+
- $ref: "../../parameters/processes-core/processId-path.yaml"
65+
responses:
66+
204:
67+
$ref: "../../responses/processes-dru/rEmpty.yaml"
68+
403:
69+
$ref: "../../responses/processes-dru/rImmutableProcess.yaml"
70+
404:
71+
$ref: "../../responses/common-core/rNotFound.yaml"
72+
500:
73+
$ref: "../../responses/common-core/rServerError.yaml"

‎openapi/paths/processes-dru/pProcessListDeploy.yaml

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
get:
2+
summary: retrieve the list of available processes
3+
description: |
4+
The list of processes contains a summary of each process the OGC API - Processes offers, including the link to a more detailed description of the process.
5+
6+
For more information, see [Section 7.7]https://docs.ogc.org/is/18-062r2/18-062r2.html#sc_process_list).
7+
operationId: getProcesses
8+
tags:
9+
- Processes
10+
responses:
11+
200:
12+
$ref: "../../responses/processes-core/rProcessList.yaml"
13+
post:
14+
summary: deploy a process.
15+
description: |
16+
Deploys a process.
17+
18+
For more information, see [Section 6.3](http://docs.ogc.org/DRAFTS/20-044.html#_87a6983e-d060-458c-95ab-27e232e64822).
19+
operationId: deploy
20+
tags:
21+
- DRU
22+
parameters:
23+
- $ref: "../../parameters/processes-dru/w-param.yaml"
24+
requestBody:
25+
description: |-
26+
An OGC Application Package used to deploy a new process.
27+
required: true
28+
content:
29+
application/ogcapppkg+json:
30+
schema:
31+
$ref: "../../schemas/processes-dru/ogcapppkg.yaml"
32+
application/cwl:
33+
example: "empty"
34+
application/cwl+json:
35+
example: "{empty}"
36+
responses:
37+
201:
38+
$ref: "../../schemas/processes-core/processSummary.yaml"
39+
403:
40+
$ref: "../../responses/processes-dru/rImmutableProcess.yaml"
41+
409:
42+
$ref: "../../responses/processes-dru/rDuplicateProcess.yaml"
43+
500:
44+
$ref: "../../responses/common-core/rServerError.yaml"

‎openapi/paths/processes-dru/pReplace.yaml

+8-7
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ put:
44
Replaces a process.
55
66
For more information, see [Section 6.4](http://docs.ogc.org/DRAFTS/20-044.html#_18582f42-ebc6-4284-9333-c089068f62b6).
7-
operationId: execute
7+
operationId: replace
88
tags:
99
- DRU
1010
parameters:
@@ -14,12 +14,13 @@ put:
1414
An OGC Application Package used to deploy a new process.
1515
required: true
1616
content:
17-
oneOf:
18-
- application/ogcapppkg+json:
19-
schema:
20-
$ref: "../../schemas/processes-dru/ogcapppkg.yaml"
21-
- application/cwl
22-
- application/cwl+json
17+
application/ogcapppkg+json:
18+
schema:
19+
$ref: "../../schemas/processes-dru/ogcapppkg.yaml"
20+
application/cwl:
21+
example: "empty"
22+
application/cwl+json:
23+
example: "{empty}"
2324
responses:
2425
204:
2526
$ref: "../../responses/processes-dru/rEmpty.yaml"

‎openapi/paths/processes-dru/pUndeploy.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ delete:
44
Undeploys a process.
55
66
For more information, see [Section 6.5](http://docs.ogc.org/DRAFTS/20-044.html#_16391f9e-538f-4a84-9710-72a6bab82842).
7-
operationId: execute
7+
operationId: undeploy
88
tags:
99
- DRU
1010
parameters:

0 commit comments

Comments
 (0)