diff options
author | Lukasz Rajewski <lukasz.rajewski@t-mobile.pl> | 2023-04-12 08:05:16 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@onap.org> | 2023-04-12 08:05:16 +0000 |
commit | 53448a95871868d5009958ede72e724bc80c0961 (patch) | |
tree | 92a1bbe0b2127521f608131c05b017fd5e83a996 /docs/api/apis/ManagedObject3gppServiceInstances.rst | |
parent | c41c04b7b53bce7354d8cd1d47db3144e267a599 (diff) | |
parent | 4647e3ef6c87e271794e06fb1660cad5ee72ab04 (diff) |
Merge "Code changes in SO api-handler for RAN Slice"
Diffstat (limited to 'docs/api/apis/ManagedObject3gppServiceInstances.rst')
-rw-r--r-- | docs/api/apis/ManagedObject3gppServiceInstances.rst | 262 |
1 files changed, 262 insertions, 0 deletions
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 |