Support of WG4 OpenFronthaul Management-Plane VES
[oam.git] / solution / smo / oam / ves-collector / externalRepo / o-ran-sc / 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-supervision.yang
38     o-ran-supervision:supervision-notification:
39       type: object
40       properties:
41         session-id:
42           type: integer
43           format: int32
44           minimum: 1
45           maximum: 4294967295
46           description: |-
47             This value uniquely identifies the NETCONF session in an O-RU. The value is conveyed to NETCONF client in hello message.
48             the session-id for the netconf session is sent as part of each supervision-notification notification.
49             and may be used for create-subscription to filter the relevant
50             notifications
51
52       title: o-ran-supervision:supervision-notification
53       description: |-
54         Notification to indicate that NETCONF management interface is up.
55
56     # notifications for o-ran-file-management.yang
57     o-ran-file-management:file-path-grouping:
58       type: object
59       required:
60       - local-logical-file-path
61       - remote-file-path
62       properties:
63         local-logical-file-path:
64           type: string
65           description: |-
66             URI specifying the complete logical path relative to the root of the logical file system
67             structure (the common root for o-ran/log, o-ran/pm, o-ran/transceiver or o-ran/beamforming) of the file
68             to upload/download (no wildcard is allowed), including a file name and its extension.
69             Example: 'o-ran/log/file_1.abc', where 'o-ran/log/' represents relative path to folder containing log files
70             as specified by O-RAN, 'file_1' represents desired filename and 'abc' represents desired filename's extension.
71             The content shall conform to RFC3986 'Uniform Resource Identifier (URI): Generic Syntax'
72         remote-file-path:
73           type: string
74           description: |-
75             URI specifying the remote-file-path on O-DU/SMO or on stand-alone file server.
76             The content shall conform to RFC3986 'Uniform Resource Identifier (URI): Generic Syntax'.
77             When upload/download is via sftp, the format shall be of the form
78             sftp://<username>@<host>[:port]/path
79             When upload/download is via ftpes, the format shall be of the form
80             ftpes://<username>@<host>[:port]/path
81             Note, ftpes is not an IANA registered URI scheme, but used here to signal
82             that a file transfer should be performed over FTPES
83       title: o-ran-file-management:file-path-grouping
84       description: |-
85         Grouping, that provides local path and remote path for the
86         purpose of File Management scenarios.
87
88     o-ran-file-management:output-status-grouping:
89       type: object
90       properties:
91         status:
92           type: string
93           enum: 
94           - SUCCESS 
95           - FAILURE
96           description: |-
97             Operation status
98         reject-reason:
99           type: string
100           description: |-
101             The field is only needed when the value of the field 'status' is ual to 'FAILURE'.
102       title: o-ran-file-management:output-status-grouping
103       description: |-
104         Status grouping
105
106     o-ran-file-management:file-download-event:
107       type: object
108       properties:
109         o-ran-file-management:file-download-event:
110           type: object
111           allOf:
112           - $ref: '#/components/schemas/o-ran-file-management:file-path-grouping'
113           - $ref: '#/components/schemas/o-ran-file-management:output-status-grouping'
114       title: o-ran-file-management:file-download-event
115       description: |-
116         An abstract object class for a file-download-event.
117
118     o-ran-file-management:file-upload-notification:
119       type: object
120       properties:
121         o-ran-file-management:file-upload-notification:
122           type: object
123           allOf:
124           - $ref: '#/components/schemas/o-ran-file-management:file-path-grouping'
125           - $ref: '#/components/schemas/o-ran-file-management:output-status-grouping'
126       title: o-ran-file-management:file-upload-notification
127       description: |-
128         An abstract object class for a file-upload-notification.
129
130     # Generic part to OFHM specific parts
131     ofhm-event-stream:
132       type: object
133       properties:
134         ietf:notification:
135           type: object
136           required:
137           - eventTime
138           properties:
139             eventTime:
140               type: string
141               format: date-time
142               description: |-
143                 The time the event was generated by the event source. This
144                 parameter is of type dateTime and compliant to [RFC3339].
145                 Implementations must support time zones.
146                 Reference: RFC3339, RFC5277, RFC8040
147           anyOf:
148           - $ref: '#/components/schemas/o-ran-supervision:supervision-notification'
149           - $ref: '#/components/schemas/o-ran-file-management:file-download-event'
150           - $ref: '#/components/schemas/o-ran-file-management:file-upload-notification'
151       title: ofhm-event-stream
152       description: |-
153         This contains the set of asynchronous messages.
154
155     # Generic Part
156     ofhm-event-stream_event-history:
157       type: object
158       properties:
159         maximum-number-of-entries:
160           description: |-
161             The maximum number of item in the event list supported by
162             the server.
163           format: int32
164           default: 255
165           type: integer
166         event:
167           type: array
168           items:
169             $ref: '#/components/schemas/ofhm-event-stream'
170           description: This contains the set of asynchronous messages.
171       title: ofhm-event-stream_event-history
172       description: |-
173         The properties of the root container of an event log.
174
175     ofhm-event-stream-event-history-ref:
176       type: object
177       properties:
178         event-history:
179           $ref: '#/components/schemas/ofhm-event-stream_event-history'
180       title: ofhm-event-stream-event-history-ref
181       description: |-
182         The root container of an event-history list.