forked from openBackhaul/ApplicationPattern
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ApplicationPattern+profileInstances.yaml
177 lines (152 loc) · 10.3 KB
/
ApplicationPattern+profileInstances.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
172
173
174
175
176
177
profile-instances:
- profile-name: 'ActionProfile'
uuid: '*-action-p-000' ## TODO: Replace "*" by ApplicationID and ReleaseNumber
capability:
operation-name: '/v1/start-application-in-generic-representation'
label: 'Inform about Application'
display-in-new-browser-window: false
configuration:
consequent-operation-reference: '/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bs-002/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name'
- profile-name: 'ActionProfile'
uuid: '*-action-p-001' ## TODO: Replace "*" by ApplicationID and ReleaseNumber
capability:
operation-name: '/v1/inform-about-application-in-generic-representation'
label: 'Release History'
display-in-new-browser-window: false
configuration:
consequent-operation-reference: '/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bs-004/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name'
- profile-name: 'ActionProfile'
uuid: '*-action-p-002' ## TODO: Replace "*" by ApplicationID and ReleaseNumber
capability:
operation-name: '/v1/inform-about-application-in-generic-representation'
label: 'API Documentation'
display-in-new-browser-window: true
configuration:
consequent-operation-reference: '/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-op-s-bs-005/layer-protocol=0/operation-server-interface-1-0:operation-server-interface-pac/operation-server-interface-capability/operation-name'
- profile-name: 'ActionProfile'
uuid: '*-action-p-???' ## TODO: Replace "*" by ApplicationID and ReleaseNumber and ??? by SequenceNumber
capability:
operation-name: ## TODO: Add generic representation operation that shall result in a new button and potentially new input fields
label: ## TODO: Add label of the new button
input-value-list:
- field-name: ## TODO: Potentially add label of a field for providing input to the request that gets called by pushing the button
unit: ## TODO: Potentially add unit that shall be represented aside the input field
## TODO: Potentially add further input fields
display-in-new-browser-window: ## TODO: Set on true, if result of pushing the button has to be represented in a new browser window
configuration:
consequent-operation-reference: ## TODO: Reference operation that shall be used, as soon as button gets pushed
## TODO: Potentially add further instances of ActionProfile
- profile-name: 'GenericResponseProfile'
uuid: '*-response-p-000' ## TODO: Replace "*" by ApplicationID and ReleaseNumber
capability:
operation-name: '/v1/start-application-in-generic-representation'
static-field-name: 'applicationName'
description: 'Own application name'
datatype: 'string'
configuration:
value-reference: '/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name'
- profile-name: 'GenericResponseProfile'
uuid: '*-response-p-001' ## TODO: Replace "*" by ApplicationID and ReleaseNumber
capability:
operation-name: '/v1/inform-about-application-in-generic-representation'
static-field-name: 'applicationName'
description: 'Name of this application'
datatype: 'string'
configuration:
value-reference: '/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-name'
- profile-name: 'GenericResponseProfile'
uuid: '*-response-p-002' ## TODO: Replace "*" by ApplicationID and ReleaseNumber
capability:
operation-name: '/v1/inform-about-application-in-generic-representation'
static-field-name: 'releaseNumber'
description: 'Number of this release'
datatype: 'string'
configuration:
value-reference: '/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-number'
- profile-name: 'GenericResponseProfile'
uuid: '*-response-p-003' ## TODO: Replace "*" by ApplicationID and ReleaseNumber
capability:
operation-name: '/v1/inform-about-application-in-generic-representation'
static-field-name: 'applicationPurpose'
description: 'Purpose of this application'
datatype: 'string'
configuration:
value-reference: '/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/application-purpose'
- profile-name: 'GenericResponseProfile'
uuid: '*-response-p-004' ## TODO: Replace "*" by ApplicationID and ReleaseNumber
capability:
operation-name: '/v1/inform-about-application-in-generic-representation'
static-field-name: 'dataUpdatePeriod'
description: 'Period of updating the data inside this application'
datatype: 'string'
configuration:
value-reference: '/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/data-update-period'
- profile-name: 'GenericResponseProfile'
uuid: '*-response-p-005' ## TODO: Replace "*" by ApplicationID and ReleaseNumber
capability:
operation-name: '/v1/inform-about-application-in-generic-representation'
static-field-name: 'ownerName'
description: 'Name of the ApplicationOwner'
datatype: 'string'
configuration:
value-reference: '/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-name'
- profile-name: 'GenericResponseProfile'
uuid: '*-response-p-006' ## TODO: Replace "*" by ApplicationID and ReleaseNumber
capability:
operation-name: '/v1/inform-about-application-in-generic-representation'
static-field-name: 'ownerEmailAddress'
description: 'Email address of the ApplicationOwner'
datatype: 'string'
configuration:
value-reference: '/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/owner-email-address'
- profile-name: 'GenericResponseProfile'
uuid: '*-response-p-007' ## TODO: Replace "*" by ApplicationID and ReleaseNumber
capability:
operation-name: '/v1/inform-about-release-history-in-generic-representation'
field-name-reference: '/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=0/release-number'
description: 'Represents the first entry in the list of releases'
datatype: string
configuration:
value-reference: '/core-model-1-4:control-construct/logical-termination-point=*-1-0-0-http-s-000/layer-protocol=0/http-server-interface-1-0:http-server-interface-pac/http-server-interface-capability/release-list=0/changes'
- profile-name: 'GenericResponseProfile'
uuid: '*-response-p-???' ## TODO: Replace "*" by ApplicationID and ReleaseNumber and ??? by SequenceNumber
capability:
operation-name: ## TODO: Add generic representation operation that shall provide this response
static-field-name: ## TODO: Add the concrete name of the field as it shall be respresented in the GUI EXOR a reference from which the name of the field shall be taken. ...
field-name-reference: ## TODO: ... Delete either the static-field-name or the field-name-reference attribute from the Instance of GenericResponseProfile.
description: ## TODO: Add some description for your own reference
datatype: ## TODO: Add the datatype of the value
configuration:
static-value: ## TODO: Add the current, concrete value of the field EXOR a reference from which the field shall be filled. ...
value-reference: ## TODO: ... Delete either the static-value or the reference attribute from the Instance of GenericResponseProfile.
## TODO: Potentially add further instances of GenericResponseProfile (e.g. to represent further release in the history)
- profile-name: 'FileProfile'
uuid: '*-file-p-???' ## TODO: Replace "*" by ApplicationID and ReleaseNumber and ??? by SequenceNumber
capability:
file-identifier: ## TODO: Add invariant identifier of the referenced file
file-description: ## TODO: Add a description of the content of the referenced file
configuration:
file-path: ## TODO: Add file name, like e.g. '../application-data/application-data.json'
user-name: ## TODO: If file protected, add user-name
password: ## TODO: If file protected, add password
operation: ## TODO: Choose from read/write/off
## TODO: Potentially add further instances of FileProfile
- profile-name: 'IntegerProfile'
uuid: '*-integer-p-???' ## TODO: Replace "*" by ApplicationID and ReleaseNumber and ??? by SequenceNumber
capability:
integer-name: ## TODO: Add name of the Integer attribute
unit: ## TODO: Potentially add unit of the Integer attribute
minimum: ## TODO: Potentially add minimum value that is to be accepted, while configuration
maximum: ## TODO: Potentially add maximum value that is to be accepted, while configuration
configuration:
integer-value: ## TODO: Add current value of the attribute
## TODO: Potentially add further instances of IntegerProfile
- profile-name: 'StringProfile'
uuid: '*-string-p-???' ## TODO: Replace "*" by ApplicationID and ReleaseNumber and ??? by SequenceNumber
capability:
string-name: ## TODO: Add name of the String attribute
enumeration: ## TODO: Potentially add a set of allowed values in cornered brackets
pattern: ## TODO: Potentially add a regex for validating configuration values
configuration:
string-value: ## TODO: Add current value of the attribute
## TODO: Potentially add further instances of StringProfile