openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

[csharp] Address MaxTimeout obsolete build warning

Open alec-petersen opened this issue 1 year ago • 2 comments

@wing328 , this adds that option to enable use of MaxTimeout over Timeout, but it defaults to the non-obsolete option by default. Fix #19525.

PR checklist

  • [x] Read the contribution guidelines.
  • [x] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [x] Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH) Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • [x] File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • [ ] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

alec-petersen avatar Oct 15 '24 12:10 alec-petersen

Good news @wing328! We can actually simplify down and lose the fallback config option. RestSharp already disregards MaxTimeout and uses the Timeout value, so setting Timeout will have the desired effect of using MaxTimeout.

[Obsolete("Use Timeout instead.")]
public int MaxTimeout {
    get => (int) (Timeout?.TotalMilliseconds ?? 0);
    set => Timeout = TimeSpan.FromMilliseconds(value);
}

alec-petersen avatar Oct 16 '24 01:10 alec-petersen

tests passed via https://ci.appveyor.com/project/WilliamCheng/openapi-generator/builds/50804786

wing328 avatar Oct 16 '24 06:10 wing328

Added an option useIntForTimeout for fallback via https://github.com/OpenAPITools/openapi-generator/pull/20069, e.g. --addititional-properties useIntForTimeout=true in CLI

wing328 avatar Nov 09 '24 07:11 wing328