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 openapi: 3.0.0
  20 info:
  21   title: RSM Service
  22   description: RSM Service APIs
  23   version: 2.0.5
  24 servers:
  25   - url: 'http://{apiRoot}/v1'
  26     variables:
  27       apiRoot:
  28         default: 'localhost:?'
  29 paths:
  30   /health:
  31     get:
  32       tags:
  33         - Health Check
  34       summary: RSM Service Health Check
  35       responses:
  36         '204':
  37           description: OK
  38 components:
  39   schemas:
  40     ErrorResponse:
  41       type: object
  42       required:
  43         - errorCode
  44         - errorMessage
  45       properties:
  46         errorCode:
  47           type: string
  48           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'
  49         errorMessage:
  50           type: string
  51           description: Human readable text