Update Example files for Swagger document
Issue-ID: POLICY-4581
Change-Id: I0db74d45694c7f8d4d0113dbc81d8adb9b55f59a
Signed-off-by: lapentafd <francesco.lapenta@est.tech>
diff --git a/runtime-acm/src/main/resources/openapi/examples/getMultiParticipantResponse.yaml b/runtime-acm/src/main/resources/openapi/examples/getMultiParticipantResponse.yaml
new file mode 100644
index 0000000..f74e299
--- /dev/null
+++ b/runtime-acm/src/main/resources/openapi/examples/getMultiParticipantResponse.yaml
@@ -0,0 +1,64 @@
+- participant:
+ participantId: 101c62b3-8918-41b9-a747-d21eb79c6c03
+ participantState: ON_LINE
+ participantSupportedElementTypes:
+ 3012010d-e59e-4dde-bab1-3ee544e49b6d:
+ id: 3012010d-e59e-4dde-bab1-3ee544e49b6d
+ typeName: org.onap.policy.clamp.acm.AutomationCompositionElement
+ typeVersion: 1.0.1
+ 8d9e947e-c444-471c-9420-29f1c6584f8c:
+ id: 8d9e947e-c444-471c-9420-29f1c6584f8c
+ typeName: org.onap.policy.clamp.acm.PolicyAutomationCompositionElement
+ typeVersion: 1.0.1
+ acNodeTemplateStateDefinitionMap:
+ 8cf8b401-dfd7-4ffe-90ff-c6543da10789:
+ nodeTemplateStateId: 8cf8b401-dfd7-4ffe-90ff-c6543da10789
+ participantId: 101c62b3-8918-41b9-a747-d21eb79c6c03
+ nodeTemplateId:
+ name: org.onap.domain.pmsh.PMSH_OperationalPolicyAutomationCompositionElement
+ version: 1.2.3
+ state: PRIMED
+ acElementInstanceMap:
+ 709c62b3-8918-41b9-a747-d21eb79c6c22:
+ id: 709c62b3-8918-41b9-a747-d21eb79c6c22
+ definition:
+ name: org.onap.domain.pmsh.PMSH_OperationalPolicyAutomationCompositionElement
+ version: 1.2.3
+ participantId: 101c62b3-8918-41b9-a747-d21eb79c6c03
+ deployState: DEPLOYED
+ lockState: UNLOCKED
+ description: Automation composition element for the operational policy for Performance
+ Management Subscription Handling
+ properties: {}
+- participant:
+ participantId: 985d73aa-abba-11ed-afa1-0242ac120002
+ participantState: ON_LINE
+ participantSupportedElementTypes:
+ cded8a5a-abba-11ed-afa1-0242ac120002:
+ id: cded8a5a-abba-11ed-afa1-0242ac120002
+ typeName: org.onap.policy.clamp.acm.K8SMicroserviceAutomationCompositionElement
+ typeVersion: 1.0.1
+ 25ac7864-abbb-11ed-afa1-0242ac120002:
+ id: 25ac7864-abbb-11ed-afa1-0242ac120002
+ typeName: org.onap.policy.clamp.acm.AutomationCompositionElement
+ typeVersion: 1.0.1
+ acNodeTemplateStateDefinitionMap:
+ 34b4d248-abbb-11ed-afa1-0242ac120002:
+ nodeTemplateStateId: 34b4d248-abbb-11ed-afa1-0242ac120002
+ participantId: 985d73aa-abba-11ed-afa1-0242ac120002
+ nodeTemplateId:
+ name: org.onap.domain.pmsh.PMSH_OperationalPolicyAutomationCompositionElement
+ version: 1.2.3
+ state: PRIMED
+ acElementInstanceMap:
+ 3dd7a936-abbb-11ed-afa1-0242ac120002:
+ id: 3dd7a936-abbb-11ed-afa1-0242ac120002
+ definition:
+ name: org.onap.domain.pmsh.PMSH_OperationalPolicyAutomationCompositionElement
+ version: 1.2.3
+ participantId: 985d73aa-abba-11ed-afa1-0242ac120002
+ deployState: DEPLOYED
+ lockState: UNLOCKED
+ description: Automation composition element for the operational policy for Performance
+ Management Subscription Handling
+ properties: {}
diff --git a/runtime-acm/src/main/resources/openapi/examples/getSingleparticipantResponse.yaml b/runtime-acm/src/main/resources/openapi/examples/getSingleparticipantResponse.yaml
new file mode 100644
index 0000000..0c2dc69
--- /dev/null
+++ b/runtime-acm/src/main/resources/openapi/examples/getSingleparticipantResponse.yaml
@@ -0,0 +1,32 @@
+participant:
+ participantId: 101c62b3-8918-41b9-a747-d21eb79c6c03
+ participantState: ON_LINE
+ participantSupportedElementTypes:
+ 3012010d-e59e-4dde-bab1-3ee544e49b6d:
+ id: 3012010d-e59e-4dde-bab1-3ee544e49b6d
+ typeName: org.onap.policy.clamp.acm.AutomationCompositionElement
+ typeVersion: 1.0.1
+ 8d9e947e-c444-471c-9420-29f1c6584f8c:
+ id: 8d9e947e-c444-471c-9420-29f1c6584f8c
+ typeName: org.onap.policy.clamp.acm.PolicyAutomationCompositionElement
+ typeVersion: 1.0.1
+acNodeTemplateStateDefinitionMap:
+ 8cf8b401-dfd7-4ffe-90ff-c6543da10789:
+ nodeTemplateStateId: 8cf8b401-dfd7-4ffe-90ff-c6543da10789
+ participantId: 101c62b3-8918-41b9-a747-d21eb79c6c03
+ nodeTemplateId:
+ name: org.onap.domain.pmsh.PMSH_OperationalPolicyAutomationCompositionElement
+ version: 1.2.3
+ state: PRIMED
+acElementInstanceMap:
+ 709c62b3-8918-41b9-a747-d21eb79c6c22:
+ id: 709c62b3-8918-41b9-a747-d21eb79c6c22
+ definition:
+ name: org.onap.domain.pmsh.PMSH_OperationalPolicyAutomationCompositionElement
+ version: 1.2.3
+ participantId: 101c62b3-8918-41b9-a747-d21eb79c6c03
+ deployState: DEPLOYED
+ lockState: UNLOCKED
+ description: Automation composition element for the operational policy for Performance
+ Management Subscription Handling
+ properties: {}
diff --git a/runtime-acm/src/main/resources/openapi/examples/putAcInstanceStateUpdate.json b/runtime-acm/src/main/resources/openapi/examples/putAcInstanceStateUpdate.json
new file mode 100644
index 0000000..bed6799
--- /dev/null
+++ b/runtime-acm/src/main/resources/openapi/examples/putAcInstanceStateUpdate.json
@@ -0,0 +1,3 @@
+{
+ "deployOrder": "DEPLOY"
+}
\ No newline at end of file
diff --git a/runtime-acm/src/main/resources/openapi/examples/putAcIntanceStateUpdate.yaml b/runtime-acm/src/main/resources/openapi/examples/putAcIntanceStateUpdate.yaml
new file mode 100644
index 0000000..eda0c9f
--- /dev/null
+++ b/runtime-acm/src/main/resources/openapi/examples/putAcIntanceStateUpdate.yaml
@@ -0,0 +1 @@
+deployOrder: DEPLOY
\ No newline at end of file
diff --git a/runtime-acm/src/main/resources/openapi/examples/putAcTypeStateUpdate.json b/runtime-acm/src/main/resources/openapi/examples/putAcTypeStateUpdate.json
new file mode 100644
index 0000000..3eeee5e
--- /dev/null
+++ b/runtime-acm/src/main/resources/openapi/examples/putAcTypeStateUpdate.json
@@ -0,0 +1,3 @@
+{
+ "primeOrder": "PRIME"
+}
\ No newline at end of file
diff --git a/runtime-acm/src/main/resources/openapi/examples/putAcTypeStateUpdate.yaml b/runtime-acm/src/main/resources/openapi/examples/putAcTypeStateUpdate.yaml
new file mode 100644
index 0000000..706592a
--- /dev/null
+++ b/runtime-acm/src/main/resources/openapi/examples/putAcTypeStateUpdate.yaml
@@ -0,0 +1 @@
+primeOrder: PRIME
\ No newline at end of file
diff --git a/runtime-acm/src/main/resources/openapi/openapi.yaml b/runtime-acm/src/main/resources/openapi/openapi.yaml
index c060fba..c9b6e1f 100644
--- a/runtime-acm/src/main/resources/openapi/openapi.yaml
+++ b/runtime-acm/src/main/resources/openapi/openapi.yaml
@@ -71,7 +71,7 @@
responses:
200:
description: OK, serialised array of instances of
- [ParticipantInformation](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/ParticipantInformation.java)
+ [ParticipantInformation](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/ParticipantInformation.java)
that contains information on participants with their information and status. Each participant entry contains
a list of AC Element types on the participant. Each AC Element type entry contains a list of AC Element
instances on the Participant.
@@ -96,14 +96,14 @@
items:
$ref: '#/components/schemas/ParticipantInformation'
example:
- externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getParticipantInformation.json'
+ externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getMultiParticipantResponse.json'
application/yaml:
schema:
type: array
items:
$ref: '#/components/schemas/ParticipantInformation'
example:
- externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getParticipantInformation.yaml'
+ externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getMultiParticipantResponse.yaml'
401:
description: Authentication Error, returns an instance of
[SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)
@@ -235,7 +235,7 @@
responses:
200:
description: Serialised instance of
- [ParticipantInformation](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/ParticipantInformation.java)
+ [ParticipantInformation](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/concepts/ParticipantInformation.java)
that information on the participant with its information and status. The participant entry contains
a list of AC Element types on the participant. Each AC Element type entry contains a list of AC Element
instances on the Participant.
@@ -258,12 +258,12 @@
schema:
$ref: '#/components/schemas/ParticipantInformation'
example:
- externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleParticipantInformation.json'
+ externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getSingleParticipantResponse.json'
application/yaml:
schema:
$ref: '#/components/schemas/ToscaServiceTemplate'
example:
- externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getParticipantInformation.yaml'
+ externalValue: 'https://raw.githubusercontent.com/onap/policy-clamp/master/runtime-acm/src/main/resources/openapi/examples/getParticipantResponse.yaml'
401:
description: Authentication Error, returns an instance of
[SimpleResponse](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/SimpleResponse.java)