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

Changes snake cased fields to camel casing #206

Merged
merged 1 commit into from
May 15, 2024

Conversation

xibz
Copy link
Contributor

@xibz xibz commented Apr 16, 2024

This commit improves consistency in our spec and examples by having all keys be camel cased.

This made 4 changes:
chain_id -> chainId
context_id -> contextId
link_kind -> linkKind
link_type -> linkType

@xibz xibz requested a review from a team as a code owner April 16, 2024 17:59
@xibz
Copy link
Contributor Author

xibz commented Apr 16, 2024

tied to #205

@xibz
Copy link
Contributor Author

xibz commented Apr 16, 2024

fixes #204

@xibz xibz added the breaking change Indicates when a PR or issue will have breaking changes label Apr 16, 2024
@e-backmark-ericsson e-backmark-ericsson modified the milestone: v0.5 Apr 22, 2024
@afrittoli
Copy link
Contributor

@xibz do you consider this a bug that we should fix in a 0.4.1 or shall we wait for 0.5.0?
Since 0.4.0 has just been released and we're still updating the SDKs, perhaps we should fix this already in a 0.4.x.

@xibz
Copy link
Contributor Author

xibz commented May 8, 2024

@afrittoli my thinking was we could fix it now since the sdks haven't been updated yet

@afrittoli
Copy link
Contributor

@afrittoli my thinking was we could fix it now since the sdks haven't been updated yet

OK, it sounds good - however, to fix this on the 0.4 version, you'll need a new PR to the spec-v0.4 branch.
This PR is also fine, we'll need it to replicate the change in the 0.5 version.

Since this PR changes all event definitions, it will have to include an update to all events (and corresponding examples) patch versions.

Since all references to the link schemas have been updated, we need
to bump all event versions too.

This as usual is automated:

ls examples | while read aa; do sp="$(echo ${aa%.*} | tr "_" ".")"; ./tools/event-version.sh -u $sp -s; done

Signed-off-by: Andrea Frittoli <[email protected]>
Signed-off-by: xibz <[email protected]>
@xibz xibz force-pushed the fix-camel-casing branch from 077580c to cca8ddb Compare May 14, 2024 15:49
Copy link
Contributor

@afrittoli afrittoli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@afrittoli afrittoli merged commit c1a465d into cdevents:main May 15, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Indicates when a PR or issue will have breaking changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants