Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecating fields in CDEvents #165

Open
afrittoli opened this issue Oct 30, 2023 · 0 comments
Open

Deprecating fields in CDEvents #165

afrittoli opened this issue Oct 30, 2023 · 0 comments
Labels
roadmap Items on the roadmap

Comments

@afrittoli
Copy link
Contributor

afrittoli commented Oct 30, 2023

We would like to identify and document the process for deprecating fields in CDEvents.

We discussed this during a working group and identified the following options:

  1. Document in the markdown, and define an ETA for removal
  2. Keep the deprecated fields forever
  3. Just update the version and drop the field

Related PR: PR not urgent, good to use to define the deprecation process

The general agreement was for option (1).
JSONSChema allows for deprecations and so we could generate the markdown for deprecations automatically.

@afrittoli afrittoli added this to the v0.4 milestone Mar 4, 2024
@e-backmark-ericsson e-backmark-ericsson modified the milestones: v0.4, v0.5 Apr 2, 2024
@afrittoli afrittoli added the roadmap Items on the roadmap label Jul 22, 2024
@afrittoli afrittoli removed this from the v0.5 milestone Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
roadmap Items on the roadmap
Projects
None yet
Development

No branches or pull requests

2 participants