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

(GH-642) Ensure camelCase for items in dsc_lib #648

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

michaeltlombardi
Copy link
Collaborator

@michaeltlombardi michaeltlombardi commented Feb 18, 2025

PR Summary

This change updates the definitions to rename the fields and values to use camelCase when serializing and deserializing, which also updates their JSON Schema.

TODO:

  • Update canonical schemas in repository
  • Add tests to generically verify serialized data types use camelCase (optional)
  • Update reference documentation

PR Context

Prior to this change, the structs and enums in dsc_lib didn't consistently use camelCase - most property names and enum values use camelCase, but not all - and this inconsistency isn't predictable for end users, who need to consult the JSON Schemas to be sure.

Fix #642

@SteveL-MSFT SteveL-MSFT added this to the 3.0-Approved milestone Feb 18, 2025
Prior to this change, the structs and enums in `dsc_lib` didn't consistently
use camelCase - most property names and enum values use camelCase, but not
all - and this inconsistency isn't predictable for end users, who need to
consult the JSON Schemas to be sure.

This change updates the definitions to rename the fields and values when
serializing and deserializing, which also updates their JSON Schema.

A future change is required to update the canonical schemas in the
repository to match these updates.
@michaeltlombardi michaeltlombardi force-pushed the gh-642/main/schema-casing-canonicalization branch from 39f84b7 to 22c034b Compare February 18, 2025 22:29
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

Successfully merging this pull request may close these issues.

Breaking Change: Standardize casing for property names and enumerated values in JSON
2 participants