ves-nf-oam-adopter/ves-nf-oam-adopter-mock/docs/api/swagger/openapi.yaml

   1 #  ============LICENSE_START=======================================================
   2 #  Copyright © 2021 AT&T Intellectual Property. All rights reserved.
   3 #  ================================================================================
   4 #  Licensed under the Apache License, Version 2.0 (the "License");
   5 #  you may not use this file except in compliance with the License.
   6 #  You may obtain a copy of the License at
   7 #
   8 #        http://www.apache.org/licenses/LICENSE-2.0
   9 #  Unless required by applicable law or agreed to in writing, software
  10 #  distributed under the License is distributed on an "AS IS" BASIS,
  11 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 #  See the License for the specific language governing permissions and
  13 #  limitations under the License.
  14 #
  15 #  SPDX-License-Identifier: Apache-2.0
  16 #  ============LICENSE_END=========================================================
  17 openapi: 3.0.3
  18 info:
  19   title: O-RAN OAM Adopter RAN Mock
  20   description: API for O-RAN OAM Adopter RAN Mock service.
  21   version: "1.0.0"
  22   license:
  23     name: "Apache 2.0"
  24     url: "http://www.apache.org/licenses/LICENSE-2.0"
  25
  26 servers:
  27   - url: https://example.io/v1
  28
  29 paths:
  30   /auth/token:
  31     post:
  32       security:
  33         - BasicAuth: [ ]
  34       tags:
  35         - controller
  36       summary: Generate token
  37       description: Generate token
  38       operationId: authenticateAndGenerateToken
  39       responses:
  40         '200':
  41           description: Successfully returned a list of adapters host address
  42           content:
  43             application/json:
  44               schema:
  45                 type: string
  46         '400':
  47           $ref: '#/components/responses/400Error'
  48         '401':
  49           $ref: '#/components/responses/401Error'
  50   /pm/files:
  51     post:
  52       tags:
  53         - controller
  54       summary: Read Performance Management Files
  55       description: Read Performance Management Files
  56       operationId: getPerformanceManagementFiles
  57       responses:
  58         '200':
  59           description: Successfully returned ZIP with CSV pm files
  60           content:
  61             application/zip:
  62               schema:
  63                 type: string
  64                 format: binary
  65         '400':
  66           $ref: '#/components/responses/400Error'
  67         '401':
  68           $ref: '#/components/responses/401Error'
  69   /system/timeZone:
  70     post:
  71       tags:
  72         - controller
  73       summary: Read time zone
  74       description: Read time zone
  75       operationId: getTimeZone
  76       responses:
  77         '200':
  78           description: Successfully returned time zone of the RAN
  79           content:
  80             application/json:
  81               schema:
  82                 type: string
  83         '400':
  84           $ref: '#/components/responses/400Error'
  85         '401':
  86           $ref: '#/components/responses/401Error'
  87
  88 components:
  89   responses:
  90     400Error:
  91       description: Invalid request
  92       content:
  93         application/json:
  94           schema:
  95             type: object
  96             properties:
  97               message:
  98                 type: string
  99     401Error:
 100       description: Unauthorized
 101       content:
 102         application/json:
 103           schema:
 104             type: object
 105             properties:
 106               message:
 107                 type: string