Swagger/RSM_API.yaml

   1 # ========================LICENSE_START=================================
   2 # O-RAN-SC
   3 #
   4 # Copyright (C) 2019 AT&T Intellectual Property and Nokia
   5 #
   6 # Licensed under the Apache License, Version 2.0 (the "License");
   7 # you may not use this file except in compliance with the License.
   8 # You may obtain a copy of the License at
   9 #
  10 #      http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 # Unless required by applicable law or agreed to in writing, software
  13 # distributed under the License is distributed on an "AS IS" BASIS,
  14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 # See the License for the specific language governing permissions and
  16 # limitations under the License.
  17 # ========================LICENSE_END===================================
  18 #
  19 #   This source code is part of the near-RT RIC (RAN Intelligent Controller)
  20 #   platform project (RICP).
  21 #
  22
  23
  24
  25
  26 openapi: 3.0.0
  27 info:
  28   title: RSM Service
  29   description: RSM Service APIs
  30   version: 2.0.5
  31 servers:
  32   - url: 'http://{apiRoot}/v1'
  33     variables:
  34       apiRoot:
  35         default: 'localhost:?'
  36 paths:
  37   /health:
  38     get:
  39       tags:
  40         - Health Check
  41       summary: RSM Service Health Check
  42       responses:
  43         '204':
  44           description: OK
  45 components:
  46   schemas:
  47     ErrorResponse:
  48       type: object
  49       required:
  50         - errorCode
  51         - errorMessage
  52       properties:
  53         errorCode:
  54           type: string
  55           description: '401 - corrupted json, 402 - validation error, 403 - RAN in wrong state, 404 - resource not found, 500 - RNIB error, 501 - internal problem, 502 - RMR error'
  56         errorMessage:
  57           type: string
  58           description: Human readable text