Hi Calin
For R19, we are working on ensuring complete consistency between the specification (word/pdf) document and the swagger file, by having a single source generation for both assets. This was piloted in R18.5 for various APIs in the Service domain, and for R19 the scope includes Product and Product Order APIs.
Specifically for both note and channel, the relationship in R19 is 0..*.
Additionally, we introduced a new pattern for an incomplete resource, such as Product as part of a ProductOrder or Service as part of a ServiceOrder, the new resource is called BaseProductRefOrValue, and has less fields than the full Product resource, should be a strict subset.
Adding
@Ludovic Robert, the lead for Product and Product Order APIs.
Hope it helps.
------------------------------
Jonathan Goldberg
Amdocs Management Limited
------------------------------
Original Message:
Sent: May 09, 2019 04:00
From: Calin Mates
Subject: TMF622 - Product Ordering Management API: Product
Hi,
I am trying to expose product ordering functionality implemented in a commerce application via TMF APIs abd for that I decided to use product ordering API.
By reading the specifications of the API I have identified some issues that are unclear for me and I need your help to move forward with the API:
- 'Product sub-resource: Product reference. Configure the product relationships & characteristics (only configurable characteristics and necessary only if a non default value is selected) and/or identify the product that needs to be modified/deleted.' - I understand from here (and also by reading the specifications) that Product sub-resource should be used in case of all ordering scenarios: for ACQUISITION of a new tariff plan (such as subscribe to a new GSM plan) to provide the selected product characteristic values; for updates on an existing product it is used to provide the updates that has to take place on that product. What is unclear for me is: if you specify that Product sub-resource from here is a reference to a product then why there are differences between Product resource from this API and Product resource from TMF637 - Product Inventory Management API? Should this resource have a different name (maybe ProductOrderingRef) or is it ok to consider the Product resource from here is the same Product resource from the product inventory API? More than that it will help me to understand what were your considerations when you decided to use Product resource for providing data for a new ACQUISITION because in this case we don't have the Product yet.
- Inconsistencies between API definition and swagger json schema in terms of relation type between resources:
- ProductOrder -> Channel: in the PDF specification the relation is 1 -> * but in the swagger definition relatoin is 1 -> 1
- ProductOrder -> Note: in the PDF specification the relation is 1 -> * and in the swagger definition relatoin is 1 -> 1
Kind regards,
Calin Mates
Kind regards,
Calin Mates
------------------------------
Calin Mates
Aplication Architect
IBM Corporation
------------------------------