papinet / papiNet-API

papiNet is a global paper, forest products and bioproducts industry e-Business initiative.
http://www.papinet.org/
Apache License 2.0
9 stars 3 forks source link

sellerProduct: in ver. 3.0.0 #107

Closed larsolofsson closed 5 months ago

larsolofsson commented 6 months ago

sellerProduct:

  1. brandName:, gradeCode: and gradeCodeName are assigned by the supplier/seller. The customer can use a sellerproduct with these properties when ordering paper. So these properties are never assigned by the customer for a sellerProduct. So the assignedBy construct can be removed.

  2. A sellerProduct can be fully-specified or not fully-specified. The identifier used for a not fully-specified sellerProduct is gradeCode in papiNet xml. The identifier used for a fully-specified sellerProduct is partNumber in papiNet xml. I propose when having gradeCode that property partNumber: should be added. Property gradeCodename could be renamed to sellerProductName or productName, A choice could be added between gradeCode and partNumber (OneOf)

The customer can specify an customerArticle that can be can be fully-specified or not fully-specified. Properties brandName:, gradeCode: and partNumber: can also be used for a customerArticle. Property customerArticleName: or articleName: could be used for an customerArticle.

larsolofsson commented 6 months ago

Decisions on 2023-12-20 Current business cases for version 3.0.0 are without uuid and master data. Our decision is to currently remove the uuid from products, parties, locations and customerArticles. Property partNumber should be added to sellerProduct and customerArticle. gradeCodeName should be changed to productName.

patricekrakow commented 6 months ago

I think we need to (re)discuss the consequences of removing the (uu)id of parties and locations. How would we then present the links with the following (existing) API endpoints:

Unless we remove these API endpoints from the version 3.0.0.

patricekrakow commented 6 months ago

@bengtwentus will prepare some proposals to be discussed...

patricekrakow commented 6 months ago

Let's summarize the needed changes for sellerProduct and customerArticleReference:

patricekrakow commented 6 months ago

When I will be ready with the commit, I will probably create a new issue to discuss further the overall usage of UUIDs so we can close this issue with the commit containing all the changes we agreed on!

patricekrakow commented 5 months ago

Changes done in commit 46c2cf1.

I will propose a JSON schema to:

within a the new issue #123 so we can already close this issue.

patricekrakow commented 5 months ago

The minLength: 1 is missing with the type: string and the constraint must be explained in English prose within the description.

patricekrakow commented 5 months ago

The constraint minLength: 1 has been added, see commit 38cbcd5. Regarding the constraint, we will follow that up within issue #123.