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

Remove "s" from read/write/format settings #6768

Closed
wants to merge 2 commits into from

Conversation

yuzhangyi
Copy link
Contributor

Latest improvements:

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

  • I have reviewed the documentation for the workflow.
  • Validation tools were run on swagger spec(s) and have all been fixed in this PR.
  • The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

  • Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
  • adding/removing APIs.
  • adding/removing properties.
  • adding/removing API-version.
  • adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

  • If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
    Please follow the link to find more details on API review process.

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Jul 29, 2019

SDK Automation [Logs] (Generated from 3298580, Iteration 2)

Failed Python: Azure/azure-sdk-for-python [Logs]
  • No packages generated.
Failed Java: Azure/azure-sdk-for-java [Logs]
  • No packages generated.
Failed Go: test-repo-billy/azure-sdk-for-go [Logs]
  • No packages generated.
Failed JavaScript: Azure/azure-sdk-for-js [Logs]
  • No packages generated.

@AutorestCI
Copy link

AutorestCI commented Jul 29, 2019

Automation for azure-sdk-for-python

Encountered an unknown error: (azure-sdk-for-python)

Traceback (most recent call last):
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 33, in exception_to_github
    yield context
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 170, in rest_handle_action
    return rest_pull_close(body, restapi_repo, sdk_pr_target_repo, sdkbase, sdk_tag)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 185, in rest_pull_close
    rest_pr_management(rest_pr, sdk_pr_target_repo, sdk_tag, sdk_default_base)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github_handler.py", line 151, in rest_pr_management
    sdk_tag=sdk_tag
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/SwaggerToSdkNewCLI.py", line 254, in generate_sdk_from_git_object
    with manage_git_folder(gh_token, Path(temp_dir) / Path("rest"), branched_rest_api_id, pr_number=pr_number) as restapi_git_folder, \
  File "/usr/lib/python3.6/contextlib.py", line 81, in __enter__
    return next(self.gen)
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 272, in manage_git_folder
    clone_to_path(gh_token, temp_dir, split_git_id[0], branch_or_commit=branch, pr_number=pr_number)
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 212, in clone_to_path
    repo.git.checkout(branch_or_commit)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 548, in <lambda>
    return lambda *args, **kwargs: self._call_process(name, *args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 1014, in _call_process
    return self.execute(call, **exec_kwargs)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 825, in execute
    raise GitCommandError(command, status, stderr_value, stdout_value)
git.exc.GitCommandError: Cmd('git') failed due to: exit code(128)
  cmdline: git checkout 3024ab0bc5c5211154013664490d7305fb4bc242
  stderr: 'fatal: reference is not a tree: 3024ab0bc5c5211154013664490d7305fb4bc242'

@yuzhangyi
Copy link
Contributor Author

+@KeynesY , @davidzhaoyue, @shawnxzq to help review this change.

@AutorestCI
Copy link

AutorestCI commented Jul 29, 2019

Automation for azure-sdk-for-go

Encountered an unknown error: (azure-sdk-for-go)

Traceback (most recent call last):
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 33, in exception_to_github
    yield context
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 170, in rest_handle_action
    return rest_pull_close(body, restapi_repo, sdk_pr_target_repo, sdkbase, sdk_tag)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 185, in rest_pull_close
    rest_pr_management(rest_pr, sdk_pr_target_repo, sdk_tag, sdk_default_base)
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github_handler.py", line 151, in rest_pr_management
    sdk_tag=sdk_tag
  File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/SwaggerToSdkNewCLI.py", line 254, in generate_sdk_from_git_object
    with manage_git_folder(gh_token, Path(temp_dir) / Path("rest"), branched_rest_api_id, pr_number=pr_number) as restapi_git_folder, \
  File "/usr/lib/python3.6/contextlib.py", line 81, in __enter__
    return next(self.gen)
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 272, in manage_git_folder
    clone_to_path(gh_token, temp_dir, split_git_id[0], branch_or_commit=branch, pr_number=pr_number)
  File "/usr/local/lib/python3.6/dist-packages/azure_devtools/ci_tools/github_tools.py", line 212, in clone_to_path
    repo.git.checkout(branch_or_commit)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 548, in <lambda>
    return lambda *args, **kwargs: self._call_process(name, *args, **kwargs)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 1014, in _call_process
    return self.execute(call, **exec_kwargs)
  File "/usr/local/lib/python3.6/dist-packages/git/cmd.py", line 825, in execute
    raise GitCommandError(command, status, stderr_value, stdout_value)
git.exc.GitCommandError: Cmd('git') failed due to: exit code(128)
  cmdline: git checkout 3024ab0bc5c5211154013664490d7305fb4bc242
  stderr: 'fatal: reference is not a tree: 3024ab0bc5c5211154013664490d7305fb4bc242'

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

@yuzhangyi
Copy link
Contributor Author

Hi, @anuchandy , because the AUX of our product has been released to customers serval months ago, so we have to rollback before change (it was breaking change on existed customers) to keep backward compability here, that's why we remove the "s" from write/read/format settings. This change has been agreed by our product leaders team. Please help review and signoff this change, thanks.

@anuchandy
Copy link
Member

anuchandy commented Jul 29, 2019

@yuzhangyi this is a breaking change in the SDK level. Also usually we use settings for configuration properties not setting. Is this change necessary?

Over the wire properties has s in their names

so there is no change in the API Level but only in the SDK level.

@anuchandy
Copy link
Member

We released SDKs with s in the model names, e.g. .NET SDK

https://github.com/Azure/azure-sdk-for-net/blob/8a7d510c4f7dc88ad6a68bc77f859f0247a71089/sdk/datafactory/Microsoft.Azure.Management.DataFactory/src/Generated/Models/StoreReadSettings.cs#L22

Nuget packages here: https://www.nuget.org/packages/Microsoft.Azure.Management.DataFactory/

Trying to understand your message so we have to rollback before change (it was breaking change on existed customers) to keep backward compability here:

now that we already released it, what do we meant by backward compatibility? sorry if I'm missing some context here.

@yuzhangyi
Copy link
Contributor Author

Hi, @anuchandy and @AutorestCI, based on newest information get from azure powershell team, our change with breaking change in public swagger has been released to customers. So we choose to let our product AUX handling both "setting" and "settings" to workaround now, so close this PR review, thanks for your help.

@yuzhangyi yuzhangyi closed this Jul 30, 2019
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