Skip to content

Commit 3d12c0a

Browse files
Fix API categories for iothub service client (#12087)
1 parent 4ae484f commit 3d12c0a

File tree

1 file changed

+12
-29
lines changed

1 file changed

+12
-29
lines changed

sdk/iot/Azure.Iot.Hub.Service/src/API Design.md

Lines changed: 12 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -38,64 +38,47 @@ APIs for getting statistics about devices and modules, as well as service statis
3838
```
3939
</details>
4040

41-
<details><summary><b>Registry</b></summary>
42-
APIs for managing device and module identities
41+
<details><summary><b>Devices</b></summary>
42+
APIs for managing device identities, device twins, and querying devices
4343

4444
```csharp
4545

4646
```
4747
</details>
4848

49-
<details><summary><b>Jobs</b></summary>
50-
APIs for using IotHub jobs
51-
52-
```csharp
53-
54-
```
55-
</details>
56-
57-
<details><summary><b>V2 Jobs</b></summary>
58-
(maybe combine with job APIs, or maybe don't expose v1 job APIs. Talk with service about this)
49+
<details><summary><b>Modules</b></summary>
50+
APIs for managing module identities, module twins, and querying modules
5951

6052
```csharp
6153

6254
```
6355
</details>
6456

65-
<details><summary><b>Twin</b></summary>
66-
Device and module twin operations
67-
68-
```csharp
69-
70-
```
71-
</details>
72-
73-
<details><summary><b>Methods</b></summary>
74-
Device and module direct methods
57+
<details><summary><b>Jobs</b></summary>
58+
APIs for using IotHub v2 jobs
7559

7660
```csharp
7761

7862
```
7963
</details>
8064

81-
<details><summary><b>Cloud to Device Messaging</b></summary>
82-
No sign of this in the swagger
83-
65+
<details><summary><b>Messages</b></summary>
66+
Feedback messages, sending cloud to device messages (missing from current swagger), and purging cloud to device message queue
8467
```csharp
8568

8669
```
8770
</details>
8871

89-
<details><summary><b>Feedback Message</b></summary>
90-
APIs for getting feedback messages
72+
<details><summary><b>Files</b></summary>
73+
APIs for getting file upload notifications (missing from current swagger)
9174

9275
```csharp
9376

9477
```
9578
</details>
9679

97-
<details><summary><b>File Upload Notifications</b></summary>
98-
No sign of this in the swagger
80+
<details><summary><b>Fault Injection</b></summary>
81+
Not sure if we'll expose these
9982

10083
```csharp
10184

0 commit comments

Comments
 (0)