Open APIs

Expand all | Collapse all

TMF652 - Why does it have 2x ResourceSpecificationRefs

  • 1.  TMF652 - Why does it have 2x ResourceSpecificationRefs

    TM Forum Member
    Posted May 11, 2021 09:33

    Hi Community,

    I noticed today, while taking a first look into the TMF652, that the resource model defines the usage of a ResourceSpecificationRef two times and I don't get the usecase for this. Can someone explain to me the difference and when to use which attribute?

    Here is a small example for a ResourceOrder as far as my current understanding goes:

    {
      "id": 42,
      "@type": "ResourceOrder",
      "orderItem": [
        {
          "id": "1",
          "resourceSpecification": {},
          "resource": {
            "resourceSpecification": {}
          }
        }
      ]
    }


    When to use orderItem.resource.resourceSpecification and when orderItem.resourceSpecification?

    Thanks - any hints are much appreciated.

    Jan



    ------------------------------
    Jan Lemmermann
    OSS Lead Architect
    EWE TEL GmbH
    ------------------------------


  • 2.  RE: TMF652 - Why does it have 2x ResourceSpecificationRefs

    TM Forum Member
    Posted May 11, 2021 10:02
    Hi Jan
    I don't know how it is in the published Swagger, but in the schema for ResourceOrderItem in our working area, the reference to resource spec looks like this:
    "resourceSpecification": {
    "$comment": "Deprecated: Can be accessed from the resource",
    "$ref": "ResourceSpecificationRef.schema.json#/definitions/ResourceSpecificationRef"
    },
    From which I conclude that you should not be using this attribute, instead use the reference from the Resource instance embedded within the item.
    I imagine it will disappear if and when the API is re-released in V5.
    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: TMF652 - Why does it have 2x ResourceSpecificationRefs

    TM Forum Member
    Posted May 11, 2021 10:13
    That helped a lot, Jonathan. Thanks a lot :-)

    ------------------------------
    Jan Lemmermann
    OSS Lead Architect
    EWE TEL GmbH
    ------------------------------