search

gs1 / EPCIS

Draft files being shared for EPCIS 2.0 development
Other
20 stars 7 forks source link

updated GS1-CBV-Format header #327

Closed shalikasingh closed 3 years ago

shalikasingh commented 3 years ago

Hi @mgh128, @domguinard, @CraigRe

We have updated the GS1-CBV-Format header as per the current discussion and also have tweaked the enum for GS1-EPC-Format header by removing Client_Chooses and including No_Preference.

shalikasingh commented 3 years ago

Hi @mgh128 ,

As per the last GSMP call, I believe that, for EPCIS Documents in JSON-LD format, bare string will be the only format supported for any CBV attribute like bizStep which means GS1-CBV-Format header will no longer be required for query response(i.e., EPCIS Events) sent in JSON-LD format.

Note: currently JSON-LD supports URN values as well so it will need to be decided whether that’s allowed or not.

But GS1-CBV-Format will still be of the value for query response in either XML or pure JSON format.

So GS1-CBV-Format header is clearly not optional when it comes to XML / JSON format as CBV can be captured or returned either in URN or URL format. So is it possible that we continue to keep GS1-CBV-Header in the openapi.yaml with a note that this particular HTTP header will be of use only in XML/JSON format but not in JSON-LD documents.

Having this header will only increase flexibility (to have a choice of format in which the client expects the CBV values in response) in the query interface.

domguinard commented 3 years ago

As discussed in the call this needs to be further discussed offline. I'd like us to also think whether this is actually going to deliver value (vs the complexity it creates) or if we would not be better off leaving this to be handled by specific vendors.