-
Notifications
You must be signed in to change notification settings - Fork 120
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
Azure IoT Provisioning Client Receiving Custom Allocation Payloads #2443
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mostly just looked at function signatures and they all looked good to me.
* @deprecated since 1.5.0-beta.1. | ||
* @see az_iot_provisioning_client_register_get_request_payload |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't render the best in doxygen docs:
https://azuresdkdocs.blob.core.windows.net/$web/c/az_iot/1.5.0/deprecated.html
We should, at least update this to the following.
* @deprecated since 1.5.0-beta.1. | |
* @see az_iot_provisioning_client_register_get_request_payload | |
* @deprecated since 1.5.0 | |
* @see az_iot_provisioning_client_register_get_request_payload |
I will leave it open for others to figure out other improvements :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was the time the changes were deprecated. Feel free to submit a new PR to update.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't render the best in doxygen docs:
Can you be more specific about what doesn't render correctly? Looks acceptable to me:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks good in the API list.
The link I shared leads to the Deprecated List
page, which formats the function signature in a way that is difficult to parse/read.
It also don't understand what is meant by Global
. Apparently there's a way to remove that page all together (https://stackoverflow.com/a/25065592), but maybe we should just keep it, as is.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was the time the changes were deprecated. Feel free to submit a new PR to update.
Fixed in #2480
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was the time the changes were deprecated. Feel free to submit a new PR to update.
Fixed in #2480
Port from https://github.com/Azure/azure-sdk-for-c/tree/feature/iot-certificate-management.
options
parameter cannot beNULL
. (Changing az_iot_provisioning_client_register_get_request_payload options behavior #2188 (comment))Deprecation notice:
az_iot_provisioning_client_get_request_payload()
is deprecated in favor ofaz_iot_provisioning_client_register_get_request_payload()
. The new API requires an initializedaz_iot_provisioning_client_payload_options
structure (usingaz_iot_provisioning_client_payload_options_default()
).