ogcapi-processes/openapi/paths/processes-dru/pProcessDescriptionReplaceUndeploy.yaml at 01521cddad229a2c2f48c1770884e6688872d20a · opengeospatial/ogcapi-processes · GitHub

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
# Process Description
get:
   summary: retrieve a process description
   description:  |
      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:

      Implementations SHOULD consider supporting the OGC process description.

      For more information, see [Section 7.8](https://docs.ogc.org/is/18-062r2/18-062r2.html#sc_process_description).
   operationId: getProcessDescription
   tags:
     - Processes
   parameters:
     - $ref: "../../parameters/processes-core/processID-path.yaml"
   responses:
     200:
       $ref: "../../responses/processes-core/rProcessDescription.yaml"
     404:
       $ref: "../../responses/common-core/rNotFound.yaml"
put:
   summary: replace a process.
   description: |
     Replaces a process.

     For more information, see [Section 6.4](http://docs.ogc.org/DRAFTS/20-044.html#_18582f42-ebc6-4284-9333-c089068f62b6).
   operationId: replace
   tags:
     - DRU
   parameters:
     - $ref: "../../parameters/processes-core/processID-path.yaml"
   requestBody:
     description: |-
       An OGC Application Package used to deploy a new process.
     required: true
     content:
       application/ogcapppkg+json:
         schema:
           $ref: "../../schemas/processes-dru/ogcapppkg.yaml"
       application/cwl:
         schema:
           #$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
           $ref: "../../schemas/cwl/cwl.yaml"
       application/cwl+json:
         schema:
           #$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
           $ref: "../../schemas/cwl/cwl.yaml"
       application/cwl+yaml:
         schema:
           #$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
           $ref: "../../schemas/cwl/cwl.yaml"
   responses:
     200:
       $ref: "../../responses/processes-dru/rProcessSummary.yaml"
     201:
       $ref: "../../responses/processes-dru/rProcessSummary.yaml"
     202:
       $ref: "../../responses/processes-dru/rProcessSummary.yaml"
     204:
       $ref: "../../responses/processes-core/rEmpty.yaml"
     400:
       $ref: "../../responses/common-core/rException.yaml"
     403:
       $ref: "../../responses/processes-dru/rImmutableProcess.yaml"
     404:
       $ref: "../../responses/common-core/rNotFound.yaml"
     409:
       $ref: "../../responses/processes-dru/rDuplicateProcess.yaml"
     500:
       $ref: "../../responses/common-core/rServerError.yaml"
delete:
   summary: undeploy a process.
   description: |
     Undeploys a process.

     For more information, see [Section 6.5](http://docs.ogc.org/DRAFTS/20-044.html#_16391f9e-538f-4a84-9710-72a6bab82842).
   operationId: undeploy
   tags:
     - DRU
   parameters:
     - $ref: "../../parameters/processes-core/processID-path.yaml"
   responses:
     204:
       $ref: "../../responses/processes-core/rEmpty.yaml"
     403:
       $ref: "../../responses/processes-dru/rImmutableProcess.yaml"
     404:
       $ref: "../../responses/common-core/rNotFound.yaml"
     500:
       $ref: "../../responses/common-core/rServerError.yaml"