First version of documentation for DME Participant
[nonrtric/plt/rappmanager.git] / participants / docs / tosca-dme-participant.yml
1 ---
2 tosca_definitions_version: tosca_simple_yaml_1_3
3 data_types:
4   onap.datatypes.ToscaConceptIdentifier:
5     derived_from: tosca.datatypes.Root
6     properties:
7       name:
8         type: string
9         required: true
10       version:
11         type: string
12         required: true
13   org.onap.datatypes.policy.clamp.acm.DMEAutomationCompositionElement.InfoTypeEntity:
14     version: 1.0.0
15     derived_from: tosca.datatypes.Root
16     properties:
17       infoTypeEntityId:
18         type: onap.datatypes.ToscaConceptIdentifier
19         required: true
20         description: The name and version of a Configuration Entity to be handled
21           by the DME Automation Composition Element
22       infoTypeId:
23         type: string
24         required: true
25         description: Id of the info type
26       payload:
27         type: string
28         required: true
29         description: Json payload of info type
30   org.onap.datatypes.policy.clamp.acm.DMEAutomationCompositionElement.DataProducerEntity:
31     version: 1.0.0
32     derived_from: tosca.datatypes.Root
33     properties:
34       dataProducerEntityId:
35         type: onap.datatypes.ToscaConceptIdentifier
36         required: true
37         description: The name and version of a Configuration Entity to be handled
38           by the DME Automation Composition Element
39       dataProducerId:
40         type: string
41         required: true
42         description: Id of the info type
43       payload:
44         type: string
45         required: true
46         description: Json payload of info type
47   org.onap.datatypes.policy.clamp.acm.DMEAutomationCompositionElement.DataConsumerEntity:
48     version: 1.0.0
49     derived_from: tosca.datatypes.Root
50     properties:
51       dataConsumerEntityId:
52         type: onap.datatypes.ToscaConceptIdentifier
53         required: true
54         description: The name and version of a Configuration Entity to be handled
55           by the DME Automation Composition Element
56       dataConsumerId:
57         type: string
58         required: true
59         description: Id of the info type
60       payload:
61         type: string
62         required: true
63         description: Json payload of info type
64 node_types:
65   org.onap.policy.clamp.acm.Participant:
66     version: 1.0.1
67     derived_from: tosca.nodetypes.Root
68     properties:
69       provider:
70         type: string
71         required: false
72   org.onap.policy.clamp.acm.AutomationCompositionElement:
73     version: 1.0.1
74     derived_from: tosca.nodetypes.Root
75     properties:
76       provider:
77         type: string
78         required: false
79       participantType:
80         type: onap.datatypes.ToscaConceptIdentifier
81         required: true
82       startPhase:
83         type: integer
84         required: false
85         constraints:
86           - greater-or-equal: 0
87         metadata:
88           common: true
89         description: A value indicating the start phase in which this automation composition
90           element will be started, the first start phase is zero. Automation Composition
91           Elements are started in their start_phase order and stopped in reverse start
92           phase order. Automation Composition Elements with the same start phase are
93           started and stopped simultaneously
94   org.onap.policy.clamp.acm.AutomationComposition:
95     version: 1.0.1
96     derived_from: tosca.nodetypes.Root
97     properties:
98       provider:
99         type: string
100         required: false
101         metadata:
102           common: true
103       elements:
104         type: list
105         required: true
106         metadata:
107           common: true
108         entry_schema:
109           type: onap.datatypes.ToscaConceptIdentifier
110   org.onap.policy.clamp.acm.DMEAutomationCompositionElement:
111     version: 1.0.1
112     derived_from: org.onap.policy.clamp.acm.AutomationCompositionElement
113     properties:
114       infoTypeEntities:
115         type: list
116         required: true
117         entry_schema:
118           type: org.onap.datatypes.policy.clamp.acm.DMEAutomationCompositionElement.InfoTypeEntity
119           type_version: 1.0.0
120         description: The configuration entities of DME
121       dataProducerEntities:
122         type: list
123         required: true
124         entry_schema:
125           type: org.onap.datatypes.policy.clamp.acm.DMEAutomationCompositionElement.DataProducerEntity
126           type_version: 1.0.0
127         description: The configuration entities of DME
128       dataConsumerEntities:
129         type: list
130         required: true
131         entry_schema:
132           type: org.onap.datatypes.policy.clamp.acm.DMEAutomationCompositionElement.DataConsumerEntity
133           type_version: 1.0.0
134         description: The configuration entities of DME
135 topology_template:
136   node_templates:
137     org.onap.policy.clamp.acm.DMEAutomationCompositionParticipant:
138       version: 2.3.4
139       type: org.onap.policy.clamp.acm.Participant
140       type_version: 1.0.1
141       description: Participant for DME
142       properties:
143         provider: ONAP
144     onap.policy.clamp.ac.element.DMEAutomationCompositionElement:
145       version: 1.2.3
146       type: org.onap.policy.clamp.acm.DMEAutomationCompositionElement
147       type_version: 1.0.1
148       description: Automation composition element for the DME Requests
149       properties:
150         provider: ONAP
151         participantType:
152           name: org.onap.policy.clamp.acm.DMEParticipant
153           version: 2.3.4
154     onap.policy.clamp.ac.element.AutomationCompositionDefinition:
155       version: 1.2.3
156       type: org.onap.policy.clamp.acm.AutomationComposition
157       type_version: 1.0.1
158       description: Automation composition for DME request
159       properties:
160         provider: ONAP
161         elements:
162           - name: onap.policy.clamp.ac.element.DMEAutomationCompositionElement
163             version: 1.2.3