-
Notifications
You must be signed in to change notification settings - Fork 78
Filtering out optional parameters when generating sample code #3619
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.
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
Open
v-jiaodi
wants to merge
2
commits into
Azure:main
Choose a base branch
from
v-jiaodi:fix-issue3610
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
89 changes: 89 additions & 0 deletions
89
.../typespec-ts/test/modularUnit/scenarios/samples/parameters/optionalParameter.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| # Optional parameters should not appear as standalone parameters in sample code | ||
|
|
||
| ## TypeSpec | ||
|
|
||
| ```typespec | ||
| import "@typespec/http"; | ||
| import "@typespec/rest"; | ||
| import "@azure-tools/typespec-azure-core"; | ||
| import "@azure-tools/typespec-client-generator-core"; | ||
|
|
||
| using TypeSpec.Http; | ||
| using TypeSpec.Rest; | ||
| using Azure.Core; | ||
|
|
||
| @service(#{ | ||
| title: "Sample Service", | ||
| }) | ||
| @server( | ||
| "{endpoint}", | ||
| "Sample endpoint", | ||
| { | ||
| @doc("The endpoint URL") | ||
| endpoint: string = "https://example.com", | ||
| } | ||
| ) | ||
| namespace SampleService; | ||
|
|
||
| model Person { | ||
| id: string; | ||
| name: string; | ||
| } | ||
|
|
||
| @route("/persons") | ||
| interface Persons { | ||
| @get | ||
| list( | ||
| @query start?: string, | ||
| @query top?: int32, | ||
| ): Person[]; | ||
| } | ||
| ``` | ||
|
|
||
| ## Example | ||
|
|
||
| ```json | ||
| { | ||
| "title": "List persons", | ||
| "operationId": "Persons_List", | ||
| "parameters": { | ||
| "start": "00000000-0000-0000-0000-000000000000", | ||
| "top": 20 | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": [ | ||
| { | ||
| "id": "person1", | ||
| "name": "John Doe" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Generated Sample | ||
|
|
||
| ```ts samples | ||
| /** This file path is /samples-dev/listSample.ts */ | ||
| import { SampleServiceClient } from "@azure/internal-test"; | ||
|
|
||
| /** | ||
| * This sample demonstrates how to execute list | ||
| * | ||
| * @summary execute list | ||
| * x-ms-original-file: 2021-10-01-preview/json.json | ||
| */ | ||
| async function listPersons(): Promise<void> { | ||
| const client = new SampleServiceClient(); | ||
| const result = await client.list({ start: "00000000-0000-0000-0000-000000000000", top: 20 }); | ||
| console.log(result); | ||
| } | ||
|
|
||
| async function main(): Promise<void> { | ||
| await listPersons(); | ||
| } | ||
|
|
||
| main().catch(console.error); | ||
| ``` |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should not filter out the optional client params at the begining and we should handle optional client params during constructing the statement.