Aligned attributes of CDS components
[ccsdk/cds.git] / components / model-catalog / definition-type / starter-type / node_type / component-resource-resolution.json
1 {
2   "description": "This is Resource Assignment Component API",
3   "version": "1.0.0",
4   "attributes": {
5     "assignment-params": {
6       "description": "Holds resolved template, resolution-summary or key-value",
7       "required": true,
8       "type": "string"
9     },
10     "assignment-map": {
11       "description": "Holds resolved values for each artifact prefix eg. { vdns: { vnf-id: 123 } }",
12       "required": true,
13       "type": "map"
14     },
15     "status": {
16       "description": "Resource Assignment status.",
17       "required": true,
18       "type": "string"
19     }
20   },
21   "capabilities": {
22     "component-node": {
23       "type": "tosca.capabilities.Node"
24     }
25   },
26   "interfaces": {
27     "ResourceResolutionComponent": {
28       "operations": {
29         "process": {
30           "inputs": {
31             "resolution-key": {
32               "description": "Key for service instance related correlation.",
33               "required": false,
34               "type": "string"
35             },
36             "occurrence": {
37               "description": "Number of time to perform the resolution.",
38               "required": false,
39               "default": 1,
40               "type": "integer"
41             },
42             "store-result": {
43               "description": "Whether or not to store the output.",
44               "required": false,
45               "type": "boolean"
46             },
47             "force-resolution": {
48               "description": "Delete existing values to force new resolution. Ineffective when occurrence < 1",
49               "required": false,
50               "type": "boolean"
51             },
52             "resource-type": {
53               "description": "Request type.",
54               "required": false,
55               "type": "string"
56             },
57             "resolution-summary": {
58               "description": "Enable resolution-summary output",
59               "required": false,
60               "type": "boolean"
61             },
62             "artifact-prefix-names": {
63               "required": true,
64               "description": "Template , Resource Assignment Artifact Prefix names",
65               "type": "list",
66               "entry_schema": {
67                 "type": "string"
68               }
69             },
70             "request-id": {
71               "description": "Request Id, Unique Id for the request.",
72               "required": true,
73               "type": "string"
74             },
75             "resource-id": {
76               "description": "Resource Id.",
77               "required": false,
78               "type": "string"
79             },
80             "action-name": {
81               "description": "Action Name of the process",
82               "required": false,
83               "type": "string"
84             },
85             "dynamic-properties": {
86               "description": "Dynamic Json Content or DSL Json reference.",
87               "required": false,
88               "type": "json"
89             }
90           },
91           "outputs": {
92             "resource-assignment-params": {
93               "required": true,
94               "type": "string"
95             },
96             "resource-assignment-map" : {
97               "required": true,
98               "type": "string"
99             },
100             "status": {
101               "required": true,
102               "type": "string"
103             }
104           }
105         }
106       }
107     }
108   },
109   "derived_from": "tosca.nodes.Component"
110 }