azure-rest-api-specs
azure-rest-api-specs copied to clipboard
[IoT Central] API Review
New API Review meeting has been requested.
Service Name: IoT Central Review Created By: Johnson Yang Review Date: 10/20/2022 4:00 PM PT PR: https://github.com/Azure/azure-rest-api-specs/pull/20981 Hero Scenarios Link: Not Provided Core Concepts Doc Link: here
Description: Add new 2022-10-31-preview version for following changes:
• Add Edge Device Deployment Manifest List, Create, Update, Remove support. • Replace $top with maxpagesize from legacy preview version. (users, jobs, scheduled jobs, devices, device templates, device groups, dashboards) • Replace $filter with filter from legacy preview version. (devices, device groups, dashboards, device templates) • Replace $orderby with orderby from legacy preview version. (devices, device groups, device templates) • Add read only id scope from Enrollment Group. • Add optional read access from File Upload Configuration, default is false. • Add new route for edge device to apply manifest. • Add new expand parameter for device route to retrieve deployment manifest when specify ?expand=deploymentManifest • Remove deploymentManifest from legacy device template contract. • Add new type: string[] for device creation, currently only allow iotEdge, type can't be changed after creation.
Detailed meeting information and documents provided can be accessed here
API Stewardship Board Review: 20-Oct-22
-
Use additionalProperties = true to give better indication to code gen for the SDKs See: https://swagger.io/specification/v2/#model-with-mapdictionary-properties
-
Support the standard conditional requests pattern using the
If-Matchheader -
Check the use of model as string
false-- some of these should betrue -
Open question on ETag that we will follow up async.
Next Steps
No blockers for preview.
@markweitzel
I have fixed "modelAsString" from false to true for any enumeration value consider to be extended in future, we also exposed if-match header as our API already supported, but we throws errors when etag in body and header are different, final cases are:
- specified from if-match header only.
- specified from body only
- if both are specified, they should be same, otherwise throws error.
Would you please take a look on these changes? please let us know if there is any issues with this change.
Thanks, Johnson