Open APIs

Expand all | Collapse all

TMF632: Error in TMF632-Party-v4.0.0.swagger.json for Individual - status

  • 1.  TMF632: Error in TMF632-Party-v4.0.0.swagger.json for Individual - status

    TM Forum Member
    Posted 7 days ago
    Edited by Paul Tap 6 days ago
    Hi all,

    first post, so I hope this is appropriate with respect to location and topic.

    I analyzed the TMF632-Party-v4.0.0.swagger.json file and I noticed that the "status" property for "Individual is:
    "status": {
    "$ref": "#/definitions/IndividualStateType",
    "description": "Status of the individual"
    },
    ,where I would expect:
    "status": {
    "type": "array",
    "items": {
    "$ref": "#/definitions/IndividualStateType",
    }
    },
    I can see that in previous versions, "status" did not have a $ref, just 3 predefined values, so this may have been missed in the change, but probably I do miss something.

    Regards,

    Paul Tap

    ------------------------------
    Paul Tap
    WeCity
    ------------------------------


  • 2.  RE: TMF632: Error in TMF632-Party-v4.0.0.swagger.json for Individual - status

    TM Forum Member
    Posted 6 days ago
    Hi Paul
    You have come to the right place, and your question is perfectly appropriate.

    During our work on Open API v4, we have been firming up the definition of state/status attributes, giving them fixed values using the JSON Schema enum construct. The definition of IndividualStateType that appears in the swagger means that the status of the individual can take only one of the three fixed values of IndividualStateType.
    The status itself cannot be array, since only one value makes sense at any given stage in the entity lifecycle.

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



  • 3.  RE: TMF632: Error in TMF632-Party-v4.0.0.swagger.json for Individual - status

    TM Forum Member
    Posted 6 days ago
    Hi Jonathan, is there any plan to expand the lists of statuses? At present, there's only Initialised, Validated and Deceased. I'd quite like to add one or two.
    For starters, 'Merged' where we've started with the creation of 2 Individuals taken from legacy systems and merged them to create one master. One record will remain current and the other will need to be retained but not used.

    Does TMF632 have an official 'owner' within the project?

    Cheers, Jeff

    ------------------------------
    Jeff Barker
    BT Group plc
    ------------------------------



  • 4.  RE: TMF632: Error in TMF632-Party-v4.0.0.swagger.json for Individual - status

    TM Forum Member
    Posted 6 days ago
    Hi Jonathan,

    thanks for your quick response. Your answer is perfectly clear and logical. For me it means I have to revisit my code for flattening the JSON and pushing into a CSV.

    I'm working on a translation from the TMF schema/API to CMDBuild (and thus postgreSQL RDBMS). From the CSV I should be able to generate the schema in the database plus all relations (either via a SQL script of (preferably) the REST aPI of CMDBuild. Idea is to stay as close as possible to the TMForum definitions, thus automatically generating the TMF APIs from CMDBuild.

    Regards,

    Paul Tap

    ------------------------------
    Paul Tap
    WeCity
    ------------------------------