Open APIs

 View Only
Back to discussions
Expand all | Collapse all

Inconsistency between state/status/lifeCycleStatus (lifecycle fields) of entities

  • 1.  Inconsistency between state/status/lifeCycleStatus (lifecycle fields) of entities

    Posted Oct 05, 2022 16:11
    Edited by Mustafa Yusufoglu Oct 05, 2022 16:34
    Hi All,

    Lifecycle statuses are sometimes defined as state, sometimes as status or lifecycleStatus. There is no standard definition. I see that among different resources, I tried to give examples below.

    Examples:
    • Product Order resource
    Field: "state: A product order state type (ProductOrderStateType). Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on."
    Event: ProductOrderStateChangeEvent

    • Billing Account resource
    Field: "state: A string. Contains the lifecycle state such as: Active, Closed, Suspended and so on."
    Event: BillingAccountStateChangeEvent

    • PartyRole resource
    Field:"status:  A string. Used to track the lifecycle status of the party role."
    Event: PartyRoleStateChangeEvent

    • Product Offering Resource
    Field:"lifecycleStatus:  A string. Used to indicate the current lifecycle status."
    Event: ProductOfferingStateChangeEvent

    Lifecycle status is a much more important field than other fields. It is important for the success of CTKs. Moreover, when there is a change, the status update event is generated unlike other fields.
    I would always expect "status" to be used for lifecycle status. This seems to be an inconsistency from my point of view. Because, there isn't a common definition and different terminology is used for same field per Resource. Can I have your comments on this?

    ------------------------------
    Mustafa Yusufoglu
    i2i Systems
    ------------------------------


  • 2.  RE: Inconsistency between state/status/lifeCycleStatus (lifecycle fields) of entities

    Posted Oct 06, 2022 02:32
    Hi Mustafa
    The Open API team is aware of this inconsistency, there's even a JIRA open for it. Unfortunately, I don't think it will be fixed soon (or at all), the fix would be a big compatibility break.
    Status change events are generated as part of the API definition (swagger/oas file, user guide) if the API designer specifies it. Nothing to do with the name of the attribute.
    Hope it helps.

    ------------------------------
    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