data-model/oas3/experimental/o-ran-sc-ofhm.yaml

   1 openapi: 3.0.3
   2 info:
   3   version: 1.0.0
   4   title: OFHM-PROVIDER modules of RestConf (RFC8040)
   5   license:
   6     name: Apache 2.0
   7     url: http://www.apache.org/licenses/LICENSE-2.0.html
   8   description: |-
   9     This documentation implements the VES notifications defined by
  10     O-RAN Alliance WG4 for OpenFronthaul Management Plane (OFHM).
  11 externalDocs:
  12   description: |-
  13     O-RAN Working Group 4 (Open Fronthaul Interfaces WG)
  14     Management Plane Specification
  15     O-RAN.WG4.MP.0-R003-v11.00
  16   url: https://orandownloadsweb.azurewebsites.net/specifications
  17 servers:
  18   - url: https://ohfm-provider.orbit-lab.org/
  19 paths:
  20   /restconf/ofhm-event-stream:event-history:
  21     get:
  22       description: |-
  23         The root container of an event log inspired by O-RAN Alliance WG4 OpenFronthaul-Management-Plane.
  24       summary: GET - VES-OFHM-API-PROVIDER - ofhm-event-stream - event-history
  25       tags:
  26         - mounted VES-OFHM-API-PROVIDER - ofhm-event-stream - event-history
  27       responses:
  28         '200':
  29           content:
  30             application/json:
  31               schema:
  32                 $ref: '#/components/schemas/ofhm-event-stream-event-history-ref'
  33           description: OK
  34
  35 components:
  36   schemas:
  37     # notifications for o-ran-file-management.yang
  38     o-ran-file-management:file-path-grouping:
  39       type: object
  40       required:
  41       - local-logical-file-path
  42       - remote-file-path
  43       properties:
  44         local-logical-file-path:
  45           type: string
  46           description: |-
  47             URI specifying the complete logical path relative to the root of the logical file system
  48             structure (the common root for o-ran/log, o-ran/pm, o-ran/transceiver or o-ran/beamforming) of the file
  49             to upload/download (no wildcard is allowed), including a file name and its extension.
  50             Example: 'o-ran/log/file_1.abc', where 'o-ran/log/' represents relative path to folder containing log files
  51             as specified by O-RAN, 'file_1' represents desired filename and 'abc' represents desired filename's extension.
  52             The content shall conform to RFC3986 'Uniform Resource Identifier (URI): Generic Syntax'
  53         remote-file-path:
  54           type: string
  55           description: |-
  56             URI specifying the remote-file-path on O-DU/SMO or on stand-alone file server.
  57             The content shall conform to RFC3986 'Uniform Resource Identifier (URI): Generic Syntax'.
  58             When upload/download is via sftp, the format shall be of the form
  59             sftp://<username>@<host>[:port]/path
  60             When upload/download is via ftpes, the format shall be of the form
  61             ftpes://<username>@<host>[:port]/path
  62             Note, ftpes is not an IANA registered URI scheme, but used here to signal
  63             that a file transfer should be performed over FTPES
  64       title: o-ran-file-management:file-path-grouping
  65       description: |-
  66         Grouping, that provides local path and remote path for the
  67         purpose of File Management scenarios.
  68
  69     o-ran-file-management:output-status-grouping:
  70       type: object
  71       properties:
  72         status:
  73           type: string
  74           enum:
  75           - SUCCESS
  76           - FAILURE
  77           description: |-
  78             Operation status
  79         reject-reason:
  80           type: string
  81           description: |-
  82             The field is only needed when the value of the field 'status' is ual to 'FAILURE'.
  83       title: o-ran-file-management:output-status-grouping
  84       description: |-
  85         Status grouping
  86
  87     o-ran-file-management:file-download-event:
  88       type: object
  89       properties:
  90         o-ran-file-management:file-download-event:
  91           type: object
  92           allOf:
  93           - $ref: '#/components/schemas/o-ran-file-management:file-path-grouping'
  94           - $ref: '#/components/schemas/o-ran-file-management:output-status-grouping'
  95       title: o-ran-file-management:file-download-event
  96       description: |-
  97         An abstract object class for a file-download-event.
  98
  99     o-ran-file-management:file-upload-notification:
 100       type: object
 101       properties:
 102         o-ran-file-management:file-upload-notification:
 103           type: object
 104           allOf:
 105           - $ref: '#/components/schemas/o-ran-file-management:file-path-grouping'
 106           - $ref: '#/components/schemas/o-ran-file-management:output-status-grouping'
 107       title: o-ran-file-management:file-upload-notification
 108       description: |-
 109         An abstract object class for a file-upload-notification.
 110
 111     # Generic part to OFHM specific parts
 112     ofhm-event-stream:
 113       type: object
 114       properties:
 115         ietf:notification:
 116           type: object
 117           required:
 118           - eventTime
 119           properties:
 120             eventTime:
 121               type: string
 122               format: date-time
 123               description: |-
 124                 The time the event was generated by the event source. This
 125                 parameter is of type dateTime and compliant to [RFC3339].
 126                 Implementations must support time zones.
 127                 Reference: RFC3339, RFC5277, RFC8040
 128           oneOf:
 129             - $ref: '#/components/schemas/o-ran-file-management:file-download-event'
 130             - $ref: '#/components/schemas/o-ran-file-management:file-upload-notification'
 131       title: ofhm-event-stream
 132       description: |-
 133         This contains the set of asynchronous messages.
 134
 135     # Generic Part
 136     ofhm-event-stream_event-history:
 137       type: object
 138       properties:
 139         maximum-number-of-entries:
 140           description: |-
 141             The maximum number of item in the event list supported by
 142             the server.
 143           format: int32
 144           default: 255
 145           type: integer
 146         event:
 147           type: array
 148           items:
 149             $ref: '#/components/schemas/ofhm-event-stream'
 150           description: This contains the set of asynchronous messages.
 151       title: ofhm-event-stream_event-history
 152       description: |-
 153         The properties of the root container of an event log.
 154
 155     ofhm-event-stream-event-history-ref:
 156       type: object
 157       properties:
 158         event-history:
 159           $ref: '#/components/schemas/ofhm-event-stream_event-history'
 160       title: ofhm-event-stream-event-history-ref
 161       description: |-
 162         The root container of an event-history list.