diff options
| author |   Priyadharshini <priyadharshini.b96@wipro.com> | 2020-07-30 14:00:16 +0530 |
|---|---|---|
| committer | Priyadharshini <priyadharshini.b96@wipro.com> | 2020-07-30 14:10:45 +0530 |
| commit | 4ac5bd6e550eed1e0fd87fc61a304029455433a9 (patch) | |
| tree | c067ea44d9064543104cc2ff41c8dadd23a782b9 /docs | |
| parent | a00c42779b32b8b1c398b19678184e64218dacb4 (diff) | |
Update serviceOrder swagger with clarifications on serviceState
Issue-ID: EXTAPI-485
Signed-off-by: Priyadharshini <priyadharshini.b96@wipro.com>
Change-Id: I966626bec4910af0f8f8ef141c8326b69587d8d4
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/offeredapis/api_serviceOrder/swagger.json | 11 | ||||
| -rw-r--r-- | docs/offeredapis/api_serviceOrder/swagger.yaml | 12 |
2 files changed, 17 insertions, 6 deletions
diff --git a/docs/offeredapis/api_serviceOrder/swagger.json b/docs/offeredapis/api_serviceOrder/swagger.json index d5d1c1e..2db9989 100644 --- a/docs/offeredapis/api_serviceOrder/swagger.json +++ b/docs/offeredapis/api_serviceOrder/swagger.json @@ -312,6 +312,14 @@ "ServiceOrderItemStateChangeNotification" ] }, + "ServiceState": { + "description": "The lifecycle state of the service requested - Required for E2E service activation and deactivation with ServiceOrderItem.action as 'modify'.For any other service modification request,service state value should not be passed.Lifecycle is not fully managed in Guilin release", + "type": "string", + "enum": [ + "active", + "inactive" + ] + }, "SeverityMessage": { "description": "Message Severity, either information or error", "type": "string", @@ -498,8 +506,7 @@ "type": "string" }, "serviceState": { - "description": "The lifecycle state of the service requested;\nNot managed in Beijing release.", - "type": "string" + "$ref": "#/definitions/ServiceState" }, "@type": { "description": "To define the service type\nNot managed in Beijing Release", diff --git a/docs/offeredapis/api_serviceOrder/swagger.yaml b/docs/offeredapis/api_serviceOrder/swagger.yaml index 43e4ba6..d6bf029 100644 --- a/docs/offeredapis/api_serviceOrder/swagger.yaml +++ b/docs/offeredapis/api_serviceOrder/swagger.yaml @@ -1,4 +1,5 @@ # Copyright (c) 2018 Orange +# Copyright (c) 2020 Wipro Limited # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -355,6 +356,12 @@ definitions: - ServiceOrderCreationNotification - ServiceOrderStateChangeNotification - ServiceOrderItemStateChangeNotification + ServiceState: + description: The lifecycle state of the service requested - Required for E2E service activation and deactivation with ServiceOrderItem.action as 'modify'.For any other service modification request,service state value should not be passed.Lifecycle is not fully managed in Guilin release + type: string + enum: + - active + - inactive SeverityMessage: description: 'Message Severity, either information or error' type: string @@ -521,10 +528,7 @@ definitions: used in ONAP/SO request as InstaceName. type: string serviceState: - description: |- - The lifecycle state of the service requested; - Not managed in Beijing release. - type: string + $ref: '#/definitions/ServiceState' '@type': description: |- To define the service type |