|
3 | 3 | - type: object
|
4 | 4 | required:
|
5 | 5 | - id
|
6 |
| - - status |
7 |
| - - created |
8 |
| - - process |
9 | 6 | - type
|
| 7 | + - status |
10 | 8 | properties:
|
11 | 9 | id:
|
12 | 10 | type: string
|
13 |
| - process: |
14 |
| - $ref: process.yaml |
15 | 11 | type:
|
16 | 12 | type: string
|
17 |
| - example: |
| 13 | + description: |
| 14 | + An indication of the API that created this job. This can be an |
| 15 | + OGC API such as processes, coverages, etc. OR an openeo API. |
| 16 | + This values needs to come from a controlled vocabulary the the |
| 17 | + current set of values is "process" (indicating that this job was |
| 18 | + created by an OAProc process), "wps" (indicating that this job |
| 19 | + was created by a WPS process) or openeo (indicating that this |
| 20 | + job was created by an OpenEO process). |
| 21 | + examples: |
18 | 22 | - process
|
19 | 23 | - wps
|
20 | 24 | - openeo
|
| 25 | + process: |
| 26 | + description: |
| 27 | + The value of this parameter is a description of the entity that |
| 28 | + created this job. The value of this property depends on the value |
| 29 | + of the "type" property. |
| 30 | + |
| 31 | + If the value of the "type" property is "process" or "wps" then |
| 32 | + this property SHALL be present and its value SHALL be a description |
| 33 | + of the process that created this job encoded in-line or referenced |
| 34 | + via a link. |
| 35 | + |
| 36 | + If the value of the "type" property is "openeo" then this property |
| 37 | + SHALL be present in the status response and its value SHALL be the |
| 38 | + process graph as per the OpenEO specification. |
| 39 | + |
| 40 | + If the value of the "type" property is not "process", "wps" or |
| 41 | + "openeo" then the value of the property SHOULD be a link pointing |
| 42 | + to the entity that created this job (e.g. an asychronous coverage |
| 43 | + request URL). |
| 44 | + oneOf: |
| 45 | + - type: object |
| 46 | + - $ref: "../common-core/link.yaml" |
21 | 47 | status:
|
| 48 | + description: |
| 49 | + The status of the job. The value space depends on the value of |
| 50 | + the "type" property. |
| 51 | + |
| 52 | + If the value of the "type" property is not "openeo" then the value |
| 53 | + space of this property SHALL be defined in "statusCode.yaml". |
| 54 | + |
| 55 | + If the value of the "type" property is "openop" then the value |
| 56 | + space of this property SHALL be "created", "queued", "running", |
| 57 | + "canceled", "finished" or "error". |
22 | 58 | oneOf:
|
23 |
| - $ref: "statusCode.yaml" |
| 59 | + - $ref: "statusCode.yaml" |
| 60 | + - type: string |
| 61 | + enum: |
| 62 | + - created |
| 63 | + - queued |
| 64 | + - running |
| 65 | + - canceled |
| 66 | + - finished |
| 67 | + - error |
24 | 68 | message:
|
25 | 69 | type: string
|
26 | 70 | exception:
|
27 | 71 | $ref: "../common-core/exception.yaml"
|
28 | 72 | created:
|
| 73 | + description: |
| 74 | + The date/time that this job was created. |
| 75 | + If the value of the "type" property is "openeo" then this property |
| 76 | + SHALL be present in the status response. |
29 | 77 | type: string
|
30 | 78 | format: date-time
|
31 | 79 | started:
|
|
0 commit comments