Fix for azure.digitaltwins.core.DigitalTwinsClient.update_components

[joseba-altran]

This PR includes changes to address the following problems with the update_component method in azure.digitaltwins.core.DigitalTwinsClient:

• adt_client.update_component(dt_id, component_path, patch) results in a TypeError stating that requests does not include a param named if_match.
• The definition of how the patch should be created, as stated in README.md is not valid.
• Also, the docstring in the method has an incorrect type.

Please note that these issues also affect the package available in PyPI right now.

The sample code below works as expected for me after applying the changes in this PR:

import os
from azure.identity import DefaultAzureCredential
from azure.digitaltwins.core import DigitalTwinsClient

# AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET & AZURE_ADT_URL must be env vars
credential = DefaultAzureCredential()
adt_client = DigitalTwinsClient(os.getenv('AZURE_ADT_URL'), credential)

patch = [{"op": "replace",
                    "path": "/mass",
                    "value": -42.42}]
adt_client.update_component('InitialChamber_1', 'Weight', patch)

Please let me know if you need any more information.

[ghost]

Thank you for your contribution joseba-altran! We will review the pull request and get back to you soon.

[annatisch]

@zolvarga - could you take a look at this issue/patch to confirm the expect service behaviour?

[joseba-altran]

@zolvarga thanks a lot for your response. I just cloned master and tried my code and see that the issue with if_match is still present. The docstring type has been fixed, though 😊. Am I missing something? Kind regards, Joseba De: Zoltan Varga <[email protected]> Fecha: miércoles, 4 de noviembre de 2020, 23:34 Para: Azure/azure-sdk-for-python <[email protected]> CC: ECHEVARRIA GARCIA Joseba <[email protected]>, Mention <[email protected]> Asunto: Re: [Azure/azure-sdk-for-python] Fix for azure.digitaltwins.core.DigitalTwinsClient.update_components (#14917) @joseba-altran Thank you for raising the issue and creating the PR. We were aware of the issue in the preview and it has been fixed in the repository already. (You can take a look at the code here: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/digitaltwins/azure-digitaltwins-core/azure/digitaltwins/core/_digitaltwins_client.py The new package is not released yet, we are working on it. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub

[joseba-altran]

In fact, I have not tested other methods, but I see a lot of calls passing the if_match kwarg, I am not sure if those will work too or not but I suspect they won't.

[annatisch]

Thanks so much for investigating this @joseba-altran!
I have merged another PR here (#15157) which should resolve all the if-match parameter issues.
I will leave this PR open until we have also corrected all the samples/readme snippets accordingly.

[joseba-altran]

Thank you very much, @annatisch! Happy to help :)

[annatisch]

Thanks @joseba-altran - all these fixes have been made and released :)