Migrate ccsdk/apps to ccsdk/cds
[ccsdk/cds.git] / components / model-catalog / definition-type / starter-type / node_type / component-config-generator.json
1 {\r
2         "description": "This is Generate Configuration Component API",\r
3         "version": "1.0.0",\r
4         "capabilities": {\r
5                 "component-node": {\r
6                         "type": "tosca.capabilities.Node"\r
7                 }\r
8         },\r
9         "interfaces": {\r
10                 "ConfigGeneratorComponent": {\r
11                         "operations": {\r
12                                 "process": {\r
13                                         "inputs": {\r
14                                                 "template-data": {\r
15                                                         "description": "Conditional : JSON string which is used to mash with template. Either template-data or ( resource-id and resource-type ) should be present",\r
16                                                         "required": false,\r
17                                                         "type": "string"\r
18                                                 },\r
19                                                 "template-content": {\r
20                                                         "description": "Conditional : Dynamic Template used to generate Configuration.",\r
21                                                         "required": false,\r
22                                                         "type": "string"\r
23                                                 },\r
24                                                 "resource-type": {\r
25                                                         "description": "Conditional : resource-type used to pull the data content from the data base. Either template-data or ( resource-id and resource-type ) should be present",\r
26                                                         "required": false,\r
27                                                         "type": "string"\r
28                                                 },\r
29                                                 "request-id": {\r
30                                                         "description": "Request Id used to store the generated configuration, in the database along with the template-name",\r
31                                                         "required": true,\r
32                                                         "type": "string"\r
33                                                 },\r
34                                                 "resource-id": {\r
35                                                         "description": "Conditional : Id used to pull the data content from the data base. Either template-data or ( resource-id and resource-type ) should be present",\r
36                                                         "required": false,\r
37                                                         "type": "string"\r
38                                                 },\r
39                                                 "action-name": {\r
40                                                         "description": "Conditional : Action Name to get from Database, Either (message & mask-info ) or ( resource-id & resource-type & action-name & template-name ) should be present. Message will be given higest priority",\r
41                                                         "required": false,\r
42                                                         "type": "string"\r
43                                                 },\r
44                                                 "template-name": {\r
45                                                         "description": "Conditional : Name of the Artifact Node Template, to get the template Content. If template-content is present, then content wont be reterived from the Artifact Node Template.",\r
46                                                         "required": true,\r
47                                                         "type": "string"\r
48                                                 }\r
49                                         },\r
50                                         "outputs": {\r
51                                                 "generated-config": {\r
52                                                         "description": "Generated Configuration for the Template adn Resource Data",\r
53                                                         "required": true,\r
54                                                         "type": "string"\r
55                                                 },\r
56                                                 "mask-info": {\r
57                                                         "description": "If template contains mask encription keys, then this mask-info field will be generated, This JSON Content alligns to the bean org.onap.ccsdk.cds.controllerblueprints.core.data.custom.MaskInfo ",\r
58                                                         "required": false,\r
59                                                         "type": "string"\r
60                                                 },\r
61                                                 "status": {\r
62                                                         "description": "Status of the Component Execution ( success or failure )",\r
63                                                         "required": true,\r
64                                                         "type": "string"\r
65                                                 }\r
66                                         }\r
67                                 }\r
68                         }\r
69                 }\r
70         },\r
71         "derived_from": "tosca.nodes.Component"\r
72 }