-
Notifications
You must be signed in to change notification settings - Fork 160
/
jobStepDefinition.yaml
171 lines (168 loc) · 5.81 KB
/
jobStepDefinition.yaml
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
openapi: 3.0.2
info:
title: Eclipse Kapua REST API - Jobs Step Definitions
version: '1.0'
contact:
name: Eclipse Kapua Dev Team
url: https://eclipse.org/kapua
email: kapua-dev@eclipse.org
license:
name: Eclipse Public License 2.0
url: https://www.eclipse.org/legal/epl-2.0
paths: { }
components:
parameters:
jobStepDefinitionId:
name: jobStepDefinitionId
in: path
description: The ID of the Job Step Definition on which to perform the operation
schema:
$ref: '../openapi.yaml#/components/schemas/kapuaId'
required: true
schemas:
jobStepDefinitionProperty:
type: object
properties:
name:
type: string
propertyType:
type: string
propertyValue:
type: string
required:
type: boolean
exampleValue:
type: string
readOnly: true
minLength:
type: integer
readOnly: true
maxLength:
type: integer
readOnly: true
minValue:
type: string
readOnly: true
maxValue:
type: string
readOnly: true
validationRegex:
type: string
readOnly: true
jobStepDefinition:
allOf:
- $ref: '../openapi.yaml#/components/schemas/kapuaNamedEntity'
- type: object
properties:
stepType:
type: string
processorName:
type: string
readerName:
type: string
writerName:
type: string
stepProperties:
type: array
items:
$ref: '#/components/schemas/jobStepDefinitionProperty'
example:
type: jobStepDefinition
id: AQ
createdOn: '2021-01-29T14:46:40.257Z'
createdBy: AQ
modifiedOn: '2021-01-29T14:46:40.257Z'
modifiedBy: AQ
optlock: 0
name: Asset Write
description: Writes to an asset using the Device Asset Management Service
processorName: org.eclipse.kapua.service.device.management.asset.job.DeviceAssetWriteTargetProcessor
stepProperties:
- exampleValue: |-
<?xml version="1.0" encoding="UTF-8"?>
<deviceAssets>
<deviceAsset>
<name>assetName</name>
<channels>
<channel>
<valueType>binary</valueType>
<value>EGVzdCBzdHJpbmcgdmFsdWU=</value>
<name>binaryTest</name>
</channel>
</channels>
</deviceAsset>
</deviceAssets>
name: assets
propertyType: org.eclipse.kapua.service.device.management.asset.DeviceAssets
required: true
- name: timeout
propertyType: java.lang.Long
propertyValue: '30000'
required: false
stepType: TARGET
jobStepDefinitionListResult:
allOf:
- $ref: '../openapi.yaml#/components/schemas/kapuaListResult'
- type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/jobStepDefinition'
example:
type: jobStepDefinitionListResult
limitExceeded: false
size: 2
items:
- type: jobStepDefinition
id: AQ
createdOn: '2021-01-29T14:46:40.257Z'
createdBy: AQ
modifiedOn: '2021-01-29T14:46:40.257Z'
modifiedBy: AQ
optlock: 0
name: Asset Write
description: Writes to an asset using the Device Asset Management Service
processorName: org.eclipse.kapua.service.device.management.asset.job.DeviceAssetWriteTargetProcessor
stepProperties:
- exampleValue: |-
<?xml version="1.0" encoding="UTF-8"?>
<deviceAssets>
<deviceAsset>
<name>assetName</name>
<channels>
<channel>
<valueType>binary</valueType>
<value>EGVzdCBzdHJpbmcgdmFsdWU=</value>
<name>binaryTest</name>
</channel>
</channels>
</deviceAsset>
</deviceAssets>
name: assets
propertyType: org.eclipse.kapua.service.device.management.asset.DeviceAssets
required: true
- name: timeout
propertyType: java.lang.Long
propertyValue: '30000'
required: false
stepType: TARGET
- type: jobStepDefinition
id: Ag
createdOn: '2021-01-29T14:46:48.061Z'
createdBy: AQ
modifiedOn: '2021-01-29T14:46:48.061Z'
modifiedBy: AQ
optlock: 0
name: Bundle Start
description: Starts a bundle using the Device Bundle Management Service
processorName: org.eclipse.kapua.service.device.management.bundle.job.DeviceBundleStartTargetProcessor
stepProperties:
- name: bundleId
propertyType: java.lang.String
required: true
- name: timeout
propertyType: java.lang.Long
propertyValue: '30000'
required: false
stepType: TARGET