Issue found in DPG modular generation - apiVersion parameter missing #3437
Conversation
MaryGao
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR fixes an issue in DPG modular generation where the apiVersion parameter was missing by correcting the logic for determining required parameters in client parameter generation.
Key changes:
- Restructured the condition logic in
isRequiredfunction to properly handle theapiVersionAsRequiredflag - Moved the apiVersion special case to the beginning of the condition to ensure it takes precedence
- Added a comprehensive test case for Azure Analytics Purview DataMap service to validate the fix
Reviewed Changes
Copilot reviewed 6 out of 48 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/typespec-ts/src/modular/helpers/clientHelpers.ts | Fixed parameter requirement logic to properly handle apiVersionAsRequired flag |
| packages/typespec-test/test/Azure.Analytics.Purview.DataMap/tspconfig.yaml | Added TypeSpec configuration for new test case |
| packages/typespec-test/test/Azure.Analytics.Purview.DataMap/spec/routes.tsp | Added comprehensive route definitions for DataMap service test |
| packages/typespec-test/test/Azure.Analytics.Purview.DataMap/spec/models.tsp | Added model definitions for DataMap service test |
| packages/typespec-test/test/Azure.Analytics.Purview.DataMap/spec/main.tsp | Added main service definition for DataMap test |
| packages/typespec-test/test/Azure.Analytics.Purview.DataMap/spec/client.tsp | Added client customizations for DataMap test |
|
The previous logic was to always return |
| model AtlasApiVersionParameter { | ||
| @doc("The API version to use for this operation.") | ||
| @query("api-version") | ||
| @minLength(1) | ||
| apiVersion?: string; | ||
| } | ||
|
|
||
| alias AtlasApiVersionParameterTraits = Azure.Core.Traits.VersionParameterTrait<AtlasApiVersionParameter>; | ||
|
|
There was a problem hiding this comment.
A custom optional apiVersion was defined, but since all operations use AtlasApiVersionParameterTraits, optional is set to true.
There was a problem hiding this comment.
@tadelesh do we allow api-version to be optional in azure scope? if it is, do we still have client-level api-version in TCGC? I am curious about what the behvior would be if the api-version is optional but not set.
There was a problem hiding this comment.
TCGC did not take case of the optionality of api version parameter. Thought it is optional, it will also in client.
| const isRequired = (p: SdkParameter) => | ||
| !p.optional && | ||
| ((!hasDefaultValue(p) && | ||
| // Special case: when apiVersionAsRequired is true, apiVersion should always be considered required |
There was a problem hiding this comment.
I don't think this fix is correct. We should trust always the defined optionality for api-version. If it is optional in spec, why we set it as required?
|
|
||
| - TypeSpec defines an optional api-version parameter: `apiVersion?: string` | ||
| - TCGC correctly sets `optional: true` for this parameter | ||
| - However, the generated client code incorrectly adds a `ClientApiVersionPolicy` instead of treating it as truly optional |
There was a problem hiding this comment.
when leveraging AI to generate content pls ensure you understand what AI is said, do you understand what following mentioned?
However, the generated client code incorrectly adds a `ClientApiVersionPolicy` instead of treating it as truly optional
5 participants
fixes #3438
