[http-client-python] Refine api_version argument doc by Copilot · Pull Request #10348 · microsoft/typespec

Copilot · 2026-04-13T02:17:08Z

Show None as default value for optional api_version params
Add "If not set, the operation's default API version will be used" note
Include None in known values for api_version
Keep "Note that overriding this default value may result in unsupported behavior" for api-version
Remove standalone test file per reviewer request
Fix condition to handle optional=False api_version params (typical case)
Add changeset

For optional api_version parameters: - Known values now include "and None" since None is valid - Default value shows None instead of the version string - Adds note: "If not set, the operation's default API version will be used." - Removes "Note that overriding this default value may result in unsupported behavior." Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/0ef852ae-fc44-4ef7-9ec1-8ae7ec0e062d Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

…ters Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/73bd662d-7b42-4b56-a125-107799d617ff Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/99c1d213-7362-4e48-a2bf-e3c44ce9a519 Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

pkg-pr-new · 2026-04-15T04:15:12Z

Open in StackBlitz

npm i https://pkg.pr.new/@typespec/http-client-python@10348

commit: 917499e

tadelesh · 2026-04-15T07:07:39Z

@copilot Recheck your implementation. I found in the regen PR, no generated code change from this change.

The api_version parameter typically has optional=False with a client_default_value set. The previous condition (self.is_api_version and self.optional) never triggered for this case. Changed to check self.is_api_version regardless of optional flag, and also include api_version in the "Known values" section. Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/3d55c9dd-061c-409f-941c-b67ca483eefc Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

Copilot · 2026-04-15T08:09:49Z

@copilot Recheck your implementation. I found in the regen PR, no generated code change from this change.

The issue was that my condition checked self.is_api_version and self.optional, but api_version parameters typically have optional=False with client_default_value set to the version string. The condition never triggered. Fixed in 5367a77 by changing the check to just self.is_api_version (without requiring self.optional), and also including api_version in the "Known values" section regardless of optional flag.

github-actions · 2026-04-15T12:21:09Z

❌ There is undocummented changes. Run chronus add to add a changeset or click here.

The following packages have changes but are not documented.

❌@typespec/http-client-python

Show changes

tadelesh · 2026-04-15T15:29:18Z

@copilot Add changeset.

Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/40a269d1-2c7a-4dfa-865d-a2757190d03c Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

Copilot · 2026-04-15T16:27:33Z

@copilot Add changeset.

Added in 917499e.

Initial plan

91e885b

Copilot AI assigned Copilot and tadelesh Apr 13, 2026

Copilot AI linked an issue Apr 13, 2026 that may be closed by this pull request

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

Closed

Copilot started work on behalf of tadelesh April 13, 2026 02:17 View session

microsoft-github-policy-service bot added the emitter:client:python Issue for the Python client emitter: @typespec/http-client-python label Apr 13, 2026

Copilot AI changed the title ~~[WIP] Fix api_version argument documentation~~ [http-client-python] Refine api_version argument doc Apr 13, 2026

Copilot AI requested a review from tadelesh April 13, 2026 02:25

Copilot finished work on behalf of tadelesh April 13, 2026 02:25

tadelesh reviewed Apr 13, 2026

View reviewed changes

Comment thread packages/http-client-python/generator/pygen/codegen/models/parameter.py Outdated

Copilot started work on behalf of tadelesh April 13, 2026 10:38 View session

tadelesh reviewed Apr 13, 2026

View reviewed changes

Comment thread packages/http-client-python/tests/unit/test_api_version_description.py Outdated

fix: keep "overriding this default value" note for api-version parame…

73affe9

…ters Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/73bd662d-7b42-4b56-a125-107799d617ff Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

Copilot finished work on behalf of tadelesh April 13, 2026 10:43

Copilot AI requested a review from tadelesh April 13, 2026 10:43

Copilot started work on behalf of tadelesh April 13, 2026 10:43 View session

test: remove test_api_version_description.py per reviewer request

3faf10a

Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/99c1d213-7362-4e48-a2bf-e3c44ce9a519 Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

Copilot finished work on behalf of tadelesh April 13, 2026 10:47

msyyc mentioned this pull request Apr 14, 2026

[http-client-python] Refine api_version argument doc Azure/autorest.python#3442

Closed

Copilot started work on behalf of tadelesh April 15, 2026 07:07 View session

Copilot finished work on behalf of tadelesh April 15, 2026 08:11

tadelesh marked this pull request as ready for review April 15, 2026 10:43

tadelesh requested review from iscai-msft, msyyc and timotheeguerin as code owners April 15, 2026 10:43

tadelesh requested review from ChenxiJiang333, catalinaperalta, lmazuel, mccoyp and swathipil as code owners April 15, 2026 10:43

Merge branch 'main' into copilot/fix-api-version-doc

ff06a1e

Copilot started work on behalf of tadelesh April 15, 2026 15:29 View session

Add changeset for api_version doc refinement

917499e

Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/40a269d1-2c7a-4dfa-865d-a2757190d03c Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>

iscai-msft approved these changes Apr 15, 2026

View reviewed changes

iscai-msft enabled auto-merge April 15, 2026 16:28

Copilot finished work on behalf of tadelesh April 15, 2026 16:28

iscai-msft added this pull request to the merge queue Apr 15, 2026

Merged via the queue into main with commit 9affc6f Apr 15, 2026
30 of 31 checks passed

iscai-msft deleted the copilot/fix-api-version-doc branch April 15, 2026 20:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

[http-client-python] Refine api_version argument doc#10348
iscai-msft merged 7 commits intomainfrom
copilot/fix-api-version-doc

Copilot AI commented Apr 13, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

pkg-pr-new bot commented Apr 15, 2026 •

edited

Loading

Uh oh!

tadelesh commented Apr 15, 2026

Uh oh!

Copilot AI commented Apr 15, 2026

Uh oh!

github-actions bot commented Apr 15, 2026

Uh oh!

tadelesh commented Apr 15, 2026

Uh oh!

Copilot AI commented Apr 15, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Copilot AI commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pkg-pr-new bot commented Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tadelesh commented Apr 15, 2026

Uh oh!

Copilot AI commented Apr 15, 2026

Uh oh!

github-actions bot commented Apr 15, 2026

Uh oh!

tadelesh commented Apr 15, 2026

Uh oh!

Copilot AI commented Apr 15, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Apr 13, 2026 •

edited

Loading

pkg-pr-new bot commented Apr 15, 2026 •

edited

Loading