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

Azure IoT Provisioning Client Receiving Custom Allocation Payloads #2443

Merged
merged 8 commits into from
Dec 12, 2022

Conversation

CIPop
Copy link
Member

@CIPop CIPop commented Dec 6, 2022

Port from https://github.com/Azure/azure-sdk-for-c/tree/feature/iot-certificate-management.

Deprecation notice: az_iot_provisioning_client_get_request_payload() is deprecated in favor of az_iot_provisioning_client_register_get_request_payload(). The new API requires an initialized az_iot_provisioning_client_payload_options structure (using az_iot_provisioning_client_payload_options_default()).

@CIPop CIPop added the APIChange This PR contains an addition or change to the API signature and must be reviewed by an architect. label Dec 6, 2022
sdk/inc/azure/core/_az_cfg.h Outdated Show resolved Hide resolved
sdk/inc/azure/iot/az_iot_provisioning_client.h Outdated Show resolved Hide resolved
sdk/inc/azure/iot/az_iot_provisioning_client.h Outdated Show resolved Hide resolved
sdk/inc/azure/iot/az_iot_provisioning_client.h Outdated Show resolved Hide resolved
sdk/inc/azure/iot/az_iot_provisioning_client.h Outdated Show resolved Hide resolved
sdk/src/azure/iot/az_iot_provisioning_client.c Outdated Show resolved Hide resolved
Copy link
Member

@JeffreyRichter JeffreyRichter left a 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.

@CIPop CIPop enabled auto-merge (squash) December 12, 2022 17:14
@CIPop CIPop merged commit e8f105e into Azure:main Dec 12, 2022
Comment on lines +513 to +514
* @deprecated since 1.5.0-beta.1.
* @see az_iot_provisioning_client_register_get_request_payload
Copy link
Member

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.

Suggested change
* @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 :)

Copy link
Member Author

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.

Copy link
Member Author

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:

image

https://azuresdkdocs.blob.core.windows.net/$web/c/az_iot/1.5.0/az__iot__provisioning__client_8h.html#a82fdc4e466e89adf377f1f5c15756d2f

Copy link
Member

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.

Copy link
Member

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

Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIChange This PR contains an addition or change to the API signature and must be reviewed by an architect.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants