ptp-notification-armada-app/api-ref/source
Andre Mauricio Zelak 6305a1a70d Use all-caps state in O-RAN timing notification
All synchronization states of LOCKED, HOLDOVER, and FREERUN need to be
all-caps in the state change event notifications. This is a requirement
of O-Cloud Notification API Specification for Event Consumers -
O-RAN.WG6.O-Cloud Notification API-v03.00.

Changed the JSON message body of the Sync OS clock, Sync Sync State,
GNSS sync status and Sync PTP Lock State to ensure all caps.

Updated ptp-notification V2 documentation to reflect the notification
message changes.

Test Plan:
PASS: Build container image
PASS: Manually deploy image and test with v2 client
PASS: Clycled through states
PASS: Restarted ptp-notification application and v2 client
received the events after starting the PTP notification pods.
PASS: ptp-tracking unit tests

Closes-bug: 2006941

Signed-off-by: Andre Mauricio Zelak <andre.zelak@windriver.com>
Change-Id: I351242504eb0dc79c0b17908609b8a8482f9cad6
2023-02-10 14:55:46 -03:00
..
api_ptp_notifications_definition_v1.rst Fix endpoint for pulling PTP current state 2022-04-25 14:08:19 -03:00
api_ptp_notifications_definition_v2.rst Use all-caps state in O-RAN timing notification 2023-02-10 14:55:46 -03:00
conf.py Add PTP Notification API definitions spec 2021-03-09 16:37:12 -05:00
index.rst Update REST API doc for PTP notification v2 2022-09-13 11:09:36 -04:00