magento / catalog-storefront

Open Software License 3.0
7 stars 18 forks source link

Create document about deprecation policy #236

Closed mslabko closed 4 years ago

mslabko commented 4 years ago

describe strategy how to work with deprecated fields (see https://github.com/magento/catalog-storefront/issues/219)

document should be published on Wiki

Updated: Add agreements regarding poblem: What’re options do we have to solve problem “field X is not deprecated in GQL, but X field is not present in Storefront API” We have only 3 options here:

  1. analyze use-cases with PWA/ECE and 1.1. if no real use-cases: deprecate field in GQL with prosing another approach 1.2 if have real use-case: add X field to Storefront API
  2. treat X field as “deprecated” and do proxy on Monolith
  3. add X field to Storefront API Due to we do consider SF API as independent API which should reflect Storefront needs and not blindly copy existing GQL schema I believe we should follow only 1st option and analyze GQL fields that we don’t want to have on Storefront API and deprecate/add them only after analyzing existing use-cases

we agreed with: remove fields from Storefront API that we don’t want to have Go with 1st option later and add field to SF or deprecate from GQL after analyze

m2-assistant[bot] commented 4 years ago

Hi @mslabko. Thank you for your report. To help us process this issue please make sure that you provided sufficient information.

Please, add a comment to assign the issue: @magento I am working on this


mslabko commented 4 years ago

Please, review: https://github.com/magento/catalog-storefront/wiki/%5BGraphQL%5D-Deprecation-policy