Skip to content
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

Add the api-version to the doc comment for the Client type #1475

Open
richardpark-msft opened this issue Dec 10, 2024 · 0 comments
Open

Add the api-version to the doc comment for the Client type #1475

richardpark-msft opened this issue Dec 10, 2024 · 0 comments
Labels
design-discussion An area of design currently under discussion and open to team and community feedback.
Milestone

Comments

@richardpark-msft
Copy link
Member

In a customer thread it came up that it's not obvious which version of the API is being supported by a package. We do document this in some places (for instance, in the operations), but not at the constructor func or Client level.

I'm wondering if we have some spots where we could do this that would make sense. In Go, at least, we seem to specifically support a single API version when we generate a package, so a Client level comment should be safe to add.

This only partly solves things, since the generated types are not always exposed directly, but it would be a step in the right direction, and, I think, directly exposing generated types is something we're moving towards.

CC: @jhendrixMSFT

@RickWinter RickWinter added the design-discussion An area of design currently under discussion and open to team and community feedback. label Dec 16, 2024
@RickWinter RickWinter added this to the Backlog milestone Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design-discussion An area of design currently under discussion and open to team and community feedback.
Projects
None yet
Development

No branches or pull requests

2 participants