summaryrefslogtreecommitdiffstats
path: root/docs/sections/apis/swagger_slice_analysis.json
blob: 22235ffbb6bf9c9489808eb0cbd03974e6914616 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
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
            }
          }
        }
      }
    }
  }
}