Azure / Azure/azure-rest-api-specs

Update IoT Hub Rest API documentation

Open
#10,899 3 comments 0 reactions 0 assignees View on GitHub
IoTHub question Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

The rest api documentation is out of date: https://docs.microsoft.com/en-us/rest/api/iothub/?source=docs (last updated on 09/30/2015)

We are looking for IoT Hub failover operation described in
https://github.com/Azure/azure-rest-api-specs/blob/master/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-08-01/iothub.json

"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/failover"

Contributor guide

Open the contributing guide

Research direction

Compare the published IoT Hub REST API documentation at the linked Microsoft Docs URL with the failover operation in specification/iothub/resource-manager/Microsoft.Devices/stable/2020-08-01/iothub.json. Start with the /failover entry; done means the REST documentation accurately describes that IoT Hub failover operation.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, openapi
Domain
api, cloud, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.