You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
fix: correct response shapes and member names that could never bind - #416
Rebased onto main on 2026-09-29 (main builds as 1.70.147). Merges as 1.74.6.
Before merging, retarget the base to main. Base branches are not auto-deleted in this repo, so GitHub will not retarget for you, and merging into the old base leaves the work off main (what happened to #413). Merge only after #415 is on main, with a merge commit; do not squash, rebase or click Update branch.
Base is chore/update-to-latest-meraki-api. Merge #415 first, then retarget this to main. Merge both with merge commits. The changelog labels (1.74.5 for #415, 1.74.6 for this) assume that; each merge commit adds one to the longest-path height; a squash or rebase shifts them.
What
Find-ModelShapeMismatches.ps1 (added in #415) found endpoints whose declared return type cannot deserialize what the Dashboard API sends, and [DataMember] names that are misspelt so the property never bound. This PR fixes every finding assessed as real. It is breaking: public return types and property names change. Each is listed in the 1.74.6 changelog section.
Class of defect
Count
Fix
List<T> where the API sends {items, meta}
6
wrapper types deriving from ItemsResponseWithMeta<T> (one already existed and was wrapped in a List)
Single object where the API sends an array
6
List<T>
List<T> where the API sends a single object (single-resource paths)
10
T (one was List<SecurityEvent>, an unrelated type)
Stale model: NetworkMove has neither property the API now sends
1
CreateNetworkMoveAsync now returns NetworkMoveDetailed; NetworkMove[Obsolete]; MoveId + Result added
Misspelt [DataMember] names
6
corrected, property renamed where it carried the typo
Found while writing the tests
ItemsResponseWithMeta<T> and the three ItemsResponseMeta* classes had no [DataContract]. Because each derived wrapper is[DataContract] (opt-in), Newtonsoft marked the inherited Meta as ignored and silently dropped the API's meta object, for every existing wrapper, not just the new ones. Verified by resolving the contract: Meta <- Meta ignored=True. Fixed by adding [DataContract] to all four; Meta.Counts will start being populated where it was always null.
Deliberately not changed
Three object-vs-list findings are the known Meraki spec habit of documenting a list endpoint's item rather than the array (GetNetworkWirelessRfProfilesAsync is observed live as an array in the customer CSV).
Five endpoints the spec documents as an array whose only item is itself {items, meta}, where the library's wrapper is right.
NetworkFirmwareUpgrade.products flagged as a typo of product: a false positive, since both exist in the spec.
Callers
No code outside Meraki.Api/Interfaces and Meraki.Api/Data references any changed method or property (checked Meraki.Api, Meraki.Api.Test, Meraki.ApiChecker).
The NetworkMovesResponse test failed first time with Meta.Counts == null, which is how the [DataContract] bug was found; it passes now. Every edited file kept its BOM and CRLF.
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%
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.
An audit against the v1.74.0 OpenAPI spec (Find-ModelShapeMismatches.ps1)
found Refit methods whose declared return type disagrees with the shape the
Dashboard API sends, so the call could never deserialize, and [DataMember]
names that are misspelt, so the property never bound.
Return types corrected (breaking for callers):
List<T> where the API sends an {items, meta} wrapper (6):
GetNetworkMovesAsync -> NetworkMovesResponse
GetOrganizationCampusGatewayClustersAsync -> OrganizationCampusGatewayClustersResponse
GetOrganizationSensorGatewaysConnectionsLatestAsync -> OrganizationSensorGatewaysConnectionsLatestResponse
GetOrganizationSwitchPortsStatusesBySwitchAsync -> OrganizationSwitchPortsStatusesBySwitchResponse
GetOrganizationIntegrationsXdrNetworksAsync -> OrganizationIntegrationsXdrByNetwork (already a wrapper)
UpdateOrganizationSmSentryPoliciesAssignments -> OrganizationSmSentryPoliciesAssignmentsUpdateResponse
Single object where the API sends an array (6): now List<T> of the same T.
List<T> where the API sends a single object (10): now T, all single-resource
paths. UpdateNetworkApplianceSdwanInternetPoliciesAsync was declared as
List<SecurityEvent>, an unrelated type.
CreateNetworkMoveAsync returns NetworkMoveDetailed: the API stopped sending
networkMoveId and url, so NetworkMove is [Obsolete]. NetworkMoveDetailed gains
MoveId and Result (new NetworkMoveResult); its Status left the spec and is
nullable.
Misspellings fixed, renaming the property where it carried the typo:
occuredAt -> occurredAt, farenheit -> fahrenheit, moveLicenses -> movedLicenses,
intiator -> initiator, themeAssests -> themeAssets, address -> addresses.
Found while testing: ItemsResponseWithMeta<T> and the ItemsResponseMeta*
classes lacked [DataContract], so on every opt-in derived wrapper Newtonsoft
marked the inherited Meta as ignored and dropped the API's meta object. All
four now carry [DataContract]; pagination counts will start arriving.
Left alone as the known Meraki spec habit of documenting a list endpoint's
item rather than the array: rfProfiles, licensing entitlements, early-access
opt-ins, and five endpoints documented as an array whose only item is itself
an {items, meta} wrapper.
ResponseShapeTests covers the new shapes, the corrected names and Meta.
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
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.
Stacked on #415
Base is
chore/update-to-latest-meraki-api. Merge #415 first, then retarget this tomain. Merge both with merge commits. The changelog labels (1.74.5for #415,1.74.6for this) assume that; each merge commit adds one to the longest-path height; a squash or rebase shifts them.What
Find-ModelShapeMismatches.ps1(added in #415) found endpoints whose declared return type cannot deserialize what the Dashboard API sends, and[DataMember]names that are misspelt so the property never bound. This PR fixes every finding assessed as real. It is breaking: public return types and property names change. Each is listed in the1.74.6changelog section.List<T>where the API sends{items, meta}ItemsResponseWithMeta<T>(one already existed and was wrapped in aList)List<T>List<T>where the API sends a single object (single-resource paths)T(one wasList<SecurityEvent>, an unrelated type)NetworkMovehas neither property the API now sendsCreateNetworkMoveAsyncnow returnsNetworkMoveDetailed;NetworkMove[Obsolete];MoveId+Resultadded[DataMember]namesFound while writing the tests
ItemsResponseWithMeta<T>and the threeItemsResponseMeta*classes had no[DataContract]. Because each derived wrapper is[DataContract](opt-in), Newtonsoft marked the inheritedMetaas ignored and silently dropped the API'smetaobject, for every existing wrapper, not just the new ones. Verified by resolving the contract:Meta <- Meta ignored=True. Fixed by adding[DataContract]to all four;Meta.Countswill start being populated where it was alwaysnull.Deliberately not changed
GetNetworkWirelessRfProfilesAsyncis observed live as an array in the customer CSV).{items, meta}, where the library's wrapper is right.NetworkFirmwareUpgrade.productsflagged as a typo ofproduct: a false positive, since both exist in the spec.Callers
No code outside
Meraki.Api/InterfacesandMeraki.Api/Datareferences any changed method or property (checkedMeraki.Api,Meraki.Api.Test,Meraki.ApiChecker).Verification
The
NetworkMovesResponsetest failed first time withMeta.Counts == null, which is how the[DataContract]bug was found; it passes now. Every edited file kept its BOM and CRLF.