Open APIs


  • 1.  TMF620_Product_Catalog_Management_API_REST_Specification_R17.5.0-1

    TM Forum Member
    Posted Jul 19, 2019 06:41
    I have been referring to the document and have some queries listed below:

    1. In API specification we are using the field such as @type, @baseType, @SchmemaLocation, @referredType
      1. Should we be using @ as a naming convention for the json fields?
      2. Above mentioned fields are used to define the different class types, so is it advisable to use Class types or yml in response?
    2. href is used for referencing purpose so if a response contains the information from third service then should we use href to point to that url?
      1. Like: ProductCatalog has relatedParty fields which is coming for party service in this case should we have the href for partyManagement APIs. (ref: Json representation sample: page 12 )

    Please suggest and help to solve above queries.

    Gaurav Sharma
    Tech Mahindra Limited