Problem
When upgrading from Cisco.Api 3.0.104 to 3.0.114, several API interface methods have breaking changes:
-
Added required pageIndex parameter to methods that previously didn't require one:
IEox.GetBySoftwareReleaseStringAsync(IEnumerable<string>) now requires int pageIndex (default: 1)
IEox.GetBySerialNumberAsync(string) now requires int pageIndex (default: 1)
ISoftwareSuggestion.GetByProductIdsAsync(IEnumerable<string>) now requires int pageIndex (default: 1)
-
Added required alias parameter to:
ISecurityAdvisory.GetAdvisoriesByOsTypeAndVersion(string type, string version) now requires string alias (default: "")
-
All obsolete overloads without CancellationToken are now errors (Obsolete(..., true)), requiring callers to pass a CancellationToken:
ISerialNumberToInfo.GetCoverageStatusBySerialNumbersAsync
ISerialNumberToInfo.GetCoverageSummaryBySerialNumbersAsync
IProductInfo.GetBySerialNumbersAsync
ISecurityAdvisory.GetOsVersionDataByType
ISecurityAdvisory.GetAdvisoriesByCveName
ISecurityAdvisory.GetAdvisoriesByProduct
Suggestion
Add a migration section to README.md (similar to what Uk.Parliament does) showing before/after examples for each breaking change. For example:
## Migration from 3.0.x to 3.0.114
### pageIndex parameter
Methods on `IEox` and `ISoftwareSuggestion` now require an explicit `pageIndex` parameter. Pass `1` for single-page requests:
```csharp
// Before
var result = await client.Eox.GetBySerialNumberAsync(serial);
// After
var result = await client.Eox.GetBySerialNumberAsync(serial, 1, cancellationToken);
CancellationToken now required
All overloads without CancellationToken are removed. Add cancellationToken (or default) as the last argument.
This would have saved significant time when upgrading MagicSuite from 3.0.104 to 3.0.114.
Problem
When upgrading from Cisco.Api 3.0.104 to 3.0.114, several API interface methods have breaking changes:
Added required
pageIndexparameter to methods that previously didn't require one:IEox.GetBySoftwareReleaseStringAsync(IEnumerable<string>)now requiresint pageIndex(default:1)IEox.GetBySerialNumberAsync(string)now requiresint pageIndex(default:1)ISoftwareSuggestion.GetByProductIdsAsync(IEnumerable<string>)now requiresint pageIndex(default:1)Added required
aliasparameter to:ISecurityAdvisory.GetAdvisoriesByOsTypeAndVersion(string type, string version)now requiresstring alias(default:"")All obsolete overloads without
CancellationTokenare now errors (Obsolete(..., true)), requiring callers to pass aCancellationToken:ISerialNumberToInfo.GetCoverageStatusBySerialNumbersAsyncISerialNumberToInfo.GetCoverageSummaryBySerialNumbersAsyncIProductInfo.GetBySerialNumbersAsyncISecurityAdvisory.GetOsVersionDataByTypeISecurityAdvisory.GetAdvisoriesByCveNameISecurityAdvisory.GetAdvisoriesByProductSuggestion
Add a migration section to README.md (similar to what Uk.Parliament does) showing before/after examples for each breaking change. For example:
CancellationToken now required
All overloads without
CancellationTokenare removed. AddcancellationToken(ordefault) as the last argument.