Tidy DTO naming, suppressions, and gitignore#329
Draft
danielabbatt wants to merge 3 commits intomainfrom
Draft
Conversation
Eleven public DTO properties were written in camelCase, bypassing the project's convention of PascalCase C# names with [DataMember(Name = "...")] attributes preserving the wire format. An assembly-wide IDE1006 suppression was masking them. Renamed the properties, wire names unchanged via existing DataMember attributes, and removed the blanket suppression. This is a source-breaking change for consumers that read the old names (e.g. obj.networkId -> obj.NetworkId).
- Remove redundant CA1848 suppression scoped to Meraki.Api.Data; the broader Meraki.Api-scoped suppression already covers it via namespaceanddescendants. This also removes a stale "TODO - remove this suppression" justification. - Delete two commented-out properties in SecureConnectDeploymentsSection that had no rationale; git history keeps them if they're ever needed. - Add a "DTO property naming" section to CONTRIBUTING.md documenting PascalCase C# names with [DataMember(Name = "camelCase")] attributes. - Fix a "deserilize" typo in the CA1056 suppression justification.
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
| Duplication | 0 |
AI Reviewer: run a review on demand. To trigger the first review automatically, go to your organization or repository integration settings. AI can make mistakes. Always validate suggestions.
TIP This summary will be updated as you push new changes. Give us feedback
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Best-practice cleanup pass across the library — no functional / wire-format changes.
[DataMember(Name = "...")]convention and were hidden by an assembly-wide IDE1006 suppression. Wire format is unchanged via the existing DataMember attributes; the suppression is now removed so future stragglers fail the build.CA1848suppression scoped toMeraki.Api.Data— the broaderMeraki.Apisuppression already covers it vianamespaceanddescendants. Also drops a stale"TODO - remove this suppression"justification.SecureConnectDeploymentsSection.csthat had no rationale.CONTRIBUTING.mdso the convention is explicit..claude/settings.local.jsonin.gitignore."deserilize"typo in a suppression justification.Breaking changes
Source-breaking for downstream consumers reading the renamed properties by their old camelCase names. JSON (de)serialization is unchanged.
AuthorizationauthorizedByEmail→AuthorizedByEmailCameraCustomAnalyticsParametersvalue→ValueClientOverviewusage→UsageClientPolicyPolicyBySsidgroupPolicyId→GroupPolicyIdLinkLayerNodeDiscoveredLldpmanagementAddress→ManagementAddressMerakiVpnPeersnetworkId→NetworkIdNetworkCellularGatewayEsimsInventoryItemlastUpdatedAt→LastUpdatedAtOrganizationAssuranceAlertsOverviewHistoricalItemByAlertTypetype→TypeSecureConnectDestinationListmodifiedAt→ModifiedAtSecureConnectTunnelClientAuthenticationParametersmodifiedAt→ModifiedAtVpnStatsnetworkId→NetworkIdWorth a CHANGELOG note and a minor-version bump.
Test plan
dotnet build Meraki.Api/Meraki.Api.csproj -c Release— 0 warnings, 0 errors acrossnetstandard2.0,net9.0,net10.0.