From 4647e3ef6c87e271794e06fb1660cad5ee72ab04 Mon Sep 17 00:00:00 2001 From: Abhishek Patil Date: Fri, 31 Mar 2023 10:39:46 +0530 Subject: Code changes in SO api-handler for RAN Slice Issue-ID: SO-4038 Change-Id: Ifad4e0a65dc810a753d30741a84c08081bcfd258 Signed-off-by: Patil --- .../api/apis/ManagedObject3gppServiceInstances.rst | 262 +++++++++++++++++ docs/api/offered_consumed_apis.rst | 1 + docs/api/swagger/swagger.json | 315 ++++++++++++++++++++- 3 files changed, 576 insertions(+), 2 deletions(-) create mode 100644 docs/api/apis/ManagedObject3gppServiceInstances.rst (limited to 'docs/api') diff --git a/docs/api/apis/ManagedObject3gppServiceInstances.rst b/docs/api/apis/ManagedObject3gppServiceInstances.rst new file mode 100644 index 0000000000..1d3336a2d1 --- /dev/null +++ b/docs/api/apis/ManagedObject3gppServiceInstances.rst @@ -0,0 +1,262 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2023 DTAG + +ManagedObject3gppServiceInstances API +===================================== + +Create a ManagedObject3gppServiceInstances +++++++++++++++++++++++++++++++++++++++++++ + ++--------------------+------------------------------------------------------------+ +|Interface Definition|Description | ++====================+============================================================+ +|URI |onap/so/infra/moi/api/rest/v1/NetworkSliceSubnet/$NSSID | ++--------------------+------------------------------------------------------------+ +|Operation Type |PUT | ++--------------------+------------------------------------------------------------+ +|Content-Type |application/json | ++--------------------+------------------------------------------------------------+ + +Request Body: + ++-----------------------------------+---------+-----------+--------------+---------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++===================================+=========+===========+==============+=======================================+ +|ManagedObject3gppServiceInstances |M |1 |allocateMOI |Content of allocate3gppMOI object | ++-----------------------------------+---------+-----------+--------------+---------------------------------------+ + +ManagedObject3gppServiceInstances Object + ++------------------------------+-----------------+-------------------------------------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+===================================================================+ +|attributes |List |List of Slice Profile Attribute | ++------------------------------+-----------------+-------------------------------------------------------------------+ + + +SliceProfileList Object + ++------------------------------+-----------------+-------------------------------------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+===================================================================+ +|plmnInfoList |List |Contains plmnInfoList | ++------------------------------+-----------------+-------------------------------------------------------------------+ +|RANSliceSubnetProfile |Object |Contains RAN Attributes Object | ++------------------------------+-----------------+-------------------------------------------------------------------+ + + +plmnInfoList Object + ++------------------------------+-----------------+-------------------------------------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+===================================================================+ +|plmnId |Object |Contains plmnData | ++------------------------------+-----------------+-------------------------------------------------------------------+ +|snssai |Object |Contains snssai data | ++------------------------------+-----------------+-------------------------------------------------------------------+ + +plmnId Object + ++------------------------------+-----------------+-------------------------------------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+===================================================================+ +|mcc |integer |Contains mcc value | ++------------------------------+-----------------+-------------------------------------------------------------------+ +|mnc |integer |Contains mcc value | ++------------------------------+-----------------+-------------------------------------------------------------------+ + +snssai Object + ++------------------------------+-----------------+-------------------------------------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+===================================================================+ +|sst |string |Contains sst | ++------------------------------+-----------------+-------------------------------------------------------------------+ +|sd |string |Contains sd | ++------------------------------+-----------------+-------------------------------------------------------------------+ + +RAN Attribute Object + ++------------------------------+-----------------+-------------------------------------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+===================================================================+ +|coverageAreaTAList |integer |Contains coverageAreaTAList | ++------------------------------+-----------------+-------------------------------------------------------------------+ +|latency |integer |desired latency of slice | ++------------------------------+-----------------+-------------------------------------------------------------------+ +|areaTrafficCapDL |integer |Contains areaTrafficCapDL | ++------------------------------+-----------------+-------------------------------------------------------------------+ +|resourceSharingLevel |string |describes slice sharing level | ++------------------------------+-----------------+-------------------------------------------------------------------+ +|serviceType |string |describes serviceType | ++------------------------------+-----------------+-------------------------------------------------------------------+ +|maxNumberofUEs |integer |describes maxNumberofUEs | ++------------------------------+-----------------+-------------------------------------------------------------------+ + + +Response: + ++-------------------------+---------+-----------+-----------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++=========================+=========+===========+=================+===========================================+ +|requestReferences |M |1 |Response Object |Content of Response object. | ++----------------+--------+---------+-----------+-----------------+-------------------------------------------+ + +Response Object + ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++===================+=========+===========+==========================+===========================================+ +|requestId |M |1 |String |Request Id. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|requestDetails |M |1 |requestDetails Object |Type of the request. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|instanceId |M |1 |requestStatus Object |Type of the request. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ + + + +Terminate/Deallocate a MOI +++++++++++++++++++++++++++ + ++--------------------+------------------------------------------------------------+ +|Interface Definition|Description | ++====================+============================================================+ +|URI |onap/so/infra/moi/api/rest/v1/NetworkSliceSubnet/$NSSID | ++--------------------+------------------------------------------------------------+ +|Operation Type |DELETE | ++--------------------+------------------------------------------------------------+ +|Content-Type |application/json | ++--------------------+------------------------------------------------------------+ + + +Request Body: + ++-----------------------------------+---------+-----------+--------------+---------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++===================================+=========+===========+==============+=======================================+ +|ManagedObject3gppServiceInstances |M |1 |deleteMOI |Content of deleteMOI object | ++-----------------------------------+---------+-----------+--------------+---------------------------------------+ + +ManagedObject3gppServiceInstances Object + ++------------------------------+-----------------+-------------------------------------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+===================================================================+ +|attributes |List |List of Slice Profile Attribute | ++------------------------------+-----------------+-------------------------------------------------------------------+ + + +SliceProfileList Object + ++------------------------------+-----------------+-------------------------------------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+===================================================================+ +|sliceProfileId |string |slice profile id to be deleted | ++------------------------------+-----------------+-------------------------------------------------------------------+ + + +Response + ++-------------------------+---------+-----------+-----------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++=========================+=========+===========+=================+===========================================+ +|requestReferences |M |1 |Response Object |Content of Response object. | ++-------------------------+---------+-----------+-----------------+-------------------------------------------+ + +Response Object + ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++===================+=========+===========+==========================+===========================================+ +|requestId |M |1 |String |Request Id. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|requestDetails |M |1 |requestDetails Object |Type of the request. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|instanceId |M |1 |requestStatus Object |Type of the request. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ + + + + +Modify a 3GPP service instance +++++++++++++++++++++++++++++++ ++--------------------+------------------------------------------------------------+ +|Interface Definition|Description | ++====================+============================================================+ +|URI |onap/so/infra/moi/api/rest/v1/NetworkSliceSubnet/$NSSID | ++--------------------+------------------------------------------------------------+ +|Operation Type |PATCH | ++--------------------+------------------------------------------------------------+ +|Content-Type |application/json | ++--------------------+------------------------------------------------------------+ + + +Request Body: + ++-----------------------------------+---------+-----------+--------------+---------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++===================================+=========+===========+==============+=======================================+ +|ManagedObject3gppServiceInstances |M |1 |modifyMOI |Content of modifyMOI object | ++-----------------------------------+---------+-----------+--------------+---------------------------------------+ + + +ManagedObject3gppServiceInstances Object + ++------------------------------+-----------------+-------------------------------------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+===================================================================+ +|attributes |List |List of Slice Profile Attribute | ++------------------------------+-----------------+-------------------------------------------------------------------+ + + +SliceProfileList Object + ++------------------------------+-----------------+-------------------------------------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+===================================================================+ +|sliceProfileId |string |slice profile id to be modify | ++------------------------------+-----------------+-------------------------------------------------------------------+ +|RANSliceSubnetProfile |Object |Contains RAN Attributes Object | ++------------------------------+-----------------+-------------------------------------------------------------------+ + + +RAN Attribute Object + ++------------------------------+-----------------+-------------------------------------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+===================================================================+ +|coverageAreaTAList |integer |Contains coverageAreaTAList | ++------------------------------+-----------------+-------------------------------------------------------------------+ +|latency |integer |desired latency of slice | ++------------------------------+-----------------+-------------------------------------------------------------------+ +|areaTrafficCapDL |integer |Contains areaTrafficCapDL | ++------------------------------+-----------------+-------------------------------------------------------------------+ +|resourceSharingLevel |string |describes slice sharing level | ++------------------------------+-----------------+-------------------------------------------------------------------+ +|serviceType |string |describes serviceType | ++------------------------------+-----------------+-------------------------------------------------------------------+ +|maxNumberofUEs |integer |describes maxNumberofUEs | ++------------------------------+-----------------+-------------------------------------------------------------------+ + + +Response: + ++-------------------------+---------+-----------+-----------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++=========================+=========+===========+=================+===========================================+ +|requestReferences |M |1 |Response Object |Content of Response object. | ++-------------------------+---------+-----------+-----------------+-------------------------------------------+ + +Response Object + ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++===================+=========+===========+==========================+===========================================+ +|requestId |M |1 |String |Request Id. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|requestDetails |M |1 |requestDetails Object |Type of the request. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|instanceId |M |1 |requestStatus Object |Type of the request. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ \ No newline at end of file diff --git a/docs/api/offered_consumed_apis.rst b/docs/api/offered_consumed_apis.rst index 11e52e82ae..fa872dbeb4 100644 --- a/docs/api/offered_consumed_apis.rst +++ b/docs/api/offered_consumed_apis.rst @@ -46,3 +46,4 @@ Detailed documentation can be found here: apis/e2eServiceInstances-api.rst apis/onap3gppServiceInstances-api.rst apis/consumed-apis.rst + apis/ManagedObject3gppServiceInstances.rst diff --git a/docs/api/swagger/swagger.json b/docs/api/swagger/swagger.json index ac0e523d45..1d23498bc8 100644 --- a/docs/api/swagger/swagger.json +++ b/docs/api/swagger/swagger.json @@ -1,7 +1,7 @@ { "openapi": "3.0.1", "info": { - "title": "SO Guilin APIs", + "title": "SO London APIs", "version": "3.1.2" }, "servers": [ @@ -48,6 +48,9 @@ }, { "name": "onapsoinfrainstanceManagement" + }, + { + "name": "ManagedObject3gppServiceInstances" } ], "paths": { @@ -3492,6 +3495,170 @@ }, "x-codegen-request-body-name": "body" } + }, + "/onap/so/infra/moi/api/rest/{version}/NetworkSliceSubnet/{NSSID}": { + "put": { + "tags": [ + "ManagedObject3gppServiceInstances" + ], + "summary": "Create a 3GPP MOI NSSI on a version provided", + "operationId": "createMOI", + "parameters": [ + { + "name": "version", + "in": "path", + "required": true, + "schema": { + "pattern": "[vV][1]", + "type": "string" + } + }, + { + "name": "NSSID", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/createMOI" + } + } + }, + "required": true + }, + "responses": { + "default": { + "description": "successful operation", + "content": {} + } + }, + "x-codegen-request-body-name": "body" + }, + "patch": { + "tags": [ + "ManagedObject3gppServiceInstances" + ], + "summary": "Modify a 3GPP MOI NSSI on a version provided", + "operationId": "modifyMOI", + "parameters": [ + { + "name": "version", + "in": "path", + "required": true, + "schema": { + "pattern": "[vV][1]", + "type": "string" + } + }, + { + "name": "NSSID", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/modifyMOI" + } + } + }, + "required": true + }, + "responses": { + "default": { + "description": "successful operation", + "content": {} + } + }, + "x-codegen-request-body-name": "body" + }, + "delete": { + "tags": [ + "ManagedObject3gppServiceInstances" + ], + "summary": "delete a 3GPP MOI NSSI on a version provided", + "operationId": "deleteMOI", + "parameters": [ + { + "name": "version", + "in": "path", + "required": true, + "schema": { + "pattern": "[vV][1]", + "type": "string" + } + }, + { + "name": "NSSID", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/deleteMOI" + } + } + }, + "required": true + }, + "responses": { + "default": { + "description": "successful operation", + "content": {} + } + }, + "x-codegen-request-body-name": "body" + }, + "get": { + "tags": [ + "ManagedObject3gppServiceInstances" + ], + "summary": "get the slice profile list of given nssiID", + "operationId": "getMOI", + "parameters": [ + { + "name": "version", + "in": "path", + "required": true, + "schema": { + "pattern": "[vV][1]", + "type": "string" + } + }, + { + "name": "NSSID", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "default": { + "description": "successful operation", + "content": {} + } + }, + "x-codegen-request-body-name": "body" + } } }, "components": { @@ -3659,7 +3826,7 @@ "type": "object", "properties": { "workflowSpecificationList": { - "type": "array", + "type": "C", "description": "List of Workflow specification data", "items": { "$ref": "#/components/schemas/WorkflowSpecification" @@ -4270,6 +4437,150 @@ } } ] + }, + "createMOI": { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "properties": { + "sliceProfileList": { + "type": "array", + "description": "List of slice profile attributes", + "items": { + "type": "array", + "description": "List of PlmnData attributes", + "items": { + "plmnid": { + "type": "object", + "properties": { + "mcc": { + "type": "integer", + "description": "mcc" + }, + "mnc": { + "type": "integer", + "description": "mnc" + } + } + }, + "snssai": { + "type": "object", + "properties": { + "mcc": { + "type": "integer", + "description": "mcc" + }, + "mnc": { + "type": "integer", + "description": "mnc" + } + } + } + }, + "RANSliceSubnetProfile": { + "type": "object", + "properties": { + "coverageAreaTAList": { + "type": "integer", + "description": "coverageAreaTAList" + }, + "latency": { + "type": "integer", + "description": "latency" + }, + "areaTrafficCapDL": { + "type": "integer", + "description": "areaTrafficCapDL" + }, + "resourceSharingLevel": { + "type": "string", + "description": "resourceSharingLevel" + }, + "serviceType": { + "type": "string", + "description": "serviceType" + }, + "maxNumberofUEs": { + "type": "integer", + "description": "maxNumberofUEs" + } + } + } + } + } + } + } + } + }, + "modifyMOI": { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "properties": { + "sliceProfileList": { + "type": "array", + "description": "List of slice profile attributes", + "items": { + "sliceProfileId": { + "type": "string", + "description": "sliceProfileId to be modify" + }, + "RANSliceSubnetProfile": { + "type": "object", + "properties": { + "coverageAreaTAList": { + "type": "integer", + "description": "coverageAreaTAList" + }, + "latency": { + "type": "integer", + "description": "latency" + }, + "areaTrafficCapDL": { + "type": "integer", + "description": "areaTrafficCapDL" + }, + "resourceSharingLevel": { + "type": "string", + "description": "resourceSharingLevel" + }, + "serviceType": { + "type": "string", + "description": "serviceType" + }, + "maxNumberofUEs": { + "type": "integer", + "description": "maxNumberofUEs" + } + } + } + } + } + } + } + } + }, + "deleteMOI": { + "type": "object", + "properties": { + "attributes": { + "type": "object", + "properties": { + "sliceProfileList": { + "type": "object", + "description": "List of slice profile attributes", + "properties": { + "sliceProfileId": { + "type": "string", + "description": "sliceProfileId to be modify" + } + } + } + } + } + } } } } -- cgit 1.2.3-korg