diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/swagger/swagger.json | 409 | ||||
| -rw-r--r-- | docs/api/swagger/swagger.yaml | 284 | ||||
| -rw-r--r-- | docs/developer_info/Building_SO.rst | 2 | ||||
| -rw-r--r-- | docs/developer_info/FAQs.rst | 2 | ||||
| -rw-r--r-- | docs/release-notes.rst | 2 |
5 files changed, 693 insertions, 6 deletions
diff --git a/docs/api/swagger/swagger.json b/docs/api/swagger/swagger.json index 6ba8380a5f..5051ba19e9 100644 --- a/docs/api/swagger/swagger.json +++ b/docs/api/swagger/swagger.json @@ -2,13 +2,16 @@ "swagger": "2.0", "info": { "version": "3.1.2", - "title": "SO Casablanca APIs" + "title": "SO Guilin APIs" }, "tags": [ { "name": "e2eServiceInstances" }, { + "name": "3gppservices" + }, + { "name": "globalhealthcheck" }, { @@ -288,6 +291,252 @@ } } }, + "/onap/so/infra/3gppservices/{version}/allocate": { + "post": { + "tags": [ + "3gppservices" + ], + "summary": "Create a 3GPP Service Instance on a version provided", + "description": "", + "operationId": "allocate3gppService", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Allocate3gppService" + } + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][1]" + } + ], + "responses": { + "default": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/3gppServiceResponse" + } + } + } + } + }, + "/onap/so/infra/3gppservices/{version}/deAllocate": { + "delete": { + "tags": [ + "3gppservices" + ], + "summary": "Terminate/Deallocate a 3GPP Service Instance on a version provided", + "description": "", + "operationId": "deallocate3gppService", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DeAllocate3gppService" + } + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][1]" + } + ], + "responses": { + "default": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/3gppServiceResponse" + } + } + } + } + }, + "/onap/so/infra/3gppservices/{version}/modify": { + "put": { + "tags": [ + "3gppservices" + ], + "summary": "Modify a 3GPP Service Instance on a version provided", + "description": "", + "operationId": "modify3gppService", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Modify3gppService" + } + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][1]" + } + ], + "responses": { + "default": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/3gppServiceResponse" + } + } + } + } + }, + "/onap/so/infra/3gppservices/{version}/activate": { + "post": { + "tags": [ + "3gppservices" + ], + "summary": "Activate a 3GPP Service Instance on a version provided", + "description": "", + "operationId": "activate3gppService", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/3gppServiceActivation" + } + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][1]" + } + ], + "responses": { + "default": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/3gppServiceResponse" + } + } + } + } + }, + "/onap/so/infra/3gppservices/{version}/deActivate": { + "post": { + "tags": [ + "3gppservices" + ], + "summary": "Deactivate a 3GPP Service Instance on a version provided", + "description": "", + "operationId": "deactivate3gppService", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/3gppServiceActivation" + } + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][1]" + } + ], + "responses": { + "default": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/3gppServiceResponse" + } + } + } + } + }, + "/onap/so/infra/3gppservices/{version}/subnetCapabilityQuery": { + "get": { + "tags": [ + "3gppservices" + ], + "summary": "Provides subnet capability based on subnet types", + "description": "", + "operationId": "querySubnetCapability", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QuerySubnetCapability" + } + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "pattern": "[vV][1]" + } + ], + "responses": { + "default": { + "description": "successful operation with capabilities for the queried subnetTypes", + "schema": { + "type": "object" + } + } + } + } + }, "/globalhealthcheck": { "get": { "tags": [ @@ -2298,5 +2547,161 @@ } } } + }, + "definitions": { + "Allocate3gppService": { + "description": "This describes the request body for 3gpp service allocation", + "type": "object", + "properties": { + "name": { + "description": "Name of the service to allocate", + "type": "string" + }, + "modelInvariantUuid": { + "description": "Model Invariant UUID corresponding to the service. For E.g : NSST Model invariant uuid in case of NSSI creation", + "type": "string" + }, + "modelUuid": { + "description": "Model UUID corresponding to the service. For E.g : NSST Model uuid in case of NSSI creation", + "type": "string" + }, + "globalSubscriberId": { + "type": "string" + }, + "subscriptionServiceType": { + "description": "Service type for the subscription. For E.G :5G", + "type": "string" + }, + "networkType": { + "description": "Network type. For E.G :AN/CN/TN", + "type": "string" + }, + "additionalProperties": { + "description": "Map of additional properties required for service allocation", + "type": "object" + } + } + }, + "DeAllocate3gppService": { + "description": "This describes the request body for 3gpp service Termination/Deallocation", + "type": "object", + "properties": { + "serviceInstanceID": { + "description": "ID of the service to terminate", + "type": "string" + }, + "globalSubscriberId": { + "type": "string" + }, + "subscriptionServiceType": { + "description": "Service type for the subscription. For E.G :5G", + "type": "string" + }, + "networkType": { + "description": "Network type. For E.G :AN/CN/TN", + "type": "string" + }, + "additionalProperties": { + "description": "Map of additional properties required for service deallocation", + "type": "object" + } + } + }, + "Modify3gppService": { + "description": "This describes the request body for 3gpp service modification", + "type": "object", + "properties": { + "name": { + "description": "Name of the service to modify", + "type": "string" + }, + "serviceInstanceID": { + "description": "ID of the service to modify", + "type": "string" + }, + "globalSubscriberId": { + "type": "string" + }, + "subscriptionServiceType": { + "description": "Service type for the subscription. For E.G :5G", + "type": "string" + }, + "networkType": { + "description": "Network type. For E.G :AN/CN/TN", + "type": "string" + }, + "additionalProperties": { + "description": "Map of additional properties required for service modification", + "type": "object" + } + } + }, + "3gppServiceActivation": { + "description": "This describes the request body for 3gpp service activation/deactivation", + "type": "object", + "properties": { + "serviceInstanceID": { + "description": "ID of the service to be activated/deactivated", + "type": "string" + }, + "globalSubscriberId": { + "type": "string" + }, + "subscriptionServiceType": { + "description": "Service type for the subscription. For E.G :5G", + "type": "string" + }, + "networkType": { + "description": "Network type. For E.G :AN/CN/TN", + "type": "string" + }, + "additionalProperties": { + "description": "Map of additional properties required for service activation/deactivation", + "type": "object" + } + } + }, + "QuerySubnetCapability": { + "description": "This describes the subnet capabilities that can be queried", + "type": "object", + "properties": { + "subnetTypes": { + "type": "array", + "items": { + "$ref": "#/definitions/SubnetTypes" + } + } + } + }, + "SubnetTypes": { + "description": "This describes allowed subnet types", + "type": "string", + "enum": [ + "AN", + "AN-NF", + "CN", + "TN-FH", + "TN-MH", + "TN-BH" + ] + }, + "3gppServiceResponse": { + "description": "This describes the response for 3gpp services", + "type": "object", + "properties": { + "jobId": { + "description": "Job ID to be used to identify the status of the job", + "type": "string" + }, + "status": { + "description": "status of the job", + "type": "string" + }, + "statusDescription": { + "description": "Description on status in case of erroneous response", + "type": "string" + } + } + } } -}
\ No newline at end of file +} diff --git a/docs/api/swagger/swagger.yaml b/docs/api/swagger/swagger.yaml index 11c72b612c..049436f954 100644 --- a/docs/api/swagger/swagger.yaml +++ b/docs/api/swagger/swagger.yaml @@ -1,9 +1,10 @@ swagger: '2.0' info: version: 3.1.2 - title: SO Casablanca APIs + title: SO Guilin APIs tags: - name: e2eServiceInstances + - name: 3gppservices - name: globalhealthcheck - name: nodehealthcheck - name: onapsoinfraorchestrationRequests @@ -183,6 +184,168 @@ paths: responses: default: description: successful operation + '/onap/so/infra/3gppservices/{version}/allocate': + post: + tags: + - 3gppservices + summary: Create a 3GPP Service Instance on a version provided + description: '' + operationId: allocate3gppService + consumes: + - application/json + produces: + - application/json + parameters: + - in: body + name: body + required: true + schema: + $ref: '#/definitions/Allocate3gppService' + - name: version + in: path + required: true + type: string + pattern: '[vV][1]' + responses: + default: + description: successful operation + schema: + $ref: '#/definitions/3gppServiceResponse' + '/onap/so/infra/3gppservices/{version}/deAllocate': + delete: + tags: + - 3gppservices + summary: Terminate/Deallocate a 3GPP Service Instance on a version provided + description: '' + operationId: deallocate3gppService + consumes: + - application/json + produces: + - application/json + parameters: + - in: body + name: body + required: true + schema: + $ref: '#/definitions/DeAllocate3gppService' + - name: version + in: path + required: true + type: string + pattern: '[vV][1]' + responses: + default: + description: successful operation + schema: + $ref: '#/definitions/3gppServiceResponse' + '/onap/so/infra/3gppservices/{version}/modify': + put: + tags: + - 3gppservices + summary: Modify a 3GPP Service Instance on a version provided + description: '' + operationId: modify3gppService + consumes: + - application/json + produces: + - application/json + parameters: + - in: body + name: body + required: true + schema: + $ref: '#/definitions/Modify3gppService' + - name: version + in: path + required: true + type: string + pattern: '[vV][1]' + responses: + default: + description: successful operation + schema: + $ref: '#/definitions/3gppServiceResponse' + '/onap/so/infra/3gppservices/{version}/activate': + post: + tags: + - 3gppservices + summary: Activate a 3GPP Service Instance on a version provided + description: '' + operationId: activate3gppService + consumes: + - application/json + produces: + - application/json + parameters: + - in: body + name: body + required: true + schema: + $ref: '#/definitions/3gppServiceActivation' + - name: version + in: path + required: true + type: string + pattern: '[vV][1]' + responses: + default: + description: successful operation + schema: + $ref: '#/definitions/3gppServiceResponse' + '/onap/so/infra/3gppservices/{version}/deActivate': + post: + tags: + - 3gppservices + summary: Deactivate a 3GPP Service Instance on a version provided + description: '' + operationId: deactivate3gppService + consumes: + - application/json + produces: + - application/json + parameters: + - in: body + name: body + required: true + schema: + $ref: '#/definitions/3gppServiceActivation' + - name: version + in: path + required: true + type: string + pattern: '[vV][1]' + responses: + default: + description: successful operation + schema: + $ref: '#/definitions/3gppServiceResponse' + '/onap/so/infra/3gppservices/{version}/subnetCapabilityQuery': + get: + tags: + - 3gppservices + summary: Provides subnet capability based on subnet types + description: '' + operationId: querySubnetCapability + consumes: + - application/json + produces: + - application/json + parameters: + - in: body + name: body + required: true + schema: + $ref: '#/definitions/QuerySubnetCapability' + - name: version + in: path + required: true + type: string + pattern: '[vV][1]' + responses: + default: + description: successful operation with capabilities for the queried subnetTypes + schema: + type: object /globalhealthcheck: get: tags: @@ -1518,3 +1681,122 @@ paths: responses: default: description: successful operation +definitions: + Allocate3gppService: + description: This describes the request body for 3gpp service allocation + type: object + properties: + name: + description: Name of the service to allocate + type: string + modelInvariantUuid: + description: >- + Model Invariant UUID corresponding to the service. For E.g : NSST + Model invariant uuid in case of NSSI creation + type: string + modelUuid: + description: >- + Model UUID corresponding to the service. For E.g : NSST Model uuid in + case of NSSI creation + type: string + globalSubscriberId: + type: string + subscriptionServiceType: + description: 'Service type for the subscription. For E.G :5G' + type: string + networkType: + description: 'Network type. For E.G :AN/CN/TN' + type: string + additionalProperties: + description: Map of additional properties required for service allocation + type: object + DeAllocate3gppService: + description: This describes the request body for 3gpp service Termination/Deallocation + type: object + properties: + serviceInstanceID: + description: ID of the service to terminate + type: string + globalSubscriberId: + type: string + subscriptionServiceType: + description: 'Service type for the subscription. For E.G :5G' + type: string + networkType: + description: 'Network type. For E.G :AN/CN/TN' + type: string + additionalProperties: + description: Map of additional properties required for service deallocation + type: object + Modify3gppService: + description: This describes the request body for 3gpp service modification + type: object + properties: + name: + description: Name of the service to modify + type: string + serviceInstanceID: + description: ID of the service to modify + type: string + globalSubscriberId: + type: string + subscriptionServiceType: + description: 'Service type for the subscription. For E.G :5G' + type: string + networkType: + description: 'Network type. For E.G :AN/CN/TN' + type: string + additionalProperties: + description: Map of additional properties required for service modification + type: object + 3gppServiceActivation: + description: This describes the request body for 3gpp service activation/deactivation + type: object + properties: + serviceInstanceID: + description: ID of the service to be activated/deactivated + type: string + globalSubscriberId: + type: string + subscriptionServiceType: + description: 'Service type for the subscription. For E.G :5G' + type: string + networkType: + description: 'Network type. For E.G :AN/CN/TN' + type: string + additionalProperties: + description: >- + Map of additional properties required for service + activation/deactivation + type: object + QuerySubnetCapability: + description: This describes the subnet capabilities that can be queried + type: object + properties: + subnetTypes: + type: array + items: + $ref: '#/definitions/SubnetTypes' + SubnetTypes: + description: This describes allowed subnet types + type: string + enum: + - AN + - AN-NF + - CN + - TN-FH + - TN-MH + - TN-BH + 3gppServiceResponse: + description: This describes the response for 3gpp services + type: object + properties: + jobId: + description: Job ID to be used to identify the status of the job + type: string + status: + description: status of the job + type: string + statusDescription: + description: Description on status in case of erroneous response + type: string diff --git a/docs/developer_info/Building_SO.rst b/docs/developer_info/Building_SO.rst index 7d68e433cc..edd2515fee 100644 --- a/docs/developer_info/Building_SO.rst +++ b/docs/developer_info/Building_SO.rst @@ -36,7 +36,7 @@ Build docker images SO docker images are built using the "docker" maven profile. -During the build, the chef-repo and so-docker repositories are cloned from gerrit into the "so" directory structure. Extra definitions are required in the build environment to make this happen. You may need to adjust the definition of mso.chef.git.url.prefix to match the way you authenticate yourself when performing git clone. +During the build, the chef-repo and so-docker repositories are cloned from gerrit into the "so" directory structure. Extra definitions are required in the build environment to make this happen. You may need to adjust the definition of mso.chef.git.url.prefix to match the way you authenticate yourself when performing git clone --depth 1. If you are behind a corporate firewall, you can specify proxy definitions for the constructed docker images. diff --git a/docs/developer_info/FAQs.rst b/docs/developer_info/FAQs.rst index cd6784071c..55a7049f49 100644 --- a/docs/developer_info/FAQs.rst +++ b/docs/developer_info/FAQs.rst @@ -57,7 +57,7 @@ How to Build docker images SO docker images are built using the "docker" maven profile. -During the build, the chef-repo and so-docker repositories are cloned from gerrit into the "so" directory structure. Extra definitions are required in the build environment to make this happen. You may need to adjust the definition of mso.chef.git.url.prefix to match the way you authenticate yourself when performing git clone. +During the build, the chef-repo and so-docker repositories are cloned from gerrit into the "so" directory structure. Extra definitions are required in the build environment to make this happen. You may need to adjust the definition of mso.chef.git.url.prefix to match the way you authenticate yourself when performing git clone --depth 1. If you are behind a corporate firewall, you can specify proxy definitions for the constructed docker images. diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 4fb098f656..ed8c7de674 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -439,7 +439,7 @@ The main goal of the El-Alto release was to improve documentation, UT improvemen - [`SO-2354 <https://jira.onap.org/browse/SO-2354>`__\ ] - vCPE model_customization_id not found on create vfmodule - [`SO-2351 <https://jira.onap.org/browse/SO-2351>`__\ ] - SO Distribution Error on Allotted Resource - duplicate primary - [`SO-2349 <https://jira.onap.org/browse/SO-2349>`__\ ] - Exception in DMAAP Client when PNF_READY event arrives from PRH -- [`SO-2337 <https://jira.onap.org/browse/SO-2337>`__\ ] - Git clone not working for CSIT filename too long +- [`SO-2337 <https://jira.onap.org/browse/SO-2337>`__\ ] - git clone --depth 1 not working for CSIT filename too long - [`SO-2289 <https://jira.onap.org/browse/SO-2289>`__\ ] - CreateVcpeResCustService_simplified workflow used in PnP PNF registration workflow returns an exception in Dmaap listener - [`SO-2229 <https://jira.onap.org/browse/SO-2229>`__\ ] - sdc adapter and openstack container in crash loopback - [`SO-2228 <https://jira.onap.org/browse/SO-2228>`__\ ] - SDC Handler crash loopback |