d1ace9f9b94c6b80696197cdbb8e34331c2bd48d
[doc.git] / docs / guides / onap-user / design / parameter_resolution / freeradius_example / after_enrichment / CBA_freeradius / Definitions / node_types.json
1 {
2   "node_types" : {
3     "component-script-executor":{
4   "description": "This is CLI Transaction Configuration Component API",
5   "version": "1.0.0",
6   "attributes": {
7     "response-data": {
8       "required": false,
9       "type": "json"
10     }
11   },
12   "capabilities": {
13     "component-node": {
14       "type": "tosca.capabilities.Node"
15     }
16   },
17   "interfaces": {
18     "ComponentScriptExecutor": {
19       "operations": {
20         "process": {
21           "inputs": {
22             "script-type": {
23               "description": "Script type, kotlin type is supported",
24               "required": true,
25               "type": "string",
26               "default": "internal",
27               "constraints": [
28                 {
29                   "valid_values": [
30                     "kotlin",
31                     "jython",
32                     "internal"
33                   ]
34                 }
35               ]
36             },
37             "script-class-reference": {
38               "description": "Kotlin Script class name or jython script name.",
39               "required": true,
40               "type": "string"
41             },
42             "dynamic-properties": {
43               "description": "Dynamic Json Content or DSL Json reference.",
44               "required": false,
45               "type": "json"
46             }
47           },
48           "outputs": {
49             "response-data": {
50               "description": "Execution Response Data.",
51               "required": false,
52               "type": "string"
53             },
54             "status": {
55               "description": "Status of the Component Execution ( success or failure )",
56               "required": true,
57               "type": "string"
58             }
59           }
60         }
61       }
62     }
63   },
64   "derived_from": "tosca.nodes.Component"
65 },
66     "component-netconf-executor" : {
67       "description" : "This is Netconf Transaction Configuration Component API",
68       "version" : "1.0.0",
69       "attributes" : {
70         "response-data" : {
71           "required" : false,
72           "type" : "json"
73         }
74       },
75       "capabilities" : {
76         "component-node" : {
77           "type" : "tosca.capabilities.Node"
78         }
79       },
80       "requirements" : {
81         "netconf-connection" : {
82           "capability" : "netconf",
83           "node" : "vnf-netconf-device",
84           "relationship" : "tosca.relationships.ConnectsTo"
85         }
86       },
87       "interfaces" : {
88         "ComponentNetconfExecutor" : {
89           "operations" : {
90             "process" : {
91               "inputs" : {
92                 "script-type" : {
93                   "description" : "Script type, kotlin type is supported",
94                   "required" : true,
95                   "type" : "string",
96                   "constraints" : [ {
97                     "valid_values" : [ "kotlin", "jython", "internal" ]
98                   } ],
99                   "default" : "internal"
100                 },
101                 "script-class-reference" : {
102                   "description" : "Kotlin Script class name or jython script name.",
103                   "required" : true,
104                   "type" : "string"
105                 },
106                 "instance-dependencies" : {
107                   "description" : "Instance names to inject to Jython or Kotlin Script.",
108                   "required" : true,
109                   "type" : "list",
110                   "entry_schema" : {
111                     "type" : "string"
112                   }
113                 },
114                 "dynamic-properties" : {
115                   "description" : "Dynamic Json Content or DSL Json reference.",
116                   "required" : false,
117                   "type" : "json"
118                 }
119               },
120               "outputs" : {
121                 "response-data" : {
122                   "description" : "Execution Response Data in JSON format.",
123                   "required" : false,
124                   "type" : "string"
125                 },
126                 "status" : {
127                   "description" : "Status of the Component Execution ( success or failure )",
128                   "required" : true,
129                   "type" : "string"
130                 }
131               }
132             }
133           }
134         }
135       },
136       "derived_from" : "tosca.nodes.Component"
137     },
138     "component-resource-resolution" : {
139       "description" : "This is Resource Assignment Component API",
140       "version" : "1.0.0",
141       "attributes" : {
142         "assignment-params" : {
143           "required" : true,
144           "type" : "string"
145         }
146       },
147       "capabilities" : {
148         "component-node" : {
149           "type" : "tosca.capabilities.Node"
150         }
151       },
152       "interfaces" : {
153         "ResourceResolutionComponent" : {
154           "operations" : {
155             "process" : {
156               "inputs" : {
157                 "resolution-key" : {
158                   "description" : "Key for service instance related correlation.",
159                   "required" : false,
160                   "type" : "string"
161                 },
162                 "occurrence" : {
163                   "description" : "Number of time to perform the resolution.",
164                   "required" : false,
165                   "type" : "integer",
166                   "default" : 1
167                 },
168                 "store-result" : {
169                   "description" : "Whether or not to store the output.",
170                   "required" : false,
171                   "type" : "boolean"
172                 },
173                 "resource-type" : {
174                   "description" : "Request type.",
175                   "required" : false,
176                   "type" : "string"
177                 },
178                 "artifact-prefix-names" : {
179                   "description" : "Template , Resource Assignment Artifact Prefix names",
180                   "required" : true,
181                   "type" : "list",
182                   "entry_schema" : {
183                     "type" : "string"
184                   }
185                 },
186                 "request-id" : {
187                   "description" : "Request Id, Unique Id for the request.",
188                   "required" : true,
189                   "type" : "string"
190                 },
191                 "resource-id" : {
192                   "description" : "Resource Id.",
193                   "required" : false,
194                   "type" : "string"
195                 },
196                 "action-name" : {
197                   "description" : "Action Name of the process",
198                   "required" : false,
199                   "type" : "string"
200                 },
201                 "dynamic-properties" : {
202                   "description" : "Dynamic Json Content or DSL Json reference.",
203                   "required" : false,
204                   "type" : "json"
205                 }
206               },
207               "outputs" : {
208                 "resource-assignment-params" : {
209                   "required" : true,
210                   "type" : "string"
211                 },
212                 "status" : {
213                   "required" : true,
214                   "type" : "string"
215                 }
216               }
217             }
218           }
219         }
220       },
221       "derived_from" : "tosca.nodes.Component"
222     },
223     "source-capability" : {
224       "description" : "This is Component Resource Source Node Type",
225       "version" : "1.0.0",
226       "properties" : {
227         "script-type" : {
228           "required" : true,
229           "type" : "string",
230           "constraints" : [ {
231             "valid_values" : [ "kotlin", "internal", "jython" ]
232           } ],
233           "default" : "kotlin"
234         },
235         "script-class-reference" : {
236           "description" : "Capability reference name for internal and kotlin, for jython script file path",
237           "required" : true,
238           "type" : "string"
239         },
240         "instance-dependencies" : {
241           "description" : "Instance dependency Names to Inject to Kotlin / Jython Script.",
242           "required" : false,
243           "type" : "list",
244           "entry_schema" : {
245             "type" : "string"
246           }
247         },
248         "key-dependencies" : {
249           "description" : "Resource Resolution dependency dictionary names.",
250           "required" : true,
251           "type" : "list",
252           "entry_schema" : {
253             "type" : "string"
254           }
255         }
256       },
257       "derived_from" : "tosca.nodes.ResourceSource"
258     },
259     "source-db" : {
260       "description" : "This is Database Resource Source Node Type",
261       "version" : "1.0.0",
262       "properties" : {
263         "type" : {
264           "required" : true,
265           "type" : "string",
266           "constraints" : [ {
267             "valid_values" : [ "SQL", "PLSQL" ]
268           } ],
269           "default" : "SQL"
270         },
271         "endpoint-selector" : {
272           "required" : false,
273           "type" : "string"
274         },
275         "query" : {
276           "required" : true,
277           "type" : "string"
278         },
279         "input-key-mapping" : {
280           "required" : false,
281           "type" : "map",
282           "entry_schema" : {
283             "type" : "string"
284           }
285         },
286         "output-key-mapping" : {
287           "required" : false,
288           "type" : "map",
289           "entry_schema" : {
290             "type" : "string"
291           }
292         },
293         "key-dependencies" : {
294           "required" : true,
295           "type" : "list",
296           "entry_schema" : {
297             "type" : "string"
298           }
299         }
300       },
301       "derived_from" : "tosca.nodes.ResourceSource"
302     },
303     "source-default" : {
304       "description" : "This is Default Resource Source Node Type",
305       "version" : "1.0.0",
306       "properties" : { },
307       "derived_from" : "tosca.nodes.ResourceSource"
308     },
309     "source-input" : {
310       "description" : "This is Input Resource Source Node Type",
311       "version" : "1.0.0",
312       "properties" : { },
313       "derived_from" : "tosca.nodes.ResourceSource"
314     },
315     "source-rest" : {
316       "description" : "This is Rest Resource Source Node Type",
317       "version" : "1.0.0",
318       "properties" : {
319         "type" : {
320           "required" : true,
321           "type" : "string",
322           "constraints" : [ {
323             "valid_values" : [ "JSON" ]
324           } ],
325           "default" : "JSON"
326         },
327         "verb" : {
328           "required" : true,
329           "type" : "string",
330           "constraints" : [ {
331             "valid_values" : [ "GET", "POST", "DELETE", "PUT" ]
332           } ],
333           "default" : "GET"
334         },
335         "payload" : {
336           "required" : false,
337           "type" : "string",
338           "default" : ""
339         },
340         "endpoint-selector" : {
341           "required" : false,
342           "type" : "string"
343         },
344         "url-path" : {
345           "required" : true,
346           "type" : "string"
347         },
348         "path" : {
349           "required" : true,
350           "type" : "string"
351         },
352         "expression-type" : {
353           "required" : false,
354           "type" : "string",
355           "constraints" : [ {
356             "valid_values" : [ "JSON_PATH", "JSON_POINTER" ]
357           } ],
358           "default" : "JSON_PATH"
359         },
360         "input-key-mapping" : {
361           "required" : false,
362           "type" : "map",
363           "entry_schema" : {
364             "type" : "string"
365           }
366         },
367         "output-key-mapping" : {
368           "required" : false,
369           "type" : "map",
370           "entry_schema" : {
371             "type" : "string"
372           }
373         },
374         "key-dependencies" : {
375           "required" : true,
376           "type" : "list",
377           "entry_schema" : {
378             "type" : "string"
379           }
380         }
381       },
382       "derived_from" : "tosca.nodes.ResourceSource"
383     },
384     "tosca.nodes.Component" : {
385       "description" : "This is default Component Node",
386       "version" : "1.0.0",
387       "derived_from" : "tosca.nodes.Root"
388     },
389     "tosca.nodes.ResourceSource" : {
390       "description" : "TOSCA base type for Resource Sources",
391       "version" : "1.0.0",
392       "derived_from" : "tosca.nodes.Root"
393     }
394   }
395 }