Skip to content

[http-client-python] Refine api_version argument doc #10348

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.

Sign up for GitHub

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

Draft
Copilot wants to merge 4 commits into
base: main
Choose a base branch
from
+11 −12
Draft

[http-client-python] Refine api_version argument doc #10348

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
91e885b
Initial plan
Copilot Apr 13, 2026
9b9de65
fix: refine api_version argument doc to show None as default value
Copilot Apr 13, 2026
73affe9
fix: keep "overriding this default value" note for api-version parame…
Copilot Apr 13, 2026
3faf10a
test: remove test_api_version_description.py per reviewer request
Copilot Apr 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 11 additions & 12 deletions packages/http-client-python/generator/pygen/codegen/models/parameter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,24 +109,23 @@ def description(self) -> str:
if type_description:
base_description = add_to_description(base_description, type_description)
if self.optional and isinstance(self.type, ConstantType):
if self.is_api_version:
base_description = add_to_description(
base_description,
f"Known values are {self.get_declaration()}.",
)
else:
base_description = add_to_description(
base_description,
f"Known values are {self.get_declaration()} and None.",
)
base_description = add_to_description(
base_description,
f"Known values are {self.get_declaration()} and None.",
)
if not (self.optional or self.client_default_value):
base_description = add_to_description(base_description, "Required.")
if self.client_default_value is not None:
if self.is_api_version and self.optional:
base_description = add_to_description(
base_description,
"Default value is None. If not set, the operation's default API version will be used.",
)
elif self.client_default_value is not None:
base_description = add_to_description(
base_description,
f"Default value is {self.client_default_value_declaration}.",
)
if self.optional and self.client_default_value is None:
elif self.optional:
base_description = add_to_description(
base_description,
f"Default value is {self.client_default_value_declaration}.",
Expand Down