Azure / Azure/azure-rest-api-specs

[IoT Central] REST API Review (2022-10-31-preview)

Open
#20,992 0 comments 0 reactions 0 assignees View on GitHub
IoT Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
3d 2h
Merged PRs (30d)
424

Description

Service name
IoT Central

Key contact for the review
[hayang@microsoft.com](mailto:hayang@microsoft.com), [Avneet.Singh@microsoft.com](mailto:Avneet.Singh@microsoft.com)

Whether this is a new or existing API
Existing API for new preview version

Whether or not your service already been deployed
No, TBD by end of Oct

A brief description of the material to be reviewed/changed:

- 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 readonly id scope from Enrollment Group.
- Add optional read access from FileUpload 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.

[Swagger PR](https://github.com/Azure/azure-rest-api-specs/pull/20981)

Contributor guide

Open the contributing guide

Research direction

Start with Swagger PR #20981 and compare its IoT Central 2022-10-31-preview changes with the legacy preview contract. Done means the listed deployment-manifest routes, pagination, filter and ordering parameters, enrollment-group and file-upload fields, and device-type changes are represented in the preview specification.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.