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

Document general required features for SDK #4

Open
afrittoli opened this issue Sep 20, 2022 · 4 comments
Open

Document general required features for SDK #4

afrittoli opened this issue Sep 20, 2022 · 4 comments
Assignees
Labels
roadmap Items on the roadmap
Milestone

Comments

@afrittoli
Copy link
Contributor

From the CDEvent WG meeting on 06 Sept 2022, we discussed general features required by SDKs

  • Unit test coverage
  • Conformance tests (hosted in the spec/jsonschema?)
  • Pin the spec version in the SDK
@afrittoli afrittoli added the roadmap Items on the roadmap label Oct 6, 2022
@afrittoli afrittoli added this to the v0.2 milestone Dec 19, 2022
@afrittoli afrittoli self-assigned this Dec 19, 2022
@afrittoli
Copy link
Contributor Author

Related to #12

@e-backmark-ericsson
Copy link
Contributor

Should an SDK be able to create events for old versions of the protocol spec, or is it enough that it can only create events with the latest version? What versions of the spec should it be possible to interpret using the SDK on the consumer side?

@afrittoli
Copy link
Contributor Author

afrittoli commented Mar 13, 2023

  • Support different versions when consuming events

  • Do we need to be able to produce old versions of events?

    • Consumers should be able to ignore unknown events / unknown properties i.e. not crash when receiving an event they don't understand
  • We should try and parse "future" events as much as possible

  • Where parsing an event is not possible, we should try and signal this for DevOps engineer to find out where the parsing failed.

    • We might be able to use CloudEvent response to carry diagnostic info of this kind

@afrittoli afrittoli modified the milestones: v0.2, v0.3 Mar 13, 2023
@e-backmark-ericsson
Copy link
Contributor

This documentation could also document the general requirements on how to release the SDKs

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
Status: Todo
Development

No branches or pull requests

2 participants