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

[BUGFIX] - Reverting readOnly for two fields #1595

Merged
merged 6 commits into from
Aug 26, 2017
Merged

Conversation

ro-joowan
Copy link
Contributor

@ro-joowan ro-joowan commented Aug 26, 2017

  • In this already-merged PR (BREAKING CHANGE: Adl object refactor #1429), Ben made some object-refactoring changes - one of them being to make all the fields in USqlJobProperties read-only as a good design decision. However, by making the fields statistics and debugData read-only, this caused some conflicts in the Powershell code.

  • We need to pan out the design more carefully for these two fields with respect to their associated APIs (below), which are both in job.json, before making them read-only.

    • "/Jobs/{jobIdentity}/GetDebugDataPath" for the debugData field
    • "/Jobs/{jobIdentity}/GetStatistics" for the statistics field
  • If I do not make the change proposed here, I would have to create two new cmdlets: one for getting the JobDataPath object and another for getting the JobStatistics object, which we do not want to do until we have a better understanding of their designs as a whole. Hence, the reverting change proposed here.

This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.

PR information

  • The title of the PR 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 information on cleaning up the commits in your pull request, see this page.
  • Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
  • If applicable, the PR references the bug/issue that it fixes.
  • Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

* There is no functional change in this commit

* This change is purely for refactoring related to Ben's refactoring
changes (which has already been accepted):
Azure#1429

* Reordering fields in the example files to match with Ben's refactoring
changes

* Other minor changes or moving code around
* In this already-merged PR
(Azure#1429), Ben made some
object-refactoring changes - one of them being to make all the fields in
USqlJobProperties read-only as a good design decision.  However, by
making the fields statistics and debugData read-only, this caused some
conflicts in the Powershell code.  We need to pan out the design more
carefully for these two fields with respect to their associated APIs
("/Jobs/{jobIdentity}/GetDebugDataPath" for the debugData field and
"/Jobs/{jobIdentity}/GetStatistics" for the statistics field) before
making them read-only.  If I do not make the change proposed here, I
would have to create two new cmdlets: one for getting the JobDataPath
object and another for getting the JobStatistics object, which we do not
want to do until we have a better understanding of their designs as a
whole.  Hence, the reverting change proposed here.
@msftclas
Copy link

@ro-joowan,
Thanks for your contribution as a Microsoft full-time employee or intern. You do not need to sign a CLA.
Thanks,
Microsoft Pull Request Bot

@azuresdkciprbot
Copy link

Hi There,

I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result:

File: specification/datalake-analytics/data-plane/readme.md
Before the PR: Warning(s): 13 Error(s): 0
After the PR: Warning(s): 13 Error(s): 0

AutoRest Linter Guidelines | AutoRest Linter Issues

Send feedback and make AutoRest Linter Azure Bot smarter day by day!

Thanks for your co-operation.

Copy link
Contributor

@olydis olydis left a comment

Choose a reason for hiding this comment

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

seems legit, thanks for the helpful explanation! 👍

@olydis olydis merged commit e33ebf8 into Azure:current Aug 26, 2017
@AutorestCI
Copy link

No modification for AutorestCI/azure-sdk-for-node

@AutorestCI
Copy link

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.

5 participants