diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sections/apis/swagger_slice_analysis.json | 163 | ||||
| -rw-r--r-- | docs/sections/apis/swagger_slice_analysis.yaml | 130 |
2 files changed, 293 insertions, 0 deletions
diff --git a/docs/sections/apis/swagger_slice_analysis.json b/docs/sections/apis/swagger_slice_analysis.json new file mode 100644 index 00000000..22235ffb --- /dev/null +++ b/docs/sections/apis/swagger_slice_analysis.json @@ -0,0 +1,163 @@ +{ + "swagger": "2.0", + "info": { + "description": "Slice Analysis MS is introduced in ONAP for: (a) Analyzing the FM/PM data (reported from the xNFs) and KPI data (computed from PM data) related to various slice instances (NSIs), slice sub-net instances (NSSIs) and services catered to by the slices (S-NSSAIs). (b) Determining and triggering appropriate Control Loop actions based on the analysis above (c) Receiving recommendations for closed loop actions from ML or Analytics engines, performing validity checks, etc. to determine if the actions can be carried out, and then triggering the appropriate Control Loop (d) Providing utilization details of slices", + "version": "1.0.7", + "title": "Slice-analysis MS APIs", + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + } + }, + "host": "localhost:8080", + "basePath": "/", + "tags": [ + { + "name": "slice-config", + "description": "API for getting utilization of slices" + } + ], + "schemes": [ + "http" + ], + "paths": { + "/api/v1/slices-config": { + "post": { + "tags": [ + "slice-config" + ], + "summary": "Get utilization of slices", + "operationId": "sliceConfig", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Slice config request", + "required": true, + "schema": { + "$ref": "#/definitions/SliceConfigRequest" + } + } + ], + "responses": { + "200": { + "description": "SliceConfig details returned successfully", + "schema": { + "$ref": "#/definitions/SliceConfigResponse" + } + }, + "400": { + "description": "Invalid input" + }, + "500": { + "description": "Internal server error" + } + } + } + }, + "/healthcheck": { + "get": { + "tags": [ + "healthcheck" + ], + "summary": "healthcheck api", + "description": "api to check if slice-analysis ms is healthy", + "operationId": "healthcheck", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "slice-analysis ms is healthy" + }, + "500": { + "description": "Internal server error" + } + } + } + } + }, + "definitions": { + "SliceConfigRequest": { + "type": "object", + "required": [ + "sliceIdentifiers", + "configParams" + ], + "properties": { + "sliceIdentifiers": { + "type": "array", + "items": { + "type": "string", + "example": [ + "7e000ddc-7ba1-4fdb-a7ce-8f0a65ab3282" + ] + } + }, + "configParams": { + "type": "array", + "items": { + "type": "string", + "example": [ + "dLThptPerSlice", + "uLThptPerSlice", + "maxNumberOfConns" + ] + } + } + } + }, + "SliceConfigResponse": { + "type": "object", + "required": [ + "sliceConfigDetails" + ], + "properties": { + "sliceConfigDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/sliceConfigDetails" + } + } + } + }, + "sliceConfigDetails": { + "type": "object", + "properties": { + "sliceIdentifier": { + "type": "string", + "example": "7e000ddc-7ba1-4fdb-a7ce-8f0a65ab3282" + }, + "aggregatedConfig": { + "type": "object", + "properties": { + "dLThptPerSlice": { + "type": "integer", + "format": "int64", + "example": 40 + }, + "uLThptPerSlice": { + "type": "integer", + "format": "int64", + "example": 25 + }, + "maxNumberOfConns": { + "type": "integer", + "format": "int64", + "example": 400 + } + } + } + } + } + } +} diff --git a/docs/sections/apis/swagger_slice_analysis.yaml b/docs/sections/apis/swagger_slice_analysis.yaml new file mode 100644 index 00000000..b346fc42 --- /dev/null +++ b/docs/sections/apis/swagger_slice_analysis.yaml @@ -0,0 +1,130 @@ +# ============LICENSE_START======================================================= +# Copyright (C) 2022 Wipro Limited. +# ================================================================================ +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ============LICENSE_END========================================================= + +swagger: "2.0" +info: + description: "Slice Analysis MS is introduced in ONAP for: (a) Analyzing the FM/PM data (reported from the xNFs) and KPI data (computed from PM data) related to various slice instances (NSIs), slice sub-net instances (NSSIs) and services catered to by the slices (S-NSSAIs). (b) Determining and triggering appropriate Control Loop actions based on the analysis above (c) Receiving recommendations for closed loop actions from ML or Analytics engines, performing validity checks, etc. to determine if the actions can be carried out, and then triggering the appropriate Control Loop (d) Providing utilization details of slices" + version: "1.0.7" + title: "Slice-analysis MS APIs" + license: + name: "Apache 2.0" + url: "http://www.apache.org/licenses/LICENSE-2.0.html" +host: "localhost:8080" +basePath: "/" +tags: +- name: "slice-config" + description: "API for getting utilization of slices" +schemes: +- "http" +paths: + /api/v1/slices-config: + post: + tags: + - "slice-config" + summary: "Get utilization of slices" + operationId: "sliceConfig" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - in: "body" + name: "body" + description: "Slice config request" + required: true + schema: + $ref: "#/definitions/SliceConfigRequest" + responses: + "200": + description: "SliceConfig details returned successfully" + schema: + $ref: "#/definitions/SliceConfigResponse" + "400": + description: "Invalid input" + "500": + description: "Internal server error" + + /healthcheck: + get: + tags: + - "healthcheck" + summary: "healthcheck api" + description: "api to check if slice-analysis ms is healthy" + operationId: "healthcheck" + consumes: + - "application/json" + produces: + - "application/json" + responses: + "200": + description: "slice-analysis ms is healthy" + "500": + description: "Internal server error" + +definitions: + SliceConfigRequest: + type: "object" + required: + - "sliceIdentifiers" + - "configParams" + properties: + sliceIdentifiers: + type: "array" + items: + type: string + example: + - 7e000ddc-7ba1-4fdb-a7ce-8f0a65ab3282 + configParams: + type: "array" + items: + type: string + example: + - dLThptPerSlice + - uLThptPerSlice + - maxNumberOfConns + + SliceConfigResponse: + type: "object" + required: + - "sliceConfigDetails" + properties: + sliceConfigDetails: + type: "array" + items: + $ref: '#/definitions/sliceConfigDetails' + + sliceConfigDetails: + type: "object" + properties: + sliceIdentifier: + type: "string" + example: 7e000ddc-7ba1-4fdb-a7ce-8f0a65ab3282 + aggregatedConfig: + type: "object" + properties: + dLThptPerSlice: + type: integer + format: int64 + example: 40 + uLThptPerSlice: + type: integer + format: int64 + example: 25 + maxNumberOfConns: + type: integer + format: int64 + example: 400 |