docs/api-docs.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2021-2022 Wind River Systems, Inc.
   4
   5 .. _api_docs:
   6
   7 .. |swagger-icon| image:: ./images/swagger.png
   8                   :width: 40px
   9
  10 .. |yaml-icon| image:: ./images/yaml_logo.png
  11                   :width: 40px
  12
  13
  14 O-RAN O2 API Definition v1
  15 ==========================
  16
  17 This document defines how a SMO like application can perform the management
  18 of O-Cloud infrastructures and the deployment life cycle management of O-RAN
  19 cloudified NFs that run on O-Cloud via O-RAN O2 interfaces.
  20
  21 The typical port used for the O-RAN O2 REST API is 30205.
  22
  23 Here we describe the API to access the O2 API.
  24
  25
  26 O2 API v1
  27 ---------
  28
  29 The O2 API v1 provides API includes O2ims_InfrastructureInventory, O2ims_InfrastructureMonitoring and
  30 Kubernetes native API based O2dms interfaces.
  31
  32 See `O-RAN O2 API v1 <./oran-o2-api.html>`_ for full details of the API.
  33
  34 The API is also described in Swagger-JSON and YAML:
  35
  36
  37 .. csv-table::
  38    :header: "API name", "|swagger-icon|", "|yaml-icon|"
  39    :widths: 10,5, 5
  40
  41    "O-RAN O2 API", ":download:`link <./swagger.json>`", ":download:`link <./swagger.yaml>`"