Skip to content

#14325 [csharp] - Add CancellationToken to generated aspnetcore controller methods. #14326

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

Merged
merged 2 commits into from
Jan 14, 2023

Conversation

philkild
Copy link
Contributor

@philkild philkild commented Dec 26, 2022

Resolve #14325. The change adds a CancellationToken to all generated aspnetcore controller methods. The change can be verified by updating /bin/configs/aspnetcore-3.0.yaml with the below and generating the samples. Without these settings, the generated samples are unchanged:

  operationIsAsync: true
  operationResultTask: true

The CancellationToken is automatically bound as described in issue #14325 and therefore does not require any other changes and consumers can continue to use the API as normal

@wing328 @mandrean @shibayan @Blackclaws @lucamazzanti

PR checklist

  • Read the contribution guidelines.
  • 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.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.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.

@philkild philkild changed the title #14325 - Add CancellationToken to generated aspnetcore controller methods. #14325 [csharp] - Add CancellationToken to generated aspnetcore controller methods. Jan 2, 2023
@philkild
Copy link
Contributor Author

philkild commented Jan 4, 2023

I've attached a gif showing the change in action.

cancellationToken

@filipesantiagoAM
Copy link

Any updates on this? Would be super useful

@philkild
Copy link
Contributor Author

philkild commented Jan 6, 2023

@wing328 do you know who is best placed to review this and is there anything else I need to do?

@wing328
Copy link
Member

wing328 commented Jan 6, 2023

@philkild thanks for the PR. will try to review and get it merged over the weekend.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[REQ] Add CancellationToken to list of arguments in Controller methods
3 participants