docs/api.json

   1 {
   2   "swagger": "2.0",
   3   "info": {
   4     "description": "Proxies access to Near-RT RIC.",
   5     "version": "version not available",
   6     "title": "Non-RT RIC Control Panel backend",
   7     "termsOfService": "Terms of service",
   8     "contact": {
   9       "name": "Non-RT RIC Control Panel Dev Team",
  10       "url": "http://no-docs-yet.org/",
  11       "email": "noreply@O-RAN-SC.org"
  12     },
  13     "license": {
  14       "name": "Apache 2.0 License",
  15       "url": "http://www.apache.org/licenses/LICENSE-2.0"
  16     }
  17   },
  18   "basePath": "/",
  19   "tags": [
  20     {
  21       "name": "enrichment-controller",
  22       "description": "Enrichment Controller"
  23     },
  24     {
  25       "name": "html-5-paths-controller",
  26       "description": "Html 5 Paths Controller"
  27     },
  28     {
  29       "name": "policy-controller",
  30       "description": "Policy Controller"
  31     }
  32   ],
  33   "paths": {
  34     "/api/enrichment/eijobs": {
  35       "get": {
  36         "tags": [
  37           "enrichment-controller"
  38         ],
  39         "summary": "Get the EI job definitions for one EI producer",
  40         "operationId": "getEiJobsUsingGET",
  41         "produces": [
  42           "application/json"
  43         ],
  44         "responses": {
  45           "200": {
  46             "description": "OK",
  47             "schema": {
  48               "type": "array",
  49               "items": {
  50                 "$ref": "#/definitions/ei_job_request"
  51               }
  52             }
  53           },
  54           "401": {
  55             "description": "Unauthorized"
  56           },
  57           "403": {
  58             "description": "Forbidden"
  59           },
  60           "404": {
  61             "description": "Not Found"
  62           }
  63         },
  64         "deprecated": false
  65       }
  66     },
  67     "/api/enrichment/eiproducers": {
  68       "get": {
  69         "tags": [
  70           "enrichment-controller"
  71         ],
  72         "summary": "Get EI producers",
  73         "operationId": "getEiProducersUsingGET",
  74         "produces": [
  75           "application/json"
  76         ],
  77         "responses": {
  78           "200": {
  79             "description": "OK",
  80             "schema": {
  81               "type": "array",
  82               "items": {
  83                 "$ref": "#/definitions/ei_producer"
  84               }
  85             }
  86           },
  87           "401": {
  88             "description": "Unauthorized"
  89           },
  90           "403": {
  91             "description": "Forbidden"
  92           },
  93           "404": {
  94             "description": "Not Found"
  95           }
  96         },
  97         "deprecated": false
  98       }
  99     },
 100     "/api/policy/policies": {
 101       "get": {
 102         "tags": [
 103           "policy-controller"
 104         ],
 105         "summary": "Returns the policy instances for the given policy type.",
 106         "operationId": "getPolicyInstancesUsingGET",
 107         "produces": [
 108           "application/json"
 109         ],
 110         "parameters": [
 111           {
 112             "name": "type",
 113             "in": "query",
 114             "description": "type",
 115             "required": true,
 116             "type": "string"
 117           }
 118         ],
 119         "responses": {
 120           "200": {
 121             "description": "OK",
 122             "schema": {
 123               "type": "string"
 124             }
 125           },
 126           "401": {
 127             "description": "Unauthorized"
 128           },
 129           "403": {
 130             "description": "Forbidden"
 131           },
 132           "404": {
 133             "description": "Not Found"
 134           }
 135         },
 136         "deprecated": false
 137       }
 138     },
 139     "/api/policy/policies/{policy_instance_id}": {
 140       "get": {
 141         "tags": [
 142           "policy-controller"
 143         ],
 144         "summary": "Returns a policy instance of a type",
 145         "operationId": "getPolicyInstanceUsingGET",
 146         "produces": [
 147           "application/json"
 148         ],
 149         "parameters": [
 150           {
 151             "name": "policy_instance_id",
 152             "in": "path",
 153             "description": "policy_instance_id",
 154             "required": true,
 155             "type": "string"
 156           },
 157           {
 158             "name": "type",
 159             "in": "query",
 160             "description": "type",
 161             "required": true,
 162             "type": "string"
 163           }
 164         ],
 165         "responses": {
 166           "200": {
 167             "description": "OK",
 168             "schema": {
 169               "type": "object"
 170             }
 171           },
 172           "401": {
 173             "description": "Unauthorized"
 174           },
 175           "403": {
 176             "description": "Forbidden"
 177           },
 178           "404": {
 179             "description": "Not Found"
 180           }
 181         },
 182         "deprecated": false
 183       },
 184       "put": {
 185         "tags": [
 186           "policy-controller"
 187         ],
 188         "summary": "Creates the policy instances for the given policy type.",
 189         "operationId": "putPolicyInstanceUsingPUT",
 190         "consumes": [
 191           "application/json"
 192         ],
 193         "produces": [
 194           "application/json"
 195         ],
 196         "parameters": [
 197           {
 198             "in": "body",
 199             "name": "instance",
 200             "description": "instance",
 201             "required": true,
 202             "schema": {
 203               "type": "string"
 204             }
 205           },
 206           {
 207             "name": "policy_instance_id",
 208             "in": "path",
 209             "description": "policy_instance_id",
 210             "required": true,
 211             "type": "string"
 212           },
 213           {
 214             "name": "ric",
 215             "in": "query",
 216             "description": "ric",
 217             "required": true,
 218             "type": "string"
 219           },
 220           {
 221             "name": "type",
 222             "in": "query",
 223             "description": "type",
 224             "required": true,
 225             "type": "string"
 226           }
 227         ],
 228         "responses": {
 229           "200": {
 230             "description": "OK",
 231             "schema": {
 232               "type": "string"
 233             }
 234           },
 235           "201": {
 236             "description": "Created"
 237           },
 238           "401": {
 239             "description": "Unauthorized"
 240           },
 241           "403": {
 242             "description": "Forbidden"
 243           },
 244           "404": {
 245             "description": "Not Found"
 246           }
 247         },
 248         "deprecated": false
 249       },
 250       "delete": {
 251         "tags": [
 252           "policy-controller"
 253         ],
 254         "summary": "Deletes the policy instances for the given policy type.",
 255         "operationId": "deletePolicyInstanceUsingDELETE",
 256         "produces": [
 257           "application/json"
 258         ],
 259         "parameters": [
 260           {
 261             "name": "policy_instance_id",
 262             "in": "path",
 263             "description": "policy_instance_id",
 264             "required": true,
 265             "type": "string"
 266           },
 267           {
 268             "name": "type",
 269             "in": "query",
 270             "description": "type",
 271             "required": true,
 272             "type": "string"
 273           }
 274         ],
 275         "responses": {
 276           "200": {
 277             "description": "OK",
 278             "schema": {
 279               "type": "string"
 280             }
 281           },
 282           "204": {
 283             "description": "No Content"
 284           },
 285           "401": {
 286             "description": "Unauthorized"
 287           },
 288           "403": {
 289             "description": "Forbidden"
 290           }
 291         },
 292         "deprecated": false
 293       }
 294     },
 295     "/api/policy/policytypes": {
 296       "get": {
 297         "tags": [
 298           "policy-controller"
 299         ],
 300         "summary": "Gets the policy types from Near-RT RIC",
 301         "operationId": "getAllPolicyTypesUsingGET",
 302         "produces": [
 303           "application/json"
 304         ],
 305         "responses": {
 306           "200": {
 307             "description": "OK",
 308             "schema": {
 309               "type": "string"
 310             }
 311           },
 312           "401": {
 313             "description": "Unauthorized"
 314           },
 315           "403": {
 316             "description": "Forbidden"
 317           },
 318           "404": {
 319             "description": "Not Found"
 320           }
 321         },
 322         "deprecated": false
 323       }
 324     },
 325     "/api/policy/rics": {
 326       "get": {
 327         "tags": [
 328           "policy-controller"
 329         ],
 330         "summary": "Returns the rics supporting the given policy type.",
 331         "operationId": "getRicsSupportingTypeUsingGET",
 332         "produces": [
 333           "application/json"
 334         ],
 335         "parameters": [
 336           {
 337             "name": "policyType",
 338             "in": "query",
 339             "description": "policyType",
 340             "required": true,
 341             "type": "string"
 342           }
 343         ],
 344         "responses": {
 345           "200": {
 346             "description": "OK",
 347             "schema": {
 348               "type": "string"
 349             }
 350           },
 351           "401": {
 352             "description": "Unauthorized"
 353           },
 354           "403": {
 355             "description": "Forbidden"
 356           },
 357           "404": {
 358             "description": "Not Found"
 359           }
 360         },
 361         "deprecated": false
 362       }
 363     },
 364     "/policy": {
 365       "get": {
 366         "tags": [
 367           "html-5-paths-controller"
 368         ],
 369         "summary": "forwardAngularRoutes",
 370         "operationId": "forwardAngularRoutesUsingGET",
 371         "produces": [
 372           "*/*"
 373         ],
 374         "responses": {
 375           "200": {
 376             "description": "OK"
 377           },
 378           "401": {
 379             "description": "Unauthorized"
 380           },
 381           "403": {
 382             "description": "Forbidden"
 383           },
 384           "404": {
 385             "description": "Not Found"
 386           }
 387         },
 388         "deprecated": false
 389       }
 390     }
 391   },
 392   "definitions": {
 393     "ei_job_request": {
 394       "type": "object",
 395       "required": [
 396         "ei_job_identity"
 397       ],
 398       "properties": {
 399         "ei_job_data": {
 400           "type": "object",
 401           "description": "Json for the job data"
 402         },
 403         "ei_job_identity": {
 404           "type": "string",
 405           "description": "Identity of the EI job"
 406         },
 407         "ei_type_identity": {
 408           "type": "string",
 409           "description": "Type identity for the job"
 410         },
 411         "owner": {
 412           "type": "string",
 413           "description": "The owner of the job"
 414         },
 415         "target_uri": {
 416           "type": "string",
 417           "description": "URI for the target of the EI"
 418         }
 419       },
 420       "title": "ei_job_request",
 421       "description": "The EI job"
 422     },
 423     "ei_producer": {
 424       "type": "object",
 425       "required": [
 426         "ei_producer_id",
 427         "ei_producer_types",
 428         "status"
 429       ],
 430       "properties": {
 431         "ei_producer_id": {
 432           "type": "string",
 433           "description": "Idenitity of the EI producer"
 434         },
 435         "ei_producer_types": {
 436           "type": "array",
 437           "description": "Types provided by the EI producer",
 438           "items": {
 439             "type": "string"
 440           }
 441         },
 442         "status": {
 443           "type": "string",
 444           "description": "Status of the EI producer"
 445         }
 446       },
 447       "title": "ei_producer",
 448       "description": "The EI producer"
 449     }
 450   }
 451 }