Skip to content

[Synapse] - Many models now have public setters#18848

Merged
idear1203 merged 2 commits intoAzure:masterfrom
idear1203:synapse_public_setters
Feb 24, 2021
Merged

[Synapse] - Many models now have public setters#18848
idear1203 merged 2 commits intoAzure:masterfrom
idear1203:synapse_public_setters

Conversation

@idear1203
Copy link
Copy Markdown
Contributor

All SDK Contribution checklist:

This checklist is used to make sure that common guidelines for a pull request are followed.

  • Please open PR in Draft mode if it is:
    • Work in progress or not intended to be merged.
    • Encountering multiple pipeline failures and working on fixes.
  • If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.
  • I have read the contribution guidelines.
  • The pull request does not introduce breaking changes.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

SDK Generation Guidelines

  • The generate.cmd file for the SDK has been updated with the version of AutoRest, as well as the commitid of your swagger spec or link to the swagger spec, used to generate the code. (Track 2 only)
  • The *.csproj and AssemblyInfo.cs files have been updated with the new version of the SDK. Please double check nuget.org current release version.

Additional management plane SDK specific contribution checklist:

Note: Only applies to Microsoft.Azure.Management.[RP] or Azure.ResourceManager.[RP]

  • Include updated management metadata.
  • Update AzureRP.props to add/remove version info to maintain up to date API versions.

Management plane SDK Troubleshooting

  • If this is very first SDK for a services and you are adding new service folders directly under /SDK, please add new service label and/or contact assigned reviewer.
  • If the check fails at the Verify Code Generation step, please ensure:
    • Do not modify any code in generated folders.
    • Do not selectively include/remove generated files in the PR.
    • Do use generate.ps1/cmd to generate this PR instead of calling autorest directly.
      Please pay attention to the @microsoft.csharp version output after running generate.ps1. If it is lower than current released version (2.3.82), please run it again as it should pull down the latest version,

Old outstanding PR cleanup

Please note:
If PRs (including draft) has been out for more than 60 days and there are no responses from our query or followups, they will be closed to maintain a concise list for our reviewers.

Copy link
Copy Markdown
Contributor

@chamons chamons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you mean settings, not getters, in both the doc and PR title?

  • public string SessionId { get; }
  • public string SessionId { get; set; }

Hey @pakrym - Is this the best way to do this?

@pakrym
Copy link
Copy Markdown
Contributor

pakrym commented Feb 18, 2021

Why are we doing this?

Copy link
Copy Markdown
Contributor

@chamons chamons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bah - I can't "undo" hitting approve not comment. But I meant comment ^.

@chamons
Copy link
Copy Markdown
Contributor

chamons commented Feb 18, 2021

Hey @idear1203 - I wonder if you are fighting the generator in needed to make the models public (previously) and get/set (here).

We might need to modify the autorest.csharp to better support this.

Some details on why we need this would be useful.

@idear1203 idear1203 changed the title [Synapse] - Many models now have public getters [Synapse] - Many models now have public setters Feb 19, 2021
@idear1203 idear1203 requested a review from chamons February 19, 2021 10:20
@idear1203
Copy link
Copy Markdown
Contributor Author

@chamons we received feedback from SDK users, compared with the ADF SDK that they use before, there are some properties now don't have public setters. I believe this is also because these classes are generated to be internal. So for now I want to use customizations to solve the issue.

Copy link
Copy Markdown
Contributor

@chamons chamons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In theory these manual changes aren't needed, we should be able to mark the configuration that these models should be public and have setters without so much customization.

However, if we add that then we can undo the customization in the future, so no reason to block on that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants