[python] Remove "None" from known values in api_version docstring#10105
Merged
Conversation
The api_version parameter is typed as `str` and None is not a valid API version value. Including "None" in the "Known values" list was misleading as passing api_version=None would flow through to request serialization rather than falling back to the default. Before: Known values are "2026-01-01-preview" and None. After: Known values are "2026-01-01-preview". Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Optimize docstring about api_version in generated SDK
[python] Remove "None" from known values in api_version docstring
Mar 20, 2026
microsoft-github-policy-service
Bot
added
the
emitter:client:python
msyyc
requested review from
ChenxiJiang333,
catalinaperalta,
iscai-msft,
laiapat,
lmazuel,
swathipil,
tadelesh and
timotheeguerin
as code owners
Collaborator
|
You can try these changes here
|
commit: |
Contributor
|
All changed packages have been documented.
Show changes
|
msyyc
reviewed
Mar 23, 2026
Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/704aa55b-8d83-4416-ba7d-97b4ae5b1051
iscai-msft
approved these changes
Mar 24, 2026
iscai-msft
approved these changes
Mar 26, 2026
msyyc
added a commit
that referenced
this pull request
Apr 1, 2026
…0105) - [x] Fix: Remove "and None" from known values in api_version docstring in `parameter.py` - [x] Add changelog entry under `.chronus/changes` - [x] Manually verify the fix works correctly for both api_version and non-api_version parameters - [x] Run existing unit tests (all pass) - [x] Code review passed (no issues) - [x] Security scan passed (no alerts) <!-- START COPILOT ORIGINAL PROMPT --> <details> <summary>Original prompt</summary> > > ---- > > *This section details on the original issue you should resolve* > > <issue_title>[python] optimize docstring about api_version in generated SDK</issue_title> > <issue_description>Bot's review comment makes sense Azure/azure-sdk-for-python#45814 (comment): > > <img width="1128" height="680" alt="Image" src="https://github.com/user-attachments/assets/65b197ce-5a64-40b0-b923-f7d8b5e84928" /></issue_description> > > ## Comments on the Issue (you are @copilot in this section) > > <comments> > </comments> > </details> <!-- START COPILOT CODING AGENT SUFFIX --> - Fixes #10104 <!-- START COPILOT CODING AGENT TIPS --> --- 📱 Kick off Copilot coding agent tasks wherever you are with [GitHub Mobile](https://gh.io/cca-mobile-docs), available on iOS and Android. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
parameter.py.chronus/changesOriginal prompt
📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.