Open APIs

 View Only

  • 1.  Notification Payload - fieldPath

    Posted Apr 03, 2024 19:48

    Team TMF,

    I'm working on a Rust TMF library and working my way through the common elements. When looking at the common notification payload, there's a field called fieldPath which presumably can contain information for AttributeChange style notifications on what has changed.

    Problem is there's almost no documentation on what is expected within this field. 

    Is it fair to say a JSON path should be put here indicating which field within the payload has changed?

    Can we place several comma separated paths in this field if more than one field has changed per event, or should each field have its own event?



    ------------------------------
    Ryan Ruckley
    Principal Architect
    SingTel Optus
    ------------------------------


  • 2.  RE: Notification Payload - fieldPath

    Posted Apr 03, 2024 19:50

    For reference, I'm allowing the caller (i.e. triggering code) to set an arbitrary string to indicate a path:

    //! Create Event Example

    use tmflib::common::event::EventPayload;
    use tmflib::tmf674::geographic_site_v4::{GeographicSite,GeographicSiteEventType};

    fn main() {

        let mut site = GeographicSite::new("Chatswood Branch");

        site.status = Some("Active".into());

        let event = site.to_event(GeographicSiteEventType::GeographicSiteStatusChangeEvent)
            .path("status");

        dbg!(event);
    }



    ------------------------------
    Ryan Ruckley
    Principal Architect
    SingTel Optus
    ------------------------------



  • 3.  RE: Notification Payload - fieldPath

    Posted Apr 04, 2024 04:09

    Hi Ryan

    Please clarify - is your query about the event patterns in TMF Open APIs in general, or specifically about this Rust library implementation. If the latter, what is the provenance of this library? Is it an official TMF published asset?



    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------

    Original Message


  • 4.  RE: Notification Payload - fieldPath

    Posted Apr 07, 2024 18:16

    Jonathon,

    This is about TMF Open APIs in general. I'm writing the Rust library for my own amusement to write TMF capable micro-services.



    ------------------------------
    Ryan Ruckley
    Principal Architect
    SingTel Optus
    ------------------------------

    Original Message


  • 5.  RE: Notification Payload - fieldPath

    Posted Apr 07, 2024 22:00

    For reference: https://github.com/rruckley/tmflib



    ------------------------------
    Ryan Ruckley
    Principal Architect
    SingTel Optus
    ------------------------------

    Original Message


  • 6.  RE: Notification Payload - fieldPath

    Posted Apr 08, 2024 14:38

    I searched the v5 schemas, and I think this may be an outlier. I didn't find fieldPath anywhere except in some ServiceUsage notifications - and I'm not sure that ServiceUsage was released yet as a v5 API.

    I also searched the v4 schemas, and here also I couldn't find widespread use of fieldPath.



    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------

    Original Message


Related Content