Open APIs

Hello, 

We are using open api's in a checkout scenario and we are faced with a problem that we were not expecting and we hope someone can help us with.

Before creating the order, we have the structure of our cart using Shopping Cart API where we have defined the relationship between cart items using cartItemRelationship, defining the type as best suited us since the field type of cartItemRelationship is a string. 
When creating the order, and passing the same structure to Product Ordering API, we noticed that the field type on orderItemRelationship is a enum field and we need more than the available values.

Can we extend the values available for that field and still be Open API compliant? or remove the enum from the field?
Is that applicable for all relationship types in all open api's?

Thank you so much for your help.

Best Regards,

------------------------------
Joana Lopes da Fonseca
Celfocus
------------------------------

I suggest you seek guidance from @Ludovic Robert, the lead for Product Order API, and @Jacob Avraham, the lead​​​​​ for Trouble Ticket API.
Hope it helps

------------------------------
Jonathan Goldberg
Amdocs Management Limited
------------------------------

Original Message:
Sent: Feb 28, 2019 04:05
From: Joana Lopes da Fonseca
Subject: TMF622 - Product Ordering - OrderItemRelationship

Hello,

We are using open api's in a checkout scenario and we are faced with a problem that we were not expecting and we hope someone can help us with.

Before creating the order, we have the structure of our cart using Shopping Cart API where we have defined the relationship between cart items using cartItemRelationship, defining the type as best suited us since the field type of cartItemRelationship is a string.
When creating the order, and passing the same structure to Product Ordering API, we noticed that the field type on orderItemRelationship is a enum field and we need more than the available values.

Can we extend the values available for that field and still be Open API compliant? or remove the enum from the field?
Is that applicable for all relationship types in all open api's?

Thank you so much for your help.

Best Regards,

------------------------------
Joana Lopes da Fonseca
Celfocus
------------------------------

Hello Joana, Jonathan, Jacob,

Look like we got a consistent issue there. Thanks for the sharing Joana.

My first feeling is that we should not 'enforce' enum values for relation type in the productOrder API. The right pattern should be the one in the shopping cart.

My proposal is to raise a Jira -  in order to get other TMF API program stakeholders feedbacks - my preference will be be to remove the enum (replace by string) in next release (We pla to deliver a new version for the release 19.0).

Best regards

Ludovic

------------------------------
Ludovic Robert
Orange
------------------------------

Original Message:
Sent: Feb 28, 2019 04:05
From: Joana Lopes da Fonseca
Subject: TMF622 - Product Ordering - OrderItemRelationship

Hello,

We are using open api's in a checkout scenario and we are faced with a problem that we were not expecting and we hope someone can help us with.

Before creating the order, we have the structure of our cart using Shopping Cart API where we have defined the relationship between cart items using cartItemRelationship, defining the type as best suited us since the field type of cartItemRelationship is a string.
When creating the order, and passing the same structure to Product Ordering API, we noticed that the field type on orderItemRelationship is a enum field and we need more than the available values.

Can we extend the values available for that field and still be Open API compliant? or remove the enum from the field?
Is that applicable for all relationship types in all open api's?

Thank you so much for your help.

Best Regards,

------------------------------
Joana Lopes da Fonseca
Celfocus
------------------------------

Hello Jonathan and Ludovic, 

Thank you so much for your help.
I believe that each implementation using open api's will need different values and it makes sense to me that this field is not constrained.

Unfortunately I'm not able to raise a jira on this subject. I checked with some colleagues to see if any of them were able to do it but no one has privileges to do it.
Do you know if there is another way to report it?

Thank you.
Best Regards,

------------------------------
Joana Lopes da Fonseca
Celfocus
------------------------------

Original Message:
Sent: Mar 01, 2019 05:40
From: Ludovic Robert
Subject: TMF622 - Product Ordering - OrderItemRelationship

Hello Joana, Jonathan, Jacob,

Look like we got a consistent issue there. Thanks for the sharing Joana.

My first feeling is that we should not 'enforce' enum values for relation type in the productOrder API. The right pattern should be the one in the shopping cart.

My proposal is to raise a Jira -  in order to get other TMF API program stakeholders feedbacks - my preference will be be to remove the enum (replace by string) in next release (We pla to deliver a new version for the release 19.0).

Best regards

Ludovic

------------------------------
Ludovic Robert
Orange

Original Message:
Sent: Feb 28, 2019 04:05
From: Joana Lopes da Fonseca
Subject: TMF622 - Product Ordering - OrderItemRelationship

Hello,

We are using open api's in a checkout scenario and we are faced with a problem that we were not expecting and we hope someone can help us with.

Before creating the order, we have the structure of our cart using Shopping Cart API where we have defined the relationship between cart items using cartItemRelationship, defining the type as best suited us since the field type of cartItemRelationship is a string.
When creating the order, and passing the same structure to Product Ordering API, we noticed that the field type on orderItemRelationship is a enum field and we need more than the available values.

Can we extend the values available for that field and still be Open API compliant? or remove the enum from the field?
Is that applicable for all relationship types in all open api's?

Thank you so much for your help.

Best Regards,

------------------------------
Joana Lopes da Fonseca
Celfocus
------------------------------

Hi Joana

I raised the Jira ;)
Discussion will be in TMF API project team architecture/pattern meeting (or has occured yesterday....I missed the call). I hope we'll have a quickly a resolution on this point.

Ludovic

------------------------------
Ludovic Robert
Orange
------------------------------

Original Message:
Sent: Mar 08, 2019 03:55
From: Joana Lopes da Fonseca
Subject: TMF622 - Product Ordering - OrderItemRelationship

Hello Jonathan and Ludovic,

Thank you so much for your help.
I believe that each implementation using open api's will need different values and it makes sense to me that this field is not constrained.

Unfortunately I'm not able to raise a jira on this subject. I checked with some colleagues to see if any of them were able to do it but no one has privileges to do it.
Do you know if there is another way to report it?

Thank you.
Best Regards,

------------------------------
Joana Lopes da Fonseca
Celfocus

Original Message:
Sent: Mar 01, 2019 05:40
From: Ludovic Robert
Subject: TMF622 - Product Ordering - OrderItemRelationship

Hello Joana, Jonathan, Jacob,

Look like we got a consistent issue there. Thanks for the sharing Joana.

My first feeling is that we should not 'enforce' enum values for relation type in the productOrder API. The right pattern should be the one in the shopping cart.

My proposal is to raise a Jira -  in order to get other TMF API program stakeholders feedbacks - my preference will be be to remove the enum (replace by string) in next release (We pla to deliver a new version for the release 19.0).

Best regards

Ludovic

------------------------------
Ludovic Robert
Orange

Original Message:
Sent: Feb 28, 2019 04:05
From: Joana Lopes da Fonseca
Subject: TMF622 - Product Ordering - OrderItemRelationship

Hello,

We are using open api's in a checkout scenario and we are faced with a problem that we were not expecting and we hope someone can help us with.

Before creating the order, we have the structure of our cart using Shopping Cart API where we have defined the relationship between cart items using cartItemRelationship, defining the type as best suited us since the field type of cartItemRelationship is a string.
When creating the order, and passing the same structure to Product Ordering API, we noticed that the field type on orderItemRelationship is a enum field and we need more than the available values.

Can we extend the values available for that field and still be Open API compliant? or remove the enum from the field?
Is that applicable for all relationship types in all open api's?

Thank you so much for your help.

Best Regards,

------------------------------
Joana Lopes da Fonseca
Celfocus
------------------------------