Open APIs

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?

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);
}

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?

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?

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);
}

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?

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?

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);
}

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?

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

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?

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);
}

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?