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

Support the ability to promote extensions to core without breaking changes #1217

Open
alanisaac opened this issue Oct 22, 2024 · 0 comments
Open

Comments

@alanisaac
Copy link
Contributor

alanisaac commented Oct 22, 2024

Background

Extensions have some great characteristics for prototyping new OCSF schema:

  • They allow for individuals to iterate on schemas without needing consensus from OCSF maintainers on code reviews to include them in the core schema.
  • They are consumable by end-users, which allows schema designers to solicit feedback on the utility of the schema.

However, it is not possible to cleanly "promote" extensions to core. The UIDs for categories, classes, etc. change between extension schemas and core schemas, which constitutes a breaking change.

Example

This was noted on the 2024-10-22 working group call: extensions could be a way to prototype and iterate on an "IoT" category before inclusion into the schema, but it would be challenging to migrate that category to OCSF core.

Proposal

This issue proposes that we try to either:

  • create a path for extensions to become a part of OCSF core without breaking changes
  • support an alternative path for iteration with similar characteristics
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant