Support deprecated API endpoints in reqwest-based Rust clients #22131
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.
Previously, if an API endpoint was marked deprecated, this fact was not reflected in the generated Rust clients using the reqwest library. We want to know exactly when our client code is using a deprecated endpoint, so marking the corresponding functions with the
#[deprecatd]attribute would be very helpful. Uses of the endpoint would then be picked up by linters so that we can react.This adds a line to the template which marks functions generated from deprecated endpoints with the
#[deprecated]attribute.This does not touch any of the other client generators for Rust or any other language, since they are out of scope for our needs.
Unfortunately, even after about a dozen attempts, I was unable to coax Mustache into not introducing an extra vertical whitespace when the
#[deprecated]attribute is absent. This has no effect on functionality of the generated code, but is visually unappealing.@frol @farcaller @richardwhiuk @paladinzh @jacob-pro @dsteeley
PR checklist
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.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)