-
Notifications
You must be signed in to change notification settings - Fork 68
docs: Add parameter renaming guide using client.tsp approach #3846
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
Conversation
Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>
Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>
tadelesh
left a comment
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.
@copilot Resolve the comments.
website/src/content/docs/docs/howtos/Generate client libraries/09renaming.mdx
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Generate client libraries/09renaming.mdx
Outdated
Show resolved
Hide resolved
… and remove version-scoped section Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>
|
No changes needing a change description found. |
website/src/content/docs/docs/howtos/Generate client libraries/09renaming.mdx
Show resolved
Hide resolved
…parameter renaming section Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>
|
You can try these changes here
|
tadelesh
left a comment
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.
@copilot For each part of the example, instead of import "main.tsp";, please compose a complete example, adding:
namespace PetStoreNamespace;
/** This is the input I need */
@resource("input")
model InputModel {
/** Id of this object */
@key
@visibility(Lifecycle.Read)
name: string;
}
/** Read my resource */
op get is ResourceRead<InputModel>;
…peSpec definition Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>
Updated the example to be self-contained. Replaced |
website/src/content/docs/docs/howtos/Generate client libraries/09renaming.mdx
Outdated
Show resolved
Hide resolved
website/src/content/docs/docs/howtos/Generate client libraries/09renaming.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>
website/src/content/docs/docs/howtos/Generate client libraries/09renaming.mdx
Show resolved
Hide resolved
Co-authored-by: tadelesh <1726438+tadelesh@users.noreply.github.com>
Documentation Update: Parameter Renaming Guide
Summary of Changes
Updated parameter renaming documentation with properly structured and complete examples:
Latest changes:
using PetStoreNamespace;statement: The client.tsp example now properly includes the using statement to reference entities from the main.tsp namespaceThe client.tsp example now includes:
This ensures the example is a complete, working TypeSpec specification.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.